# Exemplos de comando da AWS CLI Os exemplos de código neste tópico mostram como usar o AWS Command Line Interface com a 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](cli_acm_code_examples.md) + [API Gateway](cli_api-gateway_code_examples.md) + [HTTP do API Gateway e API de WebSocket](cli_apigatewayv2_code_examples.md) + [A API de gerenciamento do API Gateway](cli_apigatewaymanagementapi_code_examples.md) + [App Mesh](cli_app-mesh_code_examples.md) + [App Runner](cli_apprunner_code_examples.md) + [AWS AppConfig](cli_appconfig_code_examples.md) + [Application Auto Scaling](cli_application-auto-scaling_code_examples.md) + [Application Discovery Service](cli_application-discovery-service_code_examples.md) + [Application Signals](cli_application-signals_code_examples.md) + [AppRegistry](cli_service-catalog-appregistry_code_examples.md) + [Athena](cli_athena_code_examples.md) + [ajuste de escala automático](cli_auto-scaling_code_examples.md) + [Planos de Auto Scaling](cli_auto-scaling-plans_code_examples.md) + [AWS Backup](cli_backup_code_examples.md) + [AWS Batch](cli_batch_code_examples.md) + [AWS Budgets](cli_budgets_code_examples.md) + [Amazon Chime](cli_chime_code_examples.md) + [API de Controle da Nuvem](cli_cloudcontrol_code_examples.md) + [AWS Cloud Map](cli_servicediscovery_code_examples.md) + [AWS Cloud9](cli_cloud9_code_examples.md) + [CloudFormation](cli_cloudformation_code_examples.md) + [CloudFront](cli_cloudfront_code_examples.md) + [Amazon CloudSearch](cli_cloudsearch-domain_code_examples.md) + [CloudTrail](cli_cloudtrail_code_examples.md) + [CloudWatch](cli_cloudwatch_code_examples.md) + [CloudWatch Logs](cli_cloudwatch-logs_code_examples.md) + [Monitor de Rede do CloudWatch](cli_networkmonitor_code_examples.md) + [CloudWatch Observability Access Monitor](cli_oam_code_examples.md) + [CloudWatch Observability Admin](cli_observabilityadmin_code_examples.md) + [CloudWatch Synthetics](cli_synthetics_code_examples.md) + [CodeArtifact](cli_codeartifact_code_examples.md) + [CodeBuild](cli_codebuild_code_examples.md) + [CodeCommit](cli_codecommit_code_examples.md) + [CodeDeploy](cli_codedeploy_code_examples.md) + [CodeGuru Reviewer](cli_codeguru-reviewer_code_examples.md) + [CodePipeline](cli_codepipeline_code_examples.md) + [AWS CodeStarNotificações do](cli_codestar-notifications_code_examples.md) + [CodeConnections](cli_codestar-connections_code_examples.md) + [Amazon Cognito Identity](cli_cognito-identity_code_examples.md) + [Provedor de identidade do Amazon Cognito](cli_cognito-identity-provider_code_examples.md) + [Amazon Comprehend](cli_comprehend_code_examples.md) + [Amazon Comprehend Medical](cli_comprehendmedical_code_examples.md) + [AWS Config](cli_config-service_code_examples.md) + [Amazon Connect](cli_connect_code_examples.md) + [AWS Cost and Usage Report](cli_cost-and-usage-report-service_code_examples.md) + [Cost Explorer Service](cli_cost-explorer_code_examples.md) + [Firehose](cli_firehose_code_examples.md) + [Amazon Data Lifecycle Manager](cli_dlm_code_examples.md) + [AWS Data Pipeline](cli_data-pipeline_code_examples.md) + [DataSync](cli_datasync_code_examples.md) + [DAX](cli_dax_code_examples.md) + [Detective](cli_detective_code_examples.md) + [Device Farm](cli_device-farm_code_examples.md) + [Direct Connect](cli_direct-connect_code_examples.md) + [Directory Service](cli_directory-service_code_examples.md) + [Dados do Directory Service](cli_directory-service-data_code_examples.md) + [AWS DMS](cli_database-migration-service_code_examples.md) + [Amazon DocumentDB](cli_docdb_code_examples.md) + [DynamoDB](cli_dynamodb_code_examples.md) + [DynamoDB Streams](cli_dynamodb-streams_code_examples.md) + [Amazon EC2](cli_ec2_code_examples.md) + [Amazon EC2 Instance Connect](cli_ec2-instance-connect_code_examples.md) + [Amazon ECR](cli_ecr_code_examples.md) + [Amazon ECR Public](cli_ecr-public_code_examples.md) + [Amazon ECS](cli_ecs_code_examples.md) + [Amazon EFS](cli_efs_code_examples.md) + [Amazon EKS](cli_eks_code_examples.md) + [Elastic Beanstalk](cli_elastic-beanstalk_code_examples.md) + [Elastic Load Balancing Versão 1](cli_elastic-load-balancing_code_examples.md) + [Elastic Load Balancing Versão 2](cli_elastic-load-balancing-v2_code_examples.md) + [ElastiCache](cli_elasticache_code_examples.md) + [MediaStore](cli_mediastore_code_examples.md) + [Amazon EMR](cli_emr_code_examples.md) + [Amazon EMR no EKS](cli_emr-containers_code_examples.md) + [EventBridge](cli_eventbridge_code_examples.md) + [Pipes do EventBridge](cli_pipes_code_examples.md) + [Firewall Manager](cli_fms_code_examples.md) + [AWS FIS](cli_fis_code_examples.md) + [Amazon GameLift Servers](cli_gamelift_code_examples.md) + [Amazon Glacier](cli_glacier_code_examples.md) + [Global Accelerator](cli_global-accelerator_code_examples.md) + [AWS Glue](cli_glue_code_examples.md) + [GuardDuty](cli_guardduty_code_examples.md) + [AWS Health](cli_health_code_examples.md) + [HealthImaging](cli_medical-imaging_code_examples.md) + [HealthLake](cli_healthlake_code_examples.md) + [ HealthOmics](cli_omics_code_examples.md) + [IAM](cli_iam_code_examples.md) + [IAM Access Analyzer](cli_accessanalyzer_code_examples.md) + [Image Builder](cli_imagebuilder_code_examples.md) + [Incident Manager](cli_ssm-incidents_code_examples.md) + [Incident Manager Contacts](cli_ssm-contacts_code_examples.md) + [Amazon Inspector](cli_inspector_code_examples.md) + [AWS IoT](cli_iot_code_examples.md) + [Device Advisor](cli_iotdeviceadvisor_code_examples.md) + [AWS IoT data](cli_iot-data-plane_code_examples.md) + [AWS IoT Events](cli_iot-events_code_examples.md) + [AWS IoT Events-Data](cli_iot-events-data_code_examples.md) + [AWS IoT Greengrass](cli_greengrass_code_examples.md) + [AWS IoT Greengrass V2](cli_greengrassv2_code_examples.md) + [Lançamento do AWS IoT Jobs SDK](cli_iot-jobs-data-plane_code_examples.md) + [AWS IoT SiteWise](cli_iotsitewise_code_examples.md) + [AWS IoT Things Graph](cli_iotthingsgraph_code_examples.md) + [AWS IoT Wireless](cli_iot-wireless_code_examples.md) + [Amazon IVS](cli_ivs_code_examples.md) + [Amazon IVS Chat](cli_ivschat_code_examples.md) + [Streaming em tempo real do Amazon IVS](cli_ivs-realtime_code_examples.md) + [Amazon Kendra](cli_kendra_code_examples.md) + [Kinesis](cli_kinesis_code_examples.md) + [AWS KMS](cli_kms_code_examples.md) + [Lake Formation](cli_lakeformation_code_examples.md) + [Lambda](cli_lambda_code_examples.md) + [License Manager](cli_license-manager_code_examples.md) + [Lightsail](cli_lightsail_code_examples.md) + [Macie](cli_macie2_code_examples.md) + [Amazon Managed Grafana](cli_grafana_code_examples.md) + [MediaConnect](cli_mediaconnect_code_examples.md) + [MediaConvert](cli_mediaconvert_code_examples.md) + [MediaLive](cli_medialive_code_examples.md) + [MediaPackage](cli_mediapackage_code_examples.md) + [MediaPackage VOD](cli_mediapackage-vod_code_examples.md) + [Plano de dados MediaStore](cli_mediastore-data_code_examples.md) + [MediaTailor](cli_mediatailor_code_examples.md) + [MemoryDB](cli_memorydb_code_examples.md) + [Amazon MSK](cli_kafka_code_examples.md) + [Network Flow Monitor](cli_networkflowmonitor_code_examples.md) + [Network Manager](cli_networkmanager_code_examples.md) + [OpenSearch Service](cli_elasticsearch-service_code_examples.md) + [Organizações](cli_organizations_code_examples.md) + [AWS Outposts](cli_outposts_code_examples.md) + [AWS Payment Cryptography](cli_payment-cryptography_code_examples.md) + [AWS Payment CryptographyPlano de dados de](cli_payment-cryptography-data_code_examples.md) + [Amazon Pinpoint](cli_pinpoint_code_examples.md) + [Amazon Polly](cli_polly_code_examples.md) + [AWS Price List](cli_pricing_code_examples.md) + [CA Privada da AWS](cli_acm-pca_code_examples.md) + [AWS Proton](cli_proton_code_examples.md) + [Amazon RDS](cli_rds_code_examples.md) + [Serviços de dados do Amazon RDS](cli_rds-data_code_examples.md) + [Amazon RDS Performance Insights](cli_pi_code_examples.md) + [Amazon Redshift](cli_redshift_code_examples.md) + [Amazon Rekognition](cli_rekognition_code_examples.md) + [AWS RAM](cli_ram_code_examples.md) + [Explorador de Recursos](cli_resource-explorer-2_code_examples.md) + [Resource Groups (Grupos de recursos)](cli_resource-groups_code_examples.md) + [API Resource Groups Tagging](cli_resource-groups-tagging-api_code_examples.md) + [Route 53](cli_route-53_code_examples.md) + [Registro de domínios do Route 53](cli_route-53-domains_code_examples.md) + [Perfis do Route 53](cli_route53profiles_code_examples.md) + [Route 53 Resolver](cli_route53resolver_code_examples.md) + [Amazon S3](cli_s3_code_examples.md) + [Amazon S3 Control](cli_s3-control_code_examples.md) + [Secrets Manager](cli_secrets-manager_code_examples.md) + [CSPM do Security Hub](cli_securityhub_code_examples.md) + [Security Lake](cli_securitylake_code_examples.md) + [AWS Serverless Application Repository](cli_serverlessapplicationrepository_code_examples.md) + [Service Catalog](cli_service-catalog_code_examples.md) + [Service Quotas](cli_service-quotas_code_examples.md) + [Amazon SES](cli_ses_code_examples.md) + [Shield (Escudo)](cli_shield_code_examples.md) + [Signer](cli_signer_code_examples.md) + [Snowball Edge](cli_snowball_code_examples.md) + [Amazon SNS](cli_sns_code_examples.md) + [Amazon SQS](cli_sqs_code_examples.md) + [Storage Gateway](cli_storage-gateway_code_examples.md) + [AWS STS](cli_sts_code_examples.md) + [Suporte](cli_support_code_examples.md) + [Amazon SWF](cli_swf_code_examples.md) + [Systems Manager](cli_ssm_code_examples.md) + [Amazon Textract](cli_textract_code_examples.md) + [Amazon Transcribe](cli_transcribe_code_examples.md) + [Amazon Translate](cli_translate_code_examples.md) + [Trusted Advisor](cli_trustedadvisor_code_examples.md) + [Permissões verificadas](cli_verifiedpermissions_code_examples.md) + [VPC Lattice](cli_vpc-lattice_code_examples.md) + [AWS WAF Classic](cli_waf_code_examples.md) + [AWS WAF Classic regional](cli_waf-regional_code_examples.md) + [AWS WAFV2](cli_wafv2_code_examples.md) + [WorkDocs](cli_workdocs_code_examples.md) + [Amazon WorkMail](cli_workmail_code_examples.md) + [Amazon WorkMail Message Flow](cli_workmailmessageflow_code_examples.md) + [WorkSpaces](cli_workspaces_code_examples.md) + [X-Ray](cli_xray_code_examples.md) # Exemplos do ACM usando o AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface 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 ### `add-tags-to-certificate` O código de exemplo a seguir mostra como usar `add-tags-to-certificate`. **AWS CLI** **Como adicionar tags a um certificado do ACM existente** O comando `add-tags-to-certificate` a seguir adiciona duas tags ao certificado especificado. Use um espaço para separar várias tags: ``` aws acm add-tags-to-certificate --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 --tags Key=Admin,Value=Alice Key=Purpose,Value=Website ``` + Consulte detalhes da API em [AddTagsToCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/add-tags-to-certificate.html) na *Referência de comandos da AWS CLI*. ### `delete-certificate` O código de exemplo a seguir mostra como usar `delete-certificate`. **AWS CLI** **Como excluir um certificado do ACM da sua conta** O seguinte comando `delete-certificate` exclui o certificado com o ARN especificado: ``` aws acm delete-certificate --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 ``` + Consulte detalhes da API em [DeleteCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/delete-certificate.html) na *Referência de comandos da AWS CLI*. ### `describe-certificate` O código de exemplo a seguir mostra como usar `describe-certificate`. **AWS CLI** **Para recuperar os campos contidos em um certificado do ACM** O seguinte comando `describe-certificate` recupera todos os campos do certificado com o ARN especificado: ``` aws acm describe-certificate --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 ``` Uma saída semelhante à seguinte é exibida: ``` { "Certificate": { "CertificateArn": "arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012", "CreatedAt": 1446835267.0, "DomainName": "www.example.com", "DomainValidationOptions": [ { "DomainName": "www.example.com", "ValidationDomain": "www.example.com", "ValidationEmails": [ "hostmaster@example.com", "admin@example.com", "owner@example.com.whoisprivacyservice.org", "tech@example.com.whoisprivacyservice.org", "admin@example.com.whoisprivacyservice.org", "postmaster@example.com", "webmaster@example.com", "administrator@example.com" ] }, { "DomainName": "www.example.net", "ValidationDomain": "www.example.net", "ValidationEmails": [ "postmaster@example.net", "admin@example.net", "owner@example.net.whoisprivacyservice.org", "tech@example.net.whoisprivacyservice.org", "admin@example.net.whoisprivacyservice.org", "hostmaster@example.net", "administrator@example.net", "webmaster@example.net" ] } ], "InUseBy": [], "IssuedAt": 1446835815.0, "Issuer": "Amazon", "KeyAlgorithm": "RSA-2048", "NotAfter": 1478433600.0, "NotBefore": 1446768000.0, "Serial": "0f:ac:b0:a3:8d:ea:65:52:2d:7d:01:3a:39:36:db:d6", "SignatureAlgorithm": "SHA256WITHRSA", "Status": "ISSUED", "Subject": "CN=www.example.com", "SubjectAlternativeNames": [ "www.example.com", "www.example.net" ] } } ``` + Consulte detalhes da API em [DescribeCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/describe-certificate.html) na *Referência de comandos da AWS CLI*. ### `export-certificate` O código de exemplo a seguir mostra como usar `export-certificate`. **AWS CLI** **Para exportar um certificado privado emitido por uma CA privada.** O comando `export-certificate` a seguir exporta um certificado privado, uma cadeia de certificados e uma chave privada para a sua exibição: ``` aws acm export-certificate --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 --passphrase file://path-to-passphrase-file ``` Para exportar o certificado, a cadeia e a chave privada para um arquivo local, use o seguinte comando: ``` aws acm export-certificate --certificate-arn arn:aws:acm:region:sccount:certificate/12345678-1234-1234-1234-123456789012 --passphrase file://path-to-passphrase-file > c:\temp\export.txt ``` + Para ver detalhes da API, consulte [ExportCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/export-certificate.html) na *Referência de comandos da AWS CLI*. ### `get-certificate` O código de exemplo a seguir mostra como usar `get-certificate`. **AWS CLI** **Para recuperar um certificado do ACM** O seguinte comando `get-certificate` recupera o certificado para o ARN especificado e a cadeia de certificados: ``` aws acm get-certificate --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 ``` Uma saída semelhante à seguinte é exibida: ``` { "Certificate": "-----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": "-----BEGIN CERTIFICATE----- MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= -----END CERTIFICATE-----", "-----BEGIN CERTIFICATE----- MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= -----END CERTIFICATE-----", "-----BEGIN CERTIFICATE----- MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= -----END CERTIFICATE-----" } ``` + Consulte detalhes da API em [GetCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/get-certificate.html) na *Referência de comandos da AWS CLI*. ### `import-certificate` O código de exemplo a seguir mostra como usar `import-certificate`. **AWS CLI** **Como importar um certificado para o ACM.** O comando `import-certificate` a seguir importa um certificado para o ACM. Substitua os nomes dos arquivos pelos seus próprios: ``` aws acm import-certificate --certificate file://Certificate.pem --certificate-chain file://CertificateChain.pem --private-key file://PrivateKey.pem ``` + Consulte detalhes da API em [ImportCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/import-certificate.html) na *Referência de comandos daAWS CLI*. ### `list-certificates` O código de exemplo a seguir mostra como usar `list-certificates`. **AWS CLI** **Para listar os certificados do ACM em uma conta da AWS** O seguinte comando `list-certificates` lista os ARNs dos certificados na conta: ``` aws acm list-certificates ``` O comando anterior produz uma saída semelhante à seguinte: ``` { "CertificateSummaryList": [ { "CertificateArn": "arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012", "DomainName": "www.example.com" }, { "CertificateArn": "arn:aws:acm:region:account:certificate/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "DomainName": "www.example.net" } ] } ``` Você pode decidir quantos certificados deseja exibir sempre que chamar `list-certificates`. Por exemplo, se você tem quatro certificados e deseja exibir apenas dois por vez, defina o argumento `max-items` como 2, conforme o seguinte exemplo: ``` aws acm list-certificates --max-items 2 ``` Dois ARNs de certificado e um valor `NextToken` serão exibidos: ``` "CertificateSummaryList": [ { "CertificateArn": "arn:aws:acm:region:account: \ certificate/12345678-1234-1234-1234-123456789012", "DomainName": "www.example.com" }, { "CertificateArn": "arn:aws:acm:region:account: \ certificate/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "DomainName": "www.example.net" } ], "NextToken": "9f4d9f69-275a-41fe-b58e-2b837bd9ba48" ``` Para exibir os próximos dois certificados em sua conta, defina o valor `NextToken` na próxima chamada: ``` aws acm list-certificates --max-items 2 --next-token 9f4d9f69-275a-41fe-b58e-2b837bd9ba48 ``` É possível filtrar a saída usando o argumento `certificate-statuses`. O seguinte comando exibe certificados com o status PENDING\$1VALIDATION: ``` aws acm list-certificates --certificate-statuses PENDING_VALIDATION ``` Também é possível filtrar a saída usando o argumento `includes`. O comando a seguir exibe os certificados filtrados nas propriedades a seguir. Os certificados a serem exibidos: ``` - Specify that the RSA algorithm and a 2048 bit key are used to generate key pairs. - Contain a Key Usage extension that specifies that the certificates can be used to create digital signatures. - Contain an Extended Key Usage extension that specifies that the certificates can be used for code signing. aws acm list-certificates --max-items 10 --includes extendedKeyUsage=CODE_SIGNING,keyUsage=DIGITAL_SIGNATURE,keyTypes=RSA_2048 ``` + Consulte detalhes da API em [ListCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/list-certificates.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-certificate` O código de exemplo a seguir mostra como usar `list-tags-for-certificate`. **AWS CLI** **Para listar as tags aplicadas a um certificado do ACM** O seguinte comando `list-tags-for-certificate` lista as tags aplicadas a um certificado na conta: ``` aws acm list-tags-for-certificate --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 ``` O comando anterior produz uma saída semelhante à seguinte: ``` { "Tags": [ { "Value": "Website", "Key": "Purpose" }, { "Value": "Alice", "Key": "Admin" } ] } ``` + Consulte detalhes da API em [ListTagsForCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/list-tags-for-certificate.html) na *Referência de comandos da AWS CLI*. ### `remove-tags-from-certificate` O código de exemplo a seguir mostra como usar `remove-tags-from-certificate`. **AWS CLI** **Como remover uma tag de um certificado do ACM** O comando `remove-tags-from-certificate` a seguir remove duas tags do certificado especificado. Use um espaço para separar várias tags: ``` aws acm remove-tags-from-certificate --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 --tags Key=Admin,Value=Alice Key=Purpose,Value=Website ``` + Consulte detalhes da API em [RemoveTagsFromCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/remove-tags-from-certificate.html) na *Referência de comandos da AWS CLI*. ### `request-certificate` O código de exemplo a seguir mostra como usar `request-certificate`. **AWS CLI** **Como solicitar um novo certificado do ACM** O seguinte comando `request-certificate` solicita um novo certificado para o domínio www.example.com usando a validação de DNS: ``` aws acm request-certificate --domain-name www.example.com --validation-method DNS ``` Você pode inserir um token de idempotência para distinguir entre chamadas para `request-certificate`: ``` aws acm request-certificate --domain-name www.example.com --validation-method DNS --idempotency-token 91adc45q ``` Você pode inserir um ou mais nomes alternativos de assunto para solicitar um certificado que protegerá mais de um domínio do apex: ``` aws acm request-certificate --domain-name example.com --validation-method DNS --idempotency-token 91adc45q --subject-alternative-names www.example.net ``` Você pode inserir um nome alternativo que também pode ser usado para acessar seu site: ``` aws acm request-certificate --domain-name example.com --validation-method DNS --idempotency-token 91adc45q --subject-alternative-names www.example.com ``` Você pode usar um asterisco (\$1) como um caractere curinga para criar um certificado para vários subdomínios no mesmo domínio: ``` aws acm request-certificate --domain-name example.com --validation-method DNS --idempotency-token 91adc45q --subject-alternative-names *.example.com ``` Você também pode inserir vários nomes alternativos: ``` aws acm request-certificate --domain-name example.com --validation-method DNS --subject-alternative-names b.example.com c.example.com d.example.com ``` Se você estiver usando e-mail para validação, poderá inserir as opções de validação de domínio para especificar o domínio para o qual o e-mail de validação será enviado: ``` aws acm request-certificate --domain-name example.com --validation-method EMAIL --subject-alternative-names www.example.com --domain-validation-options DomainName=example.com,ValidationDomain=example.com ``` O seguinte comando desativa o registro em log de transparência do certificado ao solicitar um novo certificado: ``` aws acm request-certificate --domain-name www.example.com --validation-method DNS --options CertificateTransparencyLoggingPreference=DISABLED --idempotency-token 184627 ``` + Consulte detalhes da API em [RequestCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/request-certificate.html) na *Referência de comandos da AWS CLI*. ### `resend-validation-email` O código de exemplo a seguir mostra como usar `resend-validation-email`. **AWS CLI** **Como reenviar o e-mail de validação para a solicitação de certificado do ACM** O seguinte `resend-validation-email` comando instrui a autoridade de certificação da Amazon a enviar e-mails de validação para os endereços apropriados: ``` aws acm resend-validation-email --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 --domain www.example.com --validation-domain example.com ``` + Consulte detalhes da API em [ResendValidationEmail](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/resend-validation-email.html) na *Referência de comandos da AWS CLI*. ### `update-certificate-options` O código de exemplo a seguir mostra como usar `update-certificate-options`. **AWS CLI** **Para atualizar as opções de certificado** O comando `update-certificate-options` a seguir desativa o registro em log de transparência do certificado: ``` aws acm update-certificate-options --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 --options CertificateTransparencyLoggingPreference=DISABLED ``` + Para ver detalhes da API, consulte [UpdateCertificateOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/update-certificate-options.html) na *Referência de comandos da AWS CLI*. # Exemplos da API Gateway usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o API Gateway. *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 ### `create-api-key` O código de exemplo a seguir mostra como usar `create-api-key`. **AWS CLI** **Para criar uma chave de API habilitada para uma API e um estágio existentes** Comando: ``` aws apigateway create-api-key --name 'Dev API Key' --description 'Used for development' --enabled --stage-keys restApiId='a1b2c3d4e5',stageName='dev' ``` + Para ver detalhes da API, consulte [CreateApiKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-api-key.html) na *Referência de comandos da AWS CLI*. ### `create-authorizer` O código de exemplo a seguir mostra como usar `create-authorizer`. **AWS CLI** **Exemplo 1: criar um autorizador personalizado do API Gateway baseado em token para a API** O exemplo `create-authorizer` a seguir cria um autorizador baseado em token. ``` aws apigateway create-authorizer \ --rest-api-id 1234123412 \ --name 'First_Token_Custom_Authorizer' \ --type TOKEN \ --authorizer-uri 'arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthFunction/invocations' \ --identity-source 'method.request.header.Authorization' \ --authorizer-result-ttl-in-seconds 300 ``` Resultado: ``` { "authType": "custom", "name": "First_Token_Custom_Authorizer", "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthFunction/invocations", "authorizerResultTtlInSeconds": 300, "identitySource": "method.request.header.Authorization", "type": "TOKEN", "id": "z40xj0" } ``` **Exemplo 2: criar um autorizador personalizado do API Gateway baseado em grupos de usuários do Cognito para a API** O exemplo `create-authorizer` a seguir cria um autorizador personalizado do API Gateway baseado em grupos de usuários do Cognito. ``` aws apigateway create-authorizer \ --rest-api-id 1234123412 \ --name 'First_Cognito_Custom_Authorizer' \ --type COGNITO_USER_POOLS \ --provider-arns 'arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_aWcZeQbuD' \ --identity-source 'method.request.header.Authorization' ``` Resultado: ``` { "authType": "cognito_user_pools", "identitySource": "method.request.header.Authorization", "name": "First_Cognito_Custom_Authorizer", "providerARNs": [ "arn:aws:cognito-idp:us-east-1:342398297714:userpool/us-east-1_qWbZzQhzE" ], "type": "COGNITO_USER_POOLS", "id": "5yid1t" } ``` **Exemplo 3: criar um autorizador personalizado do API Gateway baseado em solicitações para a API** O exemplo `create-authorizer` a seguir cria um autorizador baseado em solicitações. ``` aws apigateway create-authorizer \ --rest-api-id 1234123412 \ --name 'First_Request_Custom_Authorizer' \ --type REQUEST \ --authorizer-uri 'arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthFunction/invocations' \ --identity-source 'method.request.header.Authorization,context.accountId' \ --authorizer-result-ttl-in-seconds 300 ``` Resultado: ``` { "id": "z40xj0", "name": "First_Request_Custom_Authorizer", "type": "REQUEST", "authType": "custom", "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthFunction/invocations", "identitySource": "method.request.header.Authorization,context.accountId", "authorizerResultTtlInSeconds": 300 } ``` + Para ver detalhes da API, consulte [CreateAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-authorizer.html) na *Referência de comandos da AWS CLI*. ### `create-base-path-mapping` O código de exemplo a seguir mostra como usar `create-base-path-mapping`. **AWS CLI** **Para criar o mapeamento de caminho base para um nome de domínio personalizado** Comando: ``` aws apigateway create-base-path-mapping --domain-name subdomain.domain.tld --rest-api-id 1234123412 --stage prod --base-path v1 ``` + Para ver detalhes da API, consulte [CreateBasePathMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-base-path-mapping.html) na *Referência de comandos da AWS CLI*. ### `create-deployment` O código de exemplo a seguir mostra como usar `create-deployment`. **AWS CLI** **Como implantar os recursos configurados de uma API em um novo estágio** Comando: ``` aws apigateway create-deployment --rest-api-id 1234123412 --stage-name dev --stage-description 'Development Stage' --description 'First deployment to the dev stage' ``` **Como implantar os recursos configurados de uma API em um estágio existente** Comando: ``` aws apigateway create-deployment --rest-api-id 1234123412 --stage-name dev --description 'Second deployment to the dev stage' ``` **Como implantar os recursos configurados de uma API em um estágio existente com variáveis de estágio** aws apigateway create-deployment --rest-api-id 1234123412 --stage-name dev --description 'Terceira implantação no estágio de desenvolvimento' --variables key='value',otherKey='otherValue' + Consulte detalhes da API em [CreateDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-deployment.html) na *Referência de comandos da AWS CLI*. ### `create-domain-name-access-association` O código de exemplo a seguir mostra como usar `create-domain-name-access-association`. **AWS CLI** **Como criar uma associação de acesso ao nome de domínio** O exemplo de `create-domain-name-access-association` a seguir cria uma associação de acesso ao nome de domínio entre um nome de domínio personalizado privado e um endpoint da VPC. ``` aws apigateway create-domain-name-access-association \ --domain-name-arn arn:aws:apigateway:us-west-2:111122223333:/domainnames/my.private.domain.tld+abcd1234 \ --access-association-source vpce-abcd1234efg \ --access-association-source-type VPCE ``` Resultado: ``` { "domainNameAccessAssociationArn": "arn:aws:apigateway:us-west-2:012345678910:/domainnameaccessassociations/domainname/my.private.domain.tld/vpcesource/vpce-abcd1234efg "accessAssociationSource": "vpce-abcd1234efg", "accessAssociationSourceType": "VPCE", "domainNameArn" : "arn:aws:apigateway:us-west-2:111122223333:/domainnames/private.example.com+abcd1234" } ``` Consulte mais informações em [Custom domain names for private APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Consulte detalhes da API em [CreateDomainNameAccessAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-domain-name-access-association.html) na *Referência de comandos da AWS CLI*. ### `create-domain-name` O código de exemplo a seguir mostra como usar `create-domain-name`. **AWS CLI** **Exemplo 1: como criar um nome de domínio personalizado público** O exemplo de `create-domain-name` a seguir cria um domínio personalizado público. ``` aws apigateway create-domain-name \ --domain-name 'my.domain.tld' \ --certificate-name 'my.domain.tld cert'\ --certificate-arn 'arn:aws:acm:us-east-1:012345678910:certificate/fb1b9770-a305-495d-aefb-27e5e101ff3' ``` Resultado: ``` { "domainName": "my.domain.tld", "certificateName": "my.domain.tld cert", "certificateArn": "arn:aws:acm:us-east-1:012345678910:certificate/fb1b9770-a305-495d-aefb-27e5e101ff3", "certificateUploadDate": "2024-10-08T11:29:49-07:00", "distributionDomainName": "abcd1234.cloudfront.net", "distributionHostedZoneId": "Z2FDTNDATAQYW2", "endpointConfiguration": { "types": [ "EDGE" ] }, "domainNameStatus": "AVAILABLE", "securityPolicy": "TLS_1_2" } ``` Consulte mais informações em [Nome de domínio personalizado para APIs REST no API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) no *Guia do desenvolvedor do Amazon API Gateway*. **Exemplo 2: como criar um nome de domínio personalizado privado** O exemplo de `create-domain-name` a seguir cria um domínio personalizado privado. ``` aws apigateway create-domain-name \ --domain-name 'my.private.domain.tld' \ --certificate-name 'my.domain.tld cert' \ --certificate-arn 'arn:aws:acm:us-east-1:012345678910:certificate/fb1b9770-a305-495d-aefb-27e5e101ff3' \ --endpoint-configuration '{"types": ["PRIVATE"]}' \ --security-policy 'TLS_1_2' \ --policy file://policy.json ``` Conteúdo de `policy.json`: ``` { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": "*", "Action": "execute-api:Invoke", "Resource": [ "execute-api:/*" ] }, { "Effect": "Deny", "Principal": "*", "Action": "execute-api:Invoke", "Resource": [ "execute-api:/*" ], "Condition" : { "StringNotEquals": { "aws:SourceVpce": "vpce-abcd1234efg" } } } ] } ``` Resultado: ``` { "domainName": "my.private.domain.tld", "domainNameId": "abcd1234", "domainNameArn": "arn:aws:apigateway:us-east-1:012345678910:/domainnames/my.private.domain.tld+abcd1234", "certificateArn": "arn:aws:acm:us-east-1:012345678910:certificate/fb1b9770-a305-495d-aefb-27e5e101ff3", "certificateUploadDate": "2024-09-10T10:31:20-07:00", "endpointConfiguration": { "types": [ "PRIVATE" ] }, "domainNameStatus": "AVAILABLE", "securityPolicy": "TLS_1_2", "policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":\"*\",\"Action\":\"execute-api:Invoke\",\"Resource\":\"arn:aws:execute-api:us-east-1:012345678910:/domainnames/my.private.domain.tld+abcd1234\"},{\"Effect\":\"Deny\",\"Principal\":\"*\",\"Action\":\"execute-api:Invoke\",\"Resource\":\"arn:aws:execute-api:us-east-1:012345678910:/domainnames/my.private.domain.tld+abcd1234\",\"Condition\":{\"StringNotEquals\":{\"aws:SourceVpc\":\"vpc-1a2b3c4d\"}}}]}" } ``` Consulte mais informações em [Nome de domínio personalizado para APIs REST no API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [CreateDomainName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-domain-name.html) na *Referência de comandos da AWS CLI*. ### `create-model` O código de exemplo a seguir mostra como usar `create-model`. **AWS CLI** **Para criar um modelo para uma API** Comando: ``` aws apigateway create-model --rest-api-id 1234123412 --name 'firstModel' --description 'The First Model' --content-type 'application/json' --schema '{ "$schema": "http://json-schema.org/draft-04/schema#", "title": "firstModel", "type": "object", "properties": { "firstProperty" : { "type": "object", "properties": { "key": { "type": "string" } } } } }' ``` Resultado: ``` { "contentType": "application/json", "description": "The First Model", "name": "firstModel", "id": "2rzg0l", "schema": "{ \"$schema\": \"http://json-schema.org/draft-04/schema#\", \"title\": \"firstModel\", \"type\": \"object\", \"properties\": { \"firstProperty\" : { \"type\": \"object\", \"properties\": { \"key\": { \"type\": \"string\" } } } } }" } ``` + Para ver detalhes da API, consulte [CreateModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-model.html) na *Referência de comandos da AWS CLI*. ### `create-resource` O código de exemplo a seguir mostra como usar `create-resource`. **AWS CLI** **Como criar um recurso em uma API** Comando: ``` aws apigateway create-resource --rest-api-id 1234123412 --parent-id a1b2c3 --path-part 'new-resource' ``` + Consulte detalhes da API em [CreateResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-resource.html) na *Referência de comandos da AWS CLI*. ### `create-rest-api` O código de exemplo a seguir mostra como usar `create-rest-api`. **AWS CLI** **Como criar uma API** Comando: ``` aws apigateway create-rest-api --name 'My First API' --description 'This is my first API' ``` **Como criar uma API duplicada a partir de uma API existente** Comando: ``` aws apigateway create-rest-api --name 'Copy of My First API' --description 'This is a copy of my first API' --clone-from 1234123412 ``` + Consulte detalhes da API em [CreateRestApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-rest-api.html) na *Referência de comandos da AWS CLI*. ### `create-stage` O código de exemplo a seguir mostra como usar `create-stage`. **AWS CLI** **Para criar um estágio em uma API que conterá uma implantação existente** Comando: ``` aws apigateway create-stage --rest-api-id 1234123412 --stage-name 'dev' --description 'Development stage' --deployment-id a1b2c3 ``` **Para criar um estágio em uma API que conterá uma implantação existente e variáveis de estágio personalizadas** Comando: ``` aws apigateway create-stage --rest-api-id 1234123412 --stage-name 'dev' --description 'Development stage' --deployment-id a1b2c3 --variables key='value',otherKey='otherValue' ``` + Para ver detalhes da API, consulte [CreateStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-stage.html) na *Referência de comandos da AWS CLI*. ### `create-usage-plan-key` O código de exemplo a seguir mostra como usar `create-usage-plan-key`. **AWS CLI** **Associar uma chave de API existente a um plano de uso** Comando: ``` aws apigateway create-usage-plan-key --usage-plan-id a1b2c3 --key-type "API_KEY" --key-id 4vq3yryqm5 ``` + Para ver detalhes da API, consulte [CreateUsagePlanKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-usage-plan-key.html) na *Referência de comandos da AWS CLI*. ### `create-usage-plan` O código de exemplo a seguir mostra como usar `create-usage-plan`. **AWS CLI** **Para criar um plano de uso com limites de cota e controle de utilização que são redefinidos no início do mês** Comando: ``` aws apigateway create-usage-plan --name "New Usage Plan" --description "A new usage plan" --throttle burstLimit=10,rateLimit=5 --quota limit=500,offset=0,period=MONTH ``` + Para ver detalhes da API, consulte [CreateUsagePlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-usage-plan.html) na *Referência de comandos da AWS CLI*. ### `delete-api-key` O código de exemplo a seguir mostra como usar `delete-api-key`. **AWS CLI** **Para excluir uma chave de API** Comando: ``` aws apigateway delete-api-key --api-key 8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk ``` + Para ver detalhes da API, consulte [DeleteApiKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-api-key.html) na *Referência de comandos da AWS CLI*. ### `delete-authorizer` O código de exemplo a seguir mostra como usar `delete-authorizer`. **AWS CLI** **Para excluir um autorizador personalizado em uma API** Comando: ``` aws apigateway delete-authorizer --rest-api-id 1234123412 --authorizer-id 7gkfbo ``` + Para ver detalhes da API, consulte [DeleteAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-authorizer.html) na *Referência de comandos da AWS CLI*. ### `delete-base-path-mapping` O código de exemplo a seguir mostra como usar `delete-base-path-mapping`. **AWS CLI** **Para excluir um mapeamento de caminho base para um nome de domínio personalizado** Comando: ``` aws apigateway delete-base-path-mapping --domain-name 'api.domain.tld' --base-path 'dev' ``` + Para ver detalhes da API, consulte [DeleteBasePathMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-base-path-mapping.html) na *Referência de comandos da AWS CLI*. ### `delete-client-certificate` O código de exemplo a seguir mostra como usar `delete-client-certificate`. **AWS CLI** **Para excluir um certificado de cliente** Comando: ``` aws apigateway delete-client-certificate --client-certificate-id a1b2c3 ``` + Para ver detalhes da API, consulte [DeleteClientCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-client-certificate.html) na *Referência de comandos da AWS CLI*. ### `delete-deployment` O código de exemplo a seguir mostra como usar `delete-deployment`. **AWS CLI** **Como excluir uma implantação em uma API** Comando: ``` aws apigateway delete-deployment --rest-api-id 1234123412 --deployment-id a1b2c3 ``` + Consulte detalhes da API em [DeleteDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-deployment.html) na *Referência de comandos da AWS CLI*. ### `delete-domain-name-access-association` O código de exemplo a seguir mostra como usar `delete-domain-name-access-association`. **AWS CLI** **Como excluir uma associação de acesso ao nome de domínio** O exemplo de `delete-domain-name-access-association` a seguir exclui uma associação de acesso ao nome de domínio entre um nome de domínio personalizado privado e um endpoint da VPC. ``` aws apigateway delete-domain-name-access-association \ --domain-name-access-association-arn arn:aws:apigateway:us-west-2:012345678910:/domainnameaccessassociations/domainname/my.private.domain.tld/vpcesource/vpce-abcd1234efg ``` Este comando não produz saída. Consulte mais informações em [Custom domain names for private APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Consulte detalhes da API em [DeleteDomainNameAccessAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-domain-name-access-association.html) na *Referência de comandos da AWS CLI*. ### `delete-domain-name` O código de exemplo a seguir mostra como usar `delete-domain-name`. **AWS CLI** **Para excluir um nome de domínio personalizado** Comando: ``` aws apigateway delete-domain-name --domain-name 'api.domain.tld' ``` + Para ver detalhes da API, consulte [DeleteDomainName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-domain-name.html) na *Referência de comandos da AWS CLI*. ### `delete-integration-response` O código de exemplo a seguir mostra como usar `delete-integration-response`. **AWS CLI** **Para excluir uma resposta de integração para um determinado recurso, método e código de status em uma API** Comando: ``` aws apigateway delete-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 ``` + Para ver detalhes da API, consulte [DeleteIntegrationResponse](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-integration-response.html) na *Referência de comandos da AWS CLI*. ### `delete-integration` O código de exemplo a seguir mostra como usar `delete-integration`. **AWS CLI** **Para excluir uma integração para um determinado recurso e método em uma API** Comando: ``` aws apigateway delete-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET ``` + Para ver detalhes da API, consulte [DeleteIntegration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-integration.html) na *Referência de comandos da AWS CLI*. ### `delete-method-response` O código de exemplo a seguir mostra como usar `delete-method-response`. **AWS CLI** **Para excluir uma resposta de método para um determinado recurso, método e código de status em uma API** Comando: ``` aws apigateway delete-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 ``` + Para ver detalhes da API, consulte [DeleteMethodResponse](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-method-response.html) na *Referência de comandos da AWS CLI*. ### `delete-method` O código de exemplo a seguir mostra como usar `delete-method`. **AWS CLI** **Para excluir um método para um determinado recurso em uma API** Comando: ``` aws apigateway delete-method --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET ``` + Para ver detalhes da API, consulte [DeleteMethod](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-method.html) na *Referência de comandos da AWS CLI*. ### `delete-model` O código de exemplo a seguir mostra como usar `delete-model`. **AWS CLI** **Para excluir um modelo na API fornecida** Comando: ``` aws apigateway delete-model --rest-api-id 1234123412 --model-name 'customModel' ``` + Para ver detalhes da API, consulte [DeleteModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-model.html) na *Referência de comandos da AWS CLI*. ### `delete-resource` O código de exemplo a seguir mostra como usar `delete-resource`. **AWS CLI** **Para excluir um recurso em uma API** Comando: ``` aws apigateway delete-resource --rest-api-id 1234123412 --resource-id a1b2c3 ``` + Para ver detalhes da API, consulte [DeleteResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-resource.html) na *Referência de comandos da AWS CLI*. ### `delete-rest-api` O código de exemplo a seguir mostra como usar `delete-rest-api`. **AWS CLI** **Como excluir uma API** Comando: ``` aws apigateway delete-rest-api --rest-api-id 1234123412 ``` + Consulte detalhes da API em [DeleteRestApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-rest-api.html) na *Referência de comandos da AWS CLI*. ### `delete-stage` O código de exemplo a seguir mostra como usar `delete-stage`. **AWS CLI** **Para excluir um estágio em uma API** Comando: ``` aws apigateway delete-stage --rest-api-id 1234123412 --stage-name 'dev' ``` + Para ver detalhes da API, consulte [DeleteStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-stage.html) na *Referência de comandos da AWS CLI*. ### `delete-usage-plan-key` O código de exemplo a seguir mostra como usar `delete-usage-plan-key`. **AWS CLI** **Para remover uma chave de API de um plano de uso** Comando: ``` aws apigateway delete-usage-plan-key --usage-plan-id a1b2c3 --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu ``` + Para ver detalhes da API, consulte [DeleteUsagePlanKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-usage-plan-key.html) na *Referência de comandos da AWS CLI*. ### `delete-usage-plan` O código de exemplo a seguir mostra como usar `delete-usage-plan`. **AWS CLI** **Para excluir um plano de uso** Comando: ``` aws apigateway delete-usage-plan --usage-plan-id a1b2c3 ``` + Para ver detalhes da API, consulte [DeleteUsagePlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-usage-plan.html) na *Referência de comandos da AWS CLI*. ### `flush-stage-authorizers-cache` O código de exemplo a seguir mostra como usar `flush-stage-authorizers-cache`. **AWS CLI** **Para limpar todas as entradas do cache do autorizador em um estágio** Comando: ``` aws apigateway flush-stage-authorizers-cache --rest-api-id 1234123412 --stage-name dev ``` + Para ver detalhes da API, consulte [FlushStageAuthorizersCache](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/flush-stage-authorizers-cache.html) na *Referência de comandos da AWS CLI*. ### `flush-stage-cache` O código de exemplo a seguir mostra como usar `flush-stage-cache`. **AWS CLI** **Para limpar o cache de um estágio da API** O exemplo de `flush-stage-cache` a seguir libera o cache de um estágio. ``` aws apigateway flush-stage-cache \ --rest-api-id 1234123412 \ --stage-name dev ``` Este comando não produz saída. Consulte mais informações em [Liberar o cache de estágio de APIs no API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html#flush-api-caching) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [FlushStageCache](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/flush-stage-cache.html) na *Referência de comandos da AWS CLI*. ### `generate-client-certificate` O código de exemplo a seguir mostra como usar `generate-client-certificate`. **AWS CLI** **Para criar um certificado SSL no lado do cliente** Comando: ``` aws apigateway generate-client-certificate --description 'My First Client Certificate' ``` + Para ver detalhes da API, consulte [GenerateClientCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/generate-client-certificate.html) na *Referência de comandos da AWS CLI*. ### `get-account` O código de exemplo a seguir mostra como usar `get-account`. **AWS CLI** **Para obter as configurações da conta do API Gateway** Comando: ``` aws apigateway get-account ``` Resultado: ``` { "cloudwatchRoleArn": "arn:aws:iam::123412341234:role/APIGatewayToCloudWatchLogsRole", "throttleSettings": { "rateLimit": 500.0, "burstLimit": 1000 } } ``` + Para ver detalhes da API, consulte [GetAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-account.html) na *Referência de comandos da AWS CLI*. ### `get-api-key` O código de exemplo a seguir mostra como usar `get-api-key`. **AWS CLI** **Para obter informações sobre um uma chave de API específica** Comando: ``` aws apigateway get-api-key --api-key 8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk ``` Resultado: ``` { "description": "My first key", "enabled": true, "stageKeys": [ "a1b2c3d4e5/dev", "e5d4c3b2a1/dev" ], "lastUpdatedDate": 1456184515, "createdDate": 1456184452, "id": "8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk", "name": "My key" } ``` + Para ver detalhes da API, consulte [GetApiKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-api-key.html) na *Referência de comandos da AWS CLI*. ### `get-api-keys` O código de exemplo a seguir mostra como usar `get-api-keys`. **AWS CLI** **Para obter a lista de chaves de API** Comando: ``` aws apigateway get-api-keys ``` Resultado: ``` { "items": [ { "description": "My first key", "enabled": true, "stageKeys": [ "a1b2c3d4e5/dev", "e5d4c3b2a1/dev" ], "lastUpdatedDate": 1456184515, "createdDate": 1456184452, "id": "8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk", "name": "My key" } ] } ``` + Para ver detalhes da API, consulte [GetApiKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-api-keys.html) na *Referência de comandos da AWS CLI*. ### `get-authorizer` O código de exemplo a seguir mostra como usar `get-authorizer`. **AWS CLI** **Para obter as configurações do API Gateway por autorizador da API** Comando: ``` aws apigateway get-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3 ``` Resultado: ``` { "authorizerResultTtlInSeconds": 300, "name": "MyAuthorizer", "type": "TOKEN", "identitySource": "method.request.header.Authorization", "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:authorizer_function/invocations", "id": "gfi4n3" } ``` + Para ver detalhes da API, consulte [GetAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-authorizer.html) na *Referência de comandos da AWS CLI*. ### `get-authorizers` O código de exemplo a seguir mostra como usar `get-authorizers`. **AWS CLI** **Para obter a lista de autorizadores de uma API REST** Comando: ``` aws apigateway get-authorizers --rest-api-id 1234123412 ``` Resultado: ``` { "items": [ { "name": "MyAuthorizer", "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:My_Authorizer_Function/invocations", "authorizerResultTtlInSeconds": 300, "identitySource": "method.request.header.Authorization", "type": "TOKEN", "id": "gfi4n3" } ] } ``` + Para ver detalhes da API, consulte [GetAuthorizers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-authorizers.html) na *Referência de comandos da AWS CLI*. ### `get-base-path-mapping` O código de exemplo a seguir mostra como usar `get-base-path-mapping`. **AWS CLI** **Como obter o mapeamento de caminho base para um nome de domínio personalizado** Comando: ``` aws apigateway get-base-path-mapping --domain-name subdomain.domain.tld --base-path v1 ``` Resultado: ``` { "basePath": "v1", "restApiId": "1234w4321e", "stage": "api" } ``` + Consulte detalhes da API em [GetBasePathMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-base-path-mapping.html) na *Referência de comandos da AWS CLI*. ### `get-base-path-mappings` O código de exemplo a seguir mostra como usar `get-base-path-mappings`. **AWS CLI** **Para obter os mapeamentos de caminho base para um nome de domínio personalizado** Comando: ``` aws apigateway get-base-path-mappings --domain-name subdomain.domain.tld ``` Resultado: ``` { "items": [ { "basePath": "(none)", "restApiId": "1234w4321e", "stage": "dev" }, { "basePath": "v1", "restApiId": "1234w4321e", "stage": "api" } ] } ``` + Para ver detalhes da API, consulte [GetBasePathMappings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-base-path-mappings.html) na *Referência de comandos da AWS CLI*. ### `get-client-certificate` O código de exemplo a seguir mostra como usar `get-client-certificate`. **AWS CLI** **Para obter um certificado de cliente** Comando: ``` aws apigateway get-client-certificate --client-certificate-id a1b2c3 ``` + Para ver detalhes da API, consulte [GetClientCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-client-certificate.html) na *Referência de comandos da AWS CLI*. ### `get-client-certificates` O código de exemplo a seguir mostra como usar `get-client-certificates`. **AWS CLI** **Para obter uma lista de certificados de clientes** Comando: ``` aws apigateway get-client-certificates ``` Resultado: ``` { "items": [ { "pemEncodedCertificate": "-----BEGIN CERTIFICATE----- -----END CERTIFICATE-----", "clientCertificateId": "a1b2c3", "expirationDate": 1483556561, "description": "My Client Certificate", "createdDate": 1452020561 } ] } ``` + Para ver detalhes da API, consulte [GetClientCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-client-certificates.html) na *Referência de comandos da AWS CLI*. ### `get-deployment` O código de exemplo a seguir mostra como usar `get-deployment`. **AWS CLI** **Para obter informações sobre uma implantação** Comando: ``` aws apigateway get-deployment --rest-api-id 1234123412 --deployment-id ztt4m2 ``` Resultado: ``` { "description": "myDeployment", "id": "ztt4m2", "createdDate": 1455218022 } ``` + Para ver detalhes da API, consulte [GetDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-deployment.html) na *Referência de comandos da AWS CLI*. ### `get-deployments` O código de exemplo a seguir mostra como usar `get-deployments`. **AWS CLI** **Para obter uma lista de implantações para uma API REST** Comando: ``` aws apigateway get-deployments --rest-api-id 1234123412 ``` Resultado: ``` { "items": [ { "createdDate": 1453797217, "id": "0a2b4c", "description": "Deployed my API for the first time" } ] } ``` + Para ver detalhes da API, consulte [GetDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-deployments.html) na *Referência de comandos da AWS CLI*. ### `get-domain-name-access-associations` O código de exemplo a seguir mostra como usar `get-domain-name-access-associations`. **AWS CLI** **Exemplo 1: como listar todas as associações de acesso a nomes de domínio** O exemplo de `get-domain-name-access-associations` a seguir lista todas as associações de acesso a nomes de domínio. ``` aws apigateway get-domain-name-access-associations ``` Resultado: ``` { "items": [ { "domainNameAccessAssociationArn": "arn:aws:apigateway:us-west-2:012345678910:/domainnameaccessassociations/domainname/my.private.domain.tld/vpcesource/vpce-abcd1234efg "accessAssociationSource": "vpce-abcd1234efg", "accessAssociationSourceType": "VPCE", "domainNameArn" : "arn:aws:apigateway:us-west-2:111122223333:/domainnames/private.example.com+abcd1234" } ] } ``` Consulte mais informações em [Custom domain names for private APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains.html) no *Guia do desenvolvedor do Amazon API Gateway*. **Exemplo 2: como listar todas as associações de acesso a nomes de domínio pertencentes a esta conta da AWS** O exemplo de `get-domain-name-access-associations` a seguir lista todas as associações de acesso a nomes de domínio pertencentes à conta da AWS atual. ``` aws apigateway get-domain-name-access-associations \ --resource-owner SELF ``` Resultado: ``` { "items": [ { "domainNameAccessAssociationArn": "arn:aws:apigateway:us-west-2:012345678910:/domainnameaccessassociations/domainname/my.private.domain.tld/vpcesource/vpce-abcd1234efg "accessAssociationSource": "vpce-abcd1234efg", "accessAssociationSourceType": "VPCE", "domainNameArn" : "arn:aws:apigateway:us-west-2:111122223333:/domainnames/private.example.com+abcd1234" } ] } ``` Consulte mais informações em [Custom domain names for private APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Consulte detalhes da API em [GetDomainNameAccessAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-domain-name-access-associations.html) na *Referência de comandos da AWS CLI*. ### `get-domain-name` O código de exemplo a seguir mostra como usar `get-domain-name`. **AWS CLI** **Exemplo 1: como obter informações sobre um nome de domínio público personalizado** O exemplo de `get-domain-name` a seguir obtém informações sobre um nome de domínio público personalizado. ``` aws apigateway get-domain-name \ --domain-name api.domain.tld ``` Resultado: ``` { "domainName": "api.domain.tld", "distributionDomainName": "d1a2f3a4c5o6d.cloudfront.net", "certificateName": "uploadedCertificate", "certificateUploadDate": 1462565487 } ``` Consulte mais informações em [Nome de domínio personalizado para APIs REST no API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) no *Guia do desenvolvedor do Amazon API Gateway*. **Exemplo 2: como obter informações sobre um nome de domínio privado personalizado** O exemplo de `get-domain-name` a seguir obtém informações sobre um nome de domínio privado personalizado. ``` aws apigateway get-domain-name \ --domain-name api.private.domain.tld \ --domain-name-id abcd1234 ``` Resultado: ``` { "domainName": "my.private.domain.tld", "domainNameId": "abcd1234", "domainNameArn": "arn:aws:apigateway:us-east-1:012345678910:/domainnames/my.private.domain.tld+abcd1234", "certificateArn": "arn:aws:acm:us-east-1:012345678910:certificate/fb1b9770-a305-495d-aefb-27e5e101ff3", "certificateUploadDate": "2024-09-10T10:31:20-07:00", "endpointConfiguration": { "types": [ "PRIVATE" ] }, "domainNameStatus": "AVAILABLE", "securityPolicy": "TLS_1_2", "policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":\"*\",\"Action\":\"execute-api:Invoke\",\"Resource\":\"arn:aws:execute-api:us-east-1:012345678910:/domainnames/my.private.domain.tld+abcd1234\"},{\"Effect\":\"Deny\",\"Principal\":\"*\",\"Action\":\"execute-api:Invoke\",\"Resource\":\"arn:aws:execute-api:us-east-1:012345678910:/domainnames/my.private.domain.tld+abcd1234\",\"Condition\":{\"StringNotEquals\":{\"aws:SourceVpc\":\"vpc-1a2b3c4d\"}}}]}" } ``` Consulte mais informações em [Nome de domínio personalizado para APIs REST no API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [GetDomainName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-domain-name.html) na *Referência de comandos da AWS CLI*. ### `get-domain-names` O código de exemplo a seguir mostra como usar `get-domain-names`. **AWS CLI** **Exemplo 1: como obter uma lista de nomes de domínio personalizados** O comando `get-domain-names` a seguir obtém uma lista de nomes de domínio. ``` aws apigateway get-domain-names ``` Resultado: ``` { "items": [ { "distributionDomainName": "d9511k3l09bkd.cloudfront.net", "certificateUploadDate": 1452812505, "certificateName": "my_custom_domain-certificate", "domainName": "subdomain.domain.tld" } ] } ``` Consulte mais informações em [Custom domain names for private APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains.html) no *Guia do desenvolvedor do Amazon API Gateway*. **Exemplo 2: como obter uma lista de nomes de domínio personalizados pertencentes a esta conta da AWS** O comando `get-domain-names` a seguir obtém uma lista de nomes de domínio pertencentes a esta conta da AWS. ``` aws apigateway get-domain-names \ --resource-owner SELF ``` Resultado: ``` { "items": [ { "domainName": "my.domain.tld", "domainNameArn": "arn:aws:apigateway:us-east-1::/domainnames/my.private.domain.tld", "certificateUploadDate": "2024-08-15T17:02:55-07:00", "regionalDomainName": "d-abcd1234.execute-api.us-east-1.amazonaws.com", "regionalHostedZoneId": "Z1UJRXOUMOOFQ8", "regionalCertificateArn": "arn:aws:acm:us-east-1:012345678910:certificate/fb1b9770-a305-495d-aefb-27e5e101ff3", "endpointConfiguration": { "types": [ "REGIONAL" ] }, "domainNameStatus": "AVAILABLE", "securityPolicy": "TLS_1_2" }, { "domainName": "my.private.domain.tld", "domainNameId": "abcd1234", "domainNameArn": "arn:aws:apigateway:us-east-1:012345678910:/domainnames/my.private.domain.tld+abcd1234", "certificateArn": "arn:aws:acm:us-east-1:012345678910:certificate/fb1b9770-a305-495d-aefb-27e5e101ff3", "certificateUploadDate": "2024-11-26T11:44:40-08:00", "endpointConfiguration": { "types": [ "PRIVATE" ] }, "domainNameStatus": "AVAILABLE", "securityPolicy": "TLS_1_2" } ] } ``` Consulte mais informações em [Custom domain names for private APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains.html) no *Guia do desenvolvedor do Amazon API Gateway*. **Exemplo 3: como obter uma lista de nomes de domínio personalizados pertencentes a outras contas da AWS com as quais você pode criar uma associação de acesso a nomes de domínio** O comando `get-domain-names` a seguir obtém uma lista de nomes de domínio pertencentes a outras contas da AWS com as quais você tem permissão para criar uma associação de acesso a nomes de domínio. ``` aws apigateway get-domain-names \ --resource-owner OTHER_ACCOUNTS ``` Resultado: ``` { "items": [ { "domainName": "my.private.domain.tld", "domainNameId": "abcd1234", "domainNameArn": "arn:aws:apigateway:us-east-1:012345678910:/domainnames/my.private.domain.tld+abcd1234" } ] } ``` Consulte mais informações em [Custom domain names for private APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [GetDomainNames](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-domain-names.html) na *Referência de comandos da AWS CLI*. ### `get-export` O código de exemplo a seguir mostra como usar `get-export`. **AWS CLI** **Para obter o modelo do Swagger JSON de um estágio** Comando: ``` aws apigateway get-export --rest-api-id a1b2c3d4e5 --stage-name dev --export-type swagger /path/to/filename.json ``` **Como obter o modelo Swagger JSON \$1 extensões do API Gateway para um estágio** Comando: ``` aws apigateway get-export --parameters extensions='integrations' --rest-api-id a1b2c3d4e5 --stage-name dev --export-type swagger /path/to/filename.json ``` **Para obter o modelo Swagger JSON \$1 Postman Extensions para um estágio** Comando: ``` aws apigateway get-export --parameters extensions='postman' --rest-api-id a1b2c3d4e5 --stage-name dev --export-type swagger /path/to/filename.json ``` + Para ver detalhes da API, consulte [GetExport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-export.html) na *Referência de comandos da AWS CLI*. ### `get-integration-response` O código de exemplo a seguir mostra como usar `get-integration-response`. **AWS CLI** **Para obter a configuração da resposta de integração para um método HTTP definido no recurso da API REST** Comando: ``` aws apigateway get-integration-response --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET --status-code 200 ``` Resultado: ``` { "statusCode": "200", "responseTemplates": { "application/json": null } } ``` + Para ver detalhes da API, consulte [GetIntegrationResponse](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-integration-response.html) na *Referência de comandos da AWS CLI*. ### `get-integration` O código de exemplo a seguir mostra como usar `get-integration`. **AWS CLI** **Para obter a configuração de integração para um método HTTP definido no recurso da API REST** Comando: ``` aws apigateway get-integration --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET ``` Resultado: ``` { "httpMethod": "POST", "integrationResponses": { "200": { "responseTemplates": { "application/json": null }, "statusCode": "200" } }, "cacheKeyParameters": [], "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:My_Function/invocations", "cacheNamespace": "y9h6rt" } ``` + Para ver detalhes da API, consulte [GetIntegration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-integration.html) na *Referência de comandos da AWS CLI*. ### `get-method-response` O código de exemplo a seguir mostra como usar `get-method-response`. **AWS CLI** **Para obter a configuração do recurso de resposta do método para um método HTTP definido no recurso da API REST** Comando: ``` aws apigateway get-method-response --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET --status-code 200 ``` Resultado: ``` { "responseModels": { "application/json": "Empty" }, "statusCode": "200" } ``` + Para ver detalhes da API, consulte [GetMethodResponse](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-method-response.html) na *Referência de comandos da AWS CLI*. ### `get-method` O código de exemplo a seguir mostra como usar `get-method`. **AWS CLI** **Para obter a configuração do recurso de método para um método HTTP definido no recurso da API REST** Comando: ``` aws apigateway get-method --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET ``` Resultado: ``` { "apiKeyRequired": false, "httpMethod": "GET", "methodIntegration": { "integrationResponses": { "200": { "responseTemplates": { "application/json": null }, "statusCode": "200" } }, "cacheKeyParameters": [], "uri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:My_Function/invocations", "httpMethod": "POST", "cacheNamespace": "y9h6rt", "type": "AWS" }, "requestParameters": {}, "methodResponses": { "200": { "responseModels": { "application/json": "Empty" }, "statusCode": "200" } }, "authorizationType": "NONE" } ``` + Para ver detalhes da API, consulte [GetMethod](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-method.html) na *Referência de comandos da AWS CLI*. ### `get-model-template` O código de exemplo a seguir mostra como usar `get-model-template`. **AWS CLI** **Para obter o modelo de mapeamento para um modelo definido em uma API REST** Comando: ``` aws apigateway get-model-template --rest-api-id 1234123412 --model-name Empty ``` Resultado: ``` { "value": "#set($inputRoot = $input.path('$'))\n{ }" } ``` + Para ver detalhes da API, consulte [GetModelTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-model-template.html) na *Referência de comandos da AWS CLI*. ### `get-model` O código de exemplo a seguir mostra como usar `get-model`. **AWS CLI** **Para obter a configuração de um modelo definido em uma API REST** Comando: ``` aws apigateway get-model --rest-api-id 1234123412 --model-name Empty ``` Resultado: ``` { "contentType": "application/json", "description": "This is a default empty schema model", "name": "Empty", "id": "etd5w5", "schema": "{\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"title\" : \"Empty Schema\",\n \"type\" : \"object\"\n}" } ``` + Para ver detalhes da API, consulte [GetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-model.html) na *Referência de comandos da AWS CLI*. ### `get-models` O código de exemplo a seguir mostra como usar `get-models`. **AWS CLI** **Para obter uma lista de modelos de uma API REST** Comando: ``` aws apigateway get-models --rest-api-id 1234123412 ``` Resultado: ``` { "items": [ { "description": "This is a default error schema model", "schema": "{\n \"$schema\" : \"http://json-schema.org/draft-04/schema#\",\n \"title\" : \"Error Schema\",\n \"type\" : \"object\",\n \"properties\" : {\n \"message\" : { \"type\" : \"string\" }\n }\n}", "contentType": "application/json", "id": "7tpbze", "name": "Error" }, { "description": "This is a default empty schema model", "schema": "{\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"title\" : \"Empty Schema\",\n \"type\" : \"object\"\n}", "contentType": "application/json", "id": "etd5w5", "name": "Empty" } ] } ``` + Para ver detalhes da API, consulte [GetModels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-models.html) na *Referência de comandos da AWS CLI*. ### `get-resource` O código de exemplo a seguir mostra como usar `get-resource`. **AWS CLI** **Para obter informações sobre um recurso** Comando: ``` aws apigateway get-resource --rest-api-id 1234123412 --resource-id zwo0y3 ``` Resultado: ``` { "path": "/path", "pathPart": "path", "id": "zwo0y3", "parentId": "uyokt6ij2g" } ``` + Para ver detalhes da API, consulte [GetResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-resource.html) na *Referência de comandos da AWS CLI*. ### `get-resources` O código de exemplo a seguir mostra como usar `get-resources`. **AWS CLI** **Como obter uma lista de recursos para uma API REST** Comando: ``` aws apigateway get-resources --rest-api-id 1234123412 ``` Resultado: ``` { "items": [ { "path": "/resource/subresource", "resourceMethods": { "POST": {} }, "id": "024ace", "pathPart": "subresource", "parentId": "ai5b02" } ] } ``` + Consulte detalhes da API em [GetResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-resources.html) na *Referência de comandos da AWS CLI*. ### `get-rest-api` O código de exemplo a seguir mostra como usar `get-rest-api`. **AWS CLI** **Para obter informações sobre uma API** Comando: ``` aws apigateway get-rest-api --rest-api-id 1234123412 ``` Resultado: ``` { "name": "myAPI", "id": "o1y243m4f5", "createdDate": 1453416433 } ``` + Para ver detalhes da API, consulte [GetRestApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-rest-api.html) na *Referência de comandos da AWS CLI*. ### `get-rest-apis` O código de exemplo a seguir mostra como usar `get-rest-apis`. **AWS CLI** **Como obter uma lista de APIs REST** Comando: ``` aws apigateway get-rest-apis ``` Resultado: ``` { "items": [ { "createdDate": 1438884790, "id": "12s44z21rb", "name": "My First API" } ] } ``` + Consulte detalhes da API em [GetRestApis](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-rest-apis.html) na *Referência de comandos da AWS CLI*. ### `get-sdk` O código de exemplo a seguir mostra como usar `get-sdk`. **AWS CLI** **Para obter o SDK para Android de um estágio da API REST** Comando: ``` aws apigateway get-sdk --rest-api-id 1234123412 --stage-name dev --sdk-type android --parameters groupId='com.mycompany',invokerPackage='com.mycompany.clientsdk',artifactId='Mycompany-client',artifactVersion='1.0.0' /path/to/android_sdk.zip ``` Resultado: ``` { "contentType": "application/octet-stream", "contentDisposition": "attachment; filename=\"android_2016-02-22_23-52Z.zip\"" } ``` **Para obter o SDK para iOS de um estágio da API REST** Comando: ``` aws apigateway get-sdk --rest-api-id 1234123412 --stage-name dev --sdk-type objectivec --parameters classPrefix='myprefix' /path/to/iOS_sdk.zip ``` Resultado: ``` { "contentType": "application/octet-stream", "contentDisposition": "attachment; filename=\"objectivec_2016-02-22_23-52Z.zip\"" } ``` **Para obter o SDK para Javascript de um estágio da API REST** Comando: ``` aws apigateway get-sdk --rest-api-id 1234123412 --stage-name dev --sdk-type javascript /path/to/javascript_sdk.zip ``` Resultado: ``` { "contentType": "application/octet-stream", "contentDisposition": "attachment; filename=\"javascript_2016-02-22_23-52Z.zip\"" } ``` + Para ver detalhes da API, consulte [GetSdk](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-sdk.html) na *Referência de comandos da AWS CLI*. ### `get-stage` O código de exemplo a seguir mostra como usar `get-stage`. **AWS CLI** **Para obter informações sobre o estágio de uma API** Comando: ``` aws apigateway get-stage --rest-api-id 1234123412 --stage-name dev ``` Resultado: ``` { "stageName": "dev", "cacheClusterSize": "0.5", "cacheClusterEnabled": false, "cacheClusterStatus": "NOT_AVAILABLE", "deploymentId": "rbh1fj", "lastUpdatedDate": 1466802961, "createdDate": 1460682074, "methodSettings": { "*/*": { "cacheTtlInSeconds": 300, "loggingLevel": "INFO", "dataTraceEnabled": false, "metricsEnabled": true, "unauthorizedCacheControlHeaderStrategy": "SUCCEED_WITH_RESPONSE_HEADER", "throttlingRateLimit": 500.0, "cacheDataEncrypted": false, "cachingEnabled": false, "throttlingBurstLimit": 1000, "requireAuthorizationForCacheControl": true }, "~1resource/GET": { "cacheTtlInSeconds": 300, "loggingLevel": "INFO", "dataTraceEnabled": false, "metricsEnabled": true, "unauthorizedCacheControlHeaderStrategy": "SUCCEED_WITH_RESPONSE_HEADER", "throttlingRateLimit": 500.0, "cacheDataEncrypted": false, "cachingEnabled": false, "throttlingBurstLimit": 1000, "requireAuthorizationForCacheControl": true } } } ``` + Para ver detalhes da API, consulte [GetStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-stage.html) na *Referência de comandos da AWS CLI*. ### `get-stages` O código de exemplo a seguir mostra como usar `get-stages`. **AWS CLI** **Para obter a lista de estágios de uma API REST** Comando: ``` aws apigateway get-stages --rest-api-id 1234123412 ``` Resultado: ``` { "item": [ { "stageName": "dev", "cacheClusterSize": "0.5", "cacheClusterEnabled": true, "cacheClusterStatus": "AVAILABLE", "deploymentId": "123h64", "lastUpdatedDate": 1456185138, "createdDate": 1453589092, "methodSettings": { "~1resource~1subresource/POST": { "cacheTtlInSeconds": 300, "loggingLevel": "INFO", "dataTraceEnabled": true, "metricsEnabled": true, "throttlingRateLimit": 500.0, "cacheDataEncrypted": false, "cachingEnabled": false, "throttlingBurstLimit": 1000 } } } ] } ``` + Para ver detalhes da API, consulte [GetStages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-stages.html) na *Referência de comandos da AWS CLI*. ### `get-usage-plan-key` O código de exemplo a seguir mostra como usar `get-usage-plan-key`. **AWS CLI** **Para obter os detalhes de uma chave de API associada a um plano de uso** Comando: ``` aws apigateway get-usage-plan-key --usage-plan-id a1b2c3 --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu ``` + Para ver detalhes da API, consulte [GetUsagePlanKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-usage-plan-key.html) na *Referência de comandos da AWS CLI*. ### `get-usage-plan-keys` O código de exemplo a seguir mostra como usar `get-usage-plan-keys`. **AWS CLI** **Para obter a lista de chaves de API associadas a um plano de uso** Comando: ``` aws apigateway get-usage-plan-keys --usage-plan-id a1b2c3 ``` + Para ver detalhes da API, consulte [GetUsagePlanKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-usage-plan-keys.html) na *Referência de comandos da AWS CLI*. ### `get-usage-plan` O código de exemplo a seguir mostra como usar `get-usage-plan`. **AWS CLI** **Para obter os detalhes de um plano de uso** Comando: ``` aws apigateway get-usage-plan --usage-plan-id a1b2c3 ``` + Para ver detalhes da API, consulte [GetUsagePlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-usage-plan.html) na *Referência de comandos da AWS CLI*. ### `get-usage-plans` O código de exemplo a seguir mostra como usar `get-usage-plans`. **AWS CLI** **Para obter os detalhes de todos os planos de uso** Comando: ``` aws apigateway get-usage-plans ``` + Para ver detalhes da API, consulte [GetUsagePlans](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-usage-plans.html) na *Referência de comandos da AWS CLI*. ### `get-usage` O código de exemplo a seguir mostra como usar `get-usage`. **AWS CLI** **Para obter os detalhes de uso de um plano de uso** Comando: ``` aws apigateway get-usage --usage-plan-id a1b2c3 --start-date "2016-08-16" --end-date "2016-08-17" ``` + Para ver detalhes da API, consulte [GetUsage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-usage.html) na *Referência de comandos da AWS CLI*. ### `import-rest-api` O código de exemplo a seguir mostra como usar `import-rest-api`. **AWS CLI** **Para importar um modelo do Swagger e criar uma API** Comando: ``` aws apigateway import-rest-api --body 'file:///path/to/API_Swagger_template.json' ``` + Para ver detalhes da API, consulte [ImportRestApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/import-rest-api.html) na *Referência de comandos da AWS CLI*. ### `put-integration-response` O código de exemplo a seguir mostra como usar `put-integration-response`. **AWS CLI** **Como criar uma resposta de integração como a resposta padrão com um modelo de mapeamento definido** Comando: ``` aws apigateway put-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --selection-pattern "" --response-templates '{"application/json": "{\"json\": \"template\"}"}' ``` **Como criar uma resposta de integração com um regex de 400 e um valor de cabeçalho definido de forma estática** Comando: ``` aws apigateway put-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 400 --selection-pattern 400 --response-parameters '{"method.response.header.custom-header": "'"'"'custom-value'"'"'"}' ``` + Consulte detalhes da API em [PutIntegrationResponse](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/put-integration-response.html) na *Referência de comandos da AWS CLI*. ### `put-integration` O código de exemplo a seguir mostra como usar `put-integration`. **AWS CLI** **Como criar uma solicitação de integração MOCK** Comando: ``` aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type MOCK --request-templates '{ "application/json": "{\"statusCode\": 200}" }' ``` **Como criar uma solicitação de integração HTTP** Comando: ``` aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type HTTP --integration-http-method GET --uri 'https://domain.tld/path' ``` **Como criar uma solicitação de integração da AWS com um endpoint da função do Lambda** Comando: ``` aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type AWS --integration-http-method POST --uri 'arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:function_name/invocations' ``` + Consulte detalhes da API em [PutIntegration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/put-integration.html) na *Referência de comandos da AWS CLI*. ### `put-method-response` O código de exemplo a seguir mostra como usar `put-method-response`. **AWS CLI** **Como criar uma resposta de método de acordo com o código de status especificado com um cabeçalho de resposta de método personalizado** Comando: ``` aws apigateway put-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 400 --response-parameters "method.response.header.custom-header=false" ``` + Consulte detalhes da API em [PutMethodResponse](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/put-method-response.html) na *Referência de comandos da AWS CLI*. ### `put-method` O código de exemplo a seguir mostra como usar `put-method`. **AWS CLI** **Como criar um método para um recurso em uma API sem autorização, sem chave de API e com um cabeçalho de solicitação de método personalizado** Comando: ``` aws apigateway put-method --rest-api-id 1234123412 --resource-id a1b2c3 --http-method PUT --authorization-type "NONE" --no-api-key-required --request-parameters "method.request.header.custom-header=false" ``` + Consulte detalhes da API em [PutMethod](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/put-method.html) na *Referência de comandos da AWS CLI*. ### `put-rest-api` O código de exemplo a seguir mostra como usar `put-rest-api`. **AWS CLI** **Para substituir uma API existente usando um modelo Swagger** Comando: ``` aws apigateway put-rest-api --rest-api-id 1234123412 --mode overwrite --body 'fileb:///path/to/API_Swagger_template.json' ``` **Para mesclar um modelo do Swagger em uma API existente** Comando: ``` aws apigateway put-rest-api --rest-api-id 1234123412 --mode merge --body 'fileb:///path/to/API_Swagger_template.json' ``` + Para ver detalhes da API, consulte [PutRestApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/put-rest-api.html) na *Referência de comandos da AWS CLI*. ### `reject-domain-name-access-association` O código de exemplo a seguir mostra como usar `reject-domain-name-access-association`. **AWS CLI** **Como rejeitar uma associação de acesso ao nome de domínio** O exemplo de `reject-domain-name-access-association` a seguir rejeita uma associação de acesso ao nome de domínio entre um nome de domínio personalizado privado e um endpoint da VPC. ``` aws apigateway reject-domain-name-access-association \ --domain-name-access-association-arn arn:aws:apigateway:us-west-2:012345678910:/domainnameaccessassociations/domainname/my.private.domain.tld/vpcesource/vpce-abcd1234efg \ --domain-name-arn arn:aws:apigateway:us-east-1:012345678910:/domainnames/my.private.domain.tld+abcd1234 ``` Este comando não produz saída. Consulte mais informações em [Custom domain names for private APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Consulte detalhes da API em [RejectDomainNameAccessAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/reject-domain-name-access-association.html) na *Referência de comandos da AWS CLI*. ### `test-invoke-authorizer` O código de exemplo a seguir mostra como usar `test-invoke-authorizer`. **AWS CLI** **Para testar a invocação de uma solicitação para um autorizador personalizado, incluindo o cabeçalho e o valor necessários** Comando: ``` aws apigateway test-invoke-authorizer --rest-api-id 1234123412 --authorizer-id 5yid1t --headers Authorization='Value' ``` + Para ver detalhes da API, consulte [TestInvokeAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/test-invoke-authorizer.html) na *Referência de comandos da AWS CLI*. ### `test-invoke-method` O código de exemplo a seguir mostra como usar `test-invoke-method`. **AWS CLI** **Para testar a invocação do recurso raiz em uma API fazendo uma solicitação GET** Comando: ``` aws apigateway test-invoke-method --rest-api-id 1234123412 --resource-id avl5sg8fw8 --http-method GET --path-with-query-string '/' ``` **Para testar a invocação de um sub-recurso em uma API fazendo uma solicitação GET com um valor de parâmetro de caminho especificado** Comando: ``` aws apigateway test-invoke-method --rest-api-id 1234123412 --resource-id 3gapai --http-method GET --path-with-query-string '/pets/1' ``` + Para ver detalhes da API, consulte [TestInvokeMethod](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/test-invoke-method.html) na *Referência de comandos da AWS CLI*. ### `update-account` O código de exemplo a seguir mostra como usar `update-account`. **AWS CLI** **Para alterar o ARN do perfil do IAM para registro em log no CloudWatch Logs** Comando: ``` aws apigateway update-account --patch-operations op='replace',path='/cloudwatchRoleArn',value='arn:aws:iam::123412341234:role/APIGatewayToCloudWatchLogs' ``` Resultado: ``` { "cloudwatchRoleArn": "arn:aws:iam::123412341234:role/APIGatewayToCloudWatchLogs", "throttleSettings": { "rateLimit": 1000.0, "burstLimit": 2000 } } ``` + Para ver detalhes da API, consulte [UpdateAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-account.html) na *Referência de comandos da AWS CLI*. ### `update-api-key` O código de exemplo a seguir mostra como usar `update-api-key`. **AWS CLI** **Para alterar o nome de uma chave de API** Comando: ``` aws apigateway update-api-key --api-key sNvjQDMReA1eEQPNAW8r37XsU2rDD7fc7m2SiMnu --patch-operations op='replace',path='/name',value='newName' ``` Resultado: ``` { "description": "currentDescription", "enabled": true, "stageKeys": [ "41t2j324r5/dev" ], "lastUpdatedDate": 1470086052, "createdDate": 1445460347, "id": "sNvjQDMReA1vEQPNzW8r3dXsU2rrD7fcjm2SiMnu", "name": "newName" } ``` **Para desativar a chave de API** Comando: ``` aws apigateway update-api-key --api-key sNvjQDMReA1eEQPNAW8r37XsU2rDD7fc7m2SiMnu --patch-operations op='replace',path='/enabled',value='false' ``` Resultado: ``` { "description": "currentDescription", "enabled": false, "stageKeys": [ "41t2j324r5/dev" ], "lastUpdatedDate": 1470086052, "createdDate": 1445460347, "id": "sNvjQDMReA1vEQPNzW8r3dXsU2rrD7fcjm2SiMnu", "name": "newName" } ``` + Para ver detalhes da API, consulte [UpdateApiKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-api-key.html) na *Referência de comandos da AWS CLI*. ### `update-authorizer` O código de exemplo a seguir mostra como usar `update-authorizer`. **AWS CLI** **Para alterar o nome do autorizador personalizado** Comando: ``` aws apigateway update-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3 --patch-operations op='replace',path='/name',value='testAuthorizer' ``` Resultado: ``` { "authType": "custom", "name": "testAuthorizer", "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthorizer/invocations", "authorizerResultTtlInSeconds": 300, "identitySource": "method.request.header.Authorization", "type": "TOKEN", "id": "gfi4n3" } ``` **Para alterar a função do Lambda que é invocada pelo autorizador personalizado** Comando: ``` aws apigateway update-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3 --patch-operations op='replace',path='/authorizerUri',value='arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:newAuthorizer/invocations' ``` Resultado: ``` { "authType": "custom", "name": "testAuthorizer", "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:newAuthorizer/invocations", "authorizerResultTtlInSeconds": 300, "identitySource": "method.request.header.Authorization", "type": "TOKEN", "id": "gfi4n3" } ``` + Para ver detalhes da API, consulte [UpdateAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-authorizer.html) na *Referência de comandos da AWS CLI*. ### `update-base-path-mapping` O código de exemplo a seguir mostra como usar `update-base-path-mapping`. **AWS CLI** **Como alterar o caminho base de um nome de domínio personalizado** Comando: ``` aws apigateway update-base-path-mapping --domain-name api.domain.tld --base-path prod --patch-operations op='replace',path='/basePath',value='v1' ``` Resultado: ``` { "basePath": "v1", "restApiId": "1234123412", "stage": "api" } ``` + Consulte detalhes da API em [UpdateBasePathMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-base-path-mapping.html) na *Referência de comandos da AWS CLI*. ### `update-client-certificate` O código de exemplo a seguir mostra como usar `update-client-certificate`. **AWS CLI** **Para atualizar a descrição de um certificado de cliente** Comando: ``` aws apigateway update-client-certificate --client-certificate-id a1b2c3 --patch-operations op='replace',path='/description',value='My new description' ``` + Para ver detalhes da API, consulte [UpdateClientCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-client-certificate.html) na *Referência de comandos da AWS CLI*. ### `update-deployment` O código de exemplo a seguir mostra como usar `update-deployment`. **AWS CLI** **Para alterar a descrição de uma implantação** Comando: ``` aws apigateway update-deployment --rest-api-id 1234123412 --deployment-id ztt4m2 --patch-operations op='replace',path='/description',value='newDescription' ``` Resultado: ``` { "description": "newDescription", "id": "ztt4m2", "createdDate": 1455218022 } ``` + Para ver detalhes da API, consulte [UpdateDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-deployment.html) na *Referência de comandos da AWS CLI*. ### `update-domain-name` O código de exemplo a seguir mostra como usar `update-domain-name`. **AWS CLI** **Para alterar o nome do certificado para um nome de domínio personalizado** O exemplo `update-domain-name` a seguir cria o nome de certificado para um domínio personalizado. ``` aws apigateway update-domain-name \ --domain-name api.domain.tld \ --patch-operations op='replace',path='/certificateArn',value='arn:aws:acm:us-west-2:111122223333:certificate/CERTEXAMPLE123EXAMPLE' ``` Resultado: ``` { "domainName": "api.domain.tld", "distributionDomainName": "d123456789012.cloudfront.net", "certificateArn": "arn:aws:acm:us-west-2:111122223333:certificate/CERTEXAMPLE123EXAMPLE", "certificateUploadDate": 1462565487 } ``` Para obter mais informações, consulte [Configurar um nome de domínio personalizado para uma API no API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [UpdateDomainName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-domain-name.html) na *Referência de comandos da AWS CLI*. ### `update-integration-response` O código de exemplo a seguir mostra como usar `update-integration-response`. **AWS CLI** **Para alterar um cabeçalho de resposta de integração para ter um mapeamento estático de '\$1'** Comando: ``` aws apigateway update-integration-response --rest-api-id 1234123412 --resource-id 3gapai --http-method GET --status-code 200 --patch-operations op='replace',path='/responseParameters/method.response.header.Access-Control-Allow-Origin',value='"'"'*'"'"' ``` Resultado: ``` { "statusCode": "200", "responseParameters": { "method.response.header.Access-Control-Allow-Origin": "'*'" } } ``` **Para remover um cabeçalho de resposta de integração** Comando: ``` aws apigateway update-integration-response --rest-api-id 1234123412 --resource-id 3gapai --http-method GET --status-code 200 --patch-operations op='remove',path='/responseParameters/method.response.header.Access-Control-Allow-Origin' ``` + Para ver detalhes da API, consulte [UpdateIntegrationResponse](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-integration-response.html) na *Referência de comandos da AWS CLI*. ### `update-integration` O código de exemplo a seguir mostra como usar `update-integration`. **AWS CLI** **Para adicionar o modelo de mapeamento “Content-Type: application/json” configurado com passagem de entrada** Comando: ``` aws apigateway update-integration \ --rest-api-id a1b2c3d4e5 \ --resource-id a1b2c3 \ --http-method POST \ --patch-operations "op='add',path='/requestTemplates/application~1json'" ``` **Para atualizar (substituir) o modelo de mapeamento “Content-Type: application/json” configurado por um modelo personalizado** Comando: ``` aws apigateway update-integration \ --rest-api-id a1b2c3d4e5 \ --resource-id a1b2c3 \ --http-method POST \ --patch-operations "op='replace',path='/requestTemplates/application~1json',value='{"example": "json"}'" ``` **Para atualizar (substituir) um modelo personalizado associado a “Content-Type: application/json” com Passthrough de entrada** Comando: ``` aws apigateway update-integration \ --rest-api-id a1b2c3d4e5 \ --resource-id a1b2c3 \ --http-method POST \ --patch-operations "op='replace',path='requestTemplates/application~1json'" ``` **Para remover o modelo de mapeamento “Content-Type: application/json** Comando: ``` aws apigateway update-integration \ --rest-api-id a1b2c3d4e5 \ --resource-id a1b2c3 \ --http-method POST \ --patch-operations "op='remove',path='/requestTemplates/application~1json'" ``` + Para ver detalhes da API, consulte [UpdateIntegration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-integration.html) na *Referência de comandos da AWS CLI*. ### `update-method-response` O código de exemplo a seguir mostra como usar `update-method-response`. **AWS CLI** **Para criar um novo cabeçalho de resposta do método para a resposta 200 em um método e defini-lo como não obrigatório (padrão)** Comando: ``` aws apigateway update-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --patch-operations op="add",path="/responseParameters/method.response.header.custom-header",value="false" ``` **Para excluir um modelo de resposta para a resposta 200 em um método** Comando: ``` aws apigateway update-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --patch-operations op="remove",path="/responseModels/application~1json" ``` + Para ver detalhes da API, consulte [UpdateMethodResponse](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-method-response.html) na *Referência de comandos da AWS CLI*. ### `update-method` O código de exemplo a seguir mostra como usar `update-method`. **AWS CLI** **Exemplo 1: modificar um método para exigir uma chave de API** O exemplo `update-method` a seguir modifica o método para exigir uma chave de API. ``` aws apigateway update-method \ --rest-api-id 1234123412 \ --resource-id a1b2c3 \ --http-method GET \ --patch-operations op="replace",path="/apiKeyRequired",value="true" ``` Resultado: ``` { "httpMethod": "GET", "authorizationType": "NONE", "apiKeyRequired": true, "methodResponses": { "200": { "statusCode": "200", "responseModels": {} } }, "methodIntegration": { "type": "AWS", "httpMethod": "POST", "uri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:123456789111:function:hello-world/invocations", "passthroughBehavior": "WHEN_NO_MATCH", "contentHandling": "CONVERT_TO_TEXT", "timeoutInMillis": 29000, "cacheNamespace": "h7i8j9", "cacheKeyParameters": [], "integrationResponses": { "200": { "statusCode": "200", "responseTemplates": {} } } } } ``` **Exemplo 2: modificar um método para exigir autorização do IAM** O exemplo `update-method` a seguir modifica o método para exigir autorização do IAM. ``` aws apigateway update-method \ --rest-api-id 1234123412 \ --resource-id a1b2c3 \ --http-method GET \ --patch-operations op="replace",path="/authorizationType",value="AWS_IAM" ``` Resultado: ``` { "httpMethod": "GET", "authorizationType": "AWS_IAM", "apiKeyRequired": false, "methodResponses": { "200": { "statusCode": "200", "responseModels": {} } }, "methodIntegration": { "type": "AWS", "httpMethod": "POST", "uri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:123456789111:function:hello-world/invocations", "passthroughBehavior": "WHEN_NO_MATCH", "contentHandling": "CONVERT_TO_TEXT", "timeoutInMillis": 29000, "cacheNamespace": "h7i8j9", "cacheKeyParameters": [], "integrationResponses": { "200": { "statusCode": "200", "responseTemplates": {} } } } } ``` **Exemplo 3: modificar um método para exigir autorização do Lambda** O exemplo `update-method` a seguir modifica o método para a autorização do Lambda necessária. ``` aws apigateway update-method --rest-api-id 1234123412 \ --resource-id a1b2c3 \ --http-method GET \ --patch-operations op="replace",path="/authorizationType",value="CUSTOM" op="replace",path="/authorizerId",value="e4f5g6" ``` Resultado: ``` { "httpMethod": "GET", "authorizationType": "CUSTOM", "authorizerId" : "e4f5g6", "apiKeyRequired": false, "methodResponses": { "200": { "statusCode": "200", "responseModels": {} } }, "methodIntegration": { "type": "AWS", "httpMethod": "POST", "uri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:123456789111:function:hello-world/invocations", "passthroughBehavior": "WHEN_NO_MATCH", "contentHandling": "CONVERT_TO_TEXT", "timeoutInMillis": 29000, "cacheNamespace": "h7i8j9", "cacheKeyParameters": [], "integrationResponses": { "200": { "statusCode": "200", "responseTemplates": {} } } } } ``` Para obter mais informações, consulte [Criar, configurar e testar planos de uso usando a CLI do API Gateway e a API REST](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-usage-plans-with-rest-api.html) e [Como controlar e gerenciar o acesso a uma API REST no API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-control-access-to-api.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [UpdateMethod](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-method.html) na *Referência de comandos da AWS CLI*. ### `update-model` O código de exemplo a seguir mostra como usar `update-model`. **AWS CLI** **Para alterar a descrição de um modelo em uma API** Comando: ``` aws apigateway update-model --rest-api-id 1234123412 --model-name 'Empty' --patch-operations op=replace,path=/description,value='New Description' ``` **Para alterar o esquema de um modelo em uma API** Comando: ``` aws apigateway update-model --rest-api-id 1234123412 --model-name 'Empty' --patch-operations op=replace,path=/schema,value='"{ \"$schema\": \"http://json-schema.org/draft-04/schema#\", \"title\" : \"Empty Schema\", \"type\" : \"object\" }"' ``` + Para ver detalhes da API, consulte [UpdateModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-model.html) na *Referência de comandos da AWS CLI*. ### `update-resource` O código de exemplo a seguir mostra como usar `update-resource`. **AWS CLI** **Para mover um recurso e colocá-lo em um recurso principal diferente em uma API** Comando: ``` aws apigateway update-resource --rest-api-id 1234123412 --resource-id 1a2b3c --patch-operations op=replace,path=/parentId,value='3c2b1a' ``` Resultado: ``` { "path": "/resource", "pathPart": "resource", "id": "1a2b3c", "parentId": "3c2b1a" } ``` **Para renomear um recurso (pathPart) em uma API** Comando: ``` aws apigateway update-resource --rest-api-id 1234123412 --resource-id 1a2b3c --patch-operations op=replace,path=/pathPart,value=newresourcename ``` Resultado: ``` { "path": "/newresourcename", "pathPart": "newresourcename", "id": "1a2b3c", "parentId": "3c2b1a" } ``` + Para ver detalhes da API, consulte [UpdateResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-resource.html) na *Referência de comandos da AWS CLI*. ### `update-rest-api` O código de exemplo a seguir mostra como usar `update-rest-api`. **AWS CLI** **Para alterar o nome de uma API** Comando: ``` aws apigateway update-rest-api --rest-api-id 1234123412 --patch-operations op=replace,path=/name,value='New Name' ``` **Para alterar a descrição de uma API** Comando: ``` aws apigateway update-rest-api --rest-api-id 1234123412 --patch-operations op=replace,path=/description,value='New Description' ``` + Para ver detalhes da API, consulte [UpdateRestApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-rest-api.html) na *Referência de comandos da AWS CLI*. ### `update-stage` O código de exemplo a seguir mostra como usar `update-stage`. **AWS CLI** **Exemplo 1: substituir as configurações do estágio de um recurso e método** O exemplo `update-stage` a seguir substitui as configurações do estágio e desativa o registro em log completo de solicitação/resposta para um recurso e método específicos. ``` aws apigateway update-stage \ --rest-api-id 1234123412 \ --stage-name 'dev' \ --patch-operations op=replace,path=/~1resourceName/GET/logging/dataTrace,value=false ``` Resultado: ``` { "deploymentId": "5ubd17", "stageName": "dev", "cacheClusterEnabled": false, "cacheClusterStatus": "NOT_AVAILABLE", "methodSettings": { "~1resourceName/GET": { "metricsEnabled": false, "dataTraceEnabled": false, "throttlingBurstLimit": 5000, "throttlingRateLimit": 10000.0, "cachingEnabled": false, "cacheTtlInSeconds": 300, "cacheDataEncrypted": false, "requireAuthorizationForCacheControl": true, "unauthorizedCacheControlHeaderStrategy": "SUCCEED_WITH_RESPONSE_HEADER" } }, "tracingEnabled": false, "createdDate": "2022-07-18T10:11:18-07:00", "lastUpdatedDate": "2022-07-18T10:19:04-07:00" } ``` Para obter mais informações, consulte [Como configurar um estágio em uma API REST](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-stages.html) no *Guia do desenvolvedor do Amazon API Gateway*. **Exemplo 2: atualizar as configurações do estágio para todos os recursos e métodos de um estágio de API** O exemplo `update-stage` a seguir ativa o registro em log completo de solicitações/respostas para todos os recursos e métodos de um estágio de API. ``` aws apigateway update-stage \ --rest-api-id 1234123412 \ --stage-name 'dev' \ --patch-operations 'op=replace,path=/*/*/logging/dataTrace,value=true' ``` Resultado: ``` { "deploymentId": "5ubd17", "stageName": "dev", "cacheClusterEnabled": false, "cacheClusterStatus": "NOT_AVAILABLE", "methodSettings": { "*/*": { "metricsEnabled": false, "dataTraceEnabled": true, "throttlingBurstLimit": 5000, "throttlingRateLimit": 10000.0, "cachingEnabled": false, "cacheTtlInSeconds": 300, "cacheDataEncrypted": false, "requireAuthorizationForCacheControl": true, "unauthorizedCacheControlHeaderStrategy": "SUCCEED_WITH_RESPONSE_HEADER" } }, "tracingEnabled": false, "createdDate": "2022-07-18T10:11:18-07:00", "lastUpdatedDate": "2022-07-18T10:31:04-07:00" } ``` Para obter mais informações, consulte [Como configurar um estágio em uma API REST](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-stages.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [UpdateStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-stage.html) na *Referência de comandos da AWS CLI*. ### `update-usage-plan` O código de exemplo a seguir mostra como usar `update-usage-plan`. **AWS CLI** **Para alterar o período definido em um plano de uso** Comando: ``` aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/quota/period",value="MONTH" ``` **Para alterar o limite de cota definido em um plano de uso** Comando: ``` aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/quota/limit",value="500" ``` **Para alterar o limite da taxa de controle de utilização definido em um plano de uso** Comando: ``` aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/throttle/rateLimit",value="10" ``` **Para alterar o limite de pico de controle de utilização definido em um plano de uso** Comando: ``` aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/throttle/burstLimit",value="20" ``` + Para ver detalhes da API, consulte [UpdateUsagePlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-usage-plan.html) na *Referência de comandos da AWS CLI*. ### `update-usage` O código de exemplo a seguir mostra como usar `update-usage`. **AWS CLI** **Para modificar temporariamente a cota em uma chave de API para o período atual definido no plano de uso** Comando: ``` aws apigateway update-usage --usage-plan-id a1b2c3 --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu --patch-operations op="replace",path="/remaining",value="50" ``` + Para ver detalhes da API, consulte [UpdateUsage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-usage.html) na *Referência de comandos da AWS CLI*. ### `update-vpc-link` O código de exemplo a seguir mostra como usar `update-vpc-link`. **AWS CLI** **Exemplo 1: atualizar o nome de um link existente da VPC** O exemplo de `update-vpc-link` a seguir atualiza o nome do link especificado da VPC. ``` aws apigateway update-vpc-link \ --vpc-link-id ab3de6 \ --patch-operations op=replace,path=/name,value=my-vpc-link ``` Resultado: ``` { "id": "ab3de6", "name": "my-vpc-link", "targetArns": [ "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/my-lb/12a456s89aaa12345" ], "status": "AVAILABLE", "statusMessage": "Your vpc link is ready for use", "tags": {} } ``` Para ter mais informações, consulte [update-vpc-link](https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-vpc-link.html) na *Referência de comandos da AWS CLI*. **Exemplo 2: atualizar o nome e a descrição de um link existente da VPC** O exemplo de `update-vpc-link` a seguir atualiza o nome do link especificado da VPC. ``` aws apigateway update-vpc-link \ --vpc-link-id ab3de6 \ --patch-operations op=replace,path=/name,value=my-vpc-link op=replace,path=/description,value="My custom description" ``` Resultado: ``` { "id": "ab3de6", "name": "my-vpc-link", "description": "My custom description", "targetArns": [ "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/my-lb/12a456s89aaa12345" ], "status": "AVAILABLE", "statusMessage": "Your vpc link is ready for use", "tags": {} } ``` Para ter mais informações, consulte [update-vpc-link](https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-vpc-link.html) na *Referência de comandos da AWS CLI*. + Para ver detalhes da API, consulte [UpdateVpcLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-vpc-link.html) na *Referência de comandos da AWS CLI*. # Exemplos de HTTP do API Gateway e API de WebSocket usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com HTTP do API Gateway e API de WebSocket. *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 ### `create-api-mapping` O código de exemplo a seguir mostra como usar `create-api-mapping`. **AWS CLI** **Para criar um mapeamento de API para uma API** O exemplo `create-api-mapping` a seguir mapeia o estágio `test` de uma API para o caminho `/myApi` do nome de domínio personalizado `regional.example.com`. ``` aws apigatewayv2 create-api-mapping \ --domain-name regional.example.com \ --api-mapping-key myApi \ --api-id a1b2c3d4 \ --stage test ``` Resultado: ``` { "ApiId": "a1b2c3d4", "ApiMappingId": "0qzs2sy7bh", "ApiMappingKey": "myApi" "Stage": "test" } ``` Para obter mais informações, consulte [Configurar um nome de domínio personalizado regional no API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [CreateApiMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-api-mapping.html) na *Referência de comandos da AWS CLI*. ### `create-api` O código de exemplo a seguir mostra como usar `create-api`. **AWS CLI** **Para criar uma API HTTP** O exemplo `create-api` a seguir cria uma API HTTP usando a criação rápida. É possível usar a criação rápida para criar uma API com uma integração do AWS Lambda ou HTTP, uma rota padrão genérica e um estágio padrão configurado para implantar alterações automaticamente. O comando a seguir usa criação rápida para criar uma API HTTP que se integra com uma função do Lambda. ``` aws apigatewayv2 create-api \ --name my-http-api \ --protocol-type HTTP \ --target arn:aws:lambda:us-west-2:123456789012:function:my-lambda-function ``` Resultado: ``` { "ApiEndpoint": "https://a1b2c3d4.execute-api.us-west-2.amazonaws.com", "ApiId": "a1b2c3d4", "ApiKeySelectionExpression": "$request.header.x-api-key", "CreatedDate": "2020-04-08T19:05:45+00:00", "Name": "my-http-api", "ProtocolType": "HTTP", "RouteSelectionExpression": "$request.method $request.path" } ``` Para obter mais informações, consulte [Desenvolver uma API HTTP no API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop.html) no *Guia do desenvolvedor do Amazon API Gateway*. **Para criar uma API de WebSocket** O exemplo `create-api` a seguir cria uma API de WebSocket com o nome especificado. ``` aws apigatewayv2 create-api \ --name "myWebSocketApi" \ --protocol-type WEBSOCKET \ --route-selection-expression '$request.body.action' ``` Resultado: ``` { "ApiKeySelectionExpression": "$request.header.x-api-key", "Name": "myWebSocketApi", "CreatedDate": "2018-11-15T06:23:51Z", "ProtocolType": "WEBSOCKET", "RouteSelectionExpression": "'$request.body.action'", "ApiId": "aabbccddee" } ``` Para obter mais informações, consulte [Criar uma API de WebSocket no API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-create-empty-api.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [CreateApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-api.html) na *Referência de comandos da AWS CLI*. ### `create-authorizer` O código de exemplo a seguir mostra como usar `create-authorizer`. **AWS CLI** **Para criar um autorizador JWT para uma API HTTP** O exemplo `create-authorizer` a seguir cria um autorizador JWT que usa o Amazon Cognito como um provedor de identidade. ``` aws apigatewayv2 create-authorizer \ --name my-jwt-authorizer \ --api-id a1b2c3d4 \ --authorizer-type JWT \ --identity-source '$request.header.Authorization' \ --jwt-configuration Audience=123456abc,Issuer=https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123 ``` Resultado: ``` { "AuthorizerId": "a1b2c3", "AuthorizerType": "JWT", "IdentitySource": [ "$request.header.Authorization" ], "JwtConfiguration": { "Audience": [ "123456abc" ], "Issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123" }, "Name": "my-jwt-authorizer" } ``` Para obter mais informações, consulte [Controlar o acesso a APIs HTTP com autorizadores JWT](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [CreateAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-authorizer.html) na *Referência de comandos da AWS CLI*. ### `create-deployment` O código de exemplo a seguir mostra como usar `create-deployment`. **AWS CLI** **Para criar uma implantação para uma API** O exemplo `create-deployment` a seguir cria uma implantação para uma API e a associa ao estágio `dev` da API. ``` aws apigatewayv2 create-deployment \ --api-id a1b2c3d4 \ --stage-name dev ``` Resultado: ``` { "AutoDeployed": false, "CreatedDate": "2020-04-06T23:38:08Z", "DeploymentId": "53lz9l", "DeploymentStatus": "DEPLOYED" } ``` Para obter mais informações, consulte [Implantação da API](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html#apigateway-definition-api-deployment) no *Guia do desenvolvedor do Amazon API Gateway*. + Consulte detalhes da API em [CreateDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-deployment.html) na *Referência de comandos da AWS CLI*. ### `create-domain-name` O código de exemplo a seguir mostra como usar `create-domain-name`. **AWS CLI** **Para criar um nome de domínio personalizado** O exemplo `create-domain-name` a seguir cria um domínio personalizado regional para uma API. ``` aws apigatewayv2 create-domain-name \ --domain-name regional.example.com \ --domain-name-configurations CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678 ``` Resultado: ``` { "ApiMappingSelectionExpression": "$request.basepath", "DomainName": "regional.example.com", "DomainNameConfigurations": [ { "ApiGatewayDomainName": "d-id.execute-api.us-west-2.amazonaws.com", "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678", "EndpointType": "REGIONAL", "HostedZoneId": "123456789111", "SecurityPolicy": "TLS_1_2", "DomainNameStatus": "AVAILABLE" } ] } ``` Para obter mais informações, consulte [Configurar um nome de domínio personalizado regional no API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [CreateDomainName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-domain-name.html) na *Referência de comandos da AWS CLI*. ### `create-integration` O código de exemplo a seguir mostra como usar `create-integration`. **AWS CLI** **Para criar uma integração com a API de WebSocket** O exemplo `create-integration` a seguir cria uma integração simulada para uma API de WebSocket. ``` aws apigatewayv2 create-integration \ --api-id aabbccddee \ --passthrough-behavior WHEN_NO_MATCH \ --timeout-in-millis 29000 \ --connection-type INTERNET \ --integration-type MOCK ``` Resultado: ``` { "ConnectionType": "INTERNET", "IntegrationId": "0abcdef", "IntegrationResponseSelectionExpression": "${integration.response.statuscode}", "IntegrationType": "MOCK", "PassthroughBehavior": "WHEN_NO_MATCH", "PayloadFormatVersion": "1.0", "TimeoutInMillis": 29000 } ``` Para obter mais informações, consulte [Configurar uma solicitação de integração da API de WebSocket no API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-requests.html) no *Guia do desenvolvedor do Amazon API Gateway*. **Para criar uma integração da API HTTP** O exemplo `create-integration` a seguir cria uma integração do AWS Lambda para uma API HTTP. ``` aws apigatewayv2 create-integration \ --api-id a1b2c3d4 \ --integration-type AWS_PROXY \ --integration-uri arn:aws:lambda:us-west-2:123456789012:function:my-function \ --payload-format-version 2.0 ``` Resultado: ``` { "ConnectionType": "INTERNET", "IntegrationId": "0abcdef", "IntegrationMethod": "POST", "IntegrationType": "AWS_PROXY", "IntegrationUri": "arn:aws:lambda:us-west-2:123456789012:function:my-function", "PayloadFormatVersion": "2.0", "TimeoutInMillis": 30000 } ``` Para obter mais informações, consulte [Configurar o integrações para APIs HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [CreateIntegration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-integration.html) na *Referência de comandos da AWS CLI*. ### `create-route` O código de exemplo a seguir mostra como usar `create-route`. **AWS CLI** **Para criar uma rota \$1default para uma API de WebSocket ou HTTP** O exemplo `create-route` a seguir cria uma rota `$default` para uma API de WebSocket ou HTTP. ``` aws apigatewayv2 create-route \ --api-id aabbccddee \ --route-key '$default' ``` Resultado: ``` { "ApiKeyRequired": false, "AuthorizationType": "NONE", "RouteKey": "$default", "RouteId": "1122334" } ``` Para obter mais informações, consulte [Trabalhar com rotas para APIs de WebSocket](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-add-route.html) no *Guia do desenvolvedor do Amazon API Gateway*. **Para criar uma rota para uma API HTTP** O exemplo `create-route` a seguir cria uma rota chamada `signup` que aceita solicitações POST. ``` aws apigatewayv2 create-route \ --api-id aabbccddee \ --route-key 'POST /signup' ``` Resultado: ``` { "ApiKeyRequired": false, "AuthorizationType": "NONE", "RouteKey": "POST /signup", "RouteId": "1122334" } ``` Para obter mais informações, consulte [Trabalhar com rotas para APIs HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html) no *Guia do desenvolvedor do Amazon API Gateway* + Para ver detalhes da API, consulte [CreateRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-route.html) na *Referência de comandos da AWS CLI*. ### `create-routing-rule` O código de exemplo a seguir mostra como usar `create-routing-rule`. **AWS CLI** **Como criar uma regra de roteamento** O exemplo `create-routing-rule` a seguir cria uma regra de roteamento com uma prioridade de `50`. ``` aws apigatewayv2 create-routing-rule \ --domain-name 'regional.example.com' \ --priority 50 \ --conditions '[ \ { \ "MatchBasePaths": { \ "AnyOf": [ \ "PetStoreShopper" \ ] \ } \ } \ ]' \ --actions '[ \ { \ "InvokeApi": { \ "ApiId": "abcd1234", \ "Stage": "prod" \ } \ } \ ]' ``` Resultado: ``` { "Actions": [ { "InvokeApi": { "ApiId": "abcd1234", "Stage": "prod", "StripBasePath": false } } ], "Conditions": [ { "MatchBasePaths": { "AnyOf": [ "PetStoreShopper" ] } } ], "Priority": 50, "RoutingRuleArn": "arn:aws:apigateway:us-east-2:123456789012:/domainnames/regional.example.com/routingrules/aaa111", "RoutingRuleId": "aaa111" } ``` Para ter mais informações, consulte [Regras de roteamento para associar estágios da API a um nome de domínio personalizado para APIs REST](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [CreateRoutingRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-routing-rule.html) na *Referência de comandos da AWS CLI*. ### `create-stage` O código de exemplo a seguir mostra como usar `create-stage`. **AWS CLI** **Para criar um estágio** O exemplo `create-stage` a seguir cria um estágio chamado dev para uma API. ``` aws apigatewayv2 create-stage \ --api-id a1b2c3d4 \ --stage-name dev ``` Resultado: ``` { "CreatedDate": "2020-04-06T23:23:46Z", "DefaultRouteSettings": { "DetailedMetricsEnabled": false }, "LastUpdatedDate": "2020-04-06T23:23:46Z", "RouteSettings": {}, "StageName": "dev", "StageVariables": {}, "Tags": {} } ``` Para obter mais informações, consulte [Trabalhar com estágios para APIs HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-stages.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [CreateStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-stage.html) na *Referência de comandos da AWS CLI*. ### `create-vpc-link` O código de exemplo a seguir mostra como usar `create-vpc-link`. **AWS CLI** **Para criar um link da VPC para uma API HTTP** O exemplo `create-vpc-link` a seguir cria um link da VPC para APIs HTTP. ``` aws apigatewayv2 create-vpc-link \ --name MyVpcLink \ --subnet-ids subnet-aaaa subnet-bbbb \ --security-group-ids sg1234 sg5678 ``` Resultado: ``` { "CreatedDate": "2020-04-07T00:11:46Z", "Name": "MyVpcLink", "SecurityGroupIds": [ "sg1234", "sg5678" ], "SubnetIds": [ "subnet-aaaa", "subnet-bbbb" ], "Tags": {}, "VpcLinkId": "abcd123", "VpcLinkStatus": "PENDING", "VpcLinkStatusMessage": "VPC link is provisioning ENIs", "VpcLinkVersion": "V2" } ``` Para obter mais informações, consulte [Trabalhar com links da VPC para APIs HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [CreateVpcLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-vpc-link.html) na *Referência de comandos da AWS CLI*. ### `delete-access-log-settings` O código de exemplo a seguir mostra como usar `delete-access-log-settings`. **AWS CLI** **Para desativar o registro em log de acesso para uma API** O exemplo `delete-access-log-settings` a seguir exclui as configurações do registro em log de acesso do estágio `$default` de uma API. Para desabilitar o registro de acesso em log de um estágio, exclua as configurações do log de acesso. ``` aws apigatewayv2 delete-access-log-settings \ --api-id a1b2c3d4 \ --stage-name '$default' ``` Este comando não produz saída. Para obter mais informações, consulte [Configurar o registros em log para uma API HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-logging.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [DeleteAccessLogSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-access-log-settings.html) na *Referência de comandos da AWS CLI*. ### `delete-api-mapping` O código de exemplo a seguir mostra como usar `delete-api-mapping`. **AWS CLI** **Para excluir um mapeamento de API** O exemplo `delete-api-mapping` a seguir exclui um mapeamento de API do nome de domínio personalizado `api.example.com`. ``` aws apigatewayv2 delete-api-mapping \ --api-mapping-id a1b2c3 \ --domain-name api.example.com ``` Este comando não produz saída. Para obter mais informações, consulte [Configurar um nome de domínio personalizado regional no API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [DeleteApiMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-api-mapping.html) na *Referência de comandos da AWS CLI*. ### `delete-api` O código de exemplo a seguir mostra como usar `delete-api`. **AWS CLI** **Como excluir uma API** O exemplo `delete-api` a seguir exclui uma API. ``` aws apigatewayv2 delete-api \ --api-id a1b2c3d4 ``` Este comando não produz saída. Para obter mais informações, consulte [Trabalhar com APIs HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) e [Trabalhar com APIs de WebSocket](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [DeleteApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-api.html) na *Referência de comandos da AWS CLI*. ### `delete-authorizer` O código de exemplo a seguir mostra como usar `delete-authorizer`. **AWS CLI** **Para excluir um autorizador** O exemplo `delete-authorizer` a seguir exclui um autorizador. ``` aws apigatewayv2 delete-authorizer \ --api-id a1b2c3d4 \ --authorizer-id a1b2c3 ``` Este comando não produz saída. Para obter mais informações, consulte [Controlar o acesso a APIs HTTP com autorizadores JWT](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [DeleteAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-authorizer.html) na *Referência de comandos da AWS CLI*. ### `delete-cors-configuration` O código de exemplo a seguir mostra como usar `delete-cors-configuration`. **AWS CLI** **Para excluir a configuração CORS de uma API HTTP** O exemplo `delete-cors-configuration` a seguir desabilita o CORS para uma API HTTP excluindo sua configuração de CORS. ``` aws apigatewayv2 delete-cors-configuration \ --api-id a1b2c3d4 ``` Este comando não produz saída. Para obter mais informações, consulte [Configurar o CORS para uma API HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [DeleteCorsConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-cors-configuration.html) na *Referência de comandos da AWS CLI*. ### `delete-deployment` O código de exemplo a seguir mostra como usar `delete-deployment`. **AWS CLI** **Para excluir uma implantação** O exemplo `delete-deployment` a seguir exclui uma implantação de uma API. ``` aws apigatewayv2 delete-deployment \ --api-id a1b2c3d4 \ --deployment-id a1b2c3 ``` Este comando não produz saída. Para obter mais informações, consulte [Implantação da API](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html#apigateway-definition-api-deployment) no *Guia do desenvolvedor do Amazon API Gateway*. + Consulte detalhes da API em [DeleteDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-deployment.html) na *Referência de comandos da AWS CLI*. ### `delete-domain-name` O código de exemplo a seguir mostra como usar `delete-domain-name`. **AWS CLI** **Para excluir um nome de domínio personalizado** O exemplo `delete-domain-name` a seguir exclui um nome de domínio personalizado. ``` aws apigatewayv2 delete-domain-name \ --domain-name api.example.com ``` Este comando não produz saída. Para obter mais informações, consulte [Configurar um nome de domínio personalizado regional no API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [DeleteDomainName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-domain-name.html) na *Referência de comandos da AWS CLI*. ### `delete-integration` O código de exemplo a seguir mostra como usar `delete-integration`. **AWS CLI** **Para excluir uma integração** O exemplo `delete-integration` a seguir exclui uma integração de API. ``` aws apigatewayv2 delete-integration \ --api-id a1b2c3d4 \ --integration-id a1b2c3 ``` Este comando não produz saída. Para obter mais informações, consulte [Configurar integrações para APIs HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html) e [Configurar integrações de APIs de WebSocket](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integrations.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [DeleteIntegration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-integration.html) na *Referência de comandos da AWS CLI*. ### `delete-route-settings` O código de exemplo a seguir mostra como usar `delete-route-settings`. **AWS CLI** **Para excluir as configurações de rota** O exemplo `delete-route-settings` a seguir exclui as configurações de rota para a rota especificada. ``` aws apigatewayv2 delete-route-settings \ --api-id a1b2c3d4 \ --stage-name dev \ --route-key 'GET /pets' ``` Este comando não produz saída. Para obter mais informações, consulte [Trabalhar com rotas para APIs HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [DeleteRouteSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-route-settings.html) na *Referência de comandos da AWS CLI*. ### `delete-route` O código de exemplo a seguir mostra como usar `delete-route`. **AWS CLI** **Para excluir uma rota** O exemplo `delete-route` a seguir exclui uma rota da API. ``` aws apigatewayv2 delete-route \ --api-id a1b2c3d4 \ --route-id a1b2c3 ``` Este comando não produz saída. Para obter mais informações, consulte [Trabalhar com rotas para APIs HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [DeleteRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-route.html) na *Referência de comandos da AWS CLI*. ### `delete-routing-rule` O código de exemplo a seguir mostra como usar `delete-routing-rule`. **AWS CLI** **Como excluir uma regra de roteamento** O exemplo `delete-routing-rule` a seguir exclui uma regra de roteamento para um nome de domínio personalizado. ``` aws apigatewayv2 delete-routing-rule \ --domain-name 'regional.example.com' \ --routing-rule-id aaa111 ``` Este comando não produz saída. Para ter mais informações, consulte [Regras de roteamento para associar estágios da API a um nome de domínio personalizado para APIs REST](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [DeleteRoutingRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-routing-rule.html) na *Referência de comandos da AWS CLI*. ### `delete-stage` O código de exemplo a seguir mostra como usar `delete-stage`. **AWS CLI** **Para excluir uma estágio** O exemplo `delete-stage` a seguir exclui o estágio `test` de uma API. ``` aws apigatewayv2 delete-stage \ --api-id a1b2c3d4 \ --stage-name test ``` Este comando não produz saída. Para obter mais informações, consulte [Trabalhar com estágios para APIs HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-stages.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [DeleteStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-stage.html) na *Referência de comandos da AWS CLI*. ### `delete-vpc-link` O código de exemplo a seguir mostra como usar `delete-vpc-link`. **AWS CLI** **Para excluir um link da VPC para uma API HTTP** O exemplo `delete-vpc-link` a seguir exclui um link da VPC. ``` aws apigatewayv2 delete-vpc-link \ --vpc-link-id abcd123 ``` Este comando não produz saída. Para obter mais informações, consulte [Trabalhar com links da VPC para APIs HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [DeleteVpcLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-vpc-link.html) na *Referência de comandos da AWS CLI*. ### `export-api` O código de exemplo a seguir mostra como usar `export-api`. **AWS CLI** **Para exportar uma definição do OpenAPI de uma API HTTP** O exemplo `export-api` a seguir exporta uma definição do OpenAPI 3.0 de um estágio de API chamado `prod` para um arquivo YAML denominado `stage-definition.yaml`. O arquivo de definição exportado inclui extensões do API Gateway por padrão. ``` aws apigatewayv2 export-api \ --api-id a1b2c3d4 \ --output-type YAML \ --specification OAS30 \ --stage-name prod \ stage-definition.yaml ``` Este comando não produz saída. Para obter mais informações, consulte [Exportar uma API HTTP do API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-export.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [ExportApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/export-api.html) na *Referência de comandos da AWS CLI*. ### `get-api-mapping` O código de exemplo a seguir mostra como usar `get-api-mapping`. **AWS CLI** **Para obter informações sobre um mapeamento de API para um nome de domínio personalizado** O exemplo `get-api-mapping` a seguir exibe informações sobre um mapeamento de API para o nome de domínio personalizado `api.example.com`. ``` aws apigatewayv2 get-api-mapping \ --api-mapping-id a1b2c3 \ --domain-name api.example.com ``` Resultado: ``` { "ApiId": "a1b2c3d4", "ApiMappingId": "a1b2c3d5", "ApiMappingKey": "myTestApi" "Stage": "test" } ``` Para obter mais informações, consulte [Configurar um nome de domínio personalizado regional no API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [GetApiMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-api-mapping.html) na *Referência de comandos da AWS CLI*. ### `get-api-mappings` O código de exemplo a seguir mostra como usar `get-api-mappings`. **AWS CLI** **Para obter mapeamentos de API para um nome de domínio personalizado** O exemplo `get-api-mappings` a seguir exibe uma lista de todos os mapeamentos de API para o nome de domínio personalizado `api.example.com`. ``` aws apigatewayv2 get-api-mappings \ --domain-name api.example.com ``` Resultado: ``` { "Items": [ { "ApiId": "a1b2c3d4", "ApiMappingId": "a1b2c3d5", "ApiMappingKey": "myTestApi" "Stage": "test" }, { "ApiId": "a5b6c7d8", "ApiMappingId": "a1b2c3d6", "ApiMappingKey": "myDevApi" "Stage": "dev" }, ] } ``` Para obter mais informações, consulte [Configurar um nome de domínio personalizado regional no API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [GetApiMappings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-api-mappings.html) na *Referência de comandos da AWS CLI*. ### `get-api` O código de exemplo a seguir mostra como usar `get-api`. **AWS CLI** **Para recuperar informações sobre uma API** O exemplo `get-api` a seguir exibe informações sobre uma API. ``` aws apigatewayv2 get-api \ --api-id a1b2c3d4 ``` Resultado: ``` { "ApiEndpoint": "https://a1b2c3d4.execute-api.us-west-2.amazonaws.com", "ApiId": "a1b2c3d4", "ApiKeySelectionExpression": "$request.header.x-api-key", "CreatedDate": "2020-03-28T00:32:37Z", "Name": "my-api", "ProtocolType": "HTTP", "RouteSelectionExpression": "$request.method $request.path", "Tags": { "department": "finance" } } ``` + Para ver detalhes da API, consulte [GetApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-api.html) na *Referência de comandos da AWS CLI*. ### `get-apis` O código de exemplo a seguir mostra como usar `get-apis`. **AWS CLI** **Para recuperar uma lista de APIs** O exemplo `get-apis` a seguir lista todas as APIs do usuário atual. ``` aws apigatewayv2 get-apis ``` Resultado: ``` { "Items": [ { "ApiEndpoint": "wss://a1b2c3d4.execute-api.us-west-2.amazonaws.com", "ApiId": "a1b2c3d4", "ApiKeySelectionExpression": "$request.header.x-api-key", "CreatedDate": "2020-04-07T20:21:59Z", "Name": "my-websocket-api", "ProtocolType": "WEBSOCKET", "RouteSelectionExpression": "$request.body.message", "Tags": {} }, { "ApiEndpoint": "https://a1b2c3d5.execute-api.us-west-2.amazonaws.com", "ApiId": "a1b2c3d5", "ApiKeySelectionExpression": "$request.header.x-api-key", "CreatedDate": "2020-04-07T20:23:50Z", "Name": "my-http-api", "ProtocolType": "HTTP", "RouteSelectionExpression": "$request.method $request.path", "Tags": {} } ] } ``` Para obter mais informações, consulte [Trabalhar com APIs HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) e [Trabalhar com APIs de WebSocket](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [GetApis](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-apis.html) na *Referência de comandos da AWS CLI*. ### `get-authorizer` O código de exemplo a seguir mostra como usar `get-authorizer`. **AWS CLI** **Para recuperar informações sobre um autorizador** O exemplo `get-authorizer` a seguir exibe informações detalhadas sobre um autorizador. ``` aws apigatewayv2 get-authorizer \ --api-id a1b2c3d4 \ --authorizer-id a1b2c3 ``` Resultado: ``` { "AuthorizerId": "a1b2c3", "AuthorizerType": "JWT", "IdentitySource": [ "$request.header.Authorization" ], "JwtConfiguration": { "Audience": [ "123456abc" ], "Issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123" }, "Name": "my-jwt-authorizer" } ``` Para obter mais informações, consulte [Controlar o acesso a APIs HTTP com autorizadores JWT](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [GetAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-authorizer.html) na *Referência de comandos da AWS CLI*. ### `get-authorizers` O código de exemplo a seguir mostra como usar `get-authorizers`. **AWS CLI** **Para recuperar uma lista de autorizadores de uma API** O exemplo `get-authorizers` a seguir exibe uma lista de todos os autorizadores de uma API. ``` aws apigatewayv2 get-authorizers \ --api-id a1b2c3d4 ``` Resultado: ``` { "Items": [ { "AuthorizerId": "a1b2c3", "AuthorizerType": "JWT", "IdentitySource": [ "$request.header.Authorization" ], "JwtConfiguration": { "Audience": [ "123456abc" ], "Issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123" }, "Name": "my-jwt-authorizer" }, { "AuthorizerId": "a1b2c4", "AuthorizerType": "JWT", "IdentitySource": [ "$request.header.Authorization" ], "JwtConfiguration": { "Audience": [ "6789abcde" ], "Issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc234" }, "Name": "new-jwt-authorizer" } ] } ``` Para obter mais informações, consulte [Controlar o acesso a APIs HTTP com autorizadores JWT](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [GetAuthorizers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-authorizers.html) na *Referência de comandos da AWS CLI*. ### `get-deployment` O código de exemplo a seguir mostra como usar `get-deployment`. **AWS CLI** **Para recuperar informações sobre uma implantação** O exemplo `get-deployment` a seguir exibe informações sobre uma implantação. ``` aws apigatewayv2 get-deployment \ --api-id a1b2c3d4 \ --deployment-id abcdef ``` Resultado: ``` { "AutoDeployed": true, "CreatedDate": "2020-04-07T23:58:40Z", "DeploymentId": "abcdef", "DeploymentStatus": "DEPLOYED", "Description": "Automatic deployment triggered by changes to the Api configuration" } ``` Para obter mais informações, consulte [Implantação da API](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html#apigateway-definition-api-deployment) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [GetDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-deployment.html) na *Referência de comandos da AWS CLI*. ### `get-deployments` O código de exemplo a seguir mostra como usar `get-deployments`. **AWS CLI** **Para recuperar uma lista de implantações** O exemplo `get-deployments` a seguir exibe uma lista de todas as implantações de uma API. ``` aws apigatewayv2 get-deployments \ --api-id a1b2c3d4 ``` Resultado: ``` { "Items": [ { "AutoDeployed": true, "CreatedDate": "2020-04-07T23:58:40Z", "DeploymentId": "abcdef", "DeploymentStatus": "DEPLOYED", "Description": "Automatic deployment triggered by changes to the Api configuration" }, { "AutoDeployed": true, "CreatedDate": "2020-04-06T00:33:00Z", "DeploymentId": "bcdefg", "DeploymentStatus": "DEPLOYED", "Description": "Automatic deployment triggered by changes to the Api configuration" } ] } ``` Para obter mais informações, consulte [Implantação da API](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html#apigateway-definition-api-deployment) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [GetDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-deployments.html) na *Referência de comandos da AWS CLI*. ### `get-domain-name` O código de exemplo a seguir mostra como usar `get-domain-name`. **AWS CLI** **Para recuperar informações sobre um nome de domínio personalizado** O exemplo `get-domain-name` a seguir exibe informações sobre um nome de domínio personalizado. ``` aws apigatewayv2 get-domain-name \ --domain-name api.example.com ``` Resultado: ``` { "ApiMappingSelectionExpression": "$request.basepath", "DomainName": "api.example.com", "DomainNameConfigurations": [ { "ApiGatewayDomainName": "d-1234.execute-api.us-west-2.amazonaws.com", "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678", "EndpointType": "REGIONAL", "HostedZoneId": "123456789111", "SecurityPolicy": "TLS_1_2", "DomainNameStatus": "AVAILABLE" } ], "Tags": {} } ``` Para obter mais informações, consulte [Configurar um nome de domínio personalizado regional no API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [GetDomainName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-domain-name.html) na *Referência de comandos da AWS CLI*. ### `get-domain-names` O código de exemplo a seguir mostra como usar `get-domain-names`. **AWS CLI** **Para recuperar uma lista de nomes de domínio personalizados** O exemplo `get-domain-names` a seguir exibe uma lista de todos os nomes de domínio personalizados do usuário atual. ``` aws apigatewayv2 get-domain-names ``` Resultado: ``` { "Items": [ { "ApiMappingSelectionExpression": "$request.basepath", "DomainName": "api.example.com", "DomainNameConfigurations": [ { "ApiGatewayDomainName": "d-1234.execute-api.us-west-2.amazonaws.com", "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678", "EndpointType": "REGIONAL", "HostedZoneId": "123456789111", "SecurityPolicy": "TLS_1_2", "DomainNameStatus": "AVAILABLE" } ] }, { "ApiMappingSelectionExpression": "$request.basepath", "DomainName": "newApi.example.com", "DomainNameConfigurations": [ { "ApiGatewayDomainName": "d-5678.execute-api.us-west-2.amazonaws.com", "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678", "EndpointType": "REGIONAL", "HostedZoneId": "123456789222", "SecurityPolicy": "TLS_1_2", "DomainNameStatus": "AVAILABLE" } ] } ] } ``` Para obter mais informações, consulte [Configurar um nome de domínio personalizado regional no API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [GetDomainNames](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-domain-names.html) na *Referência de comandos da AWS CLI*. ### `get-integration` O código de exemplo a seguir mostra como usar `get-integration`. **AWS CLI** **Para recuperar informações sobre uma integração** O exemplo `get-integration` a seguir mostra informações sobre uma integração. ``` aws apigatewayv2 get-integration \ --api-id a1b2c3d4 \ --integration-id a1b2c3 ``` Resultado: ``` { "ApiGatewayManaged": true, "ConnectionType": "INTERNET", "IntegrationId": "a1b2c3", "IntegrationMethod": "POST", "IntegrationType": "AWS_PROXY", "IntegrationUri": "arn:aws:lambda:us-west-2:12356789012:function:hello12", "PayloadFormatVersion": "2.0", "TimeoutInMillis": 30000 } ``` Para obter mais informações, consulte [Configurar integrações para APIs HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html) e [Configurar integrações de APIs de WebSocket](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integrations.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [GetIntegration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-integration.html) na *Referência de comandos da AWS CLI*. ### `get-integrations` O código de exemplo a seguir mostra como usar `get-integrations`. **AWS CLI** **Para recuperar uma lista de integrações** O exemplo `get-integrations` a seguir exibe uma lista de todas as integrações de uma API. ``` aws apigatewayv2 get-integrations \ --api-id a1b2c3d4 ``` Resultado: ``` { "Items": [ { "ApiGatewayManaged": true, "ConnectionType": "INTERNET", "IntegrationId": "a1b2c3", "IntegrationMethod": "POST", "IntegrationType": "AWS_PROXY", "IntegrationUri": "arn:aws:lambda:us-west-2:123456789012:function:my-function", "PayloadFormatVersion": "2.0", "TimeoutInMillis": 30000 }, { "ConnectionType": "INTERNET", "IntegrationId": "a1b2c4", "IntegrationMethod": "ANY", "IntegrationType": "HTTP_PROXY", "IntegrationUri": "https://www.example.com", "PayloadFormatVersion": "1.0", "TimeoutInMillis": 30000 } ] } ``` Para obter mais informações, consulte [Configurar integrações para APIs HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html) e [Configurar integrações de APIs de WebSocket](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integrations.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [GetIntegrations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-integrations.html) na *Referência de comandos da AWS CLI*. ### `get-route` O código de exemplo a seguir mostra como usar `get-route`. **AWS CLI** **Para recuperar informações sobre uma rota** O exemplo `get-route` a seguir exibe informações sobre uma rota. ``` aws apigatewayv2 get-route \ --api-id a1b2c3d4 \ --route-id 72jz1wk ``` Resultado: ``` { "ApiKeyRequired": false, "AuthorizationType": "NONE", "RouteId": "72jz1wk", "RouteKey": "ANY /pets", "Target": "integrations/a1b2c3" } ``` Para obter mais informações, consulte [Trabalhar com rotas para APIs HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html) no *Guia do desenvolvedor do Amazon API Gateway* + Para ver detalhes da API, consulte [GetRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-route.html) na *Referência de comandos da AWS CLI*. ### `get-routes` O código de exemplo a seguir mostra como usar `get-routes`. **AWS CLI** **Para recuperar uma lista de rotas** O exemplo `get-routes` a seguir exibe uma lista de todas as rotas de uma API. ``` aws apigatewayv2 get-routes \ --api-id a1b2c3d4 ``` Resultado: ``` { "Items": [ { "ApiKeyRequired": false, "AuthorizationType": "NONE", "RouteId": "72jz1wk", "RouteKey": "ANY /admin", "Target": "integrations/a1b2c3" }, { "ApiGatewayManaged": true, "ApiKeyRequired": false, "AuthorizationType": "NONE", "RouteId": "go65gqi", "RouteKey": "$default", "Target": "integrations/a1b2c4" } ] } ``` Para obter mais informações, consulte [Trabalhar com rotas para APIs HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html) no *Guia do desenvolvedor do Amazon API Gateway* + Para ver detalhes da API, consulte [GetRoutes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-routes.html) na *Referência de comandos da AWS CLI*. ### `get-routing-rule` O código de exemplo a seguir mostra como usar `get-routing-rule`. **AWS CLI** **Como obter uma regra de roteamento** O exemplo `get-routing-rule` a seguir obtém uma regra de roteamento para um nome de domínio. ``` aws apigatewayv2 get-routing-rule \ --domain-name 'regional.example.com' \ --routing-rule-id aaa111 ``` Resultado: ``` { "Actions": [ { "InvokeApi": { "ApiId": "abcd1234", "Stage": "prod", "StripBasePath": false } } ], "Conditions": [ { "MatchBasePaths": { "AnyOf": [ "PetStoreShopper" ] } } ], "Priority": 50, "RoutingRuleArn": "arn:aws:apigateway:us-east-2:123456789012:/domainnames/regional.example.com/routingrules/aaa111", "RoutingRuleId": "aaa111" } ``` Para ter mais informações, consulte [Regras de roteamento para associar estágios da API a um nome de domínio personalizado para APIs REST](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [GetRoutingRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-routing-rule.html) na *Referência de comandos da AWS CLI*. ### `get-stage` O código de exemplo a seguir mostra como usar `get-stage`. **AWS CLI** **Para recuperar informações sobre um estágio** O exemplo `get-stage` a seguir mostra informações sobre o estágio `prod` de uma API. ``` aws apigatewayv2 get-stage \ --api-id a1b2c3d4 \ --stage-name prod ``` Resultado: ``` { "CreatedDate": "2020-04-08T00:36:05Z", "DefaultRouteSettings": { "DetailedMetricsEnabled": false }, "DeploymentId": "x1zwyv", "LastUpdatedDate": "2020-04-08T00:36:13Z", "RouteSettings": {}, "StageName": "prod", "StageVariables": { "function": "my-prod-function" }, "Tags": {} } ``` Para obter mais informações, consulte [Trabalhar com estágios para APIs HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-stages.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [GetStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-stage.html) na *Referência de comandos da AWS CLI*. ### `get-stages` O código de exemplo a seguir mostra como usar `get-stages`. **AWS CLI** **Para recuperar uma lista de estágios** O exemplo `get-stages` a seguir lista todos os estágios de uma API. ``` aws apigatewayv2 get-stages \ --api-id a1b2c3d4 ``` Resultado: ``` { "Items": [ { "ApiGatewayManaged": true, "AutoDeploy": true, "CreatedDate": "2020-04-08T00:08:44Z", "DefaultRouteSettings": { "DetailedMetricsEnabled": false }, "DeploymentId": "dty748", "LastDeploymentStatusMessage": "Successfully deployed stage with deployment ID 'dty748'", "LastUpdatedDate": "2020-04-08T00:09:49Z", "RouteSettings": {}, "StageName": "$default", "StageVariables": {}, "Tags": {} }, { "AutoDeploy": true, "CreatedDate": "2020-04-08T00:35:06Z", "DefaultRouteSettings": { "DetailedMetricsEnabled": false }, "LastUpdatedDate": "2020-04-08T00:35:48Z", "RouteSettings": {}, "StageName": "dev", "StageVariables": { "function": "my-dev-function" }, "Tags": {} }, { "CreatedDate": "2020-04-08T00:36:05Z", "DefaultRouteSettings": { "DetailedMetricsEnabled": false }, "DeploymentId": "x1zwyv", "LastUpdatedDate": "2020-04-08T00:36:13Z", "RouteSettings": {}, "StageName": "prod", "StageVariables": { "function": "my-prod-function" }, "Tags": {} } ] } ``` Para obter mais informações, consulte [Trabalhar com estágios para APIs HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-stages.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [GetStages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-stages.html) na *Referência de comandos da AWS CLI*. ### `get-tags` O código de exemplo a seguir mostra como usar `get-tags`. **AWS CLI** **Para recuperar uma lista de tags de um recurso** O exemplo `get-tags` a seguir lista todas as tags de uma API. ``` aws apigatewayv2 get-tags \ --resource-arn arn:aws:apigateway:us-west-2::/apis/a1b2c3d4 ``` Resultado: ``` { "Tags": { "owner": "dev-team", "environment": "prod" } } ``` Para obter mais informações, consulte [Marcar recursos do API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-tagging.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [GetTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-tags.html) na *Referência de comandos da AWS CLI*. ### `get-vpc-link` O código de exemplo a seguir mostra como usar `get-vpc-link`. **AWS CLI** **Para recuperar informações sobre um link da VPC** O exemplo `get-vpc-link` a seguir exibe informações sobre um link da VPC. ``` aws apigatewayv2 get-vpc-link \ --vpc-link-id abcd123 ``` Resultado: ``` { "CreatedDate": "2020-04-07T00:27:47Z", "Name": "MyVpcLink", "SecurityGroupIds": [ "sg1234", "sg5678" ], "SubnetIds": [ "subnet-aaaa", "subnet-bbbb" ], "Tags": {}, "VpcLinkId": "abcd123", "VpcLinkStatus": "AVAILABLE", "VpcLinkStatusMessage": "VPC link is ready to route traffic", "VpcLinkVersion": "V2" } ``` Para obter mais informações, consulte [Trabalhar com links da VPC para APIs HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [GetVpcLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-vpc-link.html) na *Referência de comandos da AWS CLI*. ### `get-vpc-links` O código de exemplo a seguir mostra como usar `get-vpc-links`. **AWS CLI** **Para recuperar uma lista de links da VPC** O exemplo `get-vpc-links` a seguir exibe uma lista de todos os links da VPC do usuário atual. ``` aws apigatewayv2 get-vpc-links ``` Resultado: ``` { "Items": [ { "CreatedDate": "2020-04-07T00:27:47Z", "Name": "MyVpcLink", "SecurityGroupIds": [ "sg1234", "sg5678" ], "SubnetIds": [ "subnet-aaaa", "subnet-bbbb" ], "Tags": {}, "VpcLinkId": "abcd123", "VpcLinkStatus": "AVAILABLE", "VpcLinkStatusMessage": "VPC link is ready to route traffic", "VpcLinkVersion": "V2" } { "CreatedDate": "2020-04-07T00:27:47Z", "Name": "MyOtherVpcLink", "SecurityGroupIds": [ "sg1234", "sg5678" ], "SubnetIds": [ "subnet-aaaa", "subnet-bbbb" ], "Tags": {}, "VpcLinkId": "abcd456", "VpcLinkStatus": "AVAILABLE", "VpcLinkStatusMessage": "VPC link is ready to route traffic", "VpcLinkVersion": "V2" } ] } ``` Para obter mais informações, consulte [Trabalhar com links da VPC para APIs HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [GetVpcLinks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-vpc-links.html) na *Referência de comandos da AWS CLI*. ### `import-api` O código de exemplo a seguir mostra como usar `import-api`. **AWS CLI** **Para importar uma API HTTP** O exemplo `import-api` a seguir cria uma API HTTP a partir de um arquivo de definição da OpenAPI 3.0 denominado `api-definition.yaml`. ``` aws apigatewayv2 import-api \ --body file://api-definition.yaml ``` Conteúdo de `api-definition.yaml`: ``` openapi: 3.0.1 info: title: My Lambda API version: v1.0 paths: /hello: x-amazon-apigateway-any-method: x-amazon-apigateway-integration: payloadFormatVersion: 2.0 type: aws_proxy httpMethod: POST uri: arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:hello/invocations connectionType: INTERNET ``` Resultado: ``` { "ApiEndpoint": "https://a1b2c3d4.execute-api.us-west-2.amazonaws.com", "ApiId": "a1b2c3d4", "ApiKeySelectionExpression": "$request.header.x-api-key", "CreatedDate": "2020-04-08T17:19:38+00:00", "Name": "My Lambda API", "ProtocolType": "HTTP", "RouteSelectionExpression": "$request.method $request.path", "Tags": {}, "Version": "v1.0" } ``` Para obter mais informações, consulte [Trabalhar com definições da OpenAPI para APIs HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-open-api.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [ImportApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/import-api.html) na *Referência de comandos da AWS CLI*. ### `list-routing-rules` O código de exemplo a seguir mostra como usar `list-routing-rules`. **AWS CLI** **Como listar regras de roteamento** O exemplo `list-routing-rules` a seguir lista as regras de roteamento para um nome de domínio. ``` aws apigatewayv2 list-routing-rules \ --domain-name 'regional.example.com' ``` Resultado: ``` { "RoutingRules": [ { "Actions": [ { "InvokeApi": { "ApiId": "abcd1234", "Stage": "prod", "StripBasePath": false } } ], "Conditions": [ { "MatchBasePaths": { "AnyOf": [ "PetStoreShopper" ] } } ], "Priority": 150, "RoutingRuleArn": "arn:aws:apigateway:us-east-1:123456789012:/domainnames/regional.example.com/routingrules/aaa111", "RoutingRuleId": "aaa111" } ] } ``` Para ter mais informações, consulte [Regras de roteamento para associar estágios da API a um nome de domínio personalizado para APIs REST](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [ListRoutingRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/list-routing-rules.html) na *Referência de comandos da AWS CLI*. ### `put-routing-rule` O código de exemplo a seguir mostra como usar `put-routing-rule`. **AWS CLI** **Como atualizar uma regra de roteamento** O exemplo `put-routing-rule` a seguir atualiza a prioridade de uma regra de roteamento. ``` aws apigatewayv2 put-routing-rule \ --domain-name 'regional.example.com' \ --priority 150 \ --conditions '[ \ { \ "MatchBasePaths": { \ "AnyOf": [ \ "PetStoreShopper" \ ] \ } \ } \ ]' \ --actions '[ \ { \ "InvokeApi": { \ "ApiId": "abcd1234", \ "Stage": "prod" \ } \ } \ ]' ``` Resultado: ``` { "Actions": [ { "InvokeApi": { "ApiId": "abcd1234", "Stage": "prod", "StripBasePath": false } } ], "Conditions": [ { "MatchBasePaths": { "AnyOf": [ "PetStoreShopper" ] } } ], "Priority": 150, "RoutingRuleArn": "arn:aws:apigateway:us-east-2:123456789012:/domainnames/regional.example.com/routingrules/aaa111", "RoutingRuleId": "aaa111" } ``` Para ter mais informações, consulte [Regras de roteamento para associar estágios da API a um nome de domínio personalizado para APIs REST](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [PutRoutingRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/put-routing-rule.html) na *Referência de comandos da AWS CLI*. ### `reimport-api` O código de exemplo a seguir mostra como usar `reimport-api`. **AWS CLI** **Para reimportar uma API HTTP** O exemplo `reimport-api` a seguir atualiza uma API HTTP existente para usar a definição da OpenAPI 3.0 especificada em `api-definition.yaml`. ``` aws apigatewayv2 reimport-api \ --body file://api-definition.yaml \ --api-id a1b2c3d4 ``` Conteúdo de `api-definition.yaml`: ``` openapi: 3.0.1 info: title: My Lambda API version: v1.0 paths: /hello: x-amazon-apigateway-any-method: x-amazon-apigateway-integration: payloadFormatVersion: 2.0 type: aws_proxy httpMethod: POST uri: arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:12356789012:function:hello/invocations connectionType: INTERNET ``` Resultado: ``` { "ApiEndpoint": "https://a1b2c3d4.execute-api.us-west-2.amazonaws.com", "ApiId": "a1b2c3d4", "ApiKeySelectionExpression": "$request.header.x-api-key", "CreatedDate": "2020-04-08T17:19:38+00:00", "Name": "My Lambda API", "ProtocolType": "HTTP", "RouteSelectionExpression": "$request.method $request.path", "Tags": {}, "Version": "v1.0" } ``` Para obter mais informações, consulte [Trabalhar com definições da OpenAPI para APIs HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-open-api.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [ReimportApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/reimport-api.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como marcar um recurso** O exemplo `tag-resource` a seguir adiciona uma tag com o nome de chave `Department` e um valor de `Accounting` à API especificada. ``` aws apigatewayv2 tag-resource \ --resource-arn arn:aws:apigateway:us-west-2::/apis/a1b2c3d4 \ --tags Department=Accounting ``` Este comando não produz saída. Para obter mais informações, consulte [Marcar recursos do API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-tagging.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Como remover as tags de um recurso** O exemplo `untag-resource` a seguir remove as tags com os nomes das chaves `Project` e `Owner` da API especificada. ``` aws apigatewayv2 untag-resource \ --resource-arn arn:aws:apigateway:us-west-2::/apis/a1b2c3d4 \ --tag-keys Project Owner ``` Este comando não produz saída. Para obter mais informações, consulte [Marcar recursos do API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-tagging.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-api-mapping` O código de exemplo a seguir mostra como usar `update-api-mapping`. **AWS CLI** **Para criar um mapeamento de API** O exemplo `update-api-mapping` a seguir altera um mapeamento de API de um nome de domínio personalizado. Como resultado, a URL base usando o nome de domínio personalizado para a API e estágio especificados se torna `https://api.example.com/dev`. ``` aws apigatewayv2 update-api-mapping \ --api-id a1b2c3d4 \ --stage dev \ --domain-name api.example.com \ --api-mapping-id 0qzs2sy7bh \ --api-mapping-key dev ``` Resultado: ``` { "ApiId": "a1b2c3d4", "ApiMappingId": "0qzs2sy7bh", "ApiMappingKey": "dev" "Stage": "dev" } ``` Para obter mais informações, consulte [Configurar um nome de domínio personalizado regional no API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [UpdateApiMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-api-mapping.html) na *Referência de comandos da AWS CLI*. ### `update-api` O código de exemplo a seguir mostra como usar `update-api`. **AWS CLI** **Para habilitar o CORS para uma API HTTP** O exemplo `update-api` a seguir atualiza a configuração CORS da API especificada para permitir solicitações de `https://www.example.com`. ``` aws apigatewayv2 update-api \ --api-id a1b2c3d4 \ --cors-configuration AllowOrigins=https://www.example.com ``` Resultado: ``` { "ApiEndpoint": "https://a1b2c3d4.execute-api.us-west-2.amazonaws.com", "ApiId": "a1b2c3d4", "ApiKeySelectionExpression": "$request.header.x-api-key", "CorsConfiguration": { "AllowCredentials": false, "AllowHeaders": [ "header1", "header2" ], "AllowMethods": [ "GET", "OPTIONS" ], "AllowOrigins": [ "https://www.example.com" ] }, "CreatedDate": "2020-04-08T18:39:37+00:00", "Name": "my-http-api", "ProtocolType": "HTTP", "RouteSelectionExpression": "$request.method $request.path", "Tags": {}, "Version": "v1.0" } ``` Para obter mais informações, consulte [Configurar o CORS para uma API HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [UpdateApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-api.html) na *Referência de comandos da AWS CLI*. ### `update-authorizer` O código de exemplo a seguir mostra como usar `update-authorizer`. **AWS CLI** **Para atualizar um autorizador** O exemplo `update-authorizer` a seguir altera a fonte de identidade de um autorizador do JWT para um cabeçalho chamado `Authorization`. ``` aws apigatewayv2 update-authorizer \ --api-id a1b2c3d4 \ --authorizer-id a1b2c3 \ --identity-source '$request.header.Authorization' ``` Resultado: ``` { "AuthorizerId": "a1b2c3", "AuthorizerType": "JWT", "IdentitySource": [ "$request.header.Authorization" ], "JwtConfiguration": { "Audience": [ "123456abc" ], "Issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123" }, "Name": "my-jwt-authorizer" } ``` Para obter mais informações, consulte [Controlar o acesso a APIs HTTP com autorizadores JWT](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [UpdateAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-authorizer.html) na *Referência de comandos da AWS CLI*. ### `update-deployment` O código de exemplo a seguir mostra como usar `update-deployment`. **AWS CLI** **Para alterar a descrição de uma implantação** O exemplo `update-deployment` a seguir atualiza a descrição de uma implantação. ``` aws apigatewayv2 update-deployment \ --api-id a1b2c3d4 \ --deployment-id abcdef \ --description 'Manual deployment to fix integration test failures.' ``` Resultado: ``` { "AutoDeployed": false, "CreatedDate": "2020-02-05T16:21:48+00:00", "DeploymentId": "abcdef", "DeploymentStatus": "DEPLOYED", "Description": "Manual deployment to fix integration test failures." } ``` Para obter mais informações, consulte [Desenvolver uma API HTTP no API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [UpdateDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-deployment.html) na *Referência de comandos da AWS CLI*. ### `update-domain-name` O código de exemplo a seguir mostra como usar `update-domain-name`. **AWS CLI** **Para atualizar um nome de domínio personalizado** O exemplo `update-domain-name` a seguir especifica um novo certificado ACM para o nome de domínio personalizado `api.example.com`. ``` aws apigatewayv2 update-domain-name \ --domain-name api.example.com \ --domain-name-configurations CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678 ``` Resultado: ``` { "ApiMappingSelectionExpression": "$request.basepath", "DomainName": "regional.example.com", "DomainNameConfigurations": [ { "ApiGatewayDomainName": "d-id.execute-api.us-west-2.amazonaws.com", "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678", "EndpointType": "REGIONAL", "HostedZoneId": "123456789111", "SecurityPolicy": "TLS_1_2", "DomainNameStatus": "AVAILABLE" } ] } ``` Para obter mais informações, consulte [Configurar um nome de domínio personalizado regional no API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [UpdateDomainName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-domain-name.html) na *Referência de comandos da AWS CLI*. ### `update-integration` O código de exemplo a seguir mostra como usar `update-integration`. **AWS CLI** **Para atualizar uma integração com o Lambda** O exemplo `update-integration` a seguir atualiza uma integração existente do AWS Lambda para usar a função do Lambda especificada. ``` aws apigatewayv2 update-integration \ --api-id a1b2c3d4 \ --integration-id a1b2c3 \ --integration-uri arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:my-new-function/invocations ``` Resultado: ``` { "ConnectionType": "INTERNET", "IntegrationId": "a1b2c3", "IntegrationMethod": "POST", "IntegrationType": "AWS_PROXY", "IntegrationUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:my-new-function/invocations", "PayloadFormatVersion": "2.0", "TimeoutInMillis": 5000 } ``` Para obter mais informações, consulte [Configurar integrações para APIs HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html) e [Configurar integrações de APIs de WebSocket](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integrations.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [UpdateIntegration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-integration.html) na *Referência de comandos da AWS CLI*. ### `update-route` O código de exemplo a seguir mostra como usar `update-route`. **AWS CLI** **Exemplo 1: atualizar a integração de uma rota** O exemplo `update-route` a seguir atualiza a integração de uma rota especificada. ``` aws apigatewayv2 update-route \ --api-id a1b2c3d4 \ --route-id a1b2c3 \ --target integrations/a1b2c6 ``` Resultado: ``` { "ApiKeyRequired": false, "AuthorizationType": "NONE", "RouteId": "a1b2c3", "RouteKey": "ANY /pets", "Target": "integrations/a1b2c6" } ``` **Exemplo 2: adicionar um autorizador a uma rota** O exemplo `update-route` a seguir atualiza uma rota para usar um autorizador JWT. ``` aws apigatewayv2 update-route \ --api-id a1b2c3d4 \ --route-id a1b2c3 \ --authorization-type JWT \ --authorizer-id a1b2c5 \ --authorization-scopes user.id user.email ``` Resultado: ``` { "ApiKeyRequired": false, "AuthorizationScopes": [ "user.id", "user.email" ], "AuthorizationType": "JWT", "AuthorizerId": "a1b2c5", "OperationName": "GET HTTP", "RequestParameters": {}, "RouteId": "a1b2c3", "RouteKey": "GET /pets", "Target": "integrations/a1b2c6" } ``` Para obter mais informações, consulte [Controlar o acesso a APIs HTTP com autorizadores JWT](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [UpdateRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-route.html) na *Referência de comandos da AWS CLI*. ### `update-stage` O código de exemplo a seguir mostra como usar `update-stage`. **AWS CLI** **Como configurar o controle de utilização personalizado** O exemplo `update-stage` a seguir configura o controle de utilização personalizado para o estágio especificado e a rota de uma API. ``` aws apigatewayv2 update-stage \ --api-id a1b2c3d4 \ --stage-name dev \ --route-settings '{"GET /pets":{"ThrottlingBurstLimit":100,"ThrottlingRateLimit":2000}}' ``` Resultado: ``` { "CreatedDate": "2020-04-05T16:21:16+00:00", "DefaultRouteSettings": { "DetailedMetricsEnabled": false }, "DeploymentId": "shktxb", "LastUpdatedDate": "2020-04-08T22:23:17+00:00", "RouteSettings": { "GET /pets": { "ThrottlingBurstLimit": 100, "ThrottlingRateLimit": 2000.0 } }, "StageName": "dev", "StageVariables": {}, "Tags": {} } ``` Para obter mais informações, consulte [Proteger sua API HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-protect.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [UpdateStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-stage.html) na *Referência de comandos da AWS CLI*. ### `update-vpc-link` O código de exemplo a seguir mostra como usar `update-vpc-link`. **AWS CLI** **Para atualizar um link da VPC** O exemplo `update-vpc-link` a seguir atualiza o nome de um link da VPC. Depois de criar um link de VPC, você não pode alterar seus grupos de segurança ou sub-redes. ``` aws apigatewayv2 update-vpc-link \ --vpc-link-id abcd123 \ --name MyUpdatedVpcLink ``` Resultado: ``` { "CreatedDate": "2020-04-07T00:27:47Z", "Name": "MyUpdatedVpcLink", "SecurityGroupIds": [ "sg1234", "sg5678" ], "SubnetIds": [ "subnet-aaaa", "subnet-bbbb" ], "Tags": {}, "VpcLinkId": "abcd123", "VpcLinkStatus": "AVAILABLE", "VpcLinkStatusMessage": "VPC link is ready to route traffic", "VpcLinkVersion": "V2" } ``` Para obter mais informações, consulte [Trabalhar com links da VPC para APIs HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [UpdateVpcLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-vpc-link.html) na *Referência de comandos da AWS CLI*. # A API de gerenciamento do API Gateway usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com a API de gerenciamento do API Gateway. *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 ### `delete-connection` O código de exemplo a seguir mostra como usar `delete-connection`. **AWS CLI** **Para excluir uma conexão WebSocket** O exemplo `delete-connection` a seguir desconecta um cliente da API de WebSocket especificada. ``` aws apigatewaymanagementapi delete-connection \ --connection-id L0SM9cOFvHcCIhw= \ --endpoint-url https://aabbccddee.execute-api.us-west-2.amazonaws.com/prod ``` Este comando não produz saída. Para obter mais informações, consulte [Usar os comandos @connections em seu serviço de backend](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [DeleteConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewaymanagementapi/delete-connection.html) na *Referência de comandos da AWS CLI*. ### `get-connection` O código de exemplo a seguir mostra como usar `get-connection`. **AWS CLI** **Para obter informações sobre uma conexão WebSocket** O exemplo `get-connection` a seguir descreve uma conexão com a API de WebSocket especificada. ``` aws apigatewaymanagementapi get-connection \ --connection-id L0SM9cOFvHcCIhw= \ --endpoint-url https://aabbccddee.execute-api.us-west-2.amazonaws.com/prod ``` Resultado: ``` { "ConnectedAt": "2020-04-30T20:10:33.236Z", "Identity": { "SourceIp": "192.0.2.1" }, "LastActiveAt": "2020-04-30T20:10:42.997Z" } ``` Para obter mais informações, consulte [Usar os comandos @connections em seu serviço de backend](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Para ver detalhes da API, consulte [GetConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewaymanagementapi/get-connection.html) na *Referência de comandos da AWS CLI*. ### `post-to-connection` O código de exemplo a seguir mostra como usar `post-to-connection`. **AWS CLI** **Como enviar dados para uma conexão WebSocket** O exemplo de `post-to-connection` a seguir envia uma mensagem para um cliente conectado à API de WebSocket especificada. ``` aws apigatewaymanagementapi post-to-connection \ --connection-id L0SM9cOFvHcCIhw= \ --data "Hello from API Gateway!" \ --endpoint-url https://aabbccddee.execute-api.us-west-2.amazonaws.com/prod ``` Este comando não produz saída. Para obter mais informações, consulte [Usar os comandos @connections em seu serviço de backend](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html) no *Guia do desenvolvedor do Amazon API Gateway*. + Consulte detalhes da API em [PostToConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewaymanagementapi/post-to-connection.html) na *Referência de comandos da AWS CLI*. # Exemplos de App Mesh usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o App Mesh. *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 ### `create-mesh` O código de exemplo a seguir mostra como usar `create-mesh`. **AWS CLI** **Exemplo 1: criar uma nova malha de serviços** O exemplo `create-mesh` a seguir cria uma malha de serviços. ``` aws appmesh create-mesh \ --mesh-name app1 ``` Resultado: ``` { "mesh":{ "meshName":"app1", "metadata":{ "arn":"arn:aws:appmesh:us-east-1:123456789012:mesh/app1", "createdAt":1563809909.282, "lastUpdatedAt":1563809909.282, "uid":"a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version":1 }, "spec":{}, "status":{ "status":"ACTIVE" } } } ``` **Exemplo 2: criar uma nova malha de serviços com várias tags** O exemplo `create-mesh` a seguir cria uma malha de serviços com várias tags. ``` aws appmesh create-mesh \ --mesh-name app2 \ --tags key=key1,value=value1 key=key2,value=value2 key=key3,value=value3 ``` Resultado: ``` { "mesh":{ "meshName":"app2", "metadata":{ "arn":"arn:aws:appmesh:us-east-1:123456789012:mesh/app2", "createdAt":1563822121.877, "lastUpdatedAt":1563822121.877, "uid":"a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version":1 }, "spec":{}, "status":{ "status":"ACTIVE" } } } ``` Para obter mais informações, consulte [Malhas de serviços](https://docs.aws.amazon.com/app-mesh/latest/userguide/meshes.html) no *Guia do usuário do AWS App Mesh*. + Para ver detalhes da API, consulte [CreateMesh](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/create-mesh.html) na *Referência de comandos da AWS CLI*. ### `create-route` O código de exemplo a seguir mostra como usar `create-route`. **AWS CLI** **Para criar uma nova rota gRPC** O exemplo `create-route` a seguir usa um arquivo de entrada JSON para criar uma rota gRPC. O tráfego de GRPC que tem metadados que começam com 123 é roteado para um nó virtual chamado serviceBgrpc. Se houver falhas específicas de gRPC, HTTP ou TCP ao tentar se comunicar com o destino da rota, a rota será repetida três vezes. Há um atraso de 15 segundos entre cada nova tentativa. ``` aws appmesh create-route \ --cli-input-json file://create-route-grpc.json ``` Conteúdo de `create-route-grpc.json`: ``` { "meshName" : "apps", "routeName" : "grpcRoute", "spec" : { "grpcRoute" : { "action" : { "weightedTargets" : [ { "virtualNode" : "serviceBgrpc", "weight" : 100 } ] }, "match" : { "metadata" : [ { "invert" : false, "match" : { "prefix" : "123" }, "name" : "myMetadata" } ], "methodName" : "GetColor", "serviceName" : "com.amazonaws.services.ColorService" }, "retryPolicy" : { "grpcRetryEvents" : [ "deadline-exceeded" ], "httpRetryEvents" : [ "server-error", "gateway-error" ], "maxRetries" : 3, "perRetryTimeout" : { "unit" : "s", "value" : 15 }, "tcpRetryEvents" : [ "connection-error" ] } }, "priority" : 100 }, "virtualRouterName" : "serviceBgrpc" } ``` Resultado: ``` { "route": { "meshName": "apps", "metadata": { "arn": "arn:aws:appmesh:us-west-2:123456789012:mesh/apps/virtualRouter/serviceBgrpc/route/grpcRoute", "createdAt": 1572010806.008, "lastUpdatedAt": 1572010806.008, "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version": 1 }, "routeName": "grpcRoute", "spec": { "grpcRoute": { "action": { "weightedTargets": [ { "virtualNode": "serviceBgrpc", "weight": 100 } ] }, "match": { "metadata": [ { "invert": false, "match": { "prefix": "123" }, "name": "mymetadata" } ], "methodName": "GetColor", "serviceName": "com.amazonaws.services.ColorService" }, "retryPolicy": { "grpcRetryEvents": [ "deadline-exceeded" ], "httpRetryEvents": [ "server-error", "gateway-error" ], "maxRetries": 3, "perRetryTimeout": { "unit": "s", "value": 15 }, "tcpRetryEvents": [ "connection-error" ] } }, "priority": 100 }, "status": { "status": "ACTIVE" }, "virtualRouterName": "serviceBgrpc" } } ``` **Para criar uma nova rota HTTP ou HTTP/2** O exemplo `create-route` a seguir usa um arquivo de entrada JSON para criar uma rota HTTP/2. Para criar uma rota HTTP, substitua http2Route por httpRoute na especificação. Todo o tráfego HTTP/2 endereçado a qualquer prefixo de URL que tenha um valor de cabeçalho que comece com 123 é roteado para um nó virtual chamado serviceBhttp2. Se houver falhas específicas de HTTP ou TCP ao tentar se comunicar com o destino da rota, a rota será repetida três vezes. Há um atraso de 15 segundos entre cada nova tentativa. ``` aws appmesh create-route \ --cli-input-json file://create-route-http2.json ``` Conteúdo de `create-route-http2.json`: ``` { "meshName": "apps", "routeName": "http2Route", "spec": { "http2Route": { "action": { "weightedTargets": [ { "virtualNode": "serviceBhttp2", "weight": 100 } ] }, "match": { "headers": [ { "invert": false, "match": { "prefix": "123" }, "name": "clientRequestId" } ], "method": "POST", "prefix": "/", "scheme": "http" }, "retryPolicy": { "httpRetryEvents": [ "server-error", "gateway-error" ], "maxRetries": 3, "perRetryTimeout": { "unit": "s", "value": 15 }, "tcpRetryEvents": [ "connection-error" ] } }, "priority": 200 }, "virtualRouterName": "serviceBhttp2" } ``` Resultado: ``` { "route": { "meshName": "apps", "metadata": { "arn": "arn:aws:appmesh:us-west-2:123456789012:mesh/apps/virtualRouter/serviceBhttp2/route/http2Route", "createdAt": 1572011008.352, "lastUpdatedAt": 1572011008.352, "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version": 1 }, "routeName": "http2Route", "spec": { "http2Route": { "action": { "weightedTargets": [ { "virtualNode": "serviceBhttp2", "weight": 100 } ] }, "match": { "headers": [ { "invert": false, "match": { "prefix": "123" }, "name": "clientRequestId" } ], "method": "POST", "prefix": "/", "scheme": "http" }, "retryPolicy": { "httpRetryEvents": [ "server-error", "gateway-error" ], "maxRetries": 3, "perRetryTimeout": { "unit": "s", "value": 15 }, "tcpRetryEvents": [ "connection-error" ] } }, "priority": 200 }, "status": { "status": "ACTIVE" }, "virtualRouterName": "serviceBhttp2" } } ``` **Para criar uma nova rota TCP** O exemplo `create-route` a seguir usa um arquivo de entrada JSON para criar uma rota TCP, em que 75% do tráfego é roteado para um nó virtual chamado serviceBtcp e 25% do tráfego é roteado para um nó virtual chamado serviceBv2tcp. Especificar pesos diferentes para destinos diferentes é uma forma eficaz para implantação de uma nova versão de uma aplicação. Você pode ajustar os pesos para que, por fim, 100% de todo o tráfego seja roteado para um destino que tenha a nova versão de uma aplicação. ``` aws appmesh create-route \ --cli-input-json file://create-route-tcp.json ``` Conteúdo do create-route-tcp.json: ``` { "meshName": "apps", "routeName": "tcpRoute", "spec": { "priority": 300, "tcpRoute": { "action": { "weightedTargets": [ { "virtualNode": "serviceBtcp", "weight": 75 }, { "virtualNode": "serviceBv2tcp", "weight": 25 } ] } } }, "virtualRouterName": "serviceBtcp" } ``` Resultado: ``` { "route": { "meshName": "apps", "metadata": { "arn": "arn:aws:appmesh:us-west-2:123456789012:mesh/apps/virtualRouter/serviceBtcp/route/tcpRoute", "createdAt": 1572011436.26, "lastUpdatedAt": 1572011436.26, "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version": 1 }, "routeName": "tcpRoute", "spec": { "priority": 300, "tcpRoute": { "action": { "weightedTargets": [ { "virtualNode": "serviceBtcp", "weight": 75 }, { "virtualNode": "serviceBv2tcp", "weight": 25 } ] } } }, "status": { "status": "ACTIVE" }, "virtualRouterName": "serviceBtcp" } } ``` Para obter mais informações, consulte [Rotas](https://docs.aws.amazon.com/app-mesh/latest/userguide/routes.html) no *Guia do usuário do AWS App Mesh*. + Para ver detalhes da API, consulte [CreateRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/create-route.html) na *Referência de comandos da AWS CLI*. ### `create-virtual-gateway` O código de exemplo a seguir mostra como usar `create-virtual-gateway`. **AWS CLI** **Para criar um gateway privado virtual** O exemplo `create-virtual-gateway` a seguir usa um arquivo de entrada JSON para criar um gateway virtual com um receptor para HTTP usando a porta 9080. ``` aws appmesh create-virtual-gateway \ --mesh-name meshName \ --virtual-gateway-name virtualGatewayName \ --cli-input-json file://create-virtual-gateway.json ``` Conteúdo de `create-virtual-gateway.json`: ``` { "spec": { "listeners": [ { "portMapping": { "port": 9080, "protocol": "http" } } ] } } ``` Resultado: ``` { "virtualGateway": { "meshName": "meshName", "metadata": { "arn": "arn:aws:appmesh:us-west-2:123456789012:mesh/meshName/virtualGateway/virtualGatewayName", "createdAt": "2022-04-06T10:42:42.015000-05:00", "lastUpdatedAt": "2022-04-06T10:42:42.015000-05:00", "meshOwner": "123456789012", "resourceOwner": "123456789012", "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version": 1 }, "spec": { "listeners": [ { "portMapping": { "port": 9080, "protocol": "http" } } ] }, "status": { "status": "ACTIVE" }, "virtualGatewayName": "virtualGatewayName" } } ``` Para obter mais informações, consulte [Gateways virtuais](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_gateways.html) no *Guia do usuário do AWS App Mesh*. + Para ver detalhes da API, consulte [CreateVirtualGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/create-virtual-gateway.html) na *Referência de comandos da AWS CLI*. ### `create-virtual-node` O código de exemplo a seguir mostra como usar `create-virtual-node`. **AWS CLI** **Exemplo 1: criar um novo nó virtual que usa DNS para descoberta** O exemplo `create-virtual-node` a seguir usa um arquivo de entrada JSON para criar um nó virtual que usa DNS para descoberta de serviços. ``` aws appmesh create-virtual-node \ --cli-input-json file://create-virtual-node-dns.json ``` Conteúdo de `create-virtual-node-dns.json`: ``` { "meshName": "app1", "spec": { "listeners": [ { "portMapping": { "port": 80, "protocol": "http" } } ], "serviceDiscovery": { "dns": { "hostname": "serviceBv1.svc.cluster.local" } } }, "virtualNodeName": "vnServiceBv1" } ``` Resultado: ``` { "virtualNode": { "meshName": "app1", "metadata": { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv1", "createdAt": 1563810019.874, "lastUpdatedAt": 1563810019.874, "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version": 1 }, "spec": { "listeners": [ { "portMapping": { "port": 80, "protocol": "http" } } ], "serviceDiscovery": { "dns": { "hostname": "serviceBv1.svc.cluster.local" } } }, "status": { "status": "ACTIVE" }, "virtualNodeName": "vnServiceBv1" } } ``` **Exemplo 2: criar um novo nó virtual que usa o AWS Cloud Map para descoberta** O exemplo `create-virtual-node` a seguir usa um arquivo de entrada JSON para criar um nó virtual que usa o AWS Cloud Map para descoberta de serviços. ``` aws appmesh create-virtual-node \ --cli-input-json file://create-virtual-node-cloud-map.json ``` Conteúdo de `create-virtual-node-cloud-map.json`: ``` { "meshName": "app1", "spec": { "backends": [ { "virtualService": { "virtualServiceName": "serviceA.svc.cluster.local" } } ], "listeners": [ { "portMapping": { "port": 80, "protocol": "http" } } ], "serviceDiscovery": { "awsCloudMap": { "attributes": [ { "key": "Environment", "value": "Testing" } ], "namespaceName": "namespace1", "serviceName": "serviceA" } } }, "virtualNodeName": "vnServiceA" } ``` Resultado: ``` { "virtualNode": { "meshName": "app1", "metadata": { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceA", "createdAt": 1563810859.465, "lastUpdatedAt": 1563810859.465, "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version": 1 }, "spec": { "backends": [ { "virtualService": { "virtualServiceName": "serviceA.svc.cluster.local" } } ], "listeners": [ { "portMapping": { "port": 80, "protocol": "http" } } ], "serviceDiscovery": { "awsCloudMap": { "attributes": [ { "key": "Environment", "value": "Testing" } ], "namespaceName": "namespace1", "serviceName": "serviceA" } } }, "status": { "status": "ACTIVE" }, "virtualNodeName": "vnServiceA" } } ``` Para obter mais informações, consulte [Nós virtuais](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_nodes.html) no *Guia do usuário do AWS App Mesh*. + Para ver detalhes da API, consulte [CreateVirtualNode](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/create-virtual-node.html) na *Referência de comandos da AWS CLI*. ### `create-virtual-router` O código de exemplo a seguir mostra como usar `create-virtual-router`. **AWS CLI** **Para criar um roteador virtual** O exemplo `create-virtual-router` a seguir usa um arquivo de entrada JSON para criar um roteador virtual com um receptor para HTTP usando a porta 80. ``` aws appmesh create-virtual-router \ --cli-input-json file://create-virtual-router.json ``` Conteúdo de `create-virtual-router.json`: ``` { "meshName": "app1", "spec": { "listeners": [ { "portMapping": { "port": 80, "protocol": "http" } } ] }, "virtualRouterName": "vrServiceB" } ``` Resultado: ``` { "virtualRouter": { "meshName": "app1", "metadata": { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB", "createdAt": 1563810546.59, "lastUpdatedAt": 1563810546.59, "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version": 1 }, "spec": { "listeners": [ { "portMapping": { "port": 80, "protocol": "http" } } ] }, "status": { "status": "ACTIVE" }, "virtualRouterName": "vrServiceB" } } ``` Para obter mais informações, consulte [Roteadores virtuais](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_routers.html) no *Guia do usuário do AWS App Mesh*. + Para ver detalhes da API, consulte [CreateVirtualRouter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/create-virtual-router.html) na *Referência de comandos da AWS CLI*. ### `create-virtual-service` O código de exemplo a seguir mostra como usar `create-virtual-service`. **AWS CLI** **Exemplo 1: criar um novo serviço virtual com um provedor de nós virtuais** O exemplo `create-virtual-service` a seguir usa um arquivo de entrada JSON para criar um serviço virtual com um provedor de nó virtual. ``` aws appmesh create-virtual-service \ --cli-input-json file://create-virtual-service-virtual-node.json ``` Conteúdo de `create-virtual-service-virtual-node.json`: ``` { "meshName": "app1", "spec": { "provider": { "virtualNode": { "virtualNodeName": "vnServiceA" } } }, "virtualServiceName": "serviceA.svc.cluster.local" } ``` Resultado: ``` { "virtualService": { "meshName": "app1", "metadata": { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceA.svc.cluster.local", "createdAt": 1563810859.474, "lastUpdatedAt": 1563810967.179, "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version": 2 }, "spec": { "provider": { "virtualNode": { "virtualNodeName": "vnServiceA" } } }, "status": { "status": "ACTIVE" }, "virtualServiceName": "serviceA.svc.cluster.local" } } ``` Para obter mais informações, consulte [Nó virtual](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_nodes.html) no *Guia do usuário do AWS App Mesh*. **Exemplo 2: criar um novo serviço virtual com um provedor de roteador virtual** O exemplo `create-virtual-service` a seguir usa um arquivo de entrada JSON para criar um serviço virtual com um provedor de roteador virtual. ``` aws appmesh create-virtual-service \ --cli-input-json file://create-virtual-service-virtual-router.json ``` Conteúdo de `create-virtual-service-virtual-router.json`: ``` { "meshName": "app1", "spec": { "provider": { "virtualRouter": { "virtualRouterName": "vrServiceB" } } }, "virtualServiceName": "serviceB.svc.cluster.local" } ``` Resultado: ``` { "virtualService": { "meshName": "app1", "metadata": { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceB.svc.cluster.local", "createdAt": 1563908363.999, "lastUpdatedAt": 1563908363.999, "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version": 1 }, "spec": { "provider": { "virtualRouter": { "virtualRouterName": "vrServiceB" } } }, "status": { "status": "ACTIVE" }, "virtualServiceName": "serviceB.svc.cluster.local" } } ``` Para obter mais informações, consulte Serviços virtuais no *Guia do usuário do AWS App Mesh* + Para ver detalhes da API, consulte [CreateVirtualService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/create-virtual-service.html) na *Referência de comandos da AWS CLI*. ### `delete-mesh` O código de exemplo a seguir mostra como usar `delete-mesh`. **AWS CLI** **Para excluir uma malha de serviços** O exemplo `delete-mesh` a seguir exclui o serviço especificado de uma malha de serviços. ``` aws appmesh delete-mesh \ --mesh-name app1 ``` Resultado: ``` { "mesh": { "meshName": "app1", "metadata": { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1", "createdAt": 1563809909.282, "lastUpdatedAt": 1563824981.248, "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version": 2 }, "spec": { "egressFilter": { "type": "ALLOW_ALL" } }, "status": { "status": "DELETED" } } } ``` Para obter mais informações, consulte [Malhas de serviços](https://docs.aws.amazon.com/app-mesh/latest/userguide/meshes.html) no *Guia do usuário do AWS App Mesh*. + Para ver detalhes da API, consulte [DeleteMesh](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/delete-mesh.html) na *Referência de comandos da AWS CLI*. ### `delete-route` O código de exemplo a seguir mostra como usar `delete-route`. **AWS CLI** **Para excluir uma rota** O exemplo `delete-route` a seguir exclui a rota especificada. ``` aws appmesh delete-route \ --mesh-name app1 \ --virtual-router-name vrServiceB \ --route-name toVnServiceB-weighted ``` Resultado: ``` { "route": { "meshName": "app1", "metadata": { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB/route/toVnServiceB-weighted", "createdAt": 1563811384.015, "lastUpdatedAt": 1563823915.936, "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version": 3 }, "routeName": "toVnServiceB-weighted", "spec": { "httpRoute": { "action": { "weightedTargets": [ { "virtualNode": "vnServiceBv1", "weight": 80 }, { "virtualNode": "vnServiceBv2", "weight": 20 } ] }, "match": { "prefix": "/" } } }, "status": { "status": "DELETED" }, "virtualRouterName": "vrServiceB" } } ``` Para obter mais informações, consulte [Rotas](https://docs.aws.amazon.com/app-mesh/latest/userguide/routes.html) no *Guia do usuário do AWS App Mesh*. + Para ver detalhes da API, consulte [DeleteRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/delete-route.html) na *Referência de comandos da AWS CLI*. ### `delete-virtual-node` O código de exemplo a seguir mostra como usar `delete-virtual-node`. **AWS CLI** **Para excluir um nó virtual** O exemplo `delete-virtual-node` a seguir exclui o nó virtual especificado. ``` aws appmesh delete-virtual-node \ --mesh-name app1 \ --virtual-node-name vnServiceBv2 ``` Resultado: ``` { "virtualNode": { "meshName": "app1", "metadata": { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv2", "createdAt": 1563810117.297, "lastUpdatedAt": 1563824700.678, "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version": 2 }, "spec": { "backends": [], "listeners": [ { "portMapping": { "port": 80, "protocol": "http" } } ], "serviceDiscovery": { "dns": { "hostname": "serviceBv2.svc.cluster.local" } } }, "status": { "status": "DELETED" }, "virtualNodeName": "vnServiceBv2" } } ``` Para obter mais informações, consulte [Nós virtuais](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_nodes.html) no *Guia do usuário do AWS App Mesh*. + Para ver detalhes da API, consulte [DeleteVirtualNode](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/delete-virtual-node.html) na *Referência de comandos da AWS CLI*. ### `delete-virtual-router` O código de exemplo a seguir mostra como usar `delete-virtual-router`. **AWS CLI** **Para excluir um roteador virtual** O exemplo `delete-virtual-router` a seguir exclui o roteador virtual especificado. ``` aws appmesh delete-virtual-router \ --mesh-name app1 \ --virtual-router-name vrServiceB ``` Resultado: ``` { "virtualRouter": { "meshName": "app1", "metadata": { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB", "createdAt": 1563810546.59, "lastUpdatedAt": 1563824253.467, "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version": 3 }, "spec": { "listeners": [ { "portMapping": { "port": 80, "protocol": "http" } } ] }, "status": { "status": "DELETED" }, "virtualRouterName": "vrServiceB" } } ``` Para obter mais informações, consulte [Roteadores virtuais](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_routers.html) no *Guia do usuário do AWS App Mesh*. + Para ver detalhes da API, consulte [DeleteVirtualRouter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/delete-virtual-router.html) na *Referência de comandos da AWS CLI*. ### `delete-virtual-service` O código de exemplo a seguir mostra como usar `delete-virtual-service`. **AWS CLI** **Com excluir um serviço virtual** O exemplo `delete-virtual-service` a seguir exclui o serviço virtual especificado. ``` aws appmesh delete-virtual-service \ --mesh-name app1 \ --virtual-service-name serviceB.svc.cluster.local ``` Resultado: ``` { "virtualService": { "meshName": "app1", "metadata": { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceB.svc.cluster.local", "createdAt": 1563908363.999, "lastUpdatedAt": 1563913940.866, "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version": 3 }, "spec": {}, "status": { "status": "DELETED" }, "virtualServiceName": "serviceB.svc.cluster.local" } } ``` Para obter mais informações, consulte [Serviço virtual](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_services.html) no *Guia do usuário do AWS App Mesh*. + Para ver detalhes da API, consulte [DeleteVirtualService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/delete-virtual-service.html) na *Referência de comandos da AWS CLI*. ### `describe-mesh` O código de exemplo a seguir mostra como usar `describe-mesh`. **AWS CLI** **Para descrever uma malha de serviços** O exemplo `describe-mesh` a seguir retorna detalhes da malha de serviços especificada. ``` aws appmesh describe-mesh \ --mesh-name app1 ``` Resultado: ``` { "mesh": { "meshName": "app1", "metadata": { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1", "createdAt": 1563809909.282, "lastUpdatedAt": 1563809909.282, "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version": 1 }, "spec": {}, "status": { "status": "ACTIVE" } } } ``` Para obter mais informações, consulte [Malhas de serviços](https://docs.aws.amazon.com/app-mesh/latest/userguide/meshes.html) no *Guia do usuário do AWS App Mesh*. + Para ver detalhes da API, consulte [DescribeMesh](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/describe-mesh.html) na *Referência de comandos da AWS CLI*. ### `describe-route` O código de exemplo a seguir mostra como usar `describe-route`. **AWS CLI** **Para descrever uma rota** O exemplo `describe-route` a seguir retorna detalhes da rota especificada. ``` aws appmesh describe-route \ --mesh-name app1 \ --virtual-router-name vrServiceB \ --route-name toVnServiceB-weighted ``` Resultado: ``` { "route": { "meshName": "app1", "metadata": { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB/route/toVnServiceB-weighted", "createdAt": 1563811384.015, "lastUpdatedAt": 1563811384.015, "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version": 1 }, "routeName": "toVnServiceB-weighted", "spec": { "httpRoute": { "action": { "weightedTargets": [ { "virtualNode": "vnServiceBv1", "weight": 90 }, { "virtualNode": "vnServiceBv2", "weight": 10 } ] }, "match": { "prefix": "/" } } }, "status": { "status": "ACTIVE" }, "virtualRouterName": "vrServiceB" } } ``` Para obter mais informações, consulte [Rotas](https://docs.aws.amazon.com/app-mesh/latest/userguide/routes.html) no *Guia do usuário do AWS App Mesh*. + Para ver detalhes da API, consulte [DescribeRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/describe-route.html) na *Referência de comandos da AWS CLI*. ### `describe-virtual-node` O código de exemplo a seguir mostra como usar `describe-virtual-node`. **AWS CLI** **Para descrever um nó virtual** O exemplo `describe-virtual-node` a seguir retorna detalhes do nó virtual especificado. ``` aws appmesh describe-virtual-node \ --mesh-name app1 \ --virtual-node-name vnServiceBv1 ``` Resultado: ``` { "virtualNode": { "meshName": "app1", "metadata": { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv1", "createdAt": 1563810019.874, "lastUpdatedAt": 1563810019.874, "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version": 1 }, "spec": { "backends": [], "listeners": [ { "portMapping": { "port": 80, "protocol": "http" } } ], "serviceDiscovery": { "dns": { "hostname": "serviceBv1.svc.cluster.local" } } }, "status": { "status": "ACTIVE" }, "virtualNodeName": "vnServiceBv1" } } ``` Para obter mais informações, consulte [Nós virtuais](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_nodes.html) no *Guia do usuário do AWS App Mesh*. + Para ver detalhes da API, consulte [DescribeVirtualNode](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/describe-virtual-node.html) na *Referência de comandos da AWS CLI*. ### `describe-virtual-router` O código de exemplo a seguir mostra como usar `describe-virtual-router`. **AWS CLI** **Para descrever um roteador virtual** O exemplo `describe-virtual-router` a seguir retorna detalhes do roteador virtual especificado. ``` aws appmesh describe-virtual-router \ --mesh-name app1 \ --virtual-router-name vrServiceB ``` Resultado: ``` { "virtualRouter": { "meshName": "app1", "metadata": { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB", "createdAt": 1563810546.59, "lastUpdatedAt": 1563810546.59, "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version": 1 }, "spec": { "listeners": [ { "portMapping": { "port": 80, "protocol": "http" } } ] }, "status": { "status": "ACTIVE" }, "virtualRouterName": "vrServiceB" } } ``` Para obter mais informações, consulte [Roteadores virtuais](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_routers.html) no *Guia do usuário do AWS App Mesh*. + Para ver detalhes da API, consulte [DescribeVirtualRouter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/describe-virtual-router.html) na *Referência de comandos da AWS CLI*. ### `describe-virtual-service` O código de exemplo a seguir mostra como usar `describe-virtual-service`. **AWS CLI** **Para descrever um serviço virtual** O exemplo `describe-virtual-service` a seguir retorna detalhes do serviço virtual especificado. ``` aws appmesh describe-virtual-service \ --mesh-name app1 \ --virtual-service-name serviceB.svc.cluster.local ``` Resultado: ``` { "virtualService": { "meshName": "app1", "metadata": { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceB.svc.cluster.local", "createdAt": 1563908363.999, "lastUpdatedAt": 1563908363.999, "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version": 1 }, "spec": { "provider": { "virtualRouter": { "virtualRouterName": "vrServiceB" } } }, "status": { "status": "ACTIVE" }, "virtualServiceName": "serviceB.svc.cluster.local" } } ``` Para obter mais informações, consulte [Serviços virtuais](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_services.html) no *Guia do usuário do AWS App Mesh*. + Para ver detalhes da API, consulte [DescribeVirtualService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/describe-virtual-service.html) na *Referência de comandos da AWS CLI*. ### `list-meshes` O código de exemplo a seguir mostra como usar `list-meshes`. **AWS CLI** **Para listar malhas de serviços** O exemplo `list-meshes` a seguir lista todas as malhas de serviços na região da AWS atual. ``` aws appmesh list-meshes ``` Resultado: ``` { "meshes": [ { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1", "meshName": "app1" } ] } ``` Para obter mais informações, consulte [Malhas de serviços](https://docs.aws.amazon.com/app-mesh/latest/userguide/meshes.html) no *Guia do usuário do AWS App Mesh*. + Para ver detalhes da API, consulte [ListMeshes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/list-meshes.html) na *Referência de comandos da AWS CLI*. ### `list-routes` O código de exemplo a seguir mostra como usar `list-routes`. **AWS CLI** **Para listar rotas** O exemplo `list-routes` a seguir lista todas as rotas para o roteador virtual especificado. ``` aws appmesh list-routes \ --mesh-name app1 \ --virtual-router-name vrServiceB ``` Resultado: ``` { "routes": [ { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB/route/toVnServiceB", "meshName": "app1", "routeName": "toVnServiceB-weighted", "virtualRouterName": "vrServiceB" } ] } ``` Para obter mais informações, consulte [Rotas](https://docs.aws.amazon.com/app-mesh/latest/userguide/routes.html) no *Guia do usuário do AWS App Mesh*. + Para ver detalhes da API, consulte [ListRoutes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/list-routes.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar as tags para um recurso** O exemplo `list-tags-for-resource` a seguir lista todas as tags atribuídas ao recurso especificado. ``` aws appmesh list-tags-for-resource \ --resource-arn arn:aws:appmesh:us-east-1:123456789012:mesh/app1 ``` Resultado: ``` { "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" }, { "key": "key3", "value": "value3" } ] } ``` + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `list-virtual-nodes` O código de exemplo a seguir mostra como usar `list-virtual-nodes`. **AWS CLI** **Para listar nós virtuais** O exemplo `list-virtual-nodes` a seguir lista todos os nós virtuais na malha de serviços especificada. ``` aws appmesh list-virtual-nodes \ --mesh-name app1 ``` Resultado: ``` { "virtualNodes": [ { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv1", "meshName": "app1", "virtualNodeName": "vnServiceBv1" }, { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv2", "meshName": "app1", "virtualNodeName": "vnServiceBv2" } ] } ``` Para obter mais informações, consulte [Nós virtuais](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_nodes.html) no *Guia do usuário do AWS App Mesh*. + Para ver detalhes da API, consulte [ListVirtualNodes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/list-virtual-nodes.html) na *Referência de comandos da AWS CLI*. ### `list-virtual-routers` O código de exemplo a seguir mostra como usar `list-virtual-routers`. **AWS CLI** **Para listar roteadores virtuais** O exemplo `list-virtual-routers` a seguir lista todos os roteadores virtuais na malha de serviços especificada. ``` aws appmesh list-virtual-routers \ --mesh-name app1 ``` Resultado: ``` { "virtualRouters": [ { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB", "meshName": "app1", "virtualRouterName": "vrServiceB" } ] } ``` Para obter mais informações, consulte [Roteadores virtuais](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_routers.html) no *Guia do usuário do AWS App Mesh*. + Para ver detalhes da API, consulte [ListVirtualRouters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/list-virtual-routers.html) na *Referência de comandos da AWS CLI*. ### `list-virtual-services` O código de exemplo a seguir mostra como usar `list-virtual-services`. **AWS CLI** **Para listar serviços virtuais** O exemplo `list-virtual-services` a seguir lista todos os serviços virtuais na malha de serviços especificada. ``` aws appmesh list-virtual-services \ --mesh-name app1 ``` Resultado: ``` { "virtualServices": [ { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceA.svc.cluster.local", "meshName": "app1", "virtualServiceName": "serviceA.svc.cluster.local" }, { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceB.svc.cluster.local", "meshName": "app1", "virtualServiceName": "serviceB.svc.cluster.local" } ] } ``` Para obter mais informações, consulte [Serviços virtuais](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_services.html) no *Guia do usuário do AWS App Mesh*. + Para ver detalhes da API, consulte [ListVirtualServices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/list-virtual-services.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como marcar um recurso** O exemplo `tag-resource` a seguir adiciona a tag `key1` com o valor `value1` ao recursos especificado. ``` aws appmesh tag-resource \ --resource-arn arn:aws:appmesh:us-east-1:123456789012:mesh/app1 \ --tags key=key1,value=value1 ``` Este comando não produz saída. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Como desmarcar um recurso** O exemplo `untag-resource` a seguir remove a tag com a chave `key1` do recurso especificado. ``` aws appmesh untag-resource \ --resource-arn arn:aws:appmesh:us-east-1:123456789012:mesh/app1 \ --tag-keys key1 ``` Este comando não produz saída. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-mesh` O código de exemplo a seguir mostra como usar `update-mesh`. **AWS CLI** **Para atualizar uma malha de serviços** O exemplo `update-mesh` a seguir usa um arquivo de entrada JSON para atualizar uma malha de serviços para permitir que todo o tráfego de saída externo seja encaminhado pelo proxy Envoy intocado. ``` aws appmesh update-mesh \ --cli-input-json file://update-mesh.json ``` Conteúdo de `update-mesh.json`: ``` { "meshName": "app1", "spec": { "egressFilter": { "type": "ALLOW_ALL" } } } ``` Resultado: ``` { "mesh": { "meshName": "app1", "metadata": { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1", "createdAt": 1563809909.282, "lastUpdatedAt": 1563812829.687, "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version": 2 }, "spec": { "egressFilter": { "type": "ALLOW_ALL" } }, "status": { "status": "ACTIVE" } } } ``` Para obter mais informações, consulte [Malhas de serviços](https://docs.aws.amazon.com/app-mesh/latest/userguide/meshes.html) no *Guia do usuário do AWS App Mesh*. + Para ver detalhes da API, consulte [UpdateMesh](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/update-mesh.html) na *Referência de comandos da AWS CLI*. ### `update-route` O código de exemplo a seguir mostra como usar `update-route`. **AWS CLI** **Para atualizar uma rota** O exemplo `update-route` a seguir usa um arquivo de entrada JSON para atualizar os pesos de uma rota. ``` aws appmesh update-route \ --cli-input-json file://update-route-weighted.json ``` Conteúdo de `update-route-weighted.json`: ``` { "meshName": "app1", "routeName": "toVnServiceB-weighted", "spec": { "httpRoute": { "action": { "weightedTargets": [ { "virtualNode": "vnServiceBv1", "weight": 80 }, { "virtualNode": "vnServiceBv2", "weight": 20 } ] }, "match": { "prefix": "/" } } }, "virtualRouterName": "vrServiceB" } ``` Resultado: ``` { "route": { "meshName": "app1", "metadata": { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB/route/toVnServiceB-weighted", "createdAt": 1563811384.015, "lastUpdatedAt": 1563819600.022, "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version": 2 }, "routeName": "toVnServiceB-weighted", "spec": { "httpRoute": { "action": { "weightedTargets": [ { "virtualNode": "vnServiceBv1", "weight": 80 }, { "virtualNode": "vnServiceBv2", "weight": 20 } ] }, "match": { "prefix": "/" } } }, "status": { "status": "ACTIVE" }, "virtualRouterName": "vrServiceB" } } ``` Para obter mais informações, consulte [Rotas](https://docs.aws.amazon.com/app-mesh/latest/userguide/routes.html) no *Guia do usuário do AWS App Mesh*. + Para ver detalhes da API, consulte [UpdateRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/update-route.html) na *Referência de comandos da AWS CLI*. ### `update-virtual-node` O código de exemplo a seguir mostra como usar `update-virtual-node`. **AWS CLI** **Para atualizar um nó virtual** O exemplo `update-virtual-node` a seguir usa um arquivo de entrada JSON para adicionar uma verificação de integridade a um nó virtual. ``` aws appmesh update-virtual-node \ --cli-input-json file://update-virtual-node.json ``` Conteúdo de `update-virtual-node.json`: ``` { "clientToken": "500", "meshName": "app1", "spec": { "listeners": [ { "healthCheck": { "healthyThreshold": 5, "intervalMillis": 10000, "path": "/", "port": 80, "protocol": "http", "timeoutMillis": 3000, "unhealthyThreshold": 3 }, "portMapping": { "port": 80, "protocol": "http" } } ], "serviceDiscovery": { "dns": { "hostname": "serviceBv1.svc.cluster.local" } } }, "virtualNodeName": "vnServiceBv1" } ``` Resultado: ``` { "virtualNode": { "meshName": "app1", "metadata": { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv1", "createdAt": 1563810019.874, "lastUpdatedAt": 1563819234.825, "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version": 2 }, "spec": { "listeners": [ { "healthCheck": { "healthyThreshold": 5, "intervalMillis": 10000, "path": "/", "port": 80, "protocol": "http", "timeoutMillis": 3000, "unhealthyThreshold": 3 }, "portMapping": { "port": 80, "protocol": "http" } } ], "serviceDiscovery": { "dns": { "hostname": "serviceBv1.svc.cluster.local" } } }, "status": { "status": "ACTIVE" }, "virtualNodeName": "vnServiceBv1" } } ``` Para obter mais informações, consulte [Nós virtuais](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_nodes.html) no *Guia do usuário do AWS App Mesh*. + Para ver detalhes da API, consulte [UpdateVirtualNode](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/update-virtual-node.html) na *Referência de comandos da AWS CLI*. ### `update-virtual-router` O código de exemplo a seguir mostra como usar `update-virtual-router`. **AWS CLI** **Para atualizar um roteador virtual** O exemplo `update-virtual-router` a seguir usa um arquivo de entrada JSON para atualizar uma porta do receptor do roteador virtual. ``` aws appmesh update-virtual-router \ --cli-input-json file://update-virtual-router.json ``` Conteúdo de `update-virtual-router.json`: ``` { "meshName": "app1", "spec": { "listeners": [ { "portMapping": { "port": 8080, "protocol": "http" } } ] }, "virtualRouterName": "vrServiceB" } ``` Resultado: ``` { "virtualRouter": { "meshName": "app1", "metadata": { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB", "createdAt": 1563810546.59, "lastUpdatedAt": 1563819431.352, "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version": 2 }, "spec": { "listeners": [ { "portMapping": { "port": 8080, "protocol": "http" } } ] }, "status": { "status": "ACTIVE" }, "virtualRouterName": "vrServiceB" } } ``` Para obter mais informações, consulte [Roteadores virtuais](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_routers.html) no *Guia do usuário do AWS App Mesh*. + Para ver detalhes da API, consulte [UpdateVirtualRouter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/update-virtual-router.html) na *Referência de comandos da AWS CLI*. ### `update-virtual-service` O código de exemplo a seguir mostra como usar `update-virtual-service`. **AWS CLI** **Para atualizar um serviço virtual** O exemplo `update-virtual-service` a seguir usa um arquivo de entrada JSON para atualizar um serviço virtual para usar um provedor de roteador virtual. ``` aws appmesh update-virtual-service \ --cli-input-json file://update-virtual-service.json ``` Conteúdo de `update-virtual-service.json`: ``` { "meshName": "app1", "spec": { "provider": { "virtualRouter": { "virtualRouterName": "vrServiceA" } } }, "virtualServiceName": "serviceA.svc.cluster.local" } ``` Resultado: ``` { "virtualService": { "meshName": "app1", "metadata": { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceA.svc.cluster.local", "createdAt": 1563810859.474, "lastUpdatedAt": 1563820257.411, "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "version": 3 }, "spec": { "provider": { "virtualRouter": { "virtualRouterName": "vrServiceA" } } }, "status": { "status": "ACTIVE" }, "virtualServiceName": "serviceA.svc.cluster.local" } } ``` Para obter mais informações, consulte [Serviços virtuais](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_services.html) no *Guia do usuário do AWS App Mesh*. + Para ver detalhes da API, consulte [UpdateVirtualService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/update-virtual-service.html) na *Referência de comandos da AWS CLI*. # Exemplos do App Runner usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o App Runner. *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 ### `associate-custom-domain` O código de exemplo a seguir mostra como usar `associate-custom-domain`. **AWS CLI** **Como associar um nome de domínio e o subdomínio www a um serviço** O exemplo `associate-custom-domain` a seguir associa um nome de domínio personalizado que você controla com um serviço do App Runner. O nome do domínio é o domínio raiz `example.com`, incluindo o subdomínio de casos especiais `www.example.com`. ``` aws apprunner associate-custom-domain \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", "DomainName": "example.com", "EnableWWWSubdomain": true } ``` Resultado: ``` { "CustomDomain": { "CertificateValidationRecords": [ { "Name": "_70d3f50a94f7c72dc28784cf55db2f6b.example.com", "Status": "PENDING_VALIDATION", "Type": "CNAME", "Value": "_1270c137383c6307b6832db02504c4b0.bsgbmzkfwj.acm-validations.aws." }, { "Name": "_287870d3f50a94f7c72dc4cf55db2f6b.www.example.com", "Status": "PENDING_VALIDATION", "Type": "CNAME", "Value": "_832db01270c137383c6307b62504c4b0.mzkbsgbfwj.acm-validations.aws." } ], "DomainName": "example.com", "EnableWWWSubdomain": true, "Status": "CREATING" }, "DNSTarget": "psbqam834h.us-east-1.awsapprunner.com", "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" } ``` + Para ver detalhes da API, consulte [AssociateCustomDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/associate-custom-domain.html) na *Referência de comandos da AWS CLI*. ### `create-auto-scaling-configuration` O código de exemplo a seguir mostra como usar `create-auto-scaling-configuration`. **AWS CLI** **Para criar uma configuração de ajuste de escala automático de alta disponibilidade** O exemplo `create-auto-scaling-configuration` a seguir cria uma configuração de ajuste de escala automático otimizada para alta disponibilidade, definindo o `MinSize` como 5. Com essa configuração, o App Runner tenta distribuir suas instâncias de serviço pelo maior número possível de zonas de disponibilidade, até cinco, dependendo da região da AWS. A chamada retorna um objeto `AutoScalingConfiguration` com as outras configurações definidas como padrão. No exemplo, essa é a primeira chamada para criar uma configuração chamada `high-availability`. A revisão está definida como 1 e é a revisão mais recente. ``` aws apprunner create-auto-scaling-configuration \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "AutoScalingConfigurationName": "high-availability", "MinSize": 5 } ``` Resultado: ``` { "AutoScalingConfiguration": { "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/1/2f50e7656d7819fead0f59672e68042e", "AutoScalingConfigurationName": "high-availability", "AutoScalingConfigurationRevision": 1, "CreatedAt": "2020-11-03T00:29:17Z", "Latest": true, "Status": "ACTIVE", "MaxConcurrency": 100, "MaxSize": 50, "MinSize": 5 } } ``` + Para ver detalhes da API, consulte [CreateAutoScalingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/create-auto-scaling-configuration.html) na *Referência de comandos da AWS CLI*. ### `create-connection` O código de exemplo a seguir mostra como usar `create-connection`. **AWS CLI** **Para criar uma conexão com o GitHub** O exemplo `create-connection` a seguir cria uma conexão com um repositório de código privado do GitHub. O status da conexão após uma chamada bem-sucedida é `PENDING_HANDSHAKE`. Isso ocorre porque um handshake de autenticação com o provedor ainda não aconteceu. Conclua o handshake usando o console do App Runner. ``` aws apprunner create-connection \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "ConnectionName": "my-github-connection", "ProviderType": "GITHUB" } ``` Resultado: ``` { "Connection": { "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection", "ConnectionName": "my-github-connection", "Status": "PENDING_HANDSHAKE", "CreatedAt": "2020-11-03T00:32:51Z", "ProviderType": "GITHUB" } } ``` Para obter mais informações, consulte [Gerenciar conexões do App Runner](https://docs.aws.amazon.com/apprunner/latest/dg/manage-connections.html) no *Guia do desenvolvedor do AWS App Runner*. + Para ver detalhes da API, consulte [CreateConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/create-connection.html) na *Referência de comandos da AWS CLI*. ### `create-service` O código de exemplo a seguir mostra como usar `create-service`. **AWS CLI** **Exemplo 1: criar um serviço de repositório de código-fonte** O exemplo `create-service` a seguir cria um serviço do App Runner com base em um repositório de código-fonte do Python. ``` aws apprunner create-service \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "ServiceName": "python-app", "SourceConfiguration": { "AuthenticationConfiguration": { "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection/e7656250f67242d7819feade6800f59e" }, "AutoDeploymentsEnabled": true, "CodeRepository": { "RepositoryUrl": "https://github.com/my-account/python-hello", "SourceCodeVersion": { "Type": "BRANCH", "Value": "main" }, "CodeConfiguration": { "ConfigurationSource": "API", "CodeConfigurationValues": { "Runtime": "PYTHON_3", "BuildCommand": "pip install -r requirements.txt", "StartCommand": "python server.py", "Port": "8080", "RuntimeEnvironmentVariables": [ { "NAME": "Jane" } ] } } } }, "InstanceConfiguration": { "CPU": "1 vCPU", "Memory": "3 GB" } } ``` Resultado: ``` { "OperationId": "17fe9f55-7e91-4097-b243-fcabbb69a4cf", "Service": { "CreatedAt": "2020-11-20T19:05:25Z", "UpdatedAt": "2020-11-20T19:05:25Z", "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", "ServiceId": "8fe1e10304f84fd2b0df550fe98a71fa", "ServiceName": "python-app", "ServiceUrl": "psbqam834h.us-east-1.awsapprunner.com", "SourceConfiguration": { "AuthenticationConfiguration": { "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection/e7656250f67242d7819feade6800f59e" }, "AutoDeploymentsEnabled": true, "CodeRepository": { "CodeConfiguration": { "CodeConfigurationValues": { "BuildCommand": "pip install -r requirements.txt", "Port": "8080", "Runtime": "PYTHON_3", "RuntimeEnvironmentVariables": [ { "NAME": "Jane" } ], "StartCommand": "python server.py" }, "ConfigurationSource": "Api" }, "RepositoryUrl": "https://github.com/my-account/python-hello", "SourceCodeVersion": { "Type": "BRANCH", "Value": "main" } } }, "Status": "OPERATION_IN_PROGRESS", "InstanceConfiguration": { "CPU": "1 vCPU", "Memory": "3 GB" } } } ``` **Exemplo 2: criar um serviço de repositório de código-fonte** O exemplo `create-service` a seguir cria um serviço do App Runner com base em um repositório de código-fonte do Python. ``` aws apprunner create-service \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "ServiceName": "python-app", "SourceConfiguration": { "AuthenticationConfiguration": { "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection/e7656250f67242d7819feade6800f59e" }, "AutoDeploymentsEnabled": true, "CodeRepository": { "RepositoryUrl": "https://github.com/my-account/python-hello", "SourceCodeVersion": { "Type": "BRANCH", "Value": "main" }, "CodeConfiguration": { "ConfigurationSource": "API", "CodeConfigurationValues": { "Runtime": "PYTHON_3", "BuildCommand": "pip install -r requirements.txt", "StartCommand": "python server.py", "Port": "8080", "RuntimeEnvironmentVariables": [ { "NAME": "Jane" } ] } } } }, "InstanceConfiguration": { "CPU": "1 vCPU", "Memory": "3 GB" } } ``` Resultado: ``` { "OperationId": "17fe9f55-7e91-4097-b243-fcabbb69a4cf", "Service": { "CreatedAt": "2020-11-20T19:05:25Z", "UpdatedAt": "2020-11-20T19:05:25Z", "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", "ServiceId": "8fe1e10304f84fd2b0df550fe98a71fa", "ServiceName": "python-app", "ServiceUrl": "psbqam834h.us-east-1.awsapprunner.com", "SourceConfiguration": { "AuthenticationConfiguration": { "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection/e7656250f67242d7819feade6800f59e" }, "AutoDeploymentsEnabled": true, "CodeRepository": { "CodeConfiguration": { "CodeConfigurationValues": { "BuildCommand": "pip install -r requirements.txt", "Port": "8080", "Runtime": "PYTHON_3", "RuntimeEnvironmentVariables": [ { "NAME": "Jane" } ], "StartCommand": "python server.py" }, "ConfigurationSource": "Api" }, "RepositoryUrl": "https://github.com/my-account/python-hello", "SourceCodeVersion": { "Type": "BRANCH", "Value": "main" } } }, "Status": "OPERATION_IN_PROGRESS", "InstanceConfiguration": { "CPU": "1 vCPU", "Memory": "3 GB" } } } ``` **Exemplo 3: criar um serviço de repositório de imagem de origem** O exemplo `create-service` a seguir cria um serviço do App Runner com base em uma imagem armazenada no Elastic Container Registry (ECR). ``` aws apprunner create-service \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "ServiceName": "golang-container-app", "SourceConfiguration": { "AuthenticationConfiguration": { "AccessRoleArn": "arn:aws:iam::123456789012:role/my-ecr-role" }, "AutoDeploymentsEnabled": true, "ImageRepository": { "ImageIdentifier": "123456789012.dkr.ecr.us-east-1.amazonaws.com/golang-app:latest", "ImageConfiguration": { "Port": "8080", "RuntimeEnvironmentVariables": [ { "NAME": "Jane" } ] }, "ImageRepositoryType": "ECR" } }, "InstanceConfiguration": { "CPU": "1 vCPU", "Memory": "3 GB" } } ``` Resultado: ``` { "OperationId": "17fe9f55-7e91-4097-b243-fcabbb69a4cf", "Service": { "CreatedAt": "2020-11-06T23:15:30Z", "UpdatedAt": "2020-11-06T23:15:30Z", "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/golang-container-app/51728f8a20ce46d39b25398a6c8e9d1a", "ServiceId": "51728f8a20ce46d39b25398a6c8e9d1a", "ServiceName": "golang-container-app", "ServiceUrl": "psbqam834h.us-east-1.awsapprunner.com", "SourceConfiguration": { "AuthenticationConfiguration": { "AccessRoleArn": "arn:aws:iam::123456789012:role/my-ecr-role" }, "AutoDeploymentsEnabled": true, "ImageRepository": { "ImageIdentifier": "123456789012.dkr.ecr.us-east-1.amazonaws.com/golang-app:latest", "ImageConfiguration": { "Port": "8080", "RuntimeEnvironmentVariables": [ { "NAME": "Jane" } ] }, "ImageRepositoryType": "ECR" } }, "Status": "OPERATION_IN_PROGRESS", "InstanceConfiguration": { "CPU": "1 vCPU", "Memory": "3 GB" } } } ``` + Consulte detalhes da API em [CreateService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/create-service.html) na *Referência de comandos da AWS CLI*. ### `delete-auto-scaling-configuration` O código de exemplo a seguir mostra como usar `delete-auto-scaling-configuration`. **AWS CLI** **Exemplo 1: excluir a última revisão ativa de uma configuração de ajuste de escala automático** O exemplo `delete-auto-scaling-configuration` a seguir exclui a revisão ativa mais recente de uma configuração de ajuste de escala automático do App Runner. Para excluir a última revisão ativa, especifique um nome do recurso da Amazon (ARN) que termine com o nome da configuração, sem o componente de revisão. No exemplo, existem duas revisões antes dessa ação. Portanto, a revisão 2 (a mais recente) é excluída. No entanto, agora aparece `"Latest": false`, porque, depois de ser excluída, não é mais a última revisão ativa. ``` aws apprunner delete-auto-scaling-configuration \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability" } ``` Resultado: ``` { "AutoScalingConfiguration": { "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/2/e76562f50d78042e819fead0f59672e6", "AutoScalingConfigurationName": "high-availability", "AutoScalingConfigurationRevision": 2, "CreatedAt": "2021-02-25T17:42:59Z", "DeletedAt": "2021-03-02T08:07:06Z", "Latest": false, "Status": "INACTIVE", "MaxConcurrency": 30, "MaxSize": 90, "MinSize": 5 } } ``` **Exemplo 2: excluir uma revisão específica de uma configuração de ajuste de escala automático** O exemplo `delete-auto-scaling-configuration` a seguir exclui uma revisão específica de uma configuração de ajuste de escala automático do App Runner. Para excluir uma revisão específica, especifique um ARN que inclua o número da revisão. No exemplo, existem várias revisões antes dessa ação. A ação exclui a revisão `1`. ``` aws apprunner delete-auto-scaling-configuration \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/1" } ``` Resultado: ``` { "AutoScalingConfiguration": { "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/1/2f50e7656d7819fead0f59672e68042e", "AutoScalingConfigurationName": "high-availability", "AutoScalingConfigurationRevision": 1, "CreatedAt": "2020-11-03T00:29:17Z", "DeletedAt": "2021-03-02T08:07:06Z", "Latest": false, "Status": "INACTIVE", "MaxConcurrency": 100, "MaxSize": 50, "MinSize": 5 } } ``` + Para ver detalhes da API, consulte [DeleteAutoScalingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/delete-auto-scaling-configuration.html) na *Referência de comandos da AWS CLI*. ### `delete-connection` O código de exemplo a seguir mostra como usar `delete-connection`. **AWS CLI** **Para excluir uma conexão** O exemplo `delete-connection` a seguir exclui uma conexão do App Runner. O status da conexão após uma chamada bem-sucedida é `DELETED`. Isso ocorre porque a conexão não está mais disponível. ``` aws apprunner delete-connection \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection" } ``` Resultado: ``` { "Connection": { "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection", "ConnectionName": "my-github-connection", "Status": "DELETED", "CreatedAt": "2020-11-03T00:32:51Z", "ProviderType": "GITHUB" } } ``` + Para ver detalhes da API, consulte [DeleteConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/delete-connection.html) na *Referência de comandos da AWS CLI*. ### `delete-service` O código de exemplo a seguir mostra como usar `delete-service`. **AWS CLI** **Como excluir um serviço** O exemplo `delete-service` a seguir exclui um serviço do App Runner. ``` aws apprunner delete-service \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" } ``` Resultado: ``` { "OperationId": "17fe9f55-7e91-4097-b243-fcabbb69a4cf", "Service": { "CreatedAt": "2020-11-20T19:05:25Z", "UpdatedAt": "2020-11-20T19:05:25Z", "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", "ServiceId": "8fe1e10304f84fd2b0df550fe98a71fa", "ServiceName": "python-app", "ServiceUrl": "psbqam834h.us-east-1.awsapprunner.com", "SourceConfiguration": { "AuthenticationConfiguration": { "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection/e7656250f67242d7819feade6800f59e" }, "AutoDeploymentsEnabled": true, "CodeRepository": { "CodeConfiguration": { "CodeConfigurationValues": { "BuildCommand": "pip install -r requirements.txt", "Port": "8080", "Runtime": "PYTHON_3", "RuntimeEnvironmentVariables": [ { "NAME": "Jane" } ], "StartCommand": "python server.py" }, "ConfigurationSource": "Api" }, "RepositoryUrl": "https://github.com/my-account/python-hello", "SourceCodeVersion": { "Type": "BRANCH", "Value": "main" } } }, "Status": "OPERATION_IN_PROGRESS", "InstanceConfiguration": { "CPU": "1 vCPU", "Memory": "3 GB" } } } ``` + Consulte detalhes da API em [DeleteService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/delete-service.html) na *Referência de comandos da AWS CLI*. ### `describe-auto-scaling-configuration` O código de exemplo a seguir mostra como usar `describe-auto-scaling-configuration`. **AWS CLI** **Exemplo 1: descrever a última revisão ativa de uma configuração de ajuste de escala automático** O exemplo `describe-auto-scaling-configuration` a seguir apresenta uma descrição da revisão ativa mais recente de uma configuração de ajuste de escala automático do App Runner. Para descrever a última revisão ativa, especifique um ARN que termine com o nome da configuração, sem o componente de revisão. No exemplo, existem duas revisões. Portanto, a revisão `2` (a mais recente) é descrita. O objeto resultante exibe `"Latest": true`. ``` aws apprunner describe-auto-scaling-configuration \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability" } ``` Resultado: ``` { "AutoScalingConfiguration": { "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/2/e76562f50d78042e819fead0f59672e6", "AutoScalingConfigurationName": "high-availability", "AutoScalingConfigurationRevision": 2, "CreatedAt": "2021-02-25T17:42:59Z", "Latest": true, "Status": "ACTIVE", "MaxConcurrency": 30, "MaxSize": 90, "MinSize": 5 } } ``` **Exemplo 2: descrever uma revisão específica de uma configuração de ajuste de escala automático** O exemplo `describe-auto-scaling-configuration` a seguir mostra uma descrição de uma revisão específica de uma configuração de ajuste de escala automático do App Runner. Para descrever uma revisão específica, especifique um ARN que inclua o número da revisão. No exemplo, existem várias revisões e a revisão `1` é consultada. O objeto resultante exibe `"Latest": false`. ``` aws apprunner describe-auto-scaling-configuration \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/1" } ``` Resultado: ``` { "AutoScalingConfiguration": { "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/1/2f50e7656d7819fead0f59672e68042e", "AutoScalingConfigurationName": "high-availability", "AutoScalingConfigurationRevision": 1, "CreatedAt": "2020-11-03T00:29:17Z", "Latest": false, "Status": "ACTIVE", "MaxConcurrency": 100, "MaxSize": 50, "MinSize": 5 } } ``` + Para ver detalhes da API, consulte [DescribeAutoScalingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/describe-auto-scaling-configuration.html) na *Referência de comandos da AWS CLI*. ### `describe-custom-domains` O código de exemplo a seguir mostra como usar `describe-custom-domains`. **AWS CLI** **Para obter as descrições dos nomes de domínio personalizados associados a um serviço** O exemplo `describe-custom-domains` a seguir obtém as descrições e o status dos nomes de domínio personalizados associados a um serviço do App Runner. ``` aws apprunner describe-custom-domains \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", "DomainName": "example.com", "EnableWWWSubdomain": true } ``` Resultado: ``` { "CustomDomains": [ { "CertificateValidationRecords": [ { "Name": "_70d3f50a94f7c72dc28784cf55db2f6b.example.com", "Status": "PENDING_VALIDATION", "Type": "CNAME", "Value": "_1270c137383c6307b6832db02504c4b0.bsgbmzkfwj.acm-validations.aws." }, { "Name": "_287870d3f50a94f7c72dc4cf55db2f6b.www.example.com", "Status": "PENDING_VALIDATION", "Type": "CNAME", "Value": "_832db01270c137383c6307b62504c4b0.mzkbsgbfwj.acm-validations.aws." } ], "DomainName": "example.com", "EnableWWWSubdomain": true, "Status": "PENDING_CERTIFICATE_DNS_VALIDATION" }, { "CertificateValidationRecords": [ { "Name": "_a94f784c70d3f507c72dc28f55db2f6b.deals.example.com", "Status": "SUCCESS", "Type": "CNAME", "Value": "_2db02504c1270c137383c6307b6834b0.bsgbmzkfwj.acm-validations.aws." } ], "DomainName": "deals.example.com", "EnableWWWSubdomain": false, "Status": "ACTIVE" } ], "DNSTarget": "psbqam834h.us-east-1.awsapprunner.com", "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" } ``` + Para ver detalhes da API, consulte [DescribeCustomDomains](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/describe-custom-domains.html) na *Referência de comandos da AWS CLI*. ### `describe-service` O código de exemplo a seguir mostra como usar `describe-service`. **AWS CLI** **Para descrever um serviço** O exemplo `describe-service` a seguir obtém uma descrição de um serviço do App Runner. ``` aws apprunner describe-service \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" } ``` Resultado: ``` { "Service": { "CreatedAt": "2020-11-20T19:05:25Z", "UpdatedAt": "2020-11-20T19:05:25Z", "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", "ServiceId": "8fe1e10304f84fd2b0df550fe98a71fa", "ServiceName": "python-app", "ServiceUrl": "psbqam834h.us-east-1.awsapprunner.com", "SourceConfiguration": { "AuthenticationConfiguration": { "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection/e7656250f67242d7819feade6800f59e" }, "AutoDeploymentsEnabled": true, "CodeRepository": { "CodeConfiguration": { "CodeConfigurationValues": { "BuildCommand": "pip install -r requirements.txt", "Port": "8080", "Runtime": "PYTHON_3", "RuntimeEnvironmentVariables": [ { "NAME": "Jane" } ], "StartCommand": "python server.py" }, "ConfigurationSource": "Api" }, "RepositoryUrl": "https://github.com/my-account/python-hello", "SourceCodeVersion": { "Type": "BRANCH", "Value": "main" } } }, "Status": "RUNNING", "InstanceConfiguration": { "CPU": "1 vCPU", "Memory": "3 GB" } } } ``` + Para ver detalhes da API, consulte [DescribeService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/describe-service.html) na *Referência de comandos da AWS CLI*. ### `disassociate-custom-domain` O código de exemplo a seguir mostra como usar `disassociate-custom-domain`. **AWS CLI** **Como desassociar um nome de domínio de um serviço** O exemplo `disassociate-custom-domain` a seguir desassocia o domínio `example.com` de um serviço do App Runner. A chamada também desassocia o subdomínio `www.example.com` associado ao domínio raiz. ``` aws apprunner disassociate-custom-domain \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", "DomainName": "example.com" } ``` Resultado: ``` { "CustomDomain": { "CertificateValidationRecords": [ { "Name": "_70d3f50a94f7c72dc28784cf55db2f6b.example.com", "Status": "PENDING_VALIDATION", "Type": "CNAME", "Value": "_1270c137383c6307b6832db02504c4b0.bsgbmzkfwj.acm-validations.aws." }, { "Name": "_287870d3f50a94f7c72dc4cf55db2f6b.www.example.com", "Status": "PENDING_VALIDATION", "Type": "CNAME", "Value": "_832db01270c137383c6307b62504c4b0.mzkbsgbfwj.acm-validations.aws." } ], "DomainName": "example.com", "EnableWWWSubdomain": true, "Status": "DELETING" }, "DNSTarget": "psbqam834h.us-east-1.awsapprunner.com", "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" } ``` + Para ver detalhes da API, consulte [DisassociateCustomDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/disassociate-custom-domain.html) na *Referência de comandos da AWS CLI*. ### `list-auto-scaling-configurations` O código de exemplo a seguir mostra como usar `list-auto-scaling-configurations`. **AWS CLI** **Para obter uma lista paginada das configurações de ajuste de escala automático do App Runner** O exemplo `list-auto-scaling-configurations` a seguir lista todas as configurações de ajuste de escala automático do App Runner em sua conta da AWS. Até cinco configurações de ajuste de escala automático estão listadas em cada resposta. `AutoScalingConfigurationName` e `LatestOnly` não são especificados. Seus padrões fazem com que a revisão mais recente de todas as configurações ativas seja listada. Neste exemplo, a resposta inclui dois resultados e não há outros, então nenhum `NextToken` é retornado. ``` aws apprunner list-auto-scaling-configurations \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "MaxResults": 5 } ``` Resultado: ``` { "AutoScalingConfigurationSummaryList": [ { "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/2/e76562f50d78042e819fead0f59672e6", "AutoScalingConfigurationName": "high-availability", "AutoScalingConfigurationRevision": 2 }, { "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/low-cost/1/50d7804e7656fead0f59672e62f2e819", "AutoScalingConfigurationName": "low-cost", "AutoScalingConfigurationRevision": 1 } ] } ``` + Para ver detalhes da API, consulte [ListAutoScalingConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/list-auto-scaling-configurations.html) na *Referência de comandos da AWS CLI*. ### `list-connections` O código de exemplo a seguir mostra como usar `list-connections`. **AWS CLI** **Exemplo 1: listar todas as conexões** O exemplo `list-connections` a seguir lista todas as conexões do App Runner na conta da AWS. ``` aws apprunner list-connections ``` Resultado: ``` { "ConnectionSummaryList": [ { "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection", "ConnectionName": "my-github-connection", "Status": "AVAILABLE", "CreatedAt": "2020-11-03T00:32:51Z", "ProviderType": "GITHUB" }, { "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-org-connection", "ConnectionName": "my-github-org-connection", "Status": "AVAILABLE", "CreatedAt": "2020-11-03T02:54:17Z", "ProviderType": "GITHUB" } ] } ``` **Exemplo 2: listar uma conexão pelo nome** O exemplo `list-connections` a seguir lista uma conexão pelo nome. ``` aws apprunner list-connections \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "ConnectionName": "my-github-org-connection" } ``` Resultado: ``` { "ConnectionSummaryList": [ { "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-org-connection", "ConnectionName": "my-github-org-connection", "Status": "AVAILABLE", "CreatedAt": "2020-11-03T02:54:17Z", "ProviderType": "GITHUB" } ] } ``` + Para ver detalhes da API, consulte [ListConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/list-connections.html) na *Referência de comandos da AWS CLI*. ### `list-operations` O código de exemplo a seguir mostra como usar `list-operations`. **AWS CLI** **Para listar as operações que ocorreram em um serviço** O exemplo `list-operations` a seguir lista todas as operações que ocorreram em um serviço do App Runner até o momento. Neste exemplo, o serviço é novo e apenas uma única operação do tipo `CREATE_SERVICE` ocorreu. ``` aws apprunner list-operations \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" } ``` Resultado: ``` { "OperationSummaryList": [ { "EndedAt": 1606156217, "Id": "17fe9f55-7e91-4097-b243-fcabbb69a4cf", "StartedAt": 1606156014, "Status": "SUCCEEDED", "TargetArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", "Type": "CREATE_SERVICE", "UpdatedAt": 1606156217 } ] } ``` + Para ver detalhes da API, consulte [ListOperations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/list-operations.html) na *Referência de comandos da AWS CLI*. ### `list-services` O código de exemplo a seguir mostra como usar `list-services`. **AWS CLI** **Para obter uma lista paginada dos serviços do App Runner** O exemplo `list-services` a seguir lista todos os serviços do App Runner na conta da AWS. Até dois serviços são listados em cada resposta. Este exemplo mostra a primeira solicitação. A resposta inclui dois resultados e um token que pode ser usado na próxima solicitação. Quando uma resposta subsequente não inclui um token, todos os serviços são listados. ``` aws apprunner list-services \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "MaxResults": 2 } ``` Resultado: ``` { "NextToken": "eyJDdXN0b21lckFjY291bnRJZCI6IjI3MDIwNTQwMjg0NSIsIlNlcnZpY2VTdGF0dXNDb2RlIjoiUFJPVklTSU9OSU5HIiwiSGFzaEtleSI6IjI3MDIwNTQwMjg0NSNhYjhmOTRjZmUyOWE0NjBmYjg3NjBhZmQyZWU4NzU1NSJ9", "ServiceSummaryList": [ { "CreatedAt": "2020-11-20T19:05:25Z", "UpdatedAt": "2020-11-23T12:41:37Z", "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", "ServiceId": "8fe1e10304f84fd2b0df550fe98a71fa", "ServiceName": "python-app", "ServiceUrl": "psbqam834h.us-east-1.awsapprunner.com", "Status": "RUNNING" }, { "CreatedAt": "2020-11-06T23:15:30Z", "UpdatedAt": "2020-11-23T13:21:22Z", "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/golang-container-app/ab8f94cfe29a460fb8760afd2ee87555", "ServiceId": "ab8f94cfe29a460fb8760afd2ee87555", "ServiceName": "golang-container-app", "ServiceUrl": "e2m8rrrx33.us-east-1.awsapprunner.com", "Status": "RUNNING" } ] } ``` + Consulte detalhes da API em [ListServices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/list-services.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar as tags associadas a um serviço do App Runner** O exemplo `list-tags-for-resource` a seguir lista todas as tags associadas a um serviço do App Runner. ``` aws apprunner list-tags-for-resource \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "ResourceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" } ``` Resultado: ``` { "Tags": [ { "Key": "Department", "Value": "Retail" }, { "Key": "CustomerId", "Value": "56439872357912" } ] } ``` + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `pause-service` O código de exemplo a seguir mostra como usar `pause-service`. **AWS CLI** **Como pausar um serviço** O exemplo `pause-service` a seguir pausa um serviço do App Runner. ``` aws apprunner pause-service \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" } ``` Resultado: ``` { "OperationId": "17fe9f55-7e91-4097-b243-fcabbb69a4cf", "Service": { "CreatedAt": "2020-11-20T19:05:25Z", "UpdatedAt": "2020-11-23T12:41:37Z", "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", "ServiceId": "8fe1e10304f84fd2b0df550fe98a71fa", "ServiceName": "python-app", "ServiceUrl": "psbqam834h.us-east-1.awsapprunner.com", "SourceConfiguration": { "AuthenticationConfiguration": { "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection/e7656250f67242d7819feade6800f59e" }, "AutoDeploymentsEnabled": true, "CodeRepository": { "CodeConfiguration": { "CodeConfigurationValues": { "BuildCommand": "pip install -r requirements.txt", "Port": "8080", "Runtime": "PYTHON_3", "RuntimeEnvironmentVariables": [ { "NAME": "Jane" } ], "StartCommand": "python server.py" }, "ConfigurationSource": "Api" }, "RepositoryUrl": "https://github.com/my-account/python-hello", "SourceCodeVersion": { "Type": "BRANCH", "Value": "main" } } }, "Status": "OPERATION_IN_PROGRESS", "InstanceConfiguration": { "CPU": "1 vCPU", "Memory": "3 GB" } } } ``` + Para ver detalhes da API, consulte [PauseService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/pause-service.html) na *Referência de comandos da AWS CLI*. ### `resume-service` O código de exemplo a seguir mostra como usar `resume-service`. **AWS CLI** **Como retomar um serviço** O exemplo `resume-service` a seguir retoma um serviço do App Runner. ``` aws apprunner resume-service \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" } ``` Resultado: ``` { "OperationId": "17fe9f55-7e91-4097-b243-fcabbb69a4cf", "Service": { "CreatedAt": "2020-11-20T19:05:25Z", "UpdatedAt": "2020-11-23T12:41:37Z", "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", "ServiceId": "8fe1e10304f84fd2b0df550fe98a71fa", "ServiceName": "python-app", "ServiceUrl": "psbqam834h.us-east-1.awsapprunner.com", "SourceConfiguration": { "AuthenticationConfiguration": { "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection/e7656250f67242d7819feade6800f59e" }, "AutoDeploymentsEnabled": true, "CodeRepository": { "CodeConfiguration": { "CodeConfigurationValues": { "BuildCommand": "pip install -r requirements.txt", "Port": "8080", "Runtime": "PYTHON_3", "RuntimeEnvironmentVariables": [ { "NAME": "Jane" } ], "StartCommand": "python server.py" }, "ConfigurationSource": "Api" }, "RepositoryUrl": "https://github.com/my-account/python-hello", "SourceCodeVersion": { "Type": "BRANCH", "Value": "main" } } }, "Status": "OPERATION_IN_PROGRESS", "InstanceConfiguration": { "CPU": "1 vCPU", "Memory": "3 GB" } } } ``` + Para ver detalhes da API, consulte [ResumeService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/resume-service.html) na *Referência de comandos da AWS CLI*. ### `start-deployment` O código de exemplo a seguir mostra como usar `start-deployment`. **AWS CLI** **Para iniciar uma implantação manual** O exemplo `start-deployment` a seguir executa uma implantação manual em um serviço do App Runner. ``` aws apprunner start-deployment \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" } ``` Resultado: ``` { "OperationId": "853a7d5b-fc9f-4730-831b-fd8037ab832a" } ``` + Para ver detalhes da API, consulte [StartDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/start-deployment.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Para adicionar tags a um serviço do App Runner** O exemplo `tag-resource` a seguir adiciona duas tags a um serviço do App Runner. ``` aws apprunner tag-resource \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "ResourceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", "Tags": [ { "Key": "Department", "Value": "Retail" }, { "Key": "CustomerId", "Value": "56439872357912" } ] } ``` Este comando não produz saída. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover tags de um serviço do App Runner** O exemplo `untag-resource` a seguir remove duas tags de um serviço do App Runner. ``` aws apprunner untag-resource \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "ResourceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", "TagKeys": [ "Department", "CustomerId" ] } ``` Este comando não produz saída. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-service` O código de exemplo a seguir mostra como usar `update-service`. **AWS CLI** **Para atualizar o tamanho da memória** O exemplo `update-service` a seguir atualiza o tamanho da memória das instâncias (unidades de escalabilidade) de um serviço do App Runner para 2048 MiB. Quando a chamada é bem-sucedida, o App Runner inicia um processo de atualização assíncrona. A estrutura `Service` retornada pela chamada reflete o novo valor de memória que está sendo aplicado por essa chamada. ``` aws apprunner update-service \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", "InstanceConfiguration": { "Memory": "4 GB" } } ``` Resultado: ``` { "OperationId": "17fe9f55-7e91-4097-b243-fcabbb69a4cf", "Service": { "CreatedAt": "2020-11-20T19:05:25Z", "UpdatedAt": "2020-11-23T12:41:37Z", "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", "ServiceId": "8fe1e10304f84fd2b0df550fe98a71fa", "ServiceName": "python-app", "ServiceUrl": "psbqam834h.us-east-1.awsapprunner.com", "SourceConfiguration": { "AuthenticationConfiguration": { "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection/e7656250f67242d7819feade6800f59e" }, "AutoDeploymentsEnabled": true, "CodeRepository": { "CodeConfiguration": { "CodeConfigurationValues": { "BuildCommand": "pip install -r requirements.txt", "Port": "8080", "Runtime": "PYTHON_3", "RuntimeEnvironmentVariables": [ { "NAME": "Jane" } ], "StartCommand": "python server.py" }, "ConfigurationSource": "Api" }, "RepositoryUrl": "https://github.com/my-account/python-hello", "SourceCodeVersion": { "Type": "BRANCH", "Value": "main" } } }, "Status": "OPERATION_IN_PROGRESS", "InstanceConfiguration": { "CPU": "1 vCPU", "Memory": "4 GB" } } } ``` + Consulte detalhes da API em [UpdateService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/update-service.html) na *Referência de comandos da AWS CLI*. # AWS AppConfig Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o AWS AppConfig. *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 ### `create-application` O código de exemplo a seguir mostra como usar `create-application`. **AWS CLI** **Para criar uma aplicação** O exemplo `create-application` a seguir cria uma aplicação no AWS AppConfig. ``` aws appconfig create-application \ --name "example-application" \ --description "An application used for creating an example." ``` Resultado: ``` { "Description": "An application used for creating an example.", "Id": "339ohji", "Name": "example-application" } ``` Para obter mais informações, consulte [Etapa 1: criar uma aplicação do AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-application.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [CreateApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/create-application.html) na *Referência de comandos da AWS CLI*. ### `create-configuration-profile` O código de exemplo a seguir mostra como usar `create-configuration-profile`. **AWS CLI** **Para criar um perfil de configuração** O exemplo `create-configuration-profile` a seguir cria um perfil de configuração usando uma configuração armazenada no Parameter Store, um recurso do Systems Manager. ``` aws appconfig create-configuration-profile \ --application-id "339ohji" \ --name "Example-Configuration-Profile" \ --location-uri "ssm-parameter://Example-Parameter" \ --retrieval-role-arn "arn:aws:iam::111122223333:role/Example-App-Config-Role" ``` Resultado: ``` { "ApplicationId": "339ohji", "Description": null, "Id": "ur8hx2f", "LocationUri": "ssm-parameter://Example-Parameter", "Name": "Example-Configuration-Profile", "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role", "Type": null, "Validators": null } ``` Para obter mais informações, consulte [Etapa 3: criar uma configuração e um perfil de configuração](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [CreateConfigurationProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/create-configuration-profile.html) na *Referência de comandos da AWS CLI*. ### `create-environment` O código de exemplo a seguir mostra como usar `create-environment`. **AWS CLI** **Para criar um ambiente** O exemplo `create-environment` a seguir cria um ambiente do AWS AppConfig chamado Example-Environment usando a aplicação que você criou usando create-application. ``` aws appconfig create-environment \ --application-id "339ohji" \ --name "Example-Environment" ``` Resultado: ``` { "ApplicationId": "339ohji", "Description": null, "Id": "54j1r29", "Monitors": null, "Name": "Example-Environment", "State": "ReadyForDeployment" } ``` Para obter mais informações, consulte [Etapa 2: criar um ambiente](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-environment.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [CreateEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/create-environment.html) na *Referência de comandos da AWS CLI*. ### `create-extension-association` O código de exemplo a seguir mostra como usar `create-extension-association`. **AWS CLI** **Para criar uma associação de extensão** O exemplo `create-extension-association` a seguir cria uma nova associação de extensão no AWS AppConfig. ``` aws appconfig create-extension-association \ --region us-west-2 \ --extension-identifier S3-backup-extension \ --resource-identifier "arn:aws:appconfig:us-west-2:123456789012:application/Finance" \ --parameters S3bucket=FinanceConfigurationBackup ``` Resultado: ``` { "Id": "a1b2c3d4", "ExtensionArn": "arn:aws:appconfig:us-west-2:123456789012:extension/S3-backup-extension/1", "ResourceArn": "arn:aws:appconfig:us-west-2:123456789012:application/Finance", "Parameters": { "S3bucket": "FinanceConfigurationBackup" }, "ExtensionVersionNumber": 1 } ``` Para obter mais informações, consulte [Trabalhar com extensões do AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [CreateExtensionAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/create-extension-association.html) na *Referência de comandos da AWS CLI*. ### `create-extension` O código de exemplo a seguir mostra como usar `create-extension`. **AWS CLI** **Para criar uma extensão** O exemplo `create-extension` a seguir cria uma nova extensão no AWS AppConfig. ``` aws appconfig create-extension \ --region us-west-2 \ --name S3-backup-extension \ --actions PRE_CREATE_HOSTED_CONFIGURATION_VERSION=[{Name=S3backup,Uri=arn:aws:lambda:us-west-2:123456789012:function:s3backupfunction,RoleArn=arn:aws:iam::123456789012:role/appconfigextensionrole}] \ --parameters S3bucket={Required=true} ``` Resultado: ``` { "Id": "1A2B3C4D", "Name": "S3-backup-extension", "VersionNumber": 1, "Arn": "arn:aws:appconfig:us-west-2:123456789012:extension/1A2B3C4D/1", "Actions": { "PRE_CREATE_HOSTED_CONFIGURATION_VERSION": [ { "Name": "S3backup", "Uri": "arn:aws:lambda:us-west-2:123456789012:function:s3backupfunction", "RoleArn": "arn:aws:iam::123456789012:role/appconfigextensionrole" } ] }, "Parameters": { "S3bucket": { "Required": true } } } ``` Para obter mais informações, consulte [Trabalhar com extensões do AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [CreateExtension](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/create-extension.html) na *Referência de comandos da AWS CLI*. ### `create-hosted-configuration-version` O código de exemplo a seguir mostra como usar `create-hosted-configuration-version`. **AWS CLI** **Para criar uma versão de configuração hospedada** O exemplo `create-hosted-configuration-version` a seguir cria uma configuração no armazenamento de configuração hospedada do AWS AppConfig. O conteúdo da configuração deve primeiro ser convertido em base64. ``` aws appconfig create-hosted-configuration-version \ --application-id "339ohji" \ --configuration-profile-id "ur8hx2f" \ --content eyAiTmFtZSI6ICJFeGFtcGxlQXBwbGljYXRpb24iLCAiSWQiOiBFeGFtcGxlSUQsICJSYW5rIjogNyB9 \ --content-type "application/json" \ configuration_version_output_file ``` Conteúdo de `configuration_version_output_file`: ``` { "Name": "ExampleApplication", "Id": ExampleID, "Rank": 7 } ``` Resultado: ``` { "ApplicationId": "339ohji", "ConfigurationProfileId": "ur8hx2f", "VersionNumber": "1", "ContentType": "application/json" } ``` Para obter mais informações, consulte [Sobre o armazenamento de configuração hospedado do AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html#appconfig-creating-configuration-and-profile-about-hosted-store) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [CreateHostedConfigurationVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/create-hosted-configuration-version.html) na *Referência de comandos da AWS CLI*. ### `delete-application` O código de exemplo a seguir mostra como usar `delete-application`. **AWS CLI** **Como excluir uma aplicação do** O exemplo `delete-application` a seguir exclui a aplicação especificada. ``` aws appconfig delete-application \ --application-id 339ohji ``` Este comando não produz saída. Para obter mais informações, consulte [Etapa 1: criar uma aplicação do AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-application.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [DeleteApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/delete-application.html) na *Referência de comandos da AWS CLI*. ### `delete-configuration-profile` O código de exemplo a seguir mostra como usar `delete-configuration-profile`. **AWS CLI** **Para excluir um perfil de configuração** O exemplo `delete-configuration-profile` a seguir exclui o perfil de configuração especificado. ``` aws appconfig delete-configuration-profile \ --application-id 339ohji \ --configuration-profile-id ur8hx2f ``` Este comando não produz saída. Para obter mais informações, consulte [Etapa 3: criar uma configuração e um perfil de configuração](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [DeleteConfigurationProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/delete-configuration-profile.html) na *Referência de comandos da AWS CLI*. ### `delete-deployment-strategy` O código de exemplo a seguir mostra como usar `delete-deployment-strategy`. **AWS CLI** **Para excluir uma estratégia de implantação** O exemplo `delete-deployment-strategy` a seguir exclui a estratégia de implantação especificada. ``` aws appconfig delete-deployment-strategy \ --deployment-strategy-id 1225qzk ``` Este comando não produz saída. Para obter mais informações, consulte [Etapa 4: criar uma estratégia de implantação](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-deployment-strategy.html) no *Guia do usuário do AWSAppConfig*. + Para ver detalhes da API, consulte [DeleteDeploymentStrategy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/delete-deployment-strategy.html) na *Referência de comandos da AWS CLI*. ### `delete-environment` O código de exemplo a seguir mostra como usar `delete-environment`. **AWS CLI** **Para excluir um ambiente** O exemplo `delete-environment` a seguir exclui o ambiente de aplicações especificado. ``` aws appconfig delete-environment \ --application-id 339ohji \ --environment-id 54j1r29 ``` Este comando não produz saída. Para obter mais informações, consulte [Etapa 2: criar um ambiente](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-environment.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [DeleteEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/delete-environment.html) na *Referência de comandos da AWS CLI*. ### `delete-extension-association` O código de exemplo a seguir mostra como usar `delete-extension-association`. **AWS CLI** **Para excluir uma associação de extensão** O exemplo `delete-extension-association` a seguir exclui uma associação de extensão do AWS AppConfig. ``` aws appconfig delete-extension-association \ --region us-west-2 \ --extension-association-id a1b2c3d4 ``` Este comando não produz saída. Para obter mais informações, consulte [Trabalhar com extensões do AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [DeleteExtensionAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/delete-extension-association.html) na *Referência de comandos da AWS CLI*. ### `delete-extension` O código de exemplo a seguir mostra como usar `delete-extension`. **AWS CLI** **Para excluir uma extensão** O exemplo `delete-extension` a seguir exclui uma extensão do AWS AppConfig. ``` aws appconfig delete-extension \ --region us-west-2 \ --extension-identifier S3-backup-extension ``` Este comando não produz saída. Para obter mais informações, consulte [Trabalhar com extensões do AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [DeleteExtension](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/delete-extension.html) na *Referência de comandos da AWS CLI*. ### `delete-hosted-configuration-version` O código de exemplo a seguir mostra como usar `delete-hosted-configuration-version`. **AWS CLI** **Para excluir uma versão de configuração hospedada** O exemplo `delete-hosted-configuration-version` a seguir exclui uma versão de configuração hospedada no armazenamento de configuração hospedada do AWS AppConfig. ``` aws appconfig delete-hosted-configuration-version \ --application-id 339ohji \ --configuration-profile-id ur8hx2f \ --version-number 1 ``` Saída: este comando não produz saída. Para obter mais informações, consulte [Etapa 3: criar uma configuração e um perfil de configuração](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [DeleteHostedConfigurationVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/delete-hosted-configuration-version.html) na *Referência de comandos da AWS CLI*. ### `get-application` O código de exemplo a seguir mostra como usar `get-application`. **AWS CLI** **Para listar detalhes de uma aplicação** O exemplo `get-application` a seguir lista os detalhes da aplicação especificada. ``` aws appconfig get-application \ --application-id 339ohji ``` Resultado: ``` { "Description": "An application used for creating an example.", "Id": "339ohji", "Name": "example-application" } ``` Para obter mais informações, consulte [Como o AWS AppConfig funciona](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html#learn-more-appconfig-how-it-works) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [GetApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/get-application.html) na *Referência de comandos da AWS CLI*. ### `get-configuration-profile` O código de exemplo a seguir mostra como usar `get-configuration-profile`. **AWS CLI** **Para recuperar detalhes do perfil de configuração** O exemplo `get-configuration-profile` a seguir retorna detalhes sobre o perfil de configuração especificado. ``` aws appconfig get-configuration-profile \ --application-id 339ohji \ --configuration-profile-id ur8hx2f ``` Resultado: ``` { "ApplicationId": "339ohji", "Id": "ur8hx2f", "Name": "Example-Configuration-Profile", "LocationUri": "ssm-parameter://Example-Parameter", "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role" } ``` Para obter mais informações, consulte [Etapa 3: criar uma configuração e um perfil de configuração](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [GetConfigurationProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/get-configuration-profile.html) na *Referência de comandos da AWS CLI*. ### `get-configuration` O código de exemplo a seguir mostra como usar `get-configuration`. **AWS CLI** **Para recuperar detalhes da configuração** O exemplo `get-configuration` a seguir retorna os detalhes da configuração da aplicação de exemplo. Nas chamadas subsequentes para get-configuration, use o parâmetro `client-configuration-version` para atualizar somente a configuração da sua aplicação se a versão tiver sido alterada. Somente atualizar a configuração quando a versão é alterada evita cobranças excessivas incorridas ao chamar get-configuration. ``` aws appconfig get-configuration \ --application "example-application" \ --environment "Example-Environment" \ --configuration "Example-Configuration-Profile" \ --client-id "test-id" \ configuration-output-file ``` Conteúdo de `configuration-output-file`: ``` { "Name": "ExampleApplication", "Id": ExampleID, "Rank": 7 } ``` Resultado: ``` { "ConfigurationVersion": "1", "ContentType": "application/json" } ``` Para obter mais informações, consulte [Etapa 6: receber a configuração](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration.html) no *Manual do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [GetConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/get-configuration.html) na *Referência de comandos da AWS CLI*. ### `get-deployment-strategy` O código de exemplo a seguir mostra como usar `get-deployment-strategy`. **AWS CLI** **Para recuperar detalhes de uma estratégia de implantação** O exemplo `get-deployment-strategy` a seguir lista os detalhes da estratégia de implantação especificada. ``` aws appconfig get-deployment-strategy \ --deployment-strategy-id 1225qzk ``` Resultado: ``` { "Id": "1225qzk", "Name": "Example-Deployment", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR", "GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 0, "ReplicateTo": "SSM_DOCUMENT" } ``` Para obter mais informações, consulte [Etapa 4: criar uma estratégia de implantação](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-deployment-strategy.html) no *Guia do usuário do AWSAppConfig*. + Para ver detalhes da API, consulte [GetDeploymentStrategy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/get-deployment-strategy.html) na *Referência de comandos da AWS CLI*. ### `get-deployment` O código de exemplo a seguir mostra como usar `get-deployment`. **AWS CLI** **Para recuperar detalhes da implantação** O exemplo `get-deployment` a seguir lista os detalhes da implantação na aplicação no ambiente e na implantação especificados. ``` aws appconfig get-deployment \ --application-id 339ohji \ --environment-id 54j1r29 \ --deployment-number 1 ``` Resultado: ``` { "ApplicationId": "339ohji", "EnvironmentId": "54j1r29", "DeploymentStrategyId": "1225qzk", "ConfigurationProfileId": "ur8hx2f", "DeploymentNumber": 1, "ConfigurationName": "Example-Configuration-Profile", "ConfigurationLocationUri": "ssm-parameter://Example-Parameter", "ConfigurationVersion": "1", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR", "GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 0, "State": "COMPLETE", "EventLog": [ { "EventType": "DEPLOYMENT_COMPLETED", "TriggeredBy": "APPCONFIG", "Description": "Deployment completed", "OccurredAt": "2021-09-17T21:59:03.888000+00:00" }, { "EventType": "BAKE_TIME_STARTED", "TriggeredBy": "APPCONFIG", "Description": "Deployment bake time started", "OccurredAt": "2021-09-17T21:58:57.722000+00:00" }, { "EventType": "PERCENTAGE_UPDATED", "TriggeredBy": "APPCONFIG", "Description": "Configuration available to 100.00% of clients", "OccurredAt": "2021-09-17T21:55:56.816000+00:00" }, { "EventType": "PERCENTAGE_UPDATED", "TriggeredBy": "APPCONFIG", "Description": "Configuration available to 75.00% of clients", "OccurredAt": "2021-09-17T21:52:56.567000+00:00" }, { "EventType": "PERCENTAGE_UPDATED", "TriggeredBy": "APPCONFIG", "Description": "Configuration available to 50.00% of clients", "OccurredAt": "2021-09-17T21:49:55.737000+00:00" }, { "EventType": "PERCENTAGE_UPDATED", "TriggeredBy": "APPCONFIG", "Description": "Configuration available to 25.00% of clients", "OccurredAt": "2021-09-17T21:46:55.187000+00:00" }, { "EventType": "DEPLOYMENT_STARTED", "TriggeredBy": "USER", "Description": "Deployment started", "OccurredAt": "2021-09-17T21:43:54.205000+00:00" } ], "PercentageComplete": 100.0, "StartedAt": "2021-09-17T21:43:54.205000+00:00", "CompletedAt": "2021-09-17T21:59:03.888000+00:00" } ``` Para obter mais informações, consulte [Etapa 5: implantar uma configuração](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-deploying.html) no *Manual do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [GetDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/get-deployment.html) na *Referência de comandos da AWS CLI*. ### `get-environment` O código de exemplo a seguir mostra como usar `get-environment`. **AWS CLI** **Para recuperar detalhes do ambiente** O exemplo `get-environment` a seguir retorna os detalhes e o estado do ambiente especificado. ``` aws appconfig get-environment \ --application-id 339ohji \ --environment-id 54j1r29 ``` Resultado: ``` { "ApplicationId": "339ohji", "Id": "54j1r29", "Name": "Example-Environment", "State": "ReadyForDeployment" } ``` Para obter mais informações, consulte [Etapa 2: criar um ambiente](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-environment.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [GetEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/get-environment.html) na *Referência de comandos da AWS CLI*. ### `get-extension-association` O código de exemplo a seguir mostra como usar `get-extension-association`. **AWS CLI** **Para obter detalhes da associação de extensão** O exemplo `get-extension-association` a seguir exibe informações sobre uma associação de extensão. ``` aws appconfig get-extension-association \ --region us-west-2 \ --extension-association-id a1b2c3d4 ``` Resultado: ``` { "Id": "a1b2c3d4", "ExtensionArn": "arn:aws:appconfig:us-west-2:123456789012:extension/S3-backup-extension/1", "ResourceArn": "arn:aws:appconfig:us-west-2:123456789012:application/Finance", "Parameters": { "S3bucket": "FinanceConfigurationBackup" }, "ExtensionVersionNumber": 1 } ``` Para obter mais informações, consulte [Trabalhar com extensões do AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [GetExtensionAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/get-extension-association.html) na *Referência de comandos da AWS CLI*. ### `get-extension` O código de exemplo a seguir mostra como usar `get-extension`. **AWS CLI** **Para obter detalhes da extensão** O exemplo `get-extension` a seguir exibe informações sobre uma extensão. ``` aws appconfig get-extension \ --region us-west-2 \ --extension-identifier S3-backup-extension ``` Resultado: ``` { "Id": "1A2B3C4D", "Name": "S3-backup-extension", "VersionNumber": 1, "Arn": "arn:aws:appconfig:us-west-2:123456789012:extension/S3-backup-extension/1", "Actions": { "PRE_CREATE_HOSTED_CONFIGURATION_VERSION": [ { "Name": "S3backup", "Uri": "arn:aws:lambda:us-west-2:123456789012:function:S3backupfunction", "RoleArn": "arn:aws:iam::123456789012:role/appconfigextensionrole" } ] }, "Parameters": { "S3bucket": { "Required": true } } } ``` Para obter mais informações, consulte [Trabalhar com extensões do AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [GetExtension](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/get-extension.html) na *Referência de comandos da AWS CLI*. ### `get-hosted-configuration-version` O código de exemplo a seguir mostra como usar `get-hosted-configuration-version`. **AWS CLI** **Como recuperar detalhes da configuração hospedada** O exemplo `get-hosted-configuration-version` a seguir recupera os detalhes da configuração hospedada do AWS AppConfig. ``` aws appconfig get-hosted-configuration-version \ --application-id 339ohji \ --configuration-profile-id ur8hx2f \ --version-number 1 \ hosted-configuration-version-output ``` Conteúdo de `hosted-configuration-version-output`: ``` { "Name": "ExampleApplication", "Id": ExampleID, "Rank": 7 } ``` Resultado: ``` { "ApplicationId": "339ohji", "ConfigurationProfileId": "ur8hx2f", "VersionNumber": "1", "ContentType": "application/json" } ``` Para obter mais informações, consulte [Sobre o armazenamento de configuração hospedado do AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html#appconfig-creating-configuration-and-profile-about-hosted-store) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [GetHostedConfigurationVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/get-hosted-configuration-version.html) na *Referência de comandos da AWS CLI*. ### `list-applications` O código de exemplo a seguir mostra como usar `list-applications`. **AWS CLI** **Para listar as aplicações disponíveis** O exemplo `list-applications` a seguir lista as aplicações disponíveis em sua conta da AWS. ``` aws appconfig list-applications ``` Resultado: ``` { "Items": [ { "Id": "339ohji", "Name": "test-application", "Description": "An application used for creating an example." }, { "Id": "rwalwu7", "Name": "Test-Application" } ] } ``` Para obter mais informações, consulte [Etapa 1: criar uma aplicação do AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-application.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [ListApplications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/list-applications.html) na *Referência de comandos da AWS CLI*. ### `list-configuration-profiles` O código de exemplo a seguir mostra como usar `list-configuration-profiles`. **AWS CLI** **Para listar os perfis de configuração disponíveis** O exemplo `list-configuration-profiles` a seguir lista os perfis de configuração disponíveis para a aplicação especificada. ``` aws appconfig list-configuration-profiles \ --application-id 339ohji ``` Resultado: ``` { "Items": [ { "ApplicationId": "339ohji", "Id": "ur8hx2f", "Name": "Example-Configuration-Profile", "LocationUri": "ssm-parameter://Example-Parameter" } ] } ``` Para obter mais informações, consulte [Etapa 3: criar uma configuração e um perfil de configuração](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [ListConfigurationProfiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/list-configuration-profiles.html) na *Referência de comandos da AWS CLI*. ### `list-deployment-strategies` O código de exemplo a seguir mostra como usar `list-deployment-strategies`. **AWS CLI** **Para listar as estratégias de implantação disponíveis** O exemplo `list-deployment-strategies` a seguir lista as estratégias de implantação disponíveis em sua conta da AWS. ``` aws appconfig list-deployment-strategies ``` Resultado: ``` { "Items": [ { "Id": "1225qzk", "Name": "Example-Deployment", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR", "GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 0, "ReplicateTo": "SSM_DOCUMENT" }, { "Id": "AppConfig.AllAtOnce", "Name": "AppConfig.AllAtOnce", "Description": "Quick", "DeploymentDurationInMinutes": 0, "GrowthType": "LINEAR", "GrowthFactor": 100.0, "FinalBakeTimeInMinutes": 10, "ReplicateTo": "NONE" }, { "Id": "AppConfig.Linear50PercentEvery30Seconds", "Name": "AppConfig.Linear50PercentEvery30Seconds", "Description": "Test/Demo", "DeploymentDurationInMinutes": 1, "GrowthType": "LINEAR", "GrowthFactor": 50.0, "FinalBakeTimeInMinutes": 1, "ReplicateTo": "NONE" }, { "Id": "AppConfig.Canary10Percent20Minutes", "Name": "AppConfig.Canary10Percent20Minutes", "Description": "AWS Recommended", "DeploymentDurationInMinutes": 20, "GrowthType": "EXPONENTIAL", "GrowthFactor": 10.0, "FinalBakeTimeInMinutes": 10, "ReplicateTo": "NONE" } ] } ``` Para obter mais informações, consulte [Etapa 4: criar uma estratégia de implantação](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-deployment-strategy.html) no *Guia do usuário do AWSAppConfig*. + Para ver detalhes da API, consulte [ListDeploymentStrategies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/list-deployment-strategies.html) na *Referência de comandos da AWS CLI*. ### `list-deployments` O código de exemplo a seguir mostra como usar `list-deployments`. **AWS CLI** **Para listar as implantações disponíveis** O exemplo `list-deployments` a seguir lista as implantações disponíveis em sua conta da AWS para a aplicação e o ambiente especificados. ``` aws appconfig list-deployments \ --application-id 339ohji \ --environment-id 54j1r29 ``` Resultado: ``` { "Items": [ { "DeploymentNumber": 1, "ConfigurationName": "Example-Configuration-Profile", "ConfigurationVersion": "1", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR", "GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 0, "State": "COMPLETE", "PercentageComplete": 100.0, "StartedAt": "2021-09-17T21:43:54.205000+00:00", "CompletedAt": "2021-09-17T21:59:03.888000+00:00" } ] } ``` Para obter mais informações, consulte [Etapa 5: implantar uma configuração](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-deploying.html) no *Manual do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [ListDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/list-deployments.html) na *Referência de comandos da AWS CLI*. ### `list-environments` O código de exemplo a seguir mostra como usar `list-environments`. **AWS CLI** **Para listar os ambientes disponíveis** O exemplo `list-environments` a seguir lista os ambientes disponíveis em sua conta da AWS para a aplicação especificada. ``` aws appconfig list-environments \ --application-id 339ohji ``` Resultado: ``` { "Items": [ { "ApplicationId": "339ohji", "Id": "54j1r29", "Name": "Example-Environment", "State": "ReadyForDeployment" } ] } ``` Para obter mais informações, consulte [Etapa 2: criar um ambiente](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-environment.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [ListEnvironments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/list-environments.html) na *Referência de comandos da AWS CLI*. ### `list-extension-associations` O código de exemplo a seguir mostra como usar `list-extension-associations`. **AWS CLI** **Para listar todas as associações de extensão do AWS AppConfig em sua conta da AWS para uma região da AWS** O exemplo `list-extension-associations` a seguir lista todas as associações de extensão do AWS AppConfig para a conta da AWS atual em uma região da AWS específica. ``` aws appconfig list-extension-associations \ --region us-west-2 ``` Resultado: ``` { "Items": [ { "Id": "a1b2c3d4", "ExtensionArn": "arn:aws:appconfig:us-west-2:123456789012:extension/S3-backup-extension/1", "ResourceArn": "arn:aws:appconfig:us-west-2:123456789012:application/Finance" } ] } ``` Para obter mais informações, consulte [Trabalhar com extensões do AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [ListExtensionAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/list-extension-associations.html) na *Referência de comandos da AWS CLI*. ### `list-extensions` O código de exemplo a seguir mostra como usar `list-extensions`. **AWS CLI** **Para listar todas as extensões do AWS AppConfig em sua conta da AWS para uma região da AWS** O exemplo `list-extensions` a seguir lista todas as extensões do AWS AppConfig para a conta da AWS atual em uma região da AWS específica. O comando retorna extensões personalizadas e criadas pela AWS. ``` aws appconfig list-extensions \ --region us-west-2 ``` Resultado: ``` { "Items": [ { "Id": "1A2B3C4D", "Name": "S3-backup-extension", "VersionNumber": 1, "Arn": "arn:aws:appconfig:us-west-2:123456789012:extension/1A2B3C4D/1" }, { "Id": "AWS.AppConfig.FeatureFlags", "Name": "AppConfig Feature Flags Helper", "VersionNumber": 1, "Arn": "arn:aws:appconfig:us-west-2::extension/AWS.AppConfig.FeatureFlags/1", "Description": "Validates AppConfig feature flag data automatically against a JSON schema that includes structure and constraints. Also transforms feature flag data prior to sending to the client. This extension is automatically associated to configuration profiles with type \"AWS.AppConfig.FeatureFlags\"." }, { "Id": "AWS.AppConfig.JiraIntegration", "Name": "AppConfig integration with Atlassian Jira", "VersionNumber": 1, "Arn": "arn:aws:appconfig:us-west-2::extension/AWS.AppConfig.JiraIntegration/1", "Description": "Exports feature flag data from AWS AppConfig into Jira. The lifecycle of each feature flag in AppConfig is tracked in Jira as an individual issue. Customers can see in Jira when flags are updated, turned on or off. Works in conjunction with the AppConfig app in the Atlassian Marketplace and is automatically associated to configuration profiles configured within that app." }, { "Id": "AWS.AppConfig.DeploymentNotificationsToEventBridge", "Name": "AppConfig deployment events to Amazon EventBridge", "VersionNumber": 1, "Arn": "arn:aws:appconfig:us-west-2::extension/AWS.AppConfig.DeploymentNotificationsToEventBridge/1", "Description": "Sends events to Amazon EventBridge when a deployment of configuration data in AppConfig is started, completed, or rolled back. Can be associated to the following resources in AppConfig: Application, Environment, Configuration Profile." }, { "Id": "AWS.AppConfig.DeploymentNotificationsToSqs", "Name": "AppConfig deployment events to Amazon SQS", "VersionNumber": 1, "Arn": "arn:aws:appconfig:us-west-2::extension/AWS.AppConfig.DeploymentNotificationsToSqs/1", "Description": "Sends messages to the configured Amazon SQS queue when a deployment of configuration data in AppConfig is started, completed, or rolled back. Can be associated to the following resources in AppConfig: Application, Environment, Configuration Profile." }, { "Id": "AWS.AppConfig.DeploymentNotificationsToSns", "Name": "AppConfig deployment events to Amazon SNS", "VersionNumber": 1, "Description": "Sends events to the configured Amazon SNS topic when a deployment of configuration data in AppConfig is started, completed, or rolled back. Can be associated to the following resources in AppConfig: Application, Environment, Configuration Profile." } ] } ``` Para obter mais informações, consulte [Trabalhar com extensões do AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [ListExtensions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/list-extensions.html) na *Referência de comandos da AWS CLI*. ### `list-hosted-configuration-versions` O código de exemplo a seguir mostra como usar `list-hosted-configuration-versions`. **AWS CLI** **Para listar as versões de configuração hospedada disponíveis** O exemplo `list-hosted-configuration-versions` a seguir lista as versões de configurações hospedadas no armazenamento de configuração hospedada do AWS AppConfig para a aplicação e o perfil de configuração especificados. ``` aws appconfig list-hosted-configuration-versions \ --application-id 339ohji \ --configuration-profile-id ur8hx2f ``` Resultado: ``` { "Items": [ { "ApplicationId": "339ohji", "ConfigurationProfileId": "ur8hx2f", "VersionNumber": 1, "ContentType": "application/json" } ] } ``` Para obter mais informações, consulte [Sobre o armazenamento de configuração hospedado do AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html#appconfig-creating-configuration-and-profile-about-hosted-store) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [ListHostedConfigurationVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/list-hosted-configuration-versions.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar as tags de uma aplicação** O exemplo `list-tags-for-resource` a seguir lista as tags de uma aplicação especificada. ``` aws appconfig list-tags-for-resource \ --resource-arn arn:aws:appconfig:us-east-1:682428703967:application/339ohji ``` Resultado: ``` { "Tags": { "group1": "1" } } ``` Para obter mais informações, consulte [Etapa 1: criar uma aplicação do AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-application.html) no *Guia do usuário do AWS AppConfig*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `start-deployment` O código de exemplo a seguir mostra como usar `start-deployment`. **AWS CLI** **Para iniciar uma implantação de configuração** O exemplo `start-deployment` a seguir inicia uma implantação na aplicação usando o ambiente, a estratégia de implantação e o perfil de configuração especificados. ``` aws appconfig start-deployment \ --application-id 339ohji \ --environment-id 54j1r29 \ --deployment-strategy-id 1225qzk \ --configuration-profile-id ur8hx2f \ --configuration-version 1 ``` Resultado: ``` { "ApplicationId": "339ohji", "EnvironmentId": "54j1r29", "DeploymentStrategyId": "1225qzk", "ConfigurationProfileId": "ur8hx2f", "DeploymentNumber": 1, "ConfigurationName": "Example-Configuration-Profile", "ConfigurationLocationUri": "ssm-parameter://Example-Parameter", "ConfigurationVersion": "1", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR", "GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 0, "State": "DEPLOYING", "EventLog": [ { "EventType": "DEPLOYMENT_STARTED", "TriggeredBy": "USER", "Description": "Deployment started", "OccurredAt": "2021-09-17T21:43:54.205000+00:00" } ], "PercentageComplete": 0.0, "StartedAt": "2021-09-17T21:43:54.205000+00:00" } ``` Para obter mais informações, consulte [Etapa 5: implantar uma configuração](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-deploying.html) no *Manual do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [StartDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/start-deployment.html) na *Referência de comandos da AWS CLI*. ### `stop-deployment` O código de exemplo a seguir mostra como usar `stop-deployment`. **AWS CLI** **Como interromper a implantação da configuração** O exemplo `stop-deployment` a seguir interrompe a implantação de uma configuração da aplicação no ambiente especificado. ``` aws appconfig stop-deployment \ --application-id 339ohji \ --environment-id 54j1r29 \ --deployment-number 2 ``` Resultado: ``` { "DeploymentNumber": 0, "DeploymentDurationInMinutes": 0, "GrowthFactor": 0.0, "FinalBakeTimeInMinutes": 0, "PercentageComplete": 0.0 } ``` Para obter mais informações, consulte [Etapa 5: implantar uma configuração](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-deploying.html) no *Manual do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [StopDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/stop-deployment.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como marcar uma aplicação** O exemplo `tag-resource` a seguir adiciona uma tag a um recurso da aplicação. ``` aws appconfig tag-resource \ --resource-arn arn:aws:appconfig:us-east-1:682428703967:application/339ohji \ --tags '{"group1" : "1"}' ``` Este comando não produz saída. Para obter mais informações, consulte [Etapa 1: criar uma aplicação do AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-application.html) no *Guia do usuário do AWS AppConfig*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover uma tag de uma aplicação** O exemplo `untag-resource` a seguir remove a tag group1 da aplicação especificada. ``` aws appconfig untag-resource \ --resource-arn arn:aws:appconfig:us-east-1:111122223333:application/339ohji \ --tag-keys '["group1"]' ``` Este comando não produz saída. Para obter mais informações, consulte [Etapa 1: criar uma aplicação do AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-application.html) no *Guia do usuário do AWS AppConfig*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-application` O código de exemplo a seguir mostra como usar `update-application`. **AWS CLI** **Para atualizar uma aplicação** O exemplo `update-application` a seguir atualiza o nome da aplicação especificada. ``` aws appconfig update-application \ --application-id 339ohji \ --name "Example-Application" ``` Resultado: ``` { "Id": "339ohji", "Name": "Example-Application", "Description": "An application used for creating an example." } ``` Para obter mais informações, consulte [Etapa 1: criar uma aplicação do AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-application.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [UpdateApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/update-application.html) na *Referência de comandos da AWS CLI*. ### `update-configuration-profile` O código de exemplo a seguir mostra como usar `update-configuration-profile`. **AWS CLI** **Para atualizar um perfil de configuração** O exemplo `update-configuration-profile` a seguir atualiza a descrição do perfil de configuração especificado. ``` aws appconfig update-configuration-profile \ --application-id 339ohji \ --configuration-profile-id ur8hx2f \ --description "Configuration profile used for examples." ``` Resultado: ``` { "ApplicationId": "339ohji", "Id": "ur8hx2f", "Name": "Example-Configuration-Profile", "Description": "Configuration profile used for examples.", "LocationUri": "ssm-parameter://Example-Parameter", "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role" } ``` Para obter mais informações, consulte [Etapa 3: criar uma configuração e um perfil de configuração](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [UpdateConfigurationProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/update-configuration-profile.html) na *Referência de comandos da AWS CLI*. ### `update-deployment-strategy` O código de exemplo a seguir mostra como usar `update-deployment-strategy`. **AWS CLI** **Para atualizar uma estratégia de implantação** O exemplo `update-deployment-strategy` a seguir atualiza o tempo de incorporação final para 20 minutos na estratégia de implantação especificada. ``` aws appconfig update-deployment-strategy \ --deployment-strategy-id 1225qzk \ --final-bake-time-in-minutes 20 ``` Resultado: ``` { "Id": "1225qzk", "Name": "Example-Deployment", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR", "GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 20, "ReplicateTo": "SSM_DOCUMENT" } ``` Para obter mais informações, consulte [Etapa 4: criar uma estratégia de implantação](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-deployment-strategy.html) no *Guia do usuário do AWSAppConfig*. + Para ver detalhes da API, consulte [UpdateDeploymentStrategy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/update-deployment-strategy.html) na *Referência de comandos da AWS CLI*. ### `update-environment` O código de exemplo a seguir mostra como usar `update-environment`. **AWS CLI** **Para atualizar um ambiente** O exemplo `update-environment` a seguir atualiza a descrição de um ambiente. ``` aws appconfig update-environment \ --application-id 339ohji \ --environment-id 54j1r29 \ --description "An environment for examples." ``` Resultado: ``` { "ApplicationId": "339ohji", "Id": "54j1r29", "Name": "Example-Environment", "Description": "An environment for examples.", "State": "RolledBack" } ``` Para obter mais informações, consulte [Etapa 2: criar um ambiente](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-environment.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [UpdateEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/update-environment.html) na *Referência de comandos da AWS CLI*. ### `update-extension-association` O código de exemplo a seguir mostra como usar `update-extension-association`. **AWS CLI** **Para atualizar uma associação de extensão do AWS AppConfig** O exemplo `update-extension-association` a seguir adiciona um novo valor de parâmetro a uma associação de extensão no AWS AppConfig. ``` aws appconfig update-extension-association \ --region us-west-2 \ --extension-association-id a1b2c3d4 \ --parameters S3bucket=FinanceMobileApp ``` Resultado: ``` { "Id": "a1b2c3d4", "ExtensionArn": "arn:aws:appconfig:us-west-2:123456789012:extension/S3-backup-extension/1", "ResourceArn": "arn:aws:appconfig:us-west-2:123456789012:application/Finance", "Parameters": { "S3bucket": "FinanceMobileApp" }, "ExtensionVersionNumber": 1 } ``` Para obter mais informações, consulte [Trabalhar com extensões do AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [UpdateExtensionAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/update-extension-association.html) na *Referência de comandos da AWS CLI*. ### `update-extension` O código de exemplo a seguir mostra como usar `update-extension`. **AWS CLI** **Para atualizar uma extensão do AWS AppConfig** O exemplo `update-extension` a seguir adiciona um parâmetro adicional Key a uma extensão no AWS AppConfig. ``` aws appconfig update-extension \ --region us-west-2 \ --extension-identifier S3-backup-extension \ --parameters S3bucket={Required=true},CampaignID={Required=false} ``` Resultado: ``` { "Id": "1A2B3C4D", "Name": "S3-backup-extension", "VersionNumber": 1, "Arn": "arn:aws:appconfig:us-west-2:123456789012:extension/1A2B3C4D/1", "Actions": { "PRE_CREATE_HOSTED_CONFIGURATION_VERSION": [ { "Name": "S3backup", "Uri": "arn:aws:lambda:us-west-2:123456789012:function:S3backupfunction", "RoleArn": "arn:aws:iam::123456789012:role/appconfigextensionrole" } ] }, "Parameters": { "CampaignID": { "Required": false }, "S3bucket": { "Required": true } } } ``` Para obter mais informações, consulte [Trabalhar com extensões do AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [UpdateExtension](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/update-extension.html) na *Referência de comandos da AWS CLI*. ### `validate-configuration` O código de exemplo a seguir mostra como usar `validate-configuration`. **AWS CLI** **Para validar a configuração** O exemplo `validate-configuration` a seguir usa os validadores em um perfil de configuração para validar uma configuração. ``` aws appconfig validate-configuration \ --application-id abc1234 \ --configuration-profile-id ur8hx2f \ --configuration-version 1 ``` O comando não produz saída. Para obter mais informações, consulte [Etapa 3: criar uma configuração e um perfil de configuração](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html) no *Guia do usuário do AWS AppConfig*. + Para ver detalhes da API, consulte [ValidateConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/validate-configuration.html) na *Referência de comandos da AWS CLI*. # Exemplos do Application Auto Scaling usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o 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 ### `delete-scaling-policy` O código de exemplo a seguir mostra como usar `delete-scaling-policy`. **AWS CLI** **Para excluir uma política de escalabilidade** Este exemplo exclui uma política de escalabilidade para a aplicação web do serviço Amazon ECS em execução no cluster padrão. Comando: ``` aws application-autoscaling delete-scaling-policy --policy-name web-app-cpu-lt-25 --scalable-dimension ecs:service:DesiredCount --resource-id service/default/web-app --service-namespace ecs ``` + Para ver detalhes da API, consulte [DeleteScalingPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/delete-scaling-policy.html) na *Referência de comandos da AWS CLI*. ### `delete-scheduled-action` O código de exemplo a seguir mostra como usar `delete-scheduled-action`. **AWS CLI** **Para excluir uma ação programada** O exemplo `delete-scheduled-action` a seguir exclui a ação programada especificada da frota especificada do Amazon AppStream 2.0: ``` aws application-autoscaling delete-scheduled-action \ --service-namespace appstream \ --scalable-dimension appstream:fleet:DesiredCapacity \ --resource-id fleet/sample-fleet \ --scheduled-action-name my-recurring-action ``` Este comando não produz saída. Para obter mais informações, consulte [Escalabilidade programada](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html) no *Guia do usuário do Application Auto Scaling*. + Para ver detalhes da API, consulte [DeleteScheduledAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/delete-scheduled-action.html) na *Referência de comandos da AWS CLI*. ### `deregister-scalable-target` O código de exemplo a seguir mostra como usar `deregister-scalable-target`. **AWS CLI** **Como cancelar o registro de um destino escalável** Este exemplo cancela o registro de um destino escalável para um serviço do Amazon ECS chamado web-app que está sendo executado no cluster padrão. Comando: ``` aws application-autoscaling deregister-scalable-target --service-namespace ecs --scalable-dimension ecs:service:DesiredCount --resource-id service/default/web-app ``` Este exemplo cancela o registro de uma meta escalável para um recurso personalizado. O arquivo custom-resource-id.txt contém uma string que identifica o ID do recurso, que, para um recurso personalizado, é o caminho para o recurso personalizado por meio do endpoint do Amazon API Gateway. Comando: ``` aws application-autoscaling deregister-scalable-target --service-namespace custom-resource --scalable-dimension custom-resource:ResourceType:Property --resource-id file://~/custom-resource-id.txt ``` Conteúdo do arquivo custom-resource-id.txt: ``` https://example.execute-api.us-west-2.amazonaws.com/prod/scalableTargetDimensions/1-23456789 ``` + Para ver detalhes da API, consulte [DeregisterScalableTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/deregister-scalable-target.html) na *Referência de comandos da AWS CLI*. ### `describe-scalable-targets` O código de exemplo a seguir mostra como usar `describe-scalable-targets`. **AWS CLI** **Para descrever destinos escaláveis** O exemplo `describe-scalable-targets` a seguir descreve os destinos escaláveis para o namespace do serviço `ecs`. ``` aws application-autoscaling describe-scalable-targets \ --service-namespace ecs ``` Resultado: ``` { "ScalableTargets": [ { "ServiceNamespace": "ecs", "ScalableDimension": "ecs:service:DesiredCount", "ResourceId": "service/default/web-app", "MinCapacity": 1, "MaxCapacity": 10, "RoleARN": "arn:aws:iam::123456789012:role/aws-service-role/ecs.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_ECSService", "CreationTime": 1462558906.199, "SuspendedState": { "DynamicScalingOutSuspended": false, "ScheduledScalingSuspended": false, "DynamicScalingInSuspended": false }, "ScalableTargetARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123" } ] } ``` Para obter mais informações, consulte [Serviços da AWS que podem ser usados com o Application Auto Scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/integrated-services-list.html) no *Guia do usuário do Application Auto Scaling*. + Para ver detalhes da API, consulte [DescribeScalableTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/describe-scalable-targets.html) na *Referência de comandos da AWS CLI*. ### `describe-scaling-activities` O código de exemplo a seguir mostra como usar `describe-scaling-activities`. **AWS CLI** **Exemplo 1: descrever as atividades de ajuste de escala do serviço do Amazon ECS especificado** O exemplo `describe-scaling-activities` a seguir descreve as atividades de escalabilidade de um serviço do Amazon ECS chamado `web-app` que está sendo executado no cluster `default`. A saída mostra uma atividade de ajuste de escala iniciada por uma política de ajuste de escala. ``` aws application-autoscaling describe-scaling-activities \ --service-namespace ecs \ --resource-id service/default/web-app ``` Resultado: ``` { "ScalingActivities": [ { "ScalableDimension": "ecs:service:DesiredCount", "Description": "Setting desired count to 1.", "ResourceId": "service/default/web-app", "ActivityId": "e6c5f7d1-dbbb-4a3f-89b2-51f33e766399", "StartTime": 1462575838.171, "ServiceNamespace": "ecs", "EndTime": 1462575872.111, "Cause": "monitor alarm web-app-cpu-lt-25 in state ALARM triggered policy web-app-cpu-lt-25", "StatusMessage": "Successfully set desired count to 1. Change successfully fulfilled by ecs.", "StatusCode": "Successful" } ] } ``` Para obter mais informações, consulte [Atividades de escalabilidade para o Application Auto Scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scaling-activities.html) no *Guia do usuário do Application Auto Scaling*. **Exemplo 2: descrever as ações de ajuste de escala da tabela do DynamoDB especificada** O exemplo `describe-scaling-activities` a seguir descreve as atividades de ajuste de escala de uma tabela do DynamoDB chamada `TestTable`. O resultado mostra as atividades de ajuste de escala iniciadas por duas ações agendadas diferentes. ``` aws application-autoscaling describe-scaling-activities \ --service-namespace dynamodb \ --resource-id table/TestTable ``` Resultado: ``` { "ScalingActivities": [ { "ScalableDimension": "dynamodb:table:WriteCapacityUnits", "Description": "Setting write capacity units to 10.", "ResourceId": "table/my-table", "ActivityId": "4d1308c0-bbcf-4514-a673-b0220ae38547", "StartTime": 1561574415.086, "ServiceNamespace": "dynamodb", "EndTime": 1561574449.51, "Cause": "maximum capacity was set to 10", "StatusMessage": "Successfully set write capacity units to 10. Change successfully fulfilled by dynamodb.", "StatusCode": "Successful" }, { "ScalableDimension": "dynamodb:table:WriteCapacityUnits", "Description": "Setting min capacity to 5 and max capacity to 10", "ResourceId": "table/my-table", "ActivityId": "f2b7847b-721d-4e01-8ef0-0c8d3bacc1c7", "StartTime": 1561574414.644, "ServiceNamespace": "dynamodb", "Cause": "scheduled action name my-second-scheduled-action was triggered", "StatusMessage": "Successfully set min capacity to 5 and max capacity to 10", "StatusCode": "Successful" }, { "ScalableDimension": "dynamodb:table:WriteCapacityUnits", "Description": "Setting write capacity units to 15.", "ResourceId": "table/my-table", "ActivityId": "d8ea4de6-9eaa-499f-b466-2cc5e681ba8b", "StartTime": 1561574108.904, "ServiceNamespace": "dynamodb", "EndTime": 1561574140.255, "Cause": "minimum capacity was set to 15", "StatusMessage": "Successfully set write capacity units to 15. Change successfully fulfilled by dynamodb.", "StatusCode": "Successful" }, { "ScalableDimension": "dynamodb:table:WriteCapacityUnits", "Description": "Setting min capacity to 15 and max capacity to 20", "ResourceId": "table/my-table", "ActivityId": "3250fd06-6940-4e8e-bb1f-d494db7554d2", "StartTime": 1561574108.512, "ServiceNamespace": "dynamodb", "Cause": "scheduled action name my-first-scheduled-action was triggered", "StatusMessage": "Successfully set min capacity to 15 and max capacity to 20", "StatusCode": "Successful" } ] } ``` Para obter mais informações, consulte [Atividades de escalabilidade para o Application Auto Scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scaling-activities.html) no *Guia do usuário do Application Auto Scaling*. + Consulte detalhes da API em [DescribeScalingActivities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/describe-scaling-activities.html) na *Referência de comandos AWS CLI*. ### `describe-scaling-policies` O código de exemplo a seguir mostra como usar `describe-scaling-policies`. **AWS CLI** **Para descrever políticas de ajuste de escala** Este exemplo de comando descreve as políticas de ajuste de escala para o namespace do serviço ecs. Comando: ``` aws application-autoscaling describe-scaling-policies --service-namespace ecs ``` Resultado: ``` { "ScalingPolicies": [ { "PolicyName": "web-app-cpu-gt-75", "ScalableDimension": "ecs:service:DesiredCount", "ResourceId": "service/default/web-app", "CreationTime": 1462561899.23, "StepScalingPolicyConfiguration": { "Cooldown": 60, "StepAdjustments": [ { "ScalingAdjustment": 200, "MetricIntervalLowerBound": 0.0 } ], "AdjustmentType": "PercentChangeInCapacity" }, "PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-gt-75", "PolicyType": "StepScaling", "Alarms": [ { "AlarmName": "web-app-cpu-gt-75", "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:web-app-cpu-gt-75" } ], "ServiceNamespace": "ecs" }, { "PolicyName": "web-app-cpu-lt-25", "ScalableDimension": "ecs:service:DesiredCount", "ResourceId": "service/default/web-app", "CreationTime": 1462562575.099, "StepScalingPolicyConfiguration": { "Cooldown": 1, "StepAdjustments": [ { "ScalingAdjustment": -50, "MetricIntervalUpperBound": 0.0 } ], "AdjustmentType": "PercentChangeInCapacity" }, "PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-lt-25", "PolicyType": "StepScaling", "Alarms": [ { "AlarmName": "web-app-cpu-lt-25", "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:web-app-cpu-lt-25" } ], "ServiceNamespace": "ecs" } ] } ``` + Para ver detalhes da API, consulte [DescribeScalingPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/describe-scaling-policies.html) na *Referência de comandos da AWS CLI*. ### `describe-scheduled-actions` O código de exemplo a seguir mostra como usar `describe-scheduled-actions`. **AWS CLI** **Para descrever ações programadas** O exemplo `describe-scheduled-actions` a seguir exibe detalhes das ações agendadas para o namespace de serviço especificado: ``` aws application-autoscaling describe-scheduled-actions \ --service-namespace dynamodb ``` Resultado: ``` { "ScheduledActions": [ { "ScalableDimension": "dynamodb:table:WriteCapacityUnits", "Schedule": "at(2019-05-20T18:35:00)", "ResourceId": "table/my-table", "CreationTime": 1561571888.361, "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledAction:2d36aa3b-cdf9-4565-b290-81db519b227d:resource/dynamodb/table/my-table:scheduledActionName/my-first-scheduled-action", "ScalableTargetAction": { "MinCapacity": 15, "MaxCapacity": 20 }, "ScheduledActionName": "my-first-scheduled-action", "ServiceNamespace": "dynamodb" }, { "ScalableDimension": "dynamodb:table:WriteCapacityUnits", "Schedule": "at(2019-05-20T18:40:00)", "ResourceId": "table/my-table", "CreationTime": 1561571946.021, "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledAction:2d36aa3b-cdf9-4565-b290-81db519b227d:resource/dynamodb/table/my-table:scheduledActionName/my-second-scheduled-action", "ScalableTargetAction": { "MinCapacity": 5, "MaxCapacity": 10 }, "ScheduledActionName": "my-second-scheduled-action", "ServiceNamespace": "dynamodb" } ] } ``` Para obter mais informações, consulte [Escalabilidade programada](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html) no *Guia do usuário do Application Auto Scaling*. + Para ver detalhes da API, consulte [DescribeScheduledActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/describe-scheduled-actions.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar as tags de um destino escalável** O exemplo `list-tags-for-resource` a seguir lista os nomes e valores das chaves de tag que estão anexados ao destino escalável especificado por seu ARN. ``` aws application-autoscaling list-tags-for-resource \ --resource-arn arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123 ``` Resultado: ``` { "Tags": { "environment": "production" } } ``` Para obter mais informações, consulte [Suporte à marcação para o Application Auto Scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/resource-tagging-support.html) no *Guia do usuário do Application Auto Scaling*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `put-scaling-policy` O código de exemplo a seguir mostra como usar `put-scaling-policy`. **AWS CLI** **Exemplo 1: como aplicar uma política de escalabilidade com monitoramento do objetivo com uma especificação de métrica predefinida** O exemplo `put-scaling-policy` a seguir aplica uma política de ajuste de escala de rastreamento de destino com uma especificação de métrica predefinida a um serviço do ECS chamado web-app no cluster padrão. A política mantém a utilização média da CPU do serviço em 75%, com períodos de espera de aumento e redução de escala horizontalmente de 60 segundos. A saída contém os ARNs e os nomes dos dois alarmes do CloudWatch criados em seu nome. ``` aws application-autoscaling put-scaling-policy --service-namespace ecs \ --scalable-dimension ecs:service:DesiredCount \ --resource-id service/default/web-app \ --policy-name cpu75-target-tracking-scaling-policy --policy-type TargetTrackingScaling \ --target-tracking-scaling-policy-configuration file://config.json ``` Este exemplo pressupõe que você tenha um arquivo config.json no diretório atual com o seguinte conteúdo: ``` { "TargetValue": 75.0, "PredefinedMetricSpecification": { "PredefinedMetricType": "ECSServiceAverageCPUUtilization" }, "ScaleOutCooldown": 60, "ScaleInCooldown": 60 } ``` Resultado: ``` { "PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/cpu75-target-tracking-scaling-policy", "Alarms": [ { "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca", "AlarmName": "TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca" }, { "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmLow-1b437334-d19b-4a63-a812-6c67aaf2910d", "AlarmName": "TargetTracking-service/default/web-app-AlarmLow-1b437334-d19b-4a63-a812-6c67aaf2910d" } ] } ``` **Exemplo 2: como aplicar uma política de escalabilidade com monitoramento do objetivo com uma especificação de métrica personalizada** O exemplo `put-scaling-policy` a seguir aplica uma política de ajuste de escala de rastreamento de destino com uma especificação de métrica personalizada a um serviço do ECS chamado web-app no cluster padrão. A política mantém a utilização média do serviço em 75%, com períodos de espera de aumento e redução de escala horizontalmente de 60 segundos. A saída contém os ARNs e os nomes dos dois alarmes do CloudWatch criados em seu nome. ``` aws application-autoscaling put-scaling-policy --service-namespace ecs \ --scalable-dimension ecs:service:DesiredCount \ --resource-id service/default/web-app \ --policy-name cms75-target-tracking-scaling-policy --policy-type TargetTrackingScaling \ --target-tracking-scaling-policy-configuration file://config.json ``` Este exemplo pressupõe que você tenha um arquivo config.json no diretório atual com o seguinte conteúdo: ``` { "TargetValue":75.0, "CustomizedMetricSpecification":{ "MetricName":"MyUtilizationMetric", "Namespace":"MyNamespace", "Dimensions": [ { "Name":"MyOptionalMetricDimensionName", "Value":"MyOptionalMetricDimensionValue" } ], "Statistic":"Average", "Unit":"Percent" }, "ScaleOutCooldown": 60, "ScaleInCooldown": 60 } ``` Resultado: ``` { "PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy: 8784a896-b2ba-47a1-b08c-27301cc499a1:resource/ecs/service/default/web-app:policyName/cms75-target-tracking-scaling-policy", "Alarms": [ { "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmHigh-9bc77b56-0571-4276-ba0f-d4178882e0a0", "AlarmName": "TargetTracking-service/default/web-app-AlarmHigh-9bc77b56-0571-4276-ba0f-d4178882e0a0" }, { "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmLow-9b6ad934-6d37-438e-9e05-02836ddcbdc4", "AlarmName": "TargetTracking-service/default/web-app-AlarmLow-9b6ad934-6d37-438e-9e05-02836ddcbdc4" } ] } ``` **Exemplo 3: como aplicar uma política de escalabilidade com monitoramento do objetivo somente para expansão** O exemplo `put-scaling-policy` a seguir aplica uma política de ajuste de escala de rastreamento de destino a um serviço do ECS chamado `web-app` no cluster padrão. A política é usada para aumentar a escala horizontalmente o serviço ECS quando a métrica `RequestCountPerTarget` do Application Load Balancer excede o limite. A saída contém o ARN e o nome do alarme do CloudWatch criado em seu nome. ``` aws application-autoscaling put-scaling-policy \ --service-namespace ecs \ --scalable-dimension ecs:service:DesiredCount \ --resource-id service/default/web-app \ --policy-name alb-scale-out-target-tracking-scaling-policy \ --policy-type TargetTrackingScaling \ --target-tracking-scaling-policy-configuration file://config.json ``` Conteúdo de `config.json`: ``` { "TargetValue": 1000.0, "PredefinedMetricSpecification": { "PredefinedMetricType": "ALBRequestCountPerTarget", "ResourceLabel": "app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d" }, "ScaleOutCooldown": 60, "ScaleInCooldown": 60, "DisableScaleIn": true } ``` Resultado: ``` { "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/alb-scale-out-target-tracking-scaling-policy", "Alarms": [ { "AlarmName": "TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca", "AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca" } ] } ``` Para obter mais informações, consulte [Políticas de ajuste de escala de rastreamento de destino para o Application Auto Scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) no *Guia do usuário do AWS Application Auto Scaling*. + Para ver detalhes da API, consulte [PutScalingPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/put-scaling-policy.html) na *Referência de comandos da AWS CLI*. ### `put-scheduled-action` O código de exemplo a seguir mostra como usar `put-scheduled-action`. **AWS CLI** **Para adicionar uma ação programada a uma tabela do DynamoDB** Este exemplo adiciona uma ação programada a uma tabela do DynamoDB chamada TestTable para aumentar a escala horizontalmente de acordo com uma programação recorrente. Na programação que especificou (todo dia às 12:15 UTC), se a capacidade atual estiver abaixo do valor especificado para MinCapacity, o Application Auto Scaling aumenta a escala horizontalmente do valor especificado para MinCapacity. Comando: ``` aws application-autoscaling put-scheduled-action --service-namespace dynamodb --scheduled-action-name my-recurring-action --schedule "cron(15 12 * * ? *)" --resource-id table/TestTable --scalable-dimension dynamodb:table:WriteCapacityUnits --scalable-target-action MinCapacity=6 ``` Para obter mais informações, consulte Escalabilidade programada no *Guia do usuário do Application Auto Scaling*. + Para ver detalhes da API, consulte [PutScheduledAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/put-scheduled-action.html) na *Referência de comandos da AWS CLI*. ### `register-scalable-target` O código de exemplo a seguir mostra como usar `register-scalable-target`. **AWS CLI** **Exemplo 1: registrar um serviço ECS como um destino escalável** O exemplo `register-scalable-target` a seguir inscreve um serviço do Amazon ECS com o Application Auto Scaling. Ele também adiciona uma tag com o nome `environment` e o valor `production` da chave ao destino escalável. ``` aws application-autoscaling register-scalable-target \ --service-namespace ecs \ --scalable-dimension ecs:service:DesiredCount \ --resource-id service/default/web-app \ --min-capacity 1 --max-capacity 10 \ --tags environment=production ``` Resultado: ``` { "ScalableTargetARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123" } ``` Para obter exemplos de outros serviços e recursos personalizados da AWS, consulte os tópicos em [Serviços da AWS que você pode usar com o Application Auto Scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/integrated-services-list.html) no *Guia do Usuário do Application Auto Scaling*. **Exemplo 2: suspender as atividades de escalabilidade de um destino escalável** O exemplo `register-scalable-target` a seguir suspende as atividades de ajuste de escala de um destino escalável existente. ``` aws application-autoscaling register-scalable-target \ --service-namespace dynamodb \ --scalable-dimension dynamodb:table:ReadCapacityUnits \ --resource-id table/my-table \ --suspended-state DynamicScalingInSuspended=true,DynamicScalingOutSuspended=true,ScheduledScalingSuspended=true ``` Resultado: ``` { "ScalableTargetARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123" } ``` Para obter mais informações, consulte [Como suspender e retomar o ajuste de escala do Application Auto Scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html) no *Guia do usuário do Application Auto Scaling*. **Exemplo 3: retomar as atividades de escalabilidade para um destino escalável** O exemplo `register-scalable-target` a seguir retoma as atividades de ajuste de escala de um destino escalável existente. ``` aws application-autoscaling register-scalable-target \ --service-namespace dynamodb \ --scalable-dimension dynamodb:table:ReadCapacityUnits \ --resource-id table/my-table \ --suspended-state DynamicScalingInSuspended=false,DynamicScalingOutSuspended=false,ScheduledScalingSuspended=false ``` Resultado: ``` { "ScalableTargetARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123" } ``` Para obter mais informações, consulte [Como suspender e retomar o ajuste de escala do Application Auto Scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html) no *Guia do usuário do Application Auto Scaling*. + Para ver detalhes da API, consulte [RegisterScalableTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/register-scalable-target.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Para adicionar uma tag a um destino escalável** O exemplo `tag-resource` a seguir adiciona uma tag com o nome `environment` e o valor `production` da chave ao destino escalável especificado por seu ARN. ``` aws application-autoscaling tag-resource \ --resource-arn arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123 \ --tags environment=production ``` Este comando não produz saída. Para obter mais informações, consulte [Suporte à marcação para o Application Auto Scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/resource-tagging-support.html) no *Guia do usuário do Application Auto Scaling*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover uma tag de um destino escalável** O exemplo `untag-resource` a seguir remove o par de tags com o nome `environment` da chave do destino escalável especificado por seu ARN. ``` aws application-autoscaling untag-resource \ --resource-arn arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123 \ --tag-keys "environment" ``` Este comando não produz saída. Para obter mais informações, consulte [Suporte à marcação para o Application Auto Scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/resource-tagging-support.html) no *Guia do usuário do Application Auto Scaling*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/untag-resource.html) na *Referência de comandos da AWS CLI*. # Exemplos do Application Discovery Service usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o Application Discovery 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 ### `describe-agents` O código de exemplo a seguir mostra como usar `describe-agents`. **AWS CLI** **Para descrever agentes com estados de collectionStatus especificados** Este exemplo de comando descreve agentes de coleta com status de coleta “INICIADO” ou “INTERROMPIDO”. Comando: ``` aws discovery describe-agents --filters name="collectionStatus",values="STARTED","STOPPED",condition="EQUALS" --max-results 3 ``` Resultado: ``` { "Snapshots": [ { "version": "1.0.40.0", "agentType": "EC2", "hostName": "ip-172-31-40-234", "collectionStatus": "STOPPED", "agentNetworkInfoList": [ { "macAddress": "06:b5:97:14:fc:0d", "ipAddress": "172.31.40.234" } ], "health": "UNKNOWN", "agentId": "i-003305c02a776e883", "registeredTime": "2016-12-09T19:05:06Z", "lastHealthPingTime": "2016-12-09T19:05:10Z" }, { "version": "1.0.40.0", "agentType": "EC2", "hostName": "ip-172-31-39-64", "collectionStatus": "STARTED", "agentNetworkInfoList": [ { "macAddress": "06:a1:0e:c7:b2:73", "ipAddress": "172.31.39.64" } ], "health": "SHUTDOWN", "agentId": "i-003a5e5e2b36cf8bd", "registeredTime": "2016-11-16T16:36:25Z", "lastHealthPingTime": "2016-11-16T16:47:37Z" } ] } ``` + Para ver detalhes da API, consulte [DescribeAgents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/discovery/describe-agents.html) na *Referência de comandos da AWS CLI*. ### `describe-configurations` O código de exemplo a seguir mostra como usar `describe-configurations`. **AWS CLI** **Para descrever as configurações de ativos selecionadas** Este exemplo de comando descreve as configurações de dois servidores especificados. A ação detecta o tipo de ativo a partir do ID de configuração. Somente um tipo de ativo é permitido por comando. Comando: ``` aws discovery describe-configurations --configuration-ids "d-server-099385097ef9fbcfb" "d-server-0c4f2dd1fee22c6c1" ``` Resultado: ``` { "configurations": [ { "server.performance.maxCpuUsagePct": "0.0", "server.performance.maxDiskReadIOPS": "0.0", "server.performance.avgCpuUsagePct": "0.0", "server.type": "EC2", "server.performance.maxNetworkReadsPerSecondInKB": "0.19140625", "server.hostName": "ip-172-31-35-152", "server.configurationId": "d-server-0c4f2dd1fee22c6c1", "server.tags.hasMoreValues": "false", "server.performance.minFreeRAMInKB": "1543496.0", "server.osVersion": "3.14.48-33.39.amzn1.x86_64", "server.performance.maxDiskReadsPerSecondInKB": "0.0", "server.applications": "[]", "server.performance.numDisks": "1", "server.performance.numCpus": "1", "server.performance.numCores": "1", "server.performance.maxDiskWriteIOPS": "0.0", "server.performance.maxNetworkWritesPerSecondInKB": "0.82421875", "server.performance.avgDiskWritesPerSecondInKB": "0.0", "server.networkInterfaceInfo": "[{\"name\":\"eth0\",\"macAddress\":\"06:A7:7D:3F:54:57\",\"ipAddress\":\"172.31.35.152\",\"netMask\":\"255.255.240.0\"},{\"name\":\"lo\",\"macAddress\":\"00:00:00:00:00:00\",\"ipAddress\":\"127.0.0.1\",\"netMask\":\"255.0.0.0\"},{\"name\":\"eth0\",\"macAddress\":\"06:A7:7D:3F:54:57\",\"ipAddress\":\"fe80::4a7:7dff:fe3f:5457\"},{\"name\":\"lo\",\"macAddress\":\"00:00:00:00:00:00\",\"ipAddress\":\"::1\"}]", "server.performance.avgNetworkReadsPerSecondInKB": "0.04915364583333333", "server.tags": "[]", "server.applications.hasMoreValues": "false", "server.timeOfCreation": "2016-10-28 23:44:00.0", "server.agentId": "i-4447bc1b", "server.performance.maxDiskWritesPerSecondInKB": "0.0", "server.performance.avgDiskReadIOPS": "0.0", "server.performance.avgFreeRAMInKB": "1547210.1333333333", "server.performance.avgDiskReadsPerSecondInKB": "0.0", "server.performance.avgDiskWriteIOPS": "0.0", "server.performance.numNetworkCards": "2", "server.hypervisor": "xen", "server.networkInterfaceInfo.hasMoreValues": "false", "server.performance.avgNetworkWritesPerSecondInKB": "0.1380859375", "server.osName": "Linux - Amazon Linux AMI release 2015.03", "server.performance.totalRAMInKB": "1694732.0", "server.cpuType": "x64" }, { "server.performance.maxCpuUsagePct": "100.0", "server.performance.maxDiskReadIOPS": "0.0", "server.performance.avgCpuUsagePct": "14.733333333333338", "server.type": "EC2", "server.performance.maxNetworkReadsPerSecondInKB": "13.400390625", "server.hostName": "ip-172-31-42-208", "server.configurationId": "d-server-099385097ef9fbcfb", "server.tags.hasMoreValues": "false", "server.performance.minFreeRAMInKB": "1531104.0", "server.osVersion": "3.14.48-33.39.amzn1.x86_64", "server.performance.maxDiskReadsPerSecondInKB": "0.0", "server.applications": "[]", "server.performance.numDisks": "1", "server.performance.numCpus": "1", "server.performance.numCores": "1", "server.performance.maxDiskWriteIOPS": "1.0", "server.performance.maxNetworkWritesPerSecondInKB": "12.271484375", "server.performance.avgDiskWritesPerSecondInKB": "0.5333333333333334", "server.networkInterfaceInfo": "[{\"name\":\"eth0\",\"macAddress\":\"06:4A:79:60:75:61\",\"ipAddress\":\"172.31.42.208\",\"netMask\":\"255.255.240.0\"},{\"name\":\"eth0\",\"macAddress\":\"06:4A:79:60:75:61\",\"ipAddress\":\"fe80::44a:79ff:fe60:7561\"},{\"name\":\"lo\",\"macAddress\":\"00:00:00:00:00:00\",\"ipAddress\":\"::1\"},{\"name\":\"lo\",\"macAddress\":\"00:00:00:00:00:00\",\"ipAddress\":\"127.0.0.1\",\"netMask\":\"255.0.0.0\"}]", "server.performance.avgNetworkReadsPerSecondInKB": "2.8720052083333334", "server.tags": "[]", "server.applications.hasMoreValues": "false", "server.timeOfCreation": "2016-10-28 23:44:30.0", "server.agentId": "i-c142b99e", "server.performance.maxDiskWritesPerSecondInKB": "4.0", "server.performance.avgDiskReadIOPS": "0.0", "server.performance.avgFreeRAMInKB": "1534946.4", "server.performance.avgDiskReadsPerSecondInKB": "0.0", "server.performance.avgDiskWriteIOPS": "0.13333333333333336", "server.performance.numNetworkCards": "2", "server.hypervisor": "xen", "server.networkInterfaceInfo.hasMoreValues": "false", "server.performance.avgNetworkWritesPerSecondInKB": "1.7977864583333332", "server.osName": "Linux - Amazon Linux AMI release 2015.03", "server.performance.totalRAMInKB": "1694732.0", "server.cpuType": "x64" } ] } ``` **Para descrever as configurações de ativos selecionadas** Este exemplo de comando descreve as configurações de duas aplicações especificadas. A ação detecta o tipo de ativo a partir do ID de configuração. Somente um tipo de ativo é permitido por comando. Comando: ``` aws discovery describe-configurations --configuration-ids "d-application-0ac39bc0e4fad0e42" "d-application-02444a45288013764q" ``` Resultado: ``` { "configurations": [ { "application.serverCount": "0", "application.name": "Application-12345", "application.lastModifiedTime": "2016-12-13 23:53:27.0", "application.description": "", "application.timeOfCreation": "2016-12-13 23:53:27.0", "application.configurationId": "d-application-0ac39bc0e4fad0e42" }, { "application.serverCount": "0", "application.name": "Application-67890", "application.lastModifiedTime": "2016-12-13 23:53:33.0", "application.description": "", "application.timeOfCreation": "2016-12-13 23:53:33.0", "application.configurationId": "d-application-02444a45288013764" } ] } ``` + Para ver detalhes da API, consulte [DescribeConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/discovery/describe-configurations.html) na *Referência de comandos da AWS CLI*. ### `list-configurations` O código de exemplo a seguir mostra como usar `list-configurations`. **AWS CLI** **Para listar todos os servidores descobertos que atendem a um conjunto de condições de filtro** Este exemplo de comando lista os servidores descobertos que correspondem a um dos dois padrões de nome de host e que não estão executando o Ubuntu. Comando: ``` aws discovery list-configurations --configuration-type SERVER --filters name="server.hostName",values="172-31-35","172-31-42",condition="CONTAINS" name="server.osName",values="Ubuntu",condition="NOT_CONTAINS" ``` Resultado: ``` { "configurations": [ { "server.osVersion": "3.14.48-33.39.amzn1.x86_64", "server.type": "EC2", "server.hostName": "ip-172-31-42-208", "server.timeOfCreation": "2016-10-28 23:44:30.0", "server.configurationId": "d-server-099385097ef9fbcfb", "server.osName": "Linux - Amazon Linux AMI release 2015.03", "server.agentId": "i-c142b99e" }, { "server.osVersion": "3.14.48-33.39.amzn1.x86_64", "server.type": "EC2", "server.hostName": "ip-172-31-35-152", "server.timeOfCreation": "2016-10-28 23:44:00.0", "server.configurationId": "d-server-0c4f2dd1fee22c6c1", "server.osName": "Linux - Amazon Linux AMI release 2015.03", "server.agentId": "i-4447bc1b" } ] } ``` + Para ver detalhes da API, consulte [ListConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/discovery/list-configurations.html) na *Referência de comandos da AWS CLI*. # Exemplos do Application Signals usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o Application Signals. *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 ### `batch-get-service-level-objective-budget-report` O código de exemplo a seguir mostra como usar `batch-get-service-level-objective-budget-report`. **AWS CLI** **Como recuperar um ou mais relatórios de orçamento de objetivo de nível de serviço (SLO)** O exemplo de `batch-get-service-level-objective-budget-report` a seguir recupera um ou mais relatórios de orçamento de objetivo de nível de serviço (SLO). ``` aws application-signals batch-get-service-level-objective-budget-report \ --timestamp 1735059869 \ --slo-ids "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName1" "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName2" ``` Resultado: ``` { "Timestamp": "2024-12-24T22:34:29+05:30", "Reports": [{ "Arn": "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName1", "Name": "Your SLO Name", "EvaluationType": "PeriodBased", "BudgetStatus": "OK", "Attainment": 100.0, "TotalBudgetSeconds": 6048, "BudgetSecondsRemaining": 6048, "Sli": { "SliMetric": { "MetricDataQueries": [{ "Id": "m1", "MetricStat": { "Metric": { "Namespace": "AWS/EC2", "MetricName": "CPUUtilization", "Dimensions": [{ "Name": "InstanceId", "Value": "i-0e098765432522" }] }, "Period": 60, "Stat": "Average" }, "ReturnData": true }] }, "MetricThreshold": 200.0, "ComparisonOperator": "LessThanOrEqualTo" }, "Goal": { "Interval": { "RollingInterval": { "DurationUnit": "DAY", "Duration": 7 } }, "AttainmentGoal": 99.0, "WarningThreshold": 50.0 } }, { "Arn": "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName2", "Name": "test", "EvaluationType": "PeriodBased", "BudgetStatus": "BREACHED", "Attainment": 97.39583275, "TotalBudgetSeconds": 86, "BudgetSecondsRemaining": -2154, "Sli": { "SliMetric": { "MetricDataQueries": [{ "Id": "cwMetric", "MetricStat": { "Metric": { "Namespace": "AWS/EC2", "MetricName": "CPUUtilization", "Dimensions": [{ "Name": "InstanceId", "Value": "i-0e12345678922" }] }, "Period": 300, "Stat": "Average" }, "ReturnData": true }] }, "MetricThreshold": 5.0, "ComparisonOperator": "GreaterThan" }, "Goal": { "Interval": { "RollingInterval": { "DurationUnit": "DAY", "Duration": 1 } }, "AttainmentGoal": 99.9, "WarningThreshold": 30.0 } } ], "Errors": [] } ``` Para ter mais informações, consulte [Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [BatchGetServiceLevelObjectiveBudgetReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/batch-get-service-level-objective-budget-report.html) na *Referência de comandos da AWS CLI*. ### `create-service-level-objective` O código de exemplo a seguir mostra como usar `create-service-level-objective`. **AWS CLI** **Como criar um objetivo de nível de serviço (SLO)** O exemplo de `create-service-level-objective` a seguir cria um objetivo de nível de serviço (SLO), o que pode ajudar você a garantir que as operações essenciais aos seus negócios atendam às expectativas dos clientes. ``` aws application-signals create-service-level-objective \ --name "SLOName" \ --description "Description of your SLO" \ --sli-config file://sli-config.json ``` Conteúdo de `sli-config.json`: ``` { "SliMetricConfig": { "MetricDataQueries": [ { "Id": "m1", "MetricStat": { "Metric": { "Namespace": "AWS/EC2", "MetricName": "CPUUtilization", "Dimensions": [ { "Name": "InstanceId", "Value": "i-0e5a1234561522" } ] }, "Period": 60, "Stat": "Average" }, "ReturnData": true } ] }, "MetricThreshold": 200, "ComparisonOperator": "LessThanOrEqualTo" } ``` Resultado: ``` { "Slo": { "Arn": "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName", "Name": "SLOName", "Description": "Description of your SLO", "CreatedTime": "2024-12-27T08:16:09.032000+05:30", "LastUpdatedTime": "2024-12-27T08:16:09.032000+05:30", "Sli": { "SliMetric": { "MetricDataQueries": [ { "Id": "m1", "MetricStat": { "Metric": { "Namespace": "AWS/EC2", "MetricName": "CPUUtilization", "Dimensions": [ { "Name": "InstanceId", "Value": "i-0e59876543234522" } ] }, "Period": 60, "Stat": "Average" }, "ReturnData": true } ] }, "MetricThreshold": 200.0, "ComparisonOperator": "LessThanOrEqualTo" }, "EvaluationType": "PeriodBased", "Goal": { "Interval": { "RollingInterval": { "DurationUnit": "DAY", "Duration": 7 } }, "AttainmentGoal": 99.0, "WarningThreshold": 50.0 } } } ``` Para ter mais informações, consulte [Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [CreateServiceLevelObjective](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/create-service-level-objective.html) na *Referência de comandos da AWS CLI*. ### `delete-service-level-objective` O código de exemplo a seguir mostra como usar `delete-service-level-objective`. **AWS CLI** **Como excluir o objetivo de nível de serviço especificado** O exemplo de `delete-service-level-objective` a seguir exclui o objetivo de nível de serviço especificado. ``` aws application-signals delete-service-level-objective \ --id "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName" ``` Este comando não produz saída. Para ter mais informações, consulte [Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [DeleteServiceLevelObjective](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/delete-service-level-objective.html) na *Referência de comandos da AWS CLI*. ### `get-service-level-objective` O código de exemplo a seguir mostra como usar `get-service-level-objective`. **AWS CLI** **Como exibir informações sobre um SLO criado na conta** O exemplo de `get-service-level-objective` a seguir exibe informações sobre um SLO criado na conta. ``` aws application-signals get-service-level-objective \ --id "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName" ``` Resultado: ``` { "Slo": { "Arn": "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName", "Name": "SLOName", "Description": "Description of your SLO", "CreatedTime": "2024-12-24T22:19:18.624000+05:30", "LastUpdatedTime": "2024-12-24T22:19:55.280000+05:30", "Sli": { "SliMetric": { "MetricDataQueries": [{ "Id": "m1", "MetricStat": { "Metric": { "Namespace": "AWS/EC2", "MetricName": "CPUUtilization", "Dimensions": [{ "Name": "InstanceId", "Value": "i-0e0987654321522" }] }, "Period": 60, "Stat": "Average" }, "ReturnData": true }] }, "MetricThreshold": 200.0, "ComparisonOperator": "LessThanOrEqualTo" }, "EvaluationType": "PeriodBased", "Goal": { "Interval": { "RollingInterval": { "DurationUnit": "DAY", "Duration": 7 } }, "AttainmentGoal": 99.0, "WarningThreshold": 50.0 } } } ``` Para ter mais informações, consulte [Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [GetServiceLevelObjective](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/get-service-level-objective.html) na * Referência de comandos da AWS CLI*. ### `get-service` O código de exemplo a seguir mostra como usar `get-service`. **AWS CLI** **Como exibir informações sobre um serviço descoberto pelo Application Signals** O exemplo de `get-service` a seguir exibe informações sobre um serviço descoberto pelo Application Signals. ``` aws application-signals get-service \ --start-time 1732704000 \ --end-time 1732714500 \ --key-attributes Environment=lambda:default,Name=hello-world-python,Type=Service ``` Resultado: ``` { "Service": { "KeyAttributes": { "Environment": "lambda:default", "Name": "hello-world-python", "Type": "Service" }, "AttributeMaps": [{ "Lambda.Function.Name": "hello-world-python", "PlatformType": "AWS::Lambda" }], "MetricReferences": [{ "Namespace": "ApplicationSignals", "MetricType": "LATENCY", "Dimensions": [{ "Name": "Environment", "Value": "lambda:default" }, { "Name": "Service", "Value": "hello-world-python" }], "MetricName": "Latency" }, { "Namespace": "ApplicationSignals", "MetricType": "FAULT", "Dimensions": [{ "Name": "Environment", "Value": "lambda:default" }, { "Name": "Service", "Value": "hello-world-python" }], "MetricName": "Fault" }, { "Namespace": "ApplicationSignals", "MetricType": "ERROR", "Dimensions": [{ "Name": "Environment", "Value": "lambda:default" }, { "Name": "Service", "Value": "hello-world-python" }], "MetricName": "Error" }], "LogGroupReferences": [{ "Identifier": "/aws/lambda/hello-world-python", "ResourceType": "AWS::Logs::LogGroup", "Type": "AWS::Resource" }] }, "StartTime": "2024-11-27T10:00:00+00:00", "EndTime": "2024-11-27T14:00:01+00:00", "LogGroupReferences": [{ "Identifier": "/aws/lambda/hello-world-python", "ResourceType": "AWS::Logs::LogGroup", "Type": "AWS::Resource" }] } ``` Para ter mais informações, consulte [Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [GetService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/get-service.html) na *Referência de comandos da AWS CLI*. ### `list-service-dependencies` O código de exemplo a seguir mostra como usar `list-service-dependencies`. **AWS CLI** **Como exibir uma lista de dependências do serviço especificado por você**. O exemplo de `list-service-dependencies` a seguir exibe uma lista de dependências do serviço especificado por você. ``` aws application-signals list-service-dependencies \ --start-time 1732021200 \ --end-time 1732107600 \ --key-attributes Environment=api-gateway:prod, Name=PetAdoptionStatusUpdater,Type=Service ``` Resultado: ``` { "ServiceDependencies": [{ "OperationName": "PUT /prod", "DependencyKeyAttributes": { "Environment": "lambda:default", "Name": "Services-name", "Type": "Service" }, "DependencyOperationName": "Invoke", "MetricReferences": [{ "Namespace": "ApplicationSignals", "MetricType": "LATENCY", "Dimensions": [{ "Name": "Environment", "Value": "api-gateway:prod" }, { "Name": "Operation", "Value": "PUT /prod" }, { "Name": "RemoteEnvironment", "Value": "lambda:default" }, { "Name": "RemoteOperation", "Value": "Invoke" }, { "Name": "RemoteService", "Value": "Services-name" }, { "Name": "Service", "Value": "PetAdoptionStatusUpdater" }], "MetricName": "Latency" }, { "Namespace": "ApplicationSignals", "MetricType": "FAULT", "Dimensions": [{ "Name": "Environment", "Value": "api-gateway:prod" }, { "Name": "Operation", "Value": "PUT /prod" }, { "Name": "RemoteEnvironment", "Value": "lambda:default" }, { "Name": "RemoteOperation", "Value": "Invoke" }, { "Name": "RemoteService", "Value": "Services-name" }, { "Name": "Service", "Value": "PetAdoptionStatusUpdater" }], "MetricName": "Fault" }, { "Namespace": "ApplicationSignals", "MetricType": "ERROR", "Dimensions": [{ "Name": "Environment", "Value": "api-gateway:prod" }, { "Name": "Operation", "Value": "PUT /prod" }, { "Name": "RemoteEnvironment", "Value": "lambda:default" }, { "Name": "RemoteOperation", "Value": "Invoke" }, { "Name": "RemoteService", "Value": "Services-name" }, { "Name": "Service", "Value": "PetAdoptionStatusUpdater" }], "MetricName": "Error" }] }], "StartTime": "2024-11-19T13:00:00+00:00", "EndTime": "2024-11-20T13:00:01+00:00" } ``` Para ter mais informações, consulte [Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [ListServiceDependencies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/list-service-dependencies.html) na *Referência de comandos da AWS CLI*. ### `list-service-dependents` O código de exemplo a seguir mostra como usar `list-service-dependents`. **AWS CLI** **Como exibir a lista de dependentes que invocaram o serviço especificado durante o intervalo de tempo fornecido** O exemplo de `list-service-dependents` a seguir exibe a lista de dependentes que invocaram o serviço especificado durante o intervalo de tempo fornecido. ``` aws application-signals list-service-dependents \ --start-time 1732021200 \ --end-time 1732107600 \ --key-attributes Environment=generic:default,Name=PetSite,Type=Service ``` Resultado: ``` { "ServiceDependents": [{ "OperationName": "", "DependentKeyAttributes": { "Identifier": "pet-api-canary-hao", "ResourceType": "AWS::Synthetics::Canary", "Type": "AWS::Resource" }, "DependentOperationName": "", "MetricReferences": [] }, { "OperationName": "", "DependentKeyAttributes": { "Identifier": "PetSite", "ResourceType": "AWS::Synthetics::Canary", "Type": "AWS::Resource" }, "DependentOperationName": "", "MetricReferences": [] }], "StartTime": "2024-12-24T05:00:00+00:00", "EndTime": "2024-12-25T06:00:01+00:00" } ``` Para ter mais informações, consulte [Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [ListServiceDependents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/list-service-dependents.html) na *Referência de comandos da AWS CLI*. ### `list-service-level-objectives` O código de exemplo a seguir mostra como usar `list-service-level-objectives`. **AWS CLI** **Como exibir uma lista de SLOs criados nessa conta** O exemplo de `list-service-level-objectives` a seguir exibe uma lista de SLOs criados nessa conta. ``` aws application-signals list-service-level-objectives ``` Resultado: ``` { "SloSummaries": [{ "Arn": "arn:aws:application-signals:us-east-1:123456789101:slo/test", "Name": "test", "CreatedTime": "2024-12-24T22:01:21.116000+05:30" }] } ``` Para ter mais informações, consulte [Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [ListServiceLevelObjectives](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/list-service-level-objectives.html) na *Referência de comandos da AWS CLI*. ### `list-service-operations` O código de exemplo a seguir mostra como usar `list-service-operations`. **AWS CLI** **Como exibir uma lista das operações desse serviço que foram descobertas pelo Application Signals** O exemplo de `list-service-operations` a seguir exibe uma lista das operações desse serviço que foram descobertas pelo Application Signals. ``` aws application-signals list-service-operations \ --start-time 1735017423 \ --end-time 1735103823 \ --key-attributes Environment=generic:default,Name=payforadoption,Type=Service ``` Resultado: ``` { "ServiceOperations": [{ "Name": "POST /api", "MetricReferences": [{ "Namespace": "ApplicationSignals", "MetricType": "LATENCY", "Dimensions": [{ "Name": "Environment", "Value": "generic:default" }, { "Name": "Operation", "Value": "POST /api" }, { "Name": "Service", "Value": "payforadoption" }], "MetricName": "Latency" }, { "Namespace": "ApplicationSignals", "MetricType": "FAULT", "Dimensions": [{ "Name": "Environment", "Value": "generic:default" }, { "Name": "Operation", "Value": "POST /api" }, { "Name": "Service", "Value": "payforadoption" }], "MetricName": "Fault" }, { "Namespace": "ApplicationSignals", "MetricType": "ERROR", "Dimensions": [{ "Name": "Environment", "Value": "generic:default" }, { "Name": "Operation", "Value": "POST /api" }, { "Name": "Service", "Value": "payforadoption" }], "MetricName": "Error" }] }], "StartTime": "2024-12-24T05:00:00+00:00", "EndTime": "2024-12-25T06:00:01+00:00" } ``` Para ter mais informações, consulte [Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [ListServiceOperations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/list-service-operations.html) na *Referência de comandos da AWS CLI*. ### `list-services` O código de exemplo a seguir mostra como usar `list-services`. **AWS CLI** **Como exibir uma lista dos serviços que foram descobertos pelo Application Signals** O exemplo de `list-services` a seguir exibe uma lista de serviços que foram descobertos pelo Application Signals. ``` aws application-signals list-services \ --start-time 1734918791 \ --end-time 1734965591 ``` Resultado: ``` { "ServiceSummaries": [{ "KeyAttributes": { "Environment": "lambda:default", "Name": "hello-world-python", "Type": "Service" }, "AttributeMaps": [{ "Lambda.Function.Name": "hello-world-python", "PlatformType": "AWS::Lambda" }], "MetricReferences": [{ "Namespace": "ApplicationSignals", "MetricType": "LATENCY", "Dimensions": [{ "Name": "Environment", "Value": "lambda:default" }, { "Name": "Service", "Value": "hello-world-python" }], "MetricName": "Latency" }, { "Namespace": "ApplicationSignals", "MetricType": "FAULT", "Dimensions": [{ "Name": "Environment", "Value": "lambda:default" }, { "Name": "Service", "Value": "hello-world-python" }], "MetricName": "Fault" }, { "Namespace": "ApplicationSignals", "MetricType": "ERROR", "Dimensions": [{ "Name": "Environment", "Value": "lambda:default" }, { "Name": "Service", "Value": "hello-world-python" }], "MetricName": "Error" }] }], "StartTime": "2024-11-27T10:00:00+00:00", "EndTime": "2024-11-27T14:00:01+00:00" } ``` Para ter mais informações, consulte [Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [ListServices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/list-services.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Como exibir as tags associadas a um recurso do CloudWatch** O exemplo de `list-tags-for-resource` a seguir exibe as tags associadas a um recurso do CloudWatch. ``` aws application-signals list-tags-for-resource \ --resource-arn "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName" ``` Resultado: ``` { "Tags": [{ "Key": "test", "Value": "value" }] } ``` Para ter mais informações, consulte [Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html) no *Guia do usuário do Amazon CloudWatch*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `start-discovery` O código de exemplo a seguir mostra como usar `start-discovery`. **AWS CLI** **Como permitir que essa conta da Amazon Web Services use o CloudWatch Application Signals** O exemplo de `start-discovery` a seguir permite que essa conta da Amazon Web Services use o CloudWatch Application Signals criando o perfil vinculado ao serviço *AWSServiceRoleForCloudWatchApplicationSignals*. ``` aws application-signals start-discovery ``` Este comando não produz saída. Para ter mais informações, consulte [Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [StartDiscovery](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/start-discovery.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como atribuir uma ou mais tags (pares de chave-valor) ao recurso do CloudWatch especificado, como um objetivo de nível de serviço** O exemplo de `tag-resource` a seguir atribui uma ou mais tags (pares de chave-valor) ao recurso do CloudWatch especificado, como um objetivo de nível de serviço. ``` aws application-signals tag-resource \ --resource-arn "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName" \ --tags '{"Key":"test","Value":"value"}' ``` Este comando não produz saída. Para ter mais informações, consulte [Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Como remover uma ou mais tags do recurso especificado** O exemplo de `untag-resource` a seguir remove uma ou mais tags do recurso especificado. ``` aws application-signals untag-resource \ --resource-arn "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName" \ --tag-keys "test" ``` Este comando não produz saída. Para ter mais informações, consulte [Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html) no *Guia do usuário do Amazon CloudWatch*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-service-level-objective` O código de exemplo a seguir mostra como usar `update-service-level-objective`. **AWS CLI** **Como atualizar um objetivo de nível de serviço (SLO) existente** O exemplo de `update-service-level-objective` a seguir atualiza um objetivo de nível de serviço (SLO) existente. ``` aws application-signals update-service-level-objective \ --cli-input-json file://update-slo.json ``` Conteúdo de `update-slo.json`: ``` { "id": "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName", "goal": { "Interval": { "RollingInterval": { "DurationUnit": "DAY", "Duration": 7 } }, "AttainmentGoal": 90.0, "WarningThreshold": 50.0 } } ``` Resultado: ``` { "Slo": { "Arn": "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName", "Name": "SLOName", "Description": "Description of your SLO", "CreatedTime": "2024-12-24T22:19:18.624000+05:30", "LastUpdatedTime": "2024-12-27T08:51:38.278000+05:30", "Sli": { "SliMetric": { "MetricDataQueries": [{ "Id": "m1", "MetricStat": { "Metric": { "Namespace": "AWS/EC2", "MetricName": "CPUUtilization", "Dimensions": [{ "Name": "InstanceId", "Value": "i-00987654345222" }] }, "Period": 60, "Stat": "Average" }, "ReturnData": true }] }, "MetricThreshold": 200.0, "ComparisonOperator": "LessThanOrEqualTo" }, "EvaluationType": "PeriodBased", "Goal": { "Interval": { "RollingInterval": { "DurationUnit": "DAY", "Duration": 7 } }, "AttainmentGoal": 90.0, "WarningThreshold": 50.0 } } } ``` Para ter mais informações, consulte [Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [UpdateServiceLevelObjective](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/update-service-level-objective.html) na *Referência de comandos da AWS CLI*. # Exemplos do AppRegistry usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o AppRegistry. *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 ### `associate-attribute-group` O código de exemplo a seguir mostra como usar `associate-attribute-group`. **AWS CLI** **Para associar um grupo de atributos** O exemplo `associate-attribute-group` a seguir associa um grupo de atributos específico em sua conta da AWS a uma aplicação específica em sua conta da AWS. ``` aws servicecatalog-appregistry associate-attribute-group \ --application "ExampleApplication" \ --attribute-group "ExampleAttributeGroup" ``` Resultado: ``` { "applicationArn": "arn:aws:servicecatalog:us-west-2:813737243517:/applications/0ars38r6btoohvpvd9gqrptt9l", "attributeGroupArn": "arn:aws:servicecatalog:us-west-2:813737243517:/attribute-groups/01sj5xdwhbw54kejwnt09fnpcl" } ``` Para obter mais informações, consulte [Associar e desassociar grupos de atributos](https://docs.aws.amazon.com/servicecatalog/latest/arguide/associate-attr-groups.html) no *Guia do administrador do AWS Service Catalog AppRegistry*. + Para ver detalhes da API, consulte [AssociateAttributeGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/associate-attribute-group.html) na *Referência de comandos da AWS CLI*. ### `create-application` O código de exemplo a seguir mostra como usar `create-application`. **AWS CLI** **Para criar uma aplicação** O exemplo `create-application` a seguir cria uma nova aplicação em sua conta da AWS. ``` aws servicecatalog-appregistry create-application \ --name "ExampleApplication" ``` Resultado: ``` { "application": { "id": "0ars38r6btoohvpvd9gqrptt9l", "arn": "arn:aws:servicecatalog:us-west-2:813737243517:/applications/0ars38r6btoohvpvd9gqrptt9l", "name": "ExampleApplication", "creationTime": "2023-02-28T21:10:10.820000+00:00", "lastUpdateTime": "2023-02-28T21:10:10.820000+00:00", "tags": {} } } ``` Para obter mais informações, consulte [Criar aplicações](https://docs.aws.amazon.com/servicecatalog/latest/arguide/create-apps.html) no *Guia do administrador do AWS Service Catalog AppRegistry*. + Para ver detalhes da API, consulte [CreateApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/create-application.html) na *Referência de comandos da AWS CLI*. ### `create-attribute-group` O código de exemplo a seguir mostra como usar `create-attribute-group`. **AWS CLI** **Para criar um grupo de atributos** O exemplo `create-attribute-group` a seguir cria um novo grupo de atributos em sua conta da AWS. ``` aws servicecatalog-appregistry create-attribute-group \ --name "ExampleAttributeGroup" \ --attributes '{"SomeKey1":"SomeValue1","SomeKey2":"SomeValue2"}' ``` Resultado: ``` { "attributeGroup": { "id": "01sj5xdwhbw54kejwnt09fnpcl", "arn": "arn:aws:servicecatalog:us-west-2:813737243517:/attribute-groups/01sj5xdwhbw54kejwnt09fnpcl", "name": "ExampleAttributeGroup", "creationTime": "2023-02-28T20:38:01.389000+00:00", "lastUpdateTime": "2023-02-28T20:38:01.389000+00:00", "tags": {} } } ``` Para obter mais informações, consulte [Criar grupos de atributos](https://docs.aws.amazon.com/servicecatalog/latest/arguide/create-attr-groups.html) no *Guia do administrador do AWS Service Catalog AppRegistry*. + Para ver detalhes da API, consulte [CreateAttributeGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/create-attribute-group.html) na *Referência de comandos da AWS CLI*. ### `delete-application` O código de exemplo a seguir mostra como usar `delete-application`. **AWS CLI** **Como excluir uma aplicação do** O exemplo `delete-application` a seguir exclui uma aplicação específico da sua conta da AWS. ``` aws servicecatalog-appregistry delete-application \ --application "ExampleApplication3" ``` Resultado: ``` { "application": { "id": "055gw7aynr1i5mbv7kjwzx5945", "arn": "arn:aws:servicecatalog:us-west-2:813737243517:/applications/055gw7aynr1i5mbv7kjwzx5945", "name": "ExampleApplication3", "creationTime": "2023-02-28T22:06:28.228000+00:00", "lastUpdateTime": "2023-02-28T22:06:28.228000+00:00" } } ``` Para obter mais informações, consulte [Excluir aplicações](https://docs.aws.amazon.com/servicecatalog/latest/arguide/delete-app-details.html) no *Guia do administrador do AWS Service Catalog AppRegistry*. + Para ver detalhes da API, consulte [DeleteApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/delete-application.html) na *Referência de comandos da AWS CLI*. ### `delete-attribute-group` O código de exemplo a seguir mostra como usar `delete-attribute-group`. **AWS CLI** **Exemplo 8: excluir um grupo de atributos** O exemplo `delete-attribute-group` a seguir exclui um grupo de atributos específico em sua conta da AWS. ``` aws servicecatalog-appregistry delete-attribute-group \ --attribute-group "ExampleAttributeGroup3" ``` Resultado: ``` { "attributeGroup": { "id": "011ge6y3emyjijt8dw8jn6r0hv", "arn": "arn:aws:servicecatalog:us-west-2:813737243517:/attribute-groups/011ge6y3emyjijt8dw8jn6r0hv", "name": "ExampleAttributeGroup3", "creationTime": "2023-02-28T22:05:35.224000+00:00", "lastUpdateTime": "2023-02-28T22:05:35.224000+00:00" } } ``` Para obter mais informações, consulte [Excluir grupos de atributos](https://docs.aws.amazon.com/servicecatalog/latest/arguide/delete-attr-group.html) no *Guia do administrador do AWS Service Catalog AppRegistry*. + Para ver detalhes da API, consulte [DeleteAttributeGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/delete-attribute-group.html) na *Referência de comandos da AWS CLI*. ### `get-application` O código de exemplo a seguir mostra como usar `get-application`. **AWS CLI** **Para obter uma aplicação** O exemplo `get-application` a seguir recupera informações de metadados sobre uma aplicação específica em sua conta da AWS. ``` aws servicecatalog-appregistry get-application \ --application "ExampleApplication" ``` Resultado: ``` { "id": "0ars38r6btoohvpvd9gqrptt9l", "arn": "arn:aws:servicecatalog:us-west-2:813737243517:/applications/0ars38r6btoohvpvd9gqrptt9l", "name": "ExampleApplication", "creationTime": "2023-02-28T21:10:10.820000+00:00", "lastUpdateTime": "2023-02-28T21:10:10.820000+00:00", "associatedResourceCount": 0, "tags": { "aws:servicecatalog:applicationName": "ExampleApplication" }, "integrations": { "resourceGroup": { "state": "CREATE_COMPLETE", "arn": "arn:aws:resource-groups:us-west-2:813737243517:group/AWS_AppRegistry_Application-ExampleApplication" } } } ``` Para obter mais informações, consulte [Usar detalhes de aplicações](https://docs.aws.amazon.com/servicecatalog/latest/arguide/access-app-details.html) no *Guia do administrador do AWS Service Catalog AppRegistry*. + Para ver detalhes da API, consulte [GetApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/get-application.html) na *Referência de comandos da AWS CLI*. ### `get-attribute-group` O código de exemplo a seguir mostra como usar `get-attribute-group`. **AWS CLI** **Para obter um grupo de atributos** O exemplo `get-attribute-group` a seguir recupera um grupo de atributos específico em sua conta da AWS. ``` aws servicecatalog-appregistry get-attribute-group \ --attribute-group "ExampleAttributeGroup" ``` Resultado: ``` { "id": "01sj5xdwhbw54kejwnt09fnpcl", "arn": "arn:aws:servicecatalog:us-west-2:813737243517:/attribute-groups/01sj5xdwhbw54kejwnt09fnpcl", "name": "ExampleAttributeGroup", "attributes": "{\"SomeKey1\":\"SomeValue1\",\"SomeKey2\":\"SomeValue2\"}", "creationTime": "2023-02-28T20:38:01.389000+00:00", "lastUpdateTime": "2023-02-28T20:38:01.389000+00:00", "tags": { "aws:servicecatalog:attributeGroupName": "ExampleAttributeGroup" } } ``` Para obter mais informações, consulte [Gerenciar metadados em grupos de atributos](https://docs.aws.amazon.com/servicecatalog/latest/arguide/manage-metatdata.html) no *Guia do administrador do AWS Service Catalog AppRegistry*. + Para ver detalhes da API, consulte [GetAttributeGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/get-attribute-group.html) na *Referência de comandos da AWS CLI*. ### `list-applications` O código de exemplo a seguir mostra como usar `list-applications`. **AWS CLI** **Para listar aplicações** O exemplo `list-applications` a seguir recupera uma lista de todos as aplicações em sua conta da AWS. ``` aws servicecatalog-appregistry list-applications ``` Resultado: ``` { "applications": [ { "id": "03axw94pjfj3uan00tcgbrxnkw", "arn": "arn:aws:servicecatalog:us-west-2:813737243517:/applications/03axw94pjfj3uan00tcgbrxnkw", "name": "ExampleApplication2", "creationTime": "2023-02-28T21:59:34.094000+00:00", "lastUpdateTime": "2023-02-28T21:59:34.094000+00:00" }, { "id": "055gw7aynr1i5mbv7kjwzx5945", "arn": "arn:aws:servicecatalog:us-west-2:813737243517:/applications/055gw7aynr1i5mbv7kjwzx5945", "name": "ExampleApplication3", "creationTime": "2023-02-28T22:06:28.228000+00:00", "lastUpdateTime": "2023-02-28T22:06:28.228000+00:00" }, { "id": "0ars38r6btoohvpvd9gqrptt9l", "arn": "arn:aws:servicecatalog:us-west-2:813737243517:/applications/0ars38r6btoohvpvd9gqrptt9l", "name": "ExampleApplication", "description": "This is an example application", "creationTime": "2023-02-28T21:10:10.820000+00:00", "lastUpdateTime": "2023-02-28T21:24:19.729000+00:00" } ] } ``` Para obter mais informações, consulte [Visualizar detalhes de aplicações](https://docs.aws.amazon.com/servicecatalog/latest/arguide/view-app-details.html) no *Guia do administrador do AWS Service Catalog AppRegistry*. + Para ver detalhes da API, consulte [ListApplications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/list-applications.html) na *Referência de comandos da AWS CLI*. ### `list-associated-attribute-groups` O código de exemplo a seguir mostra como usar `list-associated-attribute-groups`. **AWS CLI** **Para listar grupos de atributos associados** O exemplo `list-associated-attribute-groups` a seguir recupera uma lista de todos os grupos de atributos em sua conta da AWS que estão associados a uma aplicação específica em sua conta da AWS. ``` aws servicecatalog-appregistry list-associated-attribute-groups \ --application "ExampleApplication" ``` Resultado: ``` { "attributeGroups": [ "01sj5xdwhbw54kejwnt09fnpcl" ] } ``` Para obter mais informações, consulte [Associar e desassociar grupos de atributos](https://https://docs.aws.amazon.com/servicecatalog/latest/arguide/associate-attr-groups.html) no *Guia do administrador do AWS Service Catalog AppRegistry*. + Para ver detalhes da API, consulte [ListAssociatedAttributeGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/list-associated-attribute-groups.html) na *Referência de comandos da AWS CLI*. ### `list-attribute-groups-for-application` O código de exemplo a seguir mostra como usar `list-attribute-groups-for-application`. **AWS CLI** **Para listar grupos de atributos para uma aplicação** O exemplo `list-attribute-groups-for-application` a seguir lista os detalhes de todos os grupos de atributos em sua conta da AWS que estão associados a uma aplicação específica em sua conta da AWS. ``` aws servicecatalog-appregistry list-attribute-groups-for-application \ --application "ExampleApplication" ``` Resultado: ``` { "attributeGroupsDetails": [ { "id": "01sj5xdwhbw54kejwnt09fnpcl", "arn": "arn:aws:servicecatalog:us-west-2:813737243517:/attribute-groups/01sj5xdwhbw54kejwnt09fnpcl", "name": "ExampleAttributeGroup" } ] } ``` Para obter mais informações, consulte [Visualizar detalhes do grupo de atributos](https://servicecatalog/latest/arguide/view-attr-group.html) no *Guia do administrador do AWS Service Catalog AppRegistry*. + Para ver detalhes da API, consulte [ListAttributeGroupsForApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/list-attribute-groups-for-application.html) na *Referência de comandos da AWS CLI*. ### `list-attribute-groups` O código de exemplo a seguir mostra como usar `list-attribute-groups`. **AWS CLI** **Para listar grupos de atributos** O exemplo `list-attribute-groups` a seguir recupera uma lista de todos os grupos de atributos em sua conta da AWS. ``` aws servicecatalog-appregistry list-attribute-groups ``` Resultado: ``` { "attributeGroups": [ { "id": "011ge6y3emyjijt8dw8jn6r0hv", "arn": "arn:aws:servicecatalog:us-west-2:813737243517:/attribute-groups/011ge6y3emyjijt8dw8jn6r0hv", "name": "ExampleAttributeGroup3", "creationTime": "2023-02-28T22:05:35.224000+00:00", "lastUpdateTime": "2023-02-28T22:05:35.224000+00:00" }, { "id": "01sj5xdwhbw54kejwnt09fnpcl", "arn": "arn:aws:servicecatalog:us-west-2:813737243517:/attribute-groups/01sj5xdwhbw54kejwnt09fnpcl", "name": "ExampleAttributeGroup", "description": "This is an example attribute group", "creationTime": "2023-02-28T20:38:01.389000+00:00", "lastUpdateTime": "2023-02-28T21:02:04.559000+00:00" }, { "id": "03n1yffgq6d18vwrzxf0c70nm3", "arn": "arn:aws:servicecatalog:us-west-2:813737243517:/attribute-groups/03n1yffgq6d18vwrzxf0c70nm3", "name": "ExampleAttributeGroup2", "creationTime": "2023-02-28T21:57:30.687000+00:00", "lastUpdateTime": "2023-02-28T21:57:30.687000+00:00" } ] } ``` Para obter mais informações, consulte [Visualizar detalhes do grupo de atributos](https://docs.aws.amazon.com/servicecatalog/latest/arguide/view-attr-group.html) no *Guia do administrador do AWS Service Catalog AppRegistry*. + Para ver detalhes da API, consulte [ListAttributeGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/list-attribute-groups.html) na *Referência de comandos da AWS CLI*. ### `update-application` O código de exemplo a seguir mostra como usar `update-application`. **AWS CLI** **Para atualizar uma aplicação** O exemplo `update-application` a seguir atualiza uma aplicação específica em sua conta da AWS para incluir uma descrição. ``` aws servicecatalog-appregistry update-application \ --application "ExampleApplication" \ --description "This is an example application" ``` Resultado: ``` { "application": { "id": "0ars38r6btoohvpvd9gqrptt9l", "arn": "arn:aws:servicecatalog:us-west-2:813737243517:/applications/0ars38r6btoohvpvd9gqrptt9l", "name": "ExampleApplication", "description": "This is an example application", "creationTime": "2023-02-28T21:10:10.820000+00:00", "lastUpdateTime": "2023-02-28T21:24:19.729000+00:00", "tags": { "aws:servicecatalog:applicationName": "ExampleApplication" } } } ``` Para obter mais informações, consulte [Editar aplicações](https://docs.aws.amazon.com/servicecatalog/latest/arguide/edit-apps.html) no *Guia do administrador do AWS Service Catalog AppRegistry*. + Para ver detalhes da API, consulte [UpdateApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/update-application.html) na *Referência de comandos da AWS CLI*. ### `update-attribute-group` O código de exemplo a seguir mostra como usar `update-attribute-group`. **AWS CLI** **Para atualizar um grupo de atributos** O exemplo `update-attribute-group` a seguir atualiza um grupo de atributos específico em sua conta da AWS para incluir uma descrição. ``` aws servicecatalog-appregistry update-attribute-group \ --attribute-group "ExampleAttributeGroup" \ --description "This is an example attribute group" ``` Resultado: ``` { "attributeGroup": { "id": "01sj5xdwhbw54kejwnt09fnpcl", "arn": "arn:aws:servicecatalog:us-west-2:813737243517:/attribute-groups/01sj5xdwhbw54kejwnt09fnpcl", "name": "ExampleAttributeGroup", "description": "This is an example attribute group", "creationTime": "2023-02-28T20:38:01.389000+00:00", "lastUpdateTime": "2023-02-28T21:02:04.559000+00:00", "tags": { "aws:servicecatalog:attributeGroupName": "ExampleAttributeGroup" } } } ``` Para obter mais informações, consulte [Editar grupos de atributos](https://docs.aws.amazon.com/servicecatalog/latest/arguide/edit-attr-group.html) no *Guia do administrador do AWS Service Catalog AppRegistry*. + Para ver detalhes da API, consulte [UpdateAttributeGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/update-attribute-group.html) na *Referência de comandos da AWS CLI*. # Exemplos do Athena usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o Athena. *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 ### `batch-get-named-query` O código de exemplo a seguir mostra como usar `batch-get-named-query`. **AWS CLI** **Como retornar informações sobre mais de uma consulta** O exemplo `batch-get-named-query` a seguir retorna informações sobre as consultas nomeadas que têm os IDs especificados. ``` aws athena batch-get-named-query \ --named-query-ids a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 a1b2c3d4-5678-90ab-cdef-EXAMPLE33333 ``` Resultado: ``` { "NamedQueries": [ { "Name": "Flights Select Query", "Description": "Sample query to get the top 10 airports with the most number of departures since 2000", "Database": "sampledb", "QueryString": "SELECT origin, count(*) AS total_departures\nFROM\nflights_parquet\nWHERE year >= '2000'\nGROUP BY origin\nORDER BY total_departures DESC\nLIMIT 10;", "NamedQueryId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "WorkGroup": "primary" }, { "Name": "Load flights table partitions", "Description": "Sample query to load flights table partitions using MSCK REPAIR TABLE statement", "Database": "sampledb", "QueryString": "MSCK REPAIR TABLE flights_parquet;", "NamedQueryId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "WorkGroup": "primary" }, { "Name": "CloudFront Select Query", "Description": "Sample query to view requests per operating system during a particular time frame", "Database": "sampledb", "QueryString": "SELECT os, COUNT(*) count FROM cloudfront_logs WHERE date BETWEEN date '2014-07-05' AND date '2014-08-05' GROUP BY os;", "NamedQueryId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "WorkGroup": "primary" } ], "UnprocessedNamedQueryIds": [] } ``` Para obter mais informações, consulte [Executar consultas SQL usando o Amazon Athena](https://docs.aws.amazon.com/athena/latest/ug/querying-athena-tables.html) no *Manual do usuário do Amazon Athena*. + Para ver detalhes da API, consulte [BatchGetNamedQuery](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/batch-get-named-query.html) na *Referência de comandos da AWS CLI*. ### `batch-get-query-execution` O código de exemplo a seguir mostra como usar `batch-get-query-execution`. **AWS CLI** **Como retornar informações sobre uma ou mais execuções de consulta** O exemplo `batch-get-query-execution` a seguir retorna informações de execução da consulta para as consultas que têm os IDs de consulta especificados. ``` aws athena batch-get-query-execution \ --query-execution-ids a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 ``` Resultado: ``` { "QueryExecutions": [ { "QueryExecutionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "Query": "create database if not exists webdata", "StatementType": "DDL", "ResultConfiguration": { "OutputLocation": "s3://amzn-s3-demo-bucket/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.txt" }, "QueryExecutionContext": {}, "Status": { "State": "SUCCEEDED", "SubmissionDateTime": 1593470720.592, "CompletionDateTime": 1593470720.902 }, "Statistics": { "EngineExecutionTimeInMillis": 232, "DataScannedInBytes": 0, "TotalExecutionTimeInMillis": 310, "ResultConfiguration": { "QueryQueueTimeInMillis": 50, "ServiceProcessingTimeInMillis": 28 }, "WorkGroup": "AthenaAdmin" }, { "QueryExecutionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "Query": "select date, location, browser, uri, status from cloudfront_logs where method = 'GET' and status = 200 and location like 'SFO%' limit 10", "StatementType": "DML", "ResultConfiguration": { "OutputLocation": "s3://amzn-s3-demo-bucket/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.csv" }, "QueryExecutionContext": { "Database": "mydatabase", "Catalog": "awsdatacatalog" }, "Status": { "State": "SUCCEEDED", "SubmissionDateTime": 1593469842.665, "CompletionDateTime": 1593469846.486 }, "Statistics": { "EngineExecutionTimeInMillis": 3600, "DataScannedInBytes": 203089, "TotalExecutionTimeInMillis": 3821, "QueryQueueTimeInMillis": 267, "QueryPlanningTimeInMillis": 1175 }, "WorkGroup": "AthenaAdmin" } ], "UnprocessedQueryExecutionIds": [] } ``` Para obter mais informações, consulte [Executar consultas SQL usando o Amazon Athena](https://docs.aws.amazon.com/athena/latest/ug/querying-athena-tables.html) no *Manual do usuário do Amazon Athena*. + Para ver detalhes da API, consulte [BatchGetQueryExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/batch-get-query-execution.html) na *Referência de comandos da AWS CLI*. ### `create-data-catalog` O código de exemplo a seguir mostra como usar `create-data-catalog`. **AWS CLI** **Para criar um catálogo de dados** O exemplo `create-data-catalog` a seguir cria o catálogo de dados `dynamo_db_catalog`. ``` aws athena create-data-catalog \ --name dynamo_db_catalog \ --type LAMBDA \ --description "DynamoDB Catalog" \ --parameters function=arn:aws:lambda:us-west-2:111122223333:function:dynamo_db_lambda ``` Este comando não produz saída. Para ver o resultado, use `aws athena get-data-catalog --name dynamo_db_catalog`. Para obter mais informações, consulte [Registrar um catálogo: create-data-catalog](https://docs.aws.amazon.com/athena/latest/ug/datastores-hive-cli.html#datastores-hive-cli-registering-a-catalog) no *Guia do usuário do Amazon Athena*. + Para ver detalhes da API, consulte [CreateDataCatalog](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/create-data-catalog.html) na *Referência de comandos da AWS CLI*. ### `create-named-query` O código de exemplo a seguir mostra como usar `create-named-query`. **AWS CLI** **Para criar uma consulta nomeada** O exemplo `create-named-query` a seguir cria uma consulta salva no grupo de trabalho `AthenaAdmin` que consulta a tabela `flights_parquet` de voos de Seattle para Nova York em janeiro de 2016, cuja partida e chegada tiveram mais de dez minutos de atraso. Como os valores do código do aeroporto na tabela são cadeias de caracteres que incluem aspas duplas (por exemplo, “SEA”), eles são recuados por barras invertidas e cercados por aspas simples. ``` aws athena create-named-query \ --name "SEA to JFK delayed flights Jan 2016" \ --description "Both arrival and departure delayed more than 10 minutes." \ --database sampledb \ --query-string "SELECT flightdate, carrier, flightnum, origin, dest, depdelayminutes, arrdelayminutes FROM sampledb.flights_parquet WHERE yr = 2016 AND month = 1 AND origin = '\"SEA\"' AND dest = '\"JFK\"' AND depdelayminutes > 10 AND arrdelayminutes > 10" \ --work-group AthenaAdmin ``` Resultado: ``` { "NamedQueryId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } ``` Para obter mais informações, consulte [Executar consultas SQL usando o Amazon Athena](https://docs.aws.amazon.com/athena/latest/ug/querying-athena-tables.html) no *Manual do usuário do Amazon Athena*. + Para ver detalhes da API, consulte [CreateNamedQuery](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/create-named-query.html) na *Referência de comandos da AWS CLI*. ### `create-work-group` O código de exemplo a seguir mostra como usar `create-work-group`. **AWS CLI** **Para criar um grupo de trabalho** O exemplo `create-work-group` a seguir cria um grupo de trabalho chamado `Data_Analyst_Group` que tem o local de saída dos resultados da consulta `s3://amzn-s3-demo-bucket`. O comando cria um grupo de trabalho que substitui as configurações do cliente, o que inclui o local de saída dos resultados da consulta. O comando também ativa as métricas do CloudWatch e adiciona três pares de tags de valores-chave ao grupo de trabalho para diferenciá-lo de outros grupos de trabalho. Observe que o argumento `--configuration` não tem espaços antes das vírgulas que separam suas opções. ``` aws athena create-work-group \ --name Data_Analyst_Group \ --configuration ResultConfiguration={OutputLocation="s3://amzn-s3-demo-bucket"},EnforceWorkGroupConfiguration="true",PublishCloudWatchMetricsEnabled="true" \ --description "Workgroup for data analysts" \ --tags Key=Division,Value=West Key=Location,Value=Seattle Key=Team,Value="Big Data" ``` Este comando não produz saída. Para ver os resultados, use `aws athena get-work-group --work-group Data_Analyst_Group`. Para obter mais informações, consulte [Gerenciar grupos de trabalho](https://docs.aws.amazon.com/athena/latest/ug/workgroups-create-update-delete.html) no *Guia do usuário do Amazon Athena*. + Para ver detalhes da API, consulte [CreateWorkGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/create-work-group.html) na *Referência de comandos da AWS CLI*. ### `delete-data-catalog` O código de exemplo a seguir mostra como usar `delete-data-catalog`. **AWS CLI** **Para excluir um catálogo de dados** O exemplo `delete-data-catalog` a seguir exclui o catálogo de dados `UnusedDataCatalog`. ``` aws athena delete-data-catalog \ --name UnusedDataCatalog ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir um catálogo: delete-data-catalog](https://docs.aws.amazon.com/athena/latest/ug/datastores-hive-cli.html#datastores-hive-cli-deleting-a-catalog) no *Guia do usuário do Amazon Athena*. + Para ver detalhes da API, consulte [DeleteDataCatalog](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/delete-data-catalog.html) na *Referência de comandos da AWS CLI*. ### `delete-named-query` O código de exemplo a seguir mostra como usar `delete-named-query`. **AWS CLI** **Para excluir uma consulta nomeada** O exemplo `delete-named-query` a seguir exclui a consulta nomeada que tem o ID especificado. ``` aws athena delete-named-query \ --named-query-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Este comando não produz saída. Para obter mais informações, consulte [Executar consultas SQL usando o Amazon Athena](https://docs.aws.amazon.com/athena/latest/ug/querying-athena-tables.html) no *Manual do usuário do Amazon Athena*. + Para ver detalhes da API, consulte [DeleteNamedQuery](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/delete-named-query.html) na *Referência de comandos da AWS CLI*. ### `delete-work-group` O código de exemplo a seguir mostra como usar `delete-work-group`. **AWS CLI** **Para excluir um grupo de trabalho** O exemplo `delete-work-group` a seguir exclui o grupo de trabalho `TeamB`. ``` aws athena delete-work-group \ --work-group TeamB ``` Este comando não produz saída. Para confirmar a exclusão, use `aws athena list-work-groups`. Para obter mais informações, consulte [Gerenciar grupos de trabalho](https://docs.aws.amazon.com/athena/latest/ug/workgroups-create-update-delete.html) no *Guia do usuário do Amazon Athena*. + Para ver detalhes da API, consulte [DeleteWorkGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/delete-work-group.html) na *Referência de comandos da AWS CLI*. ### `get-data-catalog` O código de exemplo a seguir mostra como usar `get-data-catalog`. **AWS CLI** **Como retornar informações sobre um catálogo de dados** O exemplo `get-data-catalog` a seguir retorna informações sobre o catálogo de dados `dynamo_db_catalog`. ``` aws athena get-data-catalog \ --name dynamo_db_catalog ``` Resultado: ``` { "DataCatalog": { "Name": "dynamo_db_catalog", "Description": "DynamoDB Catalog", "Type": "LAMBDA", "Parameters": { "catalog": "dynamo_db_catalog", "metadata-function": "arn:aws:lambda:us-west-2:111122223333:function:dynamo_db_lambda", "record-function": "arn:aws:lambda:us-west-2:111122223333:function:dynamo_db_lambda" } } } ``` Para obter mais informações, consulte [Exibir detalhes do catálogo: get-data-catalog](https://docs.aws.amazon.com/athena/latest/ug/datastores-hive-cli.html#datastores-hive-cli-showing-details-of-a-catalog) no *Guia do usuário do Amazon Athena*. + Para ver detalhes da API, consulte [GetDataCatalog](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/get-data-catalog.html) na *Referência de comandos da AWS CLI*. ### `get-database` O código de exemplo a seguir mostra como usar `get-database`. **AWS CLI** **Como retornar informações sobre um banco de dados em um catálogo de dados** O exemplo `get-database` a seguir retorna informações sobre o banco de dados `sampledb` no catálogo de dados `AwsDataCatalog`. ``` aws athena get-database \ --catalog-name AwsDataCatalog \ --database-name sampledb ``` Resultado: ``` { "Database": { "Name": "sampledb", "Description": "Sample database", "Parameters": { "CreatedBy": "Athena", "EXTERNAL": "TRUE" } } } ``` Para obter mais informações, consulte [Exibir detalhes do banco de dados: get-database](https://docs.aws.amazon.com/athena/latest/ug/datastores-hive-cli.html#datastores-hive-cli-showing-details-of-a-database) no *Guia do usuário do Amazon Athena*. + Para ver detalhes da API, consulte [GetDatabase](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/get-database.html) na *Referência de comandos da AWS CLI*. ### `get-named-query` O código de exemplo a seguir mostra como usar `get-named-query`. **AWS CLI** **Como retornar uma consulta nomeada** O exemplo `get-named-query` a seguir retorna informações sobre a consulta com o ID especificado. ``` aws athena get-named-query \ --named-query-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "NamedQuery": { "Name": "CloudFront Logs - SFO", "Description": "Shows successful GET request data for SFO", "Database": "default", "QueryString": "select date, location, browser, uri, status from cloudfront_logs where method = 'GET' and status = 200 and location like 'SFO%' limit 10", "NamedQueryId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "WorkGroup": "AthenaAdmin" } } ``` Para obter mais informações, consulte [Executar consultas SQL usando o Amazon Athena](https://docs.aws.amazon.com/athena/latest/ug/querying-athena-tables.html) no *Manual do usuário do Amazon Athena*. + Para ver detalhes da API, consulte [GetNamedQuery](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/get-named-query.html) na *Referência de comandos da AWS CLI*. ### `get-query-execution` O código de exemplo a seguir mostra como usar `get-query-execution`. **AWS CLI** **Como retornar informações sobre a execução de uma consulta** O exemplo `get-query-execution` a seguir retorna informações sobre a consulta com o ID da consulta especificado. ``` aws athena get-query-execution \ --query-execution-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "QueryExecution": { "QueryExecutionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "Query": "select date, location, browser, uri, status from cloudfront_logs where method = 'GET ' and status = 200 and location like 'SFO%' limit 10", "StatementType": "DML", "ResultConfiguration": { "OutputLocation": "s3://amzn-s3-demo-bucket/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.csv" }, "QueryExecutionContext": { "Database": "mydatabase", "Catalog": "awsdatacatalog" }, "Status": { "State": "SUCCEEDED", "SubmissionDateTime": 1593469842.665, "CompletionDateTime": 1593469846.486 }, "Statistics": { "EngineExecutionTimeInMillis": 3600, "DataScannedInBytes": 203089, "TotalExecutionTimeInMillis": 3821, "QueryQueueTimeInMillis": 267, "QueryPlanningTimeInMillis": 1175 }, "WorkGroup": "AthenaAdmin" } } ``` Para obter mais informações, consulte [Executar consultas SQL usando o Amazon Athena](https://docs.aws.amazon.com/athena/latest/ug/querying-athena-tables.html) no *Manual do usuário do Amazon Athena*. + Para ver detalhes da API, consulte [GetQueryExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/get-query-execution.html) na *Referência de comandos da AWS CLI*. ### `get-query-results` O código de exemplo a seguir mostra como usar `get-query-results`. **AWS CLI** **Como retornar os resultados de uma consulta** O exemplo `get-query-results` a seguir retorna os resultados da consulta que tem o ID da consulta especificado. ``` aws athena get-query-results \ --query-execution-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "ResultSet": { "Rows": [ { "Data": [ { "VarCharValue": "date" }, { "VarCharValue": "location" }, { "VarCharValue": "browser" }, { "VarCharValue": "uri" }, { "VarCharValue": "status" } ] }, { "Data": [ { "VarCharValue": "2014-07-05" }, { "VarCharValue": "SFO4" }, { "VarCharValue": "Safari" }, { "VarCharValue": "/test-image-2.jpeg" }, { "VarCharValue": "200" } ] }, { "Data": [ { "VarCharValue": "2014-07-05" }, { "VarCharValue": "SFO4" }, { "VarCharValue": "Opera" }, { "VarCharValue": "/test-image-2.jpeg" }, { "VarCharValue": "200" } ] }, { "Data": [ { "VarCharValue": "2014-07-05" }, { "VarCharValue": "SFO4" }, { "VarCharValue": "Firefox" }, { "VarCharValue": "/test-image-3.jpeg" }, { "VarCharValue": "200" } ] }, { "Data": [ { "VarCharValue": "2014-07-05" }, { "VarCharValue": "SFO4" }, { "VarCharValue": "Lynx" }, { "VarCharValue": "/test-image-3.jpeg" }, { "VarCharValue": "200" } ] }, { "Data": [ { "VarCharValue": "2014-07-05" }, { "VarCharValue": "SFO4" }, { "VarCharValue": "IE" }, { "VarCharValue": "/test-image-2.jpeg" }, { "VarCharValue": "200" } ] }, { "Data": [ { "VarCharValue": "2014-07-05" }, { "VarCharValue": "SFO4" }, { "VarCharValue": "Opera" }, { "VarCharValue": "/test-image-1.jpeg" }, { "VarCharValue": "200" } ] }, { "Data": [ { "VarCharValue": "2014-07-05" }, { "VarCharValue": "SFO4" }, { "VarCharValue": "Chrome" }, { "VarCharValue": "/test-image-3.jpeg" }, { "VarCharValue": "200" } ] }, { "Data": [ { "VarCharValue": "2014-07-05" }, { "VarCharValue": "SFO4" }, { "VarCharValue": "Firefox" }, { "VarCharValue": "/test-image-2.jpeg" }, { "VarCharValue": "200" } ] }, { "Data": [ { "VarCharValue": "2014-07-05" }, { "VarCharValue": "SFO4" }, { "VarCharValue": "Chrome" }, { "VarCharValue": "/test-image-3.jpeg" }, { "VarCharValue": "200" } ] }, { "Data": [ { "VarCharValue": "2014-07-05" }, { "VarCharValue": "SFO4" }, { "VarCharValue": "IE" }, { "VarCharValue": "/test-image-2.jpeg" }, { "VarCharValue": "200" } ] } ], "ResultSetMetadata": { "ColumnInfo": [ { "CatalogName": "hive", "SchemaName": "", "TableName": "", "Name": "date", "Label": "date", "Type": "date", "Precision": 0, "Scale": 0, "Nullable": "UNKNOWN", "CaseSensitive": false }, { "CatalogName": "hive", "SchemaName": "", "TableName": "", "Name": "location", "Label": "location", "Type": "varchar", "Precision": 2147483647, "Data": [ "Scale": 0, "Nullable": "UNKNOWN", "CaseSensitive": true }, { "CatalogName": "hive", "SchemaName": "", "TableName": "", "Name": "browser", "Label": "browser", "Type": "varchar", "Precision": 2147483647, "Scale": 0, "Nullable": "UNKNOWN", "CaseSensitive": true }, { "CatalogName": "hive", "SchemaName": "", "TableName": "", "Name": "uri", "Label": "uri", "Type": "varchar", "Precision": 2147483647, "Scale": 0, "Nullable": "UNKNOWN", "CaseSensitive": true }, { "CatalogName": "hive", "SchemaName": "", "TableName": "", "Name": "status", "Label": "status", "Type": "integer", "Precision": 10, "Scale": 0, "Nullable": "UNKNOWN", "CaseSensitive": false } ] } }, "UpdateCount": 0 } ``` Para obter mais informações, consulte [Trabalhar com resultados de consulta, arquivos de saída e histórico de consultas](https://docs.aws.amazon.com/athena/latest/ug/querying.html) no *Guia do usuário do Amazon Athena*. + Para ver detalhes da API, consulte [GetQueryResults](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/get-query-results.html) na *Referência de comandos da AWS CLI*. ### `get-table-metadata` O código de exemplo a seguir mostra como usar `get-table-metadata`. **AWS CLI** **Como retornar informações de metadados sobre uma tabela** O exemplo `get-table-metadata` a seguir retorna informações de metadados sobre a tabela `counties`, incluindo nomes de colunas e seus tipos de dados, do banco de dados `sampledb` do catálogo de dados `AwsDataCatalog`. ``` aws athena get-table-metadata \ --catalog-name AwsDataCatalog \ --database-name sampledb \ --table-name counties ``` Resultado: ``` { "TableMetadata": { "Name": "counties", "CreateTime": 1593559968.0, "LastAccessTime": 0.0, "TableType": "EXTERNAL_TABLE", "Columns": [ { "Name": "name", "Type": "string", "Comment": "from deserializer" }, { "Name": "boundaryshape", "Type": "binary", "Comment": "from deserializer" }, { "Name": "motto", "Type": "string", "Comment": "from deserializer" }, { "Name": "population", "Type": "int", "Comment": "from deserializer" } ], "PartitionKeys": [], "Parameters": { "EXTERNAL": "TRUE", "inputformat": "com.esri.json.hadoop.EnclosedJsonInputFormat", "location": "s3://amzn-s3-demo-bucket/json", "outputformat": "org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat", "serde.param.serialization.format": "1", "serde.serialization.lib": "com.esri.hadoop.hive.serde.JsonSerde", "transient_lastDdlTime": "1593559968" } } } ``` Para obter mais informações, consulte [Exibir detalhes da tabela: get-table-metadata](https://docs.aws.amazon.com/athena/latest/ug/datastores-hive-cli.html#datastores-hive-cli-showing-details-of-a-table) no *Guia do usuário do Amazon Athena*. + Para ver detalhes da API, consulte [GetTableMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/get-table-metadata.html) na *Referência de comandos da AWS CLI*. ### `get-work-group` O código de exemplo a seguir mostra como usar `get-work-group`. **AWS CLI** **Como retornar informações sobre um grupo de trabalho** O exemplo `get-work-group` a seguir retorna informações sobre o grupo de trabalho `AthenaAdmin`. ``` aws athena get-work-group \ --work-group AthenaAdmin ``` Resultado: ``` { "WorkGroup": { "Name": "AthenaAdmin", "State": "ENABLED", "Configuration": { "ResultConfiguration": { "OutputLocation": "s3://amzn-s3-demo-bucket/" }, "EnforceWorkGroupConfiguration": false, "PublishCloudWatchMetricsEnabled": true, "RequesterPaysEnabled": false }, "Description": "Workgroup for Athena administrators", "CreationTime": 1573677174.105 } } ``` Para obter mais informações, consulte [Gerenciar grupos de trabalho](https://docs.aws.amazon.com/athena/latest/ug/workgroups-create-update-delete.html) no *Guia do usuário do Amazon Athena*. + Para ver detalhes da API, consulte [GetWorkGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/get-work-group.html) na *Referência de comandos da AWS CLI*. ### `list-data-catalogs` O código de exemplo a seguir mostra como usar `list-data-catalogs`. **AWS CLI** **Para listar os catálogos de dados registrados com o Athena** O exemplo `list-data-catalogs` a seguir lista os catálogos de dados registrados com o Athena. ``` aws athena list-data-catalogs ``` Resultado: ``` { "DataCatalogsSummary": [ { "CatalogName": "AwsDataCatalog", "Type": "GLUE" }, { "CatalogName": "cw_logs_catalog", "Type": "LAMBDA" }, { "CatalogName": "cw_metrics_catalog", "Type": "LAMBDA" } ] } ``` Para obter mais informações, consulte [Listar catálogos registrados: list-data-catalogs](https://docs.aws.amazon.com/athena/latest/ug/datastores-hive-cli.html#datastores-hive-cli-listing-registered-catalogs) no *Guia do usuário do Amazon Athena*. + Para ver detalhes da API, consulte [ListDataCatalogs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/list-data-catalogs.html) na *Referência de comandos da AWS CLI*. ### `list-databases` O código de exemplo a seguir mostra como usar `list-databases`. **AWS CLI** **Para listar os bancos de dados em um catálogo de dados** O exemplo `list-databases` a seguir lista os bancos de dados do catálogo de dados `AwsDataCatalog`. ``` aws athena list-databases \ --catalog-name AwsDataCatalog ``` Resultado: ``` { "DatabaseList": [ { "Name": "default" }, { "Name": "mydatabase" }, { "Name": "newdb" }, { "Name": "sampledb", "Description": "Sample database", "Parameters": { "CreatedBy": "Athena", "EXTERNAL": "TRUE" } }, { "Name": "webdata" } ] } ``` Para obter mais informações, consulte [Listar bancos de dados em um catálogo: list-databases](https://docs.aws.amazon.com/athena/latest/ug/datastores-hive-cli.html#datastores-hive-cli-listing-databases) no *Guia do usuário do Amazon Athena*. + Para ver detalhes da API, consulte [ListDatabases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/list-databases.html) na *Referência de comandos da AWS CLI*. ### `list-named-queries` O código de exemplo a seguir mostra como usar `list-named-queries`. **AWS CLI** **Para listar as consultas nomeadas para um grupo de trabalho** O exemplo `list-named-queries` a seguir lista as consultas nomeadas do grupo de trabalho `AthenaAdmin`. ``` aws athena list-named-queries \ --work-group AthenaAdmin ``` Resultado: ``` { "NamedQueryIds": [ "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333" ] } ``` Para obter mais informações, consulte [Executar consultas SQL usando o Amazon Athena](https://docs.aws.amazon.com/athena/latest/ug/querying-athena-tables.html) no *Manual do usuário do Amazon Athena*. + Para ver detalhes da API, consulte [ListNamedQueries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/list-named-queries.html) na *Referência de comandos da AWS CLI*. ### `list-query-executions` O código de exemplo a seguir mostra como usar `list-query-executions`. **AWS CLI** **Para listar os IDs de consulta das consultas em um grupo de trabalho especificado** O exemplo `list-query-executions` a seguir lista no máximo dez IDs de consulta no grupo de trabalho `AthenaAdmin`. ``` aws athena list-query-executions \ --work-group AthenaAdmin \ --max-items 10 ``` Resultado: ``` { "QueryExecutionIds": [ "a1b2c3d4-5678-90ab-cdef-EXAMPLE11110", "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "a1b2c3d4-5678-90ab-cdef-EXAMPLE11114", "a1b2c3d4-5678-90ab-cdef-EXAMPLE11115", "a1b2c3d4-5678-90ab-cdef-EXAMPLE11116", "a1b2c3d4-5678-90ab-cdef-EXAMPLE11117", "a1b2c3d4-5678-90ab-cdef-EXAMPLE11118", "a1b2c3d4-5678-90ab-cdef-EXAMPLE11119" ], "NextToken": "eyJOZXh0VG9rZW4iOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAxMH0=" } ``` Para obter mais informações, consulte [Trabalhar com resultados de consulta, arquivos de saída e histórico de consultas](https://docs.aws.amazon.com/athena/latest/ug/querying.html) no *Guia do usuário do Amazon Athena*. + Para ver detalhes da API, consulte [ListQueryExecutions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/list-query-executions.html) na *Referência de comandos da AWS CLI*. ### `list-table-metadata` O código de exemplo a seguir mostra como usar `list-table-metadata`. **AWS CLI** **Para listar os metadados das tabelas no banco de dados especificado de um catálogo de dados** O exemplo `list-table-metadata` a seguir retorna informações de metadados para no máximo duas tabelas no banco de dados `geography` do catálogo de dados `AwsDataCatalog`. ``` aws athena list-table-metadata \ --catalog-name AwsDataCatalog \ --database-name geography \ --max-items 2 ``` Resultado: ``` { "TableMetadataList": [ { "Name": "country_codes", "CreateTime": 1586553454.0, "TableType": "EXTERNAL_TABLE", "Columns": [ { "Name": "country", "Type": "string", "Comment": "geo id" }, { "Name": "alpha-2 code", "Type": "string", "Comment": "geo id2" }, { "Name": "alpha-3 code", "Type": "string", "Comment": "state name" }, { "Name": "numeric code", "Type": "bigint", "Comment": "" }, { "Name": "latitude", "Type": "bigint", "Comment": "location (latitude)" }, { "Name": "longitude", "Type": "bigint", "Comment": "location (longitude)" } ], "Parameters": { "areColumnsQuoted": "false", "classification": "csv", "columnsOrdered": "true", "delimiter": ",", "has_encrypted_data": "false", "inputformat": "org.apache.hadoop.mapred.TextInputFormat", "location": "s3://amzn-s3-demo-bucket/csv/countrycode", "outputformat": "org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat", "serde.param.field.delim": ",", "serde.serialization.lib": "org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe", "skip.header.line.count": "1", "typeOfData": "file" } }, { "Name": "county_populations", "CreateTime": 1586553446.0, "TableType": "EXTERNAL_TABLE", "Columns": [ { "Name": "id", "Type": "string", "Comment": "geo id" }, { "Name": "country", "Name": "id2", "Type": "string", "Comment": "geo id2" }, { "Name": "county", "Type": "string", "Comment": "county name" }, { "Name": "state", "Type": "string", "Comment": "state name" }, { "Name": "population estimate 2018", "Type": "string", "Comment": "" } ], "Parameters": { "areColumnsQuoted": "false", "classification": "csv", "columnsOrdered": "true", "delimiter": ",", "has_encrypted_data": "false", "inputformat": "org.apache.hadoop.mapred.TextInputFormat", "location": "s3://amzn-s3-demo-bucket/csv/CountyPopulation", "outputformat": "org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat", "serde.param.field.delim": ",", "serde.serialization.lib": "org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe", "skip.header.line.count": "1", "typeOfData": "file" } } ], "NextToken": "eyJOZXh0VG9rZW4iOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==" } ``` Para obter mais informações, consulte [Exibir metadados de todas as tabelas em um banco de dados: list-table-metadata](https://docs.aws.amazon.com/athena/latest/ug/datastores-hive-cli.html#datastores-hive-cli-showing-all-table-metadata) no *Guia do usuário do Amazon Athena*. + Para ver detalhes da API, consulte [ListTableMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/list-table-metadata.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Exemplo 1: listar as tags de um grupo de trabalho** O exemplo `list-tags-for-resource` a seguir lista as tags do grupo de trabalho `Data_Analyst_Group`: ``` aws athena list-tags-for-resource \ --resource-arn arn:aws:athena:us-west-2:111122223333:workgroup/Data_Analyst_Group ``` Resultado: ``` { "Tags": [ { "Key": "Division", "Value": "West" }, { "Key": "Team", "Value": "Big Data" }, { "Key": "Location", "Value": "Seattle" } ] } ``` **Exemplo 2: listar as tags de um catálogo de dados** O exemplo `list-tags-for-resource` a seguir lista as tags do catálogo de dados `dynamo_db_catalog`. ``` aws athena list-tags-for-resource \ --resource-arn arn:aws:athena:us-west-2:111122223333:datacatalog/dynamo_db_catalog ``` Resultado: ``` { "Tags": [ { "Key": "Division", "Value": "Mountain" }, { "Key": "Organization", "Value": "Retail" }, { "Key": "Product_Line", "Value": "Shoes" }, { "Key": "Location", "Value": "Denver" } ] } ``` Para obter mais informações, consulte [Listar as tags de um recurso: list-tags-for-resource](https://docs.aws.amazon.com/athena/latest/ug/tags-operations.html#tags-operations-examples-cli-list-tags-for-resource) no *Guia do usuário do Amazon Athena*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `list-work-groups` O código de exemplo a seguir mostra como usar `list-work-groups`. **AWS CLI** **Para listar grupos de trabalho** O exemplo `list-work-groups` a seguir lista os grupos de trabalho na conta atual. ``` aws athena list-work-groups ``` Resultado: ``` { "WorkGroups": [ { "Name": "Data_Analyst_Group", "State": "ENABLED", "Description": "", "CreationTime": 1578006683.016 }, { "Name": "AthenaAdmin", "State": "ENABLED", "Description": "", "CreationTime": 1573677174.105 }, { "Name": "primary", "State": "ENABLED", "Description": "", "CreationTime": 1567465222.723 } ] } ``` Para obter mais informações, consulte [Gerenciar grupos de trabalho](https://docs.aws.amazon.com/athena/latest/ug/workgroups-create-update-delete.html) no *Guia do usuário do Amazon Athena*. + Para ver detalhes da API, consulte [ListWorkGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/list-work-groups.html) na *Referência de comandos da AWS CLI*. ### `start-query-execution` O código de exemplo a seguir mostra como usar `start-query-execution`. **AWS CLI** **Exemplo 1: executar uma consulta em um grupo de trabalho na tabela especificada no banco de dados e no catálogo de dados especificados** O exemplo `start-query-execution` a seguir usa o grupo de trabalho `AthenaAdmin` para executar uma consulta na tabela `cloudfront_logs` no `cflogsdatabase` no catálogo de dados `AwsDataCatalog`. ``` aws athena start-query-execution \ --query-string "select date, location, browser, uri, status from cloudfront_logs where method = 'GET' and status = 200 and location like 'SFO%' limit 10" \ --work-group "AthenaAdmin" \ --query-execution-context Database=cflogsdatabase,Catalog=AwsDataCatalog ``` Resultado: ``` { "QueryExecutionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } ``` Para obter mais informações, consulte [Executar consultas SQL usando o Amazon Athena](https://docs.aws.amazon.com/athena/latest/ug/querying-athena-tables.html) no *Manual do usuário do Amazon Athena*. **Exemplo 2: executar uma consulta que usa um grupo de trabalho especificado para criar um banco de dados no catálogo de dados especificado** O exemplo `start-query-execution` a seguir usa o grupo de trabalho `AthenaAdmin` para criar o banco de dados `newdb` no catálogo de dados padrão `AwsDataCatalog`. ``` aws athena start-query-execution \ --query-string "create database if not exists newdb" \ --work-group "AthenaAdmin" ``` Resultado: ``` { "QueryExecutionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11112" } ``` Para obter mais informações, consulte [Executar consultas SQL usando o Amazon Athena](https://docs.aws.amazon.com/athena/latest/ug/querying-athena-tables.html) no *Manual do usuário do Amazon Athena*. **Exemplo 3: executar uma consulta que cria uma exibição em uma tabela no banco de dados e no catálogo de dados especificados** O exemplo `start-query-execution` a seguir usa uma declaração `SELECT` na tabela `cloudfront_logs` do `cflogsdatabase` para criar a visualização `cf10`. ``` aws athena start-query-execution \ --query-string "CREATE OR REPLACE VIEW cf10 AS SELECT * FROM cloudfront_logs limit 10" \ --query-execution-context Database=cflogsdatabase ``` Resultado: ``` { "QueryExecutionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11113" } ``` Para obter mais informações, consulte [Executar consultas SQL usando o Amazon Athena](https://docs.aws.amazon.com/athena/latest/ug/querying-athena-tables.html) no *Manual do usuário do Amazon Athena*. + Para ver detalhes da API, consulte [StartQueryExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/start-query-execution.html) e *Referência de comandos da AWS CLI*. ### `stop-query-execution` O código de exemplo a seguir mostra como usar `stop-query-execution`. **AWS CLI** **Como interromper uma consulta em execução** O exemplo `stop-query-execution` a seguir interrompe a consulta que tem o ID de consulta especificado. ``` aws athena stop-query-execution \ --query-execution-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Este comando não produz saída. Para obter mais informações, consulte [Executar consultas SQL usando o Amazon Athena](https://docs.aws.amazon.com/athena/latest/ug/querying-athena-tables.html) no *Manual do usuário do Amazon Athena*. + Para ver detalhes da API, consulte [StopQueryExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/stop-query-execution.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Adicionar uma tag a um recurso** O exemplo `tag-resource` a seguir adiciona três tags ao catálogo de dados `dynamo_db_catalog`. ``` aws athena tag-resource \ --resource-arn arn:aws:athena:us-west-2:111122223333:datacatalog/dynamo_db_catalog \ --tags Key=Organization,Value=Retail Key=Division,Value=Mountain Key=Product_Line,Value=Shoes Key=Location,Value=Denver ``` Este comando não produz saída. Para ver o resultado, use `aws athena list-tags-for-resource --resource-arn arn:aws:athena:us-west-2:111122223333:datacatalog/dynamo_db_catalog`. Para obter mais informações, consulte [Adicionar tags a um recurso: tag-resource](https://docs.aws.amazon.com/athena/latest/ug/tags-operations.html#tags-operations-examples-cli-tag-resource) no *Guia do usuário do Amazon Athena*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover uma tag de um recurso** O exemplo `untag-resource` a seguir remove as chaves `Specialization` e `Focus` e seus valores do recurso de catálogo `dynamo_db_catalog`. ``` aws athena untag-resource \ --resource-arn arn:aws:athena:us-west-2:111122223333:datacatalog/dynamo_db_catalog \ --tag-keys Specialization Focus ``` Este comando não produz saída. Para ver os resultados, use o comando `list-tags-for-resource`. Para obter mais informações, consulte [Remover tags de um recurso: untag-resource](https://docs.aws.amazon.com/athena/latest/ug/tags-operations.html#tags-operations-examples-cli-untag-resource) no *Guia do usuário do Amazon Athena*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-data-catalog` O código de exemplo a seguir mostra como usar `update-data-catalog`. **AWS CLI** **Para atualizar um catálogo de dados** O exemplo `update-data-catalog` a seguir atualiza a função do Lambda e a descrição do catálogo de dados `cw_logs_catalog`. ``` aws athena update-data-catalog \ --name cw_logs_catalog \ --type LAMBDA \ --description "New CloudWatch Logs Catalog" \ --function=arn:aws:lambda:us-west-2:111122223333:function:new_cw_logs_lambda ``` Este comando não produz saída. Para ver o resultado, use `aws athena get-data-catalog --name cw_logs_catalog`. Para obter mais informações, consulte [Atualizar um catálogo: update-data-catalog](https://docs.aws.amazon.com/athena/latest/ug/datastores-hive-cli.html#datastores-hive-cli-updating-a-catalog) no *Guia do usuário do Amazon Athena*. + Para ver detalhes da API, consulte [UpdateDataCatalog](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/update-data-catalog.html) na *Referência de comandos da AWS CLI*. ### `update-work-group` O código de exemplo a seguir mostra como usar `update-work-group`. **AWS CLI** **Para atualizar um grupo de trabalho** O exemplo `update-work-group` a seguir desabilita o grupo de trabalho `Data_Analyst_Group`. Os usuários não podem executar ou criar consultas no grupo de trabalho desabilitado, mas ainda podem visualizar métricas, controles de limite de uso de dados, configurações do grupo de trabalho, histórico de consultas e consultas salvas. ``` aws athena update-work-group \ --work-group Data_Analyst_Group \ --state DISABLED ``` Este comando não produz saída. Para verificar a alteração no estado, use `aws athena get-work-group --work-group Data_Analyst_Group` e verifique a propriedade `State` na saída. Para obter mais informações, consulte [Gerenciar grupos de trabalho](https://docs.aws.amazon.com/athena/latest/ug/workgroups-create-update-delete.html) no *Guia do usuário do Amazon Athena*. + Para ver detalhes da API, consulte [UpdateWorkGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/update-work-group.html) na *Referência de comandos da AWS CLI*. # Exemplos do Auto Scaling usando o AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o 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 ### `attach-instances` O código de exemplo a seguir mostra como usar `attach-instances`. **AWS CLI** **Como anexar uma instância a um grupo do Auto Scaling** Este exemplo anexa a instância especificada ao grupo do Auto Scaling especificado. ``` aws autoscaling attach-instances \ --instance-ids i-061c63c5eb45f0416 \ --auto-scaling-group-name my-asg ``` Este comando não produz saída. + Para ver detalhes da API, consulte [AttachInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/attach-instances.html) na *Referência de comandos da AWS CLI*. ### `attach-load-balancer-target-groups` O código de exemplo a seguir mostra como usar `attach-load-balancer-target-groups`. **AWS CLI** **Como anexar um grupo de destino a um grupo do Auto Scaling** Este exemplo anexa o grupo de destino especificado ao grupo do Auto Scaling especificado. ``` aws autoscaling attach-load-balancer-target-groups \ --auto-scaling-group-name my-asg \ --target-group-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 ``` Este comando não produz saída. Para obter mais informações, consulte [Elastic Load Balancing e Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Consulte detalhes da API em [AttachLoadBalancerTargetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/attach-load-balancer-target-groups.html) na *Referência de comandos AWS CLI*. ### `attach-load-balancers` O código de exemplo a seguir mostra como usar `attach-load-balancers`. **AWS CLI** **Como anexar um Classic Load Balancer ao grupo do Auto Scaling** Este exemplo anexa o Classic Load Balancer especificado ao grupo do Auto Scaling especificado. ``` aws autoscaling attach-load-balancers \ --load-balancer-names my-load-balancer \ --auto-scaling-group-name my-asg ``` Este comando não produz saída. Para obter mais informações, consulte [Elastic Load Balancing e Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Para receber detalhes da API, consulte [AttachLoadBalancers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/attach-load-balancers.html) na *Referência de comandos da AWS CLI*. ### `cancel-instance-refresh` O código de exemplo a seguir mostra como usar `cancel-instance-refresh`. **AWS CLI** **Como cancelar uma atualização de instância** O exemplo `cancel-instance-refresh` a seguir cancela uma atualização de instância em andamento para o grupo do Auto Scaling especificado. ``` aws autoscaling cancel-instance-refresh \ --auto-scaling-group-name my-asg ``` Resultado: ``` { "InstanceRefreshId": "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b" } ``` Para obter mais informações, consulte [Cancelar uma atualização de instância](https://docs.aws.amazon.com/autoscaling/ec2/userguide/cancel-instance-refresh.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Para obter detalhes a API, consulte [CancelInstanceRefresh](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/cancel-instance-refresh.html) na *Referência de comandos da AWS CLI*. ### `complete-lifecycle-action` O código de exemplo a seguir mostra como usar `complete-lifecycle-action`. **AWS CLI** **Como concluir a ação do ciclo de vida** Este exemplo notifica o Amazon EC2 Auto Scaling de que a ação do ciclo de vida especificada foi concluída para que ele possa concluir a execução ou o encerramento da instância. ``` aws autoscaling complete-lifecycle-action \ --lifecycle-hook-name my-launch-hook \ --auto-scaling-group-name my-asg \ --lifecycle-action-result CONTINUE \ --lifecycle-action-token bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635 ``` Este comando não produz saída. Para obter mais informações, consulte [Ganchos do ciclo de vida do Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) no *Manual do usuário do Amazon EC2 Auto Scaling*. + Para ver detalhes da API, consulte [CompleteLifecycleAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/complete-lifecycle-action.html) na *Referência de comandos da AWS CLI*. ### `create-auto-scaling-group` O código de exemplo a seguir mostra como usar `create-auto-scaling-group`. **AWS CLI** **Exemplo 1: como criar um grupo do Auto Scaling** O exemplo de `create-auto-scaling-group` a seguir cria um grupo do Auto Scaling em sub-redes de várias zonas de disponibilidade de uma região. As instâncias são executadas com a versão padrão do modelo de execução especificado. Observe que os padrões são usados na maioria das outras configurações, como nas políticas de encerramento e na configuração de verificação de integridade. ``` aws autoscaling create-auto-scaling-group \ --auto-scaling-group-name my-asg \ --launch-template LaunchTemplateId=lt-1234567890abcde12 \ --min-size 1 \ --max-size 5 \ --vpc-zone-identifier "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782" ``` Este comando não produz saída. Para obter mais informações, consulte[ Grupos do Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. **Exemplo 2: como anexar o Application Load Balancer, o Network Load Balancer ou o Gateway Load Balancer** Este exemplo especifica o ARN de um grupo de destino para um balanceador de carga compatível com o tráfego esperado. O tipo de verificação de integridade especifica o `ELB`. Desta forma, quando o Elastic Load Balancing reportar uma instância como não íntegra, o grupo do Auto Scaling a substitui. O comando também define um período de carência de `600` segundos para a verificação de integridade. O período de carência ajuda a evitar o encerramento prematuro de instâncias recém-iniciadas. ``` aws autoscaling create-auto-scaling-group \ --auto-scaling-group-name my-asg \ --launch-template LaunchTemplateId=lt-1234567890abcde12 \ --target-group-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/943f017f100becff \ --health-check-type ELB \ --health-check-grace-period 600 \ --min-size 1 \ --max-size 5 \ --vpc-zone-identifier "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782" ``` Este comando não produz saída. Para obter mais informações, consulte [Elastic Load Balancing e Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. **Exemplo 3: como especificar um grupo de posicionamento e usar a versão mais recente do modelo de execução** Este exemplo executa instâncias em um grupo de posicionamento dentro de uma única zona de disponibilidade. Isso pode ser útil para grupos de baixa latência com workloads de HPC. Esse exemplo também especifica o tamanho mínimo e máximo e a capacidade desejada do grupo. ``` aws autoscaling create-auto-scaling-group \ --auto-scaling-group-name my-asg \ --launch-template LaunchTemplateId=lt-1234567890abcde12,Version='$Latest' \ --min-size 1 \ --max-size 5 \ --desired-capacity 3 \ --placement-group my-placement-group \ --vpc-zone-identifier "subnet-6194ea3b" ``` Este comando não produz saída. Para obter mais informações, consulte [Grupos de posicionamento](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) no *Guia do usuário para instâncias do Linux do Amazon EC2*. **Exemplo 4: como especificar um grupo do Auto Scaling de instância única e usar uma versão específica para iniciar o modelo** Este exemplo cria um grupo do Auto Scaling com capacidade mínima e máxima definida como `1` para impor que uma apenas instância seja executada. O comando também especifica a v1 de um modelo de execução no qual o ID de um ENI existente é especificado. Ao usar um modelo de execução que especifica um ENI existente para eth0, é necessário especificar uma zona de disponibilidade para o grupo do Auto Scaling que corresponda à interface de rede, mas sem especificar um ID de sub-rede na solicitação. ``` aws autoscaling create-auto-scaling-group \ --auto-scaling-group-name my-asg-single-instance \ --launch-template LaunchTemplateName=my-template-for-auto-scaling,Version='1' \ --min-size 1 \ --max-size 1 \ --availability-zones us-west-2a ``` Este comando não produz saída. Para obter mais informações, consulte[ Grupos do Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. **Exemplo 5: como especificar uma política de encerramento diferente** Este exemplo cria um grupo do Auto Scaling usando uma configuração de execução e define a política de encerramento para encerrar as instâncias mais antigas primeiro. O comando também aplica uma tag ao grupo e suas instâncias, com uma chave `Role` e valor de `WebServer`. ``` aws autoscaling create-auto-scaling-group \ --auto-scaling-group-name my-asg \ --launch-configuration-name my-lc \ --min-size 1 \ --max-size 5 \ --termination-policies "OldestInstance" \ --tags "ResourceId=my-asg,ResourceType=auto-scaling-group,Key=Role,Value=WebServer,PropagateAtLaunch=true" \ --vpc-zone-identifier "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782" ``` Este comando não produz saída. Para obter mais informações, consulte [Trabalhar com políticas de término do Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. **Exemplo 6: como especificar um gancho do ciclo de vida de lançamento** Este exemplo a seguir cria um grupo do Auto Scaling com um gancho do ciclo de vida que oferece suporte a uma ação personalizada na inicialização da instância. ``` aws autoscaling create-auto-scaling-group \ --cli-input-json file://~/config.json ``` Conteúdo do arquivo `config.json`: ``` { "AutoScalingGroupName": "my-asg", "LaunchTemplate": { "LaunchTemplateId": "lt-1234567890abcde12" }, "LifecycleHookSpecificationList": [{ "LifecycleHookName": "my-launch-hook", "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING", "NotificationTargetARN": "arn:aws:sqs:us-west-2:123456789012:my-sqs-queue", "RoleARN": "arn:aws:iam::123456789012:role/my-notification-role", "NotificationMetadata": "SQS message metadata", "HeartbeatTimeout": 4800, "DefaultResult": "ABANDON" }], "MinSize": 1, "MaxSize": 5, "VPCZoneIdentifier": "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782", "Tags": [{ "ResourceType": "auto-scaling-group", "ResourceId": "my-asg", "PropagateAtLaunch": true, "Value": "test", "Key": "environment" }] } ``` Este comando não produz saída. Para obter mais informações, consulte [Ganchos do ciclo de vida do Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) no *Manual do usuário do Amazon EC2 Auto Scaling*. **Exemplo 7: como especificar um gancho do ciclo de vida de encerramento** Este exemplo a seguir cria um grupo do Auto Scaling com um gancho do ciclo de vida que oferece suporte a uma ação personalizada no encerramento da instância. ``` aws autoscaling create-auto-scaling-group \ --cli-input-json file://~/config.json ``` Conteúdo de `config.json`: ``` { "AutoScalingGroupName": "my-asg", "LaunchTemplate": { "LaunchTemplateId": "lt-1234567890abcde12" }, "LifecycleHookSpecificationList": [{ "LifecycleHookName": "my-termination-hook", "LifecycleTransition": "autoscaling:EC2_INSTANCE_TERMINATING", "HeartbeatTimeout": 120, "DefaultResult": "CONTINUE" }], "MinSize": 1, "MaxSize": 5, "TargetGroupARNs": [ "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" ], "VPCZoneIdentifier": "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782" } ``` Este comando não produz saída. Para obter mais informações, consulte [Ganchos do ciclo de vida do Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) no *Manual do usuário do Amazon EC2 Auto Scaling*. **Exemplo 8: como especificar uma política de encerramento personalizada** Este exemplo cria um grupo do Auto Scaling que especifica uma política de encerramento da função do Lambda personalizada que diz ao Amazon EC2 Auto Scaling quais instâncias podem ser encerradas com segurança em escala. ``` aws autoscaling create-auto-scaling-group \ --auto-scaling-group-name my-asg-single-instance \ --launch-template LaunchTemplateName=my-template-for-auto-scaling \ --min-size 1 \ --max-size 5 \ --termination-policies "arn:aws:lambda:us-west-2:123456789012:function:HelloFunction:prod" \ --vpc-zone-identifier "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782" ``` Este comando não produz saída. Para obter mais informações, consulte [Criar uma política de término personalizada com o Lambda](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lambda-custom-termination-policy.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Consulte detalhes da API em [CreateAutoScalingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/create-auto-scaling-group.html) na *Referência de comandos AWS CLI*. ### `create-launch-configuration` O código de exemplo a seguir mostra como usar `create-launch-configuration`. **AWS CLI** **Exemplo 1: criar uma configuração de execução** Este exemplo cria uma configuração de inicialização simples. ``` aws autoscaling create-launch-configuration \ --launch-configuration-name my-lc \ --image-id ami-04d5cc9b88example \ --instance-type m5.large ``` Este comando não produz saída. Para obter mais informações, consulte [Criar uma configuração de execução](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. **Exemplo 2: criar uma configuração de inicialização com um grupo de segurança, um par de chaves e um script de bootstrapping** Este exemplo cria uma configuração de execução com um grupo de segurança, um par de chaves e um script de bootstrapping contido nos dados do usuário. ``` aws autoscaling create-launch-configuration \ --launch-configuration-name my-lc \ --image-id ami-04d5cc9b88example \ --instance-type m5.large \ --security-groups sg-eb2af88example \ --key-name my-key-pair \ --user-data file://myuserdata.txt ``` Este comando não produz saída. Para obter mais informações, consulte [Criar uma configuração de execução](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. **Exemplo 3: criar uma configuração de inicialização com um perfil do IAM** Este exemplo cria uma configuração de execução com o nome do perfil de instância de um perfil do IAM. ``` aws autoscaling create-launch-configuration \ --launch-configuration-name my-lc \ --image-id ami-04d5cc9b88example \ --instance-type m5.large \ --iam-instance-profile my-autoscaling-role ``` Este comando não produz saída. Para obter mais informações, consulte [Função do IAM para aplicações que são executadas em instâncias do Amazon EC2](https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. **Exemplo 4: habilitar o monitoramento detalhado em uma configuração de execução** Este exemplo cria uma configuração de execução com o monitoramento detalhado do EC2 habilitado, que envia métricas do EC2 para o CloudWatch em períodos de 1 minuto. ``` aws autoscaling create-launch-configuration \ --launch-configuration-name my-lc \ --image-id ami-04d5cc9b88example \ --instance-type m5.large \ --instance-monitoring Enabled=true ``` Este comando não produz saída. Para obter mais informações, consulte [Configurando o monitoramento de instâncias do Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/enable-as-instance-metrics.html) na *Guia do usuário do Amazon EC2 Auto Scaling*. **Exemplo 5: criar uma configuração de execução para instâncias spot** Este exemplo cria uma configuração de execução que usa instâncias spot como a única opção de compra. ``` aws autoscaling create-launch-configuration \ --launch-configuration-name my-lc \ --image-id ami-04d5cc9b88example \ --instance-type m5.large \ --spot-price "0.50" ``` Este comando não produz saída. Para obter mais informações, consulte [Solicitar instâncias spot](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. **Exemplo 6: criar uma configuração de execução usando uma instância do EC2** Este exemplo cria uma configuração de execução com base nos atributos de uma instância existente. Ele substitui a locação de localização e determina se um endereço IP público é definido, incluindo as opções `--placement-tenancy` e `--no-associate-public-ip-address`. ``` aws autoscaling create-launch-configuration \ --launch-configuration-name my-lc-from-instance \ --instance-id i-0123a456700123456 \ --instance-type m5.large \ --no-associate-public-ip-address \ --placement-tenancy dedicated ``` Este comando não produz saída. Para obter mais informações, consulte [Criação de uma configuração de execução usando uma instância do EC2](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-lc-with-instanceID.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. **Exemplo 7: criar uma configuração de execução com um mapeamento de dispositivos de blocos para um volume do Amazon EBS** Este exemplo cria uma configuração de execução com um mapeamento de dispositivos de blocos para um volume `gp3` do Amazon EBS com o nome do dispositivo `/dev/sdh` e um tamanho de volume de 20. ``` aws autoscaling create-launch-configuration \ --launch-configuration-name my-lc \ --image-id ami-04d5cc9b88example \ --instance-type m5.large \ --block-device-mappings '[{"DeviceName":"/dev/sdh","Ebs":{"VolumeSize":20,"VolumeType":"gp3"}}]' ``` Este comando não produz saída. Para obter mais informações, consulte [EBS](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_Ebs.html) na *Referência da API do Amazon EC2 Auto Scaling*. Para obter mais informações sobre como citar parâmetros formatados em JSON, consulte [Usar aspas com strings na AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) no *Guia do usuário da AWS Command Line Interface*. **Exemplo 8: criar uma configuração de execução com um mapeamento de dispositivos de blocos para um volume de armazenamento de instância** Este exemplo cria uma configuração de execução com `ephemeral1` como volume de armazenamento de instância com o nome do dispositivo `/dev/sdc`. ``` aws autoscaling create-launch-configuration \ --launch-configuration-name my-lc \ --image-id ami-04d5cc9b88example \ --instance-type m5.large \ --block-device-mappings '[{"DeviceName":"/dev/sdc","VirtualName":"ephemeral1"}]' ``` Este comando não produz saída. Para obter mais informações, consulte [BlockDeviceMapping](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_BlockDeviceMapping.html) na *Referência de API do Amazon EC2 Auto Scaling*. Para obter mais informações sobre como citar parâmetros formatados em JSON, consulte [Usar aspas com strings na AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) no *Guia do usuário da AWS Command Line Interface*. **Exemplo 9: criar uma configuração de execução e impedir que um dispositivo de blocos se conecte no momento da execução** Este exemplo cria uma configuração de execução que suprime um dispositivo de blocos especificado pelo mapeamento de dispositivos de blocos da AMI (por exemplo, `/dev/sdf`). ``` aws autoscaling create-launch-configuration \ --launch-configuration-name my-lc \ --image-id ami-04d5cc9b88example \ --instance-type m5.large \ --block-device-mappings '[{"DeviceName":"/dev/sdf","NoDevice":""}]' ``` Este comando não produz saída. Para obter mais informações, consulte [BlockDeviceMapping](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_BlockDeviceMapping.html) na *Referência de API do Amazon EC2 Auto Scaling*. Para obter mais informações sobre como citar parâmetros formatados em JSON, consulte [Usar aspas com strings na AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) no *Guia do usuário da AWS Command Line Interface*. + Para ver detalhes da API, consulte [CreateLaunchConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/create-launch-configuration.html) na *Referência de comandos da AWS CLI*. ### `create-or-update-tags` O código de exemplo a seguir mostra como usar `create-or-update-tags`. **AWS CLI** **Para criar ou atualizar tags de um grupo do Auto Scaling** Este exemplo adiciona duas tags ao grupo do Auto Scaling especificado. ``` aws autoscaling create-or-update-tags \ --tags ResourceId=my-asg,ResourceType=auto-scaling-group,Key=Role,Value=WebServer,PropagateAtLaunch=true ResourceId=my-asg,ResourceType=auto-scaling-group,Key=Dept,Value=Research,PropagateAtLaunch=true ``` Este comando não produz saída. Para obter mais informações, consulte [Marcar instâncias e grupos de Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Para ver detalhes da API, consulte [CreateOrUpdateTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/create-or-update-tags.html) na *Referência de comandos da AWS CLI*. ### `delete-auto-scaling-group` O código de exemplo a seguir mostra como usar `delete-auto-scaling-group`. **AWS CLI** **Exemplo 1: como excluir o grupo do Auto Scaling especificado** Este exemplo exclui o grupo do Auto Scaling especificado. ``` aws autoscaling delete-auto-scaling-group \ --auto-scaling-group-name my-asg ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir infraestrutura do Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-process-shutdown.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. **Exemplo 2: como forçar a exclusão do grupo do Auto Scaling especificado** Use a opção `--force-delete` para excluir o grupo do Auto Scaling sem precisar esperar que as instâncias do grupo sejam encerradas. ``` aws autoscaling delete-auto-scaling-group \ --auto-scaling-group-name my-asg \ --force-delete ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir infraestrutura do Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-process-shutdown.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Consulte detalhes da API em [DeleteAutoScalingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/delete-auto-scaling-group.html) na *Referência de comandos AWS CLI*. ### `delete-launch-configuration` O código de exemplo a seguir mostra como usar `delete-launch-configuration`. **AWS CLI** **Para excluir sua configuração de execução** Este exemplo exclui a configuração de execução especificada. ``` aws autoscaling delete-launch-configuration \ --launch-configuration-name my-launch-config ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir infraestrutura do Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-process-shutdown.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Para ver detalhes da API, consulte [DeleteLaunchConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/delete-launch-configuration.html) na *Referência de comandos da AWS CLI*. ### `delete-lifecycle-hook` O código de exemplo a seguir mostra como usar `delete-lifecycle-hook`. **AWS CLI** **Para excluir um gancho do ciclo de vida** Este exemplo exclui o gancho do ciclo de vida especificado. ``` aws autoscaling delete-lifecycle-hook \ --lifecycle-hook-name my-lifecycle-hook \ --auto-scaling-group-name my-asg ``` Este comando não produz saída. + Para ver detalhes da API, consulte [DeleteLifecycleHook](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/delete-lifecycle-hook.html) na *Referência de comandos da AWS CLI*. ### `delete-notification-configuration` O código de exemplo a seguir mostra como usar `delete-notification-configuration`. **AWS CLI** **Para excluir uma notificação de ajuste de escala automático** Este exemplo exclui a notificação especificada do grupo do Auto Scaling especificado. ``` aws autoscaling delete-notification-configuration \ --auto-scaling-group-name my-asg \ --topic-arn arn:aws:sns:us-west-2:123456789012:my-sns-topic ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir a configuração de notificação](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html#delete-settingupnotifications) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Para ver detalhes da API, consulte [DeleteNotificationConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/delete-notification-configuration.html) na *Referência de comandos da AWS CLI*. ### `delete-policy` O código de exemplo a seguir mostra como usar `delete-policy`. **AWS CLI** **Para excluir uma política de escalabilidade** Este exemplo exclui a política de escalabilidade especificada. ``` aws autoscaling delete-policy \ --auto-scaling-group-name my-asg \ --policy-name alb1000-target-tracking-scaling-policy ``` Este comando não produz saída. + Consulte detalhes da API em [DeletePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/delete-policy.html) na *Referência de comandos AWS CLI*. ### `delete-scheduled-action` O código de exemplo a seguir mostra como usar `delete-scheduled-action`. **AWS CLI** **Para excluir uma ação programada de um grupo do Auto Scaling** Este exemplo exclui a ação programada especificada do grupo do Auto Scaling especificado. ``` aws autoscaling delete-scheduled-action \ --auto-scaling-group-name my-asg \ --scheduled-action-name my-scheduled-action ``` Este comando não produz saída. + Para ver detalhes da API, consulte [DeleteScheduledAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/delete-scheduled-action.html) na *Referência de comandos da AWS CLI*. ### `delete-tags` O código de exemplo a seguir mostra como usar `delete-tags`. **AWS CLI** **Para excluir uma tag de um grupo do Auto Scaling** Este exemplo exclui a tag especificada do grupo do Auto Scaling especificado. ``` aws autoscaling delete-tags \ --tags ResourceId=my-asg,ResourceType=auto-scaling-group,Key=Dept,Value=Research ``` Este comando não produz saída. Para obter mais informações, consulte [Marcar instâncias e grupos de Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Para ver detalhes da API, consulte [DeleteTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/delete-tags.html) na *Referência de comandos da AWS CLI*. ### `delete-warm-pool` O código de exemplo a seguir mostra como usar `delete-warm-pool`. **AWS CLI** **Exemplo 1: excluir um grupo de alta atividade** O exemplo a seguir exclui o grupo de alta atividade para um grupo do Auto Scaling. ``` aws autoscaling delete-warm-pool \ --auto-scaling-group-name my-asg ``` Este comando não produz saída. Para obter mais informações, consulte [Pools ativos para o Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html) no *Manual do usuário do Amazon EC2 Auto Scaling*. **Exemplo 2: forçar a exclusão de um grupo de alta atividade** Para excluir o grupo de alta atividade sem esperar que suas instâncias se encerrem, use a opção `--force-delete`. ``` aws autoscaling delete-warm-pool \ --auto-scaling-group-name my-asg \ --force-delete ``` Este comando não produz saída. Para obter mais informações, consulte [Pools ativos para o Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html) no *Manual do usuário do Amazon EC2 Auto Scaling*. + Para ver detalhes da API, consulte [DeleteWarmPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/delete-warm-pool.html) na *Referência de comandos da AWS CLI*. ### `describe-account-limits` O código de exemplo a seguir mostra como usar `describe-account-limits`. **AWS CLI** **Para descrever os limites de sua conta do Amazon EC2 Auto Scaling** Este exemplo descreve os limites do Amazon EC2 Auto Scaling para sua conta da AWS. ``` aws autoscaling describe-account-limits ``` Resultado: ``` { "NumberOfLaunchConfigurations": 5, "MaxNumberOfLaunchConfigurations": 100, "NumberOfAutoScalingGroups": 3, "MaxNumberOfAutoScalingGroups": 20 } ``` Para obter mais informações, consulte [Service quotas do Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Para ver detalhes da API, consulte [DescribeAccountLimits](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-account-limits.html) na *Referência de comandos da AWS CLI*. ### `describe-adjustment-types` O código de exemplo a seguir mostra como usar `describe-adjustment-types`. **AWS CLI** **Para descrever os tipos de ajuste de escala disponíveis** Este exemplo descreve os tipos de ajuste disponíveis. ``` aws autoscaling describe-adjustment-types ``` Resultado: ``` { "AdjustmentTypes": [ { "AdjustmentType": "ChangeInCapacity" }, { "AdjustmentType": "ExactCapacity" }, { "AdjustmentType": "PercentChangeInCapacity" } ] } ``` Para obter mais informações, consulte [Tipos de ajuste da escalabilidade](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Para ver detalhes da API, consulte [DescribeAdjustmentTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-adjustment-types.html) na *Referência de comandos da AWS CLI*. ### `describe-auto-scaling-groups` O código de exemplo a seguir mostra como usar `describe-auto-scaling-groups`. **AWS CLI** **Exemplo 1: como descrever o grupo do Auto Scaling especificado** Este exemplo descreve o grupo do Auto Scaling especificado. ``` aws autoscaling describe-auto-scaling-groups \ --auto-scaling-group-names my-asg ``` Resultado: ``` { "AutoScalingGroups": [ { "AutoScalingGroupName": "my-asg", "AutoScalingGroupARN": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:930d940e-891e-4781-a11a-7b0acd480f03:autoScalingGroupName/my-asg", "LaunchTemplate": { "LaunchTemplateName": "my-launch-template", "Version": "1", "LaunchTemplateId": "lt-1234567890abcde12" }, "MinSize": 0, "MaxSize": 1, "DesiredCapacity": 1, "DefaultCooldown": 300, "AvailabilityZones": [ "us-west-2a", "us-west-2b", "us-west-2c" ], "LoadBalancerNames": [], "TargetGroupARNs": [], "HealthCheckType": "EC2", "HealthCheckGracePeriod": 0, "Instances": [ { "InstanceId": "i-06905f55584de02da", "InstanceType": "t2.micro", "AvailabilityZone": "us-west-2a", "HealthStatus": "Healthy", "LifecycleState": "InService", "ProtectedFromScaleIn": false, "LaunchTemplate": { "LaunchTemplateName": "my-launch-template", "Version": "1", "LaunchTemplateId": "lt-1234567890abcde12" } } ], "CreatedTime": "2023-10-28T02:39:22.152Z", "SuspendedProcesses": [], "VPCZoneIdentifier": "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782", "EnabledMetrics": [], "Tags": [], "TerminationPolicies": [ "Default" ], "NewInstancesProtectedFromScaleIn": false, "ServiceLinkedRoleARN":"arn", "TrafficSources": [] } ] } ``` **Exemplo 2: como descrever os primeiros 100 grupos do Auto Scaling especificados** Este exemplo descreve os grupos do Auto Scaling especificados. Ele permite especificar até cem nomes de grupos. ``` aws autoscaling describe-auto-scaling-groups \ --max-items 100 \ --auto-scaling-group-names "group1" "group2" "group3" "group4" ``` Consulte uma amostra de saída no exemplo 1. **Exemplo 3: como descrever um grupo do Auto Scaling na região especificada** Este exemplo descreve até 75 grupos do Auto Scaling na região especificada. ``` aws autoscaling describe-auto-scaling-groups \ --max-items 75 \ --region us-east-1 ``` Consulte um exemplo de saída no exemplo 1. **Exemplo 4: como descrever o número especificado do grupo do Auto Scaling** Use a opção `--max-items` para retornar um número específico de grupos do Auto Scaling. ``` aws autoscaling describe-auto-scaling-groups \ --max-items 1 ``` Consulte um exemplo de saída no exemplo 1. Se a saída incluir um campo `NextToken`, há mais grupos. Para obter os grupos adicionais, use o valor desse campo com a opção `--starting-token` em uma chamada subsequente da seguinte maneira. ``` aws autoscaling describe-auto-scaling-groups \ --starting-token Z3M3LMPEXAMPLE ``` Consulte um exemplo de saída no exemplo 1. **Exemplo 5: descrever grupos do Auto Scaling que usam configurações de execução** Este exemplo usa a opção `--query` para descrever os grupos do Auto Scaling que usam configurações de execução. ``` aws autoscaling describe-auto-scaling-groups \ --query 'AutoScalingGroups[?LaunchConfigurationName!=`null`]' ``` Resultado: ``` [ { "AutoScalingGroupName": "my-asg", "AutoScalingGroupARN": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:930d940e-891e-4781-a11a-7b0acd480f03:autoScalingGroupName/my-asg", "LaunchConfigurationName": "my-lc", "MinSize": 0, "MaxSize": 1, "DesiredCapacity": 1, "DefaultCooldown": 300, "AvailabilityZones": [ "us-west-2a", "us-west-2b", "us-west-2c" ], "LoadBalancerNames": [], "TargetGroupARNs": [], "HealthCheckType": "EC2", "HealthCheckGracePeriod": 0, "Instances": [ { "InstanceId": "i-088c57934a6449037", "InstanceType": "t2.micro", "AvailabilityZone": "us-west-2c", "HealthStatus": "Healthy", "LifecycleState": "InService", "LaunchConfigurationName": "my-lc", "ProtectedFromScaleIn": false } ], "CreatedTime": "2023-10-28T02:39:22.152Z", "SuspendedProcesses": [], "VPCZoneIdentifier": "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782", "EnabledMetrics": [], "Tags": [], "TerminationPolicies": [ "Default" ], "NewInstancesProtectedFromScaleIn": false, "ServiceLinkedRoleARN":"arn", "TrafficSources": [] } ] ``` Para obter mais informações, consulte [Filtrar a saída da AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html) no *Guia do usuário da AWS Command Line Interface*. + Consulte detalhes da API em [DescribeAutoScalingGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-auto-scaling-groups.html) na *Referência de comandos AWS CLI*. ### `describe-auto-scaling-instances` O código de exemplo a seguir mostra como usar `describe-auto-scaling-instances`. **AWS CLI** **Exemplo 1: como descrever uma ou mais instâncias** Este exemplo descreve a instância especificada. ``` aws autoscaling describe-auto-scaling-instances \ --instance-ids i-06905f55584de02da ``` Resultado: ``` { "AutoScalingInstances": [ { "InstanceId": "i-06905f55584de02da", "InstanceType": "t2.micro", "AutoScalingGroupName": "my-asg", "AvailabilityZone": "us-west-2b", "LifecycleState": "InService", "HealthStatus": "HEALTHY", "ProtectedFromScaleIn": false, "LaunchTemplate": { "LaunchTemplateId": "lt-1234567890abcde12", "LaunchTemplateName": "my-launch-template", "Version": "1" } } ] } ``` **Exemplo 2: como descrever uma ou mais instâncias** Este exemplo usa a opção `--max-items` para especificar quantas instâncias devem ser retornadas pela chamada. ``` aws autoscaling describe-auto-scaling-instances \ --max-items 1 ``` Se a saída incluir um campo `NextToken`, há mais instâncias. Para obter as instâncias adicionais, use o valor desse campo com a opção `--starting-token` em uma chamada subsequente da seguinte maneira. ``` aws autoscaling describe-auto-scaling-instances \ --starting-token Z3M3LMPEXAMPLE ``` Consulte uma amostra de saída no exemplo 1. **Exemplo 3: descrever instâncias que usam configurações de execução** Este exemplo usa a opção `--query` para descrever instâncias que usam configurações de execução. ``` aws autoscaling describe-auto-scaling-instances \ --query 'AutoScalingInstances[?LaunchConfigurationName!=`null`]' ``` Resultado: ``` [ { "InstanceId": "i-088c57934a6449037", "InstanceType": "t2.micro", "AutoScalingGroupName": "my-asg", "AvailabilityZone": "us-west-2c", "LifecycleState": "InService", "HealthStatus": "HEALTHY", "LaunchConfigurationName": "my-lc", "ProtectedFromScaleIn": false } ] ``` Para obter mais informações, consulte [Filtrar a saída da AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html) no *Guia do usuário da AWS Command Line Interface*. + Consulte detalhes da API em [DescribeAutoScalingInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-auto-scaling-instances.html) na *Referência de comandos AWS CLI*. ### `describe-auto-scaling-notification-types` O código de exemplo a seguir mostra como usar `describe-auto-scaling-notification-types`. **AWS CLI** **Para descrever os tipos de notificação disponíveis** Este exemplo descreve os tipos de notificação disponíveis. ``` aws autoscaling describe-auto-scaling-notification-types ``` Resultado: ``` { "AutoScalingNotificationTypes": [ "autoscaling:EC2_INSTANCE_LAUNCH", "autoscaling:EC2_INSTANCE_LAUNCH_ERROR", "autoscaling:EC2_INSTANCE_TERMINATE", "autoscaling:EC2_INSTANCE_TERMINATE_ERROR", "autoscaling:TEST_NOTIFICATION" ] } ``` Para obter mais informações, consulte [Obter notificações do Amazon SNS quando o grupo de Auto Scaling é dimensionado](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Para ver detalhes da API, consulte [DescribeAutoScalingNotificationTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-auto-scaling-notification-types.html) na *Referência de comandos da AWS CLI*. ### `describe-instance-refreshes` O código de exemplo a seguir mostra como usar `describe-instance-refreshes`. **AWS CLI** **Para descrever atualizações de instâncias** O exemplo `describe-instance-refreshes` a seguir retorna uma descrição de todas as solicitações de atualização de instância para o grupo do Auto Scaling especificado, incluindo a mensagem de status e (se disponível) o motivo do status. ``` aws autoscaling describe-instance-refreshes \ --auto-scaling-group-name my-asg ``` Resultado: ``` { "InstanceRefreshes": [ { "InstanceRefreshId": "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b", "AutoScalingGroupName": "my-asg", "Status": "InProgress", "StatusReason": "Waiting for instances to warm up before continuing. For example: 0e69cc3f05f825f4f is warming up.", "EndTime": "2023-03-23T16:42:55Z", "PercentageComplete": 0, "InstancesToUpdate": 0, "Preferences": { "MinHealthyPercentage": 100, "InstanceWarmup": 300, "CheckpointPercentages": [ 50 ], "CheckpointDelay": 3600, "SkipMatching": false, "AutoRollback": true, "ScaleInProtectedInstances": "Ignore", "StandbyInstances": "Ignore" } }, { "InstanceRefreshId": "dd7728d0-5bc4-4575-96a3-1b2c52bf8bb1", "AutoScalingGroupName": "my-asg", "Status": "Successful", "EndTime": "2022-06-02T16:53:37Z", "PercentageComplete": 100, "InstancesToUpdate": 0, "Preferences": { "MinHealthyPercentage": 90, "InstanceWarmup": 300, "SkipMatching": true, "AutoRollback": true, "ScaleInProtectedInstances": "Ignore", "StandbyInstances": "Ignore" } } ] } ``` Para obter mais informações, consulte [Verificar o status de uma atualização de instância](https://docs.aws.amazon.com/en_us/autoscaling/ec2/userguide/check-status-instance-refresh.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Para ver detalhes da API, consulte [DescribeInstanceRefreshes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-instance-refreshes.html) na *Referência de comandos da AWS CLI*. ### `describe-launch-configurations` O código de exemplo a seguir mostra como usar `describe-launch-configurations`. **AWS CLI** **Exemplo 1: descrever a configuração de execução especificada** Este exemplo descreve a configuração de execução especificada. ``` aws autoscaling describe-launch-configurations \ --launch-configuration-names my-launch-config ``` Resultado: ``` { "LaunchConfigurations": [ { "LaunchConfigurationName": "my-launch-config", "LaunchConfigurationARN": "arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:98d3b196-4cf9-4e88-8ca1-8547c24ced8b:launchConfigurationName/my-launch-config", "ImageId": "ami-0528a5175983e7f28", "KeyName": "my-key-pair-uswest2", "SecurityGroups": [ "sg-05eaec502fcdadc2e" ], "ClassicLinkVPCSecurityGroups": [], "UserData": "", "InstanceType": "t2.micro", "KernelId": "", "RamdiskId": "", "BlockDeviceMappings": [ { "DeviceName": "/dev/xvda", "Ebs": { "SnapshotId": "snap-06c1606ba5ca274b1", "VolumeSize": 8, "VolumeType": "gp2", "DeleteOnTermination": true, "Encrypted": false } } ], "InstanceMonitoring": { "Enabled": true }, "CreatedTime": "2020-10-28T02:39:22.321Z", "EbsOptimized": false, "AssociatePublicIpAddress": true, "MetadataOptions": { "HttpTokens": "required", "HttpPutResponseHopLimit": 1, "HttpEndpoint": "disabled" } } ] } ``` **Exemplo 2: descrever um número especificado de configurações de execução** Para retornar um número específico de configurações de execução, use a opção `--max-items`. ``` aws autoscaling describe-launch-configurations \ --max-items 1 ``` Se a saída incluir um campo `NextToken`, há mais configurações de execução. Para obter as configurações de execução adicionais, use o valor desse campo com a opção `--starting-token` em uma chamada subsequente da seguinte maneira. ``` aws autoscaling describe-launch-configurations \ --starting-token Z3M3LMPEXAMPLE ``` + Para ver detalhes da API, consulte [DescribeLaunchConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-launch-configurations.html) na *Referência de comandos da AWS CLI*. ### `describe-lifecycle-hook-types` O código de exemplo a seguir mostra como usar `describe-lifecycle-hook-types`. **AWS CLI** **Para descrever os tipos de ganchos do ciclo de vida disponíveis** Este exemplo descreve os tipos de ganchos do ciclo de vida disponíveis. ``` aws autoscaling describe-lifecycle-hook-types ``` Resultado: ``` { "LifecycleHookTypes": [ "autoscaling:EC2_INSTANCE_LAUNCHING", "autoscaling:EC2_INSTANCE_TERMINATING" ] } ``` + Para ver detalhes da API, consulte [DescribeLifecycleHookTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-lifecycle-hook-types.html) na *Referência de comandos da AWS CLI*. ### `describe-lifecycle-hooks` O código de exemplo a seguir mostra como usar `describe-lifecycle-hooks`. **AWS CLI** **Para descrever seus ganchos do ciclo de vida** Este exemplo descreve os ganchos do ciclo de vida do grupo do Auto Scaling especificado. ``` aws autoscaling describe-lifecycle-hooks \ --auto-scaling-group-name my-asg ``` Resultado: ``` { "LifecycleHooks": [ { "GlobalTimeout": 3000, "HeartbeatTimeout": 30, "AutoScalingGroupName": "my-asg", "LifecycleHookName": "my-launch-hook", "DefaultResult": "ABANDON", "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING" }, { "GlobalTimeout": 6000, "HeartbeatTimeout": 60, "AutoScalingGroupName": "my-asg", "LifecycleHookName": "my-termination-hook", "DefaultResult": "CONTINUE", "LifecycleTransition": "autoscaling:EC2_INSTANCE_TERMINATING" } ] } ``` + Para ver detalhes da API, consulte [DescribeLifecycleHooks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-lifecycle-hooks.html) na *Referência de comandos da AWS CLI*. ### `describe-load-balancer-target-groups` O código de exemplo a seguir mostra como usar `describe-load-balancer-target-groups`. **AWS CLI** **Para descrever os grupos-alvo do balanceador de carga para um grupo do Auto Scaling** Este exemplo descreve os grupos de destino do balanceador de carga anexados ao grupo do Auto Scaling especificado. ``` aws autoscaling describe-load-balancer-target-groups \ --auto-scaling-group-name my-asg ``` Resultado: ``` { "LoadBalancerTargetGroups": [ { "LoadBalancerTargetGroupARN": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", "State": "Added" } ] } ``` + Para ver detalhes da API, consulte [DescribeLoadBalancerTargetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-load-balancer-target-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-load-balancers` O código de exemplo a seguir mostra como usar `describe-load-balancers`. **AWS CLI** **Para descrever os Classic Load Balancers de um grupo do Auto Scaling** Esse exemplo descreve os load balancers clássicos do grupo de Auto Scaling especificado. ``` aws autoscaling describe-load-balancers \ --auto-scaling-group-name my-asg ``` Resultado: ``` { "LoadBalancers": [ { "State": "Added", "LoadBalancerName": "my-load-balancer" } ] } ``` + Consulte detalhes da API em [DescribeLoadBalancers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-load-balancers.html) na *Referência de comandos AWS CLI*. ### `describe-metric-collection-types` O código de exemplo a seguir mostra como usar `describe-metric-collection-types`. **AWS CLI** **Como descrever os tipos de coleta de métricas disponíveis** Este exemplo descreve os tipos de coleta de métricas disponíveis. ``` aws autoscaling describe-metric-collection-types ``` Resultado: ``` { "Metrics": [ { "Metric": "GroupMinSize" }, { "Metric": "GroupMaxSize" }, { "Metric": "GroupDesiredCapacity" }, { "Metric": "GroupInServiceInstances" }, { "Metric": "GroupInServiceCapacity" }, { "Metric": "GroupPendingInstances" }, { "Metric": "GroupPendingCapacity" }, { "Metric": "GroupTerminatingInstances" }, { "Metric": "GroupTerminatingCapacity" }, { "Metric": "GroupStandbyInstances" }, { "Metric": "GroupStandbyCapacity" }, { "Metric": "GroupTotalInstances" }, { "Metric": "GroupTotalCapacity" } ], "Granularities": [ { "Granularity": "1Minute" } ] } ``` Para obter mais informações, consulte [Métricas de grupo do Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html#as-group-metrics) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Consulte detalhes da API em [DescribeMetricCollectionTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-metric-collection-types.html) na *Referência de comandos AWS CLI*. ### `describe-notification-configurations` O código de exemplo a seguir mostra como usar `describe-notification-configurations`. **AWS CLI** **Exemplo 1: Como descrever as configurações de notificação de um grupo especificado** Este exemplo descreve as configurações de notificação do grupo do Auto Scaling especificado. ``` aws autoscaling describe-notification-configurations \ --auto-scaling-group-name my-asg ``` Resultado: ``` { "NotificationConfigurations": [ { "AutoScalingGroupName": "my-asg", "NotificationType": "autoscaling:TEST_NOTIFICATION", "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic-2" }, { "AutoScalingGroupName": "my-asg", "NotificationType": "autoscaling:TEST_NOTIFICATION", "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic" } ] } ``` Para obter mais informações, consulte [Obter notificações do Amazon SNS quando o grupo de Auto Scaling é dimensionado](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. **Exemplo 1: Como descrever um número especificado de configurações de notificação** Para retornar um número especificado de configurações de notificação, use o parâmetro `max-items`. ``` aws autoscaling describe-notification-configurations \ --auto-scaling-group-name my-auto-scaling-group \ --max-items 1 ``` Resultado: ``` { "NotificationConfigurations": [ { "AutoScalingGroupName": "my-asg", "NotificationType": "autoscaling:TEST_NOTIFICATION", "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic-2" }, { "AutoScalingGroupName": "my-asg", "NotificationType": "autoscaling:TEST_NOTIFICATION", "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic" } ] } ``` Se a saída incluir um campo `NextToken`, há mais configurações de notificação. Para obter as notificações adicionais, use o valor desse campo com o parâmetro `starting-token` em uma chamada subsequente da seguinte maneira. ``` aws autoscaling describe-notification-configurations \ --auto-scaling-group-name my-asg \ --starting-token Z3M3LMPEXAMPLE ``` Para obter mais informações, consulte [Obter notificações do Amazon SNS quando o grupo de Auto Scaling é dimensionado](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Consulte detalhes da API em [DescribeNotificationConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-notification-configurations.html) na *Referência de comandos AWS CLI*. ### `describe-policies` O código de exemplo a seguir mostra como usar `describe-policies`. **AWS CLI** **Exemplo 1: como descrever as escalas do Auto Scaling especificado** Este exemplo descreve as politicas de escalabilidade do grupo do Auto Scaling especificado. ``` aws autoscaling describe-policies \ --auto-scaling-group-name my-asg ``` Resultado: ``` { "ScalingPolicies": [ { "AutoScalingGroupName": "my-asg", "PolicyName": "alb1000-target-tracking-scaling-policy", "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:3065d9c8-9969-4bec-bb6a-3fbe5550fde6:autoScalingGroupName/my-asg:policyName/alb1000-target-tracking-scaling-policy", "PolicyType": "TargetTrackingScaling", "StepAdjustments": [], "Alarms": [ { "AlarmName": "TargetTracking-my-asg-AlarmHigh-924887a9-12d7-4e01-8686-6f844d13a196", "AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmHigh-924887a9-12d7-4e01-8686-6f844d13a196" }, { "AlarmName": "TargetTracking-my-asg-AlarmLow-f96f899d-b8e7-4d09-a010-c1aaa35da296", "AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmLow-f96f899d-b8e7-4d09-a010-c1aaa35da296" } ], "TargetTrackingConfiguration": { "PredefinedMetricSpecification": { "PredefinedMetricType": "ALBRequestCountPerTarget", "ResourceLabel": "app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff" }, "TargetValue": 1000.0, "DisableScaleIn": false }, "Enabled": true }, { "AutoScalingGroupName": "my-asg", "PolicyName": "cpu40-target-tracking-scaling-policy", "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:5fd26f71-39d4-4690-82a9-b8515c45cdde:autoScalingGroupName/my-asg:policyName/cpu40-target-tracking-scaling-policy", "PolicyType": "TargetTrackingScaling", "StepAdjustments": [], "Alarms": [ { "AlarmName": "TargetTracking-my-asg-AlarmHigh-139f9789-37b9-42ad-bea5-b5b147d7f473", "AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmHigh-139f9789-37b9-42ad-bea5-b5b147d7f473" }, { "AlarmName": "TargetTracking-my-asg-AlarmLow-bd681c67-fc18-4c56-8468-fb8e413009c9", "AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmLow-bd681c67-fc18-4c56-8468-fb8e413009c9" } ], "TargetTrackingConfiguration": { "PredefinedMetricSpecification": { "PredefinedMetricType": "ASGAverageCPUUtilization" }, "TargetValue": 40.0, "DisableScaleIn": false }, "Enabled": true } ] } ``` Para obter mais informações, consulte [Escalabilidade Dinâmica](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html) no *Manual do usuário do Amazon EC2 Auto Scaling*. **Exemplo 2: Como descrever as políticas de escalabilidade de um nome especificado** Para retornar políticas de escalabilidade específicas, use a opção `--policy-names`. ``` aws autoscaling describe-policies \ --auto-scaling-group-name my-asg \ --policy-names cpu40-target-tracking-scaling-policy ``` Consulte uma amostra de saída no exemplo 1. Para obter mais informações, consulte [Escalabilidade dinâmica](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html) no *Manual do usuário do Amazon EC2 Auto Scaling*. **Exemplo 3: Como descrever várias políticas de escalabilidade** Use a opção `--max-items` para retornar um número específico de politicas. ``` aws autoscaling describe-policies \ --auto-scaling-group-name my-asg \ --max-items 1 ``` Consulte uma amostra de saída no exemplo 1. Se a saída incluir um campo `NextToken`, use o valor desse campo com a opção `--starting-token` em uma chamada subsequente para obter as políticas adicionais. ``` aws autoscaling describe-policies --auto-scaling-group-name my-asg --starting-token Z3M3LMPEXAMPLE ``` Para obter mais informações, consulte [Escalabilidade dinâmica](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html) no *Manual do usuário do Amazon EC2 Auto Scaling*. + Para ver detalhes da API, consulte [DescribePolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-policies.html) na *Referência de comandos da AWS CLI*. ### `describe-scaling-activities` O código de exemplo a seguir mostra como usar `describe-scaling-activities`. **AWS CLI** **Exemplo 1: como descrever as ações de escalabilidade do grupo especificado** Este exemplo descreve as ações de escalabilidade do grupo do Auto Scaling especificado. ``` aws autoscaling describe-scaling-activities \ --auto-scaling-group-name my-asg ``` Resultado: ``` { "Activities": [ { "ActivityId": "f9f2d65b-f1f2-43e7-b46d-d86756459699", "Description": "Launching a new EC2 instance: i-0d44425630326060f", "AutoScalingGroupName": "my-asg", "Cause": "At 2020-10-30T19:35:51Z a user request update of AutoScalingGroup constraints to min: 0, max: 16, desired: 16 changing the desired capacity from 0 to 16. At 2020-10-30T19:36:07Z an instance was started in response to a difference between desired and actual capacity, increasing the capacity from 0 to 16.", "StartTime": "2020-10-30T19:36:09.766Z", "EndTime": "2020-10-30T19:36:41Z", "StatusCode": "Successful", "Progress": 100, "Details": "{\"Subnet ID\":\"subnet-5ea0c127\",\"Availability Zone\":\"us-west-2b\"}" } ] } ``` Para mais informações, consulte [Verificar uma ação de escalabilidade para um grupo do Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-verify-scaling-activity.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. **Exemplo 2: como descrever as ações de escalabilidade de um grupo excluído** Adicione a opção `--include-deleted-groups` para descrever as ações de escalabilidade depois que o grupo do Auto Scaling for excluído. ``` aws autoscaling describe-scaling-activities \ --auto-scaling-group-name my-asg \ --include-deleted-groups ``` Resultado: ``` { "Activities": [ { "ActivityId": "e1f5de0e-f93e-1417-34ac-092a76fba220", "Description": "Launching a new EC2 instance. Status Reason: Your Spot request price of 0.001 is lower than the minimum required Spot request fulfillment price of 0.0031. Launching EC2 instance failed.", "AutoScalingGroupName": "my-asg", "Cause": "At 2021-01-13T20:47:24Z a user request update of AutoScalingGroup constraints to min: 1, max: 5, desired: 3 changing the desired capacity from 0 to 3. At 2021-01-13T20:47:27Z an instance was started in response to a difference between desired and actual capacity, increasing the capacity from 0 to 3.", "StartTime": "2021-01-13T20:47:30.094Z", "EndTime": "2021-01-13T20:47:30Z", "StatusCode": "Failed", "StatusMessage": "Your Spot request price of 0.001 is lower than the minimum required Spot request fulfillment price of 0.0031. Launching EC2 instance failed.", "Progress": 100, "Details": "{\"Subnet ID\":\"subnet-5ea0c127\",\"Availability Zone\":\"us-west-2b\"}", "AutoScalingGroupState": "Deleted", "AutoScalingGroupARN": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:283179a2-f3ce-423d-93f6-66bb518232f7:autoScalingGroupName/my-asg" } ] } ``` Para obter mais informações, consulte [Solucionar problemas do Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/CHAP_Troubleshooting.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. **Exemplo 3: como descrever um número especificado de ações de escalabilidade** Use a opção `--max-items` para retornar um número específico de ações. ``` aws autoscaling describe-scaling-activities \ --max-items 1 ``` Resultado: ``` { "Activities": [ { "ActivityId": "f9f2d65b-f1f2-43e7-b46d-d86756459699", "Description": "Launching a new EC2 instance: i-0d44425630326060f", "AutoScalingGroupName": "my-asg", "Cause": "At 2020-10-30T19:35:51Z a user request update of AutoScalingGroup constraints to min: 0, max: 16, desired: 16 changing the desired capacity from 0 to 16. At 2020-10-30T19:36:07Z an instance was started in response to a difference between desired and actual capacity, increasing the capacity from 0 to 16.", "StartTime": "2020-10-30T19:36:09.766Z", "EndTime": "2020-10-30T19:36:41Z", "StatusCode": "Successful", "Progress": 100, "Details": "{\"Subnet ID\":\"subnet-5ea0c127\",\"Availability Zone\":\"us-west-2b\"}" } ] } ``` Se a saída incluir um campo `NextToken`, há mais ações. Para obter as ações adicionais, use o valor desse campo com a opção `--starting-token` em uma chamada subsequente da seguinte maneira. ``` aws autoscaling describe-scaling-activities \ --starting-token Z3M3LMPEXAMPLE ``` Para mais informações, consulte [Verificar uma ação de escalabilidade para um grupo do Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-verify-scaling-activity.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Consulte detalhes da API em [DescribeScalingActivities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-scaling-activities.html) na *Referência de comandos AWS CLI*. ### `describe-scaling-process-types` O código de exemplo a seguir mostra como usar `describe-scaling-process-types`. **AWS CLI** **Como descrever os tipos de processo disponíveis** Este exemplo descreve os tipos de processo disponíveis. ``` aws autoscaling describe-scaling-process-types ``` Resultado: ``` { "Processes": [ { "ProcessName": "AZRebalance" }, { "ProcessName": "AddToLoadBalancer" }, { "ProcessName": "AlarmNotification" }, { "ProcessName": "HealthCheck" }, { "ProcessName": "InstanceRefresh" }, { "ProcessName": "Launch" }, { "ProcessName": "ReplaceUnhealthy" }, { "ProcessName": "ScheduledActions" }, { "ProcessName": "Terminate" } ] } ``` Para obter mais informações, consulte [Suspensão e retomada dos processos de escalabilidade](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Consulte detalhes da API em [DescribeScalingProcessTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-scaling-process-types.html) na *Referência de comandos AWS CLI*. ### `describe-scheduled-actions` O código de exemplo a seguir mostra como usar `describe-scheduled-actions`. **AWS CLI** **Exemplo 1: Como descrever todas as ações programadas** Este exemplo descreve todas as ações programadas. ``` aws autoscaling describe-scheduled-actions ``` Resultado: ``` { "ScheduledUpdateGroupActions": [ { "AutoScalingGroupName": "my-asg", "ScheduledActionName": "my-recurring-action", "Recurrence": "30 0 1 1,6,12 *", "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-asg:scheduledActionName/my-recurring-action", "StartTime": "2023-12-01T04:00:00Z", "Time": "2023-12-01T04:00:00Z", "MinSize": 1, "MaxSize": 6, "DesiredCapacity": 4, "TimeZone": "America/New_York" } ] } ``` Para obter mais informações, consulte [Escalabilidade programada](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scheduled-scaling.html) no *Manual do usuário do Amazon EC2 Auto Scaling*. **Exemplo 2: Como descrever as ações agendadas do grupo especificado** Para descrever as ações programadas para um grupo do Auto Scaling específico, use a opção `--auto-scaling-group-name`. ``` aws autoscaling describe-scheduled-actions \ --auto-scaling-group-name my-asg ``` Resultado: ``` { "ScheduledUpdateGroupActions": [ { "AutoScalingGroupName": "my-asg", "ScheduledActionName": "my-recurring-action", "Recurrence": "30 0 1 1,6,12 *", "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-asg:scheduledActionName/my-recurring-action", "StartTime": "2023-12-01T04:00:00Z", "Time": "2023-12-01T04:00:00Z", "MinSize": 1, "MaxSize": 6, "DesiredCapacity": 4, "TimeZone": "America/New_York" } ] } ``` Para obter mais informações, consulte [Escalabilidade programada](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scheduled-scaling.html) no *Manual do usuário do Amazon EC2 Auto Scaling*. **Exemplo 3: Como descrever a ação programada especificada** Para descrever uma ação programada específica, use a opção `--scheduled-action-names`. ``` aws autoscaling describe-scheduled-actions \ --scheduled-action-names my-recurring-action ``` Resultado: ``` { "ScheduledUpdateGroupActions": [ { "AutoScalingGroupName": "my-asg", "ScheduledActionName": "my-recurring-action", "Recurrence": "30 0 1 1,6,12 *", "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-asg:scheduledActionName/my-recurring-action", "StartTime": "2023-12-01T04:00:00Z", "Time": "2023-12-01T04:00:00Z", "MinSize": 1, "MaxSize": 6, "DesiredCapacity": 4, "TimeZone": "America/New_York" } ] } ``` Para obter mais informações, consulte [Escalabilidade programada](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scheduled-scaling.html) no *Manual do usuário do Amazon EC2 Auto Scaling*. **Exemplo 4: Como descrever ações programadas com um horário de início especificado** Para descrever as ações programadas que começam em um horário específico, use a opção `--start-time`. ``` aws autoscaling describe-scheduled-actions \ --start-time "2023-12-01T04:00:00Z" ``` Resultado: ``` { "ScheduledUpdateGroupActions": [ { "AutoScalingGroupName": "my-asg", "ScheduledActionName": "my-recurring-action", "Recurrence": "30 0 1 1,6,12 *", "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-asg:scheduledActionName/my-recurring-action", "StartTime": "2023-12-01T04:00:00Z", "Time": "2023-12-01T04:00:00Z", "MinSize": 1, "MaxSize": 6, "DesiredCapacity": 4, "TimeZone": "America/New_York" } ] } ``` Para obter mais informações, consulte [Escalabilidade programada](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scheduled-scaling.html) no *Manual do usuário do Amazon EC2 Auto Scaling*. **Exemplo 5: Como descrever ações programadas que terminam em um horário especificado** Para descrever as ações agendadas que terminam em um horário específico, use a opção `--end-time` . ``` aws autoscaling describe-scheduled-actions \ --end-time "2023-12-01T04:00:00Z" ``` Resultado: ``` { "ScheduledUpdateGroupActions": [ { "AutoScalingGroupName": "my-asg", "ScheduledActionName": "my-recurring-action", "Recurrence": "30 0 1 1,6,12 *", "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-asg:scheduledActionName/my-recurring-action", "StartTime": "2023-12-01T04:00:00Z", "Time": "2023-12-01T04:00:00Z", "MinSize": 1, "MaxSize": 6, "DesiredCapacity": 4, "TimeZone": "America/New_York" } ] } ``` Para obter mais informações, consulte [Escalabilidade programada](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scheduled-scaling.html) no *Manual do usuário do Amazon EC2 Auto Scaling*. **Exemplo 6: como descrever um número especificado de ações agendadas** Use a opção `--max-items` para retornar um número específico de ações agendadas. ``` aws autoscaling describe-scheduled-actions \ --auto-scaling-group-name my-asg \ --max-items 1 ``` Resultado: ``` { "ScheduledUpdateGroupActions": [ { "AutoScalingGroupName": "my-asg", "ScheduledActionName": "my-recurring-action", "Recurrence": "30 0 1 1,6,12 *", "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-asg:scheduledActionName/my-recurring-action", "StartTime": "2023-12-01T04:00:00Z", "Time": "2023-12-01T04:00:00Z", "MinSize": 1, "MaxSize": 6, "DesiredCapacity": 4, "TimeZone": "America/New_York" } ] } ``` Se a saída incluir um campo `NextToken`, há mais ações agendadas. Para obter as ações agendadas, use o valor desse campo com a opção `--starting-token` em uma chamada subsequente da seguinte maneira. ``` aws autoscaling describe-scheduled-actions \ --auto-scaling-group-name my-asg \ --starting-token Z3M3LMPEXAMPLE ``` Para obter mais informações, consulte [Escalabilidade programada](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scheduled-scaling.html) no *Manual do usuário do Amazon EC2 Auto Scaling*. + Consulte detalhes da API em [DescribeScheduledActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-scheduled-actions.html) na *Referência de comandos AWS CLI*. ### `describe-tags` O código de exemplo a seguir mostra como usar `describe-tags`. **AWS CLI** **Como descrever todas as tags** Este exemplo descreve todas as tags. ``` aws autoscaling describe-tags ``` Resultado: ``` { "Tags": [ { "ResourceType": "auto-scaling-group", "ResourceId": "my-asg", "PropagateAtLaunch": true, "Value": "Research", "Key": "Dept" }, { "ResourceType": "auto-scaling-group", "ResourceId": "my-asg", "PropagateAtLaunch": true, "Value": "WebServer", "Key": "Role" } ] } ``` Para obter mais informações, consulte [Marcar instâncias e grupos de Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. **Exemplo 2: Como descrever tags para um grupo especificado** Use a opção para descrever as tags de um grupo do Auto Scaling específico use a opção `--filters`. ``` aws autoscaling describe-tags --filters Name=auto-scaling-group,Values=my-asg ``` Para obter mais informações, consulte [Marcar instâncias e grupos de Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. **Exemplo 3: Para descrever o número específico de tags** Use a opção `--max-items` para retornar um número específico de tags. ``` aws autoscaling describe-tags \ --max-items 1 ``` Se a saída incluir um campo `NextToken`, há mais tags. Para obter os tags adicionais, use o valor desse campo com a opção `--starting-token` em uma chamada subsequente da seguinte maneira. ``` aws autoscaling describe-tags \ --filters Name=auto-scaling-group,Values=my-asg \ --starting-token Z3M3LMPEXAMPLE ``` Para obter mais informações, consulte [Marcar instâncias e grupos de Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Consulte detalhes da API em [DescribeTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-tags.html) na *Referência de comandos AWS CLI*. ### `describe-termination-policy-types` O código de exemplo a seguir mostra como usar `describe-termination-policy-types`. **AWS CLI** **Como descrever os tipos de políticas de encerramento disponíveis** Este exemplo descreve os tipos de políticas de encerramento disponíveis. ``` aws autoscaling describe-termination-policy-types ``` Resultado: ``` { "TerminationPolicyTypes": [ "AllocationStrategy", "ClosestToNextInstanceHour", "Default", "NewestInstance", "OldestInstance", "OldestLaunchConfiguration", "OldestLaunchTemplate" ] } ``` Para obter mais informações, consulte [Controle de quais instâncias do Auto Scaling são terminadas durante a redução da escala horizontalmente](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Consulte detalhes da API em [DescribeTerminationPolicyTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-termination-policy-types.html) na *Referência de comandos AWS CLI*. ### `describe-warm-pool` O código de exemplo a seguir mostra como usar `describe-warm-pool`. **AWS CLI** **Para descrever um grupo de alta atividade** Este exemplo descreve o grupo de alta atividade do grupo do Auto Scaling especificado. ``` aws autoscaling describe-warm-pool \ --auto-scaling-group-name my-asg ``` Resultado: ``` { "WarmPoolConfiguration": { "MinSize": 2, "PoolState": "Stopped" }, "Instances": [ { "InstanceId": "i-070a5bbc7e7f40dc5", "InstanceType": "t2.micro", "AvailabilityZone": "us-west-2c", "LifecycleState": "Warmed:Pending", "HealthStatus": "Healthy", "LaunchTemplate": { "LaunchTemplateId": "lt-00a731f6e9fa48610", "LaunchTemplateName": "my-template-for-auto-scaling", "Version": "6" } }, { "InstanceId": "i-0b52f061814d3bd2d", "InstanceType": "t2.micro", "AvailabilityZone": "us-west-2b", "LifecycleState": "Warmed:Pending", "HealthStatus": "Healthy", "LaunchTemplate": { "LaunchTemplateId": "lt-00a731f6e9fa48610", "LaunchTemplateName": "my-template-for-auto-scaling", "Version": "6" } } ] } ``` Para obter mais informações, consulte [Pools ativos para o Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html) no *Manual do usuário do Amazon EC2 Auto Scaling*. + Para ver detalhes da API, consulte [DescribeWarmPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-warm-pool.html) na *Referência de comandos da AWS CLI*. ### `detach-instances` O código de exemplo a seguir mostra como usar `detach-instances`. **AWS CLI** **Para desvincular uma instância de um grupo do Auto Scaling existente** Este exemplo desvincula a instância especificada do grupo do Auto Scaling especificado. ``` aws autoscaling detach-instances \ --instance-ids i-030017cfa84b20135 \ --auto-scaling-group-name my-asg \ --should-decrement-desired-capacity ``` Resultado: ``` { "Activities": [ { "ActivityId": "5091cb52-547a-47ce-a236-c9ccbc2cb2c9", "AutoScalingGroupName": "my-asg", "Description": "Detaching EC2 instance: i-030017cfa84b20135", "Cause": "At 2020-10-31T17:35:04Z instance i-030017cfa84b20135 was detached in response to a user request, shrinking the capacity from 2 to 1.", "StartTime": "2020-04-12T15:02:16.179Z", "StatusCode": "InProgress", "Progress": 50, "Details": "{\"Subnet ID\":\"subnet-6194ea3b\",\"Availability Zone\":\"us-west-2c\"}" } ] } ``` + Para ver detalhes da API, consulte [DetachInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/detach-instances.html) na *Referência de comandos da AWS CLI*. ### `detach-load-balancer-target-groups` O código de exemplo a seguir mostra como usar `detach-load-balancer-target-groups`. **AWS CLI** **Como desvincular um grupo de destino do balanceador de carga de um grupo do Auto Scaling** Este exemplo desvincula o grupo de destino do balanceador de carga especificado ao grupo do Auto Scaling especificado. ``` aws autoscaling detach-load-balancer-target-groups \ --auto-scaling-group-name my-asg \ --target-group-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 ``` Este comando não produz saída Para obter mais informações, consulte [Anexar um balanceador de carga ao seu grupo Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-load-balancer-asg.html) no *Guia do Usuário do Amazon EC2 Auto Scaling*. + Para ver detalhes da API, consulte [DetachLoadBalancerTargetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/detach-load-balancer-target-groups.html) na *Referência de comandos da AWS CLI*. ### `detach-load-balancers` O código de exemplo a seguir mostra como usar `detach-load-balancers`. **AWS CLI** **Como desvincula um Classic Load Balancer de um grupo do Auto Scaling** Este exemplo desvincula o Classic Load Balancer especificado do grupo do Auto Scaling especificado. ``` aws autoscaling detach-load-balancers \ --load-balancer-names my-load-balancer \ --auto-scaling-group-name my-asg ``` Este comando não produz saída. Para obter mais informações, consulte [Anexar um balanceador de carga ao seu grupo Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-load-balancer-asg.html) no *Guia do Usuário do Amazon EC2 Auto Scaling*. + Consulte detalhes da API em [DetachLoadBalancers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/detach-load-balancers.html) na *Referência de comandos AWS CLI*. ### `disable-metrics-collection` O código de exemplo a seguir mostra como usar `disable-metrics-collection`. **AWS CLI** **Como desabilitar a coleta de métricas de um grupo do Auto Scaling** Este exemplo desativa a coleta da métrica `GroupDesiredCapacity` do grupo do Auto Scaling especificado. ``` aws autoscaling disable-metrics-collection \ --auto-scaling-group-name my-asg \ --metrics GroupDesiredCapacity ``` Este comando não produz saída. Para obter mais informações, consulte [Monitorar métricas do CloudWatch para grupos de Auto Scaling e instâncias](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Consulte detalhes da API em [DisableMetricsCollection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/disable-metrics-collection.html) na *Referência de comandos AWS CLI*. ### `enable-metrics-collection` O código de exemplo a seguir mostra como usar `enable-metrics-collection`. **AWS CLI** **Exemplo 1: como habilitar a coleta de métricas do grupo do Auto Scaling** Este exemplo habilita a coleta de dados do grupo do Auto Scaling especificado. ``` aws autoscaling enable-metrics-collection \ --auto-scaling-group-name my-asg \ --granularity "1Minute" ``` Este comando não produz saída. Para obter mais informações, consulte [Monitorar métricas do CloudWatch para grupos de Auto Scaling e instâncias](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. **Exemplo 2: como coletar dados da métrica especificada de um grupo de Auto Scaling** Use a opção `--metrics` para coletar dados de uma métrica específica. ``` aws autoscaling enable-metrics-collection \ --auto-scaling-group-name my-asg \ --metrics GroupDesiredCapacity --granularity "1Minute" ``` Este comando não produz saída. Para obter mais informações, consulte [Monitorar métricas do CloudWatch para grupos de Auto Scaling e instâncias](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Consulte detalhes da API em [EnableMetricsCollection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/enable-metrics-collection.html) na *Referência de comandos AWS CLI*. ### `enter-standby` O código de exemplo a seguir mostra como usar `enter-standby`. **AWS CLI** **Como colocar instâncias no modo de espera** Este exemplo coloca a instância especificada no modo de espera. Isso é útil para atualizar ou solucionar problemas de uma instância que está atualmente em serviço. ``` aws autoscaling enter-standby \ --instance-ids i-061c63c5eb45f0416 \ --auto-scaling-group-name my-asg \ --should-decrement-desired-capacity ``` Resultado: ``` { "Activities": [ { "ActivityId": "ffa056b4-6ed3-41ba-ae7c-249dfae6eba1", "AutoScalingGroupName": "my-asg", "Description": "Moving EC2 instance to Standby: i-061c63c5eb45f0416", "Cause": "At 2020-10-31T20:31:00Z instance i-061c63c5eb45f0416 was moved to standby in response to a user request, shrinking the capacity from 1 to 0.", "StartTime": "2020-10-31T20:31:00.949Z", "StatusCode": "InProgress", "Progress": 50, "Details": "{\"Subnet ID\":\"subnet-6194ea3b\",\"Availability Zone\":\"us-west-2c\"}" } ] } ``` Para obter mais informações, consulte [Amazon EC2 Auto Scaling instância de ciclo de vida](https://docs.aws.amazon.com/autoscaling/ec2/userguide/detach-instance-asg.html) no *Manual do usuário do Amazon EC2 Auto Scaling*. + Consulte detalhes da API em [EnterStandby](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/enter-standby.html) na *Referência de comandos AWS CLI*. ### `execute-policy` O código de exemplo a seguir mostra como usar `execute-policy`. **AWS CLI** **Como executar uma política de escalabilidade** Este exemplo executa a política de escalabilidade chamada `my-step-scale-out-policy` para o grupo do Auto Scaling especificado. ``` aws autoscaling execute-policy \ --auto-scaling-group-name my-asg \ --policy-name my-step-scale-out-policy \ --metric-value 95 \ --breach-threshold 80 ``` Este comando não produz saída. Para mais informações, consulte as [políticas de escalonamento por passos e escalonamento simples](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html) no *Guia do Usuário de Amazon EC2 Auto Scaling*. + Consulte detalhes da API em [ExecutePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/execute-policy.html) na *Referência de comandos AWS CLI*. ### `exit-standby` O código de exemplo a seguir mostra como usar `exit-standby`. **AWS CLI** **Como tirar instâncias do modo de espera** Esse exemplo move a instância especificada para fora do modo em espera. ``` aws autoscaling exit-standby \ --instance-ids i-061c63c5eb45f0416 \ --auto-scaling-group-name my-asg ``` Resultado: ``` { "Activities": [ { "ActivityId": "142928e1-a2dc-453a-9b24-b85ad6735928", "AutoScalingGroupName": "my-asg", "Description": "Moving EC2 instance out of Standby: i-061c63c5eb45f0416", "Cause": "At 2020-10-31T20:32:50Z instance i-061c63c5eb45f0416 was moved out of standby in response to a user request, increasing the capacity from 0 to 1.", "StartTime": "2020-10-31T20:32:50.222Z", "StatusCode": "PreInService", "Progress": 30, "Details": "{\"Subnet ID\":\"subnet-6194ea3b\",\"Availability Zone\":\"us-west-2c\"}" } ] } ``` Para obter mais informações, consulte [Desvincular temporariamente instâncias do grupo do Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enter-exit-standby.html) no *Manual do usuário do Amazon EC2 Auto Scaling*. + Consulte detalhes da API em [ExitStandby](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/exit-standby.html) na *Referência de comandos AWS CLI*. ### `put-lifecycle-hook` O código de exemplo a seguir mostra como usar `put-lifecycle-hook`. **AWS CLI** **Exemplo 1: Como criar um gancho do ciclo de vida** Este exemplo cria um gancho do ciclo de vida que será invocado em qualquer instância recém-iniciada, com um tempo limite de 4800 segundos. Isso é útil para manter as instâncias em um estado de espera até que os scripts de dados do usuário terminem ou para invocar uma função do AWS Lambda usando o EventBridge. ``` aws autoscaling put-lifecycle-hook \ --auto-scaling-group-name my-asg \ --lifecycle-hook-name my-launch-hook \ --lifecycle-transition autoscaling:EC2_INSTANCE_LAUNCHING \ --heartbeat-timeout 4800 ``` Este comando não produz saída. Se já existir um gancho do ciclo de vida com o mesmo nome, ele será substituído pelo novo gancho do ciclo de vida. Para obter mais informações, consulte [Ganchos do ciclo de vida do Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) no *Manual do usuário do Amazon EC2 Auto Scaling*. **Exemplo 2: Como enviar uma mensagem de e-mail do Amazon SNS para notificar sobre as transições de estado da instância** Este exemplo cria um gancho do ciclo de vida com o tópico do Amazon SNS e o perfil do IAM a serem usados para receber notificações na execução da instância. ``` aws autoscaling put-lifecycle-hook \ --auto-scaling-group-name my-asg \ --lifecycle-hook-name my-launch-hook \ --lifecycle-transition autoscaling:EC2_INSTANCE_LAUNCHING \ --notification-target-arn arn:aws:sns:us-west-2:123456789012:my-sns-topic \ --role-arn arn:aws:iam::123456789012:role/my-auto-scaling-role ``` Este comando não produz saída. Para obter mais informações, consulte [Ganchos do ciclo de vida do Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) no *Manual do usuário do Amazon EC2 Auto Scaling*. **Exemplo 3: Como publicar uma mensagem em uma fila do Amazon SQS** Este exemplo cria um gancho do ciclo de vida que publica uma mensagem com metadados na fila especificada do Amazon SQS. ``` aws autoscaling put-lifecycle-hook \ --auto-scaling-group-name my-asg \ --lifecycle-hook-name my-launch-hook \ --lifecycle-transition autoscaling:EC2_INSTANCE_LAUNCHING \ --notification-target-arn arn:aws:sqs:us-west-2:123456789012:my-sqs-queue \ --role-arn arn:aws:iam::123456789012:role/my-notification-role \ --notification-metadata "SQS message metadata" ``` Este comando não produz saída. Para obter mais informações, consulte [Ganchos do ciclo de vida do Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) no *Manual do usuário do Amazon EC2 Auto Scaling*. + Consulte detalhes da API em [PutLifecycleHook](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/put-lifecycle-hook.html) na *Referência de comandos AWS CLI*. ### `put-notification-configuration` O código de exemplo a seguir mostra como usar `put-notification-configuration`. **AWS CLI** **Para adicionar uma notificação** Este exemplo adiciona o grupo de destino especificado ao grupo do Auto Scaling especificado. ``` aws autoscaling put-notification-configuration \ --auto-scaling-group-name my-asg \ --topic-arn arn:aws:sns:us-west-2:123456789012:my-sns-topic \ --notification-type autoscaling:TEST_NOTIFICATION ``` Este comando não produz saída. Para obter mais informações, consulte [Obter notificações do Amazon SNS quando o grupo de Auto Scaling é dimensionado](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html#as-configure-asg-for-sns) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Para ver detalhes da API, consulte [PutNotificationConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/put-notification-configuration.html) na *Referência de comandos da AWS CLI*. ### `put-scaling-policy` O código de exemplo a seguir mostra como usar `put-scaling-policy`. **AWS CLI** **Para adicionar uma política de escalabilidade com monitoramento do objetivo a um grupo do Auto Scaling** O exemplo `put-scaling-policy` a seguir aplica uma política de escalabilidade de monitoramento de destino ao grupo do Auto Scaling especificado. A saída contém os ARNs e os nomes dos dois alarmes do CloudWatch criados em seu nome. Se já existir uma política de escalonamento com o mesmo nome, ela será substituída pela nova política de escalonamento. ``` aws autoscaling put-scaling-policy --auto-scaling-group-name my-asg \ --policy-name alb1000-target-tracking-scaling-policy \ --policy-type TargetTrackingScaling \ --target-tracking-configuration file://config.json ``` Conteúdo de `config.json`: ``` { "TargetValue": 1000.0, "PredefinedMetricSpecification": { "PredefinedMetricType": "ALBRequestCountPerTarget", "ResourceLabel": "app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff" } } ``` Resultado: ``` { "PolicyARN": "arn:aws:autoscaling:region:account-id:scalingPolicy:228f02c2-c665-4bfd-aaac-8b04080bea3c:autoScalingGroupName/my-asg:policyName/alb1000-target-tracking-scaling-policy", "Alarms": [ { "AlarmARN": "arn:aws:cloudwatch:region:account-id:alarm:TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e", "AlarmName": "TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e" }, { "AlarmARN": "arn:aws:cloudwatch:region:account-id:alarm:TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2", "AlarmName": "TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2" } ] } ``` Para obter mais exemplos, consulte [Exemplos de políticas de escalabilidade para a AWS Command Line Interface (AWS CLI)](https://docs.aws.amazon.com/autoscaling/ec2/userguide/examples-scaling-policies.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Para ver detalhes da API, consulte [PutScalingPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/put-scaling-policy.html) na *Referência de comandos da AWS CLI*. ### `put-scheduled-update-group-action` O código de exemplo a seguir mostra como usar `put-scheduled-update-group-action`. **AWS CLI** **Exemplo 1: adicionar uma ação programada a um grupo de Auto Scaling** Este exemplo adiciona a ação agendada especificada ao grupo do Auto Scaling especificado. ``` aws autoscaling put-scheduled-update-group-action \ --auto-scaling-group-name my-asg \ --scheduled-action-name my-scheduled-action \ --start-time "2023-05-12T08:00:00Z" \ --min-size 2 \ --max-size 6 \ --desired-capacity 4 ``` Este comando não produz saída. Se uma ação programada com o mesmo nome já existir, ela será substituída pela nova ação programada. Para obter mais exemplos, consulte [Escalabilidade programada](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scheduled-scaling.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. **Exemplo 2: especificar uma programação recorrente** Este exemplo cria uma ação programada para escalar em uma programação recorrente que está programada para ser executada às 00h30 horas nos primeiros dias de janeiro, junho e dezembro de cada ano. ``` aws autoscaling put-scheduled-update-group-action \ --auto-scaling-group-name my-asg \ --scheduled-action-name my-recurring-action \ --recurrence "30 0 1 1,6,12 *" \ --min-size 2 \ --max-size 6 \ --desired-capacity 4 ``` Este comando não produz saída. Se uma ação programada com o mesmo nome já existir, ela será substituída pela nova ação programada. Para obter mais exemplos, consulte [Escalabilidade programada](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scheduled-scaling.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Para ver detalhes da API, consulte [PutScheduledUpdateGroupAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/put-scheduled-update-group-action.html) na *Referência de comandos da AWS CLI*. ### `put-warm-pool` O código de exemplo a seguir mostra como usar `put-warm-pool`. **AWS CLI** **Para criar um grupo de alta atividade** O exemplo a seguir cria um grupo de alta atividade para um grupo do Auto Scaling. ``` aws autoscaling put-warm-pool \ --auto-scaling-group-name my-asg \ --min-size 2 ``` Este comando não produz saída. Se já existir um grupo de alta atividade, ele será atualizado. Para obter mais informações, consulte [Pools ativos para o Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html) no *Manual do usuário do Amazon EC2 Auto Scaling*. + Para ver detalhes da API, consulte [PutWarmPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/put-warm-pool.html) na *Referência de comandos da AWS CLI*. ### `record-lifecycle-action-heartbeat` O código de exemplo a seguir mostra como usar `record-lifecycle-action-heartbeat`. **AWS CLI** **Para registrar a pulsação de uma ação do ciclo de vida** Este exemplo registra uma pulsação da ação do ciclo de vida para manter a instância em um estado pendente. ``` aws autoscaling record-lifecycle-action-heartbeat \ --lifecycle-hook-name my-launch-hook \ --auto-scaling-group-name my-asg \ --lifecycle-action-token bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635 ``` Este comando não produz saída. Para obter mais informações, consulte [Ganchos do ciclo de vida do Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) no *Manual do usuário do Amazon EC2 Auto Scaling*. + Para ver detalhes da API, consulte [RecordLifecycleActionHeartbeat](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/record-lifecycle-action-heartbeat.html) na *Referência de comandos da AWS CLI*. ### `resume-processes` O código de exemplo a seguir mostra como usar `resume-processes`. **AWS CLI** **Como retomar processos suspensos** Este exemplo retoma o processo de escalabilidade suspenso especificado para o grupo do Auto Scaling especificado. ``` aws autoscaling resume-processes \ --auto-scaling-group-name my-asg \ --scaling-processes AlarmNotification ``` Este comando não produz saída. Para obter mais informações, consulte [Suspensão e retomada dos processos de escalabilidade](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Para ver detalhes da API, consulte [ResumeProcesses](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/resume-processes.html) na *Referência de comandos da AWS CLI*. ### `rollback-instance-refresh` O código de exemplo a seguir mostra como usar `rollback-instance-refresh`. **AWS CLI** **Como reverter uma atualização de instância** O exemplo `rollback-instance-refresh` a seguir reverte uma atualização de instância em andamento para o grupo do Auto Scaling especificado. ``` aws autoscaling rollback-instance-refresh \ --auto-scaling-group-name my-asg ``` Resultado: ``` { "InstanceRefreshId": "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b" } ``` Para obter mais informações, consulte [Desfazer alterações com uma reversão](https://docs.aws.amazon.com/autoscaling/ec2/userguide/instance-refresh-rollback.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Para ver detalhes da API, consulte [RollbackInstanceRefresh](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/rollback-instance-refresh.html) na *Referência de comandos da AWS CLI*. ### `set-desired-capacity` O código de exemplo a seguir mostra como usar `set-desired-capacity`. **AWS CLI** **Como definir a capacidade desejada para um grupo do Auto Scaling** Este exemplo define a capacidade desejada para o grupo do Auto Scaling especificado. ``` aws autoscaling set-desired-capacity \ --auto-scaling-group-name my-asg \ --desired-capacity 2 \ --honor-cooldown ``` Esse comando retornará ao prompt, se houver êxito. + Consulte detalhes da API em [SetDesiredCapacity](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/set-desired-capacity.html) na *Referência de comandos AWS CLI*. ### `set-instance-health` O código de exemplo a seguir mostra como usar `set-instance-health`. **AWS CLI** **Como definir o status de integridade de uma instância** Define o status da integridade da instância especificada para `Unhealthy`. ``` aws autoscaling set-instance-health \ --instance-id i-061c63c5eb45f0416 \ --health-status Unhealthy ``` Este comando não produz saída. + Para ver detalhes da API, consulte [SetInstanceHealth](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/set-instance-health.html) na *Referência de comandos da AWS CLI*. ### `set-instance-protection` O código de exemplo a seguir mostra como usar `set-instance-protection`. **AWS CLI** **Exemplo 1: habilitar a configuração de proteção de instância para uma instância** Este exemplo habilita a proteção de instância na a instância especificada. ``` aws autoscaling set-instance-protection \ --instance-ids i-061c63c5eb45f0416 \ --auto-scaling-group-name my-asg --protected-from-scale-in ``` Este comando não produz saída. **Exemplo 2: desativar a configuração de proteção de instância para uma instância** Este exemplo desabilita a proteção de instância na instância especificada. ``` aws autoscaling set-instance-protection \ --instance-ids i-061c63c5eb45f0416 \ --auto-scaling-group-name my-asg \ --no-protected-from-scale-in ``` Este comando não produz saída. + Para ver detalhes da API, consulte [SetInstanceProtection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/set-instance-protection.html) na *Referência de comandos da AWS CLI*. ### `start-instance-refresh` O código de exemplo a seguir mostra como usar `start-instance-refresh`. **AWS CLI** **Exemplo 1: iniciar uma atualização de instância usando parâmetros de linha de comando** O exemplo `start-instance-refresh` a seguir inicia uma atualização da instância usando argumentos de linha de comando. O parâmetro opcional `preferences` especifica um `InstanceWarmup` de `60` segundos e um `MinHealthyPercentage` de `50`%. ``` aws autoscaling start-instance-refresh \ --auto-scaling-group-name my-asg \ --preferences '{"InstanceWarmup": 60, "MinHealthyPercentage": 50}' ``` Resultado: ``` { "InstanceRefreshId": "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b" } ``` Para obter mais informações, consulte [Iniciar uma atualização de instância](https://docs.aws.amazon.com/en_us/autoscaling/ec2/userguide/start-instance-refresh.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. **Exemplo 2: iniciar uma atualização de instância usando um arquivo JSON** O exemplo `start-instance-refresh` a seguir inicia uma atualização de instância usando um arquivo JSON. Você pode especificar o grupo do Auto Scaling e definir as configurações e as preferências desejadas em um arquivo JSON, conforme mostrado no exemplo a seguir. ``` aws autoscaling start-instance-refresh \ --cli-input-json file://config.json ``` Conteúdo de `config.json`: ``` { "AutoScalingGroupName": "my-asg", "DesiredConfiguration": { "LaunchTemplate": { "LaunchTemplateId": "lt-068f72b729example", "Version": "$Default" } }, "Preferences": { "InstanceWarmup": 60, "MinHealthyPercentage": 50, "AutoRollback": true, "ScaleInProtectedInstances": Ignore, "StandbyInstances": Terminate } } ``` Resultado: ``` { "InstanceRefreshId": "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b" } ``` Para obter mais informações, consulte [Iniciar uma atualização de instância](https://docs.aws.amazon.com/en_us/autoscaling/ec2/userguide/start-instance-refresh.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Para obter detalhes sobre a API, consulte [StartInstanceRefresh](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/start-instance-refresh.html) na *Referência de comandos da AWS CLI*. ### `suspend-processes` O código de exemplo a seguir mostra como usar `suspend-processes`. **AWS CLI** **Como suspender os processos de ajuste de escala automático** Este exemplo suspende o processo de escalabilidade especificado para o grupo do Auto Scaling especificado. ``` aws autoscaling suspend-processes \ --auto-scaling-group-name my-asg \ --scaling-processes AlarmNotification ``` Este comando não produz saída. Para obter mais informações, consulte [Suspensão e retomada dos processos de escalabilidade](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. + Para ver detalhes da API, consulte [SuspendProcesses](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/suspend-processes.html) na *Referência de comandos da AWS CLI*. ### `terminate-instance-in-auto-scaling-group` O código de exemplo a seguir mostra como usar `terminate-instance-in-auto-scaling-group`. **AWS CLI** **Como encerrar uma instância em um grupo do Auto Scaling** Este exemplo encerra a instância especificada do grupo do Auto Scaling especificado sem atualizar o tamanho do grupo. O Amazon EC2 Auto Scaling executa uma instância de substituição após o encerramento da instância especificada. ``` aws autoscaling terminate-instance-in-auto-scaling-group \ --instance-id i-061c63c5eb45f0416 \ --no-should-decrement-desired-capacity ``` Resultado: ``` { "Activities": [ { "ActivityId": "8c35d601-793c-400c-fcd0-f64a27530df7", "AutoScalingGroupName": "my-asg", "Description": "Terminating EC2 instance: i-061c63c5eb45f0416", "Cause": "", "StartTime": "2020-10-31T20:34:25.680Z", "StatusCode": "InProgress", "Progress": 0, "Details": "{\"Subnet ID\":\"subnet-6194ea3b\",\"Availability Zone\":\"us-west-2c\"}" } ] } ``` + Consulte detalhes da API em [TerminateInstanceInAutoScalingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/terminate-instance-in-auto-scaling-group.html) na *Referência de comandos AWS CLI*. ### `update-auto-scaling-group` O código de exemplo a seguir mostra como usar `update-auto-scaling-group`. **AWS CLI** **Exemplo 1: como atualizar os limites de tamanho de um grupo do Auto Scaling** Este exemplo atualiza o grupo do Auto Scaling especificado com um tamanho mínimo de 2 e máximo de 10. ``` aws autoscaling update-auto-scaling-group \ --auto-scaling-group-name my-asg \ --min-size 2 \ --max-size 10 ``` Este comando não produz saída. Para obter mais informações, consulte [Definir limites de escalabilidade para seu grupo do Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-capacity-limits.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. **Exemplo 2: como adicionar verificações de integridade do Elastic Load Balancing e especificar quais zonas de disponibilidade e sub-redes usar** Este exemplo atualiza o grupo do Auto Scaling especificado para adicionar verificações de integridade do Elastic Load Balancing. Esse comando também atualiza o valor de `--vpc-zone-identifier` com uma lista de IDs de sub-rede em várias zonas de disponibilidade. ``` aws autoscaling update-auto-scaling-group \ --auto-scaling-group-name my-asg \ --health-check-type ELB \ --health-check-grace-period 600 \ --vpc-zone-identifier "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782" ``` Este comando não produz saída. Para obter mais informações, consulte [Elastic Load Balancing e Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. **Exemplo 3: como atualizar o grupo de posicionamento e a política de encerramento** Este exemplo atualiza o grupo de posicionamento e a política de encerramento que devem ser usados. ``` aws autoscaling update-auto-scaling-group \ --auto-scaling-group-name my-asg \ --placement-group my-placement-group \ --termination-policies "OldestInstance" ``` Este comando não produz saída. Para obter mais informações, consulte[ Grupos do Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html) no *Guia do usuário do Amazon EC2 Auto Scaling*. **Exemplo 4: como usar a versão mais recente do modelo de execução** Este exemplo atualiza o grupo do Auto Scaling especificado para que use a versão mais recente do modelo de execução especificado. ``` aws autoscaling update-auto-scaling-group \ --auto-scaling-group-name my-asg \ --launch-template LaunchTemplateId=lt-1234567890abcde12,Version='$Latest' ``` Este comando não produz saída. Para obter mais informações, consulte [Modelos de execução](https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchTemplates.html) no *Manual do usuário do Amazon EC2 Auto Scaling*. **Exemplo 5: como usar uma versão específica do modelo de execução** Este exemplo atualiza o grupo do Auto Scaling especificado para que use uma versão específica do modelo de execução em vez da versão mais recente ou padrão. ``` aws autoscaling update-auto-scaling-group \ --auto-scaling-group-name my-asg \ --launch-template LaunchTemplateName=my-template-for-auto-scaling,Version='2' ``` Este comando não produz saída. Para obter mais informações, consulte [Modelos de execução](https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchTemplates.html) no *Manual do usuário do Amazon EC2 Auto Scaling*. **Exemplo 6: como definir uma política de instâncias mistas e habilitar o rebalanceamento de capacidade** Este exemplo atualiza o grupo do Auto Scaling especificado para que use uma política de instâncias mistas e permita o rebalanceamento de capacidade. Essa estrutura permite especificar grupos com capacidades spot e sob demanda e usar modelos de execução diferentes para arquiteturas diferentes. ``` aws autoscaling update-auto-scaling-group \ --cli-input-json file://~/config.json ``` Conteúdo de `config.json`: ``` { "AutoScalingGroupName": "my-asg", "CapacityRebalance": true, "MixedInstancesPolicy": { "LaunchTemplate": { "LaunchTemplateSpecification": { "LaunchTemplateName": "my-launch-template-for-x86", "Version": "$Latest" }, "Overrides": [ { "InstanceType": "c6g.large", "LaunchTemplateSpecification": { "LaunchTemplateName": "my-launch-template-for-arm", "Version": "$Latest" } }, { "InstanceType": "c5.large" }, { "InstanceType": "c5a.large" } ] }, "InstancesDistribution": { "OnDemandPercentageAboveBaseCapacity": 50, "SpotAllocationStrategy": "capacity-optimized" } } } ``` Este comando não produz saída. Para obter mais informações, consulte [Grupos de Auto Scaling com vários tipos de instância e opções de compra](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html) no *Manual do usuário do Amazon EC2 Auto Scaling*. + Consulte detalhes da API em [UpdateAutoScalingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/update-auto-scaling-group.html) na *Referência de comandos AWS CLI*. # Exemplos de Auto Scaling Plans usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com Auto Scaling Plans. *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 ### `create-scaling-plan` O código de exemplo a seguir mostra como usar `create-scaling-plan`. **AWS CLI** **Para criar um plano de escalabilidade** O exemplo `create-scaling-plan` a seguir cria um plano de escalabilidade chamado `my-scaling-plan` usando um arquivo JSON já criado (chamado config.json). A estrutura do plano de escalabilidade inclui uma instrução de ajuste de escala para um grupo do Auto Scaling chamado `my-asg`. Ele especifica a propriedade `TagFilters` como a origem da aplicação e permite a escalabilidade preditiva e a escalabilidade dinâmica. ``` aws autoscaling-plans create-scaling-plan \ --scaling-plan-name my-scaling-plan \ --cli-input-json file://~/config.json ``` Conteúdo do arquivo `config.json`: ``` { "ApplicationSource": { "TagFilters": [ { "Key": "purpose", "Values": [ "my-application" ] } ] }, "ScalingInstructions": [ { "ServiceNamespace": "autoscaling", "ResourceId": "autoScalingGroup/my-asg", "ScalableDimension": "autoscaling:autoScalingGroup:DesiredCapacity", "ScheduledActionBufferTime": 300, "PredictiveScalingMaxCapacityBehavior": "SetForecastCapacityToMaxCapacity", "PredictiveScalingMode": "ForecastAndScale", "PredefinedLoadMetricSpecification": { "PredefinedLoadMetricType": "ASGTotalCPUUtilization" }, "ScalingPolicyUpdateBehavior": "ReplaceExternalPolicies", "MinCapacity": 1, "MaxCapacity": 4, "TargetTrackingConfigurations": [ { "PredefinedScalingMetricSpecification": { "PredefinedScalingMetricType": "ASGAverageCPUUtilization" }, "TargetValue": 50 } ] } ] } ``` Resultado: ``` { "ScalingPlanVersion": 1 } ``` Para obter mais informações, consulte o [Guia do usuário do AWS Auto Scaling](https://docs.aws.amazon.com/autoscaling/plans/userguide/what-is-aws-auto-scaling.html). + Para ver detalhes da API, consulte [CreateScalingPlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling-plans/create-scaling-plan.html) na *Referência de comandos da AWS CLI*. ### `delete-scaling-plan` O código de exemplo a seguir mostra como usar `delete-scaling-plan`. **AWS CLI** **Para excluir um plano de escalabilidade** O exemplo `delete-scaling-plan` a seguir exclui o plano de escalabilidade especificado. ``` aws autoscaling-plans delete-scaling-plan \ --scaling-plan-name my-scaling-plan \ --scaling-plan-version 1 ``` Este comando não produz saída. Para obter mais informações, consulte o [Guia do usuário do AWS Auto Scaling](https://docs.aws.amazon.com/autoscaling/plans/userguide/what-is-aws-auto-scaling.html). + Para ver detalhes da API, consulte [DeleteScalingPlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling-plans/delete-scaling-plan.html) na *Referência de comandos da AWS CLI*. ### `describe-scaling-plan-resources` O código de exemplo a seguir mostra como usar `describe-scaling-plan-resources`. **AWS CLI** **Para descrever os recursos escaláveis para um plano de escalabilidade** O exemplo `describe-scaling-plan-resources` a seguir exibe detalhes sobre o único recurso escalável (um grupo do Auto Scaling) associado ao plano de escalabilidade especificado. ``` aws autoscaling-plans describe-scaling-plan-resources \ --scaling-plan-name my-scaling-plan \ --scaling-plan-version 1 ``` Resultado: ``` { "ScalingPlanResources": [ { "ScalableDimension": "autoscaling:autoScalingGroup:DesiredCapacity", "ScalingPlanVersion": 1, "ResourceId": "autoScalingGroup/my-asg", "ScalingStatusCode": "Active", "ScalingStatusMessage": "Target tracking scaling policies have been applied to the resource.", "ScalingPolicies": [ { "PolicyName": "AutoScaling-my-asg-b1ab65ae-4be3-4634-bd64-c7471662b251", "PolicyType": "TargetTrackingScaling", "TargetTrackingConfiguration": { "PredefinedScalingMetricSpecification": { "PredefinedScalingMetricType": "ALBRequestCountPerTarget", "ResourceLabel": "app/my-alb/f37c06a68c1748aa/targetgroup/my-target-group/6d4ea56ca2d6a18d" }, "TargetValue": 40.0 } } ], "ServiceNamespace": "autoscaling", "ScalingPlanName": "my-scaling-plan" } ] } ``` Para obter mais informações, consulte [O que é o AWS Auto Scaling?](https://docs.aws.amazon.com/autoscaling/plans/userguide/what-is-aws-auto-scaling.html) no *Guia do usuário do AWS Auto Scaling*. + Para ver detalhes da API, consulte [DescribeScalingPlanResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling-plans/describe-scaling-plan-resources.html) na *Referência de comandos da AWS CLI*. ### `describe-scaling-plans` O código de exemplo a seguir mostra como usar `describe-scaling-plans`. **AWS CLI** **Para descrever um plano de escalabilidade** O exemplo `describe-scaling-plans` a seguir exibe os detalhes do plano de escalabilidade especificado. ``` aws autoscaling-plans describe-scaling-plans \ --scaling-plan-names scaling-plan-with-asg-and-ddb ``` Resultado: ``` { "ScalingPlans": [ { "LastMutatingRequestTime": 1565388443.963, "ScalingPlanVersion": 1, "CreationTime": 1565388443.963, "ScalingInstructions": [ { "ScalingPolicyUpdateBehavior": "ReplaceExternalPolicies", "ScalableDimension": "autoscaling:autoScalingGroup:DesiredCapacity", "TargetTrackingConfigurations": [ { "PredefinedScalingMetricSpecification": { "PredefinedScalingMetricType": "ASGAverageCPUUtilization" }, "TargetValue": 50.0, "EstimatedInstanceWarmup": 300, "DisableScaleIn": false } ], "ResourceId": "autoScalingGroup/my-asg", "DisableDynamicScaling": false, "MinCapacity": 1, "ServiceNamespace": "autoscaling", "MaxCapacity": 10 }, { "ScalingPolicyUpdateBehavior": "ReplaceExternalPolicies", "ScalableDimension": "dynamodb:table:ReadCapacityUnits", "TargetTrackingConfigurations": [ { "PredefinedScalingMetricSpecification": { "PredefinedScalingMetricType": "DynamoDBReadCapacityUtilization" }, "TargetValue": 50.0, "ScaleInCooldown": 60, "DisableScaleIn": false, "ScaleOutCooldown": 60 } ], "ResourceId": "table/my-table", "DisableDynamicScaling": false, "MinCapacity": 5, "ServiceNamespace": "dynamodb", "MaxCapacity": 10000 }, { "ScalingPolicyUpdateBehavior": "ReplaceExternalPolicies", "ScalableDimension": "dynamodb:table:WriteCapacityUnits", "TargetTrackingConfigurations": [ { "PredefinedScalingMetricSpecification": { "PredefinedScalingMetricType": "DynamoDBWriteCapacityUtilization" }, "TargetValue": 50.0, "ScaleInCooldown": 60, "DisableScaleIn": false, "ScaleOutCooldown": 60 } ], "ResourceId": "table/my-table", "DisableDynamicScaling": false, "MinCapacity": 5, "ServiceNamespace": "dynamodb", "MaxCapacity": 10000 } ], "ApplicationSource": { "TagFilters": [ { "Values": [ "my-application-id" ], "Key": "application" } ] }, "StatusStartTime": 1565388455.836, "ScalingPlanName": "scaling-plan-with-asg-and-ddb", "StatusMessage": "Scaling plan has been created and applied to all resources.", "StatusCode": "Active" } ] } ``` Para obter mais informações, consulte [O que é o AWS Auto Scaling?](https://docs.aws.amazon.com/autoscaling/plans/userguide/what-is-aws-auto-scaling.html) no *Guia do usuário do AWS Auto Scaling*. + Para ver detalhes da API, consulte [DescribeScalingPlans](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling-plans/describe-scaling-plans.html) na *Referência de comandos da AWS CLI*. ### `get-scaling-plan-resource-forecast-data` O código de exemplo a seguir mostra como usar `get-scaling-plan-resource-forecast-data`. **AWS CLI** **Para recuperar dados de previsão de carga** Este exemplo recupera dados de previsão de carga de um recurso escalável (um grupo do Auto Scaling) associado ao plano de escalabilidade especificado. ``` aws autoscaling-plans get-scaling-plan-resource-forecast-data \ --scaling-plan-name my-scaling-plan \ --scaling-plan-version 1 \ --service-namespace "autoscaling" \ --resource-id autoScalingGroup/my-asg \ --scalable-dimension "autoscaling:autoScalingGroup:DesiredCapacity" \ --forecast-data-type "LoadForecast" \ --start-time "2019-08-30T00:00:00Z" \ --end-time "2019-09-06T00:00:00Z" ``` Resultado: ``` { "Datapoints": [...] } ``` Para obter mais informações, consulte [O que é o AWS Auto Scaling](https://docs.aws.amazon.com/autoscaling/plans/userguide/what-is-aws-auto-scaling.html) no *Guia do usuário do AWS Auto Scaling*. + Para ver detalhes da API, consulte [GetScalingPlanResourceForecastData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling-plans/get-scaling-plan-resource-forecast-data.html) na *Referência de comandos da AWS CLI*. ### `update-scaling-plan` O código de exemplo a seguir mostra como usar `update-scaling-plan`. **AWS CLI** **Para atualizar um plano de escalabilidade** O exemplo `update-scaling-plan` a seguir modifica a métrica de escalabilidade de um grupo do Auto Scaling no plano de escalabilidade especificado. ``` aws autoscaling-plans update-scaling-plan \ --scaling-plan-name my-scaling-plan \ --scaling-plan-version 1 \ --scaling-instructions '{"ScalableDimension":"autoscaling:autoScalingGroup:DesiredCapacity","ResourceId":"autoScalingGroup/my-asg","ServiceNamespace":"autoscaling","TargetTrackingConfigurations":[{"PredefinedScalingMetricSpecification": {"PredefinedScalingMetricType":"ALBRequestCountPerTarget","ResourceLabel":"app/my-alb/f37c06a68c1748aa/targetgroup/my-target-group/6d4ea56ca2d6a18d"},"TargetValue":40.0}],"MinCapacity": 1,"MaxCapacity": 10}' ``` Este comando não produz saída. Para obter mais informações, consulte [O que é o AWS Auto Scaling?](https://docs.aws.amazon.com/autoscaling/plans/userguide/what-is-aws-auto-scaling.html) no *Guia do usuário do AWS Auto Scaling*. + Para ver detalhes da API, consulte [UpdateScalingPlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling-plans/update-scaling-plan.html) na *Referência de comandos da AWS CLI*. # AWS Backup Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o AWS Backup. *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 ### `create-backup-plan` O código de exemplo a seguir mostra como usar `create-backup-plan`. **AWS CLI** **Para criar um plano de backup** O exemplo `create-backup-plan` a seguir cria o plano de backup especificado com retenção de 35 dias. ``` aws backup create-backup-plan \ --backup-plan "{\"BackupPlanName\":\"Example-Backup-Plan\",\"Rules\":[{\"RuleName\":\"DailyBackups\",\"ScheduleExpression\":\"cron(0 5 ? * * *)\",\"StartWindowMinutes\":480,\"TargetBackupVaultName\":\"Default\",\"Lifecycle\":{\"DeleteAfterDays\":35}}]}" ``` Resultado: ``` { "BackupPlanId": "1fa3895c-a7f5-484a-a371-2dd6a1a9f729", "BackupPlanArn": "arn:aws:backup:us-west-2:123456789012:backup-plan:1fa3895c-a7f5-484a-a371-2dd6a1a9f729", "CreationDate": 1568928754.747, "VersionId": "ZjQ2ZTI5YWQtZDg5Yi00MzYzLWJmZTAtMDI1MzhlMDhjYjEz" } ``` Para obter mais informações, consulte [Criar um plano de backup](https://docs.aws.amazon.com/aws-backup/latest/devguide/creating-a-backup-plan.html) no *Guia do desenvolvedor do AWS Backup*. + Para ver detalhes da API, consulte [CreateBackupPlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/backup/create-backup-plan.html) na *Referência de comandos da AWS CLI*. ### `create-backup-vault` O código de exemplo a seguir mostra como usar `create-backup-vault`. **AWS CLI** **Para criar um cofre de backup** O exemplo `create-backup-vault` a seguir cria um cofre de backup com o nome especificado. ``` aws backup create-backup-vault --backup-vault-name sample-vault ``` Este comando não produz saída. Resultado: ``` { "BackupVaultName": "sample-vault", "BackupVaultArn": "arn:aws:backup:us-west-2:123456789012:backup-vault:sample-vault", "CreationDate": 1568928338.385 } ``` Para obter mais informações, consulte [Criar um cofre de backup](https://docs.aws.amazon.com/aws-backup/latest/devguide/creating-a-vault.html) no *Guia do desenvolvedor do AWS Backup*. + Para ver detalhes da API, consulte [CreateBackupVault](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/backup/create-backup-vault.html) na *Referência de comandos da AWS CLI*. ### `get-backup-plan-from-template` O código de exemplo a seguir mostra como usar `get-backup-plan-from-template`. **AWS CLI** **Para obter um plano de backup existente a partir de um modelo** O exemplo `get-backup-plan-from-template` a seguir obtém um plano de backup existente a partir de um modelo que especifica um backup diário com retenção de 35 dias. ``` aws backup get-backup-plan-from-template \ --backup-plan-template-id "87c0c1ef-254d-4180-8fef-2e76a2c38aaa" ``` Resultado: ``` { "BackupPlanDocument": { "Rules": [ { "RuleName": "DailyBackups", "ScheduleExpression": "cron(0 5 ? * * *)", "StartWindowMinutes": 480, "Lifecycle": { "DeleteAfterDays": 35 } } ] } } ``` Para obter mais informações, consulte [Criar um plano de backup](https://docs.aws.amazon.com/aws-backup/latest/devguide/creating-a-backup-plan.html) no *Guia do desenvolvedor do AWS Backup*. + Para ver detalhes da API, consulte [GetBackupPlanFromTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/backup/get-backup-plan-from-template.html) na *Referência de comandos da AWS CLI*. ### `get-backup-plan` O código de exemplo a seguir mostra como usar `get-backup-plan`. **AWS CLI** **Para obter os detalhes de um plano de backup** O exemplo `get-backup-plan` a seguir exibe os detalhes do plano de backup especificado. ``` aws backup get-backup-plan \ --backup-plan-id "fcbf5d8f-bd77-4f3a-9c97-f24fb3d373a5" ``` Resultado: ``` { "BackupPlan": { "BackupPlanName": "Example-Backup-Plan", "Rules": [ { "RuleName": "DailyBackups", "TargetBackupVaultName": "Default", "ScheduleExpression": "cron(0 5 ? * * *)", "StartWindowMinutes": 480, "CompletionWindowMinutes": 10080, "Lifecycle": { "DeleteAfterDays": 35 }, "RuleId": "70e0ccdc-e9df-4e83-82ad-c1e5a9471cc3" } ] }, "BackupPlanId": "fcbf5d8f-bd77-4f3a-9c97-f24fb3d373a5", "BackupPlanArn": "arn:aws:backup:us-west-2:123456789012:backup-plan:fcbf5d8f-bd77-4f3a-9c97-f24fb3d373a5", "VersionId": "NjQ2ZTZkODktMGVhNy00MmQ0LWE4YjktZTkwNTQ3OTkyYTcw", "CreationDate": 1568926091.57 } ``` Para obter mais informações, consulte [Criar um plano de backup](https://docs.aws.amazon.com/aws-backup/latest/devguide/creating-a-backup-plan.html) no *Guia do desenvolvedor do AWS Backup*. + Para ver detalhes da API, consulte [GetBackupPlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/backup/get-backup-plan.html) na *Referência de comandos da AWS CLI*. ### `list-backup-jobs` O código de exemplo a seguir mostra como usar `list-backup-jobs`. **AWS CLI** **Exemplo 1: listar todas os trabalhos de backup** O exemplo `list-backup-jobs` a seguir retorna metadados sobre seus trabalhos de backup em sua conta da AWS. ``` aws backup list-backup-jobs ``` Resultado: ``` { "BackupJobs": [ { "BackupJobId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "BackupVaultName": "Default", "BackupVaultArn": "arn:aws:backup:us-west-2:123456789012:backup-vault:Default", "ResourceArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-12345678901234567", "CreationDate": 1600721892.929, "State": "CREATED", "PercentDone": "0.0", "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/AWSBackupDefaultServiceRole", "StartBy": 1600725492.929, "ResourceType": "EC2" }, { "BackupJobId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "BackupVaultName": "Default", "BackupVaultArn": "arn:aws:backup:us-west-2:123456789012:backup-vault:Default", "RecoveryPointArn": "arn:aws:backup:us-west-2:123456789012:recovery-point:a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "ResourceArn": "arn:aws:elasticfilesystem:us-west-2:123456789012:file-system/fs-12345678", "CreationDate": 1600721724.77, "CompletionDate": 1600721744.488, "State": "COMPLETED", "PercentDone": "100.0", "BackupSizeInBytes": 71, "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/AWSBackupDefaultServiceRole", "StartBy": 1600725324.77, "ResourceType": "EFS" } ] } ``` Para obter mais informações, consulte [Criar um backup](https://https://docs.aws.amazon.com/aws-backup/latest/devguide/creating-a-backup.html) no *Guia do desenvolvedor do AWS Backup*. **Exemplo 2: listar as tarefas de backup concluídas** O exemplo `list-backup-jobs` a seguir retorna metadados sobre suas tarefas de backup concluídas em sua conta da AWS. ``` aws backup list-backup-jobs \ --by-state COMPLETED ``` Resultado: ``` { "BackupJobs": [ { "BackupJobId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "BackupVaultName": "Default", "BackupVaultArn": "arn:aws:backup:us-west-2:123456789012:backup-vault:Default", "RecoveryPointArn": "arn:aws:backup:us-west-2:123456789012:recovery-point:a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "ResourceArn": "arn:aws:elasticfilesystem:us-west-2:123456789012:file-system/fs-12345678", "CreationDate": 1600721724.77, "CompletionDate": 1600721744.488, "State": "COMPLETED", "PercentDone": "100.0", "BackupSizeInBytes": 71, "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/AWSBackupDefaultServiceRole", "StartBy": 1600725324.77, "ResourceType": "EFS" } ] } ``` Para obter mais informações, consulte [Criar um backup](https://https://docs.aws.amazon.com/aws-backup/latest/devguide/creating-a-backup.html) no *Guia do desenvolvedor do AWS Backup*. + Para ver detalhes da API, consulte [ListBackupJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/backup/list-backup-jobs.html) na *Referência de comandos da AWS CLI*. # AWS Batch Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o AWS Batch. *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 ### `cancel-job` O código de exemplo a seguir mostra como usar `cancel-job`. **AWS CLI** **Para cancelar um trabalho** Este exemplo cancela um trabalho com o ID de trabalho especificado. Comando: ``` aws batch cancel-job --job-id bcf0b186-a532-4122-842e-2ccab8d54efb --reason "Cancelling job." ``` + Para ver detalhes da API, consulte [CancelJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/cancel-job.html) na *Referência de comandos da AWS CLI*. ### `create-compute-environment` O código de exemplo a seguir mostra como usar `create-compute-environment`. **AWS CLI** **Para criar um ambiente computacional gerenciado com instâncias sob demanda** Este exemplo cria um ambiente computacional gerenciado com tipos específicos de instância C4 que são executados sob demanda. O ambiente computacional é chamado de C4OnDemand. Comando: ``` aws batch create-compute-environment --cli-input-json file:///C4OnDemand.json ``` Formato de arquivo JSON: ``` { "computeEnvironmentName": "C4OnDemand", "type": "MANAGED", "state": "ENABLED", "computeResources": { "type": "EC2", "minvCpus": 0, "maxvCpus": 128, "desiredvCpus": 48, "instanceTypes": [ "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge" ], "subnets": [ "subnet-220c0e0a", "subnet-1a95556d", "subnet-978f6dce" ], "securityGroupIds": [ "sg-cf5093b2" ], "ec2KeyPair": "id_rsa", "instanceRole": "ecsInstanceRole", "tags": { "Name": "Batch Instance - C4OnDemand" } }, "serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole" } ``` Resultado: ``` { "computeEnvironmentName": "C4OnDemand", "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand" } ``` **Para criar um ambiente de computação gerenciado com instâncias spot** Este exemplo cria um ambiente de computação gerenciado com o tipo de instância M4 que é executado quando a sugestão de preço do Spot é igual ou inferior a 20% do preço sob demanda do tipo de instância. O ambiente computacional é chamado de M4Spot. Comando: ``` aws batch create-compute-environment --cli-input-json file:///M4Spot.json ``` Formato de arquivo JSON: ``` { "computeEnvironmentName": "M4Spot", "type": "MANAGED", "state": "ENABLED", "computeResources": { "type": "SPOT", "spotIamFleetRole": "arn:aws:iam::012345678910:role/aws-ec2-spot-fleet-role", "minvCpus": 0, "maxvCpus": 128, "desiredvCpus": 4, "instanceTypes": [ "m4" ], "bidPercentage": 20, "subnets": [ "subnet-220c0e0a", "subnet-1a95556d", "subnet-978f6dce" ], "securityGroupIds": [ "sg-cf5093b2" ], "ec2KeyPair": "id_rsa", "instanceRole": "ecsInstanceRole", "tags": { "Name": "Batch Instance - M4Spot" } }, "serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole" } ``` Resultado: ``` { "computeEnvironmentName": "M4Spot", "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/M4Spot" } ``` + Para ver detalhes da API, consulte [CreateComputeEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/create-compute-environment.html) na *Referência de comandos da AWS CLI*. ### `create-job-queue` O código de exemplo a seguir mostra como usar `create-job-queue`. **AWS CLI** **Para criar uma fila de trabalhos de baixa prioridade com um único ambiente computacional** Este exemplo cria uma fila de trabalhos chamada LowPriority que usa o ambiente de computação M4Spot. Comando: ``` aws batch create-job-queue --cli-input-json file:///LowPriority.json ``` Formato de arquivo JSON: ``` { "jobQueueName": "LowPriority", "state": "ENABLED", "priority": 10, "computeEnvironmentOrder": [ { "order": 1, "computeEnvironment": "M4Spot" } ] } ``` Resultado: ``` { "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/LowPriority", "jobQueueName": "LowPriority" } ``` **Para criar uma fila de trabalhos de alta prioridade com dois ambientes computacionais** Este exemplo cria uma fila de trabalhos chamada HighPriority que usa o ambiente de computação C4OnDemand com uma ordem de 1 e o ambiente de computação M4Spot com uma ordem de 2. O programador tentará primeiro colocar trabalhos no ambiente computacional C4OnDemand. Comando: ``` aws batch create-job-queue --cli-input-json file:///HighPriority.json ``` Formato de arquivo JSON: ``` { "jobQueueName": "HighPriority", "state": "ENABLED", "priority": 1, "computeEnvironmentOrder": [ { "order": 1, "computeEnvironment": "C4OnDemand" }, { "order": 2, "computeEnvironment": "M4Spot" } ] } ``` Resultado: ``` { "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority", "jobQueueName": "HighPriority" } ``` + Para ver detalhes da API, consulte [CreateJobQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/create-job-queue.html) na *Referência de comandos da AWS CLI*. ### `delete-compute-environment` O código de exemplo a seguir mostra como usar `delete-compute-environment`. **AWS CLI** **Para excluir um ambiente de computação** Este exemplo exclui o ambiente de computação P2OnDemand. Comando: ``` aws batch delete-compute-environment --compute-environment P2OnDemand ``` + Para ver detalhes da API, consulte [DeleteComputeEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/delete-compute-environment.html) na *Referência de comandos da AWS CLI*. ### `delete-job-queue` O código de exemplo a seguir mostra como usar `delete-job-queue`. **AWS CLI** **Para excluir uma fila de trabalhos** Este exemplo exclui a fila de trabalho GPGPU. Comando: ``` aws batch delete-job-queue --job-queue GPGPU ``` + Para ver detalhes da API, consulte [DeleteJobQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/delete-job-queue.html) na *Referência de comandos da AWS CLI*. ### `deregister-job-definition` O código de exemplo a seguir mostra como usar `deregister-job-definition`. **AWS CLI** **Como cancelar o registro de uma definição de trabalho** Este exemplo cancela o registro de uma definição de trabalho chamada sleep10. Comando: ``` aws batch deregister-job-definition --job-definition sleep10 ``` + Para ver detalhes da API, consulte [DeregisterJobDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/deregister-job-definition.html) na *Referência de comandos da AWS CLI*. ### `describe-compute-environments` O código de exemplo a seguir mostra como usar `describe-compute-environments`. **AWS CLI** **Como descrever um ambiente de computação** Este exemplo descreve o ambiente de computação P2OnDemand. Comando: ``` aws batch describe-compute-environments --compute-environments P2OnDemand ``` Resultado: ``` { "computeEnvironments": [ { "status": "VALID", "serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole", "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand", "computeResources": { "subnets": [ "subnet-220c0e0a", "subnet-1a95556d", "subnet-978f6dce" ], "tags": { "Name": "Batch Instance - P2OnDemand" }, "desiredvCpus": 48, "minvCpus": 0, "instanceTypes": [ "p2" ], "securityGroupIds": [ "sg-cf5093b2" ], "instanceRole": "ecsInstanceRole", "maxvCpus": 128, "type": "EC2", "ec2KeyPair": "id_rsa" }, "statusReason": "ComputeEnvironment Healthy", "ecsClusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/P2OnDemand_Batch_2c06f29d-d1fe-3a49-879d-42394c86effc", "state": "ENABLED", "computeEnvironmentName": "P2OnDemand", "type": "MANAGED" } ] } ``` + Consulte detalhes da API em [DescribeComputeEnvironments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/describe-compute-environments.html) na *Referência de comandos da AWS CLI*. ### `describe-job-definitions` O código de exemplo a seguir mostra como usar `describe-job-definitions`. **AWS CLI** **Para descrever as definições de trabalhos ativos** Este exemplo descreve todas as suas definições de trabalho ativas. Comando: ``` aws batch describe-job-definitions --status ACTIVE ``` Resultado: ``` { "jobDefinitions": [ { "status": "ACTIVE", "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep60:1", "containerProperties": { "mountPoints": [], "parameters": {}, "image": "busybox", "environment": {}, "vcpus": 1, "command": [ "sleep", "60" ], "volumes": [], "memory": 128, "ulimits": [] }, "type": "container", "jobDefinitionName": "sleep60", "revision": 1 } ] } ``` + Para ver detalhes da API, consulte [DescribeJobDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/describe-job-definitions.html) na *Referência de comandos da AWS CLI*. ### `describe-job-queues` O código de exemplo a seguir mostra como usar `describe-job-queues`. **AWS CLI** **Para descrever uma fila de trabalhos** Este exemplo descreve a fila de trabalhos HighPriority. Comando: ``` aws batch describe-job-queues --job-queues HighPriority ``` Resultado: ``` { "jobQueues": [ { "status": "VALID", "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority", "computeEnvironmentOrder": [ { "computeEnvironment": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand", "order": 1 } ], "statusReason": "JobQueue Healthy", "priority": 1, "state": "ENABLED", "jobQueueName": "HighPriority" } ] } ``` + Para ver detalhes da API, consulte [DescribeJobQueues](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/describe-job-queues.html) na *Referência de comandos da AWS CLI*. ### `describe-jobs` O código de exemplo a seguir mostra como usar `describe-jobs`. **AWS CLI** **Para descrever um trabalho** O exemplo `describe-jobs` a seguir descreve um trabalho com o ID de trabalho especificado. ``` aws batch describe-jobs \ --jobs bcf0b186-a532-4122-842e-2ccab8d54efb ``` Resultado: ``` { "jobs": [ { "status": "SUBMITTED", "container": { "mountPoints": [], "image": "busybox", "environment": [], "vcpus": 1, "command": [ "sleep", "60" ], "volumes": [], "memory": 128, "ulimits": [] }, "parameters": {}, "jobDefinition": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep60:1", "jobQueue": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority", "jobId": "bcf0b186-a532-4122-842e-2ccab8d54efb", "dependsOn": [], "jobName": "example", "createdAt": 1480483387803 } ] } ``` + Para ver detalhes da API, consulte [DescribeJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/describe-jobs.html) na *Referência de comandos da AWS CLI*. ### `list-jobs` O código de exemplo a seguir mostra como usar `list-jobs`. **AWS CLI** **Para listar trabalhos em execução** Este exemplo lista os trabalhos em execução na fila de trabalhos HighPriority. Comando: ``` aws batch list-jobs --job-queue HighPriority ``` Resultado: ``` { "jobSummaryList": [ { "jobName": "example", "jobId": "e66ff5fd-a1ff-4640-b1a2-0b0a142f49bb" } ] } ``` **Para listar trabalhos enviados** Este exemplo lista trabalhos na fila de trabalhos HighPriority que estão no status de trabalho ENVIADO. Comando: ``` aws batch list-jobs --job-queue HighPriority --job-status SUBMITTED ``` Resultado: ``` { "jobSummaryList": [ { "jobName": "example", "jobId": "68f0c163-fbd4-44e6-9fd1-25b14a434786" } ] } ``` + Consulte detalhes da API em [ListJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/list-jobs.html) na *Referência de comandos da AWS CLI*. ### `register-job-definition` O código de exemplo a seguir mostra como usar `register-job-definition`. **AWS CLI** **Para registrar uma definição de trabalho** Este exemplo registra uma definição de trabalho para um trabalho de contêiner simples. Comando: ``` aws batch register-job-definition --job-definition-name sleep30 --type container --container-properties '{ "image": "busybox", "vcpus": 1, "memory": 128, "command": [ "sleep", "30"]}' ``` Resultado: ``` { "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep30:1", "jobDefinitionName": "sleep30", "revision": 1 } ``` + Para ver detalhes da API, consulte [RegisterJobDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/register-job-definition.html) na *Referência de comandos da AWS CLI*. ### `submit-job` O código de exemplo a seguir mostra como usar `submit-job`. **AWS CLI** **Como enviar um trabalho** Este exemplo envia um trabalho de contêiner simples chamado example para a fila de trabalhos HighPriority. Comando: ``` aws batch submit-job --job-name example --job-queue HighPriority --job-definition sleep60 ``` Resultado: ``` { "jobName": "example", "jobId": "876da822-4198-45f2-a252-6cea32512ea8" } ``` + Para ver detalhes da API, consulte [SubmitJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/submit-job.html) na *Referência de comandos da AWS CLI*. ### `terminate-job` O código de exemplo a seguir mostra como usar `terminate-job`. **AWS CLI** **Como encerrar um trabalho** Este exemplo encerra um trabalho com o ID de trabalho especificado. Comando: ``` aws batch terminate-job --job-id 61e743ed-35e4-48da-b2de-5c8333821c84 --reason "Terminating job." ``` + Para ver detalhes da API, consulte [TerminateJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/terminate-job.html) na *Referência de comandos da AWS CLI*. ### `update-compute-environment` O código de exemplo a seguir mostra como usar `update-compute-environment`. **AWS CLI** **Para atualizar um ambiente de computação** Este exemplo desabilita o ambiente de computação P2OnDemand para que ele possa ser excluído. Comando: ``` aws batch update-compute-environment --compute-environment P2OnDemand --state DISABLED ``` Resultado: ``` { "computeEnvironmentName": "P2OnDemand", "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand" } ``` + Para ver detalhes da API, consulte [UpdateComputeEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/update-compute-environment.html) na *Referência de comandos da AWS CLI*. ### `update-job-queue` O código de exemplo a seguir mostra como usar `update-job-queue`. **AWS CLI** **Para atualizar uma fila de trabalhos** Este exemplo desabilita uma fila de trabalhos para que ela possa ser excluída. Comando: ``` aws batch update-job-queue --job-queue GPGPU --state DISABLED ``` Resultado: ``` { "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/GPGPU", "jobQueueName": "GPGPU" } ``` + Para ver detalhes da API, consulte [UpdateJobQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/update-job-queue.html) na *Referência de comandos da AWS CLI*. # AWS Budgets Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o 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 ### `create-budget` O código de exemplo a seguir mostra como usar `create-budget`. **AWS CLI** **Para criar um orçamento de custo e uso** O comando `create-budget` a seguir cria um orçamento de custo e uso. ``` aws budgets create-budget \ --account-id 111122223333 \ --budget file://budget.json \ --notifications-with-subscribers file://notifications-with-subscribers.json ``` Conteúdo de `budget.json`: ``` { "BudgetLimit": { "Amount": "100", "Unit": "USD" }, "BudgetName": "Example Tag Budget", "BudgetType": "COST", "CostFilters": { "TagKeyValue": [ "user:Key$value1", "user:Key$value2" ] }, "CostTypes": { "IncludeCredit": true, "IncludeDiscount": true, "IncludeOtherSubscription": true, "IncludeRecurring": true, "IncludeRefund": true, "IncludeSubscription": true, "IncludeSupport": true, "IncludeTax": true, "IncludeUpfront": true, "UseBlended": false }, "TimePeriod": { "Start": 1477958399, "End": 3706473600 }, "TimeUnit": "MONTHLY" } ``` Conteúdo de `notifications-with-subscribers.json`: ``` [ { "Notification": { "ComparisonOperator": "GREATER_THAN", "NotificationType": "ACTUAL", "Threshold": 80, "ThresholdType": "PERCENTAGE" }, "Subscribers": [ { "Address": "example@example.com", "SubscriptionType": "EMAIL" } ] } ] ``` + Para ver detalhes da API, consulte [CreateBudget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/create-budget.html) na *Referência de comandos da AWS CLI*. ### `create-notification` O código de exemplo a seguir mostra como usar `create-notification`. **AWS CLI** **Para criar uma notificação para o orçamento de custo e uso especificado** Este exemplo cria uma notificação para o orçamento de custo e uso especificado. Comando: ``` aws budgets create-notification --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE --subscriber SubscriptionType=EMAIL,Address=example@example.com ``` + Para ver detalhes da API, consulte [CreateNotification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/create-notification.html) na *Referência de comandos da AWS CLI*. ### `create-subscriber` O código de exemplo a seguir mostra como usar `create-subscriber`. **AWS CLI** **Para criar um assinante para uma notificação associada a um orçamento de custo e uso** Este exemplo cria um assinante para a notificação especificada. Comando: ``` aws budgets create-subscriber --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE --subscriber SubscriptionType=EMAIL,Address=example@example.com ``` + Para ver detalhes da API, consulte [CreateSubscriber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/create-subscriber.html) na *Referência de comandos da AWS CLI*. ### `delete-budget` O código de exemplo a seguir mostra como usar `delete-budget`. **AWS CLI** **Para excluir um orçamento de custo e uso** Este exemplo exclui o orçamento de custo e uso especificado. Comando: ``` aws budgets delete-budget --account-id 111122223333 --budget-name "Example Budget" ``` + Para ver detalhes da API, consulte [DeleteBudget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/delete-budget.html) na *Referência de comandos da AWS CLI*. ### `delete-notification` O código de exemplo a seguir mostra como usar `delete-notification`. **AWS CLI** **Para excluir uma notificação de um orçamento** Este exemplo exclui a notificação especificada do orçamento especificado. Comando: ``` aws budgets delete-notification --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE ``` + Para ver detalhes da API, consulte [DeleteNotification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/delete-notification.html) na *Referência de comandos da AWS CLI*. ### `delete-subscriber` O código de exemplo a seguir mostra como usar `delete-subscriber`. **AWS CLI** **Para excluir um assinante de uma notificação** Este exemplo exclui o assinante especificado da notificação especificada. Comando: ``` aws budgets delete-subscriber --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE --subscriber SubscriptionType=EMAIL,Address=example@example.com ``` + Para ver detalhes da API, consulte [DeleteSubscriber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/delete-subscriber.html) na *Referência de comandos da AWS CLI*. ### `describe-budget` O código de exemplo a seguir mostra como usar `describe-budget`. **AWS CLI** **Para recuperar um orçamento associado a uma conta** Este exemplo recupera o orçamento de custo e uso especificado. Comando: ``` aws budgets describe-budget --account-id 111122223333 --budget-name "Example Budget" ``` Resultado: ``` { "Budget": { "CalculatedSpend": { "ForecastedSpend": { "Amount": "2641.54800000000022919266484677791595458984375", "Unit": "USD" }, "ActualSpend": { "Amount": "604.4560000000000172803993336856365203857421875", "Unit": "USD" } }, "BudgetType": "COST", "BudgetLimit": { "Amount": "100", "Unit": "USD" }, "BudgetName": "Example Budget", "CostTypes": { "IncludeOtherSubscription": true, "IncludeUpfront": true, "IncludeRefund": true, "UseBlended": false, "IncludeDiscount": true, "UseAmortized": false, "IncludeTax": true, "IncludeCredit": true, "IncludeSupport": true, "IncludeRecurring": true, "IncludeSubscription": true }, "TimeUnit": "MONTHLY", "TimePeriod": { "Start": 1477958399.0, "End": 3706473600.0 }, "CostFilters": { "AZ": [ "us-east-1" ] } } } ``` + Para ver detalhes da API, consulte [DescribeBudget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/describe-budget.html) na *Referência de comandos da AWS CLI*. ### `describe-budgets` O código de exemplo a seguir mostra como usar `describe-budgets`. **AWS CLI** **Para recuperar os orçamentos associados a uma conta** Este exemplo recupera os orçamentos de custo e uso de uma conta. Comando: ``` aws budgets describe-budgets --account-id 111122223333 --max-results 20 ``` Resultado: ``` { "Budgets": [ { "CalculatedSpend": { "ForecastedSpend": { "Amount": "2641.54800000000022919266484677791595458984375", "Unit": "USD" }, "ActualSpend": { "Amount": "604.4560000000000172803993336856365203857421875", "Unit": "USD" } }, "BudgetType": "COST", "BudgetLimit": { "Amount": "100", "Unit": "USD" }, "BudgetName": "Example Budget", "CostTypes": { "IncludeOtherSubscription": true, "IncludeUpfront": true, "IncludeRefund": true, "UseBlended": false, "IncludeDiscount": true, "UseAmortized": false, "IncludeTax": true, "IncludeCredit": true, "IncludeSupport": true, "IncludeRecurring": true, "IncludeSubscription": true }, "TimeUnit": "MONTHLY", "TimePeriod": { "Start": 1477958399.0, "End": 3706473600.0 }, "CostFilters": { "AZ": [ "us-east-1" ] } } ] } ``` + Para ver detalhes da API, consulte [DescribeBudgets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/describe-budgets.html) na *Referência de comandos da AWS CLI*. ### `describe-notifications-for-budget` O código de exemplo a seguir mostra como usar `describe-notifications-for-budget`. **AWS CLI** **Para recuperar as notificações de um orçamento** Este exemplo recupera as notificações de um orçamento de custo e uso. Comando: ``` aws budgets describe-notifications-for-budget --account-id 111122223333 --budget-name "Example Budget" --max-results 5 ``` Resultado: ``` { "Notifications": [ { "Threshold": 80.0, "ComparisonOperator": "GREATER_THAN", "NotificationType": "ACTUAL" } ] } ``` + Para ver detalhes da API, consulte [DescribeNotificationsForBudget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/describe-notifications-for-budget.html) na *Referência de comandos da AWS CLI*. ### `describe-subscribers-for-notification` O código de exemplo a seguir mostra como usar `describe-subscribers-for-notification`. **AWS CLI** **Para recuperar os assinantes de uma notificação de orçamento** Este exemplo recupera os assinantes de uma notificação de orçamento de custo e uso. Comando: ``` aws budgets describe-subscribers-for-notification --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE --max-results 5 ``` Resultado: ``` { "Subscribers": [ { "SubscriptionType": "EMAIL", "Address": "example2@example.com" }, { "SubscriptionType": "EMAIL", "Address": "example@example.com" } ] } ``` + Para ver detalhes da API, consulte [DescribeSubscribersForNotification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/describe-subscribers-for-notification.html) na *Referência de comandos da AWS CLI*. ### `update-budget` O código de exemplo a seguir mostra como usar `update-budget`. **AWS CLI** **Para substituir um orçamento por um orçamento de custo e uso** Este exemplo substitui um orçamento de custo e uso por um novo orçamento. Comando: ``` aws budgets update-budget --account-id 111122223333 --new-budget file://new-budget.json ``` new-budget.json: ``` { "BudgetLimit": { "Amount": "100", "Unit": "USD" }, "BudgetName": "Example Budget", "BudgetType": "COST", "CostFilters": { "AZ" : [ "us-east-1" ] }, "CostTypes": { "IncludeCredit": false, "IncludeDiscount": true, "IncludeOtherSubscription": true, "IncludeRecurring": true, "IncludeRefund": true, "IncludeSubscription": true, "IncludeSupport": true, "IncludeTax": true, "IncludeUpfront": true, "UseBlended": false, "UseAmortized": true }, "TimePeriod": { "Start": 1477958399, "End": 3706473600 }, "TimeUnit": "MONTHLY" } ``` + Para ver detalhes da API, consulte [UpdateBudget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/update-budget.html) na *Referência de comandos da AWS CLI*. ### `update-notification` O código de exemplo a seguir mostra como usar `update-notification`. **AWS CLI** **Para substituir uma notificação por um orçamento de custo e uso** Este exemplo substitui uma notificação de 80% para um orçamento de custo e uso por uma notificação de 90%. Comando: ``` aws budgets update-notification --account-id 111122223333 --budget-name "Example Budget" --old-notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE --new-notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=90,ThresholdType=PERCENTAGE ``` + Para ver detalhes da API, consulte [UpdateNotification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/update-notification.html) na *Referência de comandos da AWS CLI*. ### `update-subscriber` O código de exemplo a seguir mostra como usar `update-subscriber`. **AWS CLI** **Para substituir um assinante por um orçamento de custo e uso** Este exemplo substitui o assinante por um orçamento de custo e uso. Comando: ``` aws budgets update-subscriber --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE --old-subscriber SubscriptionType=EMAIL,Address=example@example.com --new-subscriber SubscriptionType=EMAIL,Address=example2@example.com ``` + Para ver detalhes da API, consulte [UpdateSubscriber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/update-subscriber.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon Chime usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o Amazon Chime. *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 ### `associate-phone-number-with-user` O código de exemplo a seguir mostra como usar `associate-phone-number-with-user`. **AWS CLI** **Como associar um número de telefone a um usuário** O exemplo `associate-phone-number-with-user` a seguir associa o número de telefone especificado a um usuário. ``` aws chime associate-phone-number-with-user \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --user-id 1ab2345c-67de-8901-f23g-45h678901j2k \ --e164-phone-number "+12065550100" ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciamento de números de telefone do usuário](https://docs.aws.amazon.com/chime/latest/ag/user-phone.html) no *Guia de administração do Amazon Chime*. + Para ver detalhes da API, consulte [AssociatePhoneNumberWithUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/associate-phone-number-with-user.html) na *Referência de comandos da AWS CLI*. ### `associate-signin-delegate-groups-with-account` O código de exemplo a seguir mostra como usar `associate-signin-delegate-groups-with-account`. **AWS CLI** **Como associar grupos delegados de login** O exemplo `associate-signin-delegate-groups-with-account` a seguir associa o grupo delegado de login especificado à conta especificada do Amazon Chime. ``` aws chime associate-signin-delegate-groups-with-account \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --signin-delegate-groups GroupName=my_users ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar as permissões e o acesso do usuário](https://docs.aws.amazon.com/chime/latest/ag/manage-access.html) no *Guia de administração do Amazon Chime*. + Para ver detalhes da API, consulte [AssociateSigninDelegateGroupsWithAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/associate-signin-delegate-groups-with-account.html) na *Referência de comandos da AWS CLI*. ### `batch-create-room-membership` O código de exemplo a seguir mostra como usar `batch-create-room-membership`. **AWS CLI** **Para criar várias associações de salas** O exemplo `batch-create-room-membership` a seguir adiciona vários usuários a uma sala de chat como membros da sala de chat. Ele também atribui perfis de administrador e membro aos usuários. ``` aws chime batch-create-room-membership \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \ --membership-item-list "MemberId=1ab2345c-67de-8901-f23g-45h678901j2k,Role=Administrator" "MemberId=2ab2345c-67de-8901-f23g-45h678901j2k,Role=Member" ``` Resultado: ``` { "ResponseMetadata": { "RequestId": "169ba401-d886-475f-8b3f-e01eac6fadfb", "HTTPStatusCode": 201, "HTTPHeaders": { "x-amzn-requestid": "169ba401-d886-475f-8b3f-e01eac6fadfb", "content-type": "application/json", "content-length": "13", "date": "Mon, 02 Dec 2019 22:46:58 GMT", "connection": "keep-alive" }, "RetryAttempts": 0 }, "Errors": [] } ``` Para obter mais informações, consulte [Criar uma sala de chat](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html) no *Guia do usuário do Amazon Chime*. + Para ver detalhes da API, consulte [BatchCreateRoomMembership](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/batch-create-room-membership.html) na *Referência de comandos da AWS CLI*. ### `batch-delete-phone-number` O código de exemplo a seguir mostra como usar `batch-delete-phone-number`. **AWS CLI** **Para excluir vários números de telefone** O exemplo `batch-delete-phone-number` a seguir exclui todos os números de telefone especificados. ``` aws chime batch-delete-phone-number \ --phone-number-ids "%2B12065550100" "%2B12065550101" ``` Este comando não produz saída. Resultado: ``` { "PhoneNumberErrors": [] } ``` Para obter mais informações, consulte [Trabalhar com números de telefone](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*. + Para ver detalhes da API, consulte [BatchDeletePhoneNumber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/batch-delete-phone-number.html) na *Referência de comandos da AWS CLI*. ### `batch-suspend-user` O código de exemplo a seguir mostra como usar `batch-suspend-user`. **AWS CLI** **Como suspender vários usuários** O exemplo `batch-suspend-user` a seguir suspende os usuários listados da conta especificada do Amazon Chime. ``` aws chime batch-suspend-user \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --user-id-list "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE" "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE" ``` Resultado: ``` { "UserErrors": [] } ``` + Para ver detalhes da API, consulte [BatchSuspendUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/batch-suspend-user.html) na *Referência de comandos da AWS CLI*. ### `batch-unsuspend-user` O código de exemplo a seguir mostra como usar `batch-unsuspend-user`. **AWS CLI** **Como cancelar a suspensão de vários usuários** O exemplo `batch-unsuspend-user` a seguir remove qualquer suspensão anterior dos usuários listados na conta especificada do Amazon Chime. ``` aws chime batch-unsuspend-user \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --user-id-list "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE" "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE" ``` Resultado: ``` { "UserErrors": [] } ``` + Para ver detalhes da API, consulte [BatchUnsuspendUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/batch-unsuspend-user.html) na *Referência de comandos da AWS CLI*. ### `batch-update-phone-number` O código de exemplo a seguir mostra como usar `batch-update-phone-number`. **AWS CLI** **Para atualizar vários tipos de produto de número de telefone ao mesmo tempo** O exemplo `batch-update-phone-number` a seguir atualiza os tipos de produtos de todos os números de telefone especificados. ``` aws chime batch-update-phone-number \ --update-phone-number-request-items PhoneNumberId=%2B12065550100,ProductType=BusinessCalling PhoneNumberId=%2B12065550101,ProductType=BusinessCalling ``` Resultado: ``` { "PhoneNumberErrors": [] } ``` **Para atualizar vários nomes de chamadas de números de telefone ao mesmo tempo** O exemplo `batch-update-phone-number` a seguir atualiza os nomes de chamada de todos os números de telefone especificados. ``` aws chime batch-update-phone-number \ --update-phone-number-request-items PhoneNumberId=%2B14013143874,CallingName=phonenumber1 PhoneNumberId=%2B14013144061,CallingName=phonenumber2 ``` Resultado: ``` { "PhoneNumberErrors": [] } ``` Para obter mais informações, consulte [Trabalhar com números de telefone](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*. + Para ver detalhes da API, consulte [BatchUpdatePhoneNumber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/batch-update-phone-number.html) na *Referência de comandos da AWS CLI*. ### `batch-update-user` O código de exemplo a seguir mostra como usar `batch-update-user`. **AWS CLI** **Para atualizar vários usuários em um único comando** O exemplo `batch-update-user` a seguir atualiza o `LicenseType` em cada um dos usuários listados na conta especificada do Amazon Chime. ``` aws chime batch-update-user \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE --update-user-request-items "UserId=a1b2c3d4-5678-90ab-cdef-22222EXAMPLE,LicenseType=Basic" "UserId=a1b2c3d4-5678-90ab-cdef-33333EXAMPLE,LicenseType=Basic" ``` Resultado: ``` { "UserErrors": [] } ``` + Para ver detalhes da API, consulte [BatchUpdateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/batch-update-user.html) na *Referência de comandos da AWS CLI*. ### `create-account` O código de exemplo a seguir mostra como usar `create-account`. **AWS CLI** **Para criar uma conta** O exemplo `create-account` a seguir cria uma conta do Amazon Chime na conta do administrador da AWS. ``` aws chime create-account \ --name MyChimeAccount ``` Resultado: ``` { "Account": { "AwsAccountId": "111122223333", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "Name": "MyChimeAccount", "AccountType": "Team", "CreatedTimestamp": "2019-01-04T17:11:22.003Z", "DefaultLicense": "Pro", "SupportedLicenses": [ "Basic", "Pro" ], "SigninDelegateGroups": [ { "GroupName": "myGroup" }, ] } } ``` Para obter mais informações, consulte [Conceitos básicos](https://docs.aws.amazon.com/chime/latest/ag/getting-started.html) no *Guia de administração do Amazon Chime*. + Consulte detalhes da API em [CreateAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/create-account.html) na *Referência de comandos da AWS CLI*. ### `create-bot` O código de exemplo a seguir mostra como usar `create-bot`. **AWS CLI** **Para criar um bot do Amazon Chime** O exemplo `create-bot` a seguir cria um bot para a conta específica do Amazon Chime Enterprise. ``` aws chime create-bot \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --display-name "myBot" \ --domain "example.com" ``` Resultado: ``` { "Bot": { "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k", "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k", "DisplayName": "myBot (Bot)", "BotType": "ChatBot", "Disabled": false, "CreatedTimestamp": "2019-09-09T18:05:56.749Z", "UpdatedTimestamp": "2019-09-09T18:05:56.749Z", "BotEmail": "myBot-chimebot@example.com", "SecurityToken": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" } } ``` Para obter mais informações, consulte [Integrar um bot de chat com o Amazon Chime](https://docs.aws.amazon.com/chime/latest/dg/integrate-bots.html) no *Guia do desenvolvedor do Amazon Chime*. + Para ver detalhes da API, consulte [CreateBot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/create-bot.html) na *Referência de comandos da AWS CLI*. ### `create-phone-number-order` O código de exemplo a seguir mostra como usar `create-phone-number-order`. **AWS CLI** **Para criar um pedido de número de telefone** O exemplo `create-phone-number-order` a seguir cria um pedido de número de telefone para os números de telefone especificados. ``` aws chime create-phone-number-order \ --product-type VoiceConnector \ --e164-phone-numbers "+12065550100" "+12065550101" "+12065550102" ``` Resultado: ``` { "PhoneNumberOrder": { "PhoneNumberOrderId": "abc12345-de67-89f0-123g-h45i678j9012", "ProductType": "VoiceConnector", "Status": "Processing", "OrderedPhoneNumbers": [ { "E164PhoneNumber": "+12065550100", "Status": "Processing" }, { "E164PhoneNumber": "+12065550101", "Status": "Processing" }, { "E164PhoneNumber": "+12065550102", "Status": "Processing" } ], "CreatedTimestamp": "2019-08-09T21:35:21.427Z", "UpdatedTimestamp": "2019-08-09T21:35:22.408Z" } } ``` Para obter mais informações, consulte [Trabalhar com números de telefone](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*. + Para ver detalhes da API, consulte [CreatePhoneNumberOrder](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/create-phone-number-order.html) na *Referência de comandos da AWS CLI*. ### `create-room-membership` O código de exemplo a seguir mostra como usar `create-room-membership`. **AWS CLI** **Para criar uma associação de sala** O exemplo `create-room-membership` a seguir adiciona o usuário especificado à sala de chat como membro da sala de chat. ``` aws chime create-room-membership \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \ --member-id 1ab2345c-67de-8901-f23g-45h678901j2k ``` Resultado: ``` { "RoomMembership": { "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", "Member": { "MemberId": "1ab2345c-67de-8901-f23g-45h678901j2k", "MemberType": "User", "Email": "janed@example.com", "FullName": "Jane Doe", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45" }, "Role": "Member", "InvitedBy": "arn:aws:iam::111122223333:user/alejandro", "UpdatedTimestamp": "2019-12-02T22:36:41.969Z" } } ``` Para obter mais informações, consulte [Criar uma sala de chat](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html) no *Guia do usuário do Amazon Chime*. + Para ver detalhes da API, consulte [CreateRoomMembership](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/create-room-membership.html) na *Referência de comandos da AWS CLI*. ### `create-room` O código de exemplo a seguir mostra como usar `create-room`. **AWS CLI** **Para criar uma sala de chat** O exemplo `create-room` a seguir cria uma sala de chat para a conta especificada do Amazon Chime. ``` aws chime create-room \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --name chatRoom ``` Resultado: ``` { "Room": { "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", "Name": "chatRoom", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45", "CreatedBy": "arn:aws:iam::111122223333:user/alejandro", "CreatedTimestamp": "2019-12-02T22:29:31.549Z", "UpdatedTimestamp": "2019-12-02T22:29:31.549Z" } } ``` Para obter mais informações, consulte [Criar uma sala de chat](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html) no *Guia do usuário do Amazon Chime*. + Para ver detalhes da API, consulte [CreateRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/create-room.html) na *Referência de comandos da AWS CLI*. ### `create-user` O código de exemplo a seguir mostra como usar `create-user`. **AWS CLI** **Para criar um perfil de usuário para um dispositivo compartilhado** O exemplo `create-user` a seguir cria um perfil de dispositivo compartilhado para o endereço de e-mail especificado. ``` aws chime create-user \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --email roomdevice@example.com \ --user-type SharedDevice ``` Resultado: ``` { "User": { "UserId": "1ab2345c-67de-8901-f23g-45h678901j2k", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45", "PrimaryEmail": "roomdevice@example.com", "DisplayName": "Room Device", "LicenseType": "Pro", "UserType": "SharedDevice", "UserRegistrationStatus": "Registered", "RegisteredOn": "2020-01-15T22:38:09.806Z", "AlexaForBusinessMetadata": { "IsAlexaForBusinessEnabled": false } } } ``` Para obter mais informações, consulte [Preparar para a configuração](https://docs.aws.amazon.com/chime/latest/ag/prepare-setup.html) no *Guia de administração do Amazon Chime*. + Consulte detalhes da API em [CreateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/create-user.html) na *Referência de comandos da AWS CLI*. ### `delete-account` O código de exemplo a seguir mostra como usar `delete-account`. **AWS CLI** **Para excluir uma conta** O exemplo `delete-account` a seguir exclui a conta especificada. ``` aws chime delete-account --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir sua conta](https://docs.aws.amazon.com/chime/latest/ag/enterprise-account.html) no *Guia de administração do Amazon Chime*. + Para ver detalhes da API, consulte [DeleteAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/delete-account.html) na *Referência de comandos da AWS CLI*. ### `delete-phone-number` O código de exemplo a seguir mostra como usar `delete-phone-number`. **AWS CLI** **Para excluir um número de telefone** O exemplo `delete-phone-number` a seguir move o número de telefone especificado para a fila de exclusão. ``` aws chime delete-phone-number \ --phone-number-id "+12065550100" ``` Este comando não produz saída. Para obter mais informações, consulte [Trabalhar com números de telefone](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*. + Para ver detalhes da API, consulte [DeletePhoneNumber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/delete-phone-number.html) na *Referência de comandos da AWS CLI*. ### `delete-room-membership` O código de exemplo a seguir mostra como usar `delete-room-membership`. **AWS CLI** **Para remover um usuário como membro de uma sala de chat** O exemplo `delete-room-membership` a seguir remove o membro especificado da sala de chat especificada. ``` aws chime delete-room-membership \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \ --member-id 1ab2345c-67de-8901-f23g-45h678901j2k ``` Este comando não produz saída. Para obter mais informações, consulte [Criar uma sala de chat](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html) no *Guia do usuário do Amazon Chime*. + Para ver detalhes da API, consulte [DeleteRoomMembership](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/delete-room-membership.html) na *Referência de comandos da AWS CLI*. ### `delete-room` O código de exemplo a seguir mostra como usar `delete-room`. **AWS CLI** **Para excluir uma sala de bate-papo** O exemplo `delete-room` a seguir exclui a sala de chat especificada e remove as associações da sala de chat. ``` aws chime delete-room \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j ``` Este comando não produz saída. Para obter mais informações, consulte [Criar uma sala de chat](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html) no *Guia do usuário do Amazon Chime*. + Para ver detalhes da API, consulte [DeleteRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/delete-room.html) na *Referência de comandos da AWS CLI*. ### `disassociate-phone-number-from-user` O código de exemplo a seguir mostra como usar `disassociate-phone-number-from-user`. **AWS CLI** **Como desassociar um número de telefone de um usuário** O exemplo `disassociate-phone-number-from-user` a seguir desassocia um número de telefone do usuário especificado. ``` aws chime disassociate-phone-number-from-user \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --user-id 1ab2345c-67de-8901-f23g-45h678901j2k ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciamento de números de telefone do usuário](https://docs.aws.amazon.com/chime/latest/ag/user-phone.html) no *Guia de administração do Amazon Chime*. + Para ver detalhes da API, consulte [DisassociatePhoneNumberFromUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/disassociate-phone-number-from-user.html) na *Referência de comandos da AWS CLI*. ### `disassociate-signin-delegate-groups-from-account` O código de exemplo a seguir mostra como usar `disassociate-signin-delegate-groups-from-account`. **AWS CLI** **Como desassociar grupos delegados de login** O exemplo `disassociate-signin-delegate-groups-from-account` a seguir desassocia o grupo delegado de login especificado da conta especificada do Amazon Chime. ``` aws chime disassociate-signin-delegate-groups-from-account \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --group-names "my_users" ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar as permissões e o acesso do usuário](https://docs.aws.amazon.com/chime/latest/ag/manage-access.html) no *Guia de administração do Amazon Chime*. + Para ver detalhes da API, consulte [DisassociateSigninDelegateGroupsFromAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/disassociate-signin-delegate-groups-from-account.html) na *Referência de comandos da AWS CLI*. ### `get-account-settings` O código de exemplo a seguir mostra como usar `get-account-settings`. **AWS CLI** **Para recuperar as configurações de uma conta** O exemplo `get-account-settings` a seguir recupera as configurações da conta na conta especificada. ``` aws chime get-account-settings --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE ``` Resultado: ``` { "AccountSettings": { "DisableRemoteControl": false, "EnableDialOut": false } } ``` Para obter mais informações, consulte [Gerenciar suas contas do Amazon Chime](https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) no *Guia de administração do Amazon Chime*. + Consulte detalhes da API em [GetAccountSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-account-settings.html) na *Referência de comandos da AWS CLI*. ### `get-account` O código de exemplo a seguir mostra como usar `get-account`. **AWS CLI** **Para recuperar os detalhes de uma conta** O exemplo `get-account` a seguir recupera os detalhes da conta do Amazon Chime especificada. ``` aws chime get-account \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE ``` Resultado: ``` { "Account": { "AwsAccountId": "111122223333", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "Name": "EnterpriseDirectory", "AccountType": "EnterpriseDirectory", "CreatedTimestamp": "2018-12-20T18:38:02.181Z", "DefaultLicense": "Pro", "SupportedLicenses": [ "Basic", "Pro" ], "SigninDelegateGroups": [ { "GroupName": "myGroup" }, ] } } ``` Para obter mais informações, consulte [Gerenciar suas contas do Amazon Chime](https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) no *Guia de administração do Amazon Chime*. + Para ver detalhes da API, consulte [GetAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-account.html) na *Referência de comandos da AWS CLI*. ### `get-bot` O código de exemplo a seguir mostra como usar `get-bot`. **AWS CLI** **Para recuperar detalhes de um bot** O exemplo `get-bot` a seguir exibe os detalhes do bot especificado. ``` aws chime get-bot \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --bot-id 123abcd4-5ef6-789g-0h12-34j56789012k ``` Resultado: ``` { "Bot": { "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k", "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k", "DisplayName": "myBot (Bot)", "BotType": "ChatBot", "Disabled": false, "CreatedTimestamp": "2019-09-09T18:05:56.749Z", "UpdatedTimestamp": "2019-09-09T18:05:56.749Z", "BotEmail": "myBot-chimebot@example.com", "SecurityToken": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" } } ``` Para obter mais informações, consulte [Atualizar bots de chat](https://docs.aws.amazon.com/chime/latest/dg/update-bots.html) no *Guia do desenvolvedor do Amazon Chime*. + Para ver detalhes da API, consulte [GetBot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-bot.html) na *Referência de comandos da AWS CLI*. ### `get-global-settings` O código de exemplo a seguir mostra como usar `get-global-settings`. **AWS CLI** **Para obter configurações globais** O exemplo `get-global-settings` a seguir recupera os nomes de bucket do S3 usados para armazenar registros de detalhes de chamadas para o Amazon Chime Business Calling e Amazon Chime Voice Connectors associados à conta da AWS do administrador. ``` aws chime get-global-settings ``` Resultado: ``` { "BusinessCalling": { "CdrBucket": "s3bucket" }, "VoiceConnector": { "CdrBucket": "s3bucket" } } ``` Para obter mais informações, consulte [Gerenciar as configurações globais](https://docs.aws.amazon.com/chime/latest/ag/manage-global.html) no *Guia do administrador do Amazon Chime*. + Para ver detalhes da API, consulte [GetGlobalSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-global-settings.html) na *Referência de comandos da AWS CLI*. ### `get-phone-number-order` O código de exemplo a seguir mostra como usar `get-phone-number-order`. **AWS CLI** **Para obter detalhes de um pedido de número de telefone** O exemplo `get-phone-number-order` a seguir exibe os detalhes do pedido de número de telefone especificado. ``` aws chime get-phone-number-order \ --phone-number-order-id abc12345-de67-89f0-123g-h45i678j9012 ``` Resultado: ``` { "PhoneNumberOrder": { "PhoneNumberOrderId": "abc12345-de67-89f0-123g-h45i678j9012", "ProductType": "VoiceConnector", "Status": "Partial", "OrderedPhoneNumbers": [ { "E164PhoneNumber": "+12065550100", "Status": "Acquired" }, { "E164PhoneNumber": "+12065550101", "Status": "Acquired" }, { "E164PhoneNumber": "+12065550102", "Status": "Failed" } ], "CreatedTimestamp": "2019-08-09T21:35:21.427Z", "UpdatedTimestamp": "2019-08-09T21:35:31.926Z" } } ``` Para obter mais informações, consulte [Trabalhar com números de telefone](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*. + Para receber detalhes da API, consulte [GetPhoneNumberOrder](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-phone-number-order.html) na *Referência de comandos da AWS CLI*. ### `get-phone-number-settings` O código de exemplo a seguir mostra como usar `get-phone-number-settings`. **AWS CLI** **Para recuperar um nome de chamada de saída** O exemplo `get-phone-number-settings` a seguir recupera o nome padrão da chamada de saída para a conta da AWS do usuário da chamada. ``` aws chime get-phone-number-settings ``` Este comando não produz saída. Resultado: ``` { "CallingName": "myName", "CallingNameUpdatedTimestamp": "2019-10-28T18:56:42.911Z" } ``` Para obter mais informações, consulte [Trabalhar com números de telefone](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*. + Para ver detalhes da API, consulte [GetPhoneNumberSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-phone-number-settings.html) na *Referência de comandos da AWS CLI*. ### `get-phone-number` O código de exemplo a seguir mostra como usar `get-phone-number`. **AWS CLI** **Para obter detalhes dos números de telefone** O exemplo `get-phone-number` a seguir exibe os detalhes do número de telefone especificado. ``` aws chime get-phone-number \ --phone-number-id +12065550100 ``` Resultado: ``` { "PhoneNumber": { "PhoneNumberId": "%2B12065550100", "E164PhoneNumber": "+12065550100", "Type": "Local", "ProductType": "VoiceConnector", "Status": "Unassigned", "Capabilities": { "InboundCall": true, "OutboundCall": true, "InboundSMS": true, "OutboundSMS": true, "InboundMMS": true, "OutboundMMS": true }, "Associations": [ { "Value": "abcdef1ghij2klmno3pqr4", "Name": "VoiceConnectorId", "AssociatedTimestamp": "2019-10-28T18:40:37.453Z" } ], "CallingNameStatus": "UpdateInProgress", "CreatedTimestamp": "2019-08-09T21:35:21.445Z", "UpdatedTimestamp": "2019-08-09T21:35:31.745Z" } } ``` Para obter mais informações, consulte [Trabalhar com números de telefone](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*. + Para ver detalhes da API, consulte [GetPhoneNumber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-phone-number.html) na *Referência de comandos da AWS CLI*. ### `get-room` O código de exemplo a seguir mostra como usar `get-room`. **AWS CLI** **Para obter os detalhes sobre uma sala de chat** O exemplo `get-room` a seguir exibe os detalhes da sala de chat especificada. ``` aws chime get-room \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j ``` Resultado: ``` { "Room": { "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", "Name": "chatRoom", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45", "CreatedBy": "arn:aws:iam::111122223333:user/alejandro", "CreatedTimestamp": "2019-12-02T22:29:31.549Z", "UpdatedTimestamp": "2019-12-02T22:29:31.549Z" } } ``` Para obter mais informações, consulte [Criar uma sala de chat](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html) no *Guia do usuário do Amazon Chime*. + Para ver detalhes da API, consulte [GetRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-room.html) na *Referência de comandos da AWS CLI*. ### `get-user-settings` O código de exemplo a seguir mostra como usar `get-user-settings`. **AWS CLI** **Para recuperar as configurações do usuário** O exemplo `get-user-settings` a seguir exibe as configurações do usuário especificadas. ``` aws chime get-user-settings \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --user-id 1ab2345c-67de-8901-f23g-45h678901j2k ``` Resultado: ``` { "UserSettings": { "Telephony": { "InboundCalling": true, "OutboundCalling": true, "SMS": true } } } ``` Para obter mais informações, consulte [Gerenciamento de números de telefone do usuário](https://docs.aws.amazon.com/chime/latest/ag/user-phone.html) no *Guia de administração do Amazon Chime*. + Para ver detalhes da API, consulte [GetUserSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-user-settings.html) na *Referência de comandos da AWS CLI*. ### `get-user` O código de exemplo a seguir mostra como usar `get-user`. **AWS CLI** **Para obter detalhes de um usuário** O exemplo `get-user` a seguir recupera os detalhes do usuário especificado. ``` aws chime get-user \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE ``` Resultado: ``` { "User": { "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "PrimaryEmail": "marthar@example.com", "DisplayName": "Martha Rivera", "LicenseType": "Pro", "UserRegistrationStatus": "Registered", "RegisteredOn": "2018-12-20T18:45:25.231Z", "InvitedOn": "2018-12-20T18:45:25.231Z", "AlexaForBusinessMetadata": { "IsAlexaForBusinessEnabled": False, "AlexaForBusinessRoomArn": "null" }, "PersonalPIN": "XXXXXXXXXX" } } ``` Para obter mais informações, consulte [Gerenciar usuários](https://docs.aws.amazon.com/chime/latest/ag/manage-users.html) no *Guia de administração do Amazon Chime*. + Consulte detalhes da API em [GetUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-user.html) na *Referência de comandos da AWS CLI*. ### `invite-users` O código de exemplo a seguir mostra como usar `invite-users`. **AWS CLI** **Como convidar usuários a participarem do Amazon Chime** O exemplo `invite-users` a seguir envia um e-mail para convidar um usuário para a conta especificada do Amazon Chime. ``` aws chime invite-users \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --user-email-list "alejandror@example.com" "janed@example.com" ``` Resultado: ``` { "Invites": [ { "InviteId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "Status": "Pending", "EmailAddress": "alejandror@example.com", "EmailStatus": "Sent" } { "InviteId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", "Status": "Pending", "EmailAddress": "janed@example.com", "EmailStatus": "Sent" } ] } ``` Para obter mais informações, consulte [Convidar e suspender usuários](https://docs.aws.amazon.com/chime/latest/ag/manage-access.html#invite-users-team) no *Guia de administração do Amazon Chime*. + Para ver detalhes da API, consulte [InviteUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/invite-users.html) na *Referência de comandos da AWS CLI*. ### `list-accounts` O código de exemplo a seguir mostra como usar `list-accounts`. **AWS CLI** **Para obter uma lista de contas** O exemplo `list-accounts` a seguir recupera uma lista das contas do Amazon Chime na conta da AWS do administrador. ``` aws chime list-accounts ``` Resultado: ``` { "Accounts": [ { "AwsAccountId": "111122223333", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "Name": "First Chime Account", "AccountType": "EnterpriseDirectory", "CreatedTimestamp": "2018-12-20T18:38:02.181Z", "DefaultLicense": "Pro", "SupportedLicenses": [ "Basic", "Pro" ], "SigninDelegateGroups": [ { "GroupName": "myGroup" }, ] }, { "AwsAccountId": "111122223333", "AccountId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "Name": "Second Chime Account", "AccountType": "Team", "CreatedTimestamp": "2018-09-04T21:44:22.292Z", "DefaultLicense": "Pro", "SupportedLicenses": [ "Basic", "Pro" ], "SigninDelegateGroups": [ { "GroupName": "myGroup" }, ] } ] } ``` Para obter mais informações, consulte [Gerenciar suas contas do Amazon Chime](https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) no *Guia de administração do Amazon Chime*. + Consulte detalhes da API em [ListAccounts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/list-accounts.html) na *Referência de comandos da AWS CLI*. ### `list-bots` O código de exemplo a seguir mostra como usar `list-bots`. **AWS CLI** **Para recuperar uma lista de bots** O exemplo `list-bots` a seguir lista os bots associados à conta especificada do Amazon Chime. ``` aws chime list-bots \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 ``` Resultado: ``` { "Bot": { "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k", "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k", "DisplayName": "myBot (Bot)", "BotType": "ChatBot", "Disabled": false, "CreatedTimestamp": "2019-09-09T18:05:56.749Z", "UpdatedTimestamp": "2019-09-09T18:05:56.749Z", "BotEmail": "myBot-chimebot@example.com", "SecurityToken": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" } } ``` Para obter mais informações, consulte [Usar bots de chat com o Amazon Chime](https://docs.aws.amazon.com/chime/latest/dg/use-bots.html) no *Guia do desenvolvedor do Amazon Chime*. + Para ver detalhes da API, consulte [ListBots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/list-bots.html) na *Referência de comandos da AWS CLI*. ### `list-phone-number-orders` O código de exemplo a seguir mostra como usar `list-phone-number-orders`. **AWS CLI** **Para listar pedidos de números de telefone** O exemplo `list-phone-number-orders` a seguir lista os pedidos de números de telefone associados à conta do administrador do Amazon Chime. ``` aws chime list-phone-number-orders ``` Resultado: ``` { "PhoneNumberOrders": [ { "PhoneNumberOrderId": "abc12345-de67-89f0-123g-h45i678j9012", "ProductType": "VoiceConnector", "Status": "Partial", "OrderedPhoneNumbers": [ { "E164PhoneNumber": "+12065550100", "Status": "Acquired" }, { "E164PhoneNumber": "+12065550101", "Status": "Acquired" }, { "E164PhoneNumber": "+12065550102", "Status": "Failed" } ], "CreatedTimestamp": "2019-08-09T21:35:21.427Z", "UpdatedTimestamp": "2019-08-09T21:35:31.926Z" } { "PhoneNumberOrderId": "cba54321-ed76-09f5-321g-h54i876j2109", "ProductType": "BusinessCalling", "Status": "Partial", "OrderedPhoneNumbers": [ { "E164PhoneNumber": "+12065550103", "Status": "Acquired" }, { "E164PhoneNumber": "+12065550104", "Status": "Acquired" }, { "E164PhoneNumber": "+12065550105", "Status": "Failed" } ], "CreatedTimestamp": "2019-08-09T21:35:21.427Z", "UpdatedTimestamp": "2019-08-09T21:35:31.926Z" } ] } ``` Para obter mais informações, consulte [Trabalhar com números de telefone](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*. + Para ver detalhes da API, consulte [ListPhoneNumberOrders](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/list-phone-number-orders.html) na *Referência de comandos da AWS CLI*. ### `list-phone-numbers` O código de exemplo a seguir mostra como usar `list-phone-numbers`. **AWS CLI** **Para listar números de telefone em uma conta do Amazon Chime** O exemplo `list-phone-numbers` a seguir lista os números de telefone associados à conta do Amazon Chime do administrador. ``` aws chime list-phone-numbers ``` Este comando não produz saída. Resultado: ``` { "PhoneNumbers": [ { "PhoneNumberId": "%2B12065550100", "E164PhoneNumber": "+12065550100", "Type": "Local", "ProductType": "VoiceConnector", "Status": "Assigned", "Capabilities": { "InboundCall": true, "OutboundCall": true, "InboundSMS": true, "OutboundSMS": true, "InboundMMS": true, "OutboundMMS": true }, "Associations": [ { "Value": "abcdef1ghij2klmno3pqr4", "Name": "VoiceConnectorId", "AssociatedTimestamp": "2019-10-28T18:40:37.453Z" } ], "CallingNameStatus": "UpdateInProgress", "CreatedTimestamp": "2019-08-12T22:10:20.521Z", "UpdatedTimestamp": "2019-10-28T18:42:07.964Z" }, { "PhoneNumberId": "%2B12065550101", "E164PhoneNumber": "+12065550101", "Type": "Local", "ProductType": "VoiceConnector", "Status": "Assigned", "Capabilities": { "InboundCall": true, "OutboundCall": true, "InboundSMS": true, "OutboundSMS": true, "InboundMMS": true, "OutboundMMS": true }, "Associations": [ { "Value": "abcdef1ghij2klmno3pqr4", "Name": "VoiceConnectorId", "AssociatedTimestamp": "2019-10-28T18:40:37.511Z" } ], "CallingNameStatus": "UpdateInProgress", "CreatedTimestamp": "2019-08-12T22:10:20.521Z", "UpdatedTimestamp": "2019-10-28T18:42:07.960Z" } ] } ``` Para obter mais informações, consulte [Trabalhar com números de telefone](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*. + Para ver detalhes da API, consulte [ListPhoneNumbers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/list-phone-numbers.html) na *Referência de comandos da AWS CLI*. ### `list-room-memberships` O código de exemplo a seguir mostra como usar `list-room-memberships`. **AWS CLI** **Para listar associações de salas** O exemplo `list-room-memberships` a seguir exibe uma lista dos detalhes da associação da sala de chat especificada. ``` aws chime list-room-memberships \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j ``` Resultado: ``` { "RoomMemberships": [ { "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", "Member": { "MemberId": "2ab2345c-67de-8901-f23g-45h678901j2k", "MemberType": "User", "Email": "zhangw@example.com", "FullName": "Zhang Wei", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45" }, "Role": "Member", "InvitedBy": "arn:aws:iam::111122223333:user/alejandro", "UpdatedTimestamp": "2019-12-02T22:46:58.532Z" }, { "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", "Member": { "MemberId": "1ab2345c-67de-8901-f23g-45h678901j2k", "MemberType": "User", "Email": "janed@example.com", "FullName": "Jane Doe", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45" }, "Role": "Administrator", "InvitedBy": "arn:aws:iam::111122223333:user/alejandro", "UpdatedTimestamp": "2019-12-02T22:46:58.532Z" } ] } ``` Para obter mais informações, consulte [Criar uma sala de chat](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html) no *Guia do usuário do Amazon Chime*. + Para ver detalhes da API, consulte [ListRoomMemberships](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/list-room-memberships.html) na *Referência de comandos da AWS CLI*. ### `list-rooms` O código de exemplo a seguir mostra como usar `list-rooms`. **AWS CLI** **Para listar salas de chat** O exemplo `list-rooms` a seguir exibe uma lista de salas de chat na conta especificada. A lista é filtrada somente para as salas de chat às quais o membro especificado pertence. ``` aws chime list-rooms \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --member-id 1ab2345c-67de-8901-f23g-45h678901j2k ``` Resultado: ``` { "Room": { "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", "Name": "teamRoom", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45", "CreatedBy": "arn:aws:iam::111122223333:user/alejandro", "CreatedTimestamp": "2019-12-02T22:29:31.549Z", "UpdatedTimestamp": "2019-12-02T22:33:19.310Z" } } ``` Para obter mais informações, consulte [Criar uma sala de chat](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html) no *Guia do usuário do Amazon Chime*. + Para ver detalhes da API, consulte [ListRooms](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/list-rooms.html) na *Referência de comandos da AWS CLI*. ### `list-users` O código de exemplo a seguir mostra como usar `list-users`. **AWS CLI** **Para listar os usuários em uma conta** O exemplo `list-users` a seguir lista os usuários da conta especificada do Amazon Chime. ``` aws chime list-users --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE ``` Resultado: ``` { "Users": [ { "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "PrimaryEmail": "mariag@example.com", "DisplayName": "Maria Garcia", "LicenseType": "Pro", "UserType": "PrivateUser", "UserRegistrationStatus": "Registered", "RegisteredOn": "2018-12-20T18:45:25.231Z" "AlexaForBusinessMetadata": { "IsAlexaForBusinessEnabled": false } }, { "UserId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "PrimaryEmail": "richardr@example.com", "DisplayName": "Richard Roe", "LicenseType": "Pro", "UserType": "PrivateUser", "UserRegistrationStatus": "Registered", "RegisteredOn": "2018-12-20T18:45:45.415Z" "AlexaForBusinessMetadata": { "IsAlexaForBusinessEnabled": false } }, { "UserId": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "PrimaryEmail": "saanvis@example.com", "DisplayName": "Saanvi Sarkar", "LicenseType": "Basic", "UserType": "PrivateUser", "UserRegistrationStatus": "Registered", "RegisteredOn": "2018-12-20T18:46:57.747Z" "AlexaForBusinessMetadata": { "IsAlexaForBusinessEnabled": false } }, { "UserId": "a1b2c3d4-5678-90ab-cdef-55555EXAMPLE", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "PrimaryEmail": "wxiulan@example.com", "DisplayName": "Wang Xiulan", "LicenseType": "Basic", "UserType": "PrivateUser", "UserRegistrationStatus": "Registered", "RegisteredOn": "2018-12-20T18:47:15.390Z" "AlexaForBusinessMetadata": { "IsAlexaForBusinessEnabled": false } } ] } ``` Para obter mais informações, consulte [Gerenciar usuários](https://docs.aws.amazon.com/chime/latest/ag/manage-users.html) no *Guia de administração do Amazon Chime*. + Consulte detalhes da API em [ListUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/list-users.html) na *Referência de comandos da AWS CLI*. ### `logout-user` O código de exemplo a seguir mostra como usar `logout-user`. **AWS CLI** **Como fazer o logoff de um usuário** O exemplo `logout-user` a seguir desconecta o usuário especificado. ``` aws chime logout-user \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE ``` Este comando não produz saída. + Para ver detalhes da API, consulte [LogoutUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/logout-user.html) na *Referência de comandos da AWS CLI*. ### `regenerate-security-token` O código de exemplo a seguir mostra como usar `regenerate-security-token`. **AWS CLI** **Como regenerar um token de segurança** O exemplo `regenerate-security-token` a seguir gera o token de segurança do bot especificado. ``` aws chime regenerate-security-token \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --bot-id 123abcd4-5ef6-789g-0h12-34j56789012k ``` Resultado: ``` { "Bot": { "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k", "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k", "DisplayName": "myBot (Bot)", "BotType": "ChatBot", "Disabled": false, "CreatedTimestamp": "2019-09-09T18:05:56.749Z", "UpdatedTimestamp": "2019-09-09T18:05:56.749Z", "BotEmail": "myBot-chimebot@example.com", "SecurityToken": "je7MtGbClwBF/2Zp9Utk/h3yCo8nvbEXAMPLEKEY" } } ``` Para obter mais informações, consulte [Autenticar solicitações de bot de chat](https://docs.aws.amazon.com/chime/latest/dg/auth-bots.html) no *Guia do desenvolvedor do Amazon Chime*. + Para ver detalhes da API, consulte [RegenerateSecurityToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/regenerate-security-token.html) na *Referência de comandos da AWS CLI*. ### `reset-personal-pin` O código de exemplo a seguir mostra como usar `reset-personal-pin`. **AWS CLI** **Como redefinir o PIN de reunião pessoal de um usuário** O exemplo `reset-personal-pin` a seguir redefine o PIN de reunião pessoal de um usuário especificado. ``` aws chime reset-personal-pin \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE ``` Resultado: ``` { "User": { "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "PrimaryEmail": "mateo@example.com", "DisplayName": "Mateo Jackson", "LicenseType": "Pro", "UserType": "PrivateUser", "UserRegistrationStatus": "Registered", "RegisteredOn": "2018-12-20T18:45:25.231Z", "AlexaForBusinessMetadata": { "IsAlexaForBusinessEnabled": False, "AlexaForBusinessRoomArn": "null" }, "PersonalPIN": "XXXXXXXXXX" } } ``` Para obter mais informações, consulte [Alteração de PINs de reuniões pessoais](https://docs.aws.amazon.com/chime/latest/ag/change-PINs.html) no *Guia de administração do Amazon Chime*. + Para ver detalhes da API, consulte [ResetPersonalPin](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/reset-personal-pin.html) na *Referência de comandos da AWS CLI*. ### `restore-phone-number` O código de exemplo a seguir mostra como usar `restore-phone-number`. **AWS CLI** **Como restaurar um número de telefone** O exemplo `restore-phone-number` a seguir restaura o número de telefone especificado da fila de exclusão. ``` aws chime restore-phone-number \ --phone-number-id "+12065550100" ``` Resultado: ``` { "PhoneNumber": { "PhoneNumberId": "%2B12065550100", "E164PhoneNumber": "+12065550100", "Type": "Local", "ProductType": "BusinessCalling", "Status": "Unassigned", "Capabilities": { "InboundCall": true, "OutboundCall": true, "InboundSMS": true, "OutboundSMS": true, "InboundMMS": true, "OutboundMMS": true }, "Associations": [], "CreatedTimestamp": "2019-08-09T21:35:21.445Z", "UpdatedTimestamp": "2019-08-12T22:06:36.355Z" } } ``` Para obter mais informações, consulte [Trabalhar com números de telefone](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*. + Para ver detalhes da API, consulte [RestorePhoneNumber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/restore-phone-number.html) na *Referência de comandos da AWS CLI*. ### `search-available-phone-numbers` O código de exemplo a seguir mostra como usar `search-available-phone-numbers`. **AWS CLI** **Como pesquisar números de telefone disponíveis** O exemplo `search-available-phone-numbers` a seguir pesquisa os números de telefone disponíveis por código de área. ``` aws chime search-available-phone-numbers \ --area-code "206" ``` Resultado: ``` { "E164PhoneNumbers": [ "+12065550100", "+12065550101", "+12065550102", "+12065550103", "+12065550104", "+12065550105", "+12065550106", "+12065550107", "+12065550108", "+12065550109", ] } ``` Para obter mais informações, consulte [Trabalhar com números de telefone](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*. + Para ver detalhes da API, consulte [SearchAvailablePhoneNumbers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/search-available-phone-numbers.html) na *Referência de comandos da AWS CLI*. ### `update-account-settings` O código de exemplo a seguir mostra como usar `update-account-settings`. **AWS CLI** **Para atualizar as configurações da sua conta** O exemplo `update-account-settings` a seguir desabilita o controle remoto de telas compartilhadas na conta especificada do Amazon Chime. ``` aws chime update-account-settings \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --account-settings DisableRemoteControl=true ``` Este comando não produz saída. + Para ver detalhes da API, consulte [UpdateAccountSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-account-settings.html) na *Referência de comandos da AWS CLI*. ### `update-account` O código de exemplo a seguir mostra como usar `update-account`. **AWS CLI** **Para atualizar uma conta** O exemplo `update-account` a seguir atualiza o nome da conta especificada. ``` aws chime update-account \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --name MyAccountName ``` Resultado: ``` { "Account": { "AwsAccountId": "111122223333", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "Name": "MyAccountName", "AccountType": "Team", "CreatedTimestamp": "2018-09-04T21:44:22.292Z", "DefaultLicense": "Pro", "SupportedLicenses": [ "Basic", "Pro" ], "SigninDelegateGroups": [ { "GroupName": "myGroup" }, ] } } ``` Para obter mais informações, consulte [Renomear sua conta](https://docs.aws.amazon.com/chime/latest/ag/rename-account.html) no *Guia de administração do Amazon Chime*. + Para ver detalhes da API, consulte [UpdateAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-account.html) na *Referência de comandos da AWS CLI*. ### `update-bot` O código de exemplo a seguir mostra como usar `update-bot`. **AWS CLI** **Para atualizar um bot** O exemplo `update-bot` a seguir atualiza o status do bot especificado para impedir sua execução. ``` aws chime update-bot \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --bot-id 123abcd4-5ef6-789g-0h12-34j56789012k \ --disabled ``` Resultado: ``` { "Bot": { "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k", "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k", "DisplayName": "myBot (Bot)", "BotType": "ChatBot", "Disabled": true, "CreatedTimestamp": "2019-09-09T18:05:56.749Z", "UpdatedTimestamp": "2019-09-09T18:05:56.749Z", "BotEmail": "myBot-chimebot@example.com", "SecurityToken": "je7MtGbClwBF/2Zp9Utk/h3yCo8nvbEXAMPLEKEY" } } ``` Para obter mais informações, consulte [Atualizar bots de chat](https://docs.aws.amazon.com/chime/latest/dg/update-bots.html) no *Guia do desenvolvedor do Amazon Chime*. + Para ver detalhes da API, consulte [UpdateBot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-bot.html) na *Referência de comandos da AWS CLI*. ### `update-global-settings` O código de exemplo a seguir mostra como usar `update-global-settings`. **AWS CLI** **Para atualizar configurações globais** O exemplo `update-global-settings` a seguir atualiza o bucket do S3 usado para armazenar registros de detalhes de chamadas para o Amazon Chime Business Calling e Amazon Chime Voice Connectors associados à conta da AWS do administrador. ``` aws chime update-global-settings \ --business-calling CdrBucket="s3bucket" \ --voice-connector CdrBucket="s3bucket" ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar as configurações globais](https://docs.aws.amazon.com/chime/latest/ag/manage-global.html) no *Guia do administrador do Amazon Chime*. + Para ver detalhes da API, consulte [UpdateGlobalSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-global-settings.html) na *Referência de comandos da AWS CLI*. ### `update-phone-number-settings` O código de exemplo a seguir mostra como usar `update-phone-number-settings`. **AWS CLI** **Para atualizar o nome de uma chamada de saída** O exemplo `update-phone-number-settings` a seguir atualiza o nome padrão da chamada de saída para a conta da AWS do administrador. ``` aws chime update-phone-number-settings \ --calling-name "myName" ``` Este comando não produz saída. Para obter mais informações, consulte [Trabalhar com números de telefone](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*. + Para ver detalhes da API, consulte [UpdatePhoneNumberSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-phone-number-settings.html) na *Referência de comandos da AWS CLI*. ### `update-phone-number` O código de exemplo a seguir mostra como usar `update-phone-number`. **AWS CLI** **Exemplo 1: atualizar o tipo de produto de um número de telefone** O exemplo `update-phone-number` a seguir atualiza o tipo de produto do número de telefone especificado. ``` aws chime update-phone-number \ --phone-number-id "+12065550100" \ --product-type "BusinessCalling" ``` Resultado: ``` { "PhoneNumber": { "PhoneNumberId": "%2B12065550100", "E164PhoneNumber": "+12065550100", "Type": "Local", "ProductType": "BusinessCalling", "Status": "Unassigned", "Capabilities": { "InboundCall": true, "OutboundCall": true, "InboundSMS": true, "OutboundSMS": true, "InboundMMS": true, "OutboundMMS": true }, "Associations": [], "CallingName": "phonenumber1", "CreatedTimestamp": "2019-08-09T21:35:21.445Z", "UpdatedTimestamp": "2019-08-12T21:44:07.591Z" } } ``` **Exemplo 2: atualizar o nome da chamada de saída de um número de telefone** O exemplo `update-phone-number` a seguir atualiza o nome da chamada de saída no número de telefone especificado. aws chime update-phone-number --phone-number-id "\$112065550100" --calling-name "phonenumber2" Resultado: ``` { "PhoneNumber": { "PhoneNumberId": "%2B12065550100", "E164PhoneNumber": "+12065550100", "Type": "Local", "ProductType": "BusinessCalling", "Status": "Unassigned", "Capabilities": { "InboundCall": true, "OutboundCall": true, "InboundSMS": true, "OutboundSMS": true, "InboundMMS": true, "OutboundMMS": true }, "Associations": [], "CallingName": "phonenumber2", "CreatedTimestamp": "2019-08-09T21:35:21.445Z", "UpdatedTimestamp": "2019-08-12T21:44:07.591Z" } } ``` Para obter mais informações, consulte [Trabalhar com números de telefone](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*. + Para ver detalhes da API, consulte [UpdatePhoneNumber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-phone-number.html) na *Referência de comandos da AWS CLI*. ### `update-room-membership` O código de exemplo a seguir mostra como usar `update-room-membership`. **AWS CLI** **Para atualizar a associação de uma sala** O exemplo `update-room-membership` a seguir modifica a função do membro da sala de chat especificado para `Administrator`. ``` aws chime update-room-membership \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \ --member-id 1ab2345c-67de-8901-f23g-45h678901j2k \ --role Administrator ``` Resultado: ``` { "RoomMembership": { "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", "Member": { "MemberId": "1ab2345c-67de-8901-f23g-45h678901j2k", "MemberType": "User", "Email": "sofiamartinez@example.com", "FullName": "Sofia Martinez", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45" }, "Role": "Administrator", "InvitedBy": "arn:aws:iam::111122223333:user/admin", "UpdatedTimestamp": "2019-12-02T22:40:22.931Z" } } ``` Para obter mais informações, consulte [Criar uma sala de chat](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html) no *Guia do usuário do Amazon Chime*. + Para ver detalhes da API, consulte [UpdateRoomMembership](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-room-membership.html) na *Referência de comandos da AWS CLI*. ### `update-room` O código de exemplo a seguir mostra como usar `update-room`. **AWS CLI** **Para atualizar uma sala de chat** O exemplo `update-room` a seguir modifica o nome da sala de chat especificada. ``` aws chime update-room \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \ --name teamRoom ``` Resultado: ``` { "Room": { "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", "Name": "teamRoom", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45", "CreatedBy": "arn:aws:iam::111122223333:user/alejandro", "CreatedTimestamp": "2019-12-02T22:29:31.549Z", "UpdatedTimestamp": "2019-12-02T22:33:19.310Z" } } ``` Para obter mais informações, consulte [Criar uma sala de chat](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html) no *Guia do usuário do Amazon Chime*. + Para ver detalhes da API, consulte [UpdateRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-room.html) na *Referência de comandos da AWS CLI*. ### `update-user-settings` O código de exemplo a seguir mostra como usar `update-user-settings`. **AWS CLI** **Para atualizar as configurações do usuário** O exemplo `update-user-settings` a seguir permite que o usuário especificado faça chamadas de entrada e saída e envie e receba mensagens SMS. ``` aws chime update-user-settings \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --user-id 1ab2345c-67de-8901-f23g-45h678901j2k \ --user-settings "Telephony={InboundCalling=true,OutboundCalling=true,SMS=true}" ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciamento de números de telefone do usuário](https://docs.aws.amazon.com/chime/latest/ag/user-phone.html) no *Guia de administração do Amazon Chime*. + Para ver detalhes da API, consulte [UpdateUserSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-user-settings.html) na *Referência de comandos da AWS CLI*. ### `update-user` O código de exemplo a seguir mostra como usar `update-user`. **AWS CLI** **Para atualizar os detalhes do usuário** Este exemplo atualiza os detalhes especificados do usuário especificado. Comando: ``` aws chime update-user \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE \ --license-type "Basic" ``` Resultado: ``` { "User": { "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" } } ``` + Consulte detalhes da API em [UpdateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-user.html) na *Referência de comandos da AWS CLI*. # Exemplos do Cloud Control API usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o Cloud Control API. *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 ### `create-resource` O código de exemplo a seguir mostra como usar `create-resource`. **AWS CLI** **Para criar um recurso** O exemplo `create-resource` a seguir cria um recurso AWS::Kinesis::Stream, chamado ResourceExample, com um período de retenção de 168 horas e uma contagem de três fragmentos. ``` aws cloudcontrol create-resource \ --type-name AWS::Kinesis::Stream \ --desired-state "{\"Name\": \"ResourceExample\",\"RetentionPeriodHours\":168, \"ShardCount\":3}" ``` Resultado: ``` { "ProgressEvent": { "EventTime": 1632506656.706, "TypeName": "AWS::Kinesis::Stream", "OperationStatus": "IN_PROGRESS", "Operation": "CREATE", "Identifier": "ResourceExample", "RequestToken": "20999d87-e304-4725-ad84-832dcbfd7fc5" } } ``` Para obter mais informações, consulte [Criar um recurso](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html) no *Guia do usuário da Cloud Control API*. + Consulte detalhes da API em [CreateResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudcontrol/create-resource.html) na *Referência de comandos da AWS CLI*. ### `delete-resource` O código de exemplo a seguir mostra como usar `delete-resource`. **AWS CLI** **Para excluir um recurso** O exemplo `delete-resource` a seguir exclui um recurso AWS::Kinesis::Stream com o identificador ResourceExample da sua conta da AWS. ``` aws cloudcontrol delete-resource \ --type-name AWS::Kinesis::Stream \ --identifier ResourceExample ``` Resultado: ``` { "ProgressEvent": { "TypeName": "AWS::Kinesis::Stream", "Identifier": "ResourceExample", "RequestToken": "e48f26ff-d0f9-4ab8-a878-120db1edf111", "Operation": "DELETE", "OperationStatus": "IN_PROGRESS", "EventTime": 1632950300.14 } } ``` Para obter mais informações, consulte [Excluir um recurso](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-delete.html) no *Guia do usuário da Cloud Control API*. + Para ver detalhes da API, consulte [DeleteResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudcontrol/delete-resource.html) na *Referência de comandos da AWS CLI*. ### `get-resource-request-status` O código de exemplo a seguir mostra como usar `get-resource-request-status`. **AWS CLI** **Para obter as informações de status de uma solicitação de recurso** O exemplo `get-resource-request-status` a seguir retorna informações de status da solicitação de recurso especificada. ``` aws cloudcontrol get-resource-request-status \ --request-token "e1a6b86e-46bd-41ac-bfba-001234567890" ``` Resultado: ``` { "ProgressEvent": { "TypeName": "AWS::Kinesis::Stream", "Identifier": "Demo", "RequestToken": "e1a6b86e-46bd-41ac-bfba-001234567890", "Operation": "CREATE", "OperationStatus": "FAILED", "EventTime": 1632950268.481, "StatusMessage": "Resource of type 'AWS::Kinesis::Stream' with identifier 'Demo' already exists.", "ErrorCode": "AlreadyExists" } } ``` Para obter mais informações, consulte [Gerenciar solicitações de operação de recursos](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html) no *Guia do usuário da Cloud Control API*. + Para ver detalhes da API, consulte [GetResourceRequestStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudcontrol/get-resource-request-status.html) na *Referência de comandos da AWS CLI*. ### `get-resource` O código de exemplo a seguir mostra como usar `get-resource`. **AWS CLI** **Para obter o estado atual de um recurso** O exemplo `get-resource` a seguir retorna o estado atual do recurso AWS::Kinesis::Stream chamado ResourceExample. ``` aws cloudcontrol get-resource \ --type-name AWS::Kinesis::Stream \ --identifier ResourceExample ``` Resultado: ``` { "TypeName": "AWS::Kinesis::Stream", "ResourceDescription": { "Identifier": "ResourceExample", "Properties": "{\"Arn\":\"arn:aws:kinesis:us-west-2:099908667365:stream/ResourceExample\",\"RetentionPeriodHours\":168,\"Name\":\"ResourceExample\",\"ShardCount\":3}" } } ``` Para obter mais informações, consulte [Ler o estado atual de um recurso](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-read.html) no *Guia do usuário da Cloud Control API*. + Para ver detalhes da API, consulte [GetResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudcontrol/get-resource.html) na *Referência de comandos da AWS CLI*. ### `list-resource-requests` O código de exemplo a seguir mostra como usar `list-resource-requests`. **AWS CLI** **Para listar as solicitações de operação de recursos ativos** O exemplo `list-resource-requests` a seguir lista as solicitações de recursos para as operações CREATE e UPDATE que falharam em sua conta da AWS. ``` aws cloudcontrol list-resource-requests \ --resource-request-status-filter Operations=CREATE,OperationStatuses=FAILED ``` Resultado: ``` { "ResourceRequestStatusSummaries": [ { "TypeName": "AWS::Kinesis::Stream", "Identifier": "Demo", "RequestToken": "e1a6b86e-46bd-41ac-bfba-633abcdfdbd7", "Operation": "CREATE", "OperationStatus": "FAILED", "EventTime": 1632950268.481, "StatusMessage": "Resource of type 'AWS::Kinesis::Stream' with identifier 'Demo' already exists.", "ErrorCode": "AlreadyExists" } ] } ``` Para obter mais informações, consulte [Gerenciar solicitações de operação de recursos](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html) no *Guia do usuário da Cloud Control API*. + Para ver detalhes da API, consulte [ListResourceRequests](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudcontrol/list-resource-requests.html) na *Referência de comandos da AWS CLI*. ### `list-resources` O código de exemplo a seguir mostra como usar `list-resources`. **AWS CLI** **Para listar os recursos de um determinado tipo** O exemplo `list-resources` a seguir lista os recursos AWS::Kinesis::Stream provisionados em sua conta da AWS. ``` aws cloudcontrol list-resources \ --type-name AWS::Kinesis::Stream ``` Resultado: ``` { "TypeName": "AWS::Kinesis::Stream", "ResourceDescriptions": [ { "Identifier": "MyKinesisStream", "Properties": "{\"Name\":\"MyKinesisStream\"}" }, { "Identifier": "AnotherStream", "Properties": "{\"Name\":\"AnotherStream\"}" } ] } ``` Para obter mais informações, consulte [Descobrir recursos](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-list.html) no *Guia do usuário da Cloud Control API*. + Para ver detalhes da API, consulte [ListResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudcontrol/list-resources.html) na *Referência de comandos da AWS CLI*. ### `update-resource` O código de exemplo a seguir mostra como usar `update-resource`. **AWS CLI** **Para atualizar as propriedades de um recurso existente** O exemplo `update-resource` a seguir atualiza a política de retenção de um recurso AWS::Logs::LogGroup chamado ExampleLogGroup para 90 dias. ``` aws cloudcontrol update-resource \ --type-name AWS::Logs::LogGroup \ --identifier ExampleLogGroup \ --patch-document "[{\"op\":\"replace\",\"path\":\"/RetentionInDays\",\"value\":90}]" ``` Resultado: ``` { "ProgressEvent": { "EventTime": "2021-08-09T18:17:15.219Z", "TypeName": "AWS::Logs::LogGroup", "OperationStatus": "IN_PROGRESS", "Operation": "UPDATE", "Identifier": "ExampleLogGroup", "RequestToken": "5f40c577-3534-4b20-9599-0b0123456789" } } ``` Para obter mais informações, consulte [Atualizar um recurso](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-update.html) no *Guia do usuário da Cloud Control API*. + Para ver detalhes da API, consulte [UpdateResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudcontrol/update-resource.html) na *Referência de comandos da AWS CLI*. # AWS Cloud Map Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o AWS Cloud Map. *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 ### `create-http-namespace` O código de exemplo a seguir mostra como usar `create-http-namespace`. **AWS CLI** **Como criar um namespace HTTP** O exemplo de `create-http-namespace` a seguir cria um namespace HTTP chamado `example.com`. ``` aws servicediscovery create-http-namespace \ --name example.com \ --creator-request-id example-request-id ``` Resultado: ``` { "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd" } ``` Para confirmar que a operação foi bem-sucedida, você pode executar`get-operation`. Para obter mais informações, consulte [get-operation](https://docs.aws.amazon.com/cli/latest/reference/servicediscovery/get-operation.html). Para obter mais informações sobre como criar um namespace, consulte [Creating an AWS Cloud Map namespace to group application services](https://docs.aws.amazon.com/cloud-map/latest/dg/creating-namespaces.html) no *Guia do desenvolvedor do AWS Cloud Map*. + Consulte detalhes da API em [CreateHttpNamespace](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/create-http-namespace.html) na *Referência de comandos da AWS CLI*. ### `create-private-dns-namespace` O código de exemplo a seguir mostra como usar `create-private-dns-namespace`. **AWS CLI** **Para criar um namespace de DNS privado** O exemplo `create-private-dns-namespace` a seguir cria um namespace DNS privado. ``` aws servicediscovery create-private-dns-namespace \ --name example.com \ --vpc vpc-1c56417b ``` Resultado: ``` { "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd" } ``` Para confirmar que a operação foi bem-sucedida, você pode executar`get-operation`. Para obter mais informações, consulte [get-operation](https://docs.aws.amazon.com/cli/latest/reference/servicediscovery/get-operation.html). Para obter mais informações, consulte [Criar namespaces](https://docs.aws.amazon.com/cloud-map/latest/dg/creating-namespaces.html) no *Guia do desenvolvedor do AWS Cloud Map*. + Para ver detalhes da API, consulte [CreatePrivateDnsNamespace](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/create-private-dns-namespace.html) na *Referência de comandos da AWS CLI*. ### `create-public-dns-namespace` O código de exemplo a seguir mostra como usar `create-public-dns-namespace`. **AWS CLI** **Como criar um namespace de DNS público** O exemplo de `create-public-dns-namespace` a seguir cria um namespace de DNS público chamado `example.com`. ``` aws servicediscovery create-public-dns-namespace \ --name example-public-dns.com \ --creator-request-id example-public-request-id \ --properties DnsProperties={SOA={TTL=60}} ``` Resultado: ``` { "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd" } ``` Para confirmar que a operação foi bem-sucedida, você pode executar`get-operation`. Para obter mais informações sobre como criar um namespace, consulte [Creating an AWS Cloud Map namespace to group application services](https://docs.aws.amazon.com/cloud-map/latest/dg/creating-namespaces.html) no *Guia do desenvolvedor do AWS Cloud Map*. + Para ver detalhes da API, consulte [CreatePublicDnsNamespace](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/create-public-dns-namespace.html) na *Referência de comandos da AWS CLI*. ### `create-service` O código de exemplo a seguir mostra como usar `create-service`. **AWS CLI** **Exemplo 1: criar um serviço usando o ID do namespace** O exemplo `create-service` a seguir cria um serviço. ``` aws servicediscovery create-service \ --name myservice \ --namespace-id ns-ylexjili4cdxy3xm \ --dns-config "RoutingPolicy=MULTIVALUE,DnsRecords=[{Type=A,TTL=60}]" ``` Resultado: ``` { "Service": { "Id": "srv-abcd1234xmpl5678", "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678", "ResourceOwner": "123456789012", "Name": "myservice", "NamespaceId": "ns-abcd1234xmpl5678", "DnsConfig": { "NamespaceId": "ns-abcd1234xmpl5678", "RoutingPolicy": "MULTIVALUE", "DnsRecords": [ { "Type": "A", "TTL": 60 } ] }, "Type": "DNS_HTTP", "CreateDate": "2025-08-18T13:45:31.023000-05:00", "CreatorRequestId": "abcd1234-5678-90ab-cdef-xmpl12345678", "CreatedByAccount": "123456789012" } } ``` Para ter mais informações, consulte [Criar um serviço do AWS Cloud Map para um componente da aplicação](https://docs.aws.amazon.com/cloud-map/latest/dg/creating-services.html) no *Guia do desenvolvedor do AWS Cloud Map*. **Exemplo 2: criar um serviço usando o ARN do namespace** O exemplo de `create-service` a seguir cria um serviço usando um ARN de namespace em vez de um ID de namespace. É necessário especificar um ARN de namespace ao criar um serviço em um namespace compartilhado. ``` aws servicediscovery create-service \ --name myservice-arn \ --namespace-id arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678 \ --dns-config "RoutingPolicy=MULTIVALUE,DnsRecords=[{Type=A,TTL=60}]" ``` Resultado: ``` { "Service": { "Id": "srv-abcd1234xmpl5678", "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678", "ResourceOwner": "123456789012", "Name": "myservice-arn", "NamespaceId": "ns-abcd1234xmpl5678", "DnsConfig": { "NamespaceId": "ns-abcd1234xmpl5678", "RoutingPolicy": "MULTIVALUE", "DnsRecords": [ { "Type": "A", "TTL": 60 } ] }, "Type": "DNS_HTTP", "CreateDate": "2025-08-18T13:45:31.023000-05:00", "CreatorRequestId": "abcd1234-5678-90ab-cdef-xmpl12345678", "CreatedByAccount": "123456789012" } } ``` Para ter mais informações, consulte [Namespaces compartilhados do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html) no *Guia do desenvolvedor do AWS Cloud Map*. + Consulte detalhes da API em [CreateService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/create-service.html) na *Referência de comandos da AWS CLI*. ### `delete-namespace` O código de exemplo a seguir mostra como usar `delete-namespace`. **AWS CLI** **Exemplo 1: excluir um namespace** O exemplo `delete-namespace` a seguir exclui um namespace. ``` aws servicediscovery delete-namespace \ --id ns-abcd1234xmpl5678 ``` Resultado: ``` { "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" } ``` Para confirmar que a operação foi bem-sucedida, você pode executar`get-operation`. Para ter mais informações, consulte [get-operation](https://docs.aws.amazon.com/cli/latest/reference/servicediscovery/get-operation.html). Para ter mais informações, consulte [Excluir um namespace do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/deleting-namespaces.html) no *Guia do desenvolvedor do AWS Cloud Map*. **Exemplo 2: excluir um namespace usando o ARN do namespace** O exemplo de `delete-namespace` a seguir exclui um namespace usando o respectivo ARN. ``` aws servicediscovery delete-namespace \ --id arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678 ``` Resultado: ``` { "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" } ``` Para ter mais informações, consulte [Excluir um namespace do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/deleting-namespaces.html) no *Guia do desenvolvedor do AWS Cloud Map*. + Para ver detalhes da API, consulte [DeleteNamespace](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/delete-namespace.html) na *Referência de comandos da AWS CLI*. ### `delete-service-attributes` O código de exemplo a seguir mostra como usar `delete-service-attributes`. **AWS CLI** **Exemplo 1: excluir um atributo de serviço** O exemplo de `delete-service-attributes` a seguir exclui um atributo de serviço com a chave `Port` associada ao serviço especificado. ``` aws servicediscovery delete-service-attributes \ --service-id srv-abcd1234xmpl5678 \ --attributes Port ``` Este comando não produz saída. Para obter mais informações, consulte [AWS Cloud Map services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) no *Guia do desenvolvedor do AWS Cloud Map*. **Exemplo 2: excluir um atributo de serviço usando o ARN** O exemplo de `delete-service-attributes` a seguir exclui um atributo de serviço usando o ARN do serviço. A especificação do ARN é necessária para excluir atributos associados aos serviços criados em namespaces compartilhados com sua conta. ``` aws servicediscovery delete-service-attributes \ --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678 \ --attributes Port ``` Este comando não produz saída. Para ter mais informações, consulte [Serviços do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) e [Namespaces compartilhados do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html) no *Guia do desenvolvedor do AWS*. + Para ver detalhes da API, consulte [DeleteServiceAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/delete-service-attributes.html) na *Referência de comandos da AWS CLI*. ### `delete-service` O código de exemplo a seguir mostra como usar `delete-service`. **AWS CLI** **Exemplo 1: excluir um serviço** O exemplo `delete-service` a seguir exclui um serviço. ``` aws servicediscovery delete-service \ --id srv-abcd1234xmpl5678 ``` Este comando não produz saída. Para ter mais informações, consulte [Excluir um serviço do AWS](https://docs.aws.amazon.com/cloud-map/latest/dg/deleting-services.html) no *Guia do desenvolvedor do AWS Cloud Map*. **Exemplo 2: excluir um serviço usando o ARN** O exemplo de `delete-service` a seguir exclui um serviço usando o respectivo ARN. ``` aws servicediscovery delete-service \ --id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678 ``` Este comando não produz saída. Para ter mais informações, consulte [Excluir um serviço do AWS](https://docs.aws.amazon.com/cloud-map/latest/dg/deleting-services.html) no *Guia do desenvolvedor do AWS Cloud Map*. + Consulte detalhes da API em [DeleteService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/delete-service.html) na *Referência de comandos da AWS CLI*. ### `deregister-instance` O código de exemplo a seguir mostra como usar `deregister-instance`. **AWS CLI** **Exemplo 1: cancelar o registro de uma instância de serviço** O exemplo `deregister-instance` a seguir cancela o registro de uma instância de serviço. ``` aws servicediscovery deregister-instance \ --service-id srv-p5zdwlg5uvvzjita \ --instance-id myservice-53 ``` Resultado: ``` { "OperationId": "4yejorelbukcjzpnr6tlmrghsjwpngf4-k98rnaiq" } ``` Para confirmar que a operação foi bem-sucedida, você pode executar`get-operation`. Para ter mais informações, consulte [get-operation](https://docs.aws.amazon.com/cli/latest/reference/servicediscovery/get-operation.html). Para obter mais informações, consulte [Cancelar o registro de instâncias de serviço](https://docs.aws.amazon.com/cloud-map/latest/dg/deregistering-instances.html) no *Guia do desenvolvedor do AWS Cloud Map*. **Exemplo 2: cancelar o registro de uma instância de serviço usando o ARN do serviço para namespaces compartilhados** O exemplo de `deregister-instance` a seguir cancela o registro de uma instância de serviço usando um ARN de serviço em vez de um ID de serviço. É necessário especificar um ARN ao cancelar o registro de instâncias de serviço criadas em namespaces compartilhados com sua conta. ``` aws servicediscovery deregister-instance \ --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita \ --instance-id web-server-01 ``` Resultado: ``` { "OperationId": "gv4g5meo7ndmkqjrhpn39wk42xmpl" } ``` Para ter mais informações, consulte [Namespaces compartilhados do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html) e [Cancelar o registro de uma instância de serviço do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/deregistering-instances.html) no *Guia do desenvolvedor do AWS*. + Para ver detalhes da API, consulte [DeregisterInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/deregister-instance.html) na *Referência de comandos da AWS CLI*. ### `discover-instances-revision` O código de exemplo a seguir mostra como usar `discover-instances-revision`. **AWS CLI** **Exemplo 1: descobrir a análise de uma instância** O exemplo de `discover-instances-revision` a seguir descobre a revisão crescente de uma instância. ``` aws servicediscovery discover-instances-revision \ --namespace-name example.com \ --service-name myservice ``` Resultado: ``` { "InstancesRevision": 123456 } ``` Para obter mais informações, consulte [AWS Cloud Map service instances](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-instances.html) no *Guia do desenvolvedor do AWS Cloud Map*. **Exemplo 2: descobrir a análise de instâncias de uma conta de proprietário específica** O exemplo de `discover-instances-revision` a seguir mostra a análise de instâncias de uma conta de proprietário específica. O parâmetro owner-account é necessário para instâncias em namespaces compartilhados com sua conta. ``` aws servicediscovery discover-instances-revision \ --namespace-name shared-namespace \ --service-name shared-service \ --owner-account 123456789111 ``` Resultado: ``` { "InstancesRevision": 1234567890 } ``` Para ter mais informações, consulte [Namespaces compartilhados do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html) e [Instâncias do serviço AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-instances.html) no *Guia do desenvolvedor do AWS Cloud Map*. + Para ver detalhes da API, consulte [DiscoverInstancesRevision](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/discover-instances-revision.html) na *Referência de comandos da AWS CLI*. ### `discover-instances` O código de exemplo a seguir mostra como usar `discover-instances`. **AWS CLI** **Exemplo 1: descobrir instâncias registradas** O exemplo `discover-instances` a seguir descobre instâncias registradas. ``` aws servicediscovery discover-instances \ --namespace-name example.com \ --service-name myservice \ --max-results 10 \ --health-status ALL ``` Resultado: ``` { "Instances": [ { "InstanceId": "myservice-53", "NamespaceName": "example.com", "ServiceName": "myservice", "HealthStatus": "UNKNOWN", "Attributes": { "AWS_INSTANCE_IPV4": "172.2.1.3", "AWS_INSTANCE_PORT": "808" } } ], "InstancesRevision": 85648075627387284 } ``` Para obter mais informações, consulte [AWS Cloud Map service instances](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-instances.html) no *Guia do desenvolvedor do AWS Cloud Map*. **Exemplo 2: descobrir instâncias de uma conta de proprietário específica** O exemplo de `discover-instances` a seguir descobre instâncias registradas de uma conta de proprietário específica. Esse parâmetro é necessário para descobrir instâncias em namespaces são compartilhados com sua conta. ``` aws servicediscovery discover-instances \ --namespace-name shared-namespace \ --service-name shared-service \ --owner-account 123456789111 ``` Resultado: ``` { "Instances": [ { "InstanceId": "shared-instance-1234", "NamespaceName": "shared-namespace", "ServiceName": "shared-service", "HealthStatus": "HEALTHY", "Attributes": { "AWS_INSTANCE_IPV4": "203.0.113.75", "AWS_INSTANCE_PORT": "80" } } ], "InstancesRevision": 1234567890 } ``` Para ter mais informações, consulte [Namespaces compartilhados do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html) e [Instâncias do serviço AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-instances.html) no *Guia do desenvolvedor do AWS Cloud Map*. + Para ver detalhes da API, consulte [DiscoverInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/discover-instances.html) na *Referência de comandos da AWS CLI*. ### `get-instance` O código de exemplo a seguir mostra como usar `get-instance`. **AWS CLI** **Exemplo 1: obter detalhes de uma instância** O exemplo de `get-instance` a seguir obtém os atributos de um serviço. ``` aws servicediscovery get-instance \ --service-id srv-e4anhexample0004 --instance-id i-abcd1234 ``` Resultado: ``` { "ResourceOwner": "123456789012", "Instance": { "Id": "arn:aws:servicediscovery:us-west-2:111122223333;:service/srv-e4anhexample0004", "Attributes": { "AWS_INSTANCE_IPV4": "192.0.2.44", "AWS_INSTANCE_PORT": "80", "color": "green", "region": "us-west-2", "stage": "beta" }, "CreatedByAccount": "123456789012" } } ``` Para obter mais informações, consulte [AWS Cloud Map service instances](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-instances.html) no *Guia do desenvolvedor do AWS Cloud Map*. **Exemplo 2: obter detalhes de uma instância usando o ARN do serviço para namespaces compartilhados** O exemplo de `get-instance` a seguir obtém os atributos de uma instância usando um ARN de serviço em vez de um ID de serviço. É necessário especificar um ARN ao obter detalhes de instâncias associadas a namespaces compartilhados com sua conta. A instância exibida neste exemplo foi registrada pela conta `123456789111` em um namespace de propriedade da conta `123456789012`. ``` aws servicediscovery get-instance \ --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita \ --instance-id web-server-01 ``` Resultado: ``` { "ResourceOwner": "123456789012", "Instance": { "Id": "web-server-01", "Attributes": { "AWS_INSTANCE_IPV4": "203.0.113.15", "AWS_INSTANCE_PORT": "80" }, "CreatedByAccount": "123456789111" } } ``` Para ter mais informações sobre compartilhamento de namespaces entre contas, consulte [Namespaces compartilhados do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html) no *Guia do desenvolvedor do AWS Cloud Map*. + Para ver detalhes da API, consulte [GetInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/get-instance.html) na *Referência de comandos da AWS CLI*. ### `get-instances-health-status` O código de exemplo a seguir mostra como usar `get-instances-health-status`. **AWS CLI** **Exemplo 1: obter o status de integridade das instâncias associadas a um serviço** O exemplo de `get-instances-health-status` a seguir obtém o status de integridade das instâncias associadas ao serviço especificado. ``` aws servicediscovery get-instances-health-status \ --service-id srv-e4anhexample0004 ``` Resultado: ``` { "Status": { "i-abcd1234": "HEALTHY", "i-abcd1235": "UNHEALTHY" } } ``` Para obter mais informações, consulte [AWS Cloud Map service instances](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-instances.html) no *Guia do desenvolvedor do AWS Cloud Map*. **Exemplo 2: obter o status de integridade das instâncias usando o ARN do serviço para namespaces compartilhados** O exemplo de `get-instances-health-status` a seguir obtém o status de integridade das instâncias usando um ARN de serviço em vez de um ID de serviço. É necessário especificar um ARN ao obter o status de integridade das instâncias associadas a namespaces compartilhados com a conta do solicitante. ``` aws servicediscovery get-instances-health-status \ --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita ``` Resultado: ``` { "Status": { "web-server-01": "HEALTHY", "web-server-02": "UNHEALTHY" } } ``` Para ter mais informações, consulte [Instâncias do serviço AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-instances.html) e [Namespaces compartilhados do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html) no *Guia do desenvolvedor do AWS Cloud Map*. + Para ver detalhes da API, consulte [GetInstancesHealthStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/get-instances-health-status.html) na *Referência de comandos da AWS CLI*. ### `get-namespace` O código de exemplo a seguir mostra como usar `get-namespace`. **AWS CLI** **Exemplo 1: obter os detalhes de um namespace** O exemplo de `get-namespace` a seguir recupera informações sobre o namespace especificado. ``` aws servicediscovery get-namespace \ --id ns-abcd1234xmpl5678 ``` Resultado: ``` { "Namespace": { "Id": "ns-abcd1234xmpl5678", "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678", "ResourceOwner": "123456789012", "Name": "example-http.com", "Type": "HTTP", "Description": "Example.com AWS Cloud Map HTTP Namespace", "Properties": { "DnsProperties": {}, "HttpProperties": { "HttpName": "example-http.com" } }, "CreateDate": "2024-02-23T13:35:21.874000-06:00", "CreatorRequestId": "abcd1234-5678-90ab-cdef-xmpl12345678" } } ``` Para obter mais informações, consulte [AWS Cloud Map namespaces](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-namespaces.html) no *Guia do desenvolvedor do AWS Cloud Map*. **Exemplo 2: obter os detalhes de um namespace usando o ARN** O exemplo de `get-namespace` a seguir recupera informações sobre o namespace especificado usando o respectivo ARN. A especificação do ARN é necessária para recuperar detalhes de um namespace compartilhado com sua conta. ``` aws servicediscovery get-namespace \ --id arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678 ``` Resultado: ``` { "Namespace": { "Id": "ns-abcd1234xmpl5678", "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678", "ResourceOwner": "123456789012", "Name": "example-http.com", "Type": "HTTP", "Description": "Example.com AWS Cloud Map HTTP Namespace", "Properties": { "DnsProperties": {}, "HttpProperties": { "HttpName": "example-http.com" } }, "CreateDate": "2024-02-23T13:35:21.874000-06:00", "CreatorRequestId": "abcd1234-5678-90ab-cdef-xmpl12345678" } } ``` Para ter mais informações, consulte [Namespaces compartilhados do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html) no *Guia do desenvolvedor do AWS Cloud Map*. + Para ver detalhes da API, consulte [GetNamespace](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/get-namespace.html) na *Referência de comandos da AWS CLI*. ### `get-operation` O código de exemplo a seguir mostra como usar `get-operation`. **AWS CLI** **Exemplo 1: obter o resultado de uma operação** O exemplo de `get-operation` a seguir obtém o resultado da operação de criação de um namespace. ``` aws servicediscovery get-operation \ --operation-id abcd1234xmpl5678abcd1234xmpl5678-abcd1234 ``` Resultado: ``` { "Operation": { "Id": "abcd1234xmpl5678abcd1234xmpl5678-abcd1234", "Type": "CREATE_NAMESPACE", "Status": "SUCCESS", "CreateDate": "2025-01-13T13:35:21.874000-06:00", "UpdateDate": "2025-01-13T13:36:02.469000-06:00", "Targets": { "NAMESPACE": "ns-abcd1234xmpl5678" } } } ``` Para obter mais informações, consulte [Creating an AWS Cloud Map namespace to group application services](https://docs.aws.amazon.com/cloud-map/latest/dg/creating-namespaces.html) no *Guia do desenvolvedor do AWS Cloud Map*. **Exemplo 2: obter uma operação de uma conta de proprietário específica** O exemplo de `get-operation` a seguir obtém o resultado de uma operação associada a uma conta de proprietário de namespace específica. Esse parâmetro é necessário para obter o resultado das operações associadas aos namespaces compartilhados com sua conta. ``` aws servicediscovery get-operation \ --operation-id abcd1234xmpl5678abcd1234xmpl5678-abcd1234 \ --owner-account 123456789111 ``` Resultado: ``` { "Operation": { "Id": "abcd1234xmpl5678abcd1234xmpl5678-abcd1234", "OwnerAccount": "123456789111", "Type": "CREATE_NAMESPACE", "Status": "SUCCESS", "CreateDate": "2025-01-13T13:35:21.874000-06:00", "UpdateDate": "2025-01-13T13:36:02.469000-06:00", "Targets": { "NAMESPACE": "ns-abcd1234xmpl5678" } } } ``` Para ter mais informações, consulte [Namespaces compartilhados do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html) no *Guia do desenvolvedor do AWS Cloud Map*. + Para ver detalhes da API, consulte [GetOperation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/get-operation.html) na *Referência de comandos da AWS CLI*. ### `get-service-attributes` O código de exemplo a seguir mostra como usar `get-service-attributes`. **AWS CLI** **Exemplo 1: obter os atributos de um serviço** O exemplo de `get-service-attributes` a seguir obtém os atributos de um serviço. ``` aws servicediscovery get-service-attributes \ --service-id srv-abcd1234xmpl5678 ``` Resultado: ``` { "ServiceAttributes": { "ServiceArn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678", "ResourceOwner": "123456789012", "Attributes": { "Port": "80" } } } ``` Para obter mais informações, consulte [AWS Cloud Map services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) no *Guia do desenvolvedor do AWS Cloud Map*. **Exemplo 2: obter os atributos de um serviço usando o ARN** O exemplo de `get-service-attributes` a seguir obtém os atributos de um serviço usando o respectivo ARN. A especificação do ARN é necessária para obter os atributos de um serviço criado em um namespace compartilhado com sua conta. ``` aws servicediscovery get-service-attributes \ --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678 ``` Resultado: ``` { "ServiceAttributes": { "ServiceArn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678", "ResourceOwner": "123456789012", "Attributes": { "Port": "80" } } } ``` Para ter mais informações, consulte [Serviços do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) e [Namespaces compartilhados do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html) no *Guia do desenvolvedor do AWS*. + Para ver detalhes da API, consulte [GetServiceAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/get-service-attributes.html) na *Referência de comandos da AWS CLI*. ### `get-service` O código de exemplo a seguir mostra como usar `get-service`. **AWS CLI** **Exemplo 1: obter as configurações de um serviço** O exemplo de `get-service` a seguir obtém as configurações de um serviço especificado. ``` aws servicediscovery get-service \ --id srv-abcd1234xmpl5678 ``` Resultado: ``` { "Service": { "Id": "srv-abcd1234xmpl5678", "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678", "ResourceOwner": "123456789012", "Name": "test-service", "NamespaceId": "ns-abcd1234xmpl5678", "DnsConfig": {}, "Type": "HTTP", "CreateDate": "2025-08-18T13:53:02.775000-05:00", "CreatorRequestId": "abcd1234-5678-90ab-cdef-xmpl12345678", "CreatedByAccount": "123456789012" } } ``` Para obter mais informações, consulte [AWS Cloud Map services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) no *Guia do desenvolvedor do AWS Cloud Map*. **Exemplo 2: obter as configurações de um serviço usando o ARN** O exemplo de `get-service` a seguir obtém as configurações de um serviço especificado usando o respectivo ARN. É necessário especificar o ARN ao recuperar informações sobre um serviço criado em um namespace compartilhado com sua conta. A conta do chamador `123456789111` criou o serviço em um namespace compartilhado pela conta `123456789012`. ``` aws servicediscovery get-service \ --id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678 ``` Resultado: ``` { "Service": { "Id": "srv-abcd1234xmpl5678", "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678", "ResourceOwner": "123456789012", "Name": "test-service", "NamespaceId": "ns-abcd1234xmpl5678", "DnsConfig": {}, "Type": "HTTP", "CreateDate": "2025-08-18T13:53:02.775000-05:00", "CreatorRequestId": "abcd1234-5678-90ab-cdef-xmpl12345678", "CreatedByAccount": "123456789111" } } ``` Para ter mais informações, consulte [Criar um serviço do AWS Cloud Map para um componente da aplicação](https://docs.aws.amazon.com/cloud-map/latest/dg/creating-services.html) e [Namespaces compartilhados do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html) no the *Guia do desenvolvedor do AWS*. + Para ver detalhes da API, consulte [GetService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/get-service.html) na *Referência de comandos da AWS CLI*. ### `list-instances` O código de exemplo a seguir mostra como usar `list-instances`. **AWS CLI** **Exemplo 1: listar instâncias de serviço** O exemplo `list-instances` a seguir lista as instâncias do serviço. ``` aws servicediscovery list-instances \ --service-id srv-qzpwvt2tfqcegapy ``` Resultado: ``` { "Instances": [ { "Id": "i-06bdabbae60f65a4e", "Attributes": { "AWS_INSTANCE_IPV4": "172.2.1.3", "AWS_INSTANCE_PORT": "808" }, "CreatedByAccount": "123456789012" } ], "ResourceOwner": "123456789012" } ``` Para ter mais informações, consulte [Listar instâncias de serviço do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/listing-instances.html) no *Guia do desenvolvedor do AWS Cloud Map*. **Exemplo 2: listar instâncias de serviço usando o ARN de serviço** O exemplo de `list-instances` a seguir lista as instâncias de serviço usando um ARN de serviço em vez de um ID de serviço. É necessário especificar um ARN ao listar instâncias associadas a namespaces compartilhados com sua conta. ``` aws servicediscovery list-instances \ --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita ``` Resultado: ``` { "ResourceOwner": "123456789012", "Instances": [ { "Id": "web-server-01", "Attributes": { "AWS_INSTANCE_IPV4": "203.0.113.15", "AWS_INSTANCE_PORT": "80" }, "CreatedByAccount": "123456789012" }, { "Id": "web-server-02", "Attributes": { "AWS_INSTANCE_IPV4": "203.0.113.16", "AWS_INSTANCE_PORT": "80" }, "CreatedByAccount": "123456789012" } ] } ``` Para ter mais informações sobre compartilhamento de namespaces entre contas, consulte [Namespaces compartilhados do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html) e [Listar instâncias de serviço do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/listing-instances.html) no *Guia do desenvolvedor do AWS Cloud Map*. + Para ver detalhes da API, consulte [ListInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/list-instances.html) na *Referência de comandos da AWS CLI*. ### `list-namespaces` O código de exemplo a seguir mostra como usar `list-namespaces`. **AWS CLI** **Exemplo 1: listar namespaces** O exemplo `list-namespaces` a seguir lista os namespaces. ``` aws servicediscovery list-namespaces ``` Resultado: ``` { "Namespaces": [ { "Id": "ns-abcd1234xmpl5678", "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678", "ResourceOwner": "123456789012", "Name": "local", "Type": "DNS_PRIVATE", "Properties": { "DnsProperties": { "HostedZoneId": "Z06752353VBUDTC32S84S", "SOA": {} }, "HttpProperties": { "HttpName": "local" } }, "CreateDate": "2023-07-17T13:37:27.872000-05:00" }, { "Id": "ns-abcd1234xmpl9012", "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl9012", "ResourceOwner": "123456789012", "Name": "My-second-namespace", "Type": "HTTP", "Description": "My second namespace", "Properties": { "DnsProperties": { "SOA": {} }, "HttpProperties": { "HttpName": "My-second-namespace" } }, "CreateDate": "2023-11-14T10:35:47.840000-06:00" } ] } ``` Para ter mais informações, consulte [Listar namespaces do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/listing-namespaces.html) no *Guia do desenvolvedor do AWS Cloud Map*. **Exemplo 2: listar namespaces compartilhados por outras contas** O exemplo de `list-namespaces` a seguir lista os namespaces compartilhados com a conta do chamador por outras contas da AWS usando o filtro `RESOURCE_OWNER`. ``` aws servicediscovery list-namespaces \ --filters Name=RESOURCE_OWNER,Values=OTHER_ACCOUNTS,Condition=EQ ``` Resultado: ``` { "Namespaces": [ { "Id": "ns-abcd1234xmpl5678", "Arn": "arn:aws:servicediscovery:us-west-2:123456789111:namespace/ns-abcd1234xmpl5678", "ResourceOwner": "123456789111", "Name": "shared-namespace", "Type": "HTTP", "Description": "Namespace shared from another account", "Properties": { "DnsProperties": { "SOA": {} }, "HttpProperties": { "HttpName": "shared-namespace" } }, "CreateDate": "2025-01-13T13:35:21.874000-06:00" } ] } ``` Para ter mais informações, consulte [Namespaces compartilhados do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html) no *Guia do desenvolvedor do AWS Cloud Map*. + Para ver detalhes da API, consulte [ListNamespaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/list-namespaces.html) na *Referência de comandos da AWS CLI*. ### `list-operations` O código de exemplo a seguir mostra como usar `list-operations`. **AWS CLI** **Como listar operações que atendem aos critérios especificados** O exemplo de `list-operations` a seguir lista as operações que têm um status `PENDING` ou `SUCCESS`. ``` aws servicediscovery list-operations \ --service-id srv-e4anhexample0004 \ --filters Name=STATUS,Condition=IN,Values=PENDING,SUCCESS ``` Resultado: ``` { "Operations": [ { "Id": "76yy8ovhpdz0plmjzbsnqgnrqvpv2qdt-kexample", "Status": "SUCCESS" }, { "Id": "prysnyzpji3u2ciy45nke83x2zanl7yk-dexample", "Status": "SUCCESS" }, { "Id": "ko4ekftir7kzlbechsh7xvcdgcpk66gh-7example", "Status": "PENDING" } ] } ``` Para obter mais informações, consulte [What is AWS Cloud Map?](https://docs.aws.amazon.com/cloud-map/latest/dg/what-is-cloud-map.html) no *Guia do desenvolvedor do AWS Cloud Map*. + Para ver detalhes da API, consulte [ListOperations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/list-operations.html) na *Referência de comandos da AWS CLI*. ### `list-services` O código de exemplo a seguir mostra como usar `list-services`. **AWS CLI** **Exemplo 1: listar serviços** O exemplo `list-services` a seguir lista os serviços. ``` aws servicediscovery list-services ``` Resultado: ``` { "Services": [ { "Id": "srv-p5zdwlg5uvvzjita", "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita", "Name": "myservice", "DnsConfig": { "RoutingPolicy": "MULTIVALUE", "DnsRecords": [ { "Type": "A", "TTL": 60 } ] }, "CreateDate": 1587081768.334 } ] } ``` Para ter mais informações, consulte [Listar serviços do AWS Cloud Map em um namespace](https://docs.aws.amazon.com/cloud-map/latest/dg/listing-services.html) no *Guia do desenvolvedor do AWS Cloud Map*. **Exemplo 2: listar serviços criados em namespaces compartilhados** O exemplo de `list-services` a seguir lista os serviços criados em namespaces compartilhados com a conta do chamador `123456789012` por outras contas da AWS usando o filtro `RESOURCE_OWNER`. ``` aws servicediscovery list-services \ --filters Name=RESOURCE_OWNER,Values=OTHER_ACCOUNTS,Condition=EQ ``` Resultado: ``` { "Services": [ { "Id": "srv-abcd1234xmpl5678", "Arn": "arn:aws:servicediscovery:us-west-2:123456789111:service/srv-abcd1234xmpl5678", "ResourceOwner": "123456789111", "Name": "shared-service", "NamespaceId": "ns-abcd1234xmpl5678", "Type": "HTTP", "Description": "Service in shared namespace", "DnsConfig": {}, "CreateDate": "2025-01-13T13:35:21.874000-06:00", "CreatorRequestId": "abcd1234-5678-90ab-cdef-xmpl12345678", "CreatedByAccount": "123456789012" } ] } ``` Para ter mais informações, consulte [Namespaces compartilhados do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html) e [Listar serviços do AWS Cloud Map em um namespace](https://docs.aws.amazon.com/cloud-map/latest/dg/listing-services.html) no *Guia do desenvolvedor do AWS Cloud Map*. + Consulte detalhes da API em [ListServices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/list-services.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Como listar tags associadas a um recurso especificado** O exemplo de `list-tags-for-resource` a seguir lista tags para o recurso especificado. ``` aws servicediscovery list-tags-for-resource \ --resource-arn arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-e4anhexample0004 ``` Resultado: ``` { "Tags": [ { "Key": "Project", "Value": "Zeta" }, { "Key": "Department", "Value": "Engineering" } ] } ``` Para obter mais informações, consulte [Tagging your AWS Cloud Map resources](https://docs.aws.amazon.com/cloud-map/latest/dg/listing-instances.html), no *Guia do desenvolvedor do AWS Cloud Map*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `register-instance` O código de exemplo a seguir mostra como usar `register-instance`. **AWS CLI** **Exemplo 1: registrar uma instância de serviço usando o ID de serviço** O exemplo `register-instance` a seguir registra uma instância de serviço. ``` aws servicediscovery register-instance \ --service-id srv-p5zdwlg5uvvzjita \ --instance-id myservice-53 \ --attributes=AWS_INSTANCE_IPV4=172.2.1.3,AWS_INSTANCE_PORT=808 ``` Resultado: ``` { "OperationId": "4yejorelbukcjzpnr6tlmrghsjwpngf4-k95yg2u7" } ``` Para confirmar que a operação foi bem-sucedida, você pode executar`get-operation`. Para ter mais informações, consulte [get-operation](https://docs.aws.amazon.com/cli/latest/reference/servicediscovery/get-operation.html). Para ter mais informações sobre como registrar uma instância, consulte [Registrar um recurso como uma instância de serviço do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/registering-instances.html) no Cloud *Map Developer AWS Guide*. **Exemplo 2: registrar uma instância de serviço usando o ARN de serviço** O exemplo de `register-instance` a seguir registra uma instância de serviço usando um ARN de serviço. É necessário especificar o ARN ao registrar instâncias em serviços compartilhados com sua conta. ``` aws servicediscovery register-instance \ --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita \ --instance-id web-server-01 \ --attributes=AWS_INSTANCE_IPV4=203.0.113.15,AWS_INSTANCE_PORT=80 ``` Resultado: ``` { "OperationId": "gv4g5meo7ndmkqjrhpn39wk42xmpl" } ``` Para ter mais informações sobre compartilhamento de namespaces entre contas, consulte [Namespaces compartilhados do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html) no *Guia do desenvolvedor do AWS Cloud Map*. + Para ver detalhes da API, consulte [RegisterInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/register-instance.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como associar tags ao recurso especificado** O exemplo de `tag-resource` a seguir associa uma tag `Department` com o valor `Engineering` ao namespace especificado. ``` aws servicediscovery tag-resource \ --resource-arn arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-e4anhexample0004 \ --tags Key=Department, Value=Engineering ``` Este comando não produz saída. Para obter mais informações, consulte [Tagging your AWS Cloud Map resources](https://docs.aws.amazon.com/cloud-map/latest/dg/listing-instances.html), no *Guia do desenvolvedor do AWS Cloud Map*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Como remover tags do recurso especificado** O exemplo de `untag-resource` a seguir remove uma tag `Department` do namespace especificado. ``` aws servicediscovery untag-resource \ --resource-arn arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-e4anhexample0004 \ --tags Key=Department, Value=Engineering ``` Este comando não produz saída. Para obter mais informações, consulte [Tagging your AWS Cloud Map resources](https://docs.aws.amazon.com/cloud-map/latest/dg/listing-instances.html), no *Guia do desenvolvedor do AWS Cloud Map*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-http-namespace` O código de exemplo a seguir mostra como usar `update-http-namespace`. **AWS CLI** **Exemplo 1: atualizar um namespace HTTP** O exemplo de `update-http-namespace` a seguir atualiza a descrição do namespace HTTP especificado. ``` aws servicediscovery update-http-namespace \ --id ns-abcd1234xmpl5678 \ --updater-request-id abcd1234-5678-90ab-cdef-xmpl12345678 \ --namespace Description="The updated namespace description." ``` Resultado: ``` { "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" } ``` Para confirmar que a operação foi bem-sucedida, você pode executar`get-operation`. Para ter mais informações, consulte [get-operation](https://docs.aws.amazon.com/cli/latest/reference/servicediscovery/get-operation.html). Para obter mais informações, consulte [AWS Cloud Map namespaces](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-namespaces.html) no *Guia do desenvolvedor do AWS Cloud Map*. **Exemplo 2: atualizar um namespace HTTP usando o ARN** O exemplo de `update-http-namespace` a seguir atualiza o namespace HTTP especificado usando o respectivo ARN. ``` aws servicediscovery update-http-namespace \ --id arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678 \ --updater-request-id abcd1234-5678-90ab-cdef-xmpl12345678 \ --namespace Description="The updated namespace description." ``` Resultado: ``` { "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" } ``` Para obter mais informações, consulte [AWS Cloud Map namespaces](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-namespaces.html) no *Guia do desenvolvedor do AWS Cloud Map*. + Consulte detalhes da API em [UpdateHttpNamespace](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/update-http-namespace.html) na *Referência de comandos da AWS CLI*. ### `update-instance-custom-health-status` O código de exemplo a seguir mostra como usar `update-instance-custom-health-status`. **AWS CLI** **Exemplo 1: atualizar uma verificação de integridade personalizada** O exemplo de `update-instance-custom-health-status` a seguir atualiza o status da verificação de integridade personalizada do serviço especificado e da instância de serviço de exemplo para `HEALTHY`. ``` aws servicediscovery update-instance-custom-health-status \ --service-id srv-e4anhexample0004 \ --instance-id example \ --status HEALTHY ``` Este comando não produz saída. Para obter mais informações, consulte [AWS Cloud Map service health check configuration](https://docs.aws.amazon.com/cloud-map/latest/dg/services-health-checks.html) no *Guia do desenvolvedor do AWS Cloud Map*. **Exemplo 2: atualizar uma verificação de integridade personalizada usando um ARN de serviço** O exemplo de `update-instance-custom-health-status` a seguir atualiza o status da verificação de integridade personalizada usando um ARN de serviço. O ARN é necessário ao atualizar o status de integridade de instâncias associadas a namespaces compartilhados com sua conta. ``` aws servicediscovery update-instance-custom-health-status \ --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita \ --instance-id web-server-01 \ --status HEALTHY ``` Este comando não produz saída. Para ter mais informações, consulte [Configuração da verificação de integridade do serviço AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/services-health-checks.html) e [Compartilhamento de namespaces do AWS Cloud Map entre contas](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html) no *Guia do desenvolvedor do AWS Cloud Map*. + Para ver detalhes da API, consulte [UpdateInstanceCustomHealthStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/update-instance-custom-health-status.html) na *Referência de comandos da AWS CLI*. ### `update-private-dns-namespace` O código de exemplo a seguir mostra como usar `update-private-dns-namespace`. **AWS CLI** **Exemplo 1: atualizar um namespace de DNS privado usando o ID** O exemplo de `update-private-dns-namespace` a seguir atualiza a descrição de um namespace de DNS privado usando o ID de namespace. ``` aws servicediscovery update-private-dns-namespace \ --id ns-abcd1234xmpl5678 \ --updater-request-id abcd1234-5678-90ab-cdef-xmpl12345678 \ --namespace Description="The updated namespace description." ``` Resultado: ``` { "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" } ``` Para confirmar que a operação foi bem-sucedida, você pode executar`get-operation`. Para obter mais informações, consulte [AWS Cloud Map namespaces](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-namespaces.html) no *Guia do desenvolvedor do AWS Cloud Map*. **Exemplo 2: atualizar um namespace de DNS privado usando o ARN** O exemplo de `update-private-dns-namespace` a seguir atualiza um namespace de DNS privado usando o respectivo ARN. ``` aws servicediscovery update-private-dns-namespace \ --id arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678 \ --updater-request-id abcd1234-5678-90ab-cdef-xmpl12345678 \ --namespace Description="The updated namespace description." ``` Resultado: ``` { "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" } ``` Para obter mais informações, consulte [AWS Cloud Map namespaces](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-namespaces.html) no *Guia do desenvolvedor do AWS Cloud Map*. + Para ver detalhes da API, consulte [UpdatePrivateDnsNamespace](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/update-private-dns-namespace.html) na *Referência de comandos da AWS CLI*. ### `update-public-dns-namespace` O código de exemplo a seguir mostra como usar `update-public-dns-namespace`. **AWS CLI** **Exemplo 1: atualizar um namespace de DNS público usando o ID** O exemplo de `update-public-dns-namespace` a seguir atualiza a descrição de um namespace de DNS público usando o respectivo ID. ``` aws servicediscovery update-public-dns-namespace \ --id ns-abcd1234xmpl5678 \ --updater-request-id abcd1234-5678-90ab-cdef-xmpl12345678 \ --namespace Description="The updated namespace description." ``` Resultado: ``` { "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" } ``` Para confirmar que a operação foi bem-sucedida, você pode executar`get-operation`. Para obter mais informações, consulte [AWS Cloud Map namespaces](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-namespaces.html) no *Guia do desenvolvedor do AWS Cloud Map*. **Exemplo 2: atualizar um namespace de DNS público usando o ARN** O exemplo de `update-public-dns-namespace` a seguir atualiza um namespace de DNS público usando o respectivo ARN. ``` aws servicediscovery update-public-dns-namespace \ --id arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678 \ --updater-request-id abcd1234-5678-90ab-cdef-xmpl12345678 \ --namespace Description="The updated namespace description." ``` Resultado: ``` { "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" } ``` Para obter mais informações, consulte [AWS Cloud Map namespaces](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-namespaces.html) no *Guia do desenvolvedor do AWS Cloud Map*. + Para ver detalhes da API, consulte [UpdatePublicDnsNamespace](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/update-public-dns-namespace.html) na *Referência de comandos da AWS CLI*. ### `update-service-attributes` O código de exemplo a seguir mostra como usar `update-service-attributes`. **AWS CLI** **Exemplo 1: atualizar um serviço para adicionar um atributo** O exemplo de `update-service-attributes` a seguir atualiza o serviço especificado para adicionar um atributo de serviço com uma chave `Port` e um valor `80`. ``` aws servicediscovery update-service-attributes \ --service-id srv-abcd1234xmpl5678 \ --attributes Port=80 ``` Este comando não produz saída. Para obter mais informações, consulte [AWS Cloud Map services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) no *Guia do desenvolvedor do AWS Cloud Map*. **Exemplo 2: atualizar atributos de um serviço usando o ARN** O exemplo de `update-service-attributes` a seguir atualiza um serviço usando o respectivo ARN para adicionar um atributo de serviço. É necessário especificar o ARN para adicionar atributos aos serviços criados em namespaces compartilhados com sua conta. ``` aws servicediscovery update-service-attributes \ --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678 \ --attributes Port=80 ``` Este comando não produz saída. Para ter mais informações, consulte [Serviços do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) e [Namespaces compartilhados do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html) no *Guia do desenvolvedor do AWS*. + Consulte detalhes da API em [UpdateServiceAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/update-service-attributes.html) na *Referência de comandos da AWS CLI*. ### `update-service` O código de exemplo a seguir mostra como usar `update-service`. **AWS CLI** **Exemplo 1: atualizar um serviço** O exemplo de `update-service` a seguir atualiza um serviço para atualizar as configurações `HealthCheckConfig` e `DnsConfig`. ``` aws servicediscovery update-service \ --id srv-abcd1234xmpl5678 \ --service "DnsConfig={DnsRecords=[{Type=A,TTL=60}]},HealthCheckConfig={Type=HTTP,ResourcePath=/,FailureThreshold=2}" ``` Resultado: ``` { "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" } ``` Para confirmar que a operação foi bem-sucedida, você pode executar`get-operation`. Para obter mais informações sobre como atualizar um serviço, consulte [Updating an AWS Cloud Map service](https://docs.aws.amazon.com/cloud-map/latest/dg/editing-services.html) no *Guia do desenvolvedor do AWS Cloud Map*. **Exemplo 2: atualizar um serviço usando o ARN** O exemplo de `update-service` a seguir atualiza um serviço usando o respectivo ARN. É necessário especificar o ARN para serviços criados em namespaces compartilhados com sua conta. ``` aws servicediscovery update-service \ --id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678 \ --service "DnsConfig={DnsRecords=[{Type=A,TTL=60}]},HealthCheckConfig={Type=HTTP,ResourcePath=/,FailureThreshold=2}" ``` Resultado: ``` { "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" } ``` Para ter mais informações sobre como atualizar um serviço, consulte [Atualizar um serviço do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/editing-services.html) e [Namespaces compartilhados do AWS Cloud Map](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html) no *Guia do desenvolvedor do AWS Cloud Map*. + Consulte detalhes da API em [UpdateService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/update-service.html) na *Referência de comandos da AWS CLI*. # AWS Cloud9 Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o 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 ### `create-environment-ec2` O código de exemplo a seguir mostra como usar `create-environment-ec2`. **AWS CLI** **Para criar um ambiente de desenvolvimento do EC2 no AWS Cloud9** O exemplo `create-environment-ec2` a seguir cria um ambiente de desenvolvimento para o AWS Cloud9 com as configurações específicas, inicia uma instância do Amazon Elastic Compute Cloud (Amazon EC2) e, em seguida, conecta-se da instância ao ambiente. ``` aws cloud9 create-environment-ec2 \ --name my-demo-env \ --description "My demonstration development environment." \ --instance-type t2.micro --image-id amazonlinux-2023-x86_64 \ --subnet-id subnet-1fab8aEX \ --automatic-stop-time-minutes 60 \ --owner-arn arn:aws:iam::123456789012:user/MyDemoUser ``` Resultado: ``` { "environmentId": "8a34f51ce1e04a08882f1e811bd706EX" } ``` Para obter mais informações, consulte [Criação de um ambiente do EC2](https://docs.aws.amazon.com/cloud9/latest/user-guide/create-environment-main.html) no *Guia do usuário do AWS Cloud9*. + Para ver detalhes da API, consulte [CreateEnvironmentEc2](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloud9/create-environment-ec2.html) na *Referência de comandos da AWS CLI*. ### `create-environment-membership` O código de exemplo a seguir mostra como usar `create-environment-membership`. **AWS CLI** **Para adicionar um membro de ambiente a um ambiente de desenvolvimento do AWS Cloud9** Este exemplo adiciona o membro de ambiente de desenvolvimento especificado ao ambiente de desenvolvimento do AWS Cloud9. Comando: ``` aws cloud9 create-environment-membership --environment-id 8a34f51ce1e04a08882f1e811bd706EX --user-arn arn:aws:iam::123456789012:user/AnotherDemoUser --permissions read-write ``` Resultado: ``` { "membership": { "environmentId": "8a34f51ce1e04a08882f1e811bd706EX", "userId": "AIDAJ3LOROMOUXTBSU6EX", "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser", "permissions": "read-write" } } ``` + Para ver detalhes da API, consulte [CreateEnvironmentMembership](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloud9/create-environment-membership.html) na *Referência de comandos da AWS CLI*. ### `delete-environment-membership` O código de exemplo a seguir mostra como usar `delete-environment-membership`. **AWS CLI** **Para excluir um membro do ambiente de um ambiente de desenvolvimento do AWS Cloud9** Este exemplo exclui o membro de ambiente de desenvolvimento especificado do ambiente de desenvolvimento do AWS Cloud9. Comando: ``` aws cloud9 delete-environment-membership --environment-id 8a34f51ce1e04a08882f1e811bd706EX --user-arn arn:aws:iam::123456789012:user/AnotherDemoUser ``` Resultado: ``` None. ``` + Para ver detalhes da API, consulte [DeleteEnvironmentMembership](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloud9/delete-environment-membership.html) na *Referência de comandos da AWS CLI*. ### `delete-environment` O código de exemplo a seguir mostra como usar `delete-environment`. **AWS CLI** **Para excluir um ambiente de desenvolvimento do AWS Cloud9** Este exemplo exclui o ambiente de desenvolvimento do AWS Cloud9 especificado. Se uma instância do Amazon EC2 estiver conectada ao ambiente, também encerrará a instância. Comando: ``` aws cloud9 delete-environment --environment-id 8a34f51ce1e04a08882f1e811bd706EX ``` Resultado: ``` None. ``` + Para ver detalhes da API, consulte [DeleteEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloud9/delete-environment.html) na *Referência de comandos da AWS CLI*. ### `describe-environment-memberships` O código de exemplo a seguir mostra como usar `describe-environment-memberships`. **AWS CLI** **Para obter informações sobre os membros do ambiente de um ambiente de desenvolvimento do AWS Cloud9** Este exemplo obtém informações sobre os membros do ambiente de desenvolvimento do AWS Cloud9 especificado. Comando: ``` aws cloud9 describe-environment-memberships --environment-id 8a34f51ce1e04a08882f1e811bd706EX ``` Resultado: ``` { "memberships": [ { "environmentId": "8a34f51ce1e04a08882f1e811bd706EX", "userId": "AIDAJ3LOROMOUXTBSU6EX", "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser", "permissions": "read-write" }, { "environmentId": "8a34f51ce1e04a08882f1e811bd706EX", "userId": "AIDAJNUEDQAQWFELJDLEX", "userArn": "arn:aws:iam::123456789012:user/MyDemoUser", "permissions": "owner" } ] } ``` **Para obter informações sobre o proprietário de um ambiente de desenvolvimento do AWS Cloud9** Este exemplo obtém informações sobre o proprietário do ambiente de desenvolvimento do AWS Cloud9 especificado. Comando: ``` aws cloud9 describe-environment-memberships --environment-id 8a34f51ce1e04a08882f1e811bd706EX --permissions owner ``` Resultado: ``` { "memberships": [ { "environmentId": "8a34f51ce1e04a08882f1e811bd706EX", "userId": "AIDAJNUEDQAQWFELJDLEX", "userArn": "arn:aws:iam::123456789012:user/MyDemoUser", "permissions": "owner" } ] } ``` **Para obter informações sobre os membros do ambiente de vários ambientes de desenvolvimento do AWS Cloud9** Este exemplo obtém informações sobre o membro do ambiente especificado para vários ambientes de desenvolvimento do AWS Cloud9. Comando: ``` aws cloud9 describe-environment-memberships --user-arn arn:aws:iam::123456789012:user/MyDemoUser ``` Resultado: ``` { "memberships": [ { "environmentId": "10a75714bd494714929e7f5ec4125aEX", "lastAccess": 1516213427.0, "userId": "AIDAJNUEDQAQWFELJDLEX", "userArn": "arn:aws:iam::123456789012:user/MyDemoUser", "permissions": "owner" }, { "environmentId": "1980b80e5f584920801c09086667f0EX", "lastAccess": 1516144884.0, "userId": "AIDAJNUEDQAQWFELJDLEX", "userArn": "arn:aws:iam::123456789012:user/MyDemoUser", "permissions": "owner" } ] } ``` + Para ver detalhes da API, consulte [DescribeEnvironmentMemberships](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloud9/describe-environment-memberships.html) na *Referência de comandos da AWS CLI*. ### `describe-environment-status` O código de exemplo a seguir mostra como usar `describe-environment-status`. **AWS CLI** **Para obter informações sobre o status de um ambiente de desenvolvimento do AWS Cloud9** Este exemplo obtém informações sobre o status do ambiente de desenvolvimento do AWS Cloud9. Comando: ``` aws cloud9 describe-environment-status --environment-id 685f892f431b45c2b28cb69eadcdb0EX ``` Resultado: ``` { "status": "ready", "message": "Environment is ready to use" } ``` + Para ver detalhes da API, consulte [DescribeEnvironmentStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloud9/describe-environment-status.html) na *Referência de comandos da AWS CLI*. ### `describe-environments` O código de exemplo a seguir mostra como usar `describe-environments`. **AWS CLI** **Para obter informações sobre os ambientes de desenvolvimento do AWS Cloud9** Este exemplo obtém informações sobre ambientes de desenvolvimento do AWS Cloud9. Comando: ``` aws cloud9 describe-environments --environment-ids 685f892f431b45c2b28cb69eadcdb0EX 349c86d4579e4e7298d500ff57a6b2EX ``` Resultado: ``` { "environments": [ { "id": "685f892f431b45c2b28cb69eadcdb0EX", "name": "my-demo-ec2-env", "description": "Created from CodeStar.", "type": "ec2", "arn": "arn:aws:cloud9:us-east-1:123456789012:environment:685f892f431b45c2b28cb69eadcdb0EX", "ownerArn": "arn:aws:iam::123456789012:user/MyDemoUser", "lifecycle": { "status": "CREATED" } }, { "id": "349c86d4579e4e7298d500ff57a6b2EX", "name": my-demo-ssh-env", "description": "", "type": "ssh", "arn": "arn:aws:cloud9:us-east-1:123456789012:environment:349c86d4579e4e7298d500ff57a6b2EX", "ownerArn": "arn:aws:iam::123456789012:user/MyDemoUser", "lifecycle": { "status": "CREATED" } } ] } ``` + Para ver detalhes da API, consulte [DescribeEnvironments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloud9/describe-environments.html) na *Referência de comandos da AWS CLI*. ### `list-environments` O código de exemplo a seguir mostra como usar `list-environments`. **AWS CLI** **Para obter uma lista de identificadores de ambiente de desenvolvimento do AWS Cloud9** Este exemplo obtém uma lista de identificadores de ambientes de desenvolvimento do AWS Cloud9. Comando: ``` aws cloud9 list-environments ``` Resultado: ``` { "environmentIds": [ "685f892f431b45c2b28cb69eadcdb0EX", "1980b80e5f584920801c09086667f0EX" ] } ``` + Para ver detalhes da API, consulte [ListEnvironments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloud9/list-environments.html) na *Referência de comandos da AWS CLI*. ### `update-environment-membership` O código de exemplo a seguir mostra como usar `update-environment-membership`. **AWS CLI** **Para alterar as configurações de um membro do ambiente de desenvolvimento existente para um ambiente de desenvolvimento do AWS Cloud9** Este exemplo altera as configurações do membro de um ambiente de desenvolvimento existente especificado do AWS Cloud9. Comando: ``` aws cloud9 update-environment-membership --environment-id 8a34f51ce1e04a08882f1e811bd706EX --user-arn arn:aws:iam::123456789012:user/AnotherDemoUser --permissions read-only ``` Resultado: ``` { "membership": { "environmentId": "8a34f51ce1e04a08882f1e811bd706EX", "userId": "AIDAJ3LOROMOUXTBSU6EX", "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser", "permissions": "read-only" } } ``` + Para ver detalhes da API, consulte [UpdateEnvironmentMembership](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloud9/update-environment-membership.html) na *Referência de comandos da AWS CLI*. ### `update-environment` O código de exemplo a seguir mostra como usar `update-environment`. **AWS CLI** **Para alterar as configurações de um ambiente de desenvolvimento existente do AWS Cloud9** Este exemplo altera as configurações especificadas do ambiente de desenvolvimento do AWS Cloud9 existente especificado. Comando: ``` aws cloud9 update-environment --environment-id 8a34f51ce1e04a08882f1e811bd706EX --name my-changed-demo-env --description "My changed demonstration development environment." ``` Resultado: ``` None. ``` + Para ver detalhes da API, consulte [UpdateEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloud9/update-environment.html) na *Referência de comandos da AWS CLI*. # Exemplos do CloudFormation usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o 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 ### `activate-type` O código de exemplo a seguir mostra como usar `activate-type`. **AWS CLI** **Como ativar um tipo** O exemplo `activate-type` a seguir ativa uma extensão pública de terceiros, tornando-a disponível para uso em modelos de pilha. ``` aws cloudformation activate-type \ --region us-west-2 \ --type RESOURCE \ --type-name Example::Test::1234567890abcdef0 \ --type-name-alias Example::Test::Alias ``` Resultado: ``` { "Arn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/Example-Test-Alias" } ``` Para obter mais informações, consulte [Usar o registro do AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [ActivateType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/activate-type.html) na *Referência de comandos da AWS CLI*. ### `batch-describe-type-configurations` O código de exemplo a seguir mostra como usar `batch-describe-type-configurations`. **AWS CLI** **Para descrever uma configuração de tipo em lote** O exemplo `batch-describe-type-configurations` a seguir configura os dados para o tipo. ``` aws cloudformation batch-describe-type-configurations \ --region us-west-2 \ --type-configuration-identifiers TypeArn="arn:aws:cloudformation:us-west-2:123456789012:type/resource/Example-Test-Type,TypeConfigurationAlias=MyConfiguration" ``` Resultado: ``` { "Errors": [], "UnprocessedTypeConfigurations": [], "TypeConfigurations": [ { "Arn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/Example-Test-Type", "Alias": "MyConfiguration", "Configuration": "{\n \"Example\": {\n \"ApiKey\": \"examplekey\",\n \"ApplicationKey\": \"examplekey1\",\n \"ApiURL\": \"exampleurl\"\n }\n}", "LastUpdated": "2021-10-01T15:25:46.210000+00:00", "TypeArn": "arn:aws:cloudformation:us-east-1:123456789012:type/resource/Example-Test-Type" } ] } ``` Para obter mais informações, consulte [Usar o registro do AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [BatchDescribeTypeConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/batch-describe-type-configurations.html) na *Referência de comandos da AWS CLI*. ### `cancel-update-stack` O código de exemplo a seguir mostra como usar `cancel-update-stack`. **AWS CLI** **Para cancelar uma atualização de pilha que está em andamento** O comando `cancel-update-stack` a seguir cancela uma atualização de pilha na pilha `myteststack`: ``` aws cloudformation cancel-update-stack --stack-name myteststack ``` + Consulte detalhes da API em [CancelUpdateStack](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/cancel-update-stack.html) na *AWS CLI Command Reference*. ### `continue-update-rollback` O código de exemplo a seguir mostra como usar `continue-update-rollback`. **AWS CLI** **Para fazer nova tentativa de reversão de atualização** O exemplo `continue-update-rollback` a seguir retoma uma operação de reversão de uma atualização de pilha anterior em que houve falha. ``` aws cloudformation continue-update-rollback \ --stack-name my-stack ``` Este comando não produz saída. + Consulte detalhes da API em [ContinueUpdateRollback](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/continue-update-rollback.html) na *AWS CLI Command Reference*. ### `create-change-set` O código de exemplo a seguir mostra como usar `create-change-set`. **AWS CLI** **Para criar um conjunto de alterações** O exemplo `create-change-set` a seguir cria um conjunto de alterações com o recurso `CAPABILITY_IAM`. O arquivo `template.yaml` é um modelo do AWS CloudFormation na pasta atual que define uma pilha que inclui recursos do IAM. ``` aws cloudformation create-change-set \ --stack-name my-application \ --change-set-name my-change-set \ --template-body file://template.yaml \ --capabilities CAPABILITY_IAM ``` Resultado: ``` { "Id": "arn:aws:cloudformation:us-west-2:123456789012:changeSet/my-change-set/bc9555ba-a949-xmpl-bfb8-f41d04ec5784", "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-application/d0a825a0-e4cd-xmpl-b9fb-061c69e99204" } ``` + Para ver detalhes da API, consulte [CreateChangeSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/create-change-set.html) na *Referência de comandos da AWS CLI*. ### `create-generated-template` O código de exemplo a seguir mostra como usar `create-generated-template`. **AWS CLI** **Como criar um modelo gerado de recursos verificados** O exemplo de `create-generated-template` a seguir cria um modelo gerado de recursos verificados com o nome `MyTemplate`. ``` aws cloudformation create-generated-template \ --generated-template-name MyTemplate \ --resources file://resources.json ``` Conteúdo de `resources.json`: ``` [ { "ResourceType": "AWS::EKS::Cluster", "LogicalResourceId":"MyCluster", "ResourceIdentifier": { "ClusterName": "MyAppClusterName" } }, { "ResourceType": "AWS::AutoScaling::AutoScalingGroup", "LogicalResourceId":"MyASG", "ResourceIdentifier": { "AutoScalingGroupName": "MyAppASGName" } }, { "ResourceType": "AWS::EKS::Nodegroup", "LogicalResourceId":"MyNodegroup", "ResourceIdentifier": { "NodegroupName": "MyAppNodegroupName" } }, { "ResourceType": "AWS::IAM::Role", "LogicalResourceId":"MyRole", "ResourceIdentifier": { "RoleId": "arn:aws::iam::123456789012:role/MyAppIAMRole" } } ] ``` Resultado: ``` { "Arn": "arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/7fc8512c-d8cb-4e02-b266-d39c48344e48", "Name": "MyTemplate" } ``` Para ter mais informações, consulte [Criar um modelo do CloudFormation a partir de recursos verificados com o gerador de IaC](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/iac-generator-create-template-from-scanned-resources.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [CreateGeneratedTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/create-generated-template.html) na *Referência de comandos da AWS CLI*. ### `create-stack-instances` O código de exemplo a seguir mostra como usar `create-stack-instances`. **AWS CLI** **Para criar instâncias da pilha** O exemplo `create-stack-instances` a seguir cria instâncias de um conjunto de pilhas em duas contas e em quatro regiões. A configuração de tolerância a falhas garante que a atualização seja tentada em todas as contas e regiões, mesmo que algumas pilhas não possam ser criadas. ``` aws cloudformation create-stack-instances \ --stack-set-name my-stack-set \ --accounts 123456789012 223456789012 \ --regions us-east-1 us-east-2 us-west-1 us-west-2 \ --operation-preferences FailureToleranceCount=7 ``` Resultado: ``` { "OperationId": "d7995c31-83c2-xmpl-a3d4-e9ca2811563f" } ``` Para criar um conjunto de pilhas, use o comando `create-stack-set`. + Para ver detalhes da API, consulte [CreateStackInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/create-stack-instances.html) na *Referência de comandos da AWS CLI*. ### `create-stack-refactor` O código de exemplo a seguir mostra como usar `create-stack-refactor`. **AWS CLI** **Como criar a definição de pilha para uma operação de refatoração de pilhas** O exemplo de `create-stack-refactor` a seguir cria a definição de pilha para refatoração de pilhas. ``` aws cloudformation create-stack-refactor \ --stack-definitions \ StackName=Stack1,TemplateBody@=file://template1-updated.yaml \ StackName=Stack2,TemplateBody@=file://template2-updated.yaml ``` Resultado: ``` { "StackRefactorId": "9c384f70-4e07-4ed7-a65d-fee5eb430841" } ``` Para ter mais informações, consulte [Refatoração de pilhas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-refactoring.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [CreateStackRefactor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/create-stack-refactor.html) na *Referência de comandos da AWS CLI*. ### `create-stack-set` O código de exemplo a seguir mostra como usar `create-stack-set`. **AWS CLI** **Para criar um conjunto de pilhas** O exemplo `create-stack-set` a seguir cria um conjunto de pilhas usando o modelo de arquivo YAML especificado. `template.yaml` é um modelo do AWS CloudFormation na pasta atual que define uma pilha. ``` aws cloudformation create-stack-set \ --stack-set-name my-stack-set \ --template-body file://template.yaml \ --description "SNS topic" ``` Resultado: ``` { "StackSetId": "my-stack-set:8d0f160b-d157-xmpl-a8e6-c0ce8e5d8cc1" } ``` Para adicionar instâncias de pilha ao conjunto de pilhas, use o comando `create-stack-instances`. + Para ver detalhes da API, consulte [CreateStackSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/create-stack-set.html) na *Referência de comandos da AWS CLI*. ### `create-stack` O código de exemplo a seguir mostra como usar `create-stack`. **AWS CLI** **Para criar uma pilha do AWS CloudFormation** O exemplo de `create-stacks` a seguir cria uma pilha com o nome de `myteststack` usando o arquivo de modelo `sampletemplate.json`: ``` aws cloudformation create-stack --stack-name myteststack --template-body file://sampletemplate.json --parameters ParameterKey=KeyPairName,ParameterValue=TestKey ParameterKey=SubnetIDs,ParameterValue=SubnetID1\\,SubnetID2 ``` Resultado: ``` { "StackId": "arn:aws:cloudformation:us-east-1:123456789012:stack/myteststack/466df9e0-0dff-08e3-8e2f-5088487c4896" } ``` Para obter mais informações, consulte Pilhas no *Guia do usuário do AWS CloudFormation*. + Consulte detalhes da API em [CreateStack](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/create-stack.html) na *AWS CLI Command Reference*. ### `deactivate-type` O código de exemplo a seguir mostra como usar `deactivate-type`. **AWS CLI** **Para desativar um tipo** O exemplo `deactivate-type` a seguir desativa uma extensão pública que foi ativada anteriormente nesta conta e região. ``` aws cloudformation deactivate-type \ --region us-west-2 \ --type MODULE \ --type-name Example::Test::Type::MODULE ``` Este comando não produz saída. Para obter mais informações, consulte [Usar o registro do AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [DeactivateType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/deactivate-type.html) na *Referência de comandos da AWS CLI*. ### `delete-change-set` O código de exemplo a seguir mostra como usar `delete-change-set`. **AWS CLI** **Para excluir um conjunto de alterações** O exemplo `delete-change-set` a seguir exclui um conjunto de alterações especificando o nome do conjunto de alterações e o nome da pilha. ``` aws cloudformation delete-change-set \ --stack-name my-stack \ --change-set-name my-change-set ``` Este comando não produz saída. O exemplo `delete-change-set` a seguir exclui um conjunto de alterações especificando o ARN completo do conjunto de alterações. ``` aws cloudformation delete-change-set \ --change-set-name arn:aws:cloudformation:us-east-2:123456789012:changeSet/my-change-set/4eca1a01-e285-xmpl-8026-9a1967bfb4b0 ``` Este comando não produz saída. + Para ver detalhes da API, consulte [DeleteChangeSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/delete-change-set.html) na *Referência de comandos da AWS CLI*. ### `delete-generated-template` O código de exemplo a seguir mostra como usar `delete-generated-template`. **AWS CLI** **Como excluir um modelo gerado** O exemplo de `delete-generated-template` a seguir exclui o modelo especificado. ``` aws cloudformation delete-generated-template \ --generated-template-name MyTemplate ``` Este comando não produz saída. Para ter mais informações, consulte [Gerar modelos a partir de recursos existentes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [DeleteGeneratedTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/delete-generated-template.html) na *Referência de comandos da AWS CLI*. ### `delete-stack-instances` O código de exemplo a seguir mostra como usar `delete-stack-instances`. **AWS CLI** **Para excluir instâncias de pilha** O exemplo `delete-stack-instances` a seguir exclui instâncias de um conjunto de pilhas em duas contas em duas regiões e encerra as pilhas. ``` aws cloudformation delete-stack-instances \ --stack-set-name my-stack-set \ --accounts 123456789012 567890123456 \ --regions us-east-1 us-west-1 \ --no-retain-stacks ``` Resultado: ``` { "OperationId": "ad49f10c-fd1d-413f-a20a-8de6e2fa8f27" } ``` Para excluir um conjunto de pilhas vazio, use o comando `delete-stack-set`. + Para ver detalhes da API, consulte [DeleteStackInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/delete-stack-instances.html) na *Referência de comandos da AWS CLI*. ### `delete-stack-set` O código de exemplo a seguir mostra como usar `delete-stack-set`. **AWS CLI** **Para excluir um conjunto de pilhas** O comando a seguir exclui o conjunto de pilhas vazio especificado. O conjunto da pilha deve estar vazio. ``` aws cloudformation delete-stack-set \ --stack-set-name my-stack-set ``` Este comando não produz saída. Para excluir instâncias do conjunto de pilhas, use o comando `delete-stack-instances`. + Para ver detalhes da API, consulte [DeleteStackSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/delete-stack-set.html) na *Referência de comandos da AWS CLI*. ### `delete-stack` O código de exemplo a seguir mostra como usar `delete-stack`. **AWS CLI** **Para excluir uma pilha** O exemplo de `delete-stack` a seguir exclui a pilha especificada. ``` aws cloudformation delete-stack \ --stack-name my-stack ``` Este comando não produz saída. + Consulte detalhes da API em [DeleteStack](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/delete-stack.html) na *AWS CLI Command Reference*. ### `deploy` O código de exemplo a seguir mostra como usar `deploy`. **AWS CLI** O comando a seguir implanta o modelo chamado `template.json` em uma pilha chamada `my-new-stack`: ``` aws cloudformation deploy --template-file /path_to_template/template.json --stack-name my-new-stack --parameter-overrides Key1=Value1 Key2=Value2 --tags Key1=Value1 Key2=Value2 ``` + Para ver detalhes da API, consulte [Deploy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/deploy.html) na *Referência de comandos da AWS CLI*. ### `deregister-type` O código de exemplo a seguir mostra como usar `deregister-type`. **AWS CLI** **Como cancelar o registro de uma versão de tipo** O exemplo `deregister-type` a seguir remove a versão do tipo especificado do uso ativo no registro do CloudFormation, para que ela não possa mais ser usada nas operações do CloudFormation. ``` aws cloudformation deregister-type \ --type RESOURCE \ --type-name My::Logs::LogGroup \ --version-id 00000002 ``` Este comando não produz saída. Para obter mais informações, consulte [Usar o registro do CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [DeregisterType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/deregister-type.html) na *Referência de comandos da AWS CLI*. ### `describe-account-limits` O código de exemplo a seguir mostra como usar `describe-account-limits`. **AWS CLI** **Para obter informações sobre os limites da sua conta** O comando a seguir recupera uma lista de limites regionais para a conta atual. ``` aws cloudformation describe-account-limits ``` Resultado: ``` { "AccountLimits": [ { "Name": "StackLimit", "Value": 200 }, { "Name": "StackOutputsLimit", "Value": 60 }, { "Name": "ConcurrentResourcesLimit", "Value": 2500 } ] } ``` + Para ver detalhes da API, consulte [DescribeAccountLimits](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-account-limits.html) na *Referência de comandos da AWS CLI*. ### `describe-change-set` O código de exemplo a seguir mostra como usar `describe-change-set`. **AWS CLI** **Para obter mais informações sobre um conjunto de alterações** O exemplo `describe-change-set` a seguir exibe os detalhes do conjunto de alterações especificado pelo nome do conjunto de alterações e nome da pilha. ``` aws cloudformation describe-change-set \ --change-set-name my-change-set \ --stack-name my-stack ``` O exemplo `describe-change-set` a seguir exibe os detalhes do conjunto de alterações especificado pelo ARN completo do conjunto de alterações: ``` aws cloudformation describe-change-set \ --change-set-name arn:aws:cloudformation:us-west-2:123456789012:changeSet/my-change-set/bc9555ba-a949-xmpl-bfb8-f41d04ec5784 ``` Resultado: ``` { "Changes": [ { "Type": "Resource", "ResourceChange": { "Action": "Modify", "LogicalResourceId": "function", "PhysicalResourceId": "my-function-SEZV4XMPL4S5", "ResourceType": "AWS::Lambda::Function", "Replacement": "False", "Scope": [ "Properties" ], "Details": [ { "Target": { "Attribute": "Properties", "Name": "Timeout", "RequiresRecreation": "Never" }, "Evaluation": "Static", "ChangeSource": "DirectModification" } ] } } ], "ChangeSetName": "my-change-set", "ChangeSetId": "arn:aws:cloudformation:us-west-2:123456789012:changeSet/my-change-set/4eca1a01-e285-xmpl-8026-9a1967bfb4b0", "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", "StackName": "my-stack", "Description": null, "Parameters": null, "CreationTime": "2019-10-02T05:20:56.651Z", "ExecutionStatus": "AVAILABLE", "Status": "CREATE_COMPLETE", "StatusReason": null, "NotificationARNs": [], "RollbackConfiguration": {}, "Capabilities": [ "CAPABILITY_IAM" ], "Tags": null } ``` + Para ver detalhes da API, consulte [DescribeChangeSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-change-set.html) na *Referência de comandos da AWS CLI*. ### `describe-generated-template` O código de exemplo a seguir mostra como usar `describe-generated-template`. **AWS CLI** **Como descrever um modelo gerado** O exemplo de `describe-generated-template` a seguir descreve o modelo especificado. ``` aws cloudformation describe-generated-template \ --generated-template-name MyTemplate ``` Resultado: ``` { "GeneratedTemplateId": "arn:aws:cloudformation:us-east-1:123456789012:generatedTemplate/7d881acf-f307-4ded-910e-f8fb49b96894", "GeneratedTemplateName": "MyTemplate", "Resources": [ { "ResourceType": "AWS::EC2::SecurityGroup", "LogicalResourceId": "EC2SecurityGroup", "ResourceIdentifier": { "Id": "sg-1234567890abcdef0" }, "ResourceStatus": "COMPLETE", "ResourceStatusReason": "Resource Template complete", "Warnings": [] }, { "ResourceType": "AWS::EC2::Instance", "LogicalResourceId": "EC2Instance", "ResourceIdentifier": { "InstanceId": "i-1234567890abcdef0" }, "ResourceStatus": "COMPLETE", "ResourceStatusReason": "Resource Template complete", "Warnings": [] }, { "ResourceType": "AWS::EC2::KeyPair", "LogicalResourceId": "EC2KeyPairSshkeypair", "ResourceIdentifier": { "KeyName": "sshkeypair" }, "ResourceStatus": "COMPLETE", "ResourceStatusReason": "Resource Template complete", "Warnings": [] } ], "Status": "COMPLETE", "StatusReason": "All resources complete", "CreationTime": "2025-09-23T19:38:06.435000+00:00", "LastUpdatedTime": "2025-09-23T19:38:10.798000+00:00", "Progress": { "ResourcesSucceeded": 3, "ResourcesFailed": 0, "ResourcesProcessing": 0, "ResourcesPending": 0 }, "TemplateConfiguration": { "DeletionPolicy": "RETAIN", "UpdateReplacePolicy": "RETAIN" }, "TotalWarnings": 0 } ``` Para ter mais informações, consulte [Gerar modelos a partir de recursos existentes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [DescribeGeneratedTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-generated-template.html) na *Referência de comandos da AWS CLI*. ### `describe-publisher` O código de exemplo a seguir mostra como usar `describe-publisher`. **AWS CLI** **Para descrever um publicador** O exemplo `describe-publisher` a seguir configura as informações de um publicador. ``` aws cloudformation describe-publisher \ --region us-west-2 \ --publisher-id 000q6TfUovXsEMmgKowxDZLlwqr2QUsh ``` Resultado: ``` { "PublisherId": "000q6TfUovXsEMmgKowxDZLlwqr2QUshd2e75c8c", "PublisherStatus": "VERIFIED", "IdentityProvider": "AWS_Marketplace", "PublisherProfile": "https://aws.amazon.com/marketplace/seller-profile?id=2c5dc1f0-17cd-4259-8e46-822a83gdtegd" } ``` Para obter mais informações, consulte [Usar o registro do AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [DescribePublisher](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-publisher.html) na *Referência de comandos da AWS CLI*. ### `describe-resource-scan` O código de exemplo a seguir mostra como usar `describe-resource-scan`. **AWS CLI** **Para descrever uma varredura de recursos** O exemplo de `describe-resource-scan` a seguir descreve a verificação de recursos com o ID de verificação especificado. ``` aws cloudformation describe-resource-scan --region \ --resource-scan-id arn:aws:cloudformation:us-east-1:123456789012:resourceScan/0a699f15-489c-43ca-a3ef-3e6ecfa5da60 ``` Resultado: ``` { "ResourceScanId": "arn:aws:cloudformation:us-east-1:123456789012:resourceScan/0a699f15-489c-43ca-a3ef-3e6ecfa5da60", "Status": "COMPLETE", "StartTime": "2025-08-21T03:10:38.485000+00:00", "EndTime": "2025-08-21T03:20:28.485000+00:00", "PercentageCompleted": 100.0, "ResourceTypes": [ "AWS::CloudFront::CachePolicy", "AWS::CloudFront::OriginRequestPolicy", "AWS::EC2::DHCPOptions", "AWS::EC2::InternetGateway", "AWS::EC2::KeyPair", "AWS::EC2::NetworkAcl", "AWS::EC2::NetworkInsightsPath", "AWS::EC2::NetworkInterface", "AWS::EC2::PlacementGroup", "AWS::EC2::Route", "AWS::EC2::RouteTable", "AWS::EC2::SecurityGroup", "AWS::EC2::Subnet", "AWS::EC2::SubnetCidrBlock", "AWS::EC2::SubnetNetworkAclAssociation", "AWS::EC2::SubnetRouteTableAssociation", ... ], "ResourcesRead": 676 } ``` Para ter mais informações, consulte [Gerar modelos a partir de recursos existentes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [DescribeResourceScan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-resource-scan.html) na *Referência de comandos da AWS CLI*. ### `describe-stack-drift-detection-status` O código de exemplo a seguir mostra como usar `describe-stack-drift-detection-status`. **AWS CLI** **Como verificar o status de uma operação de detecção de desvios** O exemplo `describe-stack-drift-detection-status` a seguir exibe o status de uma operação de detecção de desvios. Para obter o ID, execute o comando `detect-stack-drift`. ``` aws cloudformation describe-stack-drift-detection-status \ --stack-drift-detection-id 1a229160-e4d9-xmpl-ab67-0a4f93df83d4 ``` Resultado: ``` { "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", "StackDriftDetectionId": "1a229160-e4d9-xmpl-ab67-0a4f93df83d4", "StackDriftStatus": "DRIFTED", "DetectionStatus": "DETECTION_COMPLETE", "DriftedStackResourceCount": 1, "Timestamp": "2019-10-02T05:54:30.902Z" } ``` + Para ver detalhes da API, consulte [DescribeStackDriftDetectionStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-stack-drift-detection-status.html) na *Referência de comandos da AWS CLI*. ### `describe-stack-events` O código de exemplo a seguir mostra como usar `describe-stack-events`. **AWS CLI** **Para descrever os eventos da pilha** O exemplo `describe-stack-events` a seguir exibe os dois eventos mais recentes da pilha especificada. ``` aws cloudformation describe-stack-events \ --stack-name my-stack \ --max-items 2 { "StackEvents": [ { "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", "EventId": "4e1516d0-e4d6-xmpl-b94f-0a51958a168c", "StackName": "my-stack", "LogicalResourceId": "my-stack", "PhysicalResourceId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", "ResourceType": "AWS::CloudFormation::Stack", "Timestamp": "2019-10-02T05:34:29.556Z", "ResourceStatus": "UPDATE_COMPLETE" }, { "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", "EventId": "4dd3c810-e4d6-xmpl-bade-0aaf8b31ab7a", "StackName": "my-stack", "LogicalResourceId": "my-stack", "PhysicalResourceId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", "ResourceType": "AWS::CloudFormation::Stack", "Timestamp": "2019-10-02T05:34:29.127Z", "ResourceStatus": "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS" } ], "NextToken": "eyJOZXh0VG9XMPLiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==" } ``` + Consulte detalhes da API em [DescribeStackEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-stack-events.html) na*AWS CLI Command Reference*. ### `describe-stack-instance` O código de exemplo a seguir mostra como usar `describe-stack-instance`. **AWS CLI** **Para descrever uma instância de pilha** O comando a seguir descreve uma instância do conjunto de pilhas especificado na conta e na região especificadas. O conjunto de pilhas está na região e na conta atuais, e a instância está na região `us-west-2` da conta `123456789012`: ``` aws cloudformation describe-stack-instance \ --stack-set-name my-stack-set \ --stack-instance-account 123456789012 \ --stack-instance-region us-west-2 ``` Resultado: ``` { "StackInstance": { "StackSetId": "enable-config:296a3360-xmpl-40af-be78-9341e95bf743", "Region": "us-west-2", "Account": "123456789012", "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/StackSet-enable-config-e6cac20f-xmpl-46e9-8314-53e0d4591532/4287f9a0-e615-xmpl-894a-12b31d3117be", "ParameterOverrides": [], "Status": "OUTDATED", "StatusReason": "ResourceLogicalId:ConfigBucket, ResourceType:AWS::S3::Bucket, ResourceStatusReason:You have attempted to create more buckets than allowed (Service: Amazon S3; Status Code: 400; Error Code: TooManyBuckets; Request ID: F7F21CXMPL580224; S3 Extended Request ID: egd/Fdt89BXMPLyiqbMNljVk55Yqqvi3NYW2nKLUVWhUGEhNfCmZdyj967lhriaG/dWMobSO40o=)." } } ``` + Para ver detalhes da API, consulte [DescribeStackInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-stack-instance.html) na *Referência de comandos da AWS CLI*. ### `describe-stack-refactor` O código de exemplo a seguir mostra como usar `describe-stack-refactor`. **AWS CLI** **Como descrever uma operação de refatoração de pilha** O exemplo de `describe-stack-refactor` a seguir descreve a operação de refatoração de pilha com o ID de refatoração de pilha especificado. ``` aws cloudformation describe-stack-refactor \ --stack-refactor-id 9c384f70-4e07-4ed7-a65d-fee5eb430841 ``` Resultado: ``` { "StackRefactorId": "9c384f70-4e07-4ed7-a65d-fee5eb430841", "StackIds": [ "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack1/3e6a1ff0-94b1-11f0-aa6f-0a88d2e03acf", "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack2/5da91650-94b1-11f0-81cf-0a23500e151b" ], "ExecutionStatus": "AVAILABLE", "Status": "CREATE_COMPLETE" } ``` Para ter mais informações, consulte [Refatoração de pilhas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-refactoring.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [DescribeStackRefactor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-stack-refactor.html) na *Referência de comandos da AWS CLI*. ### `describe-stack-resource-drifts` O código de exemplo a seguir mostra como usar `describe-stack-resource-drifts`. **AWS CLI** **Para obter informações sobre recursos que desviaram da definição da pilha** O comando a seguir exibe informações sobre recursos desviados da pilha especificada. Para iniciar a detecção de desvios, use o comando `detect-stack-drift`: ``` aws cloudformation describe-stack-resource-drifts \ --stack-name my-stack ``` A saída mostra uma função do AWS Lambda que foi modificada fora de banda: ``` { "StackResourceDrifts": [ { "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", "LogicalResourceId": "function", "PhysicalResourceId": "my-function-SEZV4XMPL4S5", "ResourceType": "AWS::Lambda::Function", "ExpectedProperties": "{\"Description\":\"Write a file to S3.\",\"Environment\":{\"Variables\":{\"bucket\":\"my-stack-bucket-1vc62xmplgguf\"}},\"Handler\":\"index.handler\",\"MemorySize\":128,\"Role\":\"arn:aws:iam::123456789012:role/my-functionRole-HIZXMPLEOM9E\",\"Runtime\":\"nodejs10.x\",\"Tags\":[{\"Key\":\"lambda:createdBy\",\"Value\":\"SAM\"}],\"Timeout\":900,\"TracingConfig\":{\"Mode\":\"Active\"}}", "ActualProperties": "{\"Description\":\"Write a file to S3.\",\"Environment\":{\"Variables\":{\"bucket\":\"my-stack-bucket-1vc62xmplgguf\"}},\"Handler\":\"index.handler\",\"MemorySize\":256,\"Role\":\"arn:aws:iam::123456789012:role/my-functionRole-HIZXMPLEOM9E\",\"Runtime\":\"nodejs10.x\",\"Tags\":[{\"Key\":\"lambda:createdBy\",\"Value\":\"SAM\"}],\"Timeout\":22,\"TracingConfig\":{\"Mode\":\"Active\"}}", "PropertyDifferences": [ { "PropertyPath": "/MemorySize", "ExpectedValue": "128", "ActualValue": "256", "DifferenceType": "NOT_EQUAL" }, { "PropertyPath": "/Timeout", "ExpectedValue": "900", "ActualValue": "22", "DifferenceType": "NOT_EQUAL" } ], "StackResourceDriftStatus": "MODIFIED", "Timestamp": "2019-10-02T05:54:44.064Z" } ] } ``` + Para ver detalhes da API, consulte [DescribeStackResourceDrifts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-stack-resource-drifts.html) na *Referência de comandos da AWS CLI*. ### `describe-stack-resource` O código de exemplo a seguir mostra como usar `describe-stack-resource`. **AWS CLI** **Para obter informações detalhadas sobre o recurso de uma pilha** O exemplo de `describe-stack-resource` a seguir exibe os detalhes do recurso denominado `MyFunction` da pilha especificada. ``` aws cloudformation describe-stack-resource \ --stack-name MyStack \ --logical-resource-id MyFunction ``` Resultado: ``` { "StackResourceDetail": { "StackName": "MyStack", "StackId": "arn:aws:cloudformation:us-east-2:123456789012:stack/MyStack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", "LogicalResourceId": "MyFunction", "PhysicalResourceId": "my-function-SEZV4XMPL4S5", "ResourceType": "AWS::Lambda::Function", "LastUpdatedTimestamp": "2019-10-02T05:34:27.989Z", "ResourceStatus": "UPDATE_COMPLETE", "Metadata": "{}", "DriftInformation": { "StackResourceDriftStatus": "IN_SYNC" } } } ``` + Consulte detalhes da API em [DescribeStackResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-stack-resource.html) na *AWS CLI Command Reference*. ### `describe-stack-resources` O código de exemplo a seguir mostra como usar `describe-stack-resources`. **AWS CLI** **Para obter informações detalhadas sobre o recurso de uma pilha** O exemplo de `describe-stack-resources` a seguir exibe os detalhes dos recursos na pilha especificada. ``` aws cloudformation describe-stack-resources \ --stack-name my-stack ``` Resultado: ``` { "StackResources": [ { "StackName": "my-stack", "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", "LogicalResourceId": "bucket", "PhysicalResourceId": "my-stack-bucket-1vc62xmplgguf", "ResourceType": "AWS::S3::Bucket", "Timestamp": "2019-10-02T04:34:11.345Z", "ResourceStatus": "CREATE_COMPLETE", "DriftInformation": { "StackResourceDriftStatus": "IN_SYNC" } }, { "StackName": "my-stack", "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", "LogicalResourceId": "function", "PhysicalResourceId": "my-function-SEZV4XMPL4S5", "ResourceType": "AWS::Lambda::Function", "Timestamp": "2019-10-02T05:34:27.989Z", "ResourceStatus": "UPDATE_COMPLETE", "DriftInformation": { "StackResourceDriftStatus": "IN_SYNC" } }, { "StackName": "my-stack", "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", "LogicalResourceId": "functionRole", "PhysicalResourceId": "my-functionRole-HIZXMPLEOM9E", "ResourceType": "AWS::IAM::Role", "Timestamp": "2019-10-02T04:34:06.350Z", "ResourceStatus": "CREATE_COMPLETE", "DriftInformation": { "StackResourceDriftStatus": "IN_SYNC" } } ] } ``` + Consulte detalhes da API em [DescribeStackResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-stack-resources.html) na *AWS CLI Command Reference*. ### `describe-stack-set-operation` O código de exemplo a seguir mostra como usar `describe-stack-set-operation`. **AWS CLI** **Para obter informações sobre uma operação de conjunto de pilhas** O exemplo describe-stack-set-operation` a seguir exibe detalhes de uma operação de atualização no conjunto de pilhas especificado. ``` aws cloudformation describe-stack-set-operation \ --stack-set-name enable-config \ --operation-id 35d45ebc-ed88-xmpl-ab59-0197a1fc83a0 ``` Resultado: ``` { "StackSetOperation": { "OperationId": "35d45ebc-ed88-xmpl-ab59-0197a1fc83a0", "StackSetId": "enable-config:296a3360-xmpl-40af-be78-9341e95bf743", "Action": "UPDATE", "Status": "SUCCEEDED", "OperationPreferences": { "RegionOrder": [ "us-east-1", "us-west-2", "eu-west-1", "us-west-1" ], "FailureToleranceCount": 7, "MaxConcurrentCount": 2 }, "AdministrationRoleARN": "arn:aws:iam::123456789012:role/AWSCloudFormationStackSetAdministrationRole", "ExecutionRoleName": "AWSCloudFormationStackSetExecutionRole", "CreationTimestamp": "2019-10-03T16:28:44.377Z", "EndTimestamp": "2019-10-03T16:42:08.607Z" } } ``` + Para ver detalhes da API, consulte [DescribeStackSetOperation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-stack-set-operation.html) na *Referência de comandos da AWS CLI*. ### `describe-stack-set` O código de exemplo a seguir mostra como usar `describe-stack-set`. **AWS CLI** **Para obter informações sobre um conjunto de pilhas** O exemplo de describe-stack-set` a seguir exibe detalhes sobre o conjunto de pilhas especificado. ``` aws cloudformation describe-stack-set \ --stack-set-name my-stack-set ``` Resultado: ``` { "StackSet": { "StackSetName": "my-stack-set", "StackSetId": "my-stack-set:296a3360-xmpl-40af-be78-9341e95bf743", "Description": "Create an Amazon SNS topic", "Status": "ACTIVE", "TemplateBody": "AWSTemplateFormatVersion: '2010-09-09'\nDescription: An AWS SNS topic\nResources:\n topic:\n Type: AWS::SNS::Topic", "Parameters": [], "Capabilities": [], "Tags": [], "StackSetARN": "arn:aws:cloudformation:us-west-2:123456789012:stackset/enable-config:296a3360-xmpl-40af-be78-9341e95bf743", "AdministrationRoleARN": "arn:aws:iam::123456789012:role/AWSCloudFormationStackSetAdministrationRole", "ExecutionRoleName": "AWSCloudFormationStackSetExecutionRole" } } ``` + Para ver detalhes da API, consulte [DescribeStackSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-stack-set.html) na *Referência de comandos da AWS CLI*. ### `describe-stacks` O código de exemplo a seguir mostra como usar `describe-stacks`. **AWS CLI** **Para descrever as pilhas do AWS CloudFormation** O comando `describe-stacks` a seguir mostra informações resumidas da pilha `myteststack`: ``` aws cloudformation describe-stacks --stack-name myteststack ``` Resultado: ``` { "Stacks": [ { "StackId": "arn:aws:cloudformation:us-east-1:123456789012:stack/myteststack/466df9e0-0dff-08e3-8e2f-5088487c4896", "Description": "AWS CloudFormation Sample Template S3_Bucket: Sample template showing how to create a publicly accessible S3 bucket. **WARNING** This template creates an S3 bucket. You will be billed for the AWS resources used if you create a stack from this template.", "Tags": [], "Outputs": [ { "Description": "Name of S3 bucket to hold website content", "OutputKey": "BucketName", "OutputValue": "myteststack-s3bucket-jssofi1zie2w" } ], "StackStatusReason": null, "CreationTime": "2013-08-23T01:02:15.422Z", "Capabilities": [], "StackName": "myteststack", "StackStatus": "CREATE_COMPLETE", "DisableRollback": false } ] } ``` Para obter mais informações, consulte Pilhas no *Guia do usuário do AWS CloudFormation*. + Consulte detalhes da API em [DescribeStacks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-stacks.html) na *AWS CLI Command Reference*. ### `describe-type-registration` O código de exemplo a seguir mostra como usar `describe-type-registration`. **AWS CLI** **Como exibir as informações de registro do tipo** O exemplo `describe-type-registration` a seguir exibe informações sobre o registro de tipo especificado, incluindo o status atual, o tipo e a versão do tipo. ``` aws cloudformation describe-type-registration \ --registration-token a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "ProgressStatus": "COMPLETE", "TypeArn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-Logs-LogGroup", "Description": "Deployment is currently in DEPLOY_STAGE of status COMPLETED; ", "TypeVersionArn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-Logs-LogGroup/00000001" } ``` Para obter mais informações, consulte [Usar o registro do CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [DescribeTypeRegistration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-type-registration.html) na *Referência de comandos da AWS CLI*. ### `describe-type` O código de exemplo a seguir mostra como usar `describe-type`. **AWS CLI** **Como exibir as informações de tipo** O exemplo `describe-type` a seguir mostra as informações do tipo especificado. ``` aws cloudformation describe-type \ --type-name My::Logs::LogGroup \ --type RESOURCE ``` Resultado: ``` { "SourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git", "Description": "Customized resource derived from AWS::Logs::LogGroup", "TimeCreated": "2019-12-03T23:29:33.321Z", "Visibility": "PRIVATE", "TypeName": "My::Logs::LogGroup", "LastUpdated": "2019-12-03T23:29:33.321Z", "DeprecatedStatus": "LIVE", "ProvisioningType": "FULLY_MUTABLE", "Type": "RESOURCE", "Arn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-Logs-LogGroup/00000001", "Schema": "[details omitted]" } ``` Para obter mais informações, consulte [Usar o registro do CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [DescribeType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-type.html) na *Referência de comandos da AWS CLI*. ### `detect-stack-drift` O código de exemplo a seguir mostra como usar `detect-stack-drift`. **AWS CLI** **Como detectar recursos desviados** O exemplo `detect-stack-drift` a seguir inicia a detecção de desvios na pilha específica. ``` aws cloudformation detect-stack-drift \ --stack-name my-stack ``` Resultado: ``` { "StackDriftDetectionId": "1a229160-e4d9-xmpl-ab67-0a4f93df83d4" } ``` Em seguida, você pode usar esse ID com o comando `describe-stack-resource-drifts` para descrever recursos desviados. + Para ver detalhes da API, consulte [DetectStackDrift](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/detect-stack-drift.html) na *Referência de comandos da AWS CLI*. ### `detect-stack-resource-drift` O código de exemplo a seguir mostra como usar `detect-stack-resource-drift`. **AWS CLI** **Como detectar o desvio de um recurso** O exemplo `detect-stack-resource-drift` a seguir verifica se há desvios em um recurso chamado `MyFunction` em uma pilha chamada `MyStack`: ``` aws cloudformation detect-stack-resource-drift \ --stack-name MyStack \ --logical-resource-id MyFunction ``` A saída mostra uma função do AWS Lambda que foi modificada fora de banda: ``` { "StackResourceDrift": { "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/MyStack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", "LogicalResourceId": "MyFunction", "PhysicalResourceId": "my-function-SEZV4XMPL4S5", "ResourceType": "AWS::Lambda::Function", "ExpectedProperties": "{\"Description\":\"Write a file to S3.\",\"Environment\":{\"Variables\":{\"bucket\":\"my-stack-bucket-1vc62xmplgguf\"}},\"Handler\":\"index.handler\",\"MemorySize\":128,\"Role\":\"arn:aws:iam::123456789012:role/my-functionRole-HIZXMPLEOM9E\",\"Runtime\":\"nodejs10.x\",\"Tags\":[{\"Key\":\"lambda:createdBy\",\"Value\":\"SAM\"}],\"Timeout\":900,\"TracingConfig\":{\"Mode\":\"Active\"}}", "ActualProperties": "{\"Description\":\"Write a file to S3.\",\"Environment\":{\"Variables\":{\"bucket\":\"my-stack-bucket-1vc62xmplgguf\"}},\"Handler\":\"index.handler\",\"MemorySize\":256,\"Role\":\"arn:aws:iam::123456789012:role/my-functionRole-HIZXMPLEOM9E\",\"Runtime\":\"nodejs10.x\",\"Tags\":[{\"Key\":\"lambda:createdBy\",\"Value\":\"SAM\"}],\"Timeout\":22,\"TracingConfig\":{\"Mode\":\"Active\"}}", "PropertyDifferences": [ { "PropertyPath": "/MemorySize", "ExpectedValue": "128", "ActualValue": "256", "DifferenceType": "NOT_EQUAL" }, { "PropertyPath": "/Timeout", "ExpectedValue": "900", "ActualValue": "22", "DifferenceType": "NOT_EQUAL" } ], "StackResourceDriftStatus": "MODIFIED", "Timestamp": "2019-10-02T05:58:47.433Z" } } ``` + Para ver detalhes da API, consulte [DetectStackResourceDrift](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/detect-stack-resource-drift.html) na *Referência de comandos da AWS CLI*. ### `detect-stack-set-drift` O código de exemplo a seguir mostra como usar `detect-stack-set-drift`. **AWS CLI** **Como detectar desvios em um conjunto de pilhas e em todas as instâncias de pilha associadas** O exemplo `detect-stack-set-drift` a seguir inicia as operações de detecção de desvio no conjunto de pilhas especificado, incluindo todas as instâncias de pilha associadas a esse conjunto de pilhas, e retorna um ID de operação que pode ser usado para rastrear o status da operação de desvio. ``` aws cloudformation detect-stack-set-drift \ --stack-set-name stack-set-drift-example ``` Resultado: ``` { "OperationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } ``` Para obter mais informações, consulte [Detectar alterações de configuração não gerenciadas em conjuntos de pilhas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [DetectStackSetDrift](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/detect-stack-set-drift.html) na *Referência de comandos da AWS CLI*. ### `estimate-template-cost` O código de exemplo a seguir mostra como usar `estimate-template-cost`. **AWS CLI** **Para estimar o custo do modelo** O exemplo de `estimate-template-cost` a seguir gera uma estimativa de custo para um modelo denominado `template.yaml` na pasta atual. ``` aws cloudformation estimate-template-cost \ --template-body file://template.yaml ``` Resultado: ``` { "Url": "http://calculator.s3.amazonaws.com/calc5.html?key=cloudformation/7870825a-xmpl-4def-92e7-c4f8dd360cca" } ``` + Consulte detalhes da API em [EstimateTemplateCost](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/estimate-template-cost.html) na *AWS CLI Command Reference*. ### `execute-change-set` O código de exemplo a seguir mostra como usar `execute-change-set`. **AWS CLI** **Para executar um conjunto de alterações** O exemplo `execute-change-set` a seguir executa um conjunto de alterações especificado pelo nome do conjunto de alterações e nome da pilha. ``` aws cloudformation execute-change-set \ --change-set-name my-change-set \ --stack-name my-stack ``` O exemplo `execute-change-set` a seguir executa um conjunto de alterações especificado pelo ARN completo do conjunto de alterações. ``` aws cloudformation execute-change-set \ --change-set-name arn:aws:cloudformation:us-west-2:123456789012:changeSet/my-change-set/bc9555ba-a949-xmpl-bfb8-f41d04ec5784 ``` + Para ver detalhes da API, consulte [ExecuteChangeSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/execute-change-set.html) na *Referência de comandos da AWS CLI*. ### `execute-stack-refactor` O código de exemplo a seguir mostra como usar `execute-stack-refactor`. **AWS CLI** **Como concluir uma operação de refatoração de pilha** O exemplo de `execute-stack-refactor` a seguir conclui a operação de refatoração de pilha com o ID de refatoração de pilha especificado. ``` aws cloudformation execute-stack-refactor \ --stack-refactor-id 9c384f70-4e07-4ed7-a65d-fee5eb430841 ``` Este comando não produz saída. Para ter mais informações, consulte [Refatoração de pilhas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-refactoring.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [ExecuteStackRefactor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/execute-stack-refactor.html) na *Referência de comandos da AWS CLI*. ### `get-stack-policy` O código de exemplo a seguir mostra como usar `get-stack-policy`. **AWS CLI** **Como visualizar uma política de pilha** O exemplo `get-stack-policy` a seguir exibe os detalhes da política de pilha da pilha especificada. Para anexar uma política a uma pilha, use o comando `set-stack-policy`. ``` aws cloudformation get-stack-policy \ --stack-name my-stack ``` Resultado: ``` { "StackPolicyBody": "{\n \"Statement\" : [\n {\n \"Effect\" : \"Allow\",\n \"Action\" : \"Update:*\",\n \"Principal\": \"*\",\n \"Resource\" : \"*\"\n },\n {\n \"Effect\" : \"Deny\",\n \"Action\" : \"Update:*\",\n \"Principal\": \"*\",\n \"Resource\" : \"LogicalResourceId/bucket\"\n }\n ]\n}\n" } ``` + Para ver detalhes da API, consulte [GetStackPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/get-stack-policy.html) na *Referência de comandos da AWS CLI*. ### `get-template-summary` O código de exemplo a seguir mostra como usar `get-template-summary`. **AWS CLI** **Como exibir um resumo do modelo** O comando a seguir exibe informações de resumo sobre os recursos e metadados do arquivo de modelo especificado. ``` aws cloudformation get-template-summary \ --template-body file://template.yaml ``` Resultado: ``` { "Parameters": [], "Description": "A VPC and subnets.", "ResourceTypes": [ "AWS::EC2::VPC", "AWS::EC2::Subnet", "AWS::EC2::Subnet", "AWS::EC2::RouteTable", "AWS::EC2::VPCEndpoint", "AWS::EC2::SubnetRouteTableAssociation", "AWS::EC2::SubnetRouteTableAssociation", "AWS::EC2::VPCEndpoint" ], "Version": "2010-09-09" } ``` + Para ver detalhes da API, consulte [GetTemplateSummary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/get-template-summary.html) na *Referência de comandos da AWS CLI*. ### `get-template` O código de exemplo a seguir mostra como usar `get-template`. **AWS CLI** **Para visualizar o corpo do modelo de uma pilha do AWS CloudFormation** O comando `get-template` a seguir mostra o modelo da pilha `myteststack`: ``` aws cloudformation get-template --stack-name myteststack ``` Resultado: ``` { "TemplateBody": { "AWSTemplateFormatVersion": "2010-09-09", "Outputs": { "BucketName": { "Description": "Name of S3 bucket to hold website content", "Value": { "Ref": "S3Bucket" } } }, "Description": "AWS CloudFormation Sample Template S3_Bucket: Sample template showing how to create a publicly accessible S3 bucket. **WARNING** This template creates an S3 bucket. You will be billed for the AWS resources used if you create a stack from this template.", "Resources": { "S3Bucket": { "Type": "AWS::S3::Bucket", "Properties": { "AccessControl": "PublicRead" } } } } } ``` + Consulte detalhes da API em [GetTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/get-template.html) na *AWS CLI Command Reference*. ### `list-change-sets` O código de exemplo a seguir mostra como usar `list-change-sets`. **AWS CLI** **Para listar conjuntos de alterações** O exemplo `list-change-sets` a seguir exibe uma lista dos conjuntos de alterações pendentes da pilha especificada. ``` aws cloudformation list-change-sets \ --stack-name my-stack ``` Resultado: ``` { "Summaries": [ { "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", "StackName": "my-stack", "ChangeSetId": "arn:aws:cloudformation:us-west-2:123456789012:changeSet/my-change-set/70160340-7914-xmpl-bcbf-128a1fa78b5d", "ChangeSetName": "my-change-set", "ExecutionStatus": "AVAILABLE", "Status": "CREATE_COMPLETE", "CreationTime": "2019-10-02T05:38:54.297Z" } ] } ``` + Para ver detalhes da API, consulte [ListChangeSets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-change-sets.html) na *Referência de comandos da AWS CLI*. ### `list-exports` O código de exemplo a seguir mostra como usar `list-exports`. **AWS CLI** **Para listar as exportações** O exemplo `list-exports` a seguir exibe uma lista das exportações das pilhas na região atual. ``` aws cloudformation list-exports ``` Resultado: ``` { "Exports": [ { "ExportingStackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/private-vpc/99764070-b56c-xmpl-bee8-062a88d1d800", "Name": "private-vpc-subnet-a", "Value": "subnet-07b410xmplddcfa03" }, { "ExportingStackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/private-vpc/99764070-b56c-xmpl-bee8-062a88d1d800", "Name": "private-vpc-subnet-b", "Value": "subnet-075ed3xmplebd2fb1" }, { "ExportingStackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/private-vpc/99764070-b56c-xmpl-bee8-062a88d1d800", "Name": "private-vpc-vpcid", "Value": "vpc-011d7xmpl100e9841" } ] } ``` + Para ver detalhes da API, consulte [ListExports](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-exports.html) na *Referência de comandos da AWS CLI*. ### `list-generated-templates` O código de exemplo a seguir mostra como usar `list-generated-templates`. **AWS CLI** **Como listar modelos gerados** O exemplo de `list-generated-templates` a seguir lista todos os modelos gerados. ``` aws cloudformation list-generated-templates ``` Resultado: ``` { "Summaries": [ { "GeneratedTemplateId": "arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/7fc8512c-d8cb-4e02-b266-d39c48344e48", "GeneratedTemplateName": "MyTemplate", "Status": "COMPLETE", "StatusReason": "All resources complete", "CreationTime": "2025-09-23T20:13:24.283000+00:00", "LastUpdatedTime": "2025-09-23T20:13:28.610000+00:00", "NumberOfResources": 4 }, { "GeneratedTemplateId": "arn:aws:cloudformation:us-east-1:123456789012:generatedTemplate/f10dd1c4-edc6-4823-8153-ab6112b8d051", "GeneratedTemplateName": "MyEC2InstanceTemplate", "Status": "COMPLETE", "StatusReason": "All resources complete", "CreationTime": "2024-08-08T19:35:49.790000+00:00", "LastUpdatedTime": "2024-08-08T19:35:52.207000+00:00", "NumberOfResources": 3 }, { "GeneratedTemplateId": "arn:aws:cloudformation:us-east-1:123456789012:generatedTemplate/e5a1c89f-7ce2-41bd-9bdf-75b7c852e3ca", "GeneratedTemplateName": "MyEKSNodeGroupTemplate", "Status": "COMPLETE", "StatusReason": "All resources complete", "CreationTime": "2024-07-16T20:39:27.883000+00:00", "LastUpdatedTime": "2024-07-16T20:39:35.766000+00:00", "NumberOfResources": 4 } ] } ``` Para ter mais informações, consulte [Gerar modelos a partir de recursos existentes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [ListGeneratedTemplates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-generated-templates.html) na *Referência de comandos da AWS CLI*. ### `list-imports` O código de exemplo a seguir mostra como usar `list-imports`. **AWS CLI** **Para listar as importações** O exemplo `list-imports` a seguir lista as pilhas que importam a exportação especificada. Para obter a lista de exportações disponíveis, use o comando `list-exports`. ``` aws cloudformation list-imports \ --export-name private-vpc-vpcid ``` Resultado: ``` { "Imports": [ "my-database-stack" ] } ``` + Para ver detalhes da API, consulte [ListImports](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-imports.html) na *Referência de comandos da AWS CLI*. ### `list-resource-scan-related-resources` O código de exemplo a seguir mostra como usar `list-resource-scan-related-resources`. **AWS CLI** **Como listar recursos relacionados usando uma verificação de recursos** O exemplo de `list-resource-scan-related-resources` a seguir lista os recursos da verificação especificada que estão relacionados aos recursos em `resources.json`. ``` aws cloudformation list-resource-scan-related-resources \ --resource-scan-id arn:aws:cloudformation:us-east-1:123456789012:resourceScan/0a699f15-489c-43ca-a3ef-3e6ecfa5da60 \ --resources file://resources.json ``` Conteúdo de `resources.json`: ``` [ { "ResourceType": "AWS::EKS::Cluster", "ResourceIdentifier": { "ClusterName": "MyAppClusterName" } }, { "ResourceType": "AWS::AutoScaling::AutoScalingGroup", "ResourceIdentifier": { "AutoScalingGroupName": "MyAppASGName" } } ] ``` Resultado: ``` { "RelatedResources": [ { "ResourceType": "AWS::EKS::Nodegroup", "ResourceIdentifier": { "NodegroupName": "MyAppNodegroupName" }, "ManagedByStack": false }, { "ResourceType": "AWS::IAM::Role", "ResourceIdentifier": { "RoleId": "arn:aws::iam::123456789012:role/MyAppIAMRole" }, "ManagedByStack": false } ] } ``` Para ter mais informações, consulte [Criar um modelo do CloudFormation a partir de recursos verificados com o gerador de IaC](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/iac-generator-create-template-from-scanned-resources.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [ListResourceScanRelatedResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-resource-scan-related-resources.html) na *Referência de comandos da AWS CLI*. ### `list-resource-scan-resources` O código de exemplo a seguir mostra como usar `list-resource-scan-resources`. **AWS CLI** **Como listar recursos de uma verificação de recursos** O exemplo de `list-resource-scan-resources` a seguir lista os recursos da verificação de recursos especificada, filtrados por identificador de recurso. ``` aws cloudformation list-resource-scan-resources \ --resource-scan-id arn:aws:cloudformation:us-east-1:123456789012:resourceScan/0a699f15-489c-43ca-a3ef-3e6ecfa5da60 \ --resource-identifier MyApp ``` Resultado: ``` { "Resources": [ { "ResourceType": "AWS::EKS::Cluster", "ResourceIdentifier": { "ClusterName": "MyAppClusterName" }, "ManagedByStack": false }, { "ResourceType": "AWS::AutoScaling::AutoScalingGroup", "ResourceIdentifier": { "AutoScalingGroupName": "MyAppASGName" }, "ManagedByStack": false } ] } ``` Para ter mais informações, consulte [Criar um modelo do CloudFormation a partir de recursos verificados com o gerador de IaC](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/iac-generator-create-template-from-scanned-resources.html) no *Guia do usuário do AWS CloudFormation*. + Consulte detalhes da API em [ListResourceScanResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-resource-scan-resources.html) na *Referência de comandos da AWS CLI*. ### `list-stack-instances` O código de exemplo a seguir mostra como usar `list-stack-instances`. **AWS CLI** **Como listar instâncias para uma pilha** O exemplo `list-stack-instances` a seguir lista as instâncias criadas a partir do conjunto de pilhas especificado. ``` aws cloudformation list-stack-instances \ --stack-set-name enable-config ``` O exemplo de saída inclui detalhes sobre uma pilha que falhou na atualização devido a um erro: ``` { "Summaries": [ { "StackSetId": "enable-config:296a3360-xmpl-40af-be78-9341e95bf743", "Region": "us-west-2", "Account": "123456789012", "StackId": "arn:aws:cloudformation:ap-northeast-1:123456789012:stack/StackSet-enable-config-35a6ac50-d9f8-4084-86e4-7da34d5de4c4/a1631cd0-e5fb-xmpl-b474-0aa20f14f06e", "Status": "CURRENT" }, { "StackSetId": "enable-config:296a3360-xmpl-40af-be78-9341e95bf743", "Region": "us-west-2", "Account": "123456789012", "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/StackSet-enable-config-e6cac20f-xmpl-46e9-8314-53e0d4591532/eab53680-e5fa-xmpl-ba14-0a522351f81e", "Status": "OUTDATED", "StatusReason": "ResourceLogicalId:ConfigDeliveryChannel, ResourceType:AWS::Config::DeliveryChannel, ResourceStatusReason:Failed to put delivery channel 'StackSet-enable-config-e6cac20f-xmpl-46e9-8314-53e0d4591532-ConfigDeliveryChannel-1OJWJ7XD59WR0' because the maximum number of delivery channels: 1 is reached. (Service: AmazonConfig; Status Code: 400; Error Code: MaxNumberOfDeliveryChannelsExceededException; Request ID: d14b34a0-ef7c-xmpl-acf8-8a864370ae56)." } ] } ``` + Para ver detalhes da API, consulte [ListStackInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-stack-instances.html) na *Referência de comandos da AWS CLI*. ### `list-stack-refactor-actions` O código de exemplo a seguir mostra como usar `list-stack-refactor-actions`. **AWS CLI** **Como listar ações para uma operação de refatoração de pilhas** O exemplo de `list-stack-refactor-actions` a seguir lista ações para a operação de refatoração de pilhas com o ID de refatoração de pilhas especificado. ``` aws cloudformation list-stack-refactor-actions \ --stack-refactor-id 9c384f70-4e07-4ed7-a65d-fee5eb430841 ``` Resultado: ``` { "StackRefactorActions": [ { "Action": "MOVE", "Entity": "RESOURCE", "PhysicalResourceId": "MyTestLambdaRole", "Description": "No configuration changes detected.", "Detection": "AUTO", "TagResources": [], "UntagResources": [], "ResourceMapping": { "Source": { "StackName": "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack1/3e6a1ff0-94b1-11f0-aa6f-0a88d2e03acf", "LogicalResourceId": "MyLambdaRole" }, "Destination": { "StackName": "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack2/5da91650-94b1-11f0-81cf-0a23500e151b", "LogicalResourceId": "MyLambdaRole" } } }, { "Action": "MOVE", "Entity": "RESOURCE", "PhysicalResourceId": "MyTestFunction", "Description": "Resource configuration changes will be validated during refactor execution.", "Detection": "AUTO", "TagResources": [ { "Key": "aws:cloudformation:stack-name", "Value": "Stack2" }, { "Key": "aws:cloudformation:logical-id", "Value": "MyFunction" }, { "Key": "aws:cloudformation:stack-id", "Value": "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack2/5da91650-94b1-11f0-81cf-0a23500e151b" } ], "UntagResources": [ "aws:cloudformation:stack-name", "aws:cloudformation:logical-id", "aws:cloudformation:stack-id" ], "ResourceMapping": { "Source": { "StackName": "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack1/3e6a1ff0-94b1-11f0-aa6f-0a88d2e03acf", "LogicalResourceId": "MyFunction" }, "Destination": { "StackName": "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack2/5da91650-94b1-11f0-81cf-0a23500e151b", "LogicalResourceId": "MyFunction" } } } ] } ``` Para ter mais informações, consulte [Refatoração de pilhas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-refactoring.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [ListStackRefactorActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-stack-refactor-actions.html) na *Referência de comandos da AWS CLI*. ### `list-stack-resources` O código de exemplo a seguir mostra como usar `list-stack-resources`. **AWS CLI** **Para listar os recursos de uma pilha** O comando a seguir exibe a lista dos recursos da pilha especificada. ``` aws cloudformation list-stack-resources \ --stack-name my-stack ``` Resultado: ``` { "StackResourceSummaries": [ { "LogicalResourceId": "bucket", "PhysicalResourceId": "my-stack-bucket-1vc62xmplgguf", "ResourceType": "AWS::S3::Bucket", "LastUpdatedTimestamp": "2019-10-02T04:34:11.345Z", "ResourceStatus": "CREATE_COMPLETE", "DriftInformation": { "StackResourceDriftStatus": "IN_SYNC" } }, { "LogicalResourceId": "function", "PhysicalResourceId": "my-function-SEZV4XMPL4S5", "ResourceType": "AWS::Lambda::Function", "LastUpdatedTimestamp": "2019-10-02T05:34:27.989Z", "ResourceStatus": "UPDATE_COMPLETE", "DriftInformation": { "StackResourceDriftStatus": "IN_SYNC" } }, { "LogicalResourceId": "functionRole", "PhysicalResourceId": "my-functionRole-HIZXMPLEOM9E", "ResourceType": "AWS::IAM::Role", "LastUpdatedTimestamp": "2019-10-02T04:34:06.350Z", "ResourceStatus": "CREATE_COMPLETE", "DriftInformation": { "StackResourceDriftStatus": "IN_SYNC" } } ] } ``` + Consulte detalhes da API em [ListStackResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-stack-resources.html) na *AWS CLI Command Reference*. ### `list-stack-set-operation-results` O código de exemplo a seguir mostra como usar `list-stack-set-operation-results`. **AWS CLI** **Para listar os resultados da operação do conjunto de pilhas** O comando a seguir exibe os resultados de uma operação de atualização nas instâncias do conjunto de pilha especificado. ``` aws cloudformation list-stack-set-operation-results \ --stack-set-name enable-config \ --operation-id 35d45ebc-ed88-xmpl-ab59-0197a1fc83a0 ``` Resultado: ``` { "Summaries": [ { "Account": "223456789012", "Region": "us-west-2", "Status": "SUCCEEDED", "AccountGateResult": { "Status": "SKIPPED", "StatusReason": "Function not found: arn:aws:lambda:eu-west-1:223456789012:function:AWSCloudFormationStackSetAccountGate" } }, { "Account": "223456789012", "Region": "ap-south-1", "Status": "CANCELLED", "StatusReason": "Cancelled since failure tolerance has exceeded" } ] } ``` **Observação:** o status `SKIPPED` de `AccountGateResult` é esperado para operações bem-sucedidas, a menos que você crie uma função de portão de conta. + Para ver detalhes da API, consulte [ListStackSetOperationResults](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-stack-set-operation-results.html) na *Referência de comandos da AWS CLI*. ### `list-stack-set-operations` O código de exemplo a seguir mostra como usar `list-stack-set-operations`. **AWS CLI** **Para listar as operações do conjunto de pilhas** O exemplo `list-stack-set-operations` a seguir exibe a lista das operações mais recentes no conjunto de pilhas especificado. ``` aws cloudformation list-stack-set-operations \ --stack-set-name my-stack-set ``` Resultado: ``` { "Summaries": [ { "OperationId": "35d45ebc-ed88-xmpl-ab59-0197a1fc83a0", "Action": "UPDATE", "Status": "SUCCEEDED", "CreationTimestamp": "2019-10-03T16:28:44.377Z", "EndTimestamp": "2019-10-03T16:42:08.607Z" }, { "OperationId": "891aa98f-7118-xmpl-00b2-00954d1dd0d6", "Action": "UPDATE", "Status": "FAILED", "CreationTimestamp": "2019-10-03T15:43:53.916Z", "EndTimestamp": "2019-10-03T15:45:58.925Z" } ] } ``` + Para ver detalhes da API, consulte [ListStackSetOperations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-stack-set-operations.html) na *Referência de comandos da AWS CLI*. ### `list-stack-sets` O código de exemplo a seguir mostra como usar `list-stack-sets`. **AWS CLI** **Para listar conjuntos de pilhas** O exemplo `list-stack-sets` a seguir exibe a lista de conjuntos de pilhas na região e conta atuais. ``` aws cloudformation list-stack-sets ``` Resultado: ``` { "Summaries": [ { "StackSetName": "enable-config", "StackSetId": "enable-config:296a3360-xmpl-40af-be78-9341e95bf743", "Description": "Enable AWS Config", "Status": "ACTIVE" } ] } ``` + Para ver detalhes da API, consulte [ListStackSets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-stack-sets.html) na *Referência de comandos da AWS CLI*. ### `list-stacks` O código de exemplo a seguir mostra como usar `list-stacks`. **AWS CLI** **Para listar as pilhas do AWS CloudFormation** O comando `list-stacks` a seguir mostra um resumo de todas as pilhas que têm um status de `CREATE_COMPLETE`: ``` aws cloudformation list-stacks --stack-status-filter CREATE_COMPLETE ``` Resultado: ``` [ { "StackId": "arn:aws:cloudformation:us-east-1:123456789012:stack/myteststack/466df9e0-0dff-08e3-8e2f-5088487c4896", "TemplateDescription": "AWS CloudFormation Sample Template S3_Bucket: Sample template showing how to create a publicly accessible S3 bucket. **WARNING** This template creates an S3 bucket. You will be billed for the AWS resources used if you create a stack from this template.", "StackStatusReason": null, "CreationTime": "2013-08-26T03:27:10.190Z", "StackName": "myteststack", "StackStatus": "CREATE_COMPLETE" } ] ``` + Consulte detalhes da API em [ListStacks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-stacks.html) na *AWS CLI Command Reference*. ### `list-type-registrations` O código de exemplo a seguir mostra como usar `list-type-registrations`. **AWS CLI** **Para listar os registros concluídos de um tipo** O exemplo `list-type-registrations` a seguir exibe uma lista dos registros de tipo concluídos para o tipo especificado. ``` aws cloudformation list-type-registrations \ --type RESOURCE \ --type-name My::Logs::LogGroup \ --registration-status-filter COMPLETE ``` Resultado: ``` { "RegistrationTokenList": [ "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333" ] } ``` Para obter mais informações, consulte [Usar o registro do CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [ListTypeRegistrations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-type-registrations.html) na *Referência de comandos da AWS CLI*. ### `list-type-versions` O código de exemplo a seguir mostra como usar `list-type-versions`. **AWS CLI** **Para listar a versão de uma extensão** O exemplo `list-type-versions` a seguir retorna informações de resumo sobre as versões de uma extensão. ``` aws cloudformation list-type-versions \ --endpoint https://example.com \ --region us-west-2 \ --type RESOURCE \ --type-name My::Resource::Example \ --publisher-id 123456789012 ``` Este comando não produz saída. Para obter mais informações, consulte [Usar o registro do AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [ListTypeVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-type-versions.html) na *Referência de comandos da AWS CLI*. ### `list-types` O código de exemplo a seguir mostra como usar `list-types`. **AWS CLI** **Para listar os tipos de recursos privados em uma conta** O exemplo `list-types` a seguir exibe uma lista dos tipos de recursos privados atualmente registrados na conta da AWS atual. ``` aws cloudformation list-types ``` Resultado: ``` { "TypeSummaries": [ { "Description": "WordPress blog resource for internal use", "LastUpdated": "2019-12-04T18:28:15.059Z", "TypeName": "My::WordPress::BlogExample", "TypeArn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-WordPress-BlogExample", "DefaultVersionId": "00000005", "Type": "RESOURCE" }, { "Description": "Customized resource derived from AWS::Logs::LogGroup", "LastUpdated": "2019-12-04T18:28:15.059Z", "TypeName": "My::Logs::LogGroup", "TypeArn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-Logs-LogGroup", "DefaultVersionId": "00000003", "Type": "RESOURCE" } ] } ``` Para obter mais informações, consulte [Usar o registro do CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [ListTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-types.html) na *Referência de comandos da AWS CLI*. ### `package` O código de exemplo a seguir mostra como usar `package`. **AWS CLI** O comando a seguir exporta um modelo chamado `template.json` carregando artefatos locais para o bucket do S3 `bucket-name` e grava o modelo exportado em `packaged-template.json`: ``` aws cloudformation package --template-file /path_to_template/template.json --s3-bucket bucket-name --output-template-file packaged-template.json --use-json ``` + Para ver detalhes da API, consulte [Package](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/package.html) na *Referência de comandos da AWS CLI*. ### `publish-type` O código de exemplo a seguir mostra como usar `publish-type`. **AWS CLI** **Como publicar uma extensão** O exemplo `publish-type` a seguir publica a extensão especificada no registro do CloudFormation como uma extensão pública nesta região. ``` aws cloudformation publish-type \ --region us-west-2 \ --type RESOURCE \ --type-name Example::Test::1234567890abcdef0 ``` Resultado: ``` { "PublicTypeArn":"arn:aws:cloudformation:us-west-2::type/resource/000q6TfUovXsEMmgKowxDZLlwqr2QUshd2e75c8c/Example-Test-1234567890abcdef0/1.0.0" } ``` Para obter mais informações, consulte [Usar o registro do AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [PublishType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/publish-type.html) na *Referência de comandos da AWS CLI*. ### `register-publisher` O código de exemplo a seguir mostra como usar `register-publisher`. **AWS CLI** **Para registrar um publicador** O exemplo `register-publisher` a seguir registra um publicador e aceita o parâmetro de termos e condições. ``` aws cloudformation register-publisher \ --region us-west-2 \ --accept-terms-and-conditions ``` Resultado: ``` { "PublisherId": "000q6TfUovXsEMmgKowxDZLlwqr2QUshd2e75c8c" } ``` Para obter mais informações, consulte [Usar o registro do AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [RegisterPublisher](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/register-publisher.html) na *Referência de comandos da AWS CLI*. ### `register-type` O código de exemplo a seguir mostra como usar `register-type`. **AWS CLI** **Para registrar um tipo de recurso** O exemplo `register-type` a seguir registra o tipo de recurso especificado como um tipo de recurso privado na conta do usuário. ``` aws cloudformation register-type \ --type-name My::Organization::ResourceName \ --schema-handler-package s3://bucket_name/my-organization-resource_name.zip \ --type RESOURCE ``` Resultado: ``` { "RegistrationToken": "f5525280-104e-4d35-bef5-8f1f1example" } ``` Para obter mais informações, consulte [Registrar provedores de recursos](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-register.html) no *Guia do usuário da interface de linha de comando do CloudFormation para desenvolvimento de tipo*. + Para ver detalhes da API, consulte [RegisterType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/register-type.html) na *Referência de comandos da AWS CLI*. ### `set-stack-policy` O código de exemplo a seguir mostra como usar `set-stack-policy`. **AWS CLI** **Como aplicar uma política de pilha** O exemplo `set-stack-policy` a seguir desabilita as atualizações do recurso especificado na pilha especificada. `stack-policy.json` é um documento JSON que define quais operações são permitidas nos recursos da pilha. ``` aws cloudformation set-stack-policy \ --stack-name my-stack \ --stack-policy-body file://stack-policy.json ``` Resultado: ``` { "Statement" : [ { "Effect" : "Allow", "Action" : "Update:*", "Principal": "*", "Resource" : "*" }, { "Effect" : "Deny", "Action" : "Update:*", "Principal": "*", "Resource" : "LogicalResourceId/bucket" } ] } ``` + Para ver detalhes da API, consulte [SetStackPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/set-stack-policy.html) na *Referência de comandos da AWS CLI*. ### `set-type-configuration` O código de exemplo a seguir mostra como usar `set-type-configuration`. **AWS CLI** **Como configurar dados** O exemplo `set-type-configuration` a seguir especifica os dados de configuração para uma extensão do CloudFormation registrada, na conta e na região especificadas. ``` aws cloudformation set-type-configuration \ --region us-west-2 \ --type RESOURCE \ --type-name Example::Test::Type \ --configuration-alias default \ --configuration "{\"CredentialKey\": \"testUserCredential\"}" ``` Resultado: ``` { "ConfigurationArn": "arn:aws:cloudformation:us-west-2:123456789012:type-configuration/resource/Example-Test-Type/default" } ``` Para obter mais informações, consulte [Usar o registro do AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [SetTypeConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/set-type-configuration.html) na *Referência de comandos da AWS CLI*. ### `set-type-default-version` O código de exemplo a seguir mostra como usar `set-type-default-version`. **AWS CLI** **Como definir uma versão padrão do tipo** O exemplo `set-type-default-version` a seguir define a versão do tipo especificado a ser usada como padrão para esse tipo. ``` aws cloudformation set-type-default-version \ --type RESOURCE \ --type-name My::Logs::LogGroup \ --version-id 00000003 ``` Este comando não produz saída. Para obter mais informações, consulte [Usar o registro do CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [SetTypeDefaultVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/set-type-default-version.html) na *Referência de comandos da AWS CLI*. ### `signal-resource` O código de exemplo a seguir mostra como usar `signal-resource`. **AWS CLI** **Como sinalizar um recurso** O exemplo `signal-resource` a seguir indica `success` para o cumprimento da condição de espera chamada `MyWaitCondition` na pilha chamada `my-stack`. ``` aws cloudformation signal-resource \ --stack-name my-stack \ --logical-resource-id MyWaitCondition \ --unique-id 1234 \ --status SUCCESS ``` Este comando não produz saída. + Para ver detalhes da API, consulte [SignalResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/signal-resource.html) na *Referência de comandos da AWS CLI*. ### `start-resource-scan` O código de exemplo a seguir mostra como usar `start-resource-scan`. **AWS CLI** **Como iniciar uma verificação de recursos** O exemplo de `start-resource-scan` a seguir inicia uma verificação de recursos que examina todos os recursos existentes na conta e região atuais. ``` aws cloudformation start-resource-scan ``` Resultado: ``` { "ResourceScanId": "arn:aws:cloudformation:us-east-1:123456789012:resourceScan/0a699f15-489c-43ca-a3ef-3e6ecfa5da60" } ``` Para mais informações, consulte [Iniciar uma verificação de recursos com o gerador de IaC do CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/iac-generator-start-resource-scan.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [StartResourceScan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/start-resource-scan.html) na *Referência de comandos da AWS CLI*. ### `stop-stack-set-operation` O código de exemplo a seguir mostra como usar `stop-stack-set-operation`. **AWS CLI** **Como interromper uma operação de conjunto de pilhas** O exemplo `stop-stack-set-operation` a seguir interrompe uma operação de atualização em andamento no conjunto de pilhas especificado. ``` aws cloudformation stop-stack-set-operation \ --stack-set-name my-stack-set \ --operation-id 1261cd27-490b-xmpl-ab42-793a896c69e6 ``` Este comando não produz saída. + Para obter detalhes a API, consulte [StopStackSetOperation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/stop-stack-set-operation.html) na *Referência de comandos da AWS CLI*. ### `test-type` O código de exemplo a seguir mostra como usar `test-type`. **AWS CLI** **Para testar uma extensão** O exemplo `test-type` a seguir testa uma extensão registrada para garantir que ela atenda a todos os requisitos necessários para ser publicada no registro do CloudFormation. ``` aws cloudformation test-type \ --arn arn:aws:cloudformation:us-west-2:123456789012:type/resource/Sample-Test-Resource123/00000001 ``` Resultado: ``` { "TypeVersionArn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/Sample-Test-Resource123/00000001" } ``` Para obter mais informações, consulte [Usar o registro do AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) no *Guia do usuário do AWS CloudFormation*. + Para ver detalhes da API, consulte [TestType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/test-type.html) na *Referência de comandos da AWS CLI*. ### `update-stack-instances` O código de exemplo a seguir mostra como usar `update-stack-instances`. **AWS CLI** **Para atualizar instâncias de pilha** O exemplo `update-stack-instances` a seguir repete uma atualização nas instâncias de pilha em duas contas em duas regiões com as configurações mais recentes. A configuração de tolerância a falhas especificada garante que a atualização seja tentada em todas as contas e regiões, mesmo que algumas pilhas não possam ser atualizadas. ``` aws cloudformation update-stack-instances \ --stack-set-name my-stack-set \ --accounts 123456789012 567890123456 \ --regions us-east-1 us-west-2 \ --operation-preferences FailureToleranceCount=3 ``` Resultado: ``` { "OperationId": "103ebdf2-21ea-xmpl-8892-de5e30733132" } ``` + Para ver detalhes da API, consulte [UpdateStackInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/update-stack-instances.html) na *Referência de comandos da AWS CLI*. ### `update-stack-set` O código de exemplo a seguir mostra como usar `update-stack-set`. **AWS CLI** **Para atualizar um conjunto de pilhas** O exemplo `update-stack-set` a seguir adiciona uma tag com o nome de chave `Owner` e um valor de `IT` às instâncias de pilha no conjunto de pilhas especificado. ``` aws cloudformation update-stack-set \ --stack-set-name my-stack-set \ --use-previous-template \ --tags Key=Owner,Value=IT ``` Resultado: ``` { "OperationId": "e2b60321-6cab-xmpl-bde7-530c6f47950e" } ``` + Para ver detalhes da API, consulte [UpdateStackSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/update-stack-set.html) na *Referência de comandos da AWS CLI*. ### `update-stack` O código de exemplo a seguir mostra como usar `update-stack`. **AWS CLI** **Para atualizar as pilhas do AWS CloudFormation** O comando `update-stack` a seguir atualiza o modelo e os parâmetros de entrada para a pilha `mystack`: ``` aws cloudformation update-stack --stack-name mystack --template-url https://s3.amazonaws.com/sample/updated.template --parameters ParameterKey=KeyPairName,ParameterValue=SampleKeyPair ParameterKey=SubnetIDs,ParameterValue=SampleSubnetID1\\,SampleSubnetID2 ``` O comando `update-stack` a seguir atualiza apenas o valor do parâmetro `SubnetIDs` da pilha `mystack`. Se você não especificar um valor para o parâmetro, o valor padrão especificado no modelo será usado: ``` aws cloudformation update-stack --stack-name mystack --template-url https://s3.amazonaws.com/sample/updated.template --parameters ParameterKey=KeyPairName,UsePreviousValue=true ParameterKey=SubnetIDs,ParameterValue=SampleSubnetID1\\,UpdatedSampleSubnetID2 ``` O comando `update-stack` a seguir adiciona à pilha `mystack` dois tópicos de notificação de pilha: ``` aws cloudformation update-stack --stack-name mystack --use-previous-template --notification-arns "arn:aws:sns:use-east-1:123456789012:mytopic1" "arn:aws:sns:us-east-1:123456789012:mytopic2" ``` Para obter mais informações, consulte [Atualizações de pilhas do AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html) no *Guia do usuário do AWS CloudFormation*. + Consulte detalhes da API em [UpdateStack](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/update-stack.html) na *AWS CLI Command Reference*. ### `update-termination-protection` O código de exemplo a seguir mostra como usar `update-termination-protection`. **AWS CLI** **Para habilitar a proteção contra encerramento** O exemplo `update-termination-protection` a seguir ativa a proteção contra encerramento na pilha especificada. ``` aws cloudformation update-termination-protection \ --stack-name my-stack \ --enable-termination-protection ``` Resultado: ``` { "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204" } ``` + Para ver detalhes da API, consulte [UpdateTerminationProtection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/update-termination-protection.html) na *Referência de comandos da AWS CLI*. ### `validate-template` O código de exemplo a seguir mostra como usar `validate-template`. **AWS CLI** **Para validar um modelo do AWS CloudFormation** O comando `validate-template` a seguir valida o modelo `sampletemplate.json`: ``` aws cloudformation validate-template --template-body file://sampletemplate.json ``` Resultado: ``` { "Description": "AWS CloudFormation Sample Template S3_Bucket: Sample template showing how to create a publicly accessible S3 bucket. **WARNING** This template creates an S3 bucket. You will be billed for the AWS resources used if you create a stack from this template.", "Parameters": [], "Capabilities": [] } ``` Para obter mais informações, consulte Trabalhar com modelos do AWS CloudFormation no *Guia do usuário do AWS CloudFormation*. + Consulte detalhes da API em [ValidateTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/validate-template.html) na *AWS CLI Command Reference*. # Exemplos do CloudFront usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando oAWS Command Line Interface com o 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 ### `associate-distribution-tenant-web-acl` O código de exemplo a seguir mostra como usar `associate-distribution-tenant-web-acl`. **AWS CLI** **Como associar uma ACL da web a um locatário de distribuição do CloudFront** O exemplo `associate-distribution-tenant-web-acl` a seguir associa uma ACL da web a uma distribuição do CloudFront com a ETag `E13V1IB3VIYABC`. ``` aws cloudfront associate-distribution-tenant-web-acl \ --id dt_2wjDZi3hD1ivOXf6rpZJO1AB \ --if-match E13V1IB3VIYABC \ --web-acl-arn arn:aws:wafv2:us-east-1:123456789012:global/webacl/web-global-example/626900da-5f64-418b-ba9b-743f37123ABC ``` Resultado: ``` { "ETag": "E1VC38T7YXBABC", "Id": "dt_2wjDZi3hD1ivOXf6rpZJO1AB", "WebACLArn": "arn:aws:wafv2:us-east-1:123456789012:global/webacl/web-global-example/626900da-5f64-418b-ba9b-743f37123ABC" } ``` Para ter mais informações, consulte [Usar proteções do AWS WAF](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-awswaf.html) no *Guia do desenvolvedor do Amazon CloudFront*. + Para ver detalhes da API, consulte [AssociateDistributionTenantWebAcl](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/associate-distribution-tenant-web-acl.html) na *Referência de comandos da AWS CLI*. ### `associate-distribution-web-acl` O código de exemplo a seguir mostra como usar `associate-distribution-web-acl`. **AWS CLI** **Como associar uma ACL da web a uma distribuição do CloudFront** O exemplo `associate-distribution-web-acl` a seguir associa uma ACL da web a uma distribuição do CloudFront. ``` aws cloudfront associate-distribution-web-acl \ --id E1XNX8R2GOAABC \ --if-match E2YWS1C2J3OABC \ --web-acl-arn arn:aws:wafv2:us-east-1:123456789012:global/webacl/web-global-example/626900da-5f64-418b-ba9b-743f3746cABC ``` Resultado: ``` { "ETag": "E3QE7ED60U0ABC", "Id": "E1XNX8R2GOAABC", "WebACLArn": "arn:aws:wafv2:us-east-1:123456789012:global/webacl/web-global-example/626900da-5f64-418b-ba9b-743f3746cABC" } ``` Para ter mais informações, consulte [Usar proteções do AWS WAF](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-awswaf.html) no *Guia do desenvolvedor do Amazon CloudFront*. + Para ver detalhes da API, consulte [AssociateDistributionWebAcl](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/associate-distribution-web-acl.html) na *Referência de comandos da AWS CLI*. ### `create-cloud-front-origin-access-identity` O código de exemplo a seguir mostra como usar `create-cloud-front-origin-access-identity`. **AWS CLI** **Para criar uma identidade do acesso de origem do CloudFront** O exemplo a seguir cria uma identidade do acesso de origem (OAI) do CloudFront fornecendo a configuração da OAI como um argumento da linha de comando: ``` aws cloudfront create-cloud-front-origin-access-identity \ --cloud-front-origin-access-identity-config \ CallerReference="cli-example",Comment="Example OAI" ``` Você pode fazer o mesmo fornecendo a configuração da OAI em um arquivo JSON, conforme mostrado no exemplo a seguir: ``` aws cloudfront create-cloud-front-origin-access-identity \ --cloud-front-origin-access-identity-config file://OAI-config.json ``` O arquivo `OAI-config.json` é um documento JSON no diretório atual que contém o seguinte: ``` { "CallerReference": "cli-example", "Comment": "Example OAI" } ``` Se você fornecer a configuração da OAI com um argumento da linha de comando ou um arquivo JSON, a saída será a mesma: ``` { "Location": "https://cloudfront.amazonaws.com/2019-03-26/origin-access-identity/cloudfront/E74FTE3AEXAMPLE", "ETag": "E2QWRUHEXAMPLE", "CloudFrontOriginAccessIdentity": { "Id": "E74FTE3AEXAMPLE", "S3CanonicalUserId": "cd13868f797c227fbea2830611a26fe0a21ba1b826ab4bed9b7771c9aEXAMPLE", "CloudFrontOriginAccessIdentityConfig": { "CallerReference": "cli-example", "Comment": "Example OAI" } } } ``` + Para ver detalhes da API, consulte [CreateCloudFrontOriginAccessIdentity](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/create-cloud-front-origin-access-identity.html) na *Referência de comandos da AWS CLI*. ### `create-connection-group` O código de exemplo a seguir mostra como usar `create-connection-group`. **AWS CLI** **Como criar um grupo de conexões no CloudFront** O exemplo `create-connection-group` a seguir cria um grupo de conexões habilitado, especifica uma lista de IPs estáticos anycast e desabilita o IPv6. ``` aws cloudfront create-connection-group \ --name cg-with-anycast-ip-list \ --no-ipv6-enabled \ --enabled \ --anycast-ip-list-id aip_CCkW6gKrDiBD4n78123ABC \ --tags "Items=[{Key=abc,Value=123}]" ``` Resultado: ``` { "ETag": "E23ZP02F085ABC", "ConnectionGroup": { "Id": "cg_2yb6uj74B4PCbfhT31WFdiSABC", "Name": "cg-with-anycast-ip-list", "Arn": "arn:aws:cloudfront::123456789012:connection-group/cg_2yb6uj74B4PCbfhT31WFdiSABC", "CreatedTime": "2025-06-16T16:25:50.061000+00:00", "LastModifiedTime": "2025-06-16T16:25:50.061000+00:00", "Tags": { "Items": [ { "Key": "abc", "Value": "123" } ] }, "Ipv6Enabled": false, "RoutingEndpoint": "dj6xusxq65abc.cloudfront.net", "AnycastIpListId": "aip_CCkW6gKrDiBD4n78123ABC", "Status": "InProgress", "Enabled": true, "IsDefault": false } } ``` Para ter mais informações, consulte [Criar grupo de conexões personalizado (opcional)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-connection-group.html) no *Guia do desenvolvedor do Amazon CloudFront*. + Para ver detalhes da API, consulte [CreateConnectionGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/create-connection-group.html) na *Referência de comandos da AWS CLI*. ### `create-distribution-tenant` O código de exemplo a seguir mostra como usar `create-distribution-tenant`. **AWS CLI** **Exemplo 1: criar um locatário de distribuição do CloudFront que usa um certificado personalizado** O exemplo a seguir `create-distribution-tenant` cria um locatário de distribuição do CloudFront que especifica personalizações para desabilitar o WAF, adicionar restrições geográficas e usar outro certificado TLS. ``` aws cloudfront create-distribution-tenant \ --cli-input-json file://tenant.json ``` Conteúdo de `tenant.json`: ``` { "DistributionId": "E1XNX8R2GOAABC", "Domains": [ { "Domain": "example.com" } ], "Parameters": [ { "Name": "testParam", "Value": "defaultValue" } ], "ConnectionGroupId": "cg_2whCJoXMYCjHcxaLGrkllvyABC", "Enabled": false, "Tags": { "Items": [ { "Key": "tag", "Value": "tagValue" } ] }, "Name": "new-tenant-customizations", "Customizations": { "GeoRestrictions": { "Locations": ["DE"], "RestrictionType": "whitelist" }, "WebAcl": { "Action": "disable" }, "Certificate": { "Arn": "arn:aws:acm:us-east-1:123456789012:certificate/ec53f564-ea5a-4e4a-a0a2-e3c989449abc" } } } ``` Resultado: ``` { "ETag": "E23ZP02F085ABC", "DistributionTenant": { "Id": "dt_2yN5tYwVbPKr7m2IB69M1yp1AB", "DistributionId": "E1XNX8R2GOAABC", "Name": "new-tenant-customizations", "Arn": "arn:aws:cloudfront::123456789012:distribution-tenant/dt_2yN5tYwVbPKr7m2IB69M1yp1AB", "Domains": [ { "Domain": "example.com", "Status": "active" } ], "Tags": { "Items": [ { "Key": "tag", "Value": "tagValue" } ] }, "Customizations": { "WebAcl": { "Action": "disable" }, "Certificate": { "Arn": "arn:aws:acm:us-east-1:123456789012:certificate/ec53f564-ea5a-4e4a-a0a2-e3c989449abc" }, "GeoRestrictions": { "RestrictionType": "whitelist", "Locations": [ "DE" ] } }, "Parameters": [ { "Name": "testParam", "Value": "defaultValue" } ], "ConnectionGroupId": "cg_2whCJoXMYCjHcxaLGrkllvyABC", "CreatedTime": "2025-06-11T17:20:06.432000+00:00", "LastModifiedTime": "2025-06-11T17:20:06.432000+00:00", "Enabled": false, "Status": "InProgress" } } ``` **Exemplo 2: criar um locatário de distribuição com um certificado herdado** O exemplo a seguir `create-distribution-tenant` cria um locatário de distribuição e especifica um certificado TLS herdado da distribuição multilocatário. ``` aws cloudfront create-distribution-tenant \ --cli-input-json file://tenant.json ``` Conteúdo de `tenant.json`: ``` { "DistributionId": "E1HVIAU7U12ABC", "Domains": [ { "Domain": "example.com" } ], "Parameters": [ { "Name": "tenantName", "Value": "first-tenant" } ], "Enabled": true, "Name": "new-tenant-no-cert" } ``` Resultado: ``` { "ETag": "E23ZP02F0ABC", "DistributionTenant": { "Id": "dt_2zhRB0vBe0B72LZCVy1mgzI1AB", "DistributionId": "E1HVIAU7U12ABC", "Name": "new-tenant-no-cert", "Arn": "arn:aws:cloudfront::123456789012:distribution-tenant/dt_2zhRB0vBe0B72LZCVy1mgzI1AB", "Domains": [ { "Domain": "example.com", "Status": "active" } ], "Parameters": [ { "Name": "tenantName", "Value": "first-tenant" } ], "ConnectionGroupId": "cg_2yQEwpipGFN0hhA0ZemPabOABC", "CreatedTime": "2025-07-10T20:59:38.414000+00:00", "LastModifiedTime": "2025-07-10T20:59:38.414000+00:00", "Enabled": true, "Status": "InProgress" } } ``` **Exemplo 3: criar um locatário de distribuição do CloudFront usando um token de validação hospedado no CloudFront** O exemplo a seguir `create-distribution-tenant` cria um locatário de distribuição e usa um token de validação hospedado no CloudFront para seu nome de domínio. ``` aws cloudfront create-distribution-tenant \ --cli-input-json file://tenant.json ``` Conteúdo de `tenant.json`: ``` { "DistributionId": "E2GJ5J9QN12ABC", "Domains": [ { "Domain": "example.com" } ], "Parameters": [ { "Name": "tenantName", "Value": "first-tenant" } ], "ConnectionGroupId": "cg_2yQEwpipGFN0hhA0ZemPabOABC", "Enabled": true, "Name": "new-tenant-cf-hosted", "ManagedCertificateRequest": { "ValidationTokenHost": "cloudfront" } } ``` **Importante:** para executar esse comando com êxito, você deve configurar um registro DNS CNAME que aponte seu novo domínio (exemplo.com) para o endpoint de roteamento do grupo de conexão associado ao locatário da distribuição. Esse registro CNAME também deve ser propagado antes que o CloudFront possa concluir com êxito essa solicitação. Resultado: ``` { "ETag": "E23ZP02F0ABC", "DistributionTenant": { "Id": "dt_2zhStKrA524GvvTWJX92Ozl1AB", "DistributionId": "E2GJ5J9QN12ABC", "Name": "new-tenant-cf-hosted", "Arn": "arn:aws:cloudfront::123456789012:distribution-tenant/dt_2zhStKrA524GvvTWJX92Ozl1AB", "Domains": [ { "Domain": "example.com", "Status": "inactive" } ], "Parameters": [ { "Name": "tenantName", "Value": "first-tenant" } ], "ConnectionGroupId": "cg_2zhSaGatwwXjTjE42nneZzqABC", "CreatedTime": "2025-07-10T21:13:46.416000+00:00", "LastModifiedTime": "2025-07-10T21:13:46.416000+00:00", "Enabled": true, "Status": "InProgress" } } ``` **Exemplo 4: criar um locatário de distribuição do CloudFront usando um token de validação auto-hospedado** O exemplo a seguir `create-distribution-tenant` cria um locatário de distribuição do CloudFront e usa um token de validação auto-hospedado. ``` aws cloudfront create-distribution-tenant \ --cli-input-json file://tenant.json ``` Conteúdo de `tenant.json`: ``` { "DistributionId": "E2GJ5J9QN12ABC", "Domains": [ { "Domain": "example.com" } ], "Parameters": [ { "Name": "tenantName", "Value": "first-tenant" } ], "Enabled": true, "Name": "new-tenant-self-hosted", "ManagedCertificateRequest": { "ValidationTokenHost": "self-hosted" } } ``` Resultado: ``` { "ETag": "E23ZP02F0ABC", "DistributionTenant": { "Id": "dt_2zhTFBV93OfFJJ3YMdNM5BC1AB", "DistributionId": "E2GJ5J9QN12ABC", "Name": "new-tenant-self-hosted", "Arn": "arn:aws:cloudfront::123456789012:distribution-tenant/dt_2zhTFBV93OfFJJ3YMdNM5BC1AB", "Domains": [ { "Domain": "example.com", "Status": "inactive" } ], "Parameters": [ { "Name": "tenantName", "Value": "first-tenant" } ], "ConnectionGroupId": "cg_2yQEwpipGFN0hhA0ZemPabOABC", "CreatedTime": "2025-07-10T21:16:39.828000+00:00", "LastModifiedTime": "2025-07-10T21:16:39.828000+00:00", "Enabled": true, "Status": "InProgress" } } ``` **Importante:** depois de executar esse comando, o locatário da distribuição será criado sem validação. Para validar a solicitação de certificado gerenciado e configurar o DNS quando você estiver pronto para começar a receber tráfego, consulte [Configuração completa do domínio](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/managed-cloudfront-certificates.html#complete-domain-ownership) no *Guia do Desenvolvedor do Amazon CloudFront*. Para obter mais informações sobre como criar locatários de distribuição, consulte [Criar uma distribuição](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-creating-console.html) no *Guia do desenvolvedor do Amazon CloudFront*. + Para ver detalhes da API, consulte [CreateDistributionTenant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/create-distribution-tenant.html) na *Referência de comandos da AWS CLI*. ### `create-distribution-with-tags` O código de exemplo a seguir mostra como usar `create-distribution-with-tags`. **AWS CLI** **Para criar uma distribuição do CloudFront com tags** O exemplo de `create-distribution-with-tags` a seguir cria uma distribuição com duas tags fornecendo a configuração de distribuição e as tags em um arquivo JSON chamado `dist-config-with-tags.json`. ``` aws cloudfront create-distribution-with-tags \ --distribution-config-with-tags file://dist-config-with-tags.json ``` O arquivo `dist-config-with-tags.json` é um documento JSON na pasta atual. Observe o objeto `Tags` na parte superior do arquivo, que contém duas tags: `Name = ExampleDistribution``Project = ExampleProject` Conteúdo de `dist-config-with-tags.json`: ``` { "Tags": { "Items": [ { "Key": "Name", "Value": "ExampleDistribution" }, { "Key": "Project", "Value": "ExampleProject" } ] }, "DistributionConfig": { "CallerReference": "cli-example", "Aliases": { "Quantity": 0 }, "DefaultRootObject": "index.html", "Origins": { "Quantity": 1, "Items": [ { "Id": "amzn-s3-demo-bucket---s3.amazonaws.com.rproxy.goskope.com-cli-example", "DomainName": "amzn-s3-demo-bucket.s3.amazonaws.com", "OriginPath": "", "CustomHeaders": { "Quantity": 0 }, "S3OriginConfig": { "OriginAccessIdentity": "" } } ] }, "OriginGroups": { "Quantity": 0 }, "DefaultCacheBehavior": { "TargetOriginId": "amzn-s3-demo-bucket---s3.amazonaws.com.rproxy.goskope.com-cli-example", "ForwardedValues": { "QueryString": false, "Cookies": { "Forward": "none" }, "Headers": { "Quantity": 0 }, "QueryStringCacheKeys": { "Quantity": 0 } }, "TrustedSigners": { "Enabled": false, "Quantity": 0 }, "ViewerProtocolPolicy": "allow-all", "MinTTL": 0, "AllowedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ], "CachedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ] } }, "SmoothStreaming": false, "DefaultTTL": 86400, "MaxTTL": 31536000, "Compress": false, "LambdaFunctionAssociations": { "Quantity": 0 }, "FieldLevelEncryptionId": "" }, "CacheBehaviors": { "Quantity": 0 }, "CustomErrorResponses": { "Quantity": 0 }, "Comment": "", "Logging": { "Enabled": false, "IncludeCookies": false, "Bucket": "", "Prefix": "" }, "PriceClass": "PriceClass_All", "Enabled": true, "ViewerCertificate": { "CloudFrontDefaultCertificate": true, "MinimumProtocolVersion": "TLSv1", "CertificateSource": "cloudfront" }, "Restrictions": { "GeoRestriction": { "RestrictionType": "none", "Quantity": 0 } }, "WebACLId": "", "HttpVersion": "http2", "IsIPV6Enabled": true } } ``` Resultado: ``` { "Location": "https://cloudfront.amazonaws.com/2019-03-26/distribution/EDFDVBD6EXAMPLE", "ETag": "E2QWRUHEXAMPLE", "Distribution": { "Id": "EDFDVBD6EXAMPLE", "ARN": "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", "Status": "InProgress", "LastModifiedTime": "2019-12-04T23:35:41.433Z", "InProgressInvalidationBatches": 0, "DomainName": "d111111abcdef8.cloudfront.net", "ActiveTrustedSigners": { "Enabled": false, "Quantity": 0 }, "DistributionConfig": { "CallerReference": "cli-example", "Aliases": { "Quantity": 0 }, "DefaultRootObject": "index.html", "Origins": { "Quantity": 1, "Items": [ { "Id": "amzn-s3-demo-bucket---s3.amazonaws.com.rproxy.goskope.com-cli-example", "DomainName": "amzn-s3-demo-bucket.s3.amazonaws.com", "OriginPath": "", "CustomHeaders": { "Quantity": 0 }, "S3OriginConfig": { "OriginAccessIdentity": "" } } ] }, "OriginGroups": { "Quantity": 0 }, "DefaultCacheBehavior": { "TargetOriginId": "amzn-s3-demo-bucket---s3.amazonaws.com.rproxy.goskope.com-cli-example", "ForwardedValues": { "QueryString": false, "Cookies": { "Forward": "none" }, "Headers": { "Quantity": 0 }, "QueryStringCacheKeys": { "Quantity": 0 } }, "TrustedSigners": { "Enabled": false, "Quantity": 0 }, "ViewerProtocolPolicy": "allow-all", "MinTTL": 0, "AllowedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ], "CachedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ] } }, "SmoothStreaming": false, "DefaultTTL": 86400, "MaxTTL": 31536000, "Compress": false, "LambdaFunctionAssociations": { "Quantity": 0 }, "FieldLevelEncryptionId": "" }, "CacheBehaviors": { "Quantity": 0 }, "CustomErrorResponses": { "Quantity": 0 }, "Comment": "", "Logging": { "Enabled": false, "IncludeCookies": false, "Bucket": "", "Prefix": "" }, "PriceClass": "PriceClass_All", "Enabled": true, "ViewerCertificate": { "CloudFrontDefaultCertificate": true, "MinimumProtocolVersion": "TLSv1", "CertificateSource": "cloudfront" }, "Restrictions": { "GeoRestriction": { "RestrictionType": "none", "Quantity": 0 } }, "WebACLId": "", "HttpVersion": "http2", "IsIPV6Enabled": true } } } ``` + Para ver detalhes da API, consulte [CreateDistributionWithTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/create-distribution-with-tags.html) na *Referência de comandos da AWS CLI*. ### `create-distribution` O código de exemplo a seguir mostra como usar `create-distribution`. **AWS CLI** **Exemplo 1: como criar uma distribuição do CloudFront** O exemplo a seguir `create-distribution` cria uma distribuição para um bucket do S3 chamado `amzn-s3-demo-bucket` e também especifica `index.html` como o objeto raiz padrão, usando argumentos de linha de comandos. ``` aws cloudfront create-distribution \ --origin-domain-name amzn-s3-demo-bucket.s3.amazonaws.com \ --default-root-object index.html ``` Resultado: ``` { "Location": "https://cloudfront.amazonaws.com/2019-03-26/distribution/EMLARXS9EXAMPLE", "ETag": "E9LHASXEXAMPLE", "Distribution": { "Id": "EMLARXS9EXAMPLE", "ARN": "arn:aws:cloudfront::123456789012:distribution/EMLARXS9EXAMPLE", "Status": "InProgress", "LastModifiedTime": "2019-11-22T00:55:15.705Z", "InProgressInvalidationBatches": 0, "DomainName": "d111111abcdef8.cloudfront.net", "ActiveTrustedSigners": { "Enabled": false, "Quantity": 0 }, "DistributionConfig": { "CallerReference": "cli-example", "Aliases": { "Quantity": 0 }, "DefaultRootObject": "index.html", "Origins": { "Quantity": 1, "Items": [ { "Id": "amzn-s3-demo-bucket---s3.amazonaws.com.rproxy.goskope.com-cli-example", "DomainName": "amzn-s3-demo-bucket.s3.amazonaws.com", "OriginPath": "", "CustomHeaders": { "Quantity": 0 }, "S3OriginConfig": { "OriginAccessIdentity": "" } } ] }, "OriginGroups": { "Quantity": 0 }, "DefaultCacheBehavior": { "TargetOriginId": "amzn-s3-demo-bucket---s3.amazonaws.com.rproxy.goskope.com-cli-example", "ForwardedValues": { "QueryString": false, "Cookies": { "Forward": "none" }, "Headers": { "Quantity": 0 }, "QueryStringCacheKeys": { "Quantity": 0 } }, "TrustedSigners": { "Enabled": false, "Quantity": 0 }, "ViewerProtocolPolicy": "allow-all", "MinTTL": 0, "AllowedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ], "CachedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ] } }, "SmoothStreaming": false, "DefaultTTL": 86400, "MaxTTL": 31536000, "Compress": false, "LambdaFunctionAssociations": { "Quantity": 0 }, "FieldLevelEncryptionId": "" }, "CacheBehaviors": { "Quantity": 0 }, "CustomErrorResponses": { "Quantity": 0 }, "Comment": "", "Logging": { "Enabled": false, "IncludeCookies": false, "Bucket": "", "Prefix": "" }, "PriceClass": "PriceClass_All", "Enabled": true, "ViewerCertificate": { "CloudFrontDefaultCertificate": true, "MinimumProtocolVersion": "TLSv1", "CertificateSource": "cloudfront" }, "Restrictions": { "GeoRestriction": { "RestrictionType": "none", "Quantity": 0 } }, "WebACLId": "", "HttpVersion": "http2", "IsIPV6Enabled": true } } } ``` **Exemplo 2: como criar uma distribuição do CloudFront usando um arquivo JSON** O exemplo a seguir `create-distribution` cria uma distribuição para um bucket do S3 chamado `amzn-s3-demo-bucket` e também especifica `index.html` como o objeto raiz padrão, usando um arquivo JSON. ``` aws cloudfront create-distribution \ --distribution-config file://dist-config.json ``` Conteúdo de `dist-config.json`: ``` { "CallerReference": "cli-example", "Aliases": { "Quantity": 0 }, "DefaultRootObject": "index.html", "Origins": { "Quantity": 1, "Items": [ { "Id": "amzn-s3-demo-bucket---s3.amazonaws.com.rproxy.goskope.com-cli-example", "DomainName": "amzn-s3-demo-bucket.s3.amazonaws.com", "OriginPath": "", "CustomHeaders": { "Quantity": 0 }, "S3OriginConfig": { "OriginAccessIdentity": "" } } ] }, "OriginGroups": { "Quantity": 0 }, "DefaultCacheBehavior": { "TargetOriginId": "amzn-s3-demo-bucket---s3.amazonaws.com.rproxy.goskope.com-cli-example", "ForwardedValues": { "QueryString": false, "Cookies": { "Forward": "none" }, "Headers": { "Quantity": 0 }, "QueryStringCacheKeys": { "Quantity": 0 } }, "TrustedSigners": { "Enabled": false, "Quantity": 0 }, "ViewerProtocolPolicy": "allow-all", "MinTTL": 0, "AllowedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ], "CachedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ] } }, "SmoothStreaming": false, "DefaultTTL": 86400, "MaxTTL": 31536000, "Compress": false, "LambdaFunctionAssociations": { "Quantity": 0 }, "FieldLevelEncryptionId": "" }, "CacheBehaviors": { "Quantity": 0 }, "CustomErrorResponses": { "Quantity": 0 }, "Comment": "", "Logging": { "Enabled": false, "IncludeCookies": false, "Bucket": "", "Prefix": "" }, "PriceClass": "PriceClass_All", "Enabled": true, "ViewerCertificate": { "CloudFrontDefaultCertificate": true, "MinimumProtocolVersion": "TLSv1", "CertificateSource": "cloudfront" }, "Restrictions": { "GeoRestriction": { "RestrictionType": "none", "Quantity": 0 } }, "WebACLId": "", "HttpVersion": "http2", "IsIPV6Enabled": true } ``` Consulte a amostra de saída no exemplo 1. **Exemplo 3: criar uma distribuição multilocatária do CloudFront com um certificado** O exemplo a seguir `create-distribution` cria uma distribuição do CloudFront com suporte multilocatário e especifica um certificado TLS. ``` aws cloudfront create-distribution \ --distribution-config file://dist-config.json ``` Conteúdo de `dist-config.json`: ``` { "CallerReference": "cli-example-with-cert", "Comment": "CLI example distribution", "DefaultRootObject": "index.html", "Origins": { "Quantity": 1, "Items": [ { "Id": "amzn-s3-demo-bucket.s3.us-east-1.amazonaws.com", "DomainName": "amzn-s3-demo-bucket.s3.us-east-1.amazonaws.com", "OriginPath": "/{{tenantName}}", "CustomHeaders": { "Quantity": 0 }, "S3OriginConfig": { "OriginAccessIdentity": "" } } ] }, "DefaultCacheBehavior": { "TargetOriginId": "amzn-s3-demo-bucket.s3.us-east-1.amazonaws.com", "CachePolicyId": "658327ea-f89d-4fab-a63d-7e88639e5ABC", "ViewerProtocolPolicy": "allow-all", "AllowedMethods": { "Quantity": 2, "Items": ["HEAD", "GET"], "CachedMethods": { "Quantity": 2, "Items": ["HEAD", "GET"] } } }, "Enabled": true, "ViewerCertificate": { "ACMCertificateArn": "arn:aws:acm:us-east-1:123456789012:certificate/191306a1-db01-49ca-90ef-fc414ee5dabc", "SSLSupportMethod": "sni-only" }, "HttpVersion": "http2", "ConnectionMode": "tenant-only", "TenantConfig": { "ParameterDefinitions": [ { "Name": "tenantName", "Definition": { "StringSchema": { "Comment": "tenantName parameter", "DefaultValue": "root", "Required": false } } } ] } } ``` Resultado: ``` { "Location": "https://cloudfront.amazonaws.com/2020-05-31/distribution/E1HVIAU7UABC", "ETag": "E20LT7R1BABC", "Distribution": { "Id": "E1HVIAU7U12ABC", "ARN": "arn:aws:cloudfront::123456789012:distribution/E1HVIAU7U12ABC", "Status": "InProgress", "LastModifiedTime": "2025-07-10T20:33:31.117000+00:00", "InProgressInvalidationBatches": 0, "DomainName": "example.com", "ActiveTrustedSigners": { "Enabled": false, "Quantity": 0 }, "ActiveTrustedKeyGroups": { "Enabled": false, "Quantity": 0 }, "DistributionConfig": { "CallerReference": "cli-example-with-cert", "DefaultRootObject": "index.html", "Origins": { "Quantity": 1, "Items": [ { "Id": "amzn-s3-demo-bucket.s3.us-east-1.amazonaws.com", "DomainName": "amzn-s3-demo-bucket.s3.us-east-1.amazonaws.com", "OriginPath": "/{{tenantName}}", "CustomHeaders": { "Quantity": 0 }, "S3OriginConfig": { "OriginAccessIdentity": "" }, "ConnectionAttempts": 3, "ConnectionTimeout": 10, "OriginShield": { "Enabled": false }, "OriginAccessControlId": "" } ] }, "OriginGroups": { "Quantity": 0 }, "DefaultCacheBehavior": { "TargetOriginId": "amzn-s3-demo-bucket.s3.us-east-1.amazonaws.com", "TrustedKeyGroups": { "Enabled": false, "Quantity": 0 }, "ViewerProtocolPolicy": "allow-all", "AllowedMethods": { "Quantity": 2, "Items": ["HEAD", "GET"], "CachedMethods": { "Quantity": 2, "Items": ["HEAD", "GET"] } }, "Compress": false, "LambdaFunctionAssociations": { "Quantity": 0 }, "FunctionAssociations": { "Quantity": 0 }, "FieldLevelEncryptionId": "", "CachePolicyId": "658327ea-f89d-4fab-a63d-7e88639e5ABC", "GrpcConfig": { "Enabled": false } }, "CacheBehaviors": { "Quantity": 0 }, "CustomErrorResponses": { "Quantity": 0 }, "Comment": "CLI example distribution", "Logging": { "Enabled": false, "IncludeCookies": false, "Bucket": "", "Prefix": "" }, "Enabled": true, "ViewerCertificate": { "CloudFrontDefaultCertificate": false, "ACMCertificateArn": "arn:aws:acm:us-east-1:123456789012:certificate/1954f095-11b6-4daf-9952-0c308a00abc", "SSLSupportMethod": "sni-only", "MinimumProtocolVersion": "TLSv1.2_2021", "Certificate": "arn:aws:acm:us-east-1:123456789012:certificate/1954f095-11b6-4daf-9952-0c308a00abc", "CertificateSource": "acm" }, "Restrictions": { "GeoRestriction": { "RestrictionType": "none", "Quantity": 0 } }, "WebACLId": "", "HttpVersion": "http2", "TenantConfig": { "ParameterDefinitions": [ { "Name": "tenantName", "Definition": { "StringSchema": { "Comment": "tenantName parameter", "DefaultValue": "root", "Required": false } } } ] }, "ConnectionMode": "tenant-only" } } } ``` Para obter mais informações, consulte [Trabalhar com distribuições](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-working-with.html) no *Guia do desenvolvedor do Amazon CloudFront*. **Exemplo 4: criar uma distribuição multilocatária do CloudFront sem um certificado** O exemplo a seguir `create-distribution` cria uma distribuição do CloudFront com suporte multilocatário, mas sem um certificado TLS. ``` aws cloudfront create-distribution \ --distribution-config file://dist-config.json ``` Conteúdo de `dist-config.json`: ``` { "CallerReference": "cli-example", "Comment": "CLI example distribution", "DefaultRootObject": "index.html", "Origins": { "Quantity": 1, "Items": [ { "Id": "amzn-s3-demo-bucket.s3.us-east-1.amazonaws.com", "DomainName": "amzn-s3-demo-bucket.s3.us-east-1.amazonaws.com", "OriginPath": "/{{tenantName}}", "CustomHeaders": { "Quantity": 0 }, "S3OriginConfig": { "OriginAccessIdentity": "" } } ] }, "DefaultCacheBehavior": { "TargetOriginId": "amzn-s3-demo-bucket.s3.us-east-1.amazonaws.com", "CachePolicyId": "658327ea-f89d-4fab-a63d-7e88639e5ABC", "ViewerProtocolPolicy": "allow-all", "AllowedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ], "CachedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ] } } }, "Enabled": true, "HttpVersion": "http2", "ConnectionMode": "tenant-only", "TenantConfig": { "ParameterDefinitions": [ { "Name": "tenantName", "Definition": { "StringSchema": { "Comment": "tenantName parameter", "DefaultValue": "root", "Required": false } } } ] } } ``` Resultado: ``` { "Location": "https://cloudfront.amazonaws.com/2020-05-31/distribution/E2GJ5J9QN12ABC", "ETag": "E37YLVVQIABC", "Distribution": { "Id": "E2GJ5J9QNABC", "ARN": "arn:aws:cloudfront::123456789012:distribution/E2GJ5J9QN12ABC", "Status": "InProgress", "LastModifiedTime": "2025-07-10T20:35:20.565000+00:00", "InProgressInvalidationBatches": 0, "DomainName": "example.com", "ActiveTrustedSigners": { "Enabled": false, "Quantity": 0 }, "ActiveTrustedKeyGroups": { "Enabled": false, "Quantity": 0 }, "DistributionConfig": { "CallerReference": "cli-example-no-cert", "DefaultRootObject": "index.html", "Origins": { "Quantity": 1, "Items": [ { "Id": "amzn-s3-demo-bucket.s3.us-east-1.amazonaws.com", "DomainName": "amzn-s3-demo-bucket.s3.us-east-1.amazonaws.com", "OriginPath": "/{{tenantName}}", "CustomHeaders": { "Quantity": 0 }, "S3OriginConfig": { "OriginAccessIdentity": "" }, "ConnectionAttempts": 3, "ConnectionTimeout": 10, "OriginShield": { "Enabled": false }, "OriginAccessControlId": "" } ] }, "OriginGroups": { "Quantity": 0 }, "DefaultCacheBehavior": { "TargetOriginId": "amzn-s3-demo-bucket.s3.us-east-1.amazonaws.com", "TrustedKeyGroups": { "Enabled": false, "Quantity": 0 }, "ViewerProtocolPolicy": "allow-all", "AllowedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ], "CachedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ] } }, "Compress": false, "LambdaFunctionAssociations": { "Quantity": 0 }, "FunctionAssociations": { "Quantity": 0 }, "FieldLevelEncryptionId": "", "CachePolicyId": "658327ea-f89d-4fab-a63d-7e88639e5ABC", "GrpcConfig": { "Enabled": false } }, "CacheBehaviors": { "Quantity": 0 }, "CustomErrorResponses": { "Quantity": 0 }, "Comment": "CLI example distribution", "Logging": { "Enabled": false, "IncludeCookies": false, "Bucket": "", "Prefix": "" }, "Enabled": true, "ViewerCertificate": { "CloudFrontDefaultCertificate": true, "SSLSupportMethod": "sni-only", "MinimumProtocolVersion": "TLSv1", "CertificateSource": "cloudfront" }, "Restrictions": { "GeoRestriction": { "RestrictionType": "none", "Quantity": 0 } }, "WebACLId": "", "HttpVersion": "http2", "TenantConfig": { "ParameterDefinitions": [ { "Name": "tenantName", "Definition": { "StringSchema": { "Comment": "tenantName parameter", "DefaultValue": "root", "Required": false } } } ] }, "ConnectionMode": "tenant-only" } } } ``` Para ter mais informações, consulte [Criar distribuições](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-working-with.html) no *Guia do desenvolvedor do Amazon CloudFront*. + Consulte detalhes da API em [CreateDistribution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/create-distribution.html) na *Referência de comandos da AWS CLI*. ### `create-field-level-encryption-config` O código de exemplo a seguir mostra como usar `create-field-level-encryption-config`. **AWS CLI** **Para criar uma configuração de criptografia no nível de campo do CloudFront** O exemplo a seguir cria uma configuração de criptografia no nível de campo fornecendo os parâmetros de configuração em um arquivo JSON chamado `fle-config.json`. Antes de criar uma configuração de criptografia no nível de campo, você deve ter um perfil de criptografia no nível de campo. Para criar um perfil, consulte o comando create-field-level-encryption-profile. Para obter mais informações sobre a criptografia no nível de campo do CloudFront, consulte [Como usar a criptografia no nível de campo para ajudar a proteger dados confidenciais](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html) no *Guia do desenvolvedor do Amazon CloudFront*. ``` aws cloudfront create-field-level-encryption-config \ --field-level-encryption-config file://fle-config.json ``` O arquivo `fle-config.json` é um documento JSON na pasta atual que contém o seguinte: ``` { "CallerReference": "cli-example", "Comment": "Example FLE configuration", "QueryArgProfileConfig": { "ForwardWhenQueryArgProfileIsUnknown": true, "QueryArgProfiles": { "Quantity": 0 } }, "ContentTypeProfileConfig": { "ForwardWhenContentTypeIsUnknown": true, "ContentTypeProfiles": { "Quantity": 1, "Items": [ { "Format": "URLEncoded", "ProfileId": "P280MFCLSYOCVU", "ContentType": "application/x-www-form-urlencoded" } ] } } } ``` Resultado: ``` { "Location": "https://cloudfront.amazonaws.com/2019-03-26/field-level-encryption/C3KM2WVD605UAY", "ETag": "E2P4Z4VU7TY5SG", "FieldLevelEncryption": { "Id": "C3KM2WVD605UAY", "LastModifiedTime": "2019-12-10T21:30:18.974Z", "FieldLevelEncryptionConfig": { "CallerReference": "cli-example", "Comment": "Example FLE configuration", "QueryArgProfileConfig": { "ForwardWhenQueryArgProfileIsUnknown": true, "QueryArgProfiles": { "Quantity": 0, "Items": [] } }, "ContentTypeProfileConfig": { "ForwardWhenContentTypeIsUnknown": true, "ContentTypeProfiles": { "Quantity": 1, "Items": [ { "Format": "URLEncoded", "ProfileId": "P280MFCLSYOCVU", "ContentType": "application/x-www-form-urlencoded" } ] } } } } } ``` + Para ver detalhes da API, consulte [CreateFieldLevelEncryptionConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/create-field-level-encryption-config.html) na *Referência de comandos da AWS CLI*. ### `create-field-level-encryption-profile` O código de exemplo a seguir mostra como usar `create-field-level-encryption-profile`. **AWS CLI** **Para criar um perfil de criptografia no nível de campo do CloudFront** O exemplo a seguir cria um perfil de criptografia no nível de campo fornecendo os parâmetros em um arquivo JSON chamado `fle-profile-config.json`. Antes de criar um perfil de criptografia no nível de campo, você deve ter uma chave pública do CloudFront. Para criar uma chave pública do CloudFront, consulte o comando create-public-key. Para obter mais informações sobre a criptografia no nível de campo do CloudFront, consulte [Como usar a criptografia no nível de campo para ajudar a proteger dados confidenciais](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html) no *Guia do desenvolvedor do Amazon CloudFront*. ``` aws cloudfront create-field-level-encryption-profile \ --field-level-encryption-profile-config file://fle-profile-config.json ``` O arquivo `fle-profile-config.json` é um documento JSON na pasta atual que contém o seguinte: ``` { "Name": "ExampleFLEProfile", "CallerReference": "cli-example", "Comment": "FLE profile for AWS CLI example", "EncryptionEntities": { "Quantity": 1, "Items": [ { "PublicKeyId": "K2K8NC4HVFE3M0", "ProviderId": "ExampleFLEProvider", "FieldPatterns": { "Quantity": 1, "Items": [ "ExampleSensitiveField" ] } } ] } } ``` Resultado: ``` { "Location": "https://cloudfront.amazonaws.com/2019-03-26/field-level-encryption-profile/PPK0UOSIF5WSV", "ETag": "E2QWRUHEXAMPLE", "FieldLevelEncryptionProfile": { "Id": "PPK0UOSIF5WSV", "LastModifiedTime": "2019-12-10T01:03:16.537Z", "FieldLevelEncryptionProfileConfig": { "Name": "ExampleFLEProfile", "CallerReference": "cli-example", "Comment": "FLE profile for AWS CLI example", "EncryptionEntities": { "Quantity": 1, "Items": [ { "PublicKeyId": "K2K8NC4HVFE3M0", "ProviderId": "ExampleFLEProvider", "FieldPatterns": { "Quantity": 1, "Items": [ "ExampleSensitiveField" ] } } ] } } } } ``` + Para ver detalhes da API, consulte [CreateFieldLevelEncryptionProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/create-field-level-encryption-profile.html) na *Referência de comandos da AWS CLI*. ### `create-invalidation-for-distribution-tenant` O código de exemplo a seguir mostra como usar `create-invalidation-for-distribution-tenant`. **AWS CLI** **Como criar uma invalidação do CloudFront para um locatário de distribuição** O exemplo `create-invalidation-for-distribution-tenant` a seguir cria uma invalidação para todos os arquivos em um locatário de distribuição do CloudFront. ``` aws cloudfront create-invalidation-for-distribution-tenant \ --id dt_2wjDZi3hD1ivOXf6rpZJO1AB \ --invalidation-batch '{"Paths": {"Quantity": 1, "Items": ["/*"]}, "CallerReference": "invalidation-$(date +%s)"}' ``` Resultado: ``` { "Location": "https://cloudfront.amazonaws.com/2020-05-31/distribution-tenant/dt_2wjDZi3hD1ivOXf6rpZJO1AB/invalidation/I2JGL2F1ZAA426PGG0YLLKABC", "Invalidation": { "Id": "I2JGL2F1ZAA426PGG0YLLKABC", "Status": "InProgress", "CreateTime": "2025-05-07T16:59:25.947000+00:00", "InvalidationBatch": { "Paths": { "Quantity": 1, "Items": [ "/*" ] }, "CallerReference": "invalidation-$(date +%s)" } } } ``` Para ter mais informações, consulte [Invalidar arquivos para remover conteúdo](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html) no *Guia do desenvolvedor do Amazon CloudFront*. + Para ver detalhes da API, consulte [CreateInvalidationForDistributionTenant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/create-invalidation-for-distribution-tenant.html) na *Referência de comandos da AWS CLI*. ### `create-invalidation` O código de exemplo a seguir mostra como usar `create-invalidation`. **AWS CLI** **Como criar uma invalidação para uma distribuição do CloudFront** O exemplo `create-invalidation` a seguir cria uma invalidação para os arquivos especificados na distribuição especificada do CloudFront: ``` aws cloudfront create-invalidation \ --distribution-id EDFDVBD6EXAMPLE \ --paths "/example-path/example-file.jpg" "/example-path/example-file2.png" ``` Resultado: ``` { "Location": "https://cloudfront.amazonaws.com/2019-03-26/distribution/EDFDVBD6EXAMPLE/invalidation/I1JLWSDAP8FU89", "Invalidation": { "Id": "I1JLWSDAP8FU89", "Status": "InProgress", "CreateTime": "2019-12-05T18:24:51.407Z", "InvalidationBatch": { "Paths": { "Quantity": 2, "Items": [ "/example-path/example-file2.png", "/example-path/example-file.jpg" ] }, "CallerReference": "cli-1575570291-670203" } } } ``` No exemplo anterior, a AWS CLI gerou automaticamente um `CallerReference` aleatório. Para especificar seu próprio `CallerReference` ou evitar passar os parâmetros de invalidação como argumentos da linha de comando, é possível usar um arquivo JSON. O exemplo a seguir cria uma invalidação para dois arquivos fornecendo os parâmetros de invalidação em um arquivo JSON chamado `inv-batch.json`: ``` aws cloudfront create-invalidation \ --distribution-id EDFDVBD6EXAMPLE \ --invalidation-batch file://inv-batch.json ``` Conteúdo de `inv-batch.json`: ``` { "Paths": { "Quantity": 2, "Items": [ "/example-path/example-file.jpg", "/example-path/example-file2.png" ] }, "CallerReference": "cli-example" } ``` Resultado: ``` { "Location": "https://cloudfront.amazonaws.com/2019-03-26/distribution/EDFDVBD6EXAMPLE/invalidation/I2J0I21PCUYOIK", "Invalidation": { "Id": "I2J0I21PCUYOIK", "Status": "InProgress", "CreateTime": "2019-12-05T18:40:49.413Z", "InvalidationBatch": { "Paths": { "Quantity": 2, "Items": [ "/example-path/example-file.jpg", "/example-path/example-file2.png" ] }, "CallerReference": "cli-example" } } } ``` + Para detalhes da API, consulte [CreateInvalidation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/create-invalidation.html) na *Referência de comandos da AWS CLI*. ### `create-public-key` O código de exemplo a seguir mostra como usar `create-public-key`. **AWS CLI** **Como criar uma chave pública do CloudFront** O exemplo a seguir cria uma chave pública do CloudFront fornecendo os parâmetros em um arquivo JSON chamado `pub-key-config.json`. Antes de usar esse comando, você deve ter uma chave pública codificada em PEM. Para obter mais informações, consulte [Criar um par de chaves do RSA](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html#field-level-encryption-setting-up-step1) no *Guia do desenvolvedor do Amazon CloudFront*. ``` aws cloudfront create-public-key \ --public-key-config file://pub-key-config.json ``` O arquivo `pub-key-config.json` é um documento JSON na pasta atual que contém o seguinte. Observe que a chave pública é codificada no formato PEM. ``` { "CallerReference": "cli-example", "Name": "ExampleKey", "EncodedKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxPMbCA2Ks0lnd7IR+3pw\nwd3H/7jPGwj8bLUmore7bX+oeGpZ6QmLAe/1UOWcmZX2u70dYcSIzB1ofZtcn4cJ\nenHBAzO3ohBY/L1tQGJfS2A+omnN6H16VZE1JCK8XSJyfze7MDLcUyHZETdxuvRb\nA9X343/vMAuQPnhinFJ8Wdy8YBXSPpy7r95ylUQd9LfYTBzVZYG2tSesplcOkjM3\n2Uu+oMWxQAw1NINnSLPinMVsutJy6ZqlV3McWNWe4T+STGtWhrPNqJEn45sIcCx4\nq+kGZ2NQ0FyIyT2eiLKOX5Rgb/a36E/aMk4VoDsaenBQgG7WLTnstb9sr7MIhS6A\nrwIDAQAB\n-----END PUBLIC KEY-----\n", "Comment": "example public key" } ``` Resultado: ``` { "Location": "https://cloudfront.amazonaws.com/2019-03-26/public-key/KDFB19YGCR002", "ETag": "E2QWRUHEXAMPLE", "PublicKey": { "Id": "KDFB19YGCR002", "CreatedTime": "2019-12-05T18:51:43.781Z", "PublicKeyConfig": { "CallerReference": "cli-example", "Name": "ExampleKey", "EncodedKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxPMbCA2Ks0lnd7IR+3pw\nwd3H/7jPGwj8bLUmore7bX+oeGpZ6QmLAe/1UOWcmZX2u70dYcSIzB1ofZtcn4cJ\nenHBAzO3ohBY/L1tQGJfS2A+omnN6H16VZE1JCK8XSJyfze7MDLcUyHZETdxuvRb\nA9X343/vMAuQPnhinFJ8Wdy8YBXSPpy7r95ylUQd9LfYTBzVZYG2tSesplcOkjM3\n2Uu+oMWxQAw1NINnSLPinMVsutJy6ZqlV3McWNWe4T+STGtWhrPNqJEn45sIcCx4\nq+kGZ2NQ0FyIyT2eiLKOX5Rgb/a36E/aMk4VoDsaenBQgG7WLTnstb9sr7MIhS6A\nrwIDAQAB\n-----END PUBLIC KEY-----\n", "Comment": "example public key" } } } ``` + Consulte detalhes da API em [CreatePublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/create-public-key.html) na *Referência de comandos da AWS CLI*. ### `delete-cloud-front-origin-access-identity` O código de exemplo a seguir mostra como usar `delete-cloud-front-origin-access-identity`. **AWS CLI** **Para excluir uma identidade do acesso de origem do CloudFront** O exemplo a seguir exclui a identidade do acesso de origem (OAI) com o ID `E74FTE3AEXAMPLE`. Para excluir uma OAI, você deve ter o ID da OAI e a `ETag`. O ID da OAI é retornado na saída dos comandos create-cloud-front-origin-access-identity e list-cloud-front-origin-access-identities. Para obter a `ETag`, use o comando get-cloud-front-origin-access-identity ou get-cloud-front-origin-access-identity-config. Use a opção `--if-match` para fornecer a `ETag` da OAI. ``` aws cloudfront delete-cloud-front-origin-access-identity \ --id E74FTE3AEXAMPLE \ --if-match E2QWRUHEXAMPLE ``` Quando bem-sucedido, este comando não tem saída. + Para ver detalhes da API, consulte [DeleteCloudFrontOriginAccessIdentity](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/delete-cloud-front-origin-access-identity.html) na *Referência de comandos da AWS CLI*. ### `delete-connection-group` O código de exemplo a seguir mostra como usar `delete-connection-group`. **AWS CLI** **Como excluir um grupo de conexões** O exemplo `delete-connection-group` a seguir exclui um grupo de conexões. O grupo de conexões deve estar desabilitado e não pode ser associado a nenhum recurso do CloudFront. ``` aws cloudfront delete-connection-group \ --id cg_2wjLpjbHkLUdhWAjHllcOeABC \ --if-match ETVPDKIKX0DABC ``` Quando bem-sucedido, este comando não tem saída. Para ter mais informações sobre como gerenciar grupos de conexões, consulte [Criar grupo de conexões personalizado (opcional)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-connection-group.html) no *Guia do desenvolvedor do Amazon CloudFront*. + Para ver detalhes da API, consulte [DeleteConnectionGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/delete-connection-group.html) na *Referência de comandos da AWS CLI*. ### `delete-distribution-tenant` O código de exemplo a seguir mostra como usar `delete-distribution-tenant`. **AWS CLI** **Como excluir um locatário de distribuição** O exemplo `delete-distribution-tenant` a seguir exclui um locatário de distribuição com a ETag `ETVPDKIKX0DABC`. O locatário de distribuição deve estar desabilitado e não pode ser associado a nenhum recurso do CloudFront. ``` aws cloudfront delete-distribution-tenant \ --id dt_2wjMUbg3NHZEQ7OfoalP5zi1AB \ --if-match ETVPDKIKX0DABC ``` Quando bem-sucedido, este comando não tem saída. Para ter mais informações, consulte [Excluir uma distribuição](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html) no *Guia do desenvolvedor do Amazon CloudFront*. + Para ver detalhes da API, consulte [DeleteDistributionTenant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/delete-distribution-tenant.html) na *Referência de comandos da AWS CLI*. ### `delete-distribution` O código de exemplo a seguir mostra como usar `delete-distribution`. **AWS CLI** **Como excluir uma distribuição do CloudFront** O exemplo a seguir exclui a distribuição do CloudFront com o ID `EDFDVBD6EXAMPLE`. Você deve desabilitar uma distribuição antes de exclui-la. Use o comando update-distribution para desabilitar uma distribuição. Para obter mais informações, consulte exemplos do comando update-distribution. Uma distribuição pode ser excluída depois de ser desabilitada. Para excluir uma distribuição, use a opção `--if-match` para fornecer o `ETag` da distribuição. Use o comando get-distribution ou get-distribution-config para obter o `ETag`. ``` aws cloudfront delete-distribution \ --id EDFDVBD6EXAMPLE \ --if-match E2QWRUHEXAMPLE ``` Quando bem-sucedido, este comando não tem saída. + Consulte detalhes da API em [DeleteDistribution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/delete-distribution.html) na *Referência de comandos da AWS CLI*. ### `delete-field-level-encryption-config` O código de exemplo a seguir mostra como usar `delete-field-level-encryption-config`. **AWS CLI** **Para excluir uma configuração de criptografia no nível de campo do CloudFront** O exemplo a seguir exclui a configuração de criptografia no nível de campo do CloudFront com o ID `C3KM2WVD605UAY`. Para excluir uma configuração de criptografia no nível de campo, você deve ter o ID e a `ETag`. O ID é retornado na saída dos comandos create-field-level-encryption-config e list-field-level-encryption-configs. Para obter a `ETag`, use o comando get-field-level-encryption ou get-field-level-encryption-config. Use a opção `--if-match` para fornecer a `ETag` das configurações. ``` aws cloudfront delete-field-level-encryption-config \ --id C3KM2WVD605UAY \ --if-match E26M4BIAV81ZF6 ``` Quando bem-sucedido, este comando não tem saída. + Para ver detalhes da API, consulte [DeleteFieldLevelEncryptionConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/delete-field-level-encryption-config.html) na *Referência de comandos da AWS CLI*. ### `delete-field-level-encryption-profile` O código de exemplo a seguir mostra como usar `delete-field-level-encryption-profile`. **AWS CLI** **Para excluir um perfil de criptografia no nível de campo do CloudFront** O exemplo a seguir exclui o perfil de criptografia no nível de campo do CloudFront com o ID `PPK0UOSIF5WSV`. Para excluir um perfil de criptografia no nível de campo, você deve ter o ID e a `ETag`. O ID é retornado na saída dos comandos create-field-level-encryption-profile e list-field-level-encryption-profiles. Para obter a `ETag`, use o comando get-field-level-encryption-profile ou get-field-level-encryption-profile-config. Use a opção `--if-match` para fornecer a `ETag` do perfil. ``` aws cloudfront delete-field-level-encryption-profile \ --id PPK0UOSIF5WSV \ --if-match EJETYFJ9CL66D ``` Quando bem-sucedido, este comando não tem saída. + Para ver detalhes da API, consulte [DeleteFieldLevelEncryptionProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/delete-field-level-encryption-profile.html) na *Referência de comandos da AWS CLI*. ### `delete-public-key` O código de exemplo a seguir mostra como usar `delete-public-key`. **AWS CLI** **Para excluir uma chave pública do CloudFront** O exemplo a seguir exclui a chave pública do CloudFront com o ID `KDFB19YGCR002`. Para excluir uma chave pública, você deve ter seu ID e `ETag`. O ID é retornado na saída dos comandos create-public-key e list-public-keys. Para obter a `ETag`, use o comando get-public-key ou get-public-key-config. Use a opção `--if-match` para fornecer a `ETag` da chave pública. ``` aws cloudfront delete-public-key \ --id KDFB19YGCR002 \ --if-match E2QWRUHEXAMPLE ``` Quando bem-sucedido, este comando não tem saída. + Para ver detalhes da API, consulte [DeletePublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/delete-public-key.html) na *Referência de comandos da AWS CLI*. ### `disassociate-distribution-tenant-web-acl` O código de exemplo a seguir mostra como usar `disassociate-distribution-tenant-web-acl`. **AWS CLI** **Como desassociar uma ACL da web de um locatário de distribuição** O exemplo `disassociate-distribution-tenant-web-acl` a seguir dissocia uma ACL da web de um locatário de distribuição com a ETag `E1PA6795UKMABC`. ``` aws cloudfront disassociate-distribution-tenant-web-acl \ --id dt_2wjDZi3hD1ivOXf6rpZJOSNE1AB \ --if-match E1PA6795UKMABC ``` Resultado: ``` { "ETag": "E13V1IB3VIYABC", "Id": "dt_2wjDZi3hD1ivOXf6rpZJOSNE1AB" } ``` Para ter mais informações, consulte [Desabilitar as proteções de segurança do AWS WAF](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/disable-waf.html) no *Guia do desenvolvedor do Amazon CloudFront*. + Para ver detalhes da API, consulte [DisassociateDistributionTenantWebAcl](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/disassociate-distribution-tenant-web-acl.html) na *Referência de comandos da AWS CLI*. ### `disassociate-distribution-web-acl` O código de exemplo a seguir mostra como usar `disassociate-distribution-web-acl`. **AWS CLI** **Como desassociar uma ACL da web de uma distribuição do CloudFront** O exemplo `disassociate-distribution-web-acl` a seguir remove a associação entre uma ACL da web e uma distribuição do CloudFront com a ETag `E13V1IB3VIYABC`. ``` aws cloudfront disassociate-distribution-web-acl \ --id E1XNX8R2GOAABC \ --if-match EEZQ9Z24VM1ABC ``` Resultado: ``` { "ETag": "E2YWS1C2J3OABC", "Id": "E1XNX8R2GOAABC" } ``` Para ter mais informações, consulte [Desabilitar as proteções de segurança do AWS WAF](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/disable-waf.html) no *Guia do desenvolvedor do Amazon CloudFront*. + Para ver detalhes da API, consulte [DisassociateDistributionWebAcl](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/disassociate-distribution-web-acl.html) na *Referência de comandos da AWS CLI*. ### `get-cloud-front-origin-access-identity-config` O código de exemplo a seguir mostra como usar `get-cloud-front-origin-access-identity-config`. **AWS CLI** **Como obter uma configuração de identidade do acesso de origem do CloudFront** O exemplo a seguir obtém metadados sobre a identidade do acesso de origem (OAI) do CloudFront com o ID `E74FTE3AEXAMPLE`, incluindo a `ETag`. O ID da OAI é retornado na saída dos comandos create-cloud-front-origin-access-identity e list-cloud-front-origin-access-identities. ``` aws cloudfront get-cloud-front-origin-access-identity-config --id E74FTE3AEXAMPLE ``` Resultado: ``` { "ETag": "E2QWRUHEXAMPLE", "CloudFrontOriginAccessIdentityConfig": { "CallerReference": "cli-example", "Comment": "Example OAI" } } ``` + Consulte detalhes da API em [GetCloudFrontOriginAccessIdentityConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-cloud-front-origin-access-identity-config.html) na *Referência de comandos da AWS CLI*. ### `get-cloud-front-origin-access-identity` O código de exemplo a seguir mostra como usar `get-cloud-front-origin-access-identity`. **AWS CLI** **Para obter uma identidade do acesso de origem do CloudFront** O exemplo a seguir obtém a identidade do acesso de origem (OAI) do CloudFront com a ID `E74FTE3AEXAMPLE`, incluindo sua `ETag` e a ID canônica associada do S3. O ID da OAI é retornado na saída dos comandos create-cloud-front-origin-access-identity e list-cloud-front-origin-access-identities. ``` aws cloudfront get-cloud-front-origin-access-identity --id E74FTE3AEXAMPLE ``` Resultado: ``` { "ETag": "E2QWRUHEXAMPLE", "CloudFrontOriginAccessIdentity": { "Id": "E74FTE3AEXAMPLE", "S3CanonicalUserId": "cd13868f797c227fbea2830611a26fe0a21ba1b826ab4bed9b7771c9aEXAMPLE", "CloudFrontOriginAccessIdentityConfig": { "CallerReference": "cli-example", "Comment": "Example OAI" } } } ``` + Consulte detalhes da API em [GetCloudFrontOriginAccessIdentity](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-cloud-front-origin-access-identity.html) na *Referência de comandos da AWS CLI*. ### `get-connection-group-by-routing-endpoint` O código de exemplo a seguir mostra como usar `get-connection-group-by-routing-endpoint`. **AWS CLI** **Como obter um grupo de conexão por endpoint de roteamento** O exemplo `get-connection-group-by-routing-endpoint` a seguir recupera informações sobre um grupo de conexões usando o respectivo endpoint de roteamento. ``` aws cloudfront get-connection-group-by-routing-endpoint \ --routing-endpoint dvdg9gprgabc.cloudfront.net ``` Resultado: ``` { "ETag": "E23ZP02F085ABC", "ConnectionGroup": { "Id": "cg_2wjDWTBKTlRB87cAaUQFaakABC", "Name": "connection-group-2", "Arn": "arn:aws:cloudfront::123456789012:connection-group/cg_2wjDWTBKTlRB87cAaUQFaakABC", "CreatedTime": "2025-05-06T15:42:00.790000+00:00", "LastModifiedTime": "2025-05-06T15:42:00.790000+00:00", "Ipv6Enabled": true, "RoutingEndpoint": "dvdg9gprgabc.cloudfront.net", "Status": "Deployed", "Enabled": true, "IsDefault": false } } ``` Para ter mais informações, consulte [Criar grupo de conexões personalizado (opcional)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-connection-group.html) no *Guia do desenvolvedor do Amazon CloudFront*. + Para ver detalhes da API, consulte [GetConnectionGroupByRoutingEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-connection-group-by-routing-endpoint.html) na *Referência de comandos da AWS CLI*. ### `get-connection-group` O código de exemplo a seguir mostra como usar `get-connection-group`. **AWS CLI** **Como obter um grupo de conexões do CloudFront** O exemplo `get-connection-group` a seguir recupera informações sobre um grupo de conexões do CloudFront. ``` aws cloudfront get-connection-group \ --identifier cg_2wjDWTBKTlRB87cAaUQFaakABC ``` Resultado: ``` { "ETag": "E23ZP02F085ABC", "ConnectionGroup": { "Id": "cg_2wjDWTBKTlRB87cAaUQFaakABC", "Name": "connection-group-2", "Arn": "arn:aws:cloudfront::123456789012:connection-group/cg_2wjDWTBKTlRB87cAaUQFaakABC", "CreatedTime": "2025-05-06T15:42:00.790000+00:00", "LastModifiedTime": "2025-05-06T15:42:00.790000+00:00", "Ipv6Enabled": true, "RoutingEndpoint": "dvdg9gprgabc.cloudfront.net", "Status": "Deployed", "Enabled": true, "IsDefault": false } } ``` Para ter mais informações, consulte [Criar grupo de conexões personalizado (opcional)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-connection-group.html) no *Guia do desenvolvedor do Amazon CloudFront*. + Para ver detalhes da API, consulte [GetConnectionGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-connection-group.html) na *Referência de comandos da AWS CLI*. ### `get-distribution-config` O código de exemplo a seguir mostra como usar `get-distribution-config`. **AWS CLI** **Como obter uma configuração de distribuição do CloudFront** O exemplo a seguir obtém metadados sobre a distribuição do CloudFront com o ID `EDFDVBD6EXAMPLE`, incluindo o `ETag`. O ID de distribuição é retornado nos comandos create-distribution e list-distributions. ``` aws cloudfront get-distribution-config \ --id EDFDVBD6EXAMPLE ``` Resultado: ``` { "ETag": "E2QWRUHEXAMPLE", "DistributionConfig": { "CallerReference": "cli-example", "Aliases": { "Quantity": 0 }, "DefaultRootObject": "index.html", "Origins": { "Quantity": 1, "Items": [ { "Id": "amzn-s3-demo-bucket---s3.amazonaws.com.rproxy.goskope.com-cli-example", "DomainName": "amzn-s3-demo-bucket.s3.amazonaws.com", "OriginPath": "", "CustomHeaders": { "Quantity": 0 }, "S3OriginConfig": { "OriginAccessIdentity": "" } } ] }, "OriginGroups": { "Quantity": 0 }, "DefaultCacheBehavior": { "TargetOriginId": "amzn-s3-demo-bucket---s3.amazonaws.com.rproxy.goskope.com-cli-example", "ForwardedValues": { "QueryString": false, "Cookies": { "Forward": "none" }, "Headers": { "Quantity": 0 }, "QueryStringCacheKeys": { "Quantity": 0 } }, "TrustedSigners": { "Enabled": false, "Quantity": 0 }, "ViewerProtocolPolicy": "allow-all", "MinTTL": 0, "AllowedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ], "CachedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ] } }, "SmoothStreaming": false, "DefaultTTL": 86400, "MaxTTL": 31536000, "Compress": false, "LambdaFunctionAssociations": { "Quantity": 0 }, "FieldLevelEncryptionId": "" }, "CacheBehaviors": { "Quantity": 0 }, "CustomErrorResponses": { "Quantity": 0 }, "Comment": "", "Logging": { "Enabled": false, "IncludeCookies": false, "Bucket": "", "Prefix": "" }, "PriceClass": "PriceClass_All", "Enabled": true, "ViewerCertificate": { "CloudFrontDefaultCertificate": true, "MinimumProtocolVersion": "TLSv1", "CertificateSource": "cloudfront" }, "Restrictions": { "GeoRestriction": { "RestrictionType": "none", "Quantity": 0 } }, "WebACLId": "", "HttpVersion": "http2", "IsIPV6Enabled": true } } ``` + Consulte detalhes da API em [GetDistributionConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-distribution-config.html) na *Referência de comandos da AWS CLI*. ### `get-distribution-tenant-by-domain` O código de exemplo a seguir mostra como usar `get-distribution-tenant-by-domain`. **AWS CLI** **Como obter informações sobre um locatário de distribuição por domínio** O exemplo `get-distribution-tenant-by-domain` a seguir recupera informações sobre um locatário de distribuição usando o domínio especificado. ``` aws cloudfront get-distribution-tenant-by-domain \ --domain example.com ``` Resultado: ``` { "ETag": "E23ZP02F085ABC", "DistributionTenant": { "Id": "dt_2xVInRKCfUzQHgxosDs9hiLk1AB", "DistributionId": "E1XNX8R2GOAABC", "Name": "example-tenant-4", "Arn": "arn:aws:cloudfront::123456789012:distribution-tenant/dt_2xVInRKCfUzQHgxosDs9hiLk1AB", "Domains": [ { "Domain": "example.com", "Status": "active" } ], "Parameters": [ { "Name": "testParam", "Value": "defaultValue" } ], "ConnectionGroupId": "cg_2whCJoXMYCjHcxaLGrkllvyABC", "CreatedTime": "2025-05-23T16:16:20.871000+00:00", "LastModifiedTime": "2025-05-23T16:16:20.871000+00:00", "Enabled": false, "Status": "Deployed" } } ``` Para obter mais informações, consulte [Understand how multi-tenant distributions work](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html) no *Amazon CloudFront Developer Guide*. + Para ver detalhes da API, consulte [GetDistributionTenantByDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-distribution-tenant-by-domain.html) na *Referência de comandos da AWS CLI*. ### `get-distribution-tenant` O código de exemplo a seguir mostra como usar `get-distribution-tenant`. **AWS CLI** **Como obter detalhes sobre um locatário de distribuição do CloudFront** O exemplo `get-distribution-tenant` a seguir recupera informações sobre um locatário de distribuição do CloudFront. ``` aws cloudfront get-distribution-tenant \ --id dt_2wjDZi3hD1ivOXf6rpZJOSNE1AB ``` Resultado: ``` { "ETag": "E23ZP02F085ABC", "DistributionTenant": { "Id": "dt_2wjDZi3hD1ivOXf6rpZJOSNE1AB", "DistributionId": "E1XNX8R2GOAABC", "Name": "example-tenant-2", "Arn": "arn:aws:cloudfront::123456789012:distribution-tenant/dt_2wjDZi3hD1ivOXf6rpZJOSNE1AB", "Domains": [ { "Domain": "example.com", "Status": "inactive" } ], "ConnectionGroupId": "cg_2wjDWTBKTlRB87cAaUQFaakABC", "CreatedTime": "2025-05-06T15:42:28.542000+00:00", "LastModifiedTime": "2025-05-06T15:42:37.724000+00:00", "Enabled": true, "Status": "InProgress" } } ``` Para obter mais informações, consulte [Understand how multi-tenant distributions work](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html) no *Amazon CloudFront Developer Guide*. + Para ver detalhes da API, consulte [GetDistributionTenant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-distribution-tenant.html) na *Referência de comandos da AWS CLI*. ### `get-distribution` O código de exemplo a seguir mostra como usar `get-distribution`. **AWS CLI** **Como obter uma distribuição do CloudFront** O exemplo de `get-distribution` a seguir obtém a distribuição do CloudFront com o ID `EDFDVBD6EXAMPLE`, incluindo a respectiva `ETag`. O ID de distribuição é retornado nos comandos create-distribution e list-distributions. ``` aws cloudfront get-distribution \ --id EDFDVBD6EXAMPLE ``` Resultado: ``` { "ETag": "E2QWRUHEXAMPLE", "Distribution": { "Id": "EDFDVBD6EXAMPLE", "ARN": "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", "Status": "Deployed", "LastModifiedTime": "2019-12-04T23:35:41.433Z", "InProgressInvalidationBatches": 0, "DomainName": "d111111abcdef8.cloudfront.net", "ActiveTrustedSigners": { "Enabled": false, "Quantity": 0 }, "DistributionConfig": { "CallerReference": "cli-example", "Aliases": { "Quantity": 0 }, "DefaultRootObject": "index.html", "Origins": { "Quantity": 1, "Items": [ { "Id": "amzn-s3-demo-bucket---s3.amazonaws.com.rproxy.goskope.com-cli-example", "DomainName": "amzn-s3-demo-bucket.s3.amazonaws.com", "OriginPath": "", "CustomHeaders": { "Quantity": 0 }, "S3OriginConfig": { "OriginAccessIdentity": "" } } ] }, "OriginGroups": { "Quantity": 0 }, "DefaultCacheBehavior": { "TargetOriginId": "amzn-s3-demo-bucket---s3.amazonaws.com.rproxy.goskope.com-cli-example", "ForwardedValues": { "QueryString": false, "Cookies": { "Forward": "none" }, "Headers": { "Quantity": 0 }, "QueryStringCacheKeys": { "Quantity": 0 } }, "TrustedSigners": { "Enabled": false, "Quantity": 0 }, "ViewerProtocolPolicy": "allow-all", "MinTTL": 0, "AllowedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ], "CachedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ] } }, "SmoothStreaming": false, "DefaultTTL": 86400, "MaxTTL": 31536000, "Compress": false, "LambdaFunctionAssociations": { "Quantity": 0 }, "FieldLevelEncryptionId": "" }, "CacheBehaviors": { "Quantity": 0 }, "CustomErrorResponses": { "Quantity": 0 }, "Comment": "", "Logging": { "Enabled": false, "IncludeCookies": false, "Bucket": "", "Prefix": "" }, "PriceClass": "PriceClass_All", "Enabled": true, "ViewerCertificate": { "CloudFrontDefaultCertificate": true, "MinimumProtocolVersion": "TLSv1", "CertificateSource": "cloudfront" }, "Restrictions": { "GeoRestriction": { "RestrictionType": "none", "Quantity": 0 } }, "WebACLId": "", "HttpVersion": "http2", "IsIPV6Enabled": true } } } ``` + Consulte detalhes da API em [GetDistribution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-distribution.html) na *Referência de comandos da AWS CLI*. ### `get-field-level-encryption-config` O código de exemplo a seguir mostra como usar `get-field-level-encryption-config`. **AWS CLI** **Para obter metadados sobre uma configuração de criptografia no nível de campo do CloudFront** O exemplo a seguir obtém metadados sobre a configuração de criptografia no nível de campo do CloudFront com o ID `C3KM2WVD605UAY`, incluindo a `ETag`: ``` aws cloudfront get-field-level-encryption-config --id C3KM2WVD605UAY ``` Resultado: ``` { "ETag": "E2P4Z4VU7TY5SG", "FieldLevelEncryptionConfig": { "CallerReference": "cli-example", "Comment": "Example FLE configuration", "QueryArgProfileConfig": { "ForwardWhenQueryArgProfileIsUnknown": true, "QueryArgProfiles": { "Quantity": 0, "Items": [] } }, "ContentTypeProfileConfig": { "ForwardWhenContentTypeIsUnknown": true, "ContentTypeProfiles": { "Quantity": 1, "Items": [ { "Format": "URLEncoded", "ProfileId": "P280MFCLSYOCVU", "ContentType": "application/x-www-form-urlencoded" } ] } } } } ``` + Para ver detalhes da API, consulte [GetFieldLevelEncryptionConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-field-level-encryption-config.html) na *Referência de comandos da AWS CLI*. ### `get-field-level-encryption-profile-config` O código de exemplo a seguir mostra como usar `get-field-level-encryption-profile-config`. **AWS CLI** **Para obter uma configuração de perfil de criptografia no nível de campo do CloudFront** O exemplo a seguir obtém metadados sobre o perfil de criptografia no nível de campo do CloudFront com o ID `PPK0UOSIF5WSV`, incluindo a `ETag`: ``` aws cloudfront get-field-level-encryption-profile-config --id PPK0UOSIF5WSV ``` Resultado: ``` { "ETag": "E1QQG65FS2L2GC", "FieldLevelEncryptionProfileConfig": { "Name": "ExampleFLEProfile", "CallerReference": "cli-example", "Comment": "FLE profile for AWS CLI example", "EncryptionEntities": { "Quantity": 1, "Items": [ { "PublicKeyId": "K2K8NC4HVFE3M0", "ProviderId": "ExampleFLEProvider", "FieldPatterns": { "Quantity": 1, "Items": [ "ExampleSensitiveField" ] } } ] } } } ``` + Para ver detalhes da API, consulte [GetFieldLevelEncryptionProfileConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-field-level-encryption-profile-config.html) na *Referência de comandos da AWS CLI*. ### `get-field-level-encryption-profile` O código de exemplo a seguir mostra como usar `get-field-level-encryption-profile`. **AWS CLI** **Para obter um perfil de criptografia no nível de campo do CloudFront** O exemplo a seguir obtém o perfil de criptografia no nível de campo do CloudFront com o ID `PPK0UOSIF5WSV`, incluindo a `ETag`: ``` aws cloudfront get-field-level-encryption-profile --id PPK0UOSIF5WSV ``` Resultado: ``` { "ETag": "E1QQG65FS2L2GC", "FieldLevelEncryptionProfile": { "Id": "PPK0UOSIF5WSV", "LastModifiedTime": "2019-12-10T01:03:16.537Z", "FieldLevelEncryptionProfileConfig": { "Name": "ExampleFLEProfile", "CallerReference": "cli-example", "Comment": "FLE profile for AWS CLI example", "EncryptionEntities": { "Quantity": 1, "Items": [ { "PublicKeyId": "K2K8NC4HVFE3M0", "ProviderId": "ExampleFLEProvider", "FieldPatterns": { "Quantity": 1, "Items": [ "ExampleSensitiveField" ] } } ] } } } } ``` + Para ver detalhes da API, consulte [GetFieldLevelEncryptionProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-field-level-encryption-profile.html) na *Referência de comandos da AWS CLI*. ### `get-field-level-encryption` O código de exemplo a seguir mostra como usar `get-field-level-encryption`. **AWS CLI** **Para obter uma configuração de criptografia no nível de campo do CloudFront** O exemplo a seguir obtém a configuração de criptografia no nível de campo do CloudFront com o ID `C3KM2WVD605UAY`, incluindo a `ETag`: ``` aws cloudfront get-field-level-encryption --id C3KM2WVD605UAY ``` Resultado: ``` { "ETag": "E2P4Z4VU7TY5SG", "FieldLevelEncryption": { "Id": "C3KM2WVD605UAY", "LastModifiedTime": "2019-12-10T21:30:18.974Z", "FieldLevelEncryptionConfig": { "CallerReference": "cli-example", "Comment": "Example FLE configuration", "QueryArgProfileConfig": { "ForwardWhenQueryArgProfileIsUnknown": true, "QueryArgProfiles": { "Quantity": 0, "Items": [] } }, "ContentTypeProfileConfig": { "ForwardWhenContentTypeIsUnknown": true, "ContentTypeProfiles": { "Quantity": 1, "Items": [ { "Format": "URLEncoded", "ProfileId": "P280MFCLSYOCVU", "ContentType": "application/x-www-form-urlencoded" } ] } } } } } ``` + Para ver detalhes da API, consulte [GetFieldLevelEncryption](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-field-level-encryption.html) na *Referência de comandos da AWS CLI*. ### `get-invalidation-for-distribution-tenant` O código de exemplo a seguir mostra como usar `get-invalidation-for-distribution-tenant`. **AWS CLI** **Como obter uma invalidação para um locatário de distribuição** O exemplo `get-invalidation-for-distribution-tenant` a seguir obtém informações sobre uma invalidação para um locatário de distribuição. ``` aws cloudfront get-invalidation-for-distribution-tenant \ --distribution-tenant-id dt_2wjDZi3hD1ivOXf6rpZJOSNE1AB \ --id I4CU23QAPKMUDUU06F9OFGFABC ``` Resultado: ``` { "Invalidation": { "Id": "I4CU23QAPKMUDUU06F9OFGFABC", "Status": "Completed", "CreateTime": "2025-05-06T15:46:12.824000+00:00", "InvalidationBatch": { "Paths": { "Quantity": 2, "Items": [ "/example/invalidation", "/more/invalidations" ] }, "CallerReference": "007ee5a6-d0a0-42be-bb61-e7b915969b48" } } } ``` Para ter mais informações, consulte [Invalidar arquivos para remover conteúdo](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html) no *Guia do desenvolvedor do Amazon CloudFront*. + Para ver detalhes da API, consulte [GetInvalidationForDistributionTenant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-invalidation-for-distribution-tenant.html) na *Referência de comandos da AWS CLI*. ### `get-invalidation` O código de exemplo a seguir mostra como usar `get-invalidation`. **AWS CLI** **Para obter uma invalidação do CloudFront** O exemplo a seguir obtém a invalidação com o ID `I2J0I21PCUYOIK` da distribuição do CloudFront com o ID `EDFDVBD6EXAMPLE`: ``` aws cloudfront get-invalidation --id I2J0I21PCUYOIK --distribution-id EDFDVBD6EXAMPLE ``` Resultado: ``` { "Invalidation": { "Status": "Completed", "InvalidationBatch": { "Paths": { "Items": [ "/example-path/example-file.jpg", "/example-path/example-file-2.jpg" ], "Quantity": 2 }, "CallerReference": "cli-example" }, "Id": "I2J0I21PCUYOIK", "CreateTime": "2019-12-05T18:40:49.413Z" } } ``` + Para ver detalhes da API, consulte [GetInvalidation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-invalidation.html) na *Referência de comandos da AWS CLI*. ### `get-managed-certificate-details` O código de exemplo a seguir mostra como usar `get-managed-certificate-details`. **AWS CLI** **Como obter detalhes de certificados gerenciados** O exemplo `get-managed-certificate-details` a seguir recupera os detalhes de um certificado do ACM gerenciado pelo CloudFront. ``` aws cloudfront get-managed-certificate-details \ --identifier dt_2wjDZi3hD1ivOXf6rpZJOSNE1AB ``` Resultado: ``` { "ManagedCertificateDetails": { "CertificateArn": "arn:aws:acm:us-east-1:123456789012:certificate/655dc1fe-6d37-451d-a013-c2db3a034abc", "CertificateStatus": "pending-validation", "ValidationTokenHost": "self-hosted", "ValidationTokenDetails": [ { "Domain": "example.com", "RedirectTo": "validation.us-east-1.acm-validations.aws/123456789012/.well-known/pki-validation/b315c9ae21284e7918bb9f3f422ab1c7.txt", "RedirectFrom": "example.com/.well-known/pki-validation/b315c9ae21284e7918bb9f3f422ac3c7.txt" } ] } } ``` Para ter mais informações, consulte [Solicitar certificados para locatários de distribuição do CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/managed-cloudfront-certificates.html) no *Guia do desenvolvedor do Amazon CloudFront*. + Para ver detalhes da API, consulte [GetManagedCertificateDetails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-managed-certificate-details.html) na *Referência de comandos da AWS CLI*. ### `get-public-key-config` O código de exemplo a seguir mostra como usar `get-public-key-config`. **AWS CLI** **Para obter uma configuração de chave pública do CloudFront** O exemplo a seguir obtém metadados sobre a chave pública do CloudFront com o ID `KDFB19YGCR002`, incluindo a `ETag`. O ID da chave pública é retornado nos comandos create-public-key e list-public-keys. ``` aws cloudfront get-public-key-config --id KDFB19YGCR002 ``` Resultado: ``` { "ETag": "E2QWRUHEXAMPLE", "PublicKeyConfig": { "CallerReference": "cli-example", "Name": "ExampleKey", "EncodedKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxPMbCA2Ks0lnd7IR+3pw\nwd3H/7jPGwj8bLUmore7bX+oeGpZ6QmLAe/1UOWcmZX2u70dYcSIzB1ofZtcn4cJ\nenHBAzO3ohBY/L1tQGJfS2A+omnN6H16VZE1JCK8XSJyfze7MDLcUyHZETdxuvRb\nA9X343/vMAuQPnhinFJ8Wdy8YBXSPpy7r95ylUQd9LfYTBzVZYG2tSesplcOkjM3\n2Uu+oMWxQAw1NINnSLPinMVsutJy6ZqlV3McWNWe4T+STGtWhrPNqJEn45sIcCx4\nq+kGZ2NQ0FyIyT2eiLKOX5Rgb/a36E/aMk4VoDsaenBQgG7WLTnstb9sr7MIhS6A\nrwIDAQAB\n-----END PUBLIC KEY-----\n", "Comment": "example public key" } } ``` + Para ver detalhes da API, consulte [GetPublicKeyConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-public-key-config.html) na *Referência de comandos da AWS CLI*. ### `get-public-key` O código de exemplo a seguir mostra como usar `get-public-key`. **AWS CLI** **Para obter uma chave pública do CloudFront** O exemplo a seguir obtém a chave pública do CloudFront com o ID `KDFB19YGCR002`, incluindo a `ETag`. O ID da chave pública é retornado nos comandos create-public-key e list-public-keys. ``` aws cloudfront get-public-key --id KDFB19YGCR002 ``` Resultado: ``` { "ETag": "E2QWRUHEXAMPLE", "PublicKey": { "Id": "KDFB19YGCR002", "CreatedTime": "2019-12-05T18:51:43.781Z", "PublicKeyConfig": { "CallerReference": "cli-example", "Name": "ExampleKey", "EncodedKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxPMbCA2Ks0lnd7IR+3pw\nwd3H/7jPGwj8bLUmore7bX+oeGpZ6QmLAe/1UOWcmZX2u70dYcSIzB1ofZtcn4cJ\nenHBAzO3ohBY/L1tQGJfS2A+omnN6H16VZE1JCK8XSJyfze7MDLcUyHZETdxuvRb\nA9X343/vMAuQPnhinFJ8Wdy8YBXSPpy7r95ylUQd9LfYTBzVZYG2tSesplcOkjM3\n2Uu+oMWxQAw1NINnSLPinMVsutJy6ZqlV3McWNWe4T+STGtWhrPNqJEn45sIcCx4\nq+kGZ2NQ0FyIyT2eiLKOX5Rgb/a36E/aMk4VoDsaenBQgG7WLTnstb9sr7MIhS6A\nrwIDAQAB\n-----END PUBLIC KEY-----\n", "Comment": "example public key" } } } ``` + Para ver detalhes da API, consulte [GetPublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-public-key.html) na *Referência de comandos da AWS CLI*. ### `list-cloud-front-origin-access-identities` O código de exemplo a seguir mostra como usar `list-cloud-front-origin-access-identities`. **AWS CLI** **Para listar as identidades do acesso de origem do CloudFront** O exemplo a seguir obtém uma lista das identidades do acesso de origem (OAIs) do CloudFront na sua conta da AWS: ``` aws cloudfront list-cloud-front-origin-access-identities ``` Resultado: ``` { "CloudFrontOriginAccessIdentityList": { "Items": [ { "Id": "E74FTE3AEXAMPLE", "S3CanonicalUserId": "cd13868f797c227fbea2830611a26fe0a21ba1b826ab4bed9b7771c9aEXAMPLE", "Comment": "Example OAI" }, { "Id": "EH1HDMBEXAMPLE", "S3CanonicalUserId": "1489f6f2e6faacaae7ff64c4c3e6956c24f78788abfc1718c3527c263bf7a17EXAMPLE", "Comment": "Test OAI" }, { "Id": "E2X2C9TEXAMPLE", "S3CanonicalUserId": "cbfeebb915a64749f9be546a45b3fcfd3a31c779673c13c4dd460911ae402c2EXAMPLE", "Comment": "Example OAI #2" } ] } } ``` + Consulte detalhes da API em [ListCloudFrontOriginAccessIdentities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-cloud-front-origin-access-identities.html) na *Referência de comandos da AWS CLI*. ### `list-connection-groups` O código de exemplo a seguir mostra como usar `list-connection-groups`. **AWS CLI** **Como listar grupos de conexões** O exemplo `list-connection-groups` a seguir lista os grupos de conexões disponíveis na sua conta da AWS. ``` aws cloudfront list-connection-groups ``` Resultado: ``` { "ConnectionGroups": [ { "Id": "cg_2whCJoXMYCjHcxaLGrkllvyABC", "Name": "CreatedByCloudFront-cg_2whCJoXMYCjHcxaLGrkllvyABC", "Arn": "arn:aws:cloudfront::123456789012:connection-group/cg_2whCJoXMYCjHcxaLGrkllvyABC", "RoutingEndpoint": "d3sx0pso7m5abc.cloudfront.net", "CreatedTime": "2025-05-05T22:32:29.630000+00:00", "LastModifiedTime": "2025-05-05T22:32:29.630000+00:00", "ETag": "E23ZP02F085ABC", "Enabled": true, "Status": "Deployed", "IsDefault": true }, { "Id": "cg_2wjDWTBKTlRB87cAaUQFaakABC", "Name": "connection-group-2", "Arn": "arn:aws:cloudfront::123456789012:connection-group/cg_2wjDWTBKTlRB87cAaUQFaakABC", "RoutingEndpoint": "dvdg9gprgabc.cloudfront.net", "CreatedTime": "2025-05-06T15:42:00.790000+00:00", "LastModifiedTime": "2025-05-06T15:42:00.790000+00:00", "ETag": "E23ZP02F085ABC", "Enabled": true, "Status": "Deployed", "IsDefault": false } ] } ``` Para ter mais informações, consulte [Criar grupo de conexões personalizado (opcional)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-connection-group.html) no *Guia do desenvolvedor do Amazon CloudFront*. + Para ver detalhes da API, consulte [ListConnectionGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-connection-groups.html) na *Referência de comandos da AWS CLI*. ### `list-distribution-tenants-by-customization` O código de exemplo a seguir mostra como usar `list-distribution-tenants-by-customization`. **AWS CLI** **Como listar locatários de distribuição por personalização** O exemplo `list-distribution-tenants-by-customization` a seguir lista os locatários de distribuição que usam a ACL da web especificada. ``` aws cloudfront list-distribution-tenants-by-customization \ --web-acl-arn arn:aws:wafv2:us-east-1:123456789012:global/webacl/CreatedByCloudFront-0273cd2f/a3c19bce-42b5-48a1-a8d4-b2bb2f28eabc ``` Resultado: ``` { "DistributionTenantList": [ { "Id": "dt_2wjDZi3hD1ivOXf6rpZJOSNE1AB", "DistributionId": "E1XNX8R2GOAABC", "Name": "example-tenant-2", "Arn": "arn:aws:cloudfront::123456789012:distribution-tenant/dt_2wjDZi3hD1ivOXf6rpZJOSNE1AB", "Domains": [ { "Domain": "example.com", "Status": "inactive" } ], "ConnectionGroupId": "cg_2wjDWTBKTlRB87cAaUQFaakABC", "Customizations": { "WebAcl": { "Action": "override", "Arn": "arn:aws:wafv2:us-east-1:123456789012:global/webacl/CreatedByCloudFront-0273cd2f/a3c19bce-42b5-48a1-a8d4-b2bb2f28eabc" }, "GeoRestrictions": { "RestrictionType": "whitelist", "Locations": [ "AL" ] } }, "CreatedTime": "2025-05-06T15:42:28.542000+00:00", "LastModifiedTime": "2025-05-06T16:14:08.710000+00:00", "ETag": "E1F83G8C2ARABC", "Enabled": true, "Status": "Deployed" } ] } ``` Para ter mais informações, consulte [Personalizações de locatários da distribuição](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/tenant-customization.html) no *Guia do desenvolvedor do Amazon CloudFront*. + Para ver detalhes da API, consulte [ListDistributionTenantsByCustomization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-distribution-tenants-by-customization.html) na *Referência de comandos da AWS CLI*. ### `list-distribution-tenants` O código de exemplo a seguir mostra como usar `list-distribution-tenants`. **AWS CLI** **Como listar locatários de distribuição do CloudFront** O exemplo `list-distribution-tenants` a seguir lista três locatários de distribuição do CloudFront em sua conta da AWS pelo grupo de conexões associado. ``` aws cloudfront list-distribution-tenants \ --association-filter ConnectionGroupId=cg_2whCJoXMYCjHcxaLGrkllvyABC \ --max-items 3 ``` Resultado: ``` { "DistributionTenantList": [ { "Id": "dt_2yMvQgam3QkJo2z54FDl91dk1AB", "DistributionId": "E1XNX8R2GOAABC", "Name": "new-tenant-customizations", "Arn": "arn:aws:cloudfront::123456789012:distribution-tenant/dt_2yMvQgam3QkJo2z54FDl91dk1AB", "Domains": [ { "Domain": "example.com", "Status": "active" } ], "ConnectionGroupId": "cg_2whCJoXMYCjHcxaLGrkllvyABC", "Customizations": { "WebAcl": { "Action": "disable" }, "GeoRestrictions": { "RestrictionType": "whitelist", "Locations": [ "DE" ] } }, "CreatedTime": "2025-06-11T15:54:02.142000+00:00", "LastModifiedTime": "2025-06-11T15:54:02.142000+00:00", "ETag": "E23ZP02F085ABC", "Enabled": false, "Status": "Deployed" }, { "Id": "dt_2yMuV7NJuBcAB0cwwxMCBZQ1AB", "DistributionId": "E1XNX8R2GOAABC", "Name": "new-tenant", "Arn": "arn:aws:cloudfront::123456789012:distribution-tenant/dt_2yMuV7NJuBcAB0cwwxMCBZQ1AB", "Domains": [ { "Domain": "1.example.com", "Status": "active" } ], "ConnectionGroupId": "cg_2whCJoXMYCjHcxaLGrkllvyABC", "Customizations": { "GeoRestrictions": { "RestrictionType": "whitelist", "Locations": [ "DE" ] } }, "CreatedTime": "2025-06-11T15:46:23.466000+00:00", "LastModifiedTime": "2025-06-11T15:46:23.466000+00:00", "ETag": "E23ZP02F085ABC", "Enabled": false, "Status": "Deployed" }, { "Id": "dt_2xVInRKCfUzQHgxosDs9hiLk1AB", "DistributionId": "E1XNX8R2GOAABC", "Name": "new-tenant-2", "Arn": "arn:aws:cloudfront::123456789012:distribution-tenant/dt_2xVInRKCfUzQHgxosDs9hiLk1AB", "Domains": [ { "Domain": "2.example.com", "Status": "active" } ], "ConnectionGroupId": "cg_2whCJoXMYCjHcxaLGrkllvyABC", "CreatedTime": "2025-05-23T16:16:20.871000+00:00", "LastModifiedTime": "2025-05-23T16:16:20.871000+00:00", "ETag": "E23ZP02F085ABC", "Enabled": false, "Status": "Deployed" } ], "NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAzfQ==" } ``` Para obter mais informações, consulte [Understand how multi-tenant distributions work](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html) no *Amazon CloudFront Developer Guide*. + Para ver detalhes da API, consulte [ListDistributionTenants](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-distribution-tenants.html) na *Referência de comandos da AWS CLI*. ### `list-distributions-by-connection-mode` O código de exemplo a seguir mostra como usar `list-distributions-by-connection-mode`. **AWS CLI** **Como distribuições do CloudFront por modo de conexão** O exemplo `list-distributions-by-connection-mode` a seguir lista distribuições do CloudFront com o modo de conexão especificado. ``` aws cloudfront list-distributions-by-connection-mode \ --connection-mode tenant-only ``` Resultado: ``` { "DistributionList": { "Items": [ { "Id": "E1XNX8R2GOAABC", "ARN": "arn:aws:cloudfront::123456789012:distribution/E1XNX8R2GOAABC", "ETag": "EPT4JPJQDY1ABC", "Status": "Deployed", "LastModifiedTime": "2025-05-23T16:16:15.691000+00:00", "DomainName": "-", "Aliases": { "Quantity": 0 }, "Origins": { "Quantity": 1, "Items": [ { "Id": "example-cfn-simple-distribution123", "DomainName": "example.com", "OriginPath": "", "CustomHeaders": { "Quantity": 0 }, "S3OriginConfig": { "OriginAccessIdentity": "" }, "ConnectionAttempts": 3, "ConnectionTimeout": 10, "OriginShield": { "Enabled": false }, "OriginAccessControlId": "E2CJRMB5LKEABC" } ] }, "OriginGroups": { "Quantity": 0 }, "DefaultCacheBehavior": { "TargetOriginId": "example-cfn-simple-distribution123", "TrustedKeyGroups": { "Enabled": false, "Quantity": 0 }, "ViewerProtocolPolicy": "allow-all", "AllowedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ], "CachedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ] } }, "Compress": true, "LambdaFunctionAssociations": { "Quantity": 0 }, "FunctionAssociations": { "Quantity": 0 }, "FieldLevelEncryptionId": "", "CachePolicyId": "658327ea-f89d-4fab-a63d-7e88639e5abc", "GrpcConfig": { "Enabled": false } }, "CacheBehaviors": { "Quantity": 0 }, "CustomErrorResponses": { "Quantity": 0 }, "Comment": "", "PriceClass": "PriceClass_All", "Enabled": true, "ViewerCertificate": { "CloudFrontDefaultCertificate": false, "ACMCertificateArn": "arn:aws:acm:us-east-1:123456789012:certificate/ec53f564-ea5a-4e4a-a0a2-e3c989449abc", "SSLSupportMethod": "sni-only", "MinimumProtocolVersion": "TLSv1.2_2021", "Certificate": "arn:aws:acm:us-east-1:123456789012:certificate/ec53f564-ea5a-4e4a-a0a2-e3c989449abc", "CertificateSource": "acm" }, "Restrictions": { "GeoRestriction": { "RestrictionType": "none", "Quantity": 0 } }, "WebACLId": "arn:aws:wafv2:us-east-1:123456789012:global/webacl/web-global-example/626900da-5f64-418b-ba9b-743f3746cabc", "HttpVersion": "http2", "IsIPV6Enabled": false, "Staging": false, "ConnectionMode": "tenant-only" } ] } } ``` Para ter mais informações, consulte [Criar grupo de conexões personalizado (opcional)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-connection-group.html) no *Guia do desenvolvedor do Amazon CloudFront*. + Para ver detalhes da API, consulte [ListDistributionsByConnectionMode](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-distributions-by-connection-mode.html) na *Referência de comandos da AWS CLI*. ### `list-distributions` O código de exemplo a seguir mostra como usar `list-distributions`. **AWS CLI** **Para listar as distribuições do CloudFront** O exemplo a seguir obtém uma lista de distribuições do CloudFront em sua conta da AWS. ``` aws cloudfront list-distributions ``` Resultado: ``` { "DistributionList": { "Items": [ { "Id": "E23YS8OEXAMPLE", "ARN": "arn:aws:cloudfront::123456789012:distribution/E23YS8OEXAMPLE", "Status": "Deployed", "LastModifiedTime": "2024-08-05T18:23:40.375000+00:00", "DomainName": "abcdefgh12ijk.cloudfront.net", "Aliases": { "Quantity": 0 }, "Origins": { "Quantity": 1, "Items": [ { "Id": "amzn-s3-demo-bucket.s3.us-east-1.amazonaws.com", "DomainName": "amzn-s3-demo-bucket.s3.us-east-1.amazonaws.com", "OriginPath": "", "CustomHeaders": { "Quantity": 0 }, "S3OriginConfig": { "OriginAccessIdentity": "" }, "ConnectionAttempts": 3, "ConnectionTimeout": 10, "OriginShield": { "Enabled": false }, "OriginAccessControlId": "EIAP8PEXAMPLE" } ] }, "OriginGroups": { "Quantity": 0 }, "DefaultCacheBehavior": { "TargetOriginId": "amzn-s3-demo-bucket.s3.us-east-1.amazonaws.com", "TrustedSigners": { "Enabled": false, "Quantity": 0 }, "TrustedKeyGroups": { "Enabled": false, "Quantity": 0 }, "ViewerProtocolPolicy": "allow-all", "AllowedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ], "CachedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ] } }, "SmoothStreaming": false, "Compress": true, "LambdaFunctionAssociations": { "Quantity": 0 }, "FunctionAssociations": { "Quantity": 0 }, "FieldLevelEncryptionId": "", "CachePolicyId": "658327ea-f89d-4fab-a63d-7e886EXAMPLE" }, "CacheBehaviors": { "Quantity": 0 }, "CustomErrorResponses": { "Quantity": 0 }, "Comment": "", "PriceClass": "PriceClass_All", "Enabled": true, "ViewerCertificate": { "CloudFrontDefaultCertificate": true, "SSLSupportMethod": "vip", "MinimumProtocolVersion": "TLSv1", "CertificateSource": "cloudfront" }, "Restrictions": { "GeoRestriction": { "RestrictionType": "none", "Quantity": 0 } }, "WebACLId": "", "HttpVersion": "HTTP2", "IsIPV6Enabled": true, "Staging": false } ] } } ``` + Consulte detalhes da API em [ListDistributions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-distributions.html) na *Referência de comandos da AWS CLI*. ### `list-domain-conflicts` O código de exemplo a seguir mostra como usar `list-domain-conflicts`. **AWS CLI** **Como listar conflitos de domínio para uma distribuição do CloudFront** O exemplo `list-domain-conflicts` a seguir lista conflitos de domínio para uma distribuição do CloudFront. ``` aws cloudfront list-domain-conflicts \ --domain example.com \ --domain-control-validation-resource "DistributionTenantId=dt_2x9GhoK0TZRsohWzv1b9It8J1AB" ``` Resultado: ``` { "DomainConflicts": [ { "Domain": "example.com", "ResourceType": "distribution-tenant", "ResourceId": "***************ohWzv1b9It8J1AB", "AccountId": "123456789012" } ] } ``` Para ter mais informações, consulte [Mover um nome de domínio alternativo para uma distribuição diferente](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/alternate-domain-names-move.html) no *Guia do desenvolvedor do Amazon CloudFront*. + Para ver detalhes da API, consulte [ListDomainConflicts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-domain-conflicts.html) na *Referência de comandos da AWS CLI*. ### `list-field-level-encryption-configs` O código de exemplo a seguir mostra como usar `list-field-level-encryption-configs`. **AWS CLI** **Para listar as configurações de criptografia no nível de campo do CloudFront** O exemplo a seguir obtém uma lista das configurações de criptografia no nível de campo do CloudFront na sua conta da AWS: ``` aws cloudfront list-field-level-encryption-configs ``` Resultado: ``` { "FieldLevelEncryptionList": { "MaxItems": 100, "Quantity": 1, "Items": [ { "Id": "C3KM2WVD605UAY", "LastModifiedTime": "2019-12-10T21:30:18.974Z", "Comment": "Example FLE configuration", "QueryArgProfileConfig": { "ForwardWhenQueryArgProfileIsUnknown": true, "QueryArgProfiles": { "Quantity": 0, "Items": [] } }, "ContentTypeProfileConfig": { "ForwardWhenContentTypeIsUnknown": true, "ContentTypeProfiles": { "Quantity": 1, "Items": [ { "Format": "URLEncoded", "ProfileId": "P280MFCLSYOCVU", "ContentType": "application/x-www-form-urlencoded" } ] } } } ] } } ``` + Para ver detalhes da API, consulte [ListFieldLevelEncryptionConfigs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-field-level-encryption-configs.html) na *Referência de comandos da AWS CLI*. ### `list-field-level-encryption-profiles` O código de exemplo a seguir mostra como usar `list-field-level-encryption-profiles`. **AWS CLI** **Para listar perfis de criptografia no nível de campo do CloudFront** O exemplo a seguir obtém uma lista dos perfis de criptografia no nível de campo do CloudFront na sua conta da AWS: ``` aws cloudfront list-field-level-encryption-profiles ``` Resultado: ``` { "FieldLevelEncryptionProfileList": { "MaxItems": 100, "Quantity": 2, "Items": [ { "Id": "P280MFCLSYOCVU", "LastModifiedTime": "2019-12-05T01:05:39.896Z", "Name": "ExampleFLEProfile", "EncryptionEntities": { "Quantity": 1, "Items": [ { "PublicKeyId": "K2K8NC4HVFE3M0", "ProviderId": "ExampleFLEProvider", "FieldPatterns": { "Quantity": 1, "Items": [ "ExampleSensitiveField" ] } } ] }, "Comment": "FLE profile for AWS CLI example" }, { "Id": "PPK0UOSIF5WSV", "LastModifiedTime": "2019-12-10T01:03:16.537Z", "Name": "ExampleFLEProfile2", "EncryptionEntities": { "Quantity": 1, "Items": [ { "PublicKeyId": "K2ABC10EXAMPLE", "ProviderId": "ExampleFLEProvider2", "FieldPatterns": { "Quantity": 1, "Items": [ "ExampleSensitiveField2" ] } } ] }, "Comment": "FLE profile #2 for AWS CLI example" } ] } } ``` + Para ver detalhes da API, consulte [ListFieldLevelEncryptionProfiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-field-level-encryption-profiles.html) na *Referência de comandos da AWS CLI*. ### `list-invalidations-for-distribution-tenant` O código de exemplo a seguir mostra como usar `list-invalidations-for-distribution-tenant`. **AWS CLI** **Como listar invalidações para um locatário de distribuição do CloudFront** O exemplo `list-invalidations-for-distribution-tenant` a seguir lista invalidações para um locatário de distribuição do CloudFront. ``` aws cloudfront list-invalidations-for-distribution-tenant \ --id dt_2wjDZi3hD1ivOXf6rpZJOSNE1AB ``` Resultado: ``` { "InvalidationList": { "Items": [ { "Id": "I4CU23QAPKMUDUU06F9OFGFABC", "CreateTime": "2025-05-06T15:46:12.824000+00:00", "Status": "Completed" } ] } } ``` Para ter mais informações, consulte [Invalidar arquivos para remover conteúdo](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html) no *Guia do desenvolvedor do Amazon CloudFront*. + Para ver detalhes da API, consulte [ListInvalidationsForDistributionTenant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-invalidations-for-distribution-tenant.html) na *Referência de comandos da AWS CLI*. ### `list-invalidations` O código de exemplo a seguir mostra como usar `list-invalidations`. **AWS CLI** **Para listar as invalidações do CloudFront** O exemplo a seguir obtém uma lista das invalidações da distribuição do CloudFront com o ID `EDFDVBD6EXAMPLE`: ``` aws cloudfront list-invalidations --distribution-id EDFDVBD6EXAMPLE ``` Resultado: ``` { "InvalidationList": { "Marker": "", "Items": [ { "Status": "Completed", "Id": "YNY2LI2BVJ4NJU", "CreateTime": "2019-08-31T21:15:52.042Z" } ], "IsTruncated": false, "MaxItems": 100, "Quantity": 1 } } ``` + Para ver detalhes da API, consulte [ListInvalidations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-invalidations.html) na *Referência de comandos da AWS CLI*. ### `list-public-keys` O código de exemplo a seguir mostra como usar `list-public-keys`. **AWS CLI** **Para listar as chaves públicas do CloudFront** O seguinte exemplo obtém uma lista das chaves públicas do CloudFront em sua conta da AWS: ``` aws cloudfront list-public-keys ``` Resultado: ``` { "PublicKeyList": { "MaxItems": 100, "Quantity": 2, "Items": [ { "Id": "K2K8NC4HVFE3M0", "Name": "ExampleKey", "CreatedTime": "2019-12-05T01:04:28.818Z", "EncodedKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxPMbCA2Ks0lnd7IR+3pw\nwd3H/7jPGwj8bLUmore7bX+oeGpZ6QmLAe/1UOWcmZX2u70dYcSIzB1ofZtcn4cJ\nenHBAzO3ohBY/L1tQGJfS2A+omnN6H16VZE1JCK8XSJyfze7MDLcUyHZETdxuvRb\nA9X343/vMAuQPnhinFJ8Wdy8YBXSPpy7r95ylUQd9LfYTBzVZYG2tSesplcOkjM3\n2Uu+oMWxQAw1NINnSLPinMVsutJy6ZqlV3McWNWe4T+STGtWhrPNqJEn45sIcCx4\nq+kGZ2NQ0FyIyT2eiLKOX5Rgb/a36E/aMk4VoDsaenBQgG7WLTnstb9sr7MIhS6A\nrwIDAQAB\n-----END PUBLIC KEY-----\n", "Comment": "example public key" }, { "Id": "K1S0LWQ2L5HTBU", "Name": "ExampleKey2", "CreatedTime": "2019-12-09T23:28:11.110Z", "EncodedKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApOCAg88A8+f4dujn9Izt\n26LxtgAkn2opGgo/NKpMiaisyw5qlg3f1gol7FV6pYNl78iJg3EO8JBbwtlH+cR9\nLGSf60NDeVhm76Oc39Np/vWgOdsGQcRbi9WmKZeSODqjQGzVZWqPmito3FzWVk6b\nfVY5N36U/RdbVAJm95Km+qaMYlbIdF40t72bi3IkKYV5hlB2XoDjlQ9F6ajQKyTB\nMHa3SN8q+3ZjQ4sJJ7D1V6r4wR8jDcFVD5NckWJmmgIVnkOQM37NYeoDnkaOuTpu\nha/+3b8tOb2z3LBVHPkp85zJRAOXacSwf5rZtPYKBNFsixTa2n55k2r218mOkMC4\nUwIDAQAB\n-----END PUBLIC KEY-----", "Comment": "example public key #2" } ] } } ``` + Para ver detalhes da API, consulte [ListPublicKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-public-keys.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar tags para uma distribuição do CloudFront** O seguinte exemplo obtém uma lista das tags de uma distribuição do CloudFront: ``` aws cloudfront list-tags-for-resource \ --resource arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE ``` Resultado: ``` { "Tags": { "Items": [ { "Key": "DateCreated", "Value": "2019-12-04" }, { "Key": "Name", "Value": "Example name" }, { "Key": "Project", "Value": "Example project" } ] } } ``` + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `sign` O código de exemplo a seguir mostra como usar `sign`. **AWS CLI** **Como assinar um URL do CloudFront** O exemplo a seguir assina um URL do CloudFront. Para assinar um URL, você precisa do ID do par de chaves (chamado de **ID da chave de acesso** no console de gerenciamento da AWS) e da chave privada do par de chaves do CloudFront do signatário confiável. Para obter mais informações sobre URLs assinados, consulte [Veicular conteúdo privado com URLs assinados e cookies assinados](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) no *Guia do desenvolvedor do Amazon CloudFront*. ``` aws cloudfront sign \ --url https://d111111abcdef8.cloudfront.net/private-content/private-file.html \ --key-pair-id APKAEIBAERJR2EXAMPLE \ --private-key file://cf-signer-priv-key.pem \ --date-less-than 2020-01-01 ``` Resultado: ``` https://d111111abcdef8.cloudfront.net/private-content/private-file.html?Expires=1577836800&Signature=nEXK7Kby47XKeZQKVc6pwkif6oZc-JWSpDkH0UH7EBGGqvgurkecCbgL5VfUAXyLQuJxFwRQWscz-owcq9KpmewCXrXQbPaJZNi9XSNwf4YKurPDQYaRQawKoeenH0GFteRf9ELK-Bs3nljTLjtbgzIUt7QJNKXcWr8AuUYikzGdJ4-qzx6WnxXfH~fxg4-GGl6l2kgCpXUB6Jx6K~Y3kpVOdzUPOIqFLHAnJojbhxqrVejomZZ2XrquDvNUCCIbePGnR3d24UPaLXG4FKOqNEaWDIBXu7jUUPwOyQCvpt-GNvjRJxqWf93uMobeMOiVYahb-e0KItiQewGcm0eLZQ__&Key-Pair-Id=APKAEIBAERJR2EXAMPLE ``` + Para ver detalhes da API, consulte [Sign](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/sign.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como marcar uma distribuição do CloudFront** O exemplo `tag-resource` a seguir adiciona duas tags à distribuição do CloudFront especificada. ``` aws cloudfront tag-resource \ --resource arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE \ --tags 'Items=[{Key=Name,Value="Example name"},{Key=Project,Value="Example project"}]' ``` Em vez de usar argumentos de linha de comando, forneça as tags em um arquivo JSON, conforme mostrado no seguinte exemplo: ``` aws cloudfront tag-resource \ --resource arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE \ --tags file://tags.json ``` Conteúdo de `tags.json`: ``` { "Items": [ { "Key": "Name", "Value": "Example name" }, { "Key": "Project", "Value": "Example project" } ] } ``` Este comando não produz saída. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover tags de uma distribuição do CloudFront** O exemplo a seguir remove duas tags de uma distribuição do CloudFront usando argumentos de linha de comando: ``` aws cloudfront untag-resource \ --resource arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE \ --tag-keys Items=Name,Project ``` Em vez de usar argumentos de linha de comando, forneça as chaves de tag em um arquivo JSON, conforme mostrado no seguinte exemplo: ``` aws cloudfront untag-resource \ --resource arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE \ --tag-keys file://tag-keys.json ``` O arquivo `tag-keys.json` é um documento JSON na pasta atual que contém o seguinte: ``` { "Items": [ "Name", "Project" ] } ``` Quando bem-sucedido, este comando não tem saída. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-cloud-front-origin-access-identity` O código de exemplo a seguir mostra como usar `update-cloud-front-origin-access-identity`. **AWS CLI** **Para atualizar uma identidade do acesso de origem do CloudFront** O exemplo a seguir atualiza a identidade do acesso de origem (OAI) com o ID `E74FTE3AEXAMPLE`. O único campo que você pode atualizar é `Comment` da OAI. Para atualizar uma OAI, você deve ter o ID da OAI e a `ETag`. O ID da OAI é retornado na saída dos comandos create-cloud-front-origin-access-identity e list-cloud-front-origin-access-identities. Para obter a `ETag`, use o comando get-cloud-front-origin-access-identity ou get-cloud-front-origin-access-identity-config. Use a opção `--if-match` para fornecer a `ETag` da OAI. ``` aws cloudfront update-cloud-front-origin-access-identity \ --id E74FTE3AEXAMPLE \ --if-match E2QWRUHEXAMPLE \ --cloud-front-origin-access-identity-config \ CallerReference=cli-example,Comment="Example OAI Updated" ``` Você pode fazer o mesmo fornecendo a configuração da OAI em um arquivo JSON, conforme mostrado no exemplo a seguir: ``` aws cloudfront update-cloud-front-origin-access-identity \ --id E74FTE3AEXAMPLE \ --if-match E2QWRUHEXAMPLE \ --cloud-front-origin-access-identity-config file://OAI-config.json ``` O arquivo `OAI-config.json` é um documento JSON no diretório atual que contém o seguinte: ``` { "CallerReference": "cli-example", "Comment": "Example OAI Updated" } ``` Se você fornecer a configuração da OAI com um argumento da linha de comando ou um arquivo JSON, a saída será a mesma: ``` { "ETag": "E9LHASXEXAMPLE", "CloudFrontOriginAccessIdentity": { "Id": "E74FTE3AEXAMPLE", "S3CanonicalUserId": "cd13868f797c227fbea2830611a26fe0a21ba1b826ab4bed9b7771c9aEXAMPLE", "CloudFrontOriginAccessIdentityConfig": { "CallerReference": "cli-example", "Comment": "Example OAI Updated" } } } ``` + Para ver detalhes da API, consulte [UpdateCloudFrontOriginAccessIdentity](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/update-cloud-front-origin-access-identity.html) na *Referência de comandos da AWS CLI*. ### `update-connection-group` O código de exemplo a seguir mostra como usar `update-connection-group`. **AWS CLI** **Como atualizar um grupo de conexões do CloudFront** O exemplo `update-connection-group` a seguir desabilita um grupo de conexões do CloudFront e o IPv6. ``` aws cloudfront update-connection-group \ --id cg_2yHsDkcPKeUlVkk3aEgLKcjABC \ --no-ipv6-enabled \ --no-enabled \ --if-match E3UN6WX5RRO2ABC ``` Resultado: ``` { "ETag": "E1F83G8C2ARABC", "ConnectionGroup": { "Id": "cg_2yHsDkcPKeUlVkk3aEgLKcjABC", "Name": "cg-example", "Arn": "arn:aws:cloudfront::123456789012:connection-group/cg_2yHsDkcPKeUlVkk3aEgLKcjABC", "CreatedTime": "2025-06-09T20:58:35.481000+00:00", "LastModifiedTime": "2025-06-11T16:25:54.280000+00:00", "Ipv6Enabled": false, "RoutingEndpoint": "du9xp1elo1abc.cloudfront.net", "Status": "InProgress", "Enabled": false, "IsDefault": false } } ``` Para ter mais informações, consulte [Criar grupo de conexões personalizado (opcional)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-connection-group.html) no *Guia do desenvolvedor do Amazon CloudFront*. + Para ver detalhes da API, consulte [UpdateConnectionGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/update-connection-group.html) na *Referência de comandos da AWS CLI*. ### `update-distribution-tenant` O código de exemplo a seguir mostra como usar `update-distribution-tenant`. **AWS CLI** **Como atualizar um locatário de distribuição do CloudFront** O exemplo `update-distribution-tenant` a seguir atualiza um locatário de distribuição do CloudFront com um novo valor de parâmetro e adiciona um país às restrições geográficas. ``` aws cloudfront update-distribution-tenant \ --cli-input-json file://update-tenant.json ``` Conteúdo de `update-tenant.json`: ``` { "Id": "dt_2yMvQgam3QkJo2z54FDl91dk1AB", "IfMatch": "E1F83G8C2ARABC", "Parameters": [ { "Name": "testParam", "Value": "newParameterValue" } ], "Customizations": { "WebAcl": { "Action": "disable" }, "GeoRestrictions": { "RestrictionType": "whitelist", "Locations": [ "DE", "GB", "ES" ] } } } ``` Resultado: ``` { "ETag": "E1PA6795UKMABC", "DistributionTenant": { "Id": "dt_2yMvQgam3QkJo2z54FDl91dk1AB", "DistributionId": "E1XNX8R2GOAABC", "Name": "new-tenant-customizations", "Arn": "arn:aws:cloudfront::123456789012:distribution-tenant/dt_2yMvQgam3QkJo2z54FDl91dk1AB", "Domains": [ { "Domain": "example.com", "Status": "active" } ], "Customizations": { "WebAcl": { "Action": "disable" }, "GeoRestrictions": { "RestrictionType": "whitelist", "Locations": [ "DE", "ES", "GB" ] } }, "Parameters": [ { "Name": "testParam", "Value": "newParameterValue" } ], "ConnectionGroupId": "cg_2whCJoXMYCjHcxaLGrkllvyABC", "CreatedTime": "2025-06-11T15:54:02.142000+00:00", "LastModifiedTime": "2025-06-11T16:42:45.531000+00:00", "Enabled": false, "Status": "InProgress" } } ``` Para ter mais informações, consulte [Personalizações de locatários da distribuição](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/tenant-customization.html) no *Guia do desenvolvedor do Amazon CloudFront*. + Para ver detalhes da API, consulte [UpdateDistributionTenant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/update-distribution-tenant.html) na *Referência de comandos da AWS CLI*. ### `update-distribution` O código de exemplo a seguir mostra como usar `update-distribution`. **AWS CLI** **Exemplo 1: como atualizar o objeto raiz padrão de uma distribuição do CloudFront** O exemplo a seguir atualiza o objeto raiz padrão para `index.html` para a distribuição do CloudFront com o ID `EDFDVBD6EXAMPLE`. ``` aws cloudfront update-distribution \ --id EDFDVBD6EXAMPLE \ --default-root-object index.html ``` Resultado: ``` { "ETag": "E2QWRUHEXAMPLE", "Distribution": { "Id": "EDFDVBD6EXAMPLE", "ARN": "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", "Status": "InProgress", "LastModifiedTime": "2019-12-06T18:55:39.870Z", "InProgressInvalidationBatches": 0, "DomainName": "d111111abcdef8.cloudfront.net", "ActiveTrustedSigners": { "Enabled": false, "Quantity": 0 }, "DistributionConfig": { "CallerReference": "6b10378d-49be-4c4b-a642-419ccaf8f3b5", "Aliases": { "Quantity": 0 }, "DefaultRootObject": "index.html", "Origins": { "Quantity": 1, "Items": [ { "Id": "example-website", "DomainName": "www.example.com", "OriginPath": "", "CustomHeaders": { "Quantity": 0 }, "CustomOriginConfig": { "HTTPPort": 80, "HTTPSPort": 443, "OriginProtocolPolicy": "match-viewer", "OriginSslProtocols": { "Quantity": 2, "Items": [ "SSLv3", "TLSv1" ] }, "OriginReadTimeout": 30, "OriginKeepaliveTimeout": 5 } } ] }, "OriginGroups": { "Quantity": 0 }, "DefaultCacheBehavior": { "TargetOriginId": "example-website", "ForwardedValues": { "QueryString": false, "Cookies": { "Forward": "none" }, "Headers": { "Quantity": 1, "Items": [ "*" ] }, "QueryStringCacheKeys": { "Quantity": 0 } }, "TrustedSigners": { "Enabled": false, "Quantity": 0 }, "ViewerProtocolPolicy": "allow-all", "MinTTL": 0, "AllowedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ], "CachedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ] } }, "SmoothStreaming": false, "DefaultTTL": 86400, "MaxTTL": 31536000, "Compress": false, "LambdaFunctionAssociations": { "Quantity": 0 }, "FieldLevelEncryptionId": "" }, "CacheBehaviors": { "Quantity": 0 }, "CustomErrorResponses": { "Quantity": 0 }, "Comment": "", "Logging": { "Enabled": false, "IncludeCookies": false, "Bucket": "", "Prefix": "" }, "PriceClass": "PriceClass_All", "Enabled": true, "ViewerCertificate": { "CloudFrontDefaultCertificate": true, "MinimumProtocolVersion": "TLSv1", "CertificateSource": "cloudfront" }, "Restrictions": { "GeoRestriction": { "RestrictionType": "none", "Quantity": 0 } }, "WebACLId": "", "HttpVersion": "http1.1", "IsIPV6Enabled": true } } } ``` **Exemplo 2: como atualizar uma distribuição do CloudFront** O exemplo a seguir desabilita a distribuição do CloudFront com o ID `EMLARXS9EXAMPLE` fornecendo a configuração de distribuição em um arquivo JSON chamado `dist-config-disable.json`. Para atualizar uma distribuição, use a opção `--if-match` para fornecer o `ETag` da distribuição. Use o comando get-distribution ou get-distribution-config para obter o `ETag`. Observe que o campo `Enabled` está definido como `false` no arquivo JSON. Depois de usar o exemplo a seguir para desabilitar uma distribuição, use o comando delete-distribution para exclui-la. ``` aws cloudfront update-distribution \ --id EMLARXS9EXAMPLE \ --if-match E2QWRUHEXAMPLE \ --distribution-config file://dist-config-disable.json ``` Conteúdo de `dist-config-disable.json`: ``` { "CallerReference": "cli-1574382155-496510", "Aliases": { "Quantity": 0 }, "DefaultRootObject": "index.html", "Origins": { "Quantity": 1, "Items": [ { "Id": "amzn-s3-demo-bucket---s3.amazonaws.com.rproxy.goskope.com-1574382155-273939", "DomainName": "amzn-s3-demo-bucket.s3.amazonaws.com", "OriginPath": "", "CustomHeaders": { "Quantity": 0 }, "S3OriginConfig": { "OriginAccessIdentity": "" } } ] }, "OriginGroups": { "Quantity": 0 }, "DefaultCacheBehavior": { "TargetOriginId": "amzn-s3-demo-bucket---s3.amazonaws.com.rproxy.goskope.com-1574382155-273939", "ForwardedValues": { "QueryString": false, "Cookies": { "Forward": "none" }, "Headers": { "Quantity": 0 }, "QueryStringCacheKeys": { "Quantity": 0 } }, "TrustedSigners": { "Enabled": false, "Quantity": 0 }, "ViewerProtocolPolicy": "allow-all", "MinTTL": 0, "AllowedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ], "CachedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ] } }, "SmoothStreaming": false, "DefaultTTL": 86400, "MaxTTL": 31536000, "Compress": false, "LambdaFunctionAssociations": { "Quantity": 0 }, "FieldLevelEncryptionId": "" }, "CacheBehaviors": { "Quantity": 0 }, "CustomErrorResponses": { "Quantity": 0 }, "Comment": "", "Logging": { "Enabled": false, "IncludeCookies": false, "Bucket": "", "Prefix": "" }, "PriceClass": "PriceClass_All", "Enabled": false, "ViewerCertificate": { "CloudFrontDefaultCertificate": true, "MinimumProtocolVersion": "TLSv1", "CertificateSource": "cloudfront" }, "Restrictions": { "GeoRestriction": { "RestrictionType": "none", "Quantity": 0 } }, "WebACLId": "", "HttpVersion": "http2", "IsIPV6Enabled": true } ``` Resultado: ``` { "ETag": "E9LHASXEXAMPLE", "Distribution": { "Id": "EMLARXS9EXAMPLE", "ARN": "arn:aws:cloudfront::123456789012:distribution/EMLARXS9EXAMPLE", "Status": "InProgress", "LastModifiedTime": "2019-12-06T18:32:35.553Z", "InProgressInvalidationBatches": 0, "DomainName": "d111111abcdef8.cloudfront.net", "ActiveTrustedSigners": { "Enabled": false, "Quantity": 0 }, "DistributionConfig": { "CallerReference": "cli-1574382155-496510", "Aliases": { "Quantity": 0 }, "DefaultRootObject": "index.html", "Origins": { "Quantity": 1, "Items": [ { "Id": "amzn-s3-demo-bucket---s3.amazonaws.com.rproxy.goskope.com-1574382155-273939", "DomainName": "amzn-s3-demo-bucket.s3.amazonaws.com", "OriginPath": "", "CustomHeaders": { "Quantity": 0 }, "S3OriginConfig": { "OriginAccessIdentity": "" } } ] }, "OriginGroups": { "Quantity": 0 }, "DefaultCacheBehavior": { "TargetOriginId": "amzn-s3-demo-bucket---s3.amazonaws.com.rproxy.goskope.com-1574382155-273939", "ForwardedValues": { "QueryString": false, "Cookies": { "Forward": "none" }, "Headers": { "Quantity": 0 }, "QueryStringCacheKeys": { "Quantity": 0 } }, "TrustedSigners": { "Enabled": false, "Quantity": 0 }, "ViewerProtocolPolicy": "allow-all", "MinTTL": 0, "AllowedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ], "CachedMethods": { "Quantity": 2, "Items": [ "HEAD", "GET" ] } }, "SmoothStreaming": false, "DefaultTTL": 86400, "MaxTTL": 31536000, "Compress": false, "LambdaFunctionAssociations": { "Quantity": 0 }, "FieldLevelEncryptionId": "" }, "CacheBehaviors": { "Quantity": 0 }, "CustomErrorResponses": { "Quantity": 0 }, "Comment": "", "Logging": { "Enabled": false, "IncludeCookies": false, "Bucket": "", "Prefix": "" }, "PriceClass": "PriceClass_All", "Enabled": false, "ViewerCertificate": { "CloudFrontDefaultCertificate": true, "MinimumProtocolVersion": "TLSv1", "CertificateSource": "cloudfront" }, "Restrictions": { "GeoRestriction": { "RestrictionType": "none", "Quantity": 0 } }, "WebACLId": "", "HttpVersion": "http2", "IsIPV6Enabled": true } } } ``` + Consulte detalhes da API em [UpdateDistribution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/update-distribution.html) na *Referência de comandos da AWS CLI*. ### `update-domain-association` O código de exemplo a seguir mostra como usar `update-domain-association`. **AWS CLI** **Como atualizar uma associação de domínio** O exemplo `update-domain-association` a seguir atualiza uma associação de domínio para um locatário de distribuição com a ETag `E23ZP02F085ABC`. ``` aws cloudfront update-domain-association \ --domain example.com \ --target-resource DistributionTenantId=dt_2x9GhoK0TZRsohWzv1b9It8J1AB \ --if-match E23ZP02F085ABC ``` Resultado: ``` { "ETag": "ETVPDKIKX0ABC", "Domain": "example.com", "ResourceId": "dt_2x9GhoK0TZRsohWzv1b9It8J1AB" } ``` Para ter mais informações, consulte [Mover um nome de domínio alternativo para uma distribuição diferente](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/alternate-domain-names-move.html) no *Guia do desenvolvedor do Amazon CloudFront*. + Para ver detalhes da API, consulte [UpdateDomainAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/update-domain-association.html) na *Referência de comandos da AWS CLI*. ### `update-field-level-encryption-config` O código de exemplo a seguir mostra como usar `update-field-level-encryption-config`. **AWS CLI** **Para atualizar uma configuração de criptografia no nível de campo do CloudFront** O exemplo a seguir atualiza o campo `Comment` da configuração de criptografia no nível de campo com o ID `C3KM2WVD605UAY` fornecendo os parâmetros em um arquivo JSON. Para atualizar uma configuração de criptografia no nível de campo, você deve ter o ID da configuração e a `ETag`. O ID é retornado na saída dos comandos create-field-level-encryption-config e list-field-level-encryption-configs. Para obter a `ETag`, use o comando get-field-level-encryption ou get-field-level-encryption-config. Use a opção `--if-match` para fornecer a `ETag` das configurações. ``` aws cloudfront update-field-level-encryption-config \ --id C3KM2WVD605UAY \ --if-match E2P4Z4VU7TY5SG \ --field-level-encryption-config file://fle-config.json ``` O arquivo `fle-config.json` é um documento JSON no diretório atual que contém o seguinte: ``` { "CallerReference": "cli-example", "Comment": "Updated example FLE configuration", "QueryArgProfileConfig": { "ForwardWhenQueryArgProfileIsUnknown": true, "QueryArgProfiles": { "Quantity": 0 } }, "ContentTypeProfileConfig": { "ForwardWhenContentTypeIsUnknown": true, "ContentTypeProfiles": { "Quantity": 1, "Items": [ { "Format": "URLEncoded", "ProfileId": "P280MFCLSYOCVU", "ContentType": "application/x-www-form-urlencoded" } ] } } } ``` Resultado: ``` { "ETag": "E26M4BIAV81ZF6", "FieldLevelEncryption": { "Id": "C3KM2WVD605UAY", "LastModifiedTime": "2019-12-10T22:26:26.170Z", "FieldLevelEncryptionConfig": { "CallerReference": "cli-example", "Comment": "Updated example FLE configuration", "QueryArgProfileConfig": { "ForwardWhenQueryArgProfileIsUnknown": true, "QueryArgProfiles": { "Quantity": 0, "Items": [] } }, "ContentTypeProfileConfig": { "ForwardWhenContentTypeIsUnknown": true, "ContentTypeProfiles": { "Quantity": 1, "Items": [ { "Format": "URLEncoded", "ProfileId": "P280MFCLSYOCVU", "ContentType": "application/x-www-form-urlencoded" } ] } } } } } ``` + Para ver detalhes da API, consulte [UpdateFieldLevelEncryptionConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/update-field-level-encryption-config.html) na *Referência de comandos da AWS CLI*. ### `update-field-level-encryption-profile` O código de exemplo a seguir mostra como usar `update-field-level-encryption-profile`. **AWS CLI** **Para atualizar um perfil de criptografia no nível de campo do CloudFront** O exemplo a seguir atualiza o perfil de criptografia no nível de campo com o ID `PPK0UOSIF5WSV`. Este exemplo atualiza o `Name` e o `Comment` do perfil e adiciona um segundo item `FieldPatterns`, fornecendo os parâmetros em um arquivo JSON. Para atualizar um perfil de criptografia no nível de campo, você deve ter o ID e a `ETag` do perfil. O ID é retornado na saída dos comandos create-field-level-encryption-profile e list-field-level-encryption-profiles. Para obter a `ETag`, use o comando get-field-level-encryption-profile ou get-field-level-encryption-profile-config. Use a opção `--if-match` para fornecer a `ETag` do perfil. ``` aws cloudfront update-field-level-encryption-profile \ --id PPK0UOSIF5WSV \ --if-match E1QQG65FS2L2GC \ --field-level-encryption-profile-config file://fle-profile-config.json ``` O arquivo `fle-profile-config.json` é um documento JSON no diretório atual que contém o seguinte: ``` { "Name": "ExampleFLEProfileUpdated", "CallerReference": "cli-example", "Comment": "Updated FLE profile for AWS CLI example", "EncryptionEntities": { "Quantity": 1, "Items": [ { "PublicKeyId": "K2K8NC4HVFE3M0", "ProviderId": "ExampleFLEProvider", "FieldPatterns": { "Quantity": 2, "Items": [ "ExampleSensitiveField", "SecondExampleSensitiveField" ] } } ] } } ``` Resultado: ``` { "ETag": "EJETYFJ9CL66D", "FieldLevelEncryptionProfile": { "Id": "PPK0UOSIF5WSV", "LastModifiedTime": "2019-12-10T19:05:58.296Z", "FieldLevelEncryptionProfileConfig": { "Name": "ExampleFLEProfileUpdated", "CallerReference": "cli-example", "Comment": "Updated FLE profile for AWS CLI example", "EncryptionEntities": { "Quantity": 1, "Items": [ { "PublicKeyId": "K2K8NC4HVFE3M0", "ProviderId": "ExampleFLEProvider", "FieldPatterns": { "Quantity": 2, "Items": [ "ExampleSensitiveField", "SecondExampleSensitiveField" ] } } ] } } } } ``` + Para ver detalhes da API, consulte [UpdateFieldLevelEncryptionProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/update-field-level-encryption-profile.html) na *Referência de comandos da AWS CLI*. ### `verify-dns-configuration` O código de exemplo a seguir mostra como usar `verify-dns-configuration`. **AWS CLI** **Como verificar a configuração de DNS de um domínio** O exemplo `verify-dns-configuration` a seguir verifica a configuração de DNS de um domínio. ``` aws cloudfront verify-dns-configuration \ --domain example.com \ --identifier dt_2x9GhoK0TZRsohWzv1b9It8J1AB ``` Resultado: ``` { "DnsConfigurationList": [ { "Domain": "example.com", "Status": "valid-configuration" } ] } ``` Para ter mais informações, consulte [Mover um nome de domínio alternativo para uma distribuição diferente](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/alternate-domain-names-move.html) no *Guia do desenvolvedor do Amazon CloudFront*. + Para ver detalhes da API, consulte [VerifyDnsConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/verify-dns-configuration.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon CloudSearch usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o Amazon CloudSearch. *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 ### `upload-documents` O código de exemplo a seguir mostra como usar `upload-documents`. **AWS CLI** O comando `upload-documents` a seguir carrega um lote de documentos JSON em um domínio do Amazon CloudSearch: ``` aws cloudsearchdomain upload-documents --endpoint-url https://doc-my-domain.us-west-1.cloudsearch.amazonaws.com --content-type application/json --documents document-batch.json ``` Resultado: ``` { "status": "success", "adds": 5000, "deletes": 0 } ``` + Consulte detalhes da API em [UploadDocuments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudsearchdomain/upload-documents.html) na *Referência de comandos da AWS CLI*. # Exemplos do CloudTrail usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o 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 ### `add-tags` O código de exemplo a seguir mostra como usar `add-tags`. **AWS CLI** **Para adicionar tags à trilha** O comando `add-tags` a seguir adiciona tags à `Trail1`: ``` aws cloudtrail add-tags --resource-id arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1 --tags-list Key=name,Value=Alice Key=location,Value=us ``` + Para ver detalhes da API, consulte [AddTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/add-tags.html) na *Referência de comandos da AWS CLI*. ### `create-subscription` O código de exemplo a seguir mostra como usar `create-subscription`. **AWS CLI** **Para criar e configurar recursos da AWS em uma trilha** O comando `create-subscription` a seguir cria um bucket do S3 e um tópico do SNS para `Trail1`. ``` aws cloudtrail create-subscription \ --name Trail1 \ --s3-new-bucket amzn-s3-demo-bucket \ --sns-new-topic my-topic ``` Resultado: ``` Setting up new S3 bucket amzn-s3-demo-bucket... Setting up new SNS topic my-topic... Creating/updating CloudTrail configuration... CloudTrail configuration: { "trailList": [ { "IncludeGlobalServiceEvents": true, "Name": "Trail1", "TrailARN": "arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1", "LogFileValidationEnabled": false, "IsMultiRegionTrail": false, "S3BucketName": "amzn-s3-demo-bucket", "SnsTopicName": "my-topic", "HomeRegion": "us-east-1" } ], "ResponseMetadata": { "HTTPStatusCode": 200, "RequestId": "f39e51f6-c615-11e5-85bd-d35ca21ee3e2" } } Starting CloudTrail service... Logs will be delivered to my-bucket ``` + Para ver detalhes da API, consulte [CreateSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/create-subscription.html) na *Referência de comandos da AWS CLI*. ### `create-trail` O código de exemplo a seguir mostra como usar `create-trail`. **AWS CLI** **Para criar uma trilha** O comando `create-trail` a seguir cria uma trilha multirregional chamada `Trail1` e especifica um bucket do S3. ``` aws cloudtrail create-trail \ --name Trail1 \ --s3-bucket-name amzn-s3-demo-bucket \ --is-multi-region-trail ``` Resultado: ``` { "IncludeGlobalServiceEvents": true, "Name": "Trail1", "TrailARN": "arn:aws:cloudtrail:us-west-2:123456789012:trail/Trail1", "LogFileValidationEnabled": false, "IsMultiRegionTrail": true, "S3BucketName": "amzn-s3-demo-bucket" } ``` + Para ver detalhes da API, consulte [CreateTrail](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/create-trail.html) na *Referência de comandos da AWS CLI*. ### `delete-trail` O código de exemplo a seguir mostra como usar `delete-trail`. **AWS CLI** **Como para excluir uma trilha** O comando `delete-trail` a seguir cria uma trilha chamada `Trail1`: ``` aws cloudtrail delete-trail --name Trail1 ``` + Para ver detalhes da API, consulte [DeleteTrail](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/delete-trail.html) na *Referência de comandos da AWS CLI*. ### `describe-trails` O código de exemplo a seguir mostra como usar `describe-trails`. **AWS CLI** **Para descrever uma trilha** O exemplo de `describe-trails` a seguir retorna as configurações de `Trail1` e `Trail2`. ``` aws cloudtrail describe-trails \ --trail-name-list Trail1 Trail2 ``` Resultado: ``` { "trailList": [ { "IncludeGlobalServiceEvents": true, "Name": "Trail1", "TrailARN": "arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1", "LogFileValidationEnabled": false, "IsMultiRegionTrail": false, "S3BucketName": "amzn-s3-demo-bucket", "CloudWatchLogsRoleArn": "arn:aws:iam::123456789012:role/CloudTrail_CloudWatchLogs_Role", "CloudWatchLogsLogGroupArn": "arn:aws:logs:us-east-1:123456789012:log-group:CloudTrail:*", "SnsTopicName": "my-topic", "HomeRegion": "us-east-1" }, { "IncludeGlobalServiceEvents": true, "Name": "Trail2", "S3KeyPrefix": "my-prefix", "TrailARN": "arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail2", "LogFileValidationEnabled": false, "IsMultiRegionTrail": false, "S3BucketName": "amzn-s3-demo-bucket2", "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c5ae5ac-3c13-421e-8335-c7868ef6a769", "HomeRegion": "us-east-1" } ] } ``` + Para ver detalhes da API, consulte [DescribeTrails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/describe-trails.html) na *Referência de comandos da AWS CLI*. ### `get-event-selectors` O código de exemplo a seguir mostra como usar `get-event-selectors`. **AWS CLI** **Como visualizar as configurações do seletor de eventos de uma trilha** O comando `get-event-selectors` a seguir retorna as configurações da `Trail1`: ``` aws cloudtrail get-event-selectors --trail-name Trail1 ``` Resultado: ``` { "EventSelectors": [ { "IncludeManagementEvents": true, "DataResources": [], "ReadWriteType": "All" } ], "TrailARN": "arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1" } ``` + Para ver detalhes da API, consulte [GetEventSelectors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/get-event-selectors.html) na *Referência de comandos da AWS CLI*. ### `get-trail-status` O código de exemplo a seguir mostra como usar `get-trail-status`. **AWS CLI** **Para obter o status de uma trilha** O comando `get-trail-status` a seguir retorna os detalhes de entrega e registro em log da `Trail1`: ``` aws cloudtrail get-trail-status --name Trail1 ``` Resultado: ``` { "LatestNotificationTime": 1454022144.869, "LatestNotificationAttemptSucceeded": "2016-01-28T23:02:24Z", "LatestDeliveryAttemptTime": "2016-01-28T23:02:24Z", "LatestDeliveryTime": 1454022144.869, "TimeLoggingStarted": "2015-11-06T18:36:38Z", "LatestDeliveryAttemptSucceeded": "2016-01-28T23:02:24Z", "IsLogging": true, "LatestCloudWatchLogsDeliveryTime": 1454022144.918, "StartLoggingTime": 1446834998.695, "StopLoggingTime": 1446834996.933, "LatestNotificationAttemptTime": "2016-01-28T23:02:24Z", "TimeLoggingStopped": "2015-11-06T18:36:36Z" } ``` + Para ver detalhes da API, consulte [GetTrailStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/get-trail-status.html) na *Referência de comandos da AWS CLI*. ### `list-public-keys` O código de exemplo a seguir mostra como usar `list-public-keys`. **AWS CLI** **Para listar todas as chaves públicas de uma trilha** O comando `list-public-keys` a seguir retorna todas as chaves públicas cujas chaves privadas foram usadas para assinar os arquivos de resumo dentro do período especificado: ``` aws cloudtrail list-public-keys --start-time 2016-01-01T20:30:00.000Z ``` Resultado: ``` { "PublicKeyList": [ { "ValidityStartTime": 1453076702.0, "ValidityEndTime": 1455668702.0, "Value": "MIIBCgKCAQEAlSS3cl92HDycr/MTj0moOhas8habjrraXw+KzlWF0axSI2tcF+3iJ9BKQAVSKxGwxwu3m0wG3J+kUl1xboEcEPHYoIYMbgfSw7KGnuDKwkLzsQWhUJ0cIbOHASox1vv/5fNXkrHhGbDCHeVXm804c83nvHUEFYThr1PfyP/8HwrCtR3FX5OANtQCP61C1nJtSSkC8JSQUOrIP4CuwJjc+4WGDk+BGH5m9iuiAKkipEHWmUl8/P7XpfpWQuk4h8g3pXZOrNXr08lbh4d39svj7UqdhvOXoBISp9t/EXYuePGEtBdrKD9Dz+VHwyUPtBQvYr9BnkF88qBnaPNhS44rzwIDAQAB", "Fingerprint": "7f3f401420072e50a65a141430817ab3" } ] } ``` + Para ver detalhes da API, consulte [ListPublicKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/list-public-keys.html) na *Referência de comandos da AWS CLI*. ### `list-tags` O código de exemplo a seguir mostra como usar `list-tags`. **AWS CLI** **Para listar as tags de uma trilha** O comando `list-tags` a seguir lista as tags de `Trail1` e `Trail2`: ``` aws cloudtrail list-tags --resource-id-list arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1 arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail2 ``` Resultado: ``` { "ResourceTagList": [ { "ResourceId": "arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1", "TagsList": [ { "Value": "Alice", "Key": "name" }, { "Value": "us", "Key": "location" } ] }, { "ResourceId": "arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail2", "TagsList": [ { "Value": "Bob", "Key": "name" } ] } ] } ``` + Consulte detalhes da API em [ListTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/list-tags.html) na *Referência de comandos da AWS CLI*. ### `lookup-events` O código de exemplo a seguir mostra como usar `lookup-events`. **AWS CLI** **Como pesquisar eventos em uma trilha** O comando `lookup-events` a seguir pesquisa eventos de atividade da API pelo atributo `EventName`: ``` aws cloudtrail lookup-events --lookup-attributes AttributeKey=EventName,AttributeValue=ConsoleLogin ``` Resultado: ``` { "Events": [ { "EventId": "654ccbc0-ba0d-486a-9076-dbf7274677a7", "Username": "my-session-name", "EventTime": "2021-11-18T09:41:02-08:00", "CloudTrailEvent": "{\"eventVersion\":\"1.02\",\"userIdentity\":{\"type\":\"AssumedRole\",\"principalId\":\"AROAJIKPFTA72SWU4L7T4:my-session-name\",\"arn\":\"arn:aws:sts::123456789012:assumed-role/my-role/my-session-name\",\"accountId\":\"123456789012\",\"sessionContext\":{\"attributes\":{\"mfaAuthenticated\":\"false\",\"creationDate\":\"2016-01-26T21:42:12Z\"},\"sessionIssuer\":{\"type\":\"Role\",\"principalId\":\"AROAJIKPFTA72SWU4L7T4\",\"arn\":\"arn:aws:iam::123456789012:role/my-role\",\"accountId\":\"123456789012\",\"userName\":\"my-role\"}}},\"eventTime\":\"2016-01-26T21:42:12Z\",\"eventSource\":\"signin.amazonaws.com\",\"eventName\":\"ConsoleLogin\",\"awsRegion\":\"us-east-1\",\"sourceIPAddress\":\"72.21.198.70\",\"userAgent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.111 Safari/537.36\",\"requestParameters\":null,\"responseElements\":{\"ConsoleLogin\":\"Success\"},\"additionalEventData\":{\"MobileVersion\":\"No\",\"MFAUsed\":\"No\"},\"eventID\":\"654ccbc0-ba0d-486a-9076-dbf7274677a7\",\"eventType\":\"AwsConsoleSignIn\",\"recipientAccountId\":\"123456789012\"}", "EventName": "ConsoleLogin", "Resources": [] } ] } ``` + Para ver detalhes da API, consulte [LookupEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/lookup-events.html) na *Referência de comandos da AWS CLI*. ### `put-event-selectors` O código de exemplo a seguir mostra como usar `put-event-selectors`. **AWS CLI** **Exemplo 1: configurar uma trilha para fazer o log de eventos de gerenciamento e eventos de dados usando seletores de eventos avançados** Você pode adicionar seletores de eventos avançados e condições para seus seletores de eventos avançados, até um máximo de 500 valores para todas as condições e seletores em uma trilha. É possível usar seletores de eventos avançados para fazer o log de todos os tipos de eventos de dados. Você pode usar seletores de eventos avançados ou seletores de eventos básicos, mas não ambos. Se você aplicar seletores de eventos avançados a uma trilha, todos os seletores de eventos básicos existentes serão substituídos. O exemplo de `put-event-selectors` a seguir cria um seletor de eventos avançado para uma trilha denominada `myTrail` para registrar em log todos os eventos de gerenciamento, as chamadas de API PutObject e DeleteObject do S3 para todos os buckets do S3 (exceto um), as chamadas de API de dados para uma função do Lambda denominada `myFunction` e as chamadas de API Publish em um tópico do SNS denominado `myTopic`. ``` aws cloudtrail put-event-selectors \ --trail-name myTrail \ --advanced-event-selectors '[{"Name": "Log all management events", "FieldSelectors": [{ "Field": "eventCategory", "Equals": ["Management"] }] },{"Name": "Log PutObject and DeleteObject events for all but one bucket","FieldSelectors": [{ "Field": "eventCategory", "Equals": ["Data"] },{ "Field": "resources.type", "Equals": ["AWS::S3::Object"] },{ "Field": "eventName", "Equals": ["PutObject","DeleteObject"] },{ "Field": "resources.ARN", "NotStartsWith": ["arn:aws:s3:::amzn-s3-demo-bucket/"] }]},{"Name": "Log data events for a specific Lambda function","FieldSelectors": [{ "Field": "eventCategory", "Equals": ["Data"] },{ "Field": "resources.type", "Equals": ["AWS::Lambda::Function"] },{ "Field": "resources.ARN", "Equals": ["arn:aws:lambda:us-east-1:123456789012:function:myFunction"] }]},{"Name": "Log all Publish API calls on a specific SNS topic","FieldSelectors": [{ "Field": "eventCategory", "Equals": ["Data"] },{ "Field": "resources.type", "Equals": ["AWS::SNS::Topic"] },{ "Field": "eventName", "Equals": ["Publish"] },{ "Field": "resources.ARN", "Equals": ["arn:aws:sns:us-east-1:123456789012:myTopic.fifo"] }]}]' ``` Resultado: ``` { "TrailARN": "arn:aws:cloudtrail:us-east-1:123456789012:trail/myTrail", "AdvancedEventSelectors": [ { "Name": "Log all management events", "FieldSelectors": [ { "Field": "eventCategory", "Equals": [ "Management" ] } ] }, { "Name": "Log PutObject and DeleteObject events for all but one bucket", "FieldSelectors": [ { "Field": "eventCategory", "Equals": [ "Data" ] }, { "Field": "resources.type", "Equals": [ "AWS::S3::Object" ] }, { "Field": "eventName", "Equals": [ "PutObject", "DeleteObject" ] }, { "Field": "resources.ARN", "NotStartsWith": [ "arn:aws:s3:::amzn-s3-demo-bucket/" ] } ] }, { "Name": "Log data events for a specific Lambda function", "FieldSelectors": [ { "Field": "eventCategory", "Equals": [ "Data" ] }, { "Field": "resources.type", "Equals": [ "AWS::Lambda::Function" ] }, { "Field": "resources.ARN", "Equals": [ "arn:aws:lambda:us-east-1:123456789012:function:myFunction" ] } ] }, { "Name": "Log all Publish API calls on a specific SNS topic", "FieldSelectors": [ { "Field": "eventCategory", "Equals": [ "Data" ] }, { "Field": "resources.type", "Equals": [ "AWS::SNS::Topic" ] }, { "Field": "eventName", "Equals": [ "Publish" ] }, { "Field": "resources.ARN", "Equals": [ "arn:aws:sns:us-east-1:123456789012:myTopic.fifo" ] } ] } ] } ``` Para obter mais informações, consulte [Eventos de logs utilizando seletores de eventos avançados](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced) no *Guia do usuário do AWS CloudTrail*. **Exemplo 2: configurar seletores de eventos para uma trilha para fazer o log de todos os eventos de gerenciamento e eventos de dados** Você pode configurar até 5 seletores de eventos para uma trilha e até 250 recursos de dados para uma trilha. Os seletores de eventos também são chamados de seletores de eventos básicos. Você pode usar seletores de eventos para fazer o log de eventos de gerenciamento e eventos de dados para objetos do S3, funções do Lambda e tabelas do DynnamoDB. Para fazer o log de eventos de dados em outros tipos de recursos, use seletores de eventos avançados. O exemplo de `put-event-selectors` a seguir cria um seletor de eventos para uma trilha chamada `TrailName` com o objetivo de incluir todos os eventos de gerenciamento, eventos de dados para duas combinações de bucket/prefixo do Amazon S3 e eventos de dados para uma única função do AWS Lambda chamada `hello-world-python-function`. ``` aws cloudtrail put-event-selectors \ --trail-name TrailName \ --event-selectors '[{"ReadWriteType": "All","IncludeManagementEvents": true,"DataResources": [{"Type":"AWS::S3::Object", "Values": ["arn:aws:s3:::amzn-s3-demo-bucket/prefix","arn:aws:s3:::amzn-s3-demo-bucket2/prefix2"]},{"Type": "AWS::Lambda::Function","Values": ["arn:aws:lambda:us-west-2:999999999999:function:hello-world-python-function"]}]}]' ``` Resultado: ``` { "EventSelectors": [ { "IncludeManagementEvents": true, "DataResources": [ { "Values": [ "arn:aws:s3:::amzn-s3-demo-bucket/prefix", "arn:aws:s3:::amzn-s3-demo-bucket2/prefix2" ], "Type": "AWS::S3::Object" }, { "Values": [ "arn:aws:lambda:us-west-2:123456789012:function:hello-world-python-function" ], "Type": "AWS::Lambda::Function" }, ], "ReadWriteType": "All" } ], "TrailARN": "arn:aws:cloudtrail:us-east-2:123456789012:trail/TrailName" } ``` Para obter mais informações, consulte [Eventos de logs utilizando seletores de eventos básicos](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-basic) no *Guia do usuário do AWS CloudTrail*. **Exemplo 3: configurar seletores de eventos para uma trilha para fazer o log de eventos de gerenciamento, todos os eventos de dados do S3 em objetos do S3 e todos os eventos de dados do Lambda em funções em sua conta** O exemplo de `put-event-selectors` a seguir cria um seletor de eventos de uma trilha chamada `TrailName2` que inclui todos os eventos de gerenciamento e todos os eventos de dados para todos os buckets do Amazon S3 e as funções do AWS Lambda na conta da AWS. ``` aws cloudtrail put-event-selectors \ --trail-name TrailName2 \ --event-selectors '[{"ReadWriteType": "All","IncludeManagementEvents": true,"DataResources": [{"Type":"AWS::S3::Object", "Values": ["arn:aws:s3"]},{"Type": "AWS::Lambda::Function","Values": ["arn:aws:lambda"]}]}]' ``` Resultado: ``` { "EventSelectors": [ { "IncludeManagementEvents": true, "DataResources": [ { "Values": [ "arn:aws:s3" ], "Type": "AWS::S3::Object" }, { "Values": [ "arn:aws:lambda" ], "Type": "AWS::Lambda::Function" }, ], "ReadWriteType": "All" } ], "TrailARN": "arn:aws:cloudtrail:us-east-2:123456789012:trail/TrailName2" } ``` Para obter mais informações, consulte [Eventos de logs utilizando seletores de eventos básicos](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-basic) no *Guia do usuário do AWS CloudTrail*. + Para ver detalhes da API, consulte [PutEventSelectors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/put-event-selectors.html) na *Referência de comandos da AWS CLI*. ### `remove-tags` O código de exemplo a seguir mostra como usar `remove-tags`. **AWS CLI** **Para remover etiquetas de uma trilha** O comando `remove-tags` a seguir marca as tags especificadas da `Trail1`: ``` aws cloudtrail remove-tags --resource-id arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1 --tags-list Key=name Key=location ``` + Para ver detalhes da API, consulte [RemoveTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/remove-tags.html) na *Referência de comandos da AWS CLI*. ### `start-logging` O código de exemplo a seguir mostra como usar `start-logging`. **AWS CLI** **Para iniciar o registro de uma trilha** O comando `start-logging` a seguir ativa o registro em log da `Trail1`: ``` aws cloudtrail start-logging --name Trail1 ``` + Para ver detalhes da API, consulte [StartLogging](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/start-logging.html) na *Referência de comandos da AWS CLI*. ### `stop-logging` O código de exemplo a seguir mostra como usar `stop-logging`. **AWS CLI** **Como parar de registrar uma trilha** O comando `stop-logging` a seguir desativa o registro em log da `Trail1`: ``` aws cloudtrail stop-logging --name Trail1 ``` + Para ver detalhes da API, consulte [StopLogging](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/stop-logging.html) na *Referência de comandos da AWS CLI*. ### `update-subscription` O código de exemplo a seguir mostra como usar `update-subscription`. **AWS CLI** **Para atualizar as configurações de uma trilha** O exemplo de `update-subscription` a seguir atualiza a trilha para especificar um novo bucket do S3 e um tópico do SNS. ``` aws cloudtrail update-subscription \ --name Trail1 \ --s3-new-bucket amzn-s3-demo-bucket \ --sns-new-topic my-topic-new ``` Resultado: ``` Setting up new S3 bucket amzn-s3-demo-bucket... Setting up new SNS topic my-topic-new... Creating/updating CloudTrail configuration... CloudTrail configuration: { "trailList": [ { "IncludeGlobalServiceEvents": true, "Name": "Trail1", "TrailARN": "arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1", "LogFileValidationEnabled": false, "IsMultiRegionTrail": false, "S3BucketName": "amzn-s3-demo-bucket", "SnsTopicName": "my-topic-new", "HomeRegion": "us-east-1" } ], "ResponseMetadata": { "HTTPStatusCode": 200, "RequestId": "31126f8a-c616-11e5-9cc6-2fd637936879" } } ``` + Para ver detalhes da API, consulte [UpdateSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/update-subscription.html) na *Referência de comandos da AWS CLI*. ### `update-trail` O código de exemplo a seguir mostra como usar `update-trail`. **AWS CLI** **Para atualizar uma trilha** O exemplo de `update-trail` a seguir atualiza uma trilha para usar um bucket existente para entrega de logs. ``` aws cloudtrail update-trail \ --name Trail1 \ --s3-bucket-name amzn-s3-demo-bucket ``` Resultado: ``` { "IncludeGlobalServiceEvents": true, "Name": "Trail1", "TrailARN": "arn:aws:cloudtrail:us-west-2:123456789012:trail/Trail1", "LogFileValidationEnabled": false, "IsMultiRegionTrail": true, "S3BucketName": "amzn-s3-demo-bucket" } ``` + Para ver detalhes da API, consulte [UpdateTrail](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/update-trail.html) na *Referência de comandos da AWS CLI*. ### `validate-logs` O código de exemplo a seguir mostra como usar `validate-logs`. **AWS CLI** **Para validar um arquivo de log** O comando `validate-logs` a seguir valida os logs da `Trail1`: ``` aws cloudtrail validate-logs --trail-arn arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1 --start-time 20160129T19:00:00Z ``` Resultado: ``` Validating log files for trail arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1 between 2016-01-29T19:00:00Z and 2016-01-29T22:15:43Z Results requested for 2016-01-29T19:00:00Z to 2016-01-29T22:15:43Z Results found for 2016-01-29T19:24:57Z to 2016-01-29T21:24:57Z: 3/3 digest files valid 15/15 log files valid ``` + Para ver detalhes da API, consulte [ValidateLogs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/validate-logs.html) na *Referência de comandos da AWS CLI*. # Exemplos do CloudWatch usando o AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o 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 ### `delete-alarms` O código de exemplo a seguir mostra como usar `delete-alarms`. **AWS CLI** **Como excluir um alarme** O seguinte exemplo usa o comando `delete-alarms` para excluir o alarme “myalarm” do Amazon CloudWatch: ``` aws cloudwatch delete-alarms --alarm-names myalarm ``` Resultado: ``` This command returns to the prompt if successful. ``` + Consulte detalhes da API em [DeleteAlarms](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/delete-alarms.html) na *Referência de comandos da AWS CLI*. ### `delete-anomaly-detector` O código de exemplo a seguir mostra como usar `delete-anomaly-detector`. **AWS CLI** **Para excluir um modelo específico de detecção de anomalias** O exemplo `delete-anomaly-detector` a seguir exclui um modelo de detector de anomalias na conta específica. ``` aws cloudwatch delete-anomaly-detector \ --namespace AWS/Logs \ --metric-name IncomingBytes \ --stat SampleCount ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir um modelo de detecção de anomalias](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Anomaly_Detection_Alarm.html#Delete_Anomaly_Detection_Model) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [DeleteAnomalyDetector](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/delete-anomaly-detector.html) na *Referência de comandos da AWS CLI*. ### `delete-dashboards` O código de exemplo a seguir mostra como usar `delete-dashboards`. **AWS CLI** **Para excluir painéis específicos** O exemplo `delete-dashboards` a seguir exclui dois painéis denominados `Dashboard-A` e `Dashboard-B` na conta específica. ``` aws cloudwatch delete-dashboards \ --dashboard-names Dashboard-A Dashboard-B ``` Este comando não produz saída. Para obter mais informações, consulte [Painéis do Amazon CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Dashboards.html) no *Guiado usuário do Amazon CloudWatch*. + Consulte detalhes da API em [DeleteDashboards](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/delete-dashboards.html) na *Referência de comandos da AWS CLI*. ### `delete-insight-rules` O código de exemplo a seguir mostra como usar `delete-insight-rules`. **AWS CLI** **Como excluir regras específicas do Contributor Insights** O exemplo de `delete-insight-rules` a seguir exclui duas regras do Contributor Insights chamadas `Rule-A` e `Rule-B` na conta específica. ``` aws cloudwatch delete-insight-rules \ --rule-names Rule-A Rule-B ``` Resultado: ``` { "Failures": [] } ``` Consulte mais informações em [Usar o Contributor Insights para analisar dados de alta cardinalidade](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [DeleteInsightRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/delete-insight-rules.html) na *Referência de comandos da AWS CLI*. ### `delete-metric-stream` O código de exemplo a seguir mostra como usar `delete-metric-stream`. **AWS CLI** **Como excluir um fluxo de métricas especificado** O exemplo de `delete-metric-stream` a seguir exclui o fluxo de métricas chamado `QuickPartial-gSCKvO` na conta especificada. ``` aws cloudwatch delete-metric-stream \ --name QuickPartial-gSCKvO ``` Este comando não produz saída. Consulte mais informações em [Usar fluxos de métricas](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [DeleteMetricStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/delete-metric-stream.html) na *Referência de comandos da AWS CLI*. ### `describe-alarm-history` O código de exemplo a seguir mostra como usar `describe-alarm-history`. **AWS CLI** **Para recuperar o histórico de um alarme** O seguinte exemplo usa o comando `describe-alarm-history` para recuperar o histórico do alarme “myalarm” do Amazon CloudWatch: ``` aws cloudwatch describe-alarm-history --alarm-name "myalarm" --history-item-type StateUpdate ``` Resultado: ``` { "AlarmHistoryItems": [ { "Timestamp": "2014-04-09T18:59:06.442Z", "HistoryItemType": "StateUpdate", "AlarmName": "myalarm", "HistoryData": "{\"version\":\"1.0\",\"oldState\":{\"stateValue\":\"ALARM\",\"stateReason\":\"testing purposes\"},\"newState\":{\"stateValue\":\"OK\",\"stateReason\":\"Threshold Crossed: 2 datapoints were not greater than the threshold (70.0). The most recent datapoints: [38.958, 40.292].\",\"stateReasonData\":{\"version\":\"1.0\",\"queryDate\":\"2014-04-09T18:59:06.419+0000\",\"startDate\":\"2014-04-09T18:44:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[38.958,40.292],\"threshold\":70.0}}}", "HistorySummary": "Alarm updated from ALARM to OK" }, { "Timestamp": "2014-04-09T18:59:05.805Z", "HistoryItemType": "StateUpdate", "AlarmName": "myalarm", "HistoryData": "{\"version\":\"1.0\",\"oldState\":{\"stateValue\":\"OK\",\"stateReason\":\"Threshold Crossed: 2 datapoints were not greater than the threshold (70.0). The most recent datapoints: [38.839999999999996, 39.714].\",\"stateReasonData\":{\"version\":\"1.0\",\"queryDate\":\"2014-03-11T22:45:41.569+0000\",\"startDate\":\"2014-03-11T22:30:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[38.839999999999996,39.714],\"threshold\":70.0}},\"newState\":{\"stateValue\":\"ALARM\",\"stateReason\":\"testing purposes\"}}", "HistorySummary": "Alarm updated from OK to ALARM" } ] } ``` + Consulte detalhes da API em [DescribeAlarmHistory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/describe-alarm-history.html) na *Referência de comandos da AWS CLI*. ### `describe-alarms-for-metric` O código de exemplo a seguir mostra como usar `describe-alarms-for-metric`. **AWS CLI** **Como exibir informações sobre os alarmes associados a uma métrica** O seguinte exemplo usa o comando `describe-alarms-for-metric` para exibir informações sobre qualquer alarme associado à métrica CPUUtilization do Amazon EC2 e à instância com o ID i-0c986c72.: ``` aws cloudwatch describe-alarms-for-metric --metric-name CPUUtilization --namespace AWS/EC2 --dimensions Name=InstanceId,Value=i-0c986c72 ``` Resultado: ``` { "MetricAlarms": [ { "EvaluationPeriods": 10, "AlarmArn": "arn:aws:cloudwatch:us-east-1:111122223333:alarm:myHighCpuAlarm2", "StateUpdatedTimestamp": "2013-10-30T03:03:51.479Z", "AlarmConfigurationUpdatedTimestamp": "2013-10-30T03:03:50.865Z", "ComparisonOperator": "GreaterThanOrEqualToThreshold", "AlarmActions": [ "arn:aws:sns:us-east-1:111122223333:NotifyMe" ], "Namespace": "AWS/EC2", "AlarmDescription": "CPU usage exceeds 70 percent", "StateReasonData": "{\"version\":\"1.0\",\"queryDate\":\"2013-10-30T03:03:51.479+0000\",\"startDate\":\"2013-10-30T02:08:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[40.698,39.612,42.432,39.796,38.816,42.28,42.854,40.088,40.760000000000005,41.316],\"threshold\":70.0}", "Period": 300, "StateValue": "OK", "Threshold": 70.0, "AlarmName": "myHighCpuAlarm2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-0c986c72" } ], "Statistic": "Average", "StateReason": "Threshold Crossed: 10 datapoints were not greater than or equal to the threshold (70.0). The most recent datapoints: [40.760000000000005, 41.316].", "InsufficientDataActions": [], "OKActions": [], "ActionsEnabled": true, "MetricName": "CPUUtilization" }, { "EvaluationPeriods": 2, "AlarmArn": "arn:aws:cloudwatch:us-east-1:111122223333:alarm:myHighCpuAlarm", "StateUpdatedTimestamp": "2014-04-09T18:59:06.442Z", "AlarmConfigurationUpdatedTimestamp": "2014-04-09T22:26:05.958Z", "ComparisonOperator": "GreaterThanThreshold", "AlarmActions": [ "arn:aws:sns:us-east-1:111122223333:HighCPUAlarm" ], "Namespace": "AWS/EC2", "AlarmDescription": "CPU usage exceeds 70 percent", "StateReasonData": "{\"version\":\"1.0\",\"queryDate\":\"2014-04-09T18:59:06.419+0000\",\"startDate\":\"2014-04-09T18:44:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[38.958,40.292],\"threshold\":70.0}", "Period": 300, "StateValue": "OK", "Threshold": 70.0, "AlarmName": "myHighCpuAlarm", "Dimensions": [ { "Name": "InstanceId", "Value": "i-0c986c72" } ], "Statistic": "Average", "StateReason": "Threshold Crossed: 2 datapoints were not greater than the threshold (70.0). The most recent datapoints: [38.958, 40.292].", "InsufficientDataActions": [], "OKActions": [], "ActionsEnabled": false, "MetricName": "CPUUtilization" } ] } ``` + Consulte detalhes da API em [DescribeAlarmsForMetric](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/describe-alarms-for-metric.html) na *Referência de comandos da AWS CLI*. ### `describe-alarms` O código de exemplo a seguir mostra como usar `describe-alarms`. **AWS CLI** **Para listar informações sobre um alarme** O seguinte exemplo usa o comando `describe-alarms` para fornecer informações sobre o alarme chamado “myalarm”: ``` aws cloudwatch describe-alarms --alarm-names "myalarm" ``` Resultado: ``` { "MetricAlarms": [ { "EvaluationPeriods": 2, "AlarmArn": "arn:aws:cloudwatch:us-east-1:123456789012:alarm:myalarm", "StateUpdatedTimestamp": "2014-04-09T18:59:06.442Z", "AlarmConfigurationUpdatedTimestamp": "2012-12-27T00:49:54.032Z", "ComparisonOperator": "GreaterThanThreshold", "AlarmActions": [ "arn:aws:sns:us-east-1:123456789012:myHighCpuAlarm" ], "Namespace": "AWS/EC2", "AlarmDescription": "CPU usage exceeds 70 percent", "StateReasonData": "{\"version\":\"1.0\",\"queryDate\":\"2014-04-09T18:59:06.419+0000\",\"startDate\":\"2014-04-09T18:44:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[38.958,40.292],\"threshold\":70.0}", "Period": 300, "StateValue": "OK", "Threshold": 70.0, "AlarmName": "myalarm", "Dimensions": [ { "Name": "InstanceId", "Value": "i-0c986c72" } ], "Statistic": "Average", "StateReason": "Threshold Crossed: 2 datapoints were not greater than the threshold (70.0). The most recent datapoints: [38.958, 40.292].", "InsufficientDataActions": [], "OKActions": [], "ActionsEnabled": true, "MetricName": "CPUUtilization" } ] } ``` + Consulte detalhes da API em [DescribeAlarms](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/describe-alarms.html) na *Referência de comandos da AWS CLI*. ### `describe-anomaly-detectors` O código de exemplo a seguir mostra como usar `describe-anomaly-detectors`. **AWS CLI** **Para recuperar uma lista de modelos de detecção de anomalias** O exemplo `describe-anomaly-detectors` a seguir exibe informações sobre modelos de detectores de anomalias associados ao namespace `AWS/Logs` na conta específica. ``` aws cloudwatch describe-anomaly-detectors \ --namespace AWS/Logs ``` Resultado: ``` { "AnomalyDetectors": [ { "Namespace": "AWS/Logs", "MetricName": "IncomingBytes", "Dimensions": [], "Stat": "SampleCount", "Configuration": { "ExcludedTimeRanges": [] }, "StateValue": "TRAINED", "SingleMetricAnomalyDetector": { "AccountId": "123456789012", "Namespace": "AWS/Logs", "MetricName": "IncomingBytes", "Dimensions": [], "Stat": "SampleCount" } }, { "Namespace": "AWS/Logs", "MetricName": "IncomingBytes", "Dimensions": [ { "Name": "LogGroupName", "Value": "demo" } ], "Stat": "Average", "Configuration": { "ExcludedTimeRanges": [] }, "StateValue": "PENDING_TRAINING", "SingleMetricAnomalyDetector": { "AccountId": "123456789012", "Namespace": "AWS/Logs", "MetricName": "IncomingBytes", "Dimensions": [ { "Name": "LogGroupName", "Value": "demo" } ], "Stat": "Average" } } ] } ``` Para obter mais informações, consulte [Usar a detecção de anomalias do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Anomaly_Detection.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [DescribeAnomalyDetectors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/describe-anomaly-detectors.html) na *Referência de comandos da AWS CLI*. ### `describe-insight-rules` O código de exemplo a seguir mostra como usar `describe-insight-rules`. **AWS CLI** **Como recuperar uma lista de regras do Contributor Insights** O exemplo de `describe-insight-rules` a seguir mostra todas as regras do Contributor Insights na conta especificada. ``` aws cloudwatch describe-insight-rules ``` Resultado: ``` { "InsightRules": [ { "Name": "Rule-A", "State": "ENABLED", "Schema": "CloudWatchLogRule/1", "Definition": "{\n\t\"AggregateOn\": \"Count\",\n\t\"Contribution\": {\n\t\t\"Filters\": [],\n\t\t\"Keys\": [\n\t\t\t\"$.requestId\"\n\t\t]\n\t},\n\t\"LogFormat\": \"JSON\",\n\t\"Schema\": {\n\t\t\"Name\": \"CloudWatchLogRule\",\n\t\t\"Version\": 1\n\t},\n\t\"LogGroupARNs\": [\n\t\t\"arn:aws:logs:us-east-1:123456789012:log-group:demo\"\n\t]\n}", "ManagedRule": false }, { "Name": "Rule-B", "State": "ENABLED", "Schema": "CloudWatchLogRule/1", "Definition": "{\n\t\"AggregateOn\": \"Count\",\n\t\"Contribution\": {\n\t\t\"Filters\": [],\n\t\t\"Keys\": [\n\t\t\t\"$.requestId\"\n\t\t]\n\t},\n\t\"LogFormat\": \"JSON\",\n\t\"Schema\": {\n\t\t\"Name\": \"CloudWatchLogRule\",\n\t\t\"Version\": 1\n\t},\n\t\"LogGroupARNs\": [\n\t\t\"arn:aws:logs:us-east-1:123456789012:log-group:demo-1\"\n\t]\n}", "ManagedRule": false } ] } ``` Consulte mais informações em [Usar o Contributor Insights para analisar dados de alta cardinalidade](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [DescribeInsightRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/describe-insight-rules.html) na *Referência de comandos da AWS CLI*. ### `disable-alarm-actions` O código de exemplo a seguir mostra como usar `disable-alarm-actions`. **AWS CLI** **Como desativar ações de um alarme** O seguinte exemplo usa o comando `disable-alarm-actions` para desabilitar todas as ações do alarme “myalarm”: ``` aws cloudwatch disable-alarm-actions --alarm-names myalarm ``` Esse comando retornará ao prompt, se houver êxito. + Consulte detalhes da API em [DisableAlarmActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/disable-alarm-actions.html) na *Referência de comandos da AWS CLI*. ### `disable-insight-rules` O código de exemplo a seguir mostra como usar `disable-insight-rules`. **AWS CLI** **Como desabilitar regras especificadas do Contributor Insights** O exemplo de `disable-insight-rules` a seguir desabilita duas regras do Contributor Insights chamadas `Rule-A` e `Rule-B` na conta especificada. ``` aws cloudwatch disable-insight-rules \ --rule-names Rule-A Rule-B ``` Resultado: ``` { "Failures": [] } ``` Consulte mais informações em [Usar o Contributor Insights para analisar dados de alta cardinalidade](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [DisableInsightRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/disable-insight-rules.html) na *Referência de comandos da AWS CLI*. ### `enable-alarm-actions` O código de exemplo a seguir mostra como usar `enable-alarm-actions`. **AWS CLI** **Para habilitar todas as ações de um alarme** O seguinte exemplo usa o comando `enable-alarm-actions` para habilitar todas as ações para o alarme “myalarm”: ``` aws cloudwatch enable-alarm-actions --alarm-names myalarm ``` Esse comando retornará ao prompt, se tiver êxito. + Consulte detalhes da API em [EnableAlarmActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/enable-alarm-actions.html) na *Referência de comandos da AWS CLI*. ### `enable-insight-rules` O código de exemplo a seguir mostra como usar `enable-insight-rules`. **AWS CLI** **Como habilitar regras especificadas do Contributor Insights** O exemplo de `enable-insight-rules` a seguir habilita duas regras do Contributor Insights chamadas `Rule-A` e `Rule-B` na conta especificada. ``` aws cloudwatch enable-insight-rules \ --rule-names Rule-A Rule-B ``` Resultado: ``` { "Failures": [] } ``` Consulte mais informações em [Usar o Contributor Insights para analisar dados de alta cardinalidade](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [EnableInsightRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/enable-insight-rules.html) na *Referência de comandos da AWS CLI*. ### `get-dashboard` O código de exemplo a seguir mostra como usar `get-dashboard`. **AWS CLI** **Para recuperar informações sobre um painel** O exemplo `get-dashboard` a seguir exibe as informações sobre o painel denominado `Dashboard-A` na conta específica. ``` aws cloudwatch get-dashboard \ --dashboard-name Dashboard-A ``` Resultado: ``` { "DashboardArn": "arn:aws:cloudwatch::123456789012:dashboard/Dashboard-A", "DashboardBody": "{\"widgets\":[{\"type\":\"metric\",\"x\":0,\"y\":0,\"width\":6,\"height\":6,\"properties\":{\"view\":\"timeSeries\",\"stacked\":false,\"metrics\":[[\"AWS/EC2\",\"NetworkIn\",\"InstanceId\",\"i-0131f062232ade043\"],[\".\",\"NetworkOut\",\".\",\".\"]],\"region\":\"us-east-1\"}}]}", "DashboardName": "Dashboard-A" } ``` Para obter mais informações, consulte [Painéis do Amazon CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Dashboards.html) no *Guiado usuário do Amazon CloudWatch*. + Consulte detalhes da API em [GetDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/get-dashboard.html) na *Referência de comandos da AWS CLI*. ### `get-insight-rule-report` O código de exemplo a seguir mostra como usar `get-insight-rule-report`. **AWS CLI** **Como recuperar os dados de séries temporais coletados por uma regra do Contributor Insights** O exemplo de `get-insight-rule-report` a seguir retorna os dados de séries temporais coletados por uma regra do Contributor Insights. ``` aws cloudwatch get-insight-rule-report \ --rule-name Rule-A \ --start-time 2024-10-13T20:15:00Z \ --end-time 2024-10-13T20:30:00Z \ --period 300 ``` Resultado: ``` { "KeyLabels": [ "PartitionKey" ], "AggregationStatistic": "Sum", "AggregateValue": 0.5, "ApproximateUniqueCount": 1, "Contributors": [ { "Keys": [ "RequestID" ], "ApproximateAggregateValue": 0.5, "Datapoints": [ { "Timestamp": "2024-10-13T21:00:00+00:00", "ApproximateValue": 0.5 } ] } ], "RuleAttributes": [] } ``` Consulte mais informações em [Usar o Contributor Insights para analisar dados de alta cardinalidade](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [GetInsightRuleReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/get-insight-rule-report.html) na *Referência de comandos da AWS CLI*. ### `get-metric-data` O código de exemplo a seguir mostra como usar `get-metric-data`. **AWS CLI** **Exemplo 1: para obter a média total de IOPS para o EC2 especificado usando a expressão matemática** O exemplo `get-metric-data` a seguir recupera os valores de métricas do CloudWatch para a instância do EC2 com InstanceID `i-abcdef` usando uma expressão matemática métrica que combina as métricas `EBSReadOps` e `EBSWriteOps`. ``` aws cloudwatch get-metric-data \ --metric-data-queries file://file.json \ --start-time 2024-09-29T22:10:00Z \ --end-time 2024-09-29T22:15:00Z ``` Conteúdo de `file.json`: ``` [ { "Id": "m3", "Expression": "(m1+m2)/300", "Label": "Avg Total IOPS" }, { "Id": "m1", "MetricStat": { "Metric": { "Namespace": "AWS/EC2", "MetricName": "EBSReadOps", "Dimensions": [ { "Name": "InstanceId", "Value": "i-abcdef" } ] }, "Period": 300, "Stat": "Sum", "Unit": "Count" }, "ReturnData": false }, { "Id": "m2", "MetricStat": { "Metric": { "Namespace": "AWS/EC2", "MetricName": "EBSWriteOps", "Dimensions": [ { "Name": "InstanceId", "Value": "i-abcdef" } ] }, "Period": 300, "Stat": "Sum", "Unit": "Count" }, "ReturnData": false } ] ``` Resultado: ``` { "MetricDataResults": [ { "Id": "m3", "Label": "Avg Total IOPS", "Timestamps": [ "2024-09-29T22:10:00+00:00" ], "Values": [ 96.85 ], "StatusCode": "Complete" } ], "Messages": [] } ``` **Exemplo 2: para monitorar as cobranças estimadas da AWS usando as métricas de faturamento do CloudWatch** O exemplo `get-metric-data` a seguir recupera a métrica `EstimatedCharges` do CloudWatch do namespace AWS/Faturamento. ``` aws cloudwatch get-metric-data \ --metric-data-queries '[{"Id":"m1","MetricStat":{"Metric":{"Namespace":"AWS/Billing","MetricName":"EstimatedCharges","Dimensions":[{"Name":"Currency","Value":"USD"}]},"Period":21600,"Stat":"Maximum"}}]' \ --start-time 2024-09-26T12:00:00Z \ --end-time 2024-09-26T18:00:00Z \ --region us-east-1 ``` Resultado: ``` { "MetricDataResults": [ { "Id": "m1", "Label": "EstimatedCharges", "Timestamps": [ "2024-09-26T12:00:00+00:00" ], "Values": [ 542.38 ], "StatusCode": "Complete" } ], "Messages": [] } ``` Para obter mais informações, consulte [Uso de expressões matemáticas com as métricas do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [GetMetricData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/get-metric-data.html) na *Referência de comandos da AWS CLI*. ### `get-metric-statistics` O código de exemplo a seguir mostra como usar `get-metric-statistics`. **AWS CLI** **Como obter a utilização da CPU por instância do EC** O exemplo a seguir usa o comando `get-metric-statistics` para obter a utilização da CPU de uma instância do EC2 com o ID i-abcdef. ``` aws cloudwatch get-metric-statistics --metric-name CPUUtilization --start-time 2014-04-08T23:18:00Z --end-time 2014-04-09T23:18:00Z --period 3600 --namespace AWS/EC2 --statistics Maximum --dimensions Name=InstanceId,Value=i-abcdef ``` Resultado: ``` { "Datapoints": [ { "Timestamp": "2014-04-09T11:18:00Z", "Maximum": 44.79, "Unit": "Percent" }, { "Timestamp": "2014-04-09T20:18:00Z", "Maximum": 47.92, "Unit": "Percent" }, { "Timestamp": "2014-04-09T19:18:00Z", "Maximum": 50.85, "Unit": "Percent" }, { "Timestamp": "2014-04-09T09:18:00Z", "Maximum": 47.92, "Unit": "Percent" }, { "Timestamp": "2014-04-09T03:18:00Z", "Maximum": 76.84, "Unit": "Percent" }, { "Timestamp": "2014-04-09T21:18:00Z", "Maximum": 48.96, "Unit": "Percent" }, { "Timestamp": "2014-04-09T14:18:00Z", "Maximum": 47.92, "Unit": "Percent" }, { "Timestamp": "2014-04-09T08:18:00Z", "Maximum": 47.92, "Unit": "Percent" }, { "Timestamp": "2014-04-09T16:18:00Z", "Maximum": 45.55, "Unit": "Percent" }, { "Timestamp": "2014-04-09T06:18:00Z", "Maximum": 47.92, "Unit": "Percent" }, { "Timestamp": "2014-04-09T13:18:00Z", "Maximum": 45.08, "Unit": "Percent" }, { "Timestamp": "2014-04-09T05:18:00Z", "Maximum": 47.92, "Unit": "Percent" }, { "Timestamp": "2014-04-09T18:18:00Z", "Maximum": 46.88, "Unit": "Percent" }, { "Timestamp": "2014-04-09T17:18:00Z", "Maximum": 52.08, "Unit": "Percent" }, { "Timestamp": "2014-04-09T07:18:00Z", "Maximum": 47.92, "Unit": "Percent" }, { "Timestamp": "2014-04-09T02:18:00Z", "Maximum": 51.23, "Unit": "Percent" }, { "Timestamp": "2014-04-09T12:18:00Z", "Maximum": 47.67, "Unit": "Percent" }, { "Timestamp": "2014-04-08T23:18:00Z", "Maximum": 46.88, "Unit": "Percent" }, { "Timestamp": "2014-04-09T10:18:00Z", "Maximum": 51.91, "Unit": "Percent" }, { "Timestamp": "2014-04-09T04:18:00Z", "Maximum": 47.13, "Unit": "Percent" }, { "Timestamp": "2014-04-09T15:18:00Z", "Maximum": 48.96, "Unit": "Percent" }, { "Timestamp": "2014-04-09T00:18:00Z", "Maximum": 48.16, "Unit": "Percent" }, { "Timestamp": "2014-04-09T01:18:00Z", "Maximum": 49.18, "Unit": "Percent" } ], "Label": "CPUUtilization" } ``` **Especificar várias dimensões** O exemplo a seguir ilustra como especificar diversas dimensões. Cada dimensão é especificada como um par de nome/valor, com uma vírgula entre o nome e o valor. As diversas dimensões são separadas por um espaço. Se uma única métrica incluir diversas dimensões, você deverá especificar um valor para cada dimensão definida. Para obter mais exemplos relacionados ao uso do comando `get-metric-statistics`, consulte Obter estatísticas de uma métrica no *Guia do desenvolvedor do Amazon CloudWatch*. ``` aws cloudwatch get-metric-statistics --metric-name Buffers --namespace MyNameSpace --dimensions Name=InstanceID,Value=i-abcdef Name=InstanceType,Value=m1.small --start-time 2016-10-15T04:00:00Z --end-time 2016-10-19T07:00:00Z --statistics Average --period 60 ``` + Consulte detalhes da API em [GetMetricStatistics](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/get-metric-statistics.html) na *Referência de comandos da AWS CLI*. ### `get-metric-stream` O código de exemplo a seguir mostra como usar `get-metric-stream`. **AWS CLI** **Como recuperar informações sobre um fluxo de métricas** O exemplo de `get-metric-stream` a seguir exibe as informações sobre o fluxo de métricas chamado `QuickFull-GuaFbs` na conta especificada. ``` aws cloudwatch get-metric-stream \ --name QuickFull-GuaFbs ``` Resultado: ``` { "Arn": "arn:aws:cloudwatch:us-east-1:123456789012:metric-stream/QuickFull-GuaFbs", "Name": "QuickFull-GuaFbs", "FirehoseArn": "arn:aws:firehose:us-east-1:123456789012:deliverystream/MetricStreams-QuickFull-GuaFbs-WnySbECG", "RoleArn": "arn:aws:iam::123456789012:role/service-role/MetricStreams-FirehosePutRecords-JN10W9B3", "State": "running", "CreationDate": "2024-10-11T18:48:59.187000+00:00", "LastUpdateDate": "2024-10-11T18:48:59.187000+00:00", "OutputFormat": "json", "IncludeLinkedAccountsMetrics": false } ``` Consulte mais informações em [Usar fluxos de métricas](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [GetMetricStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/get-metric-stream.html) na *Referência de comandos da AWS CLI*. ### `get-metric-widget-image` O código de exemplo a seguir mostra como usar `get-metric-widget-image`. **AWS CLI** **Para recuperar um grafo de snapshot de CPUUtilization** O exemplo `get-metric-widget-image` a seguir recupera o grafo de snapshot da métrica `CPUUtilization` da instância do EC2 com o ID `i-abcde` e salva a imagem recuperada como um arquivo denominado "image.png" na máquina local. ``` aws cloudwatch get-metric-widget-image \ --metric-widget '{"metrics":[["AWS/EC2","CPUUtilization","InstanceId","i-abcde"]]}' \ --output-format png \ --output text | base64 --decode > image.png ``` Este comando não produz saída. + Consulte detalhes da API em [GetMetricWidgetImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/get-metric-widget-image.html) na *Referência de comandos da AWS CLI*. ### `list-dashboards` O código de exemplo a seguir mostra como usar `list-dashboards`. **AWS CLI** **Para recuperar uma lista de painéis** O exemplo `list-dashboards` a seguir lista todos os painéis na conta especificada. ``` aws cloudwatch list-dashboards ``` Resultado: ``` { "DashboardEntries": [ { "DashboardName": "Dashboard-A", "DashboardArn": "arn:aws:cloudwatch::123456789012:dashboard/Dashboard-A", "LastModified": "2024-10-11T18:40:11+00:00", "Size": 271 }, { "DashboardName": "Dashboard-B", "DashboardArn": "arn:aws:cloudwatch::123456789012:dashboard/Dashboard-B", "LastModified": "2024-10-11T18:44:41+00:00", "Size": 522 } ] } ``` Para obter mais informações, consulte [Painéis do Amazon CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Dashboards.html) no *Guiado usuário do Amazon CloudWatch*. + Consulte detalhes da API em [ListDashboards](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/list-dashboards.html) na *Referência de comandos da AWS CLI*. ### `list-metric-streams` O código de exemplo a seguir mostra como usar `list-metric-streams`. **AWS CLI** **Como recuperar uma lista de fluxos de métricas** O exemplo de `list-metric-streams` a seguir lista todos os fluxos de métricas na conta especificada. ``` aws cloudwatch list-metric-streams ``` Resultado: ``` { "Entries": [ { "Arn": "arn:aws:cloudwatch:us-east-1:123456789012:metric-stream/QuickFull-GuaFbs", "CreationDate": "2024-10-11T18:48:59.187000+00:00", "LastUpdateDate": "2024-10-11T18:48:59.187000+00:00", "Name": "QuickFull-GuaFbs", "FirehoseArn": "arn:aws:firehose:us-east-1:123456789012:deliverystream/MetricStreams-QuickFull-GuaFbs-WnySbECG", "State": "running", "OutputFormat": "json" } ] } ``` Consulte mais informações em [Usar fluxos de métricas](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [ListMetricStreams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/list-metric-streams.html) na *Referência de comandos da AWS CLI*. ### `list-metrics` O código de exemplo a seguir mostra como usar `list-metrics`. **AWS CLI** **Para listar as métricas do Amazon SNS** O exemplo apresentado a seguir para `list-metrics` exibe as métricas do Amazon SNS. ``` aws cloudwatch list-metrics \ --namespace "AWS/SNS" ``` Resultado: ``` { "Metrics": [ { "Namespace": "AWS/SNS", "Dimensions": [ { "Name": "TopicName", "Value": "NotifyMe" } ], "MetricName": "PublishSize" }, { "Namespace": "AWS/SNS", "Dimensions": [ { "Name": "TopicName", "Value": "CFO" } ], "MetricName": "PublishSize" }, { "Namespace": "AWS/SNS", "Dimensions": [ { "Name": "TopicName", "Value": "NotifyMe" } ], "MetricName": "NumberOfNotificationsFailed" }, { "Namespace": "AWS/SNS", "Dimensions": [ { "Name": "TopicName", "Value": "NotifyMe" } ], "MetricName": "NumberOfNotificationsDelivered" }, { "Namespace": "AWS/SNS", "Dimensions": [ { "Name": "TopicName", "Value": "NotifyMe" } ], "MetricName": "NumberOfMessagesPublished" }, { "Namespace": "AWS/SNS", "Dimensions": [ { "Name": "TopicName", "Value": "CFO" } ], "MetricName": "NumberOfMessagesPublished" }, { "Namespace": "AWS/SNS", "Dimensions": [ { "Name": "TopicName", "Value": "CFO" } ], "MetricName": "NumberOfNotificationsDelivered" }, { "Namespace": "AWS/SNS", "Dimensions": [ { "Name": "TopicName", "Value": "CFO" } ], "MetricName": "NumberOfNotificationsFailed" } ] } ``` + Consulte detalhes da API em [ListMetrics](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/list-metrics.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Como listar as tags associadas a um alarme existente\$1** O exemplo de `list-tags-for-resource` a seguir lista todas as tags associadas a um alarme chamado `demo` na conta especificada. ``` aws cloudwatch list-tags-for-resource \ --resource-arn arn:aws:cloudwatch:us-east-1:123456789012:alarm:demo ``` Resultado: ``` { "Tags": [ { "Key": "stack", "Value": "Production" }, { "Key": "team", "Value": "Devops" } ] } ``` Consulte mais informações em [Alarmes e marcação](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_alarms_and_tagging.html) no *Guia do usuário do Amazon CloudWatch*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `put-anomaly-detector` O código de exemplo a seguir mostra como usar `put-anomaly-detector`. **AWS CLI** **Para criar um modelo de detecção de anomalias** O exemplo `put-anomaly-detector` a seguir cria um modelo de detecção de anomalias de uma métrica do CloudWatch. ``` aws cloudwatch put-anomaly-detector \ --namespace AWS/Logs \ --metric-name IncomingBytes \ --stat SampleCount ``` Este comando não produz saída. Para obter mais informações, consulte [Usar a detecção de anomalias do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Anomaly_Detection.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [PutAnomalyDetector](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/put-anomaly-detector.html) na *Referência de comandos da AWS CLI*. ### `put-composite-alarm` O código de exemplo a seguir mostra como usar `put-composite-alarm`. **AWS CLI** **Como criar um alarme composto no CloudWatch** O exemplo de `put-composite-alarm` a seguir cria um alarme composto chamado `ProdAlarm` na conta especificada. ``` aws cloudwatch put-composite-alarm \ --alarm-name ProdAlarm \ --alarm-rule "ALARM(CPUUtilizationTooHigh) AND ALARM(MemUsageTooHigh)" \ --alarm-actions arn:aws:sns:us-east-1:123456789012:demo \ --actions-enabled ``` Este comando não produz saída. Consulte mais informações em [Criar um alarme composto](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Composite_Alarm_How_To.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [PutCompositeAlarm](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/put-composite-alarm.html) na *Referência de comandos da AWS CLI*. ### `put-dashboard` O código de exemplo a seguir mostra como usar `put-dashboard`. **AWS CLI** **Para criar um painel** O exemplo `put-dashboard` a seguir cria um painel denominado `Dashboard-A` na conta especificada. ``` aws cloudwatch put-dashboard \ --dashboard-name Dashboard-A \ --dashboard-body '{"widgets":[{"height":6,"width":6,"y":0,"x":0,"type":"metric","properties":{"view":"timeSeries","stacked":false,"metrics":[["Namespace","CPUUtilization","Environment","Prod","Type","App"]],"region":"us-east-1"}}]}' ``` Resultado: ``` { "DashboardValidationMessages": [] } ``` Para obter mais informações, consulte [Criar um painel do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/create_dashboard.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [PutDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/put-dashboard.html) na *Referência de comandos da AWS CLI*. ### `put-insight-rule` O código de exemplo a seguir mostra como usar `put-insight-rule`. **AWS CLI** **Como criar uma regra do Contributor Insights** O exemplo de `put-insight-rule` a seguir cria uma regra do Contributor Insights chamada `VPCFlowLogsContributorInsights` na conta especificada. ``` aws cloudwatch put-insight-rule \ --rule-name VPCFlowLogsContributorInsights \ --rule-definition file://insight-rule.json \ --rule-state ENABLED ``` Conteúdo de `insight-rule.json`: ``` { "Schema": { "Name": "CloudWatchLogRule", "Version": 1 }, "AggregateOn": "Count", "Contribution": { "Filters": [], "Keys": [ "tcp-flag" ] }, "LogFormat": "CLF", "LogGroupNames": [ "/vpc/flowlogs/*" ], "Fields": { "23": "tcp-flag" } } ``` Este comando não produz saída. Consulte mais informações em [Criação de uma regra do Contributor Insights no CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-CreateRule.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [PutInsightRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/put-insight-rule.html) na *Referência de comandos da AWS CLI*. ### `put-metric-alarm` O código de exemplo a seguir mostra como usar `put-metric-alarm`. **AWS CLI** **Como enviar uma mensagem de e-mail do Amazon Simple Notification Service quando a utilização da CPU exceder** O seguinte exemplo usa o comando `put-metric-alarm` para enviar uma mensagem de e-mail do Amazon Simple Notification Service quando a utilização da CPU excede 70%: ``` aws cloudwatch put-metric-alarm --alarm-name cpu-mon --alarm-description "Alarm when CPU exceeds 70 percent" --metric-name CPUUtilization --namespace AWS/EC2 --statistic Average --period 300 --threshold 70 --comparison-operator GreaterThanThreshold --dimensions "Name=InstanceId,Value=i-12345678" --evaluation-periods 2 --alarm-actions arn:aws:sns:us-east-1:111122223333:MyTopic --unit Percent ``` Esse comando retornará ao prompt, se houver êxito. Se já existir um alarme com o mesmo nome, ele será substituído pelo novo alarme. **Como especificar diversas dimensões** O exemplo a seguir ilustra como especificar diversas dimensões. Cada dimensão é especificada como um par de nome/valor, com uma vírgula entre o nome e o valor. As diversas dimensões são separadas por um espaço: ``` aws cloudwatch put-metric-alarm --alarm-name "Default_Test_Alarm3" --alarm-description "The default example alarm" --namespace "CW EXAMPLE METRICS" --metric-name Default_Test --statistic Average --period 60 --evaluation-periods 3 --threshold 50 --comparison-operator GreaterThanOrEqualToThreshold --dimensions Name=key1,Value=value1 Name=key2,Value=value2 ``` + Consulte detalhes da API em [PutMetricAlarm](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/put-metric-alarm.html) na *Referência de comandos da AWS CLI*. ### `put-metric-data` O código de exemplo a seguir mostra como usar `put-metric-data`. **AWS CLI** **Como publicar uma métrica personalizada no Amazon CloudWatch** O seguinte exemplo usa o comando `put-metric-data` para publicar uma métrica personalizada no Amazon CloudWatch: ``` aws cloudwatch put-metric-data --namespace "Usage Metrics" --metric-data file://metric.json ``` Os valores da própria métrica estão armazenados no arquivo em JSON, `metric.json`. Veja o conteúdo desse arquivo: ``` [ { "MetricName": "New Posts", "Timestamp": "Wednesday, June 12, 2013 8:28:20 PM", "Value": 0.50, "Unit": "Count" } ] ``` Para obter mais informações, consulte Publicar métricas personalizadas no *Guia do desenvolvedor do Amazon CloudWatch*. **Como especificar diversas dimensões** O exemplo a seguir ilustra como especificar diversas dimensões. Cada dimensão é especificada como um par de nome/valor. As diversas dimensões são separadas por uma vírgula. ``` aws cloudwatch put-metric-data --metric-name Buffers --namespace MyNameSpace --unit Bytes --value 231434333 --dimensions InstanceID=1-23456789,InstanceType=m1.small ``` + Consulte detalhes da API em [PutMetricData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/put-metric-data.html) na *Referência de comandos da AWS CLI*. ### `put-metric-stream` O código de exemplo a seguir mostra como usar `put-metric-stream`. **AWS CLI** **Como criar um fluxo de métricas** O exemplo de `put-metric-stream` a seguir cria um fluxo de métricas chamado `QuickFull-GuaFb` na conta especificada. ``` aws cloudwatch put-metric-stream \ --name QuickFull-GuaFbs \ --firehose-arn arn:aws:firehose:us-east-1:123456789012:deliverystream/MetricStreams-QuickFull-GuaFbs-WnySbECG \ --role-arn arn:aws:iam::123456789012:role/service-role/MetricStreams-FirehosePutRecords-JN10W9B3 \ --output-format json \ --no-include-linked-accounts-metrics ``` Resultado: ``` { "Arn": "arn:aws:cloudwatch:us-east-1:123456789012:metric-stream/QuickFull-GuaFbs" } ``` Consulte mais informações em [Configurar um fluxo de métricas](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-setup.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [PutMetricStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/put-metric-stream.html) na *Referência de comandos da AWS CLI*. ### `set-alarm-state` O código de exemplo a seguir mostra como usar `set-alarm-state`. **AWS CLI** **Para alterar temporariamente o estado de um alarme** O seguinte exemplo usa o comando `set-alarm-state` para alterar temporariamente o estado de um alarme do Amazon CloudWatch chamado “myalarm” e definir seu estado como ALARM para fins de teste: ``` aws cloudwatch set-alarm-state --alarm-name "myalarm" --state-value ALARM --state-reason "testing purposes" ``` Esse comando retornará ao prompt, se houver êxito. + Para ver detalhes da API, consulte [SetAlarmState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/set-alarm-state.html) na *Referência de comandos da AWS CLI*. ### `start-metric-streams` O código de exemplo a seguir mostra como usar `start-metric-streams`. **AWS CLI** **Como iniciar um fluxo de métricas especificado** O exemplo de `start-metric-streams` a seguir inicia o fluxo de métricas chamado `QuickFull-GuaFbs` na conta especificada. ``` aws cloudwatch start-metric-streams \ --names QuickFull-GuaFbs ``` Este comando não produz saída. Consulte mais informações em [Usar fluxos de métricas](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [StartMetricStreams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/start-metric-streams.html) na *Referência de comandos da AWS CLI*. ### `stop-metric-streams` O código de exemplo a seguir mostra como usar `stop-metric-streams`. **AWS CLI** **Como interromper um fluxo de métricas especificado** O exemplo de `stop-metric-streams` a seguir interrompe o fluxo de métricas chamado `QuickFull-GuaFbs` na conta especificada. ``` aws cloudwatch stop-metric-streams \ --names QuickFull-GuaFbs ``` Este comando não produz saída. Consulte mais informações em [Usar fluxos de métricas](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [StopMetricStreams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/stop-metric-streams.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como adicionar uma ou mais tags ao recurso especificado** O exemplo de `tag-resource` a seguir adiciona duas tags ao alarme do CloudWatch chamado `demo` na conta especificada. ``` aws cloudwatch tag-resource \ --resource-arn arn:aws:cloudwatch:us-east-1:123456789012:alarm:demo \ --tags Key=stack,Value=Production Key=team,Value=Devops ``` Este comando não produz saída. Consulte mais informações em [Etiquetar recursos do Amazon CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Tagging.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Como remover uma ou mais tags do recurso especificado** O exemplo de `untag-resource` a seguir remove duas tags do alarme do CloudWatch chamado `demo` na conta especificada. ``` aws cloudwatch untag-resource \ --resource-arn arn:aws:cloudwatch:us-east-1:123456789012:alarm:demo \ --tag-keys stack team ``` Este comando não produz saída. Consulte mais informações em [Etiquetar recursos do Amazon CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Tagging.html) no *Guia do usuário do Amazon CloudWatch*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/untag-resource.html) na *Referência de comandos da AWS CLI*. # Exemplos do CloudWatch Logs usando o AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o CloudWatch Logs. *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 ### `create-log-group` O código de exemplo a seguir mostra como usar `create-log-group`. **AWS CLI** O seguinte comando cria um grupo de logs chamado `my-logs`: ``` aws logs create-log-group --log-group-name my-logs ``` + Consulte detalhes da API em [CreateLogGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/create-log-group.html) na *Referência de comandos da AWS CLI*. ### `create-log-stream` O código de exemplo a seguir mostra como usar `create-log-stream`. **AWS CLI** O seguinte comando cria um fluxo de logs `20150601` no grupo de logs `my-logs`: ``` aws logs create-log-stream --log-group-name my-logs --log-stream-name 20150601 ``` + Consulte detalhes da API em [CreateLogStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/create-log-stream.html) na *Referência de comandos da AWS CLI*. ### `delete-log-group` O código de exemplo a seguir mostra como usar `delete-log-group`. **AWS CLI** O seguinte comando exclui um grupo de logs chamado `my-logs`: ``` aws logs delete-log-group --log-group-name my-logs ``` + Consulte detalhes da API em [DeleteLogGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/delete-log-group.html) na *Referência de comandos da AWS CLI*. ### `delete-log-stream` O código de exemplo a seguir mostra como usar `delete-log-stream`. **AWS CLI** O seguinte comando exclui um fluxo de logs chamado `20150531` de um grupo de logs chamado `my-logs`: ``` aws logs delete-log-stream --log-group-name my-logs --log-stream-name 20150531 ``` + Para ver detalhes da API, consulte [DeleteLogStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/delete-log-stream.html) na *Referência de comandos da AWS CLI*. ### `delete-retention-policy` O código de exemplo a seguir mostra como usar `delete-retention-policy`. **AWS CLI** O comando a seguir remove a política de retenção que foi aplicada anteriormente a um grupo de logs chamado `my-logs`: ``` aws logs delete-retention-policy --log-group-name my-logs ``` + Para ver detalhes da API, consulte [DeleteRetentionPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/delete-retention-policy.html) na *Referência de comandos da AWS CLI*. ### `describe-log-groups` O código de exemplo a seguir mostra como usar `describe-log-groups`. **AWS CLI** O seguinte comando descreve um grupo de logs chamado `my-logs`: ``` aws logs describe-log-groups --log-group-name-prefix my-logs ``` Resultado: ``` { "logGroups": [ { "storedBytes": 0, "metricFilterCount": 0, "creationTime": 1433189500783, "logGroupName": "my-logs", "retentionInDays": 5, "arn": "arn:aws:logs:us-west-2:0123456789012:log-group:my-logs:*" } ] } ``` + Consulte detalhes da API em [DescribeLogGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/describe-log-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-log-streams` O código de exemplo a seguir mostra como usar `describe-log-streams`. **AWS CLI** O comando a seguir mostra todos os fluxos de log começando com o prefixo `2015` no grupo de logs `my-logs`: ``` aws logs describe-log-streams --log-group-name my-logs --log-stream-name-prefix 2015 ``` Resultado: ``` { "logStreams": [ { "creationTime": 1433189871774, "arn": "arn:aws:logs:us-west-2:0123456789012:log-group:my-logs:log-stream:20150531", "logStreamName": "20150531", "storedBytes": 0 }, { "creationTime": 1433189873898, "arn": "arn:aws:logs:us-west-2:0123456789012:log-group:my-logs:log-stream:20150601", "logStreamName": "20150601", "storedBytes": 0 } ] } ``` + Para ver detalhes da API, consulte [DescribeLogStreams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/describe-log-streams.html) na *Referência de comandos da AWS CLI*. ### `get-log-events` O código de exemplo a seguir mostra como usar `get-log-events`. **AWS CLI** O seguinte comando recupera eventos de logs de um fluxo de logs chamado `20150601` no grupo de logs `my-logs`: ``` aws logs get-log-events --log-group-name my-logs --log-stream-name 20150601 ``` Resultado: ``` { "nextForwardToken": "f/31961209122447488583055879464742346735121166569214640130", "events": [ { "ingestionTime": 1433190494190, "timestamp": 1433190184356, "message": "Example Event 1" }, { "ingestionTime": 1433190516679, "timestamp": 1433190184356, "message": "Example Event 1" }, { "ingestionTime": 1433190494190, "timestamp": 1433190184358, "message": "Example Event 2" } ], "nextBackwardToken": "b/31961209122358285602261756944988674324553373268216709120" } ``` + Para ver detalhes da API, consulte [GetLogEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/get-log-events.html) na *Referência de comandos da AWS CLI*. ### `put-log-events` O código de exemplo a seguir mostra como usar `put-log-events`. **AWS CLI** O seguinte comando define eventos de logs de um fluxo de logs chamado `20150601` no grupo de logs `my-logs`: ``` aws logs put-log-events --log-group-name my-logs --log-stream-name 20150601 --log-events file://events ``` Resultado: ``` { "nextSequenceToken": "49542672486831074009579604567656788214806863282469607346" } ``` O exemplo acima lê uma matriz JSON de eventos de um arquivo chamado `events` no diretório atual: ``` [ { "timestamp": 1433190184356, "message": "Example Event 1" }, { "timestamp": 1433190184358, "message": "Example Event 2" }, { "timestamp": 1433190184360, "message": "Example Event 3" } ] ``` Cada chamada subsequente exige que o próximo token de sequência fornecido pela chamada anterior seja especificado com a opção de token de sequência: ``` aws logs put-log-events --log-group-name my-logs --log-stream-name 20150601 --log-events file://events2 --sequence-token "49542672486831074009579604567656788214806863282469607346" ``` Resultado: ``` { "nextSequenceToken": "49542672486831074009579604567900991230369019956308219826" } ``` + Para ver detalhes da API, consulte [PutLogEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/put-log-events.html) na *Referência de comandos da AWS CLI*. ### `put-retention-policy` O código de exemplo a seguir mostra como usar `put-retention-policy`. **AWS CLI** O comando a seguir adiciona uma política de retenção de 5 dias a um grupo de logs chamado `my-logs`: ``` aws logs put-retention-policy --log-group-name my-logs --retention-in-days 5 ``` + Para ver detalhes da API, consulte [PutRetentionPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/put-retention-policy.html) na *Referência de comandos da AWS CLI*. # Exemplos do Monitor de Rede do CloudWatch usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Monitor de Rede do 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 ### `create-monitor` O código de exemplo a seguir mostra como usar `create-monitor`. **AWS CLI** **Exemplo 1: criar um monitor de rede com um período de agregação** O exemplo `create-monitor` a seguir cria um monitor chamado `Example_NetworkMonitor` com um `aggregationPeriod` definido como `30` segundos. O `state` inicial do monitor será `INACTIVE`, porque não há sondas associadas a ele. O estado muda para `ACTIVE` somente quando as sondas são adicionadas. É possível usar os comandos [update-monitor](https://docs.aws.amazon.com/cli/latest/reference/networkmonitor/update-monitor.html) ou [create-probe](https://docs.aws.amazon.com/cli/latest/reference/networkmonitor/create-probe.html) para adicionar sondas a esse monitor. ``` aws networkmonitor create-monitor \ --monitor-name Example_NetworkMonitor \ --aggregation-period 30 ``` Resultado: ``` { "monitorArn": "arn:aws:networkmonitor:region:111122223333:monitor/Example_NetworkMonitor", "monitorName": "Example_NetworkMonitor", "state": "INACTIVE", "aggregationPeriod": 30, "tags": {} } ``` Para obter mais informações, consulte [Como o Monitor de Rede do Amazon CloudWatch funciona](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html) no *Guia do usuário do Amazon CloudWatch*. **Exemplo 2: criar um monitor de rede com uma sonda usando TCP e também incluir tags** O exemplo `create-monitor` a seguir cria um monitor chamado `Example_NetworkMonitor`. O comando também cria uma sonda que usa o protocolo `ICMP` e inclui tags. Como nenhum `aggregationPeriod` é passado na solicitação, `60` segundos são definidos como padrão. O `state` do monitor com a sonda permanecerá como `PENDING` até que o monitor esteja `ACTIVE`. Isso pode levar alguns minutos, quando então `state` mudará para `ACTIVE`, e será possível visualizar as métricas do CloudWatch. ``` aws networkmonitor create-monitor \ --monitor-name Example_NetworkMonitor \ --probes sourceArn=arn:aws:ec2:region:111122223333:subnet/subnet-id,destination=10.0.0.100,destinationPort=80,protocol=TCP,packetSize=56,probeTags={Name=Probe1} \ --tags Monitor=Monitor1 ``` Resultado: ``` { "monitorArn": "arn:aws:networkmonitor:region111122223333:monitor/Example_NetworkMonitor", "monitorName": "Example_NetworkMonitor", "state": "PENDING", "aggregationPeriod": 60, "tags": { "Monitor": "Monitor1" } } ``` Para obter mais informações, consulte [Como o Monitor de Rede do Amazon CloudWatch funciona](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html) no *Guia do usuário do Amazon CloudWatch*. **Exemplo 3: criar um monitor de rede com uma sonda usando ICMP e também incluir tags** O exemplo `create-monitor` a seguir cria um monitor chamado `Example_NetworkMonitor` com um `aggregationPeriod` definido como `30` segundos. O comando também cria uma sonda que usa o protocolo `ICMP` e inclui tags. Como nenhum `aggregationPeriod` é passado na solicitação, `60` segundos são definidos como padrão. O `state` do monitor com a sonda permanecerá como `PENDING` até que o monitor esteja `ACTIVE`. Isso pode levar alguns minutos, quando então `state` mudará para `ACTIVE`, e será possível visualizar as métricas do CloudWatch. ``` aws networkmonitor create-monitor \ --monitor-name Example_NetworkMonitor \ --aggregation-period 30 \ --probes sourceArn=arn:aws:ec2:region111122223333:subnet/subnet-id,destination=10.0.0.100,protocol=ICMP,packetSize=56,probeTags={Name=Probe1} \ --tags Monitor=Monitor1 ``` Resultado: ``` { "monitorArn": "arn:aws:networkmonitor:region:111122223333:monitor/Example_NetworkMonitor", "monitorName": "Example_NetworkMonitor", "state": "PENDING", "aggregationPeriod": 30, "tags": { "Monitor": "Monitor1" } } ``` Para obter mais informações, consulte [Como o Monitor de Rede do Amazon CloudWatch funciona](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [CreateMonitor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmonitor/create-monitor.html) na *Referência de comandos da AWS CLI*. ### `create-probe` O código de exemplo a seguir mostra como usar `create-probe`. **AWS CLI** **Exemplo 1: criar uma sonda que usa TCP e adicioná-la a um monitor de rede** O exemplo `create-probe` a seguir cria uma sonda que usa o `protocol` `TCP` e adiciona a sonda a um monitor chamado `Example_NetworkMonitor`. Uma vez criado, o `state` do monitor com a sonda permanecerá como `PENDING` até que o monitor esteja `ACTIVE`. Isso pode levar alguns minutos, quando então state mudará para `ACTIVE`, e será possível visualizar as métricas do CloudWatch. ``` aws networkmonitor create-probe \ --monitor-name Example_NetworkMonitor \ --probe sourceArn=arn:aws:ec2:region:111122223333:subnet/subnet-id,destination=10.0.0.100,destinationPort=80,protocol=TCP,packetSize=56,tags={Name=Probe1} ``` Resultado: ``` { "probeId": "probe-12345", "probeArn": "arn:aws:networkmonitor:region:111122223333:probe/probe-12345", "destination": "10.0.0.100", "destinationPort": 80, "packetSize": 56, "addressFamily": "IPV4", "vpcId": "vpc-12345", "state": "PENDING", "createdAt": "2024-03-29T12:41:57.314000-04:00", "modifiedAt": "2024-03-29T12:41:57.314000-04:00", "tags": { "Name": "Probe1" } } ``` **Exemplo 2: criar uma sonda que usa ICMP e adicioná-la a um monitor de rede** O exemplo `create-probe` a seguir cria uma sonda que usa o `protocol` `ICMP` e adiciona a sonda a um monitor chamado `Example_NetworkMonitor`. Uma vez criado, o `state` do monitor com a sonda permanecerá como `PENDING` até que o monitor esteja `ACTIVE`. Isso pode levar alguns minutos, quando então state mudará para `ACTIVE`, e será possível visualizar as métricas do CloudWatch. ``` aws networkmonitor create-probe \ --monitor-name Example_NetworkMonitor \ --probe sourceArn=arn:aws:ec2:region:012345678910:subnet/subnet-id,destination=10.0.0.100,protocol=ICMP,packetSize=56,tags={Name=Probe1} ``` Resultado: ``` { "probeId": "probe-12345", "probeArn": "arn:aws:networkmonitor:region:111122223333:probe/probe-12345", "destination": "10.0.0.100", "packetSize": 56, "addressFamily": "IPV4", "vpcId": "vpc-12345", "state": "PENDING", "createdAt": "2024-03-29T12:44:02.452000-04:00", "modifiedAt": "2024-03-29T12:44:02.452000-04:00", "tags": { "Name": "Probe1" } } ``` Para obter mais informações, consulte [Como o Monitor de Rede do Amazon CloudWatch funciona](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [CreateProbe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmonitor/create-probe.html) na *Referência de comandos da AWS CLI*. ### `delete-monitor` O código de exemplo a seguir mostra como usar `delete-monitor`. **AWS CLI** **Para excluir um monitor** O exemplo `delete-monitor` a seguir exclui um monitor chamado `Example_NetworkMonitor`. ``` aws networkmonitor delete-monitor \ --monitor-name Example_NetworkMonitor ``` Este comando não produz saída. Para obter mais informações, consulte [Como o Monitor de Rede do Amazon CloudWatch funciona](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [DeleteMonitor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmonitor/delete-monitor.html) na *Referência de comandos da AWS CLI*. ### `delete-probe` O código de exemplo a seguir mostra como usar `delete-probe`. **AWS CLI** **Para excluir uma sonda** O exemplo `delete-probe` a seguir exclui uma sonda com o ID `probe-12345` de um monitor de rede chamado `Example_NetworkMonitor`. ``` aws networkmonitor delete-probe \ --monitor-name Example_NetworkMonitor \ --probe-id probe-12345 ``` Este comando não produz saída. Para obter mais informações, consulte [Como o Monitor de Rede do Amazon CloudWatch funciona](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [DeleteProbe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmonitor/delete-probe.html) na *Referência de comandos AWS CLI*. ### `get-monitor` O código de exemplo a seguir mostra como usar `get-monitor`. **AWS CLI** **Para obter informações sobre o monitor** O exemplo `get-monitor` a seguir obtém informações sobre o monitor chamado `Example_NetworkMonitor`. ``` aws networkmonitor get-monitor \ --monitor-name Example_NetworkMonitor ``` Resultado: ``` { "monitorArn": "arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor", "monitorName": "Example_NetworkMonitor", "state": "ACTIVE", "aggregationPeriod": 60, "tags": {}, "probes": [], "createdAt": "2024-04-01T17:58:07.211000-04:00", "modifiedAt": "2024-04-01T17:58:07.211000-04:00" } ``` Para obter mais informações, consulte [Como o Monitor de Rede do Amazon CloudWatch funciona](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [GetMonitor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmonitor/get-monitor.html) na *Referência de comandos da AWS CLI*. ### `get-probe` O código de exemplo a seguir mostra como usar `get-probe`. **AWS CLI** **Como visualizar os detalhes da sonda** O exemplo `get-probe` a seguir retorna detalhes sobre uma sonda associada ao `probeID` `probe-12345`, que está associado a um monitor chamado `Example_NetworkMonitor`. ``` aws networkmonitor get-probe \ --monitor-name Example_NetworkMonitor \ --probe-id probe-12345 ``` Resultado: ``` { "probeId": "probe-12345", "probeArn": "arn:aws:networkmonitor:region:012345678910:probe/probe-12345", "sourceArn": "arn:aws:ec2:region:012345678910:subnet/subnet-12345", "destination": "10.0.0.100", "destinationPort": 80, "protocol": "TCP", "packetSize": 56, "addressFamily": "IPV4", "vpcId": "vpc-12345", "state": "ACTIVE", "createdAt": "2024-03-29T12:41:57.314000-04:00", "modifiedAt": "2024-03-29T12:42:28.610000-04:00", "tags": { "Name": "Probe1" } } ``` Para obter mais informações, consulte [Como o Monitor de Rede do Amazon CloudWatch funciona](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [GetProbe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmonitor/get-probe.html) na *Referência de comandos da AWS CLI*. ### `list-monitors` O código de exemplo a seguir mostra como usar `list-monitors`. **AWS CLI** **Exemplo 1: listar todos os monitores (monitor único)** O exemplo `list-monitors` a seguir retorna uma lista de apenas um único monitor. O monitor `state` está `ACTIVE` e tem um `aggregationPeriod` de 60 segundos. ``` aws networkmonitor list-monitors ``` Resultado: ``` { "monitors": [{ "monitorArn": "arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor", "monitorName": "Example_NetworkMonitor", "state": "ACTIVE", "aggregationPeriod": 60, "tags": { "Monitor": "Monitor1" } } ] } ``` Para obter mais informações, consulte [Como o Monitor de Rede do Amazon CloudWatch funciona](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html) no *Guia do usuário do Amazon CloudWatch*. **Exemplo 2: listar todos os monitores (vários monitores)** O exemplo `list-monitors` a seguir retorna uma lista com três monitores. O `state` de um monitor é `ACTIVE`, e ele está gerando métricas do CloudWatch. O estado dos outros dois monitores é `INACTIVE`, e eles não geram métricas do CloudWatch. Os três monitores usam um `aggregationPeriod` de 60 segundos. ``` aws networkmonitor list-monitors ``` Resultado: ``` { "monitors": [ { "monitorArn": "arn:aws:networkmonitor:us-east-1:111122223333:monitor/Example_NetworkMonitor", "monitorName": "Example_NetworkMonitor", "state": "INACTIVE", "aggregationPeriod": 60, "tags": {} }, { "monitorArn": "arn:aws:networkmonitor:us-east-1:111122223333:monitor/Example_NetworkMonitor2", "monitorName": "Example_NetworkMonitor2", "state": "ACTIVE", "aggregationPeriod": 60, "tags": { "Monitor": "Monitor1" } }, { "monitorArn": "arn:aws:networkmonitor:us-east-1:111122223333:monitor/TestNetworkMonitor_CLI", "monitorName": "TestNetworkMonitor_CLI", "state": "INACTIVE", "aggregationPeriod": 60, "tags": {} } ] } ``` Para obter mais informações, consulte [Como o Monitor de Rede do Amazon CloudWatch funciona](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [ListMonitors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmonitor/list-monitors.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar as tags para um recurso** O exemplo `list-tags-for-resource` a seguir retorna uma lista das tags do monitor chamado `Example_NetworkMonitor`. ``` aws networkmonitor list-tags-for-resource \ --resource-arn arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor ``` Resultado: ``` { "tags": { "Environment": "Dev", "Application": "PetStore" } } ``` Para obter mais informações, consulte [Como o Monitor de Rede do Amazon CloudWatch funciona](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html) no *Guia do usuário do Amazon CloudWatch*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmonitor/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como marcar um recurso** O exemplo `tag-resource` a seguir marca um monitor chamado `Example_NetworkMonitor` com as tags `Environment=Dev` e `Application=PetStore`. ``` aws networkmonitor tag-resource \ --resource-arn arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor \ --tags Environment=Dev,Application=PetStore ``` Este comando não produz saída. Para obter mais informações, consulte [Como o Monitor de Rede do Amazon CloudWatch funciona](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmonitor/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Como desmarcar um recurso** O exemplo `untag-resource` a seguir remove um parâmetro `tag-keys` com o par de chave-valor `Environment Application` de sua associação com um monitor chamado `Example_NetworkMonitor`. ``` aws networkmonitor untag-resource \ --resource-arn arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor \ --tag-keys Environment Application ``` Este comando não produz saída. Para obter mais informações, consulte [Como o Monitor de Rede do Amazon CloudWatch funciona](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html) no *Guia do usuário do Amazon CloudWatch*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmonitor/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-monitor` O código de exemplo a seguir mostra como usar `update-monitor`. **AWS CLI** **Para atualizar um monitor** O exemplo `update-monitor` a seguir altera o `aggregationPeriod` de um monitor de `60` segundos para `30` segundos. ``` aws networkmonitor update-monitor \ --monitor-name Example_NetworkMonitor \ --aggregation-period 30 ``` Resultado: ``` { "monitorArn": "arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor", "monitorName": "Example_NetworkMonitor", "state": "PENDING", "aggregationPeriod": 30, "tags": { "Monitor": "Monitor1" } } ``` Para obter mais informações, consulte [Como o Monitor de Rede do Amazon CloudWatch funciona](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [UpdateMonitor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmonitor/update-monitor.html) na *Referência de comandos da AWS CLI*. ### `update-probe` O código de exemplo a seguir mostra como usar `update-probe`. **AWS CLI** **Para atualizar uma sonda** O exemplo `update-probe` a seguir atualiza o endereço IP de `destination` original de uma sonda e também atualiza o `packetSize` para `60`. ``` aws networkmonitor update-probe \ --monitor-name Example_NetworkMonitor \ --probe-id probe-12345 \ --destination 10.0.0.150 \ --packet-size 60 ``` Resultado: ``` { "probeId": "probe-12345", "probeArn": "arn:aws:networkmonitor:region:012345678910:probe/probe-12345", "sourceArn": "arn:aws:ec2:region:012345678910:subnet/subnet-12345", "destination": "10.0.0.150", "destinationPort": 80, "protocol": "TCP", "packetSize": 60, "addressFamily": "IPV4", "vpcId": "vpc-12345", "state": "PENDING", "createdAt": "2024-03-29T12:41:57.314000-04:00", "modifiedAt": "2024-03-29T13:52:23.115000-04:00", "tags": { "Name": "Probe1" } } ``` Para obter mais informações, consulte [Como o Monitor de Rede do Amazon CloudWatch funciona](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [UpdateProbe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmonitor/update-probe.html) na *Referência de comandos da AWS CLI*. # Exemplos do CloudWatch Observability Access Monitor usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o CloudWatch Observability Access Monitor. *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 ### `create-link` O código de exemplo a seguir mostra como usar `create-link`. **AWS CLI** **Como criar um vínculo** O exemplo de `create-link` a seguir cria um vínculo entre uma conta de origem e um coletor que você criou em uma conta de monitoramento. ``` aws oam create-link \ --label-template sourceAccount \ --resource-types AWS::CloudWatch::Metric \ --sink-identifier arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345 ``` Resultado: ``` { "Arn": "arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111", "Id": "a1b2c3d4-5678-90ab-cdef-example11111", "Label": "sourceAccount", "LabelTemplate": "sourceAccount", "ResourceTypes": [ "AWS::CloudWatch::Metric" ], "SinkArn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345", "Tags": {} } ``` Consulte mais informações em [Observabilidade entre contas do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [CreateLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/create-link.html) na *Referência de comandos da AWS CLI*. ### `create-sink` O código de exemplo a seguir mostra como usar `create-sink`. **AWS CLI** **Como criar um coletor** O exemplo de `create-sink` a seguir cria um coletor na conta atual para que ele possa ser usado como uma conta de monitoramento na observabilidade entre contas do CloudWatch. ``` aws oam create-sink \ --name DemoSink ``` Resultado: ``` { "Arn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345", "Id": "a1b2c3d4-5678-90ab-cdef-example12345", "Name": "DemoSink", "Tags": {} } ``` Consulte mais informações em [Observabilidade entre contas do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [CreateSink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/create-sink.html) na *Referência de comandos da AWS CLI*. ### `delete-link` O código de exemplo a seguir mostra como usar `delete-link`. **AWS CLI** **Como excluir um vínculo** O exemplo de `delete-link` a seguir exclui um vínculo entre um coletor da conta de monitoramento e uma conta de origem. ``` aws oam delete-link \ --identifier arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111 ``` Este comando não produz saída. Consulte mais informações em [Observabilidade entre contas do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [DeleteLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/delete-link.html) na *Referência de comandos da AWS CLI*. ### `delete-sink` O código de exemplo a seguir mostra como usar `delete-sink`. **AWS CLI** **Como excluir um coletor** O exemplo de `delete-sink` a seguir exclui um coletor. Você deve excluir todos os vínculos de um coletor para poder excluí-lo. ``` aws oam delete-sink \ --identifier arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345 ``` Este comando não produz saída. Consulte mais informações em [Observabilidade entre contas do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [DeleteSink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/delete-sink.html) na *Referência de comandos da AWS CLI*. ### `get-link` O código de exemplo a seguir mostra como usar `get-link`. **AWS CLI** **Como retornar informações completas sobre um vínculo** O exemplo de `get-link` a seguir retorna informações completas sobre um vínculo. ``` aws oam get-link \ --identifier arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111 ``` Resultado: ``` { "Arn": "arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111", "Id": "a1b2c3d4-5678-90ab-cdef-example11111", "Label": "sourceAccount", "LabelTemplate": "sourceAccount", "ResourceTypes": [ "AWS::CloudWatch::Metric" ], "SinkArn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345", "Tags": {} } ``` Consulte mais informações em [Observabilidade entre contas do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [GetLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/get-link.html) na *Referência de comandos da AWS CLI*. ### `get-sink-policy` O código de exemplo a seguir mostra como usar `get-sink-policy`. **AWS CLI** **Como retornar a política de coletor atual anexada ao coletor** O exemplo de `get-sink-policy` a seguir retorna a política de coletor atual anexada ao coletor. ``` aws oam get-sink-policy \ --sink-identifier arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345 ``` Resultado: ``` { "SinkArn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345", "SinkId": "a1b2c3d4-5678-90ab-cdef-example12345", "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789111:root\"},\"Action\":[\"oam:CreateLink\",\"oam:UpdateLink\"],\"Resource\":\"*\",\"Condition\":{\"ForAllValues:StringEquals\":{\"oam:ResourceTypes\":[\"AWS::Logs::LogGroup\",\"AWS::CloudWatch::Metric\",\"AWS::XRay::Trace\",\"AWS::ApplicationInsights::Application\"]}}}]}" } ``` Consulte mais informações em [Observabilidade entre contas do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [GetSinkPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/get-sink-policy.html) na *Referência de comandos da AWS CLI*. ### `get-sink` O código de exemplo a seguir mostra como usar `get-sink`. **AWS CLI** **Como retornar informações completas sobre um vínculo da conta de monitoramento** O exemplo de `get-sink` a seguir retorna informações completas sobre um coletor da conta de monitoramento. ``` aws oam get-sink \ --identifier arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345 ``` Resultado: ``` { "Arn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345", "Id": "a1b2c3d4-5678-90ab-cdef-example12345", "Name": "DemoSink", "Tags": {} } ``` Consulte mais informações em [Observabilidade entre contas do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [GetSink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/get-sink.html) na *Referência de comandos da AWS CLI*. ### `list-attached-links` O código de exemplo a seguir mostra como usar `list-attached-links`. **AWS CLI** **Como retornar uma lista de vínculos de contas de origem com esse coletor da conta de monitoramento** O exemplo de `list-attached-links` a seguir retorna uma lista de vínculos de contas de origem com esse coletor da conta de monitoramento. ``` aws oam list-attached-links \ --sink-identifier arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345 ``` Resultado: ``` { "Items": [{ "Label": "Monitoring account", "LinkArn": "arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111", "ResourceTypes": [ "AWS::ApplicationInsights::Application", "AWS::Logs::LogGroup", "AWS::CloudWatch::Metric", "AWS::XRay::Trace" ] }] } ``` Consulte mais informações em [Observabilidade entre contas do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [ListAttachedLinks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/list-attached-links.html) na *Referência de comandos da AWS CLI*. ### `list-links` O código de exemplo a seguir mostra como usar `list-links`. **AWS CLI** **Como retornar uma lista de vínculos para um coletor da conta de monitoramento** O exemplo de `list-links` a seguir retorna uma lista de vínculos para um coletor da conta de monitoramento. Execute essa operação em uma conta de origem para retornar uma lista de vínculos para coletores das contas de monitoramento que essa conta de origem possui. ``` aws oam list-links ``` Resultado: ``` { "Items": [{ "Arn": "arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111", "Id": "a1b2c3d4-5678-90ab-cdef-example11111", "Label": "sourceAccount", "ResourceTypes": [ "AWS::CloudWatch::Metric" ], "SinkArn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345" }] } ``` Consulte mais informações em [Observabilidade entre contas do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [ListLinks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/list-links.html) na *Referência de comandos da AWS CLI*. ### `list-sinks` O código de exemplo a seguir mostra como usar `list-sinks`. **AWS CLI** **Como retornar a lista de coletores criados na conta de monitoramento** O exemplo de `list-sinks` a seguir retorna uma lista de coletores criados na conta de monitoramento. Execute essa operação em uma conta de monitoramento. ``` aws oam list-sinks ``` Resultado: ``` { "Items": [ { "Arn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345", "Id": "a1b2c3d4-5678-90ab-cdef-example12345", "Name": "DemoSink" } ] } ``` Consulte mais informações em [Observabilidade entre contas do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [ListSinks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/list-sinks.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Como exibir as tags associadas a um recurso** O exemplo de `list-tags-for-resource` a seguir exibe as tags associadas a um coletor. ``` aws oam list-tags-for-resource \ --resource-arn arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345 ``` Resultado: ``` { "Tags": { "Team": "Devops" } } ``` Consulte mais informações em [Observabilidade entre contas do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) no *Guia do usuário do Amazon CloudWatch*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `put-sink-policy` O código de exemplo a seguir mostra como usar `put-sink-policy`. **AWS CLI** **Como criar ou atualizar a política de recursos** O exemplo de `put-sink-policy` a seguir cria a política de recursos que concede permissões às contas de origem para se vincularem ao coletor da conta de monitoramento. ``` aws oam put-sink-policy \ --policy '{"Version":"2012-10-17", "Statement":[{"Effect":"Allow","Principal":{"AWS":"arn:aws:iam::123456789111:root"},"Action":["oam:CreateLink","oam:UpdateLink"],"Resource":"*","Condition":{"ForAllValues:StringEquals":{"oam:ResourceTypes":["AWS::Logs::LogGroup","AWS::CloudWatch::Metric","AWS::XRay::Trace","AWS::ApplicationInsights::Application"]}}}]}' \ --sink-identifier arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345 ``` Resultado: ``` { "SinkArn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345", "SinkId": "a1b2c3d4-5678-90ab-cdef-example12345", "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789111:root\"},\"Action\":[\"oam:CreateLink\",\"oam:UpdateLink\"],\"Resource\":\"*\",\"Condition\":{\"ForAllValues:StringEquals\":{\"oam:ResourceTypes\":[\"AWS::Logs::LogGroup\",\"AWS::CloudWatch::Metric\",\"AWS::XRay::Trace\",\"AWS::ApplicationInsights::Application\"]}}}]}" } ``` Consulte mais informações em [Observabilidade entre contas do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [PutSinkPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/put-sink-policy.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como atribuir uma ou mais tags ao recurso especificado** O exemplo de `tag-resource` a seguir marca um coletor `arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345`. ``` aws oam tag-resource \ --resource-arn arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345 \ --tags team=Devops ``` Este comando não produz saída. Consulte mais informações em [Observabilidade entre contas do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Como remover uma ou mais tags do recurso especificado.** O exemplo de `untag-resource` a seguir remove uma tag com a chave `team` do coletor `arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345`. ``` aws oam untag-resource \ --resource-arn arn:aws:oam:us-east-2:123456789012:sink/f3f42f60-f0f2-425c-1234-12347bdd821f \ --tag-keys team ``` Este comando não produz saída. Consulte mais informações em [Observabilidade entre contas do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) no *Guia do usuário do Amazon CloudWatch*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-link` O código de exemplo a seguir mostra como usar `update-link`. **AWS CLI** **Como alterar quais tipos de dados são compartilhados de uma conta de origem para o coletor da conta de monitoramento vinculada** O exemplo de `update-link` a seguir atualiza o vínculo de `arn:aws:oam:us-east-2:123456789111:link/0123e691-e7ef-43fa-1234-c57c837fced0` com os tipos de recursos `AWS::CloudWatch::Metric` e `AWS::Logs::LogGroup`. ``` aws oam update-link \ --identifier arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111 \ --resource-types "AWS::CloudWatch::Metric" "AWS::Logs::LogGroup" ``` Resultado: ``` { "Arn": "arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111", "Id": "a1b2c3d4-5678-90ab-cdef-example11111", "Label": "sourceAccount", "LabelTemplate": "sourceAccount", "ResourceTypes": [ "AWS::CloudWatch::Metric", "AWS::Logs::LogGroup" ], "SinkArn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345", "Tags": {} } ``` Consulte mais informações em [Observabilidade entre contas do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [UpdateLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/update-link.html) na *Referência de comandos da AWS CLI*. # Exemplos do CloudWatch Observability Admin usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o CloudWatch Observability Admin. *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-telemetry-evaluation-status-for-organization` O código de exemplo a seguir mostra como usar `get-telemetry-evaluation-status-for-organization`. **AWS CLI** **Como obter o status de integração de telemetria para a organização** O exemplo de `get-telemetry-evaluation-status-for-organization` a seguir retorna o status atual de integração do recurso de configuração de telemetria da organização. ``` aws observabilityadmin get-telemetry-evaluation-status-for-organization ``` Resultado: ``` { "Status": "RUNNING" } ``` Consulte mais informações em [Auditar as configurações de telemetria do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-cloudwatch.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [GetTelemetryEvaluationStatusForOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/observabilityadmin/get-telemetry-evaluation-status-for-organization.html) na *Referência de comandos da AWS CLI*. ### `get-telemetry-evaluation-status` O código de exemplo a seguir mostra como usar `get-telemetry-evaluation-status`. **AWS CLI** **Como obter o status de integração de telemetria para a conta** O exemplo de `get-telemetry-evaluation-status` a seguir retorna o status atual de integração do recurso de configuração de telemetria na conta especificada. ``` aws observabilityadmin get-telemetry-evaluation-status ``` Resultado: ``` { "Status": "RUNNING" } ``` Consulte mais informações em [Auditar as configurações de telemetria do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-cloudwatch.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [GetTelemetryEvaluationStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/observabilityadmin/get-telemetry-evaluation-status.html) na *Referência de comandos da AWS CLI*. ### `list-resource-telemetry-for-organization` O código de exemplo a seguir mostra como usar `list-resource-telemetry-for-organization`. **AWS CLI** **Como recuperar as configurações de telemetria da organização** O exemplo de `list-resource-telemetry-for-organization` a seguir retorna uma lista de configurações de telemetria na organização para recursos da AWS compatíveis com a configuração de telemetria. ``` aws observabilityadmin list-resource-telemetry-for-organization \ --resource-types AWS::EC2::Instance ``` Resultado: ``` { "TelemetryConfigurations": [ { "AccountIdentifier": "111111111111", "TelemetryConfigurationState": { "Logs": "NotApplicable", "Metrics": "Disabled", "Traces": "NotApplicable" }, "ResourceType": "AWS::EC2::Instance", "ResourceIdentifier": "i-a166400b", "ResourceTags": { "Name": "dev" }, "LastUpdateTimeStamp": 1733168548521 }, { "AccountIdentifier": "222222222222", "TelemetryConfigurationState": { "Logs": "NotApplicable", "Metrics": "Disabled", "Traces": "NotApplicable" }, "ResourceType": "AWS::EC2::Instance", "ResourceIdentifier": "i-b188560f", "ResourceTags": { "Name": "apache" }, "LastUpdateTimeStamp": 1732744260182 } ] } ``` Consulte mais informações em [Auditar as configurações de telemetria do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-cloudwatch.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [ListResourceTelemetryForOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/observabilityadmin/list-resource-telemetry-for-organization.html) na *Referência de comandos da AWS CLI*. ### `list-resource-telemetry` O código de exemplo a seguir mostra como usar `list-resource-telemetry`. **AWS CLI** **Como recuperar as configurações de telemetria da conta** O exemplo de `list-resource-telemetry` a seguir retorna uma lista de configurações de telemetria para recursos da AWS compatíveis com a configuração de telemetria na conta especificada. ``` aws observabilityadmin list-resource-telemetry \ --resource-types AWS::EC2::Instance ``` Resultado: ``` { "TelemetryConfigurations": [ { "AccountIdentifier": "111111111111", "TelemetryConfigurationState": { "Logs": "NotApplicable", "Metrics": "Disabled", "Traces": "NotApplicable" }, "ResourceType": "AWS::EC2::Instance", "ResourceIdentifier": "i-0e979d278b040f856", "ResourceTags": { "Name": "apache" }, "LastUpdateTimeStamp": 1732744260182 } ] } ``` Consulte mais informações em [Auditar as configurações de telemetria do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-cloudwatch.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [ListResourceTelemetry](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/observabilityadmin/list-resource-telemetry.html) na *Referência de comandos da AWS CLI*. ### `start-telemetry-evaluation-for-organization` O código de exemplo a seguir mostra como usar `start-telemetry-evaluation-for-organization`. **AWS CLI** **Como habilitar o recurso de configuração de telemetria** O exemplo de `start-telemetry-evaluation-for-organization` a seguir habilita o recurso de configuração de telemetria da organização. ``` aws observabilityadmin start-telemetry-evaluation-for-organization ``` Este comando não produz saída. Consulte mais informações em [Ativar a auditoria de telemetria do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-turn-on.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [StartTelemetryEvaluationForOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/observabilityadmin/start-telemetry-evaluation-for-organization.html) na *Referência de comandos da AWS CLI*. ### `start-telemetry-evaluation` O código de exemplo a seguir mostra como usar `start-telemetry-evaluation`. **AWS CLI** **Como habilitar o recurso de configuração de telemetria** O exemplo de `start-telemetry-evaluation` a seguir habilita o recurso de configuração de telemetria na conta especificada. ``` aws observabilityadmin start-telemetry-evaluation ``` Este comando não produz saída. Consulte mais informações em [Ativar a auditoria de telemetria do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-turn-on.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [StartTelemetryEvaluation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/observabilityadmin/start-telemetry-evaluation.html) na *Referência de comandos da AWS CLI*. ### `stop-telemetry-evaluation-for-organization` O código de exemplo a seguir mostra como usar `stop-telemetry-evaluation-for-organization`. **AWS CLI** **Como desabilitar o recurso de configuração de telemetria** O exemplo de `stop-telemetry-evaluation-for-organization` a seguir desabilita o recurso de configuração de telemetria da organização. ``` aws observabilityadmin stop-telemetry-evaluation-for-organization ``` Este comando não produz saída. Consulte mais informações em [Desativar a auditoria de telemetria do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-turn-off.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [StopTelemetryEvaluationForOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/observabilityadmin/stop-telemetry-evaluation-for-organization.html) na *Referência de comandos da AWS CLI*. ### `stop-telemetry-evaluation` O código de exemplo a seguir mostra como usar `stop-telemetry-evaluation`. **AWS CLI** **Como desabilitar o recurso de configuração de telemetria** O exemplo de `stop-telemetry-evaluation` a seguir desabilita o recurso de configuração de telemetria na conta especificada. ``` aws observabilityadmin stop-telemetry-evaluation ``` Este comando não produz saída. Consulte mais informações em [Desativar a auditoria de telemetria do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-turn-off.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [StopTelemetryEvaluation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/observabilityadmin/stop-telemetry-evaluation.html) na *Referência de comandos da AWS CLI*. # Exemplos do CloudWatch Synthetics usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o CloudWatch Synthetics. *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 ### `associate-resource` O código de exemplo a seguir mostra como usar `associate-resource`. **AWS CLI** **Como associar um canário a um grupo** O exemplo de `associate-resource` a seguir associa um canário a um grupo chamado `demo_group`. ``` aws synthetics associate-resource \ --group-identifier demo_group \ --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary ``` Este comando não produz saída. Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [AssociateResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/associate-resource.html) na *Referência de comandos da AWS CLI*. ### `create-canary` O código de exemplo a seguir mostra como usar `create-canary`. **AWS CLI** **Como criar um canário** O exemplo de `create-canary` a seguir cria um canário chamado `demo_canary`. ``` aws synthetics create-canary \ --name demo_canary \ --code '{"S3Bucket": "artifacts3bucket", "S3Key":"demo_canary.zip", "Handler": "index.lambda_handler"}' \ --artifact-s3-location s3://amzn-s3-demo-bucket/demo_canary.zip \ --execution-role-arn arn:aws:iam::123456789012:role/demo_canary_role \ --schedule Expression="rate(10 minutes)" \ --runtime-version syn-nodejs-puppeteer-9.1 ``` Resultado: ``` { "Canary": { "Id": "a1b2c3d4-5678-90ab-cdef-example11111", "Name": "demo_canary", "Code": { "Handler": "index.lambda_handler" }, "ExecutionRoleArn": "arn:aws:iam::123456789012:role/demo_canary_role", "Schedule": { "Expression": "rate(10 minutes)", "DurationInSeconds": 0 }, "RunConfig": { "TimeoutInSeconds": 600, "MemoryInMB": 1000, "ActiveTracing": false }, "SuccessRetentionPeriodInDays": 31, "FailureRetentionPeriodInDays": 31, "Status": { "State": "CREATING", "StateReasonCode": "CREATE_PENDING" }, "Timeline": { "Created": "2024-10-15T19:03:08.826000+05:30", "LastModified": "2024-10-15T19:03:08.826000+05:30" }, "ArtifactS3Location": "amzn-s3-demo-bucket/demo_canary.zip", "RuntimeVersion": "syn-nodejs-puppeteer-9.1", "Tags": {} } } ``` Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [CreateCanary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/create-canary.html) na *Referência de comandos da AWS CLI*. ### `create-group` O código de exemplo a seguir mostra como usar `create-group`. **AWS CLI** **Para criar um grupo** O exemplo `create-group` a seguir cria um grupo chamado `demo_group`. ``` aws synthetics create-group \ --name demo_group ``` Resultado: ``` { "Group": { "Id": "example123", "Name": "demo_group", "Arn": "arn:aws:synthetics:us-east-1:123456789012:group:example123", "Tags": {}, "CreatedTime": "2024-10-15T14:47:23.811000+05:30", "LastModifiedTime": "2024-10-15T14:47:23.811000+05:30" } } ``` Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [CreateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/create-group.html) na *Referência de comandos da AWS CLI*. ### `delete-canary` O código de exemplo a seguir mostra como usar `delete-canary`. **AWS CLI** **Como excluir permanentemente um canário** O exemplo de `delete-canary` a seguir exclui um canário chamado `demo_canary`. ``` aws synthetics delete-canary \ --name demo_canary ``` Este comando não produz saída. Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [DeleteCanary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/delete-canary.html) na *Referência de comandos da AWS CLI*. ### `delete-group` O código de exemplo a seguir mostra como usar `delete-group`. **AWS CLI** **Para excluir um grupo** O exemplo de `delete-group` a seguir exclui um grupo chamado `demo_group`. ``` aws synthetics delete-group \ --group-identifier demo_group ``` Este comando não produz saída. Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [DeleteGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/delete-group.html) na *Referência de comandos da AWS CLI*. ### `describe-canaries-last-run` O código de exemplo a seguir mostra como usar `describe-canaries-last-run`. **AWS CLI** **Como ver informações da execução mais recente de cada canário** O exemplo de `describe-canaries-last-run` a seguir retorna a execução mais recente de cada canário que você criou. ``` aws synthetics describe-canaries-last-run ``` Resultado: ``` { "CanariesLastRun": [ { "CanaryName": "demo_canary", "LastRun": { "Id": "a1b2c3d4-5678-90ab-cdef-example11111", "Name": "demo_canary", "Status": { "State": "PASSED", "StateReason": "", "StateReasonCode": "" }, "Timeline": { "Started": "2024-10-15T19:20:39.691000+05:30", "Completed": "2024-10-15T19:20:58.211000+05:30" }, "ArtifactS3Location": "cw-syn-results-123456789012-us-east-1/canary/us-east-1/demo_canary-abc-example1234/2024/10/15/13/50-39-690" } } ] } ``` Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [DescribeCanariesLastRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/describe-canaries-last-run.html) na *Referência de comandos da AWS CLI*. ### `describe-canaries` O código de exemplo a seguir mostra como usar `describe-canaries`. **AWS CLI** **Como listar canários em sua conta** O exemplo de `describe-canaries` a seguir lista os detalhes de canários em sua conta. ``` aws synthetics describe-canaries ``` Resultado: ``` { "Canaries": [ { "Id": "a1b2c3d4-5678-90ab-cdef-example11111", "Name": "demo_canary", "Code": { "SourceLocationArn": "arn:aws:lambda:us-east-1:123456789012:layer:cwsyn-demo_canary-a1b2c3d4-5678-90ab-cdef-example11111b8:1", "Handler": "pageLoadBlueprint.handler" }, "ExecutionRoleArn": "arn:aws:iam::123456789012:role/service-role/CloudWatchSyntheticsRole-demo_canary-a12-a123bc456789", "Schedule": { "Expression": "rate(5 minutes)", "DurationInSeconds": 0 }, "RunConfig": { "TimeoutInSeconds": 300, "MemoryInMB": 1000, "ActiveTracing": false }, "SuccessRetentionPeriodInDays": 31, "FailureRetentionPeriodInDays": 31, "Status": { "State": "RUNNING" }, "Timeline": { "Created": "2024-10-15T18:55:15.168000+05:30", "LastModified": "2024-10-15T18:55:40.540000+05:30", "LastStarted": "2024-10-15T18:55:40.540000+05:30" }, "ArtifactS3Location": "cw-syn-results-123456789012-us-east-1/canary/us-east-1/demo_canary-a12-a123bc456789", "EngineArn": "arn:aws:lambda:us-east-1:123456789012:function:cwsyn-demo_canary-a1b2c3d4-5678-90ab-cdef-example111118:1", "RuntimeVersion": "syn-nodejs-puppeteer-9.1", "Tags": { "blueprint": "heartbeat" } } ] } ``` Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [DescribeCanaries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/describe-canaries.html) na *Referência de comandos da AWS CLI*. ### `describe-runtime-versions` O código de exemplo a seguir mostra como usar `describe-runtime-versions`. **AWS CLI** **Como retornar uma lista de versões de runtime do canário do Synthetics** O exemplo de `describe-runtime-versions` a seguir retorna a lista de versões de runtime do canário do Synthetics. ``` aws synthetics describe-runtime-versions ``` Resultado: ``` { "RuntimeVersions": [ { "VersionName": "syn-nodejs-puppeteer-9.1", "Description": "Security fixes and bug fix for date range error in har. Dependencies: Node JS 20.x, Puppeteer-core 22.12.1, Chromium 126.0.6478.126", "ReleaseDate": "2024-10-02T05:30:00+05:30" }, { "VersionName": "syn-nodejs-puppeteer-9.0", "Description": "Upgraded Chromium and Puppeteer. Dependencies: Node JS 20.x, Puppeteer-core 22.12.1, Chromium 126.0.6478.126", "ReleaseDate": "2024-07-22T05:30:00+05:30" }, { "VersionName": "syn-nodejs-puppeteer-8.0", "Description": "Upgraded Chromium and Puppeteer. Dependencies: Node JS 20.x, Puppeteer-core 22.10.0, Chromium 125.0.6422.112", "ReleaseDate": "2024-06-21T05:30:00+05:30" }, { "VersionName": "syn-nodejs-puppeteer-7.0", "Description": "Upgraded Chromium and Puppeteer. Dependencies: Node JS 18.x, Puppeteer-core 21.9.0, Chromium 121.0.6167.139", "ReleaseDate": "2024-03-08T05:30:00+05:30" }, { "VersionName": "syn-nodejs-puppeteer-6.2", "Description": "Updated shared libraries for Chromium and added ephemeral storage monitoring. Dependencies: Node JS 18.x, Puppeteer-core 19.7.0, Chromium 111.0.5563.146", "ReleaseDate": "2024-02-02T05:30:00+05:30" }, { "VersionName": "syn-nodejs-puppeteer-6.1", "Description": "Added puppeteer launch retry. Dependencies: Node JS 18.x, Puppeteer-core 19.7.0, Chromium 111.0.5563.146", "ReleaseDate": "2023-11-13T05:30:00+05:30", "DeprecationDate": "2024-03-08T13:30:00+05:30" }, { "VersionName": "syn-nodejs-puppeteer-6.0", "Description": "Reduced X-Ray traces of a canary run, improved duration metric and upgraded to NodeJS 18.x. Dependencies: Node JS 18.x, Puppeteer-core 19.7.0, Chromium 111.0.5563.146", "ReleaseDate": "2023-09-15T05:30:00+05:30", "DeprecationDate": "2024-03-08T13:30:00+05:30" }, { "VersionName": "syn-nodejs-puppeteer-5.2", "Description": "Updated shared libraries for Chromium. Dependencies: Node JS 16.x, Puppeteer-core 19.7.0, Chromium 111.0.5563.146", "ReleaseDate": "2024-02-01T05:30:00+05:30" }, { "VersionName": "syn-nodejs-puppeteer-5.1", "Description": "Fixes a bug about missing request headers in har. Dependencies: Node JS 16.x, Puppeteer-core 19.7.0, Chromium 111.0.5563.146", "ReleaseDate": "2023-08-09T05:30:00+05:30", "DeprecationDate": "2024-03-08T13:30:00+05:30" }, { "VersionName": "syn-nodejs-puppeteer-5.0", "Description": "Upgraded Puppeteer and Chromium. Dependencies: Node JS 16.x, Puppeteer-core 19.7.0, Chromium 111.0.5563.146", "ReleaseDate": "2023-07-21T05:30:00+05:30", "DeprecationDate": "2024-03-08T13:30:00+05:30" }, { "VersionName": "syn-nodejs-puppeteer-4.0", "Description": "Upgraded to NodeJS 16.x. Dependencies: Node JS 16.x, Puppeteer-core 5.5.0, Chromium 92.0.4512.0", "ReleaseDate": "2023-05-01T05:30:00+05:30", "DeprecationDate": "2024-03-08T13:30:00+05:30" } ] } ``` Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [DescribeRuntimeVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/describe-runtime-versions.html) na *Referência de comandos da AWS CLI*. ### `disassociate-resource` O código de exemplo a seguir mostra como usar `disassociate-resource`. **AWS CLI** **Como remover um canário de um grupo** O exemplo de `disassociate-resource` a seguir remove um canário do grupo chamado `demo_group`. ``` aws synthetics disassociate-resource \ --group-identifier demo_group \ --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary ``` Este comando não produz saída. Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [DisassociateResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/disassociate-resource.html) na *Referência de comandos da AWS CLI*. ### `get-canary-runs` O código de exemplo a seguir mostra como usar `get-canary-runs`. **AWS CLI** **Como recuperar uma lista de execuções para um canário especificado** O exemplo de `get-canary-runs` a seguir recupera uma lista de execuções do canário chamado `demo_canary`. ``` aws synthetics get-canary-runs \ --name demo_canary ``` Resultado: ``` { "CanaryRuns": [ { "Id": "a1b2c3d4-5678-90ab-cdef-example11111", "Name": "demo_canary", "Status": { "State": "PASSED", "StateReason": "", "StateReasonCode": "" }, "Timeline": { "Started": "2024-10-16T10:38:57.013000+05:30", "Completed": "2024-10-16T10:39:25.793000+05:30" }, "ArtifactS3Location": "cw-syn-results-123456789012-us-east-1/canary/us-east-1/demo_canary-abc-example1234/2024/10/15/13/50-39-690" } ] } ``` Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [GetCanaryRuns](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/get-canary-runs.html) na *Referência de comandos da AWS CLI*. ### `get-canary` O código de exemplo a seguir mostra como usar `get-canary`. **AWS CLI** **Como recuperar informações completas sobre um canário** O exemplo de `get-canary` a seguir recupera informações completas sobre o canário chamado `demo_canary`. ``` aws synthetics get-canary \ --name demo_canary ``` Resultado: ``` { "Canary": { "Id": "a1b2c3d4-5678-90ab-cdef-example11111", "Name": "demo_canary", "Code": { "SourceLocationArn": "arn:aws:lambda:us-east-1:123456789012:layer:cwsyn-demo_canary-a1b2c3d4-5678-90ab-cdef-example111118:1", "Handler": "pageLoadBlueprint.handler" }, "ExecutionRoleArn": "arn:aws:iam::123456789012:role/demo_canary_role", "Schedule": { "Expression": "rate(10 minutes)", "DurationInSeconds": 0 }, "RunConfig": { "TimeoutInSeconds": 300, "MemoryInMB": 1000, "ActiveTracing": false }, "SuccessRetentionPeriodInDays": 31, "FailureRetentionPeriodInDays": 31, "Status": { "State": "RUNNING" }, "Timeline": { "Created": "2024-10-15T18:55:15.168000+05:30", "LastModified": "2024-10-15T18:55:40.540000+05:30", "LastStarted": "2024-10-15T18:55:40.540000+05:30" }, "ArtifactS3Location": "cw-syn-results-123456789012-us-east-1/canary/us-east-1/demo_canary-a12-a123bc456789", "EngineArn": "arn:aws:lambda:us-east-1:123456789012:function:cwsyn-demo_canary-a1b2c3d4-5678-90ab-cdef-example111118:1", "RuntimeVersion": "syn-nodejs-puppeteer-9.1", "Tags": { "blueprint": "heartbeat" } } } ``` Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [GetCanary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/get-canary.html) na *Referência de comandos da AWS CLI*. ### `get-group` O código de exemplo a seguir mostra como usar `get-group`. **AWS CLI** **Como retornar informações sobre um grupo** O exemplo de `get-group` a seguir retorna informações sobre o grupo chamado `demo_group`. ``` aws synthetics get-group \ --group-identifier demo_group ``` Resultado: ``` { "Group": { "Id": "example123", "Name": "demo_group", "Arn": "arn:aws:synthetics:us-east-1:123456789012:group:example123", "Tags": {}, "CreatedTime": "2024-10-15T14:47:23.811000+05:30", "LastModifiedTime": "2024-10-15T14:47:23.811000+05:30" } } ``` Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [GetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/get-group.html) na *Referência de comandos da AWS CLI*. ### `list-associated-groups` O código de exemplo a seguir mostra como usar `list-associated-groups`. **AWS CLI** **Como retornar uma lista dos grupos** O exemplo de `list-associated-groups` a seguir retorna uma lista dos grupos associados ao canário chamado `demo_canary`. ``` aws synthetics list-associated-groups \ --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary ``` Resultado: ``` { "Groups": [ { "Id": "example123", "Name": "demo_group", "Arn": "arn:aws:synthetics:us-east-1:123456789012:group:example123" } ] } ``` Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [ListAssociatedGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/list-associated-groups.html) na *Referência de comandos da AWS CLI*. ### `list-group-resources` O código de exemplo a seguir mostra como usar `list-group-resources`. **AWS CLI** **Como retornar uma lista dos ARNs dos canários associados ao grupo especificado** O exemplo de `list-group-resources` a seguir retorna uma lista dos ARNs dos canários associados ao grupo chamado `demo_group`. ``` aws synthetics list-group-resources \ --group-identifier demo_group ``` Resultado: ``` { "Resources": [ "arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary" ] } ``` Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [ListGroupResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/list-group-resources.html) na *Referência de comandos da AWS CLI*. ### `list-groups` O código de exemplo a seguir mostra como usar `list-groups`. **AWS CLI** **Como retornar uma lista de todos os grupos na conta** O exemplo de `list-groups` a seguir retorna uma lista de todos os grupos na conta. ``` aws synthetics list-groups ``` Resultado: ``` { "Groups": [ { "Id": "example123", "Name": "demo_group", "Arn": "arn:aws:synthetics:us-east-1:123456789012:group:example123" } ] } ``` Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [ListGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/list-groups.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Exemplo 1: como exibir as tags associadas a um canário** O exemplo de `list-tags-for-resource` a seguir retorna as tags associadas a um canário chamado `demo_canary`. ``` aws synthetics list-tags-for-resource \ --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary ``` Resultado: ``` { "Tags": { "blueprint": "heartbeat" } } ``` **Exemplo 2: como exibir as tags associadas a um grupo** O exemplo de `list-tags-for-resource` a seguir retorna as tags associadas a um grupo chamado `demo_group`. ``` aws synthetics list-tags-for-resource \ --resource-arn arn:aws:synthetics:us-east-1:123456789012:group:example123 ``` Resultado: ``` { "Tags": { "team": "Devops" } } ``` Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `start-canary` O código de exemplo a seguir mostra como usar `start-canary`. **AWS CLI** **Como executar um canário** O exemplo de `start-canary` a seguir executa um canário chamado `demo_canary`. ``` aws synthetics start-canary \ --name demo_canary ``` Este comando não produz saída. Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [StartCanary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/start-canary.html) na *Referência de comandos da AWS CLI*. ### `stop-canary` O código de exemplo a seguir mostra como usar `stop-canary`. **AWS CLI** **Como interromper um canário** O exemplo de `stop-canary` a seguir interrompe o canário chamado `demo_canary`. ``` aws synthetics stop-canary \ --name demo_canary ``` Este comando não produz saída. Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [StopCanary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/stop-canary.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Exemplo 1: como atribuir uma tag ao canário** O exemplo de `tag-resource` a seguir atribui uma tag ao canário chamado `demo_canary`. ``` aws synthetics tag-resource \ --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary \ --tags blueprint=heartbeat ``` Este comando não produz saída. **Exemplo 2: como atribuir uma tag ao grupo** O exemplo de `tag-resource` a seguir atribui uma tag ao grupo chamado `demo_group`. ``` aws synthetics tag-resource \ --resource-arn arn:aws:synthetics:us-east-1:123456789012:group:example123 \ --tags team=Devops ``` Este comando não produz saída. Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Exemplo 1: como remover uma tag do canário** O exemplo de `untag-resource` a seguir remove uma tag do canário chamado `demo_canary`. ``` aws synthetics untag-resource \ --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary \ --tag-keys blueprint ``` Este comando não produz saída. **Exemplo 2: como remover uma tag do grupo** O exemplo de `untag-resource` a seguir remove uma tag do grupo chamado `demo_group`. ``` aws synthetics untag-resource \ --resource-arn arn:aws:synthetics:us-east-1:123456789012:group:example123 \ --tag-keys team ``` Este comando não produz saída. Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-canary` O código de exemplo a seguir mostra como usar `update-canary`. **AWS CLI** **Como atualizar um canário** O exemplo de `update-canary` a seguir atualiza a configuração de um canário chamado `demo_canary`. ``` aws synthetics update-canary \ --name demo_canary \ --schedule Expression="rate(15 minutes)" ``` Este comando não produz saída. Consulte mais informações em [Monitoramento do Synthetics (canários)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [UpdateCanary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/update-canary.html) na *Referência de comandos da AWS CLI*. # Exemplos do CodeArtifact usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o CodeArtifact. *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 ### `associate-external-connection` O código de exemplo a seguir mostra como usar `associate-external-connection`. **AWS CLI** **Para adicionar uma conexão externa a um repositório** O exemplo `associate-external-connection` a seguir adiciona uma conexão externa ao npmjs.com a um repositório chamado test-repo. ``` aws codeartifact associate-external-connection \ --repository test-repo \ --domain test-domain \ --external-connection public:npmjs ``` Resultado: ``` { "repository": { "name": "test-repo", "administratorAccount": "111122223333", "domainName": "test-domain", "domainOwner": "111122223333", "arn": "arn:aws:codeartifact:us-west-2:111122223333:repository/test-domain/test-repo", "upstreams": [], "externalConnections": [ { "externalConnectionName": "public:npmjs", "packageFormat": "npm", "status": "AVAILABLE" } ] } } ``` Para obter mais informações, consulte [Adicionar uma conexão externa](https://docs.aws.amazon.com/codeartifact/latest/ug/external-connection.html) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [AssociateExternalConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/associate-external-connection.html) na *Referência de comandos da AWS CLI*. ### `copy-package-versions` O código de exemplo a seguir mostra como usar `copy-package-versions`. **AWS CLI** **Como copiar versões de pacote de um repositório para outro** O `copy-package-versions` seguinte move as versões 4.0.0 e 5.0.0 de um pacote chamado test-package de my-repo para test-repo. ``` aws codeartifact copy-package-versions \ --domain test-domain \ --source-repository my-repo \ --destination-repository test-repo \ --format npm \ --package test-package \ --versions '["4.0.0", "5.0.0"]' ``` Resultado: ``` { "format": "npm", "package": "test-package", "versions": [ { "version": "5.0.0", "revision": "REVISION-1-SAMPLE-6C81EFF7DA55CC", "status": "Published" }, { "version": "4.0.0", "revision": "REVISION-2-SAMPLE-55C752BEE772FC", "status": "Published" } ] } ``` Para obter mais informações, consulte [Copiar pacotes entre repositórios](https://docs.aws.amazon.com/codeartifact/latest/ug/copy-package.html) no *Guia do usuário do AWS CodeArtifact*. + Para obter os detalhes da API, consulte [CopyPackageVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/copy-package-versions.html) na *Referência de comandos da AWS CLI*. ### `create-domain` O código de exemplo a seguir mostra como usar `create-domain`. **AWS CLI** **Para criar um domínio** O exemplo `create-domain` a seguir cria um domínio chamado test-domain. ``` aws codeartifact create-domain \ --domain test-domain ``` Resultado: ``` { "domain": { "name": "test-domain", "owner": "111122223333", "arn": "arn:aws:codeartifact:us-west-2:111122223333:domain/test-domain", "status": "Active", "createdTime": "2020-10-20T13:16:48.559000-04:00", "encryptionKey": "arn:aws:kms:us-west-2:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "repositoryCount": 0, "assetSizeBytes": 0 } } ``` Para obter mais informações, consulte [Criar um domínio](https://docs.aws.amazon.com/codeartifact/latest/ug/domain-create.html) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [CreateDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/create-domain.html) na *Referência de comandos da AWS CLI*. ### `create-repository` O código de exemplo a seguir mostra como usar `create-repository`. **AWS CLI** **Como criar um repositório** O exemplo `create-repository` a seguir cria um repositório chamado test-repo dentro de um domínio chamado test-domain. ``` aws codeartifact create-repository \ --domain test-domain \ --domain-owner 111122223333 \ --repository test-repo \ --description "This is a test repository." ``` Resultado: ``` { "repository": { "name": "test-repo", "administratorAccount": "111122223333", "domainName": "test-domain", "domainOwner": "111122223333", "arn": "arn:aws:codeartifact:us-west-2:111122223333:repository/test-domain/test-repo", "description": "This is a test repository.", "upstreams": [], "externalConnections": [] } } ``` Para obter mais informações, consulte [Criar um domínio](https://docs.aws.amazon.com/codeartifact/latest/ug/create-repo.html) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [CreateRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/create-repository.html) na *Referência de comandos da AWS CLI*. ### `delete-domain-permissions-policy` O código de exemplo a seguir mostra como usar `delete-domain-permissions-policy`. **AWS CLI** **Para excluir o documento de política de permissões de um domínio** O exemplo `delete-domain-permissions-policy` a seguir exclui a política de permissão de um domínio chamado test-domain. ``` aws codeartifact delete-domain-permissions-policy \ --domain test-domain ``` Resultado: ``` { "Version":"2012-10-17", "Statement": [ { "Sid": "BasicDomainPolicy", "Action": [ "codeartifact:GetDomainPermissionsPolicy", "codeartifact:ListRepositoriesInDomain", "codeartifact:GetAuthorizationToken", "codeartifact:CreateRepository" ], "Effect": "Allow", "Resource": "*", "Principal": { "AWS": "arn:aws:iam::111122223333:root" } } ] } ``` Para obter mais informações, consulte [Excluir uma política de domínio](https://docs.aws.amazon.com/codeartifact/latest/ug/domain-policies.html#deleting-a-domain-policy) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [DeleteDomainPermissionsPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/delete-domain-permissions-policy.html) na *Referência de comandos da AWS CLI*. ### `delete-domain` O código de exemplo a seguir mostra como usar `delete-domain`. **AWS CLI** **Para excluir um domínio** O exemplo `delete-domain` a seguir exclui um domínio chamado `test-domain`. ``` aws codeartifact delete-domain \ --domain test-domain ``` Resultado: ``` { "domain": { "name": "test-domain", "owner": "417498243647", "arn": "arn:aws:codeartifact:us-west-2:417498243647:domain/test-domain", "status": "Deleted", "createdTime": "2020-10-20T13:16:48.559000-04:00", "encryptionKey": "arn:aws:kms:us-west-2:417498243647:key/c9fe2447-0795-4fda-afbe-8464574ae162", "repositoryCount": 0, "assetSizeBytes": 0 } } ``` Para obter mais informações, consulte [Excluir um domínio](https://docs.aws.amazon.com/codeartifact/latest/ug/delete-domain.html) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [DeleteDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/delete-domain.html) na *Referência de comandos da AWS CLI*. ### `delete-package-versions` O código de exemplo a seguir mostra como usar `delete-package-versions`. **AWS CLI** **Para excluir versões de pacote** O exemplo `delete-package-versions` a seguir exclui a versão 4.0.0 de um pacote chamado test-package. ``` aws codeartifact delete-package-versions \ --domain test-domain \ --repo test-repo \ --format npm \ --package test-package \ --versions 4.0.0 ``` Resultado: ``` { "successfulVersions": { "4.0.0": { "revision": "Ciqe5/9yicvkJT13b5/LdLpCyE6fqA7poa9qp+FilPs=", "status": "Deleted" } }, "failedVersions": {} } ``` Para obter mais informações, consulte [Excluir uma versão de pacote](https://docs.aws.amazon.com/codeartifact/latest/ug/delete-package.html) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [DeletePackageVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/delete-package-versions.html) na *Referência de comandos da AWS CLI*. ### `delete-repository-permissions-policy` O código de exemplo a seguir mostra como usar `delete-repository-permissions-policy`. **AWS CLI** **Para excluir uma política de permissões de um repositório** O exemplo `delete-repository-permissions-policy` a seguir exclui a política de permissão de um repositório chamado test-repo. ``` aws codeartifact delete-repository-permissions-policy \ --domain test-domain \ --repository test-repo ``` Resultado: ``` { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111122223333:root" }, "Action": [ "codeartifact:DescribePackageVersion", "codeartifact:DescribeRepository", "codeartifact:GetPackageVersionReadme", "codeartifact:GetRepositoryEndpoint", "codeartifact:ListPackages", "codeartifact:ListPackageVersions", "codeartifact:ListPackageVersionAssets", "codeartifact:ListPackageVersionDependencies", "codeartifact:ReadFromRepository" ], "Resource": "*" } ] } ``` Para obter mais informações, consulte [Excluir uma política](https://docs.aws.amazon.com/codeartifact/latest/ug/repo-policies.html#deleting-a-policy) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [DeleteRepositoryPermissionsPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/delete-repository-permissions-policy.html) na *Referência de comandos da AWS CLI*. ### `delete-repository` O código de exemplo a seguir mostra como usar `delete-repository`. **AWS CLI** **Para excluir um repositório** O exemplo `delete-repository` a seguir exclui um repositório chamado `test-repo` em um domínio chamado `test-domain`. ``` aws codeartifact delete-repository \ --domain test-domain \ --repository test-repo ``` Resultado: ``` { "repository": { "name": "test-repo", "administratorAccount": "111122223333", "domainName": "test-domain", "domainOwner": "111122223333", "arn": "arn:aws:codeartifact:us-west-2:111122223333:repository/test-domain/test-repo", "description": "This is a test repository", "upstreams": [], "externalConnections": [] } } ``` Para obter mais informações, consulte [Excluir um repositório](https://docs.aws.amazon.com/codeartifact/latest/ug/delete-repo.html) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [DeleteRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/delete-repository.html) na *Referência de comandos da AWS CLI*. ### `describe-domain` O código de exemplo a seguir mostra como usar `describe-domain`. **AWS CLI** **Para obter informações sobre um domínio** O exemplo `describe-domain` a seguir retorna um objeto DomainDescription para um domínio chamado test-domain. ``` aws codeartifact describe-domain \ --domain test-domain ``` Resultado: ``` { "domain": { "name": "test-domain", "owner": "111122223333", "arn": "arn:aws:codeartifact:us-west-2:111122223333:domain/test-domain", "status": "Active", "createdTime": "2020-10-20T13:16:48.559000-04:00", "encryptionKey": "arn:aws:kms:us-west-2:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "repositoryCount": 2, "assetSizeBytes": 0, "s3BucketArn": "arn:aws:s3:::assets-111122223333-us-west-2" } } ``` Para obter mais informações, consulte [Visão geral do domínio](https://docs.aws.amazon.com/codeartifact/latest/ug/domain-overview.html) no *Guia do Usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [DescribeDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/describe-domain.html) na *Referência de comandos da AWS CLI*. ### `describe-repository` O código de exemplo a seguir mostra como usar `describe-repository`. **AWS CLI** **Para obter informações sobre um repositório** O exemplo `describe-repository` a seguir retorna um objeto RepositoryDescription para um repositório chamado test-repo. ``` aws codeartifact describe-repository \ --domain test-domain \ --repository test-repo ``` Resultado: ``` { "repository": { "name": "test-repo", "administratorAccount": "111122223333", "domainName": "test-domain", "domainOwner": "111122223333", "arn": "arn:aws:codeartifact:us-west-2:111122223333:repository/test-domain/test-repo", "description": "This is a test repository.", "upstreams": [], "externalConnections": [] } } ``` Para obter mais informações, consulte [Criar um domínio](https://docs.aws.amazon.com/codeartifact/latest/ug/create-repo.html) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [DescribeRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/describe-repository.html) na *Referência de comandos da AWS CLI*. ### `disassociate-external-connection` O código de exemplo a seguir mostra como usar `disassociate-external-connection`. **AWS CLI** **Para remover uma conexão externa de um repositório** O exemplo `disassociate-external-connection` a seguir remove uma conexão externa com npmjs.com de um repositório chamado test-repo. ``` aws codeartifact disassociate-external-connection \ --repository test-repo \ --domain test-domain \ --external-connection public:npmjs ``` Resultado: ``` { "repository": { "name": "test-repo", "administratorAccount": "111122223333", "domainName": "test-domain", "domainOwner": "111122223333", "arn": "arn:aws:codeartifact:us-west-2:111122223333:repository/test-domain/test-repo", "upstreams": [], "externalConnections": [] } } ``` Para obter mais informações, consulte [Remover uma conexão externa](https://docs.aws.amazon.com/codeartifact/latest/ug/external-connection.html#removing-an-external-connection) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [DisassociateExternalConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/disassociate-external-connection.html) na *Referência de comandos da AWS CLI*. ### `dispose-package-versions` O código de exemplo a seguir mostra como usar `dispose-package-versions`. **AWS CLI** **Para excluir os ativos de uma versão do pacote e definir seu status como Descartado** O exemplo `dispose-package-versions` a seguir exclui os ativos do pacote de teste versão 4.0.0 e define seu status como Descartado. ``` aws codeartifact dispose-package-versions \ --domain test-domain \ --repo test-repo \ --format npm \ --package test-package \ --versions 4.0.0 ``` Resultado: ``` { "successfulVersions": { "4.0.0": { "revision": "Ciqe5/9yicvkJT13b5/LdLpCyE6fqA7poa9qp+FilPs=", "status": "Disposed" } }, "failedVersions": {} } ``` Para obter mais informações, consulte [Trabalhar com pacotes no CodeArtifact](https://docs.aws.amazon.com/codeartifact/latest/ug/packages.html) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [DisposePackageVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/dispose-package-versions.html) na *Referência de comandos da AWS CLI*. ### `get-authorization-token` O código de exemplo a seguir mostra como usar `get-authorization-token`. **AWS CLI** **Para obter um token de autorização** O exemplo `get-authorization-token` a seguir recupera um token de autorização do CodeArtifact. ``` aws codeartifact get-authorization-token \ --domain test-domain \ --query authorizationToken \ --output text ``` Resultado: ``` This command will return the authorization token. You can store the output in an environment variable when calling the command. ``` Para obter mais informações, consulte [Configurar o pip sem o comando de login](https://docs.aws.amazon.com/codeartifact/latest/ug/python-configure-without-pip.html) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [GetAuthorizationToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/get-authorization-token.html) na *Referência de comandos da AWS CLI*. ### `get-domain-permissions-policy` O código de exemplo a seguir mostra como usar `get-domain-permissions-policy`. **AWS CLI** **Para obter o documento de política de permissões de um domínio** O exemplo `get-domain-permissions-policy` a seguir anexa a política de permissão a um domínio chamado test-domain. ``` aws codeartifact get-domain-permissions-policy \ --domain test-domain ``` Resultado: ``` { "Version":"2012-10-17", "Statement": [ { "Sid": "BasicDomainPolicy", "Action": [ "codeartifact:GetDomainPermissionsPolicy", "codeartifact:ListRepositoriesInDomain", "codeartifact:GetAuthorizationToken", "codeartifact:CreateRepository" ], "Effect": "Allow", "Resource": "*", "Principal": { "AWS": "arn:aws:iam::111122223333:root" } } ] } ``` Para obter mais informações, consulte [Ler uma política de domínio](https://docs.aws.amazon.com/codeartifact/latest/ug/domain-policies.html#reading-a-domain-policy) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [GetDomainPermissionsPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/get-domain-permissions-policy.html) na *Referência de comandos da AWS CLI*. ### `get-package-version-asset` O código de exemplo a seguir mostra como usar `get-package-version-asset`. **AWS CLI** **Para obter um ativo de uma versão do pacote** O exemplo `get-package-version-asset` a seguir recupera o ativo `package.tgz` para a versão 4.0.0 de um pacote npm chamado test-package. ``` aws codeartifact get-package-version-asset \ --domain test-domain \ --repository test-repo \ --format npm \ --package test-package \ --package-version 4.0.0 \ --asset 'package.tgz' \ outfileName ``` Resultado: ``` The output for this command will also store the raw asset in the file provided in place of outfileName. { "assetName": "package.tgz", "packageVersion": "4.0.0", "packageVersionRevision": "Ciqe5/9yicvkJT13b5/LdLpCyE6fqA7poa9qp+FilPs=" } ``` Para obter mais informações, consulte [Listar ativos da versão do pacote](https://docs.aws.amazon.com/codeartifact/latest/ug/list-assets.html) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [GetPackageVersionAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/get-package-version-asset.html) na *Referência de comandos da AWS CLI*. ### `get-package-version-readme` O código de exemplo a seguir mostra como usar `get-package-version-readme`. **AWS CLI** **Para obter o arquivo readme de uma versão de pacote** O exemplo `get-package-version-readme` a seguir recupera o arquivo readme da versão 4.0.0 de um pacote npm chamado test-package. ``` aws codeartifact get-package-version-readme \ --domain test-domain \ --repo test-repo \ --format npm \ --package test-package \ --package-version 4.0.0 ``` Resultado: ``` { "format": "npm", "package": "test-package", "version": "4.0.0", "readme": "
\n ... more content ... \n", "versionRevision": "Ciqe5/9yicvkJT13b5/LdLpCyE6fqA7poa9qp+FilPs=" } ``` Para obter mais informações, consulte [Exibir arquivo readme da versão do pacote](https://docs.aws.amazon.com/codeartifact/latest/ug/describe-package-version.html#view-package-readme) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [GetPackageVersionReadme](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/get-package-version-readme.html) na *Referência de comandos da AWS CLI*. ### `get-repository-endpoint` O código de exemplo a seguir mostra como usar `get-repository-endpoint`. **AWS CLI** **Para obter o endpoint de URL de um repositório** O exemplo `get-repository-endpoint` a seguir retorna o endpoint npm para o repositório test-repo. ``` aws codeartifact get-repository-endpoint \ --domain test-domain \ --repository test-repo \ --format npm ``` Resultado: ``` { "repositoryEndpoint": "https://test-domain-111122223333.d.codeartifact.us-west-2.amazonaws.com/npm/test-repo/" } ``` Para obter mais informações, consulte [Conectar-se a um repositório](https://docs.aws.amazon.com/codeartifact/latest/ug/connect-repo.html) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [GetRepositoryEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/get-repository-endpoint.html) na *Referência de comandos da AWS CLI*. ### `get-repository-permissions-policy` O código de exemplo a seguir mostra como usar `get-repository-permissions-policy`. **AWS CLI** **Para obter o documento de política de permissões de um repositório** O exemplo `get-repository-permissions-policy` a seguir anexa a política de permissão a um repositório chamado test-repo. ``` aws codeartifact get-repository-permissions-policy \ --domain test-domain \ --repository test-repo ``` Resultado: ``` { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111122223333:root" }, "Action": [ "codeartifact:DescribePackageVersion", "codeartifact:DescribeRepository", "codeartifact:GetPackageVersionReadme", "codeartifact:GetRepositoryEndpoint", "codeartifact:ListPackages", "codeartifact:ListPackageVersions", "codeartifact:ListPackageVersionAssets", "codeartifact:ListPackageVersionDependencies", "codeartifact:ReadFromRepository" ], "Resource": "*" } ] } ``` Para obter mais informações, consulte [Ler uma política](https://docs.aws.amazon.com/codeartifact/latest/ug/repo-policies.html#setting-a-policy) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [GetRepositoryPermissionsPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/get-repository-permissions-policy.html) na *Referência de comandos da AWS CLI*. ### `list-domains` O código de exemplo a seguir mostra como usar `list-domains`. **AWS CLI** **Para listar domínios** O exemplo `list-domains` a seguir retorna um resumo de todos os domínios pertencentes à conta da AWS que faz a chamada. ``` aws codeartifact list-domains ``` Resultado: ``` { "domains": [ { "name": "my-domain", "owner": "111122223333", "status": "Active", "encryptionKey": "arn:aws:kms:us-west-2:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, { "name": "test-domain", "owner": "111122223333", "status": "Active", "encryptionKey": "arn:aws:kms:us-west-2:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" } ] } ``` Para obter mais informações, consulte [Trabalhar com domínios no CodeArtifact](https://docs.aws.amazon.com/codeartifact/latest/ug/domains.html) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [ListDomains](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/list-domains.html) na *Referência de comandos da AWS CLI*. ### `list-package-version-assets` O código de exemplo a seguir mostra como usar `list-package-version-assets`. **AWS CLI** **Como visualizar os ativos de uma versão do pacote** O exemplo `list-package-version-assets` a seguir recupera os ativos para a versão 4.0.0 de um pacote npm chamado test-package. ``` aws codeartifact list-package-version-assets \ --domain test-domain \ --repo test-repo \ --format npm \ --package test-package \ --package-version 4.0.0 ``` Resultado: ``` { "format": "npm", "package": "test-package", "version": "4.0.0", "versionRevision": "Ciqe5/9yicvkJT13b5/LdLpCyE6fqA7poa9qp+FilPs=", "assets": [ { "name": "package.tgz", "size": 316680, "hashes": { "MD5": "60078ec6d9e76b89fb55c860832742b2", "SHA-1": "b44a9b6297bcb698f1c51a3545a2b3b368d59c52", "SHA-256": "d2aa8c6afc3c8591765785a37d1c5acae482a8eb3ab9729ed28922692454f2e2", "SHA-512": "3e585d15c8a594e20d7de57b362ea81754c011acb2641a19f1b72c8531ea39825896bab344ae616a0a5a824cb9a381df0b3cddd534645cf305aba70a93dac698" } } ] } ``` Para obter mais informações, consulte [Listar ativos da versão do pacote](https://docs.aws.amazon.com/codeartifact/latest/ug/list-assets.html) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [ListPackageVersionAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/list-package-version-assets.html) na *Referência de comandos da AWS CLI*. ### `list-package-version-dependencies` O código de exemplo a seguir mostra como usar `list-package-version-dependencies`. **AWS CLI** **Como exibir dependências de versão de pacote** O exemplo `list-package-version-dependencies` a seguir recupera as dependências para a versão 4.0.0 de um pacote npm chamado test-package. ``` aws codeartifact list-package-version-dependencies \ --domain test-domain \ --repo test-repo \ --format npm \ --package test-package \ --package-version 4.0.0 ``` Resultado: ``` { "format": "npm", "package": "test-package", "version": "4.0.0", "versionRevision": "Ciqe5/9yicvkJT13b5/LdLpCyE6fqA7poa9qp+FilPs=", "dependencies": [ { "namespace": "testns", "package": "testdep1", "dependencyType": "regular", "versionRequirement": "1.8.5" }, { "namespace": "testns", "package": "testdep2", "dependencyType": "regular", "versionRequirement": "1.8.5" } ] } ``` Para obter mais informações, consulte [Exibir e atualizar os detalhes e dependências da versão do pacote](https://docs.aws.amazon.com/codeartifact/latest/ug/describe-package-version.html) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [ListPackageVersionDependencies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/list-package-version-dependencies.html) na *Referência de comandos da AWS CLI*. ### `list-package-versions` O código de exemplo a seguir mostra como usar `list-package-versions`. **AWS CLI** **Para listar as versões de um pacote** O exemplo `list-package-versions` a seguir retorna uma lista de versões de pacotes para um pacote chamado `kind-of`. ``` aws codeartifact list-package-versions \ --package kind-of \ --domain test-domain \ --repository test-repo \ --format npm ``` Resultado: ``` { "defaultDisplayVersion": "1.0.1", "format": "npm", "package": "kind-of", "versions": [ { "version": "1.0.1", "revision": "REVISION-SAMPLE-1-C7F4S5E9B772FC", "status": "Published" }, { "version": "1.0.0", "revision": "REVISION-SAMPLE-2-C752BEEF6D2CFC", "status": "Published" }, { "version": "0.1.2", "revision": "REVISION-SAMPLE-3-654S65A5C5E1FC", "status": "Published" }, { "version": "0.1.1", "revision": "REVISION-SAMPLE-1-C7F4S5E9B772FC"", "status": "Published" }, { "version": "0.1.0", "revision": "REVISION-SAMPLE-4-AF669139B772FC", "status": "Published" } ] } ``` Para obter mais informações, consulte [Listar versões do pacote](https://docs.aws.amazon.com/codeartifact/latest/ug/list-packages-versions.html) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [ListPackageVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/list-package-versions.html) na *Referência de comandos da AWS CLI*. ### `list-packages` O código de exemplo a seguir mostra como usar `list-packages`. **AWS CLI** **Para listar pacotes em um repositório** O exemplo `list-packages` a seguir lista pacotes em um repositório chamado `test-repo` em um domínio chamado `test-domain`. ``` aws codeartifact list-packages \ --domain test-domain \ --repository test-repo ``` Resultado: ``` { "packages": [ { "format": "npm", "package": "lodash" } { "format": "python", "package": "test-package" } ] } ``` Para obter mais informações, consulte [Listar nomes de pacotes](https://docs.aws.amazon.com/codeartifact/latest/ug/list-packages.html) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [ListPackages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/list-packages.html) na *Referência de comandos da AWS CLI*. ### `list-repositories-in-domain` O código de exemplo a seguir mostra como usar `list-repositories-in-domain`. **AWS CLI** **Para listar repositórios em um domínio** O exemplo `list-repositories-in-domain` a seguir retorna um resumo de todos os repositórios no domínio test-domain. ``` aws codeartifact list-repositories-in-domain \ --domain test-domain ``` Resultado: ``` { "repositories": [ { "name": "test-repo", "administratorAccount": "111122223333", "domainName": "test-domain", "domainOwner": "111122223333", "arn": "arn:aws:codeartifact:us-west-2:111122223333:repository/test-domain/test-repo", "description": "This is a test repository." }, { "name": "test-repo2", "administratorAccount": "111122223333", "domainName": "test-domain", "domainOwner": "111122223333", "arn": "arn:aws:codeartifact:us-west-2:111122223333:repository/test-domain/test-repo2", "description": "This is a test repository." } ] } ``` Para obter mais informações, consulte [Listar repositórios](https://docs.aws.amazon.com/codeartifact/latest/ug/list-repos.html) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [ListRepositoriesInDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/list-repositories-in-domain.html) na *Referência de comandos da AWS CLI*. ### `list-repositories` O código de exemplo a seguir mostra como usar `list-repositories`. **AWS CLI** **Para listar repositórios** O exemplo `list-repositories` a seguir retorna um resumo de todos os repositórios no domínio de propriedade da conta da AWS que faz a chamada. ``` aws codeartifact list-repositories ``` Resultado: ``` { "repositories": [ { "name": "npm-store", "administratorAccount": "111122223333", "domainName": "my-domain", "domainOwner": "111122223333", "arn": "arn:aws:codeartifact:us-west-2:111122223333:repository/my-domain/npm-store", "description": "Provides npm artifacts from npm, Inc." }, { "name": "target-repo", "administratorAccount": "111122223333", "domainName": "my-domain", "domainOwner": "111122223333", "arn": "arn:aws:codeartifact:us-west-2:111122223333:repository/my-domain/target-repo", "description": "test target repo" }, { "name": "test-repo2", "administratorAccount": "111122223333", "domainName": "test-domain", "domainOwner": "111122223333", "arn": "arn:aws:codeartifact:us-west-2:111122223333:repository/test-domain/test-repo2", "description": "This is a test repository." } ] } ``` Para obter mais informações, consulte [Listar repositórios](https://docs.aws.amazon.com/codeartifact/latest/ug/list-repos.html) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [ListRepositories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/list-repositories.html) na *Referência de comandos da AWS CLI*. ### `login` O código de exemplo a seguir mostra como usar `login`. **AWS CLI** **Como configurar a autenticação no seu repositório com o comando de login** O exemplo `login` a seguir configura o gerenciador de pacotes npm com um repositório chamado test-repo em um domínio chamado test-domain. ``` aws codeartifact login \ --domain test-domain \ --repository test-repo \ --tool npm ``` Resultado: ``` Successfully configured npm to use AWS CodeArtifact repository https://test-domain-111122223333.d.codeartifact.us-west-2.amazonaws.com/npm/test-repo/ Login expires in 12 hours at 2020-11-12 01:53:16-05:00 ``` Para obter mais informações, consulte [Introdução à AWS CLI](https://docs.aws.amazon.com/codeartifact/latest/ug/getting-started-cli.html) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [Login](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/login.html) na *Referência de comandos da AWS CLI*. ### `put-domain-permissions-policy` O código de exemplo a seguir mostra como usar `put-domain-permissions-policy`. **AWS CLI** **Como anexar uma política de permissões a um domínio** O exemplo `put-domain-permissions-policy` a seguir anexa uma política de permissão definida no arquivo policy.json a um domínio chamado test-domain. ``` aws codeartifact put-domain-permissions-policy \ --domain test-domain \ --policy-document file://PATH/TO/policy.json ``` Resultado: ``` { "policy": { "resourceArn": "arn:aws:codeartifact:region-id:111122223333:domain/test-domain", "document": "{ ...policy document content...}", "revision": "MQlyyTQRASRU3HB58gBtSDHXG7Q3hvxxxxxxx=" } } ``` Para obter mais informações, consulte [Definir uma política de domínio](https://docs.aws.amazon.com/codeartifact/latest/ug/domain-policies.html#set-domain-policy) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [PutDomainPermissionsPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/put-domain-permissions-policy.html) na *Referência de comandos da AWS CLI*. ### `put-repository-permissions-policy` O código de exemplo a seguir mostra como usar `put-repository-permissions-policy`. **AWS CLI** **Como anexar uma política de permissões a um repositório** O exemplo `put-repository-permissions-policy` a seguir anexa uma política de permissão definida no arquivo policy.json a um repositório chamado test-repo. ``` aws codeartifact put-repository-permissions-policy \ --domain test-domain \ --repository test-repo \ --policy-document file://PATH/TO/policy.json ``` Resultado: ``` { "policy": { "resourceArn": "arn:aws:codeartifact:region-id:111122223333:repository/test-domain/test-repo", "document": "{ ...policy document content...}", "revision": "MQlyyTQRASRU3HB58gBtSDHXG7Q3hvxxxxxxx=" } } ``` Para obter mais informações, consulte [Definir uma política](https://docs.aws.amazon.com/codeartifact/latest/ug/repo-policies.html#setting-a-policy) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [PutRepositoryPermissionsPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/put-repository-permissions-policy.html) na *Referência de comandos da AWS CLI*. ### `update-package-versions-status` O código de exemplo a seguir mostra como usar `update-package-versions-status`. **AWS CLI** **Para atualizar o status da versão do pacote** O exemplo `update-package-versions-status` a seguir atualiza o status da versão 4.0.0 do pacote test-package para Archived. ``` aws codeartifact update-package-versions-status \ --domain test-domain \ --repo test-repo \ --format npm \ --package test-package \ --versions 4.0.0 \ --target-status Archived ``` Resultado: ``` { "successfulVersions": { "4.0.0": { "revision": "Ciqe5/9yicvkJT13b5/LdLpCyE6fqA7poa9qp+FilPs=", "status": "Archived" } }, "failedVersions": {} } ``` Para obter mais informações, consulte [Atualizar o status da versão do pacote](https://docs.aws.amazon.com/codeartifact/latest/ug/describe-package-version.html#update-package-version-status) no *Guia do usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [UpdatePackageVersionsStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/update-package-versions-status.html) na *Referência de comandos da AWS CLI*. ### `update-repository` O código de exemplo a seguir mostra como usar `update-repository`. **AWS CLI** **Para atualizar um repositório** O exemplo `update-repository` a seguir atualiza a descrição de um repositório chamado test-repo em um domínio chamado test-domain para “esta é uma descrição atualizada”. ``` aws codeartifact update-repository \ --domain test-domain \ --repository test-repo \ --description "this is an updated description" ``` Resultado: ``` { "repository": { "name": "test-repo", "administratorAccount": "111122223333", "domainName": "test-domain", "domainOwner": "111122223333", "arn": "arn:aws:codeartifact:us-west-2:111122223333:repository/test-domain/test-repo", "description": "this is an updated description", "upstreams": [], "externalConnections": [] } } ``` Para obter mais informações, consulte [Exibir ou modificar a configuração de um repositório](https://docs.aws.amazon.com/codeartifact/latest/ug/config-repos.html) no *Guia do Usuário do AWS CodeArtifact*. + Para ver detalhes da API, consulte [UpdateRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/update-repository.html) na *Referência de comandos da AWS CLI*. # Exemplos do CodeBuild usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o CodeBuild. *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 ### `batch-delete-builds` O código de exemplo a seguir mostra como usar `batch-delete-builds`. **AWS CLI** **Para excluir compilações no AWS CodeBuild.** O exemplo `batch-delete-builds` a seguir exclui compilações no CodeBuild com os IDs especificados. ``` aws codebuild batch-delete-builds --ids my-build-project-one:a1b2c3d4-5678-9012-abcd-11111EXAMPLE my-build-project-two:a1b2c3d4-5678-9012-abcd-22222EXAMPLE ``` Resultado: ``` { "buildsNotDeleted": [ { "id": "arn:aws:codebuild:us-west-2:123456789012:build/my-build-project-one:a1b2c3d4-5678-9012-abcd-11111EXAMPLE", "statusCode": "BUILD_IN_PROGRESS" } ], "buildsDeleted": [ "arn:aws:codebuild:us-west-2:123456789012:build/my-build-project-two:a1b2c3d4-5678-9012-abcd-22222EXAMPLE" ] } ``` Para obter mais informações, consulte [Excluir compilações (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/delete-builds.html#delete-builds-cli) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [BatchDeleteBuilds](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/batch-delete-builds.html) na *Referência de comandos da AWS CLI*. ### `batch-get-build-batches` O código de exemplo a seguir mostra como usar `batch-get-build-batches`. **AWS CLI** **Para visualizar detalhes das compilações no AWS CodeBuild.** O exemplo `batch-get-build-batches` a seguir obtém informações sobre lotes de compilação no CodeBuild com os IDs especificados. ``` aws codebuild batch-get-build-batches \ --ids codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE ``` Resultado: ``` { "buildBatches": [ { "id": "codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE", "arn": "arn:aws:codebuild:us-west-2:123456789012:build-batch/codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE", "startTime": "2020-11-03T21:52:20.775000+00:00", "endTime": "2020-11-03T21:56:59.784000+00:00", "currentPhase": "SUCCEEDED", "buildBatchStatus": "SUCCEEDED", "resolvedSourceVersion": "0a6546f68309560d08a310daac92314c4d378f6b", "projectName": "codebuild-demo-project", "phases": [ { "phaseType": "SUBMITTED", "phaseStatus": "SUCCEEDED", "startTime": "2020-11-03T21:52:20.775000+00:00", "endTime": "2020-11-03T21:52:20.976000+00:00", "durationInSeconds": 0 }, { "phaseType": "DOWNLOAD_BATCHSPEC", "phaseStatus": "SUCCEEDED", "startTime": "2020-11-03T21:52:20.976000+00:00", "endTime": "2020-11-03T21:52:57.401000+00:00", "durationInSeconds": 36 }, { "phaseType": "IN_PROGRESS", "phaseStatus": "SUCCEEDED", "startTime": "2020-11-03T21:52:57.401000+00:00", "endTime": "2020-11-03T21:56:59.751000+00:00", "durationInSeconds": 242 }, { "phaseType": "COMBINE_ARTIFACTS", "phaseStatus": "SUCCEEDED", "startTime": "2020-11-03T21:56:59.751000+00:00", "endTime": "2020-11-03T21:56:59.784000+00:00", "durationInSeconds": 0 }, { "phaseType": "SUCCEEDED", "startTime": "2020-11-03T21:56:59.784000+00:00" } ], "source": { "type": "GITHUB", "location": "https://github.com/my-repo/codebuild-demo-project.git", "gitCloneDepth": 1, "gitSubmodulesConfig": { "fetchSubmodules": false }, "reportBuildStatus": false, "insecureSsl": false }, "secondarySources": [], "secondarySourceVersions": [], "artifacts": { "location": "" }, "secondaryArtifacts": [], "cache": { "type": "NO_CACHE" }, "environment": { "type": "LINUX_CONTAINER", "image": "aws/codebuild/amazonlinux2-x86_64-standard:3.0", "computeType": "BUILD_GENERAL1_SMALL", "environmentVariables": [], "privilegedMode": false, "imagePullCredentialsType": "CODEBUILD" }, "logConfig": { "cloudWatchLogs": { "status": "ENABLED" }, "s3Logs": { "status": "DISABLED", "encryptionDisabled": false } }, "buildTimeoutInMinutes": 60, "queuedTimeoutInMinutes": 480, "complete": true, "initiator": "Strohm", "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3", "buildBatchNumber": 6, "buildBatchConfig": { "serviceRole": "arn:aws:iam::123456789012:role/service-role/codebuild-demo-project", "restrictions": { "maximumBuildsAllowed": 100 }, "timeoutInMins": 480 }, "buildGroups": [ { "identifier": "DOWNLOAD_SOURCE", "ignoreFailure": false, "currentBuildSummary": { "arn": "arn:aws:codebuild:us-west-2:123456789012:build/codebuild-demo-project:379737d8-bc35-48ec-97fd-776d27545315", "requestedOn": "2020-11-03T21:52:21.394000+00:00", "buildStatus": "SUCCEEDED", "primaryArtifact": { "type": "no_artifacts", "identifier": "DOWNLOAD_SOURCE" }, "secondaryArtifacts": [] } }, { "identifier": "linux_small", "dependsOn": [], "ignoreFailure": false, "currentBuildSummary": { "arn": "arn:aws:codebuild:us-west-2:123456789012:build/codebuild-demo-project:dd785171-ed84-4bb6-8ede-ceeb86e54bdb", "requestedOn": "2020-11-03T21:52:57.604000+00:00", "buildStatus": "SUCCEEDED", "primaryArtifact": { "type": "no_artifacts", "identifier": "linux_small" }, "secondaryArtifacts": [] } }, { "identifier": "linux_medium", "dependsOn": [ "linux_small" ], "ignoreFailure": false, "currentBuildSummary": { "arn": "arn:aws:codebuild:us-west-2:123456789012:build/codebuild-demo-project:97cf7bd4-5313-4786-8243-4aef350a1267", "requestedOn": "2020-11-03T21:54:18.474000+00:00", "buildStatus": "SUCCEEDED", "primaryArtifact": { "type": "no_artifacts", "identifier": "linux_medium" }, "secondaryArtifacts": [] } }, { "identifier": "linux_large", "dependsOn": [ "linux_medium" ], "ignoreFailure": false, "currentBuildSummary": { "arn": "arn:aws:codebuild:us-west-2:123456789012:build/codebuild-demo-project:60a194cd-0d03-4337-9db1-d41476a17d27", "requestedOn": "2020-11-03T21:55:39.203000+00:00", "buildStatus": "SUCCEEDED", "primaryArtifact": { "type": "no_artifacts", "identifier": "linux_large" }, "secondaryArtifacts": [] } } ] } ], "buildBatchesNotFound": [] } ``` Para obter mais informações, consulte Compilações em lote no AWS CodeBuild )\$1\$1 no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [BatchGetBuildBatches](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/batch-get-build-batches.html) na *Referência de comandos da AWS CLI*. ### `batch-get-builds` O código de exemplo a seguir mostra como usar `batch-get-builds`. **AWS CLI** **Para visualizar detalhes das compilações no AWS CodeBuild.** O exemplo `batch-get-builds` a seguir obtém informações sobre compilações no CodeBuild com os IDs especificados. ``` aws codebuild batch-get-builds --ids codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE codebuild-demo-project:815e755f-bade-4a7e-80f0-efe51EXAMPLE ``` Resultado: ``` { "buildsNotFound": [], "builds": [ { "artifacts": { "md5sum": "0e95edf915048a0c22efe6d139fff837", "location": "arn:aws:s3:::codepipeline-us-west-2-820783811474/CodeBuild-Python-Pip/BuildArtif/6DJsqQa", "encryptionDisabled": false, "sha256sum": "cfa0df33a090966a737f64ae4fe498969fdc842a0c9aec540bf93c37ac0d05a2" }, "logs": { "cloudWatchLogs": { "status": "ENABLED" }, "s3Logs": { "status": "DISABLED" }, "streamName": "46472baf-8f6b-43c2-9255-b3b963af2732", "groupName": "/aws/codebuild/codebuild-demo-project", "deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-west-2#logEvent:group=/aws/codebuild/codebuild-demo-project;stream=46472baf-8f6b-43c2-9255-b3b963af2732" }, "timeoutInMinutes": 60, "environment": { "privilegedMode": false, "computeType": "BUILD_GENERAL1_MEDIUM", "image": "aws/codebuild/windows-base:1.0", "environmentVariables": [], "type": "WINDOWS_CONTAINER" }, "projectName": "codebuild-demo-project", "buildComplete": true, "source": { "gitCloneDepth": 1, "insecureSsl": false, "type": "CODEPIPELINE" }, "buildStatus": "SUCCEEDED", "secondaryArtifacts": [], "phases": [ { "durationInSeconds": 0, "startTime": 1548717462.122, "phaseType": "SUBMITTED", "endTime": 1548717462.484, "phaseStatus": "SUCCEEDED" }, { "durationInSeconds": 0, "startTime": 1548717462.484, "phaseType": "QUEUED", "endTime": 1548717462.775, "phaseStatus": "SUCCEEDED" }, { "durationInSeconds": 34, "endTime": 1548717496.909, "contexts": [ { "statusCode": "", "message": "" } ], "startTime": 1548717462.775, "phaseType": "PROVISIONING", "phaseStatus": "SUCCEEDED" }, { "durationInSeconds": 15, "endTime": 1548717512.555, "contexts": [ { "statusCode": "", "message": "" } ], "startTime": 1548717496.909, "phaseType": "DOWNLOAD_SOURCE", "phaseStatus": "SUCCEEDED" }, { "durationInSeconds": 0, "endTime": 1548717512.734, "contexts": [ { "statusCode": "", "message": "" } ], "startTime": 1548717512.555, "phaseType": "INSTALL", "phaseStatus": "SUCCEEDED" }, { "durationInSeconds": 0, "endTime": 1548717512.924, "contexts": [ { "statusCode": "", "message": "" } ], "startTime": 1548717512.734, "phaseType": "PRE_BUILD", "phaseStatus": "SUCCEEDED" }, { "durationInSeconds": 9, "endTime": 1548717522.254, "contexts": [ { "statusCode": "", "message": "" } ], "startTime": 1548717512.924, "phaseType": "BUILD", "phaseStatus": "SUCCEEDED" }, { "durationInSeconds": 3, "endTime": 1548717525.498, "contexts": [ { "statusCode": "", "message": "" } ], "startTime": 1548717522.254, "phaseType": "POST_BUILD", "phaseStatus": "SUCCEEDED" }, { "durationInSeconds": 9, "endTime": 1548717534.646, "contexts": [ { "statusCode": "", "message": "" } ], "startTime": 1548717525.498, "phaseType": "UPLOAD_ARTIFACTS", "phaseStatus": "SUCCEEDED" }, { "durationInSeconds": 2, "endTime": 1548717536.846, "contexts": [ { "statusCode": "", "message": "" } ], "startTime": 1548717534.646, "phaseType": "FINALIZING", "phaseStatus": "SUCCEEDED" }, { "startTime": 1548717536.846, "phaseType": "COMPLETED" } ], "startTime": 1548717462.122, "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3", "initiator": "codepipeline/CodeBuild-Pipeline", "secondarySources": [], "serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role", "currentPhase": "COMPLETED", "id": "codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE", "cache": { "type": "NO_CACHE" }, "sourceVersion": "arn:aws:s3:::codepipeline-us-west-2-820783811474/CodeBuild-Python-Pip/SourceArti/1TspnN3.zip", "endTime": 1548717536.846, "arn": "arn:aws:codebuild:us-west-2:123456789012:build/codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE", "queuedTimeoutInMinutes": 480, "resolvedSourceVersion": "f2194c1757bbdcb0f8f229254a4b3c8b27d43e0b" }, { "artifacts": { "md5sum": "", "overrideArtifactName": false, "location": "arn:aws:s3:::my-artifacts/codebuild-demo-project", "encryptionDisabled": false, "sha256sum": "" }, "logs": { "cloudWatchLogs": { "status": "ENABLED" }, "s3Logs": { "status": "DISABLED" }, "streamName": "4dea3ca4-20ec-4898-b22a-a9eb9292775d", "groupName": "/aws/codebuild/codebuild-demo-project", "deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-west-2#logEvent:group=/aws/codebuild/codebuild-demo-project;stream=4dea3ca4-20ec-4898-b22a-a9eb9292775d" }, "timeoutInMinutes": 60, "environment": { "privilegedMode": false, "computeType": "BUILD_GENERAL1_MEDIUM", "image": "aws/codebuild/windows-base:1.0", "environmentVariables": [], "type": "WINDOWS_CONTAINER" }, "projectName": "codebuild-demo-project", "buildComplete": true, "source": { "gitCloneDepth": 1, "location": "https://github.com/my-repo/codebuild-demo-project.git", "insecureSsl": false, "reportBuildStatus": false, "type": "GITHUB" }, "buildStatus": "SUCCEEDED", "secondaryArtifacts": [], "phases": [ { "durationInSeconds": 0, "startTime": 1548716241.89, "phaseType": "SUBMITTED", "endTime": 1548716242.241, "phaseStatus": "SUCCEEDED" }, { "durationInSeconds": 0, "startTime": 1548716242.241, "phaseType": "QUEUED", "endTime": 1548716242.536, "phaseStatus": "SUCCEEDED" }, { "durationInSeconds": 33, "endTime": 1548716276.171, "contexts": [ { "statusCode": "", "message": "" } ], "startTime": 1548716242.536, "phaseType": "PROVISIONING", "phaseStatus": "SUCCEEDED" }, { "durationInSeconds": 15, "endTime": 1548716291.809, "contexts": [ { "statusCode": "", "message": "" } ], "startTime": 1548716276.171, "phaseType": "DOWNLOAD_SOURCE", "phaseStatus": "SUCCEEDED" }, { "durationInSeconds": 0, "endTime": 1548716291.993, "contexts": [ { "statusCode": "", "message": "" } ], "startTime": 1548716291.809, "phaseType": "INSTALL", "phaseStatus": "SUCCEEDED" }, { "durationInSeconds": 0, "endTime": 1548716292.191, "contexts": [ { "statusCode": "", "message": "" } ], "startTime": 1548716291.993, "phaseType": "PRE_BUILD", "phaseStatus": "SUCCEEDED" }, { "durationInSeconds": 9, "endTime": 1548716301.622, "contexts": [ { "statusCode": "", "message": "" } ], "startTime": 1548716292.191, "phaseType": "BUILD", "phaseStatus": "SUCCEEDED" }, { "durationInSeconds": 3, "endTime": 1548716304.783, "contexts": [ { "statusCode": "", "message": "" } ], "startTime": 1548716301.622, "phaseType": "POST_BUILD", "phaseStatus": "SUCCEEDED" }, { "durationInSeconds": 8, "endTime": 1548716313.775, "contexts": [ { "statusCode": "", "message": "" } ], "startTime": 1548716304.783, "phaseType": "UPLOAD_ARTIFACTS", "phaseStatus": "SUCCEEDED" }, { "durationInSeconds": 2, "endTime": 1548716315.935, "contexts": [ { "statusCode": "", "message": "" } ], "startTime": 1548716313.775, "phaseType": "FINALIZING", "phaseStatus": "SUCCEEDED" }, { "startTime": 1548716315.935, "phaseType": "COMPLETED" } ], "startTime": 1548716241.89, "secondarySourceVersions": [], "initiator": "my-codebuild-project", "arn": "arn:aws:codebuild:us-west-2:123456789012:build/codebuild-demo-project:815e755f-bade-4a7e-80f0-efe51EXAMPLE", "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3", "serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role", "currentPhase": "COMPLETED", "id": "codebuild-demo-project:815e755f-bade-4a7e-80f0-efe51EXAMPLE", "cache": { "type": "NO_CACHE" }, "endTime": 1548716315.935, "secondarySources": [], "queuedTimeoutInMinutes": 480, "resolvedSourceVersion": "f2194c1757bbdcb0f8f229254a4b3c8b27d43e0b" } ] } ``` Para obter mais informações, consulte [Visualizar detalhes de compilação (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/view-build-details.html#view-build-details-cli) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [BatchGetBuilds](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/batch-get-builds.html) na *Referência de comandos da AWS CLI*. ### `batch-get-projects` O código de exemplo a seguir mostra como usar `batch-get-projects`. **AWS CLI** **Para obter uma lista de nomes de projeto de compilação do AWS CodeBuild.** O exemplo `batch-get-projects` a seguir obtém uma lista de projetos de compilação do CodeBuild especificados por nome. ``` aws codebuild batch-get-projects --names codebuild-demo-project codebuild-demo-project2 my-other-demo-project ``` Na saída a seguir, a matriz `projectsNotFound` lista nomes de projetos de compilação que foram especificados, mas não encontrados. A matriz `projects` lista detalhes para cada projeto de build em que informações foram encontradas. ``` { "projectsNotFound": [], "projects": [ { "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3", "name": "codebuild-demo-project2", "queuedTimeoutInMinutes": 480, "timeoutInMinutes": 60, "source": { "buildspec": "version: 0.2\n\n#env:\n #variables:\n # key: \"value\"\n # key: \"value\"\n #parameter-store:\n # key: \"value\"\n # key:\"value\"\n\nphases:\n #install:\n #commands:\n # - command\n # - command\n #pre_build:\n #commands:\n # - command\n # - command\n build:\n commands:\n # - command\n # - command\n #post_build:\n #commands:\n # - command\n # - command\n#artifacts:\n #files:\n # - location\n # - location\n #name: $(date +%Y-%m-%d)\n #discard-paths: yes\n #base-directory: location\n#cache:\n #paths:\n # - paths", "type": "NO_SOURCE", "insecureSsl": false, "gitCloneDepth": 1 }, "artifacts": { "type": "NO_ARTIFACTS" }, "badge": { "badgeEnabled": false }, "lastModified": 1540588091.108, "created": 1540588091.108, "arn": "arn:aws:codebuild:us-west-2:123456789012:project/test-for-sample", "secondarySources": [], "secondaryArtifacts": [], "cache": { "type": "NO_CACHE" }, "serviceRole": "arn:aws:iam::123456789012:role/service-role/my-test-role", "environment": { "image": "aws/codebuild/java:openjdk-8", "privilegedMode": true, "type": "LINUX_CONTAINER", "computeType": "BUILD_GENERAL1_SMALL", "environmentVariables": [] }, "tags": [] }, { "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3", "name": "my-other-demo-project", "queuedTimeoutInMinutes": 480, "timeoutInMinutes": 60, "source": { "location": "https://github.com/iversonic/codedeploy-sample.git", "reportBuildStatus": false, "buildspec": "buildspec.yml", "insecureSsl": false, "gitCloneDepth": 1, "type": "GITHUB", "auth": { "type": "OAUTH" } }, "artifacts": { "type": "NO_ARTIFACTS" }, "badge": { "badgeEnabled": false }, "lastModified": 1523401711.73, "created": 1523401711.73, "arn": "arn:aws:codebuild:us-west-2:123456789012:project/Project2", "cache": { "type": "NO_CACHE" }, "serviceRole": "arn:aws:iam::123456789012:role/service-role/codebuild-Project2-service-role", "environment": { "image": "aws/codebuild/nodejs:4.4.7", "privilegedMode": false, "type": "LINUX_CONTAINER", "computeType": "BUILD_GENERAL1_SMALL", "environmentVariables": [] }, "tags": [] } ] } ``` Para obter mais informações, consulte [Visualizar detalhes de um projeto de compilação (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/view-project-details.html#view-project-details-cli) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [BatchGetProjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/batch-get-projects.html) na *Referência de comandos da AWS CLI*. ### `batch-get-report-groups` O código de exemplo a seguir mostra como usar `batch-get-report-groups`. **AWS CLI** **Para obter informações sobre um ou mais grupos de relatórios no AWS CodeBuild.** O exemplo `batch-get-report-groups` a seguir recupera informações sobre o grupo de relatórios com o ARN especificado. ``` aws codebuild batch-get-report-groups \ --report-group-arns arn:aws:codebuild:::report-group/ ``` Resultado: ``` { "reportGroups": [ { "arn": "arn:aws:codebuild:::report-group/", "name": "report-group-name", "type": "TEST", "exportConfig": { "exportConfigType": "NO_EXPORT" }, "created": "2020-10-01T18:04:08.466000+00:00", "lastModified": "2020-10-01T18:04:08.466000+00:00", "tags": [] } ], "reportGroupsNotFound": [] } ``` Para obter mais informações, consulte [Trabalhar com grupos de relatórios](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group.html) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [BatchGetReportGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/batch-get-report-groups.html) na *Referência de comandos da AWS CLI*. ### `batch-get-reports` O código de exemplo a seguir mostra como usar `batch-get-reports`. **AWS CLI** **Para obter informações sobre um ou mais relatórios no AWS CodeBuild.** O exemplo `batch-get-reports` a seguir recupera informações sobre os relatórios com os ARNs especificados. ``` aws codebuild batch-get-reports \ --report-arns arn:aws:codebuild:::report/: arn:aws:codebuild:::report/: ``` Resultado: ``` { "reports": [ { "arn": "arn:aws:codebuild:::report/:", "type": "TEST", "name": "", "reportGroupArn": "arn:aws:codebuild:::report-group/", "executionId": "arn:aws:codebuild:::build/test-reports:", "status": "FAILED", "created": "2020-10-01T11:25:22.531000-07:00", "expired": "2020-10-31T11:25:22-07:00", "exportConfig": { "exportConfigType": "NO_EXPORT" }, "truncated": false, "testSummary": { "total": 28, "statusCounts": { "ERROR": 5, "FAILED": 1, "SKIPPED": 4, "SUCCEEDED": 18, "UNKNOWN": 0 }, "durationInNanoSeconds": 94000000 } }, { "arn": "arn:aws:codebuild:::report/:", "type": "TEST", "name": "", "reportGroupArn": "arn:aws:codebuild:::report-group/", "executionId": "arn:aws:codebuild:::build/test-reports:", "status": "FAILED", "created": "2020-10-01T11:13:05.816000-07:00", "expired": "2020-10-31T11:13:05-07:00", "exportConfig": { "exportConfigType": "NO_EXPORT" }, "truncated": false, "testSummary": { "total": 28, "statusCounts": { "ERROR": 5, "FAILED": 1, "SKIPPED": 4, "SUCCEEDED": 18, "UNKNOWN": 0 }, "durationInNanoSeconds": 94000000 } } ], "reportsNotFound": [] } ``` Para obter mais informações, consulte [Trabalhar com relatórios](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report.html) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [BatchGetReports](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/batch-get-reports.html) na *Referência de comandos da AWS CLI*. ### `create-project` O código de exemplo a seguir mostra como usar `create-project`. **AWS CLI** **Exemplo 1: como criar um projeto de compilação do AWS CodeBuild** O exemplo de `create-project` a seguir cria um projeto de compilação do CodeBuild usando arquivos de origem de um bucket do S3 ``` aws codebuild create-project \ --name "my-demo-project" \ --source "{\"type\": \"S3\",\"location\": \"codebuild-us-west-2-123456789012-input-bucket/my-source.zip\"}" \ --artifacts {"\"type\": \"S3\",\"location\": \"codebuild-us-west-2-123456789012-output-bucket\""} \ --environment "{\"type\": \"LINUX_CONTAINER\",\"image\": \"aws/codebuild/standard:1.0\",\"computeType\": \"BUILD_GENERAL1_SMALL\"}" \ --service-role "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role" ``` Resultado: ``` { "project": { "arn": "arn:aws:codebuild:us-west-2:123456789012:project/my-demo-project", "name": "my-cli-demo-project", "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3", "serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role", "lastModified": 1556839783.274, "badge": { "badgeEnabled": false }, "queuedTimeoutInMinutes": 480, "environment": { "image": "aws/codebuild/standard:1.0", "computeType": "BUILD_GENERAL1_SMALL", "type": "LINUX_CONTAINER", "imagePullCredentialsType": "CODEBUILD", "privilegedMode": false, "environmentVariables": [] }, "artifacts": { "location": "codebuild-us-west-2-123456789012-output-bucket", "name": "my-cli-demo-project", "namespaceType": "NONE", "type": "S3", "packaging": "NONE", "encryptionDisabled": false }, "source": { "type": "S3", "location": "codebuild-us-west-2-123456789012-input-bucket/my-source.zip", "insecureSsl": false }, "timeoutInMinutes": 60, "cache": { "type": "NO_CACHE" }, "created": 1556839783.274 } } ``` **Exemplo 2: como criar um projeto de compilação do AWS CodeBuild usando um arquivo de entrada JSON para os parâmetros** O exemplo de `create-project` a seguir cria um projeto de compilação do CodeBuild passando todos os parâmetros necessários em um arquivo de entrada JSON. Crie o modelo do arquivo de entrada executando o comando somente com o `--generate-cli-skeleton parameter`. ``` aws codebuild create-project --cli-input-json file://create-project.json ``` O arquivo de entrada JSON `create-project.json` contém o seguinte conteúdo: ``` { "name": "codebuild-demo-project", "source": { "type": "S3", "location": "codebuild-region-ID-account-ID-input-bucket/MessageUtil.zip" }, "artifacts": { "type": "S3", "location": "codebuild-region-ID-account-ID-output-bucket" }, "environment": { "type": "LINUX_CONTAINER", "image": "aws/codebuild/standard:1.0", "computeType": "BUILD_GENERAL1_SMALL" }, "serviceRole": "serviceIAMRole" } ``` Resultado: ``` { "project": { "name": "codebuild-demo-project", "serviceRole": "serviceIAMRole", "tags": [], "artifacts": { "packaging": "NONE", "type": "S3", "location": "codebuild-region-ID-account-ID-output-bucket", "name": "message-util.zip" }, "lastModified": 1472661575.244, "timeoutInMinutes": 60, "created": 1472661575.244, "environment": { "computeType": "BUILD_GENERAL1_SMALL", "image": "aws/codebuild/standard:1.0", "type": "LINUX_CONTAINER", "environmentVariables": [] }, "source": { "type": "S3", "location": "codebuild-region-ID-account-ID-input-bucket/MessageUtil.zip" }, "encryptionKey": "arn:aws:kms:region-ID:account-ID:alias/aws/s3", "arn": "arn:aws:codebuild:region-ID:account-ID:project/codebuild-demo-project" } } ``` Para obter mais informações, consulte [Criar um projeto de compilação (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/create-project.html#create-project-cli) no *Guia do usuário do AWS CodeBuild*. + Consulte detalhes da API em [CreateProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/create-project.html) na *Referência de comandos da AWS CLI*. ### `create-report-group` O código de exemplo a seguir mostra como usar `create-report-group`. **AWS CLI** **Para criar um grupo de relatórios no AWS CodeBuild.** O exemplo `create-report-group` a seguir cria um novo grupo de relatórios. ``` aws codebuild create-report-group \ --cli-input-json file://create-report-group-source.json ``` Conteúdo de create-report-group-source.json: ``` { "name": "cli-created-report-group", "type": "TEST", "exportConfig": { "exportConfigType": "S3", "s3Destination": { "bucket": "amzn-s3-demo-bucket", "path": "", "packaging": "ZIP", "encryptionDisabled": true } } } ``` Resultado: ``` { "reportGroup": { "arn": "arn:aws:codebuild:::report-group/cli-created-report-group", "name": "cli-created-report-group", "type": "TEST", "exportConfig": { "exportConfigType": "S3", "s3Destination": { "bucket": "amzn-s3-demo-bucket", "path": "", "packaging": "ZIP", "encryptionDisabled": true } }, "created": 1602020026.775, "lastModified": 1602020026.775 } } ``` Para obter mais informações, consulte [Trabalhar com grupos de relatórios](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group.html) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [CreateReportGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/create-report-group.html) na *Referência de comandos da AWS CLI*. ### `create-webhook` O código de exemplo a seguir mostra como usar `create-webhook`. **AWS CLI** **Para criar filtros de webhook para um projeto do AWS CodeBuild** O exemplo `create-webhook` a seguir cria um webhook para um projeto do CodeBuild chamado `my-project` que tem dois grupos de filtros. O primeiro grupo de filtros especifica as solicitações pull que são criadas, atualizadas ou reabertas nas ramificações com nomes de referência do Git que correspondam à expressão regular `^refs/heads/master$` e referências head que correspondam a `^refs/heads/myBranch$`. O segundo grupo de filtros especifica solicitações push em ramificações com nomes de referência do Git que não correspondam à expressão regular `^refs/heads/myBranch$`. ``` aws codebuild create-webhook \ --project-name my-project \ --filter-groups "[[{\"type\":\"EVENT\",\"pattern\":\"PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED\"},{\"type\":\"HEAD_REF\",\"pattern\":\"^refs/heads/myBranch$\",\"excludeMatchedPattern\":true},{\"type\":\"BASE_REF\",\"pattern\":\"^refs/heads/master$\",\"excludeMatchedPattern\":true}],[{\"type\":\"EVENT\",\"pattern\":\"PUSH\"},{\"type\":\"HEAD_REF\",\"pattern\":\"^refs/heads/myBranch$\",\"excludeMatchedPattern\":true}]]" ``` Resultado: ``` { "webhook": { "payloadUrl": "https://codebuild.us-west-2.amazonaws.com/webhooks?t=eyJlbmNyeXB0ZWREYXRhIjoiVVl5MGtoeGRwSzZFRXl2Wnh4bld1Z0tKZ291TVpQNEtFamQ3RDlDYWpRaGIreVFrdm9EQktIVk1NeHJEWEpmUDUrVUNOMUIyRHJRc1VxcHJ6QlNDSnljPSIsIml2UGFyYW1ldGVyU3BlYyI6InN4Tm1SeUt5MUhaUVRWbGciLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&v=1", "url": "https://api.github.com/repos/iversonic/codedeploy-sample/hooks/105190656", "lastModifiedSecret": 1556311319.069, "filterGroups": [ [ { "type": "EVENT", "pattern": "PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED", "excludeMatchedPattern": false }, { "type": "HEAD_REF", "pattern": "refs/heads/myBranch$", "excludeMatchedPattern": true }, { "type": "BASE_REF", "pattern": "refs/heads/master$", "excludeMatchedPattern": true } ], [ { "type": "EVENT", "pattern": "PUSH", "excludeMatchedPattern": false }, { "type": "HEAD_REF", "pattern": "refs/heads/myBranch$", "excludeMatchedPattern": true } ] ] } } ``` Para obter mais informações, consulte [Filtrar eventos de webhook (SDK) do GitHub](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-github-pull-request.html#sample-github-pull-request-filter-webhook-events-sdk) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [CreateWebhook](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/create-webhook.html) na *Referência de comandos da AWS CLI*. ### `delete-build-batch` O código de exemplo a seguir mostra como usar `delete-build-batch`. **AWS CLI** **Para excluir uma compilação em lote no AWS CodeBuild.** O exemplo `delete-build-batch` a seguir exclui a compilação em lote especificado. ``` aws codebuild delete-build-batch \ --id : ``` Resultado: ``` { "statusCode": "BATCH_DELETED", "buildsDeleted": [ "arn:aws:codebuild:::build/:", "arn:aws:codebuild:::build/:", "arn:aws:codebuild:::build/:", "arn:aws:codebuild:::build/:" ], "buildsNotDeleted": [] } ``` Para obter mais informações, consulte [Compilações em lote no AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/batch-build.html) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [DeleteBuildBatch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/delete-build-batch.html) na *Referência de comandos da AWS CLI*. ### `delete-project` O código de exemplo a seguir mostra como usar `delete-project`. **AWS CLI** **Para excluir um projeto de compilação do AWS CodeBuild** O exemplo `delete-project` a seguir exclui o projeto de compilação do CodeBuild especificado. ``` aws codebuild delete-project --name my-project ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir um projeto de compilação (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/delete-project.html) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [DeleteProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/delete-project.html) na *Referência de comandos da AWS CLI*. ### `delete-report-group` O código de exemplo a seguir mostra como usar `delete-report-group`. **AWS CLI** **Para excluir grupos de relatórios no AWS CodeBuild.** O exemplo `delete-report-group` a seguir exclui o grupo de relatório com o ARN especificado. ``` aws codebuild delete-report-group \ --arn arn:aws:codebuild:::report-group/ ``` Este comando não produz saída. Para obter mais informações, consulte [Trabalhar com grupos de relatórios](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group.html) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [DeleteReportGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/delete-report-group.html) na *Referência de comandos da AWS CLI*. ### `delete-report` O código de exemplo a seguir mostra como usar `delete-report`. **AWS CLI** **Para excluir um relatório no AWS CodeBuild.** O exemplo `delete-report` a seguir exclui o relatório especificado. ``` aws codebuild delete-report \ --arn arn:aws:codebuild:::report/: ``` Este comando não produz saída. Para obter mais informações, consulte [Trabalhar com relatórios](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report.html) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [DeleteReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/delete-report.html) na *Referência de comandos da AWS CLI*. ### `delete-source-credentials` O código de exemplo a seguir mostra como usar `delete-source-credentials`. **AWS CLI** **Para se desconectar de um provedor de origem e remover seus tokens de acesso.** O exemplo `delete-source-credentials` a seguir se desconecta de um provedor de origem e remove seus tokens. O ARN das credenciais de origem usadas para se conectar ao provedor de origem determina quais credenciais de origem. ``` aws codebuild delete-source-credentials --arn arn-of-your-credentials ``` Resultado: ``` { "arn": "arn:aws:codebuild:your-region:your-account-id:token/your-server-type" } ``` Para obter mais informações, consulte [Conectar provedores de origem com tokens de acesso (CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-access-tokens.html#sample-access-tokens-cli) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [DeleteSourceCredentials](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/delete-source-credentials.html) na *Referência de comandos da AWS CLI*. ### `delete-webhook` O código de exemplo a seguir mostra como usar `delete-webhook`. **AWS CLI** **Para excluir um filtro de webhook de um projeto do AWS CodeBuild** O exemplo `delete-webhook` a seguir exclui um webhook do projeto CodeBuild especificado. ``` aws codebuild delete-webhook --project-name my-project ``` Este comando não produz saída. Para obter mais informações, consulte [Interromper compilações em execução automaticamente (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/run-build.html#run-build-cli-auto-stop) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [DeleteWebhook](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/delete-webhook.html) na *Referência de comandos da AWS CLI*. ### `describe-code-coverages` O código de exemplo a seguir mostra como usar `describe-code-coverages`. **AWS CLI** **Para obter informações detalhadas sobre os resultados do teste de cobertura de código no AWS CodeBuild.** O exemplo `describe-code-coverages` a seguir obtém informações sobre os resultados do teste de cobertura de código no relatório especificado. ``` aws codebuild describe-code-coverages \ --report-arn arn:aws:codebuild:::report/: ``` Resultado: ``` { "codeCoverages": [ { "id": "20a0adcc-db13-4b66-804b-ecaf9f852855", "reportARN": "arn:aws:codebuild::972506530580:report/:", "filePath": "", "lineCoveragePercentage": 83.33, "linesCovered": 5, "linesMissed": 1, "branchCoveragePercentage": 50.0, "branchesCovered": 1, "branchesMissed": 1, "expired": "2020-11-20T21:22:45+00:00" }, { "id": "0887162d-bf57-4cf1-a164-e432373d1a83", "reportARN": "arn:aws:codebuild::972506530580:report/:", "filePath": "", "lineCoveragePercentage": 90.9, "linesCovered": 10, "linesMissed": 1, "branchCoveragePercentage": 50.0, "branchesCovered": 1, "branchesMissed": 1, "expired": "2020-11-20T21:22:45+00:00" } ] } ``` Para obter mais informações, consulte [Relatórios de cobertura de código](https://docs.aws.amazon.com/codebuild/latest/userguide/code-coverage-report.html) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [DescribeCodeCoverages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/describe-code-coverages.html) na *Referência de comandos da AWS CLI*. ### `describe-test-cases` O código de exemplo a seguir mostra como usar `describe-test-cases`. **AWS CLI** **Para obter informações detalhadas sobre casos de teste no AWS CodeBuild.** O exemplo `describe-test-cases` a seguir obtém informações sobre os casos de teste no relatório especificado. ``` aws codebuild describe-test-cases \ --report-arn arn:aws:codebuild:::report/: ``` Resultado: ``` { "testCases": [ { "reportArn": "arn:aws:codebuild:::report/:", "testRawDataPath": "", "prefix": "NUnit.Tests.Assemblies.MockTestFixture", "name": "NUnit.Tests.Assemblies.MockTestFixture.NotRunnableTest", "status": "ERROR", "durationInNanoSeconds": 0, "message": "No arguments were provided\n", "expired": "2020-11-20T17:52:10+00:00" }, { "reportArn": "arn:aws:codebuild:::report/:", "testRawDataPath": "", "prefix": "NUnit.Tests.Assemblies.MockTestFixture", "name": "NUnit.Tests.Assemblies.MockTestFixture.TestWithException", "status": "ERROR", "durationInNanoSeconds": 0, "message": "System.ApplicationException : Intentional Exception\nat NUnit.Tests.Assemblies.MockTestFixture.MethodThrowsException()\nat NUnit.Tests.Assemblies.MockTestFixture.TestWithException()\n\n", "expired": "2020-11-20T17:52:10+00:00" } ] } ``` Para obter mais informações, consulte [Trabalhar com relatórios de teste no AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/test-reporting.html) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [DescribeTestCases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/describe-test-cases.html) na *Referência de comandos da AWS CLI*. ### `import-source-credentials` O código de exemplo a seguir mostra como usar `import-source-credentials`. **AWS CLI** **Conecte um usuário do AWS CodeBuild a um provedor de origem importando credenciais para o provedor de origem.** O exemplo `import-source-credentials` a seguir importa um token para um repositório do Bitbucket que usa BASIC\$1AUTH como seu tipo de autenticação. ``` aws codebuild import-source-credentials --server-type BITBUCKET --auth-type BASIC_AUTH --token my-Bitbucket-password --username my-Bitbucket-username ``` Resultado: ``` { "arn": "arn:aws:codebuild:us-west-2:123456789012:token/bitbucket" } ``` Para obter mais informações, consulte [Conectar provedores de origem com tokens de acesso (CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-access-tokens.html#sample-access-tokens-cli) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [ImportSourceCredentials](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/import-source-credentials.html) na *Referência de comandos da AWS CLI*. ### `invalidate-project-cache` O código de exemplo a seguir mostra como usar `invalidate-project-cache`. **AWS CLI** **Como redefinir o cache de um projeto de compilação do AWS CodeBuild.** O exemplo `invalidate-project-cache` a seguir redefine o cache do projeto CodeBuild especificado. ``` aws codebuild invalidate-project-cache --project-name my-project ``` Este comando não produz saída. Para obter mais informações, consulte [Armazenamento em cache de compilação no CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/build-caching.html) no *Guia do usuário no AWS CodeBuild*. + Para ver detalhes da API, consulte [InvalidateProjectCache](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/invalidate-project-cache.html) na *Referência de comandos da AWS CLI*. ### `list-build-batches-for-project` O código de exemplo a seguir mostra como usar `list-build-batches-for-project`. **AWS CLI** **Para listar compilações em lote para um projeto de compilação específico no AWS CodeBuild.** O exemplo `list-build-batches-for-project` a seguir lista as compilações em lote do CodeBuild para o projeto especificado. ``` aws codebuild list-build-batches-for-project \ --project-name "" ``` Resultado: ``` { "ids": [ ":", ":" ] } ``` Para obter mais informações, consulte [Compilações em lote no AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/batch-build.html) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [ListBuildBatchesForProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-build-batches-for-project.html) na *Referência de comandos da AWS CLI*. ### `list-build-batches` O código de exemplo a seguir mostra como usar `list-build-batches`. **AWS CLI** **Para listar compilações em lote no AWS CodeBuild.** O exemplo `list-build-batches` a seguir lista as compilações em lote do CodeBuild para a conta atual. ``` aws codebuild list-build-batches ``` Resultado: ``` { "ids": [ ":", ":" ] } ``` Para obter mais informações, consulte Compilações em lote no AWS CodeBuild )\$1\$1 no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [ListBuildBatches](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-build-batches.html) na *Referência de comandos da AWS CLI*. ### `list-builds-for-project` O código de exemplo a seguir mostra como usar `list-builds-for-project`. **AWS CLI** **Como visualizar uma lista de compilações para um projeto de compilação do AWS CodeBuild.** O exemplo `list-builds-for-project` a seguir lista os IDs de compilação em ordem decrescente para o projeto de compilação do CodeBuild especificado. ``` aws codebuild list-builds-for-project --project-name codebuild-demo-project --sort-order DESCENDING ``` Resultado: ``` { "ids": [ "codebuild-demo-project:1a2b3c4d-5678-90ab-cdef-11111example", "codebuild-demo-project:1a2b3c4d-5678-90ab-cdef-22222example", "codebuild-demo-project:1a2b3c4d-5678-90ab-cdef-33333example", "codebuild-demo-project:1a2b3c4d-5678-90ab-cdef-44444example", "codebuild-demo-project:1a2b3c4d-5678-90ab-cdef-55555example" ] } ``` Para obter mais informações, consulte [Visualizar uma lista de IDs de um projeto de compilação (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/view-builds-for-project.html#view-builds-for-project-cli) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [ListBuildsForProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-builds-for-project.html) na *Referência de comandos da AWS CLI*. ### `list-builds` O código de exemplo a seguir mostra como usar `list-builds`. **AWS CLI** **Para obter uma lista de IDs de compilações do AWS CodeBuild.** O exemplo `list-builds` a seguir obtém uma lista de IDs do CodeBuild classificados em ordem crescente. ``` aws codebuild list-builds --sort-order ASCENDING ``` A saída inclui um valor `nextToken` que indica que há mais saída disponível. ``` { "nextToken": "4AEA6u7J...The full token has been omitted for brevity...MzY2OA==", "ids": [ "codebuild-demo-project:815e755f-bade-4a7e-80f0-efe51EXAMPLE" "codebuild-demo-project:84a7f3d1-d40e-4956-b4cf-7a9d4EXAMPLE" ... The full list of build IDs has been omitted for brevity ... "codebuild-demo-project:931d0b72-bf6f-4040-a472-5c707EXAMPLE" ] } ``` Execute esse comando novamente e forneça o valor `nextToken` na resposta anterior como parâmetro para obter a próxima parte da saída. Repita até que você não receba um valor `nextToken` na resposta. ``` aws codebuild list-builds --sort-order ASCENDING --next-token 4AEA6u7J...The full token has been omitted for brevity...MzY2OA== ``` Próxima parte da saída: ``` { "ids": [ "codebuild-demo-project:49015049-21cf-4b50-9708-df115EXAMPLE", "codebuild-demo-project:543e7206-68a3-46d6-a4da-759abEXAMPLE", ... The full list of build IDs has been omitted for brevity ... "codebuild-demo-project:c282f198-4582-4b38-bdc0-26f96EXAMPLE" ] } ``` Para obter mais informações, consulte [Exibir uma lista de IDs da compilação (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/view-build-list.html) no *Guia do usuário do AWS CodeBuild* + Para ver detalhes da API, consulte [ListBuilds](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-builds.html) na *Referência de comandos da AWS CLI*. ### `list-curated-environment-images` O código de exemplo a seguir mostra como usar `list-curated-environment-images`. **AWS CLI** **Para obter uma lista de imagens do Docker gerenciadas pelo AWS CodeBuild que você pode usar nas compilações.** O exemplo `list-curated-environment-images` a seguir lista as imagens do Docker gerenciadas pelo CodeBuild que podem ser usadas para compilações: ``` aws codebuild list-curated-environment-images ``` Resultado: ``` { "platforms": [ { "platform": "AMAZON_LINUX", "languages": [ { "language": "JAVA", "images": [ { "description": "AWS ElasticBeanstalk - Java 7 Running on Amazon Linux 64bit v2.1.3", "name": "aws/codebuild/eb-java-7-amazonlinux-64:2.1.3", "versions": [ "aws/codebuild/eb-java-7-amazonlinux-64:2.1.3-1.0.0" ] }, { "description": "AWS ElasticBeanstalk - Java 8 Running on Amazon Linux 64bit v2.1.3", "name": "aws/codebuild/eb-java-8-amazonlinux-64:2.1.3", "versions": [ "aws/codebuild/eb-java-8-amazonlinux-64:2.1.3-1.0.0" ] }, ... LIST TRUNCATED FOR BREVITY ... ] } ] } ] } ``` Para obter mais informações, consulte [Imagens do Docker fornecidas pelo CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [ListCuratedEnvironmentImages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-curated-environment-images.html) na *Referência de comandos da AWS CLI*. ### `list-projects` O código de exemplo a seguir mostra como usar `list-projects`. **AWS CLI** **Para obter uma lista de nomes de projeto de compilação do AWS CodeBuild.** O exemplo `list-projects` a seguir obtém uma lista de projetos de compilação do CodeBuild classificados por nome em ordem crescente. ``` aws codebuild list-projects --sort-by NAME --sort-order ASCENDING ``` A saída inclui um valor `nextToken` que indica que há mais saída disponível. ``` { "nextToken": "Ci33ACF6...The full token has been omitted for brevity...U+AkMx8=", "projects": [ "codebuild-demo-project", "codebuild-demo-project2", ... The full list of build project names has been omitted for brevity ... "codebuild-demo-project99" ] } ``` Execute esse comando novamente e forneça o valor `nextToken` da resposta anterior como parâmetro para obter a próxima parte da saída. Repita até que você não receba um valor `nextToken` na resposta. ``` aws codebuild list-projects --sort-by NAME --sort-order ASCENDING --next-token Ci33ACF6...The full token has been omitted for brevity...U+AkMx8= { "projects": [ "codebuild-demo-project100", "codebuild-demo-project101", ... The full list of build project names has been omitted for brevity ... "codebuild-demo-project122" ] } ``` Para obter mais informações, consulte [Exibir uma lista de nomes de projeto de compilação (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/view-project-list.html#view-project-list-cli) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [ListProjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-projects.html) na *Referência de comandos da AWS CLI*. ### `list-report-groups` O código de exemplo a seguir mostra como usar `list-report-groups`. **AWS CLI** **Para obter uma lista dos ARNs do grupo de relatórios no AWS CodeBuild.** O exemplo `list-report-groups` a seguir recupera os ARNs do grupo de relatórios da conta na região. ``` aws codebuild list-report-groups ``` Resultado: ``` { "reportGroups": [ "arn:aws:codebuild:::report-group/report-group-1", "arn:aws:codebuild:::report-group/report-group-2", "arn:aws:codebuild:::report-group/report-group-3" ] } ``` Para obter mais informações, consulte [Trabalhar com grupos de relatórios](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group.html) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [ListReportGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-report-groups.html) na *Referência de comandos da AWS CLI*. ### `list-reports-for-report-group` O código de exemplo a seguir mostra como usar `list-reports-for-report-group`. **AWS CLI** **Para obter uma lista dos relatórios em um grupo de relatórios no AWS CodeBuild.** O exemplo `list-report-for-report-groups` a seguir recupera os relatórios no grupo de relatórios especificado para a conta na região. ``` aws codebuild list-reports-for-report-group \ --report-group-arn arn:aws:codebuild:::report-group/ ``` Resultado: ``` { "reports": [ "arn:aws:codebuild:::report/report-1", "arn:aws:codebuild:::report/report-2", "arn:aws:codebuild:::report/report-3" ] } ``` Para obter mais informações, consulte [Trabalhar com grupos de relatórios](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group.html) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [ListReportsForReportGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-reports-for-report-group.html) na *Referência de comandos da AWS CLI*. ### `list-reports` O código de exemplo a seguir mostra como usar `list-reports`. **AWS CLI** **Para obter uma lista dos relatórios da conta atual no AWS CodeBuild.** O exemplo `list-reports` a seguir recupera os ARNs dos relatórios na conta atual. ``` aws codebuild list-reports ``` Resultado: ``` { "reports": [ "arn:aws:codebuild:::report/:", "arn:aws:codebuild:::report/:", "arn:aws:codebuild:::report/:" ] } ``` Para obter mais informações, consulte [Trabalhar com relatórios](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report.html) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [ListReports](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-reports.html) na *Referência de comandos da AWS CLI*. ### `list-shared-projects` O código de exemplo a seguir mostra como usar `list-shared-projects`. **AWS CLI** **Para listar o projeto compartilhado no AWS CodeBuild.** O exemplo `list-shared-projects` a seguir lista os projetos compartilhados do CodeBuild que estão disponíveis na conta atual. ``` aws codebuild list-shared-projects ``` Resultado: ``` { "projects": [ "arn:aws:codebuild:::project/", "arn:aws:codebuild:::project/" ] } ``` Para obter mais informações, consulte [Trabalhar com projetos compartilhados](https://docs.aws.amazon.com/codebuild/latest/userguide/project-sharing.html) no * Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [ListSharedProjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-shared-projects.html) na *Referência de comandos da AWS CLI*. ### `list-shared-report-groups` O código de exemplo a seguir mostra como usar `list-shared-report-groups`. **AWS CLI** **Para obter uma lista dos ARNs do grupo de relatórios compartilhados no AWS CodeBuild.** O exemplo `list-shared-report-groups` a seguir recupera os ARNs do grupo de relatórios da conta na região. ``` aws codebuild list-shared-report-groups ``` Resultado: ``` { "reportGroups": [ "arn:aws:codebuild:::report-group/report-group-1", "arn:aws:codebuild:::report-group/report-group-2", "arn:aws:codebuild:::report-group/report-group-3" ] } ``` Para obter mais informações, consulte [Trabalhar com grupos de relatórios](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group.html) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [ListSharedReportGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-shared-report-groups.html) na *Referência de comandos da AWS CLI*. ### `list-source-credentials` O código de exemplo a seguir mostra como usar `list-source-credentials`. **AWS CLI** **Para visualizar uma lista de sourceCredentialsObjects** O exemplo `list-source-credentials` a seguir lista tokens para uma conta da AWS conectada a uma conta do Bitbucket e a uma conta do GitHub. Cada objeto `sourceCredentialsInfos` na resposta contém informações de credenciais de origem conectada. ``` aws codebuild list-source-credentials ``` Resultado: ``` { "sourceCredentialsInfos": [ { "serverType": "BITBUCKET", "arn": "arn:aws:codebuild:us-west-2:123456789012:token/bitbucket", "authType": "BASIC_AUTH" }, { "serverType": "GITHUB", "arn": "arn:aws:codebuild:us-west-2:123456789012:token/github", "authType": "OAUTH" } ] } ``` Para obter mais informações, consulte [Conectar provedores de origem com tokens de acesso (CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-access-tokens.html#sample-access-tokens-cli) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [ListSourceCredentials](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-source-credentials.html) na *Referência de comandos da AWS CLI*. ### `retry-build-batch` O código de exemplo a seguir mostra como usar `retry-build-batch`. **AWS CLI** **Como tentar novamente uma compilação em lote com falha no AWS CodeBuild.** O exemplo `retry-build-batch` a seguir reinicia a compilação em lote especificada. ``` aws codebuild retry-build-batch \ --id : ``` Resultado: ``` { "buildBatch": { "id": ":", "arn": "arn:aws:codebuild:::build-batch/:", "startTime": "2020-10-21T17:26:23.099000+00:00", "currentPhase": "SUBMITTED", "buildBatchStatus": "IN_PROGRESS", "resolvedSourceVersion": "3a9e11cb419e8fff14b03883dc4e64f6155aaa7e", "projectName": "", "phases": [ { "phaseType": "SUBMITTED", "phaseStatus": "SUCCEEDED", "startTime": "2020-10-21T17:26:23.099000+00:00", "endTime": "2020-10-21T17:26:23.457000+00:00", "durationInSeconds": 0 }, { "phaseType": "DOWNLOAD_BATCHSPEC", "phaseStatus": "SUCCEEDED", "startTime": "2020-10-21T17:26:23.457000+00:00", "endTime": "2020-10-21T17:26:54.902000+00:00", "durationInSeconds": 31 }, { "phaseType": "IN_PROGRESS", "phaseStatus": "CLIENT_ERROR", "startTime": "2020-10-21T17:26:54.902000+00:00", "endTime": "2020-10-21T17:28:16.060000+00:00", "durationInSeconds": 81 }, { "phaseType": "FAILED", "phaseStatus": "RETRY", "startTime": "2020-10-21T17:28:16.060000+00:00", "endTime": "2020-10-21T17:29:39.709000+00:00", "durationInSeconds": 83 }, { "phaseType": "SUBMITTED", "startTime": "2020-10-21T17:29:39.709000+00:00" } ], "source": { "type": "GITHUB", "location": "https://github.com/strohm-a/-graph.git", "gitCloneDepth": 1, "gitSubmodulesConfig": { "fetchSubmodules": false }, "reportBuildStatus": false, "insecureSsl": false }, "secondarySources": [], "secondarySourceVersions": [], "artifacts": { "location": "" }, "secondaryArtifacts": [], "cache": { "type": "NO_CACHE" }, "environment": { "type": "LINUX_CONTAINER", "image": "aws/codebuild/amazonlinux2-x86_64-standard:3.0", "computeType": "BUILD_GENERAL1_SMALL", "environmentVariables": [], "privilegedMode": false, "imagePullCredentialsType": "CODEBUILD" }, "logConfig": { "cloudWatchLogs": { "status": "ENABLED" }, "s3Logs": { "status": "DISABLED", "encryptionDisabled": false } }, "buildTimeoutInMinutes": 60, "queuedTimeoutInMinutes": 480, "complete": false, "initiator": "", "encryptionKey": "arn:aws:kms:::alias/aws/s3", "buildBatchNumber": 4, "buildBatchConfig": { "serviceRole": "arn:aws:iam:::role/service-role/", "restrictions": { "maximumBuildsAllowed": 100 }, "timeoutInMins": 480 }, "buildGroups": [ { "identifier": "DOWNLOAD_SOURCE", "ignoreFailure": false, "currentBuildSummary": { "arn": "arn:aws:codebuild:::build/:", "requestedOn": "2020-10-21T17:26:23.889000+00:00", "buildStatus": "SUCCEEDED", "primaryArtifact": { "type": "no_artifacts", "identifier": "DOWNLOAD_SOURCE" }, "secondaryArtifacts": [] } }, { "identifier": "linux_small", "dependsOn": [], "ignoreFailure": false, "currentBuildSummary": { "arn": "arn:aws:codebuild:::build/:", "requestedOn": "2020-10-21T17:26:55.115000+00:00", "buildStatus": "FAILED", "primaryArtifact": { "type": "no_artifacts", "identifier": "linux_small" }, "secondaryArtifacts": [] } }, { "identifier": "linux_medium", "dependsOn": [ "linux_small" ], "ignoreFailure": false, "currentBuildSummary": { "arn": "arn:aws:codebuild:::build/:", "requestedOn": "2020-10-21T17:26:54.594000+00:00", "buildStatus": "STOPPED" } }, { "identifier": "linux_large", "dependsOn": [ "linux_medium" ], "ignoreFailure": false, "currentBuildSummary": { "arn": "arn:aws:codebuild:::build/:", "requestedOn": "2020-10-21T17:26:54.701000+00:00", "buildStatus": "STOPPED" } } ] } } ``` Para obter mais informações, consulte [Compilações em lote no AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/batch-build.html) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [RetryBuildBatch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/retry-build-batch.html) na *Referência de comandos da AWS CLI*. ### `retry-build` O código de exemplo a seguir mostra como usar `retry-build`. **AWS CLI** **Como tentar novamente uma compilação com falha no AWS CodeBuild.** O exemplo `retry-build` a seguir reinicia a compilação especificada. ``` aws codebuild retry-build \ --id : ``` Resultado: ``` { "build": { "id": ":", "arn": "arn:aws:codebuild:::build/:", "buildNumber": 9, "startTime": "2020-10-21T17:51:38.161000+00:00", "currentPhase": "QUEUED", "buildStatus": "IN_PROGRESS", "projectName": "", "phases": [ { "phaseType": "SUBMITTED", "phaseStatus": "SUCCEEDED", "startTime": "2020-10-21T17:51:38.161000+00:00", "endTime": "2020-10-21T17:51:38.210000+00:00", "durationInSeconds": 0 }, { "phaseType": "QUEUED", "startTime": "2020-10-21T17:51:38.210000+00:00" } ], "source": { "type": "GITHUB", "location": "", "gitCloneDepth": 1, "gitSubmodulesConfig": { "fetchSubmodules": false }, "reportBuildStatus": false, "insecureSsl": false }, "secondarySources": [], "secondarySourceVersions": [], "artifacts": { "location": "" }, "secondaryArtifacts": [], "cache": { "type": "NO_CACHE" }, "environment": { "type": "LINUX_CONTAINER", "image": "aws/codebuild/amazonlinux2-x86_64-standard:3.0", "computeType": "BUILD_GENERAL1_SMALL", "environmentVariables": [], "privilegedMode": false, "imagePullCredentialsType": "CODEBUILD" }, "serviceRole": "arn:aws:iam:::role/service-role/", "logs": { "deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=#logEvent:group=null;stream=null", "cloudWatchLogsArn": "arn:aws:logs:::log-group:null:log-stream:null", "cloudWatchLogs": { "status": "ENABLED" }, "s3Logs": { "status": "DISABLED", "encryptionDisabled": false } }, "timeoutInMinutes": 60, "queuedTimeoutInMinutes": 480, "buildComplete": false, "initiator": "", "encryptionKey": "arn:aws:kms:::alias/aws/s3" } } ``` Para obter mais informações, consulte [Compilações em lote no AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/batch-build.html) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [RetryBuild](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/retry-build.html) na *Referência de comandos da AWS CLI*. ### `start-build-batch` O código de exemplo a seguir mostra como usar `start-build-batch`. **AWS CLI** **Para iniciar uma compilação em lote no AWS CodeBuild.** O exemplo `start-build-batch` a seguir inicia uma compilação em lote do projeto especificado. ``` aws codebuild start-build-batch \ --project-name ``` Resultado: ``` { "buildBatch": { "id": ":", "arn": "arn:aws:codebuild:::build-batch/:", "startTime": "2020-10-21T16:54:24.740000+00:00", "currentPhase": "SUBMITTED", "buildBatchStatus": "IN_PROGRESS", "projectName": "", "source": { "type": "GITHUB", "location": "", "gitCloneDepth": 1, "gitSubmodulesConfig": { "fetchSubmodules": false }, "reportBuildStatus": false, "insecureSsl": false }, "secondarySources": [], "secondarySourceVersions": [], "artifacts": { "location": "" }, "secondaryArtifacts": [], "cache": { "type": "NO_CACHE" }, "environment": { "type": "LINUX_CONTAINER", "image": "aws/codebuild/amazonlinux2-x86_64-standard:3.0", "computeType": "BUILD_GENERAL1_SMALL", "environmentVariables": [], "privilegedMode": false, "imagePullCredentialsType": "CODEBUILD" }, "logConfig": { "cloudWatchLogs": { "status": "ENABLED" }, "s3Logs": { "status": "DISABLED", "encryptionDisabled": false } }, "buildTimeoutInMinutes": 60, "queuedTimeoutInMinutes": 480, "complete": false, "initiator": "", "encryptionKey": "arn:aws:kms:::alias/aws/s3", "buildBatchNumber": 3, "buildBatchConfig": { "serviceRole": "arn:aws:iam:::role/service-role/", "restrictions": { "maximumBuildsAllowed": 100 }, "timeoutInMins": 480 } } } ``` Para obter mais informações, consulte [Compilações em lote no AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/batch-build.html) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [StartBuildBatch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/start-build-batch.html) na *Referência de comandos da AWS CLI*. ### `start-build` O código de exemplo a seguir mostra como usar `start-build`. **AWS CLI** **Como começar a executar uma compilação de um projeto de compilação do AWS CodeBuild.** O exemplo `start-build` a seguir inicia uma compilação para o projeto do CodeBuild especificado. A compilação substitui a configuração do projeto pelo número de minutos que a compilação pode ficar na fila antes de atingir o tempo limite e as configurações de artefato do projeto. ``` aws codebuild start-build \ --project-name "my-demo-project" \ --queued-timeout-in-minutes-override 5 \ --artifacts-override {"\"type\": \"S3\",\"location\": \"arn:aws:s3:::artifacts-override\",\"overrideArtifactName\":true"} ``` Resultado: ``` { "build": { "serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role", "buildStatus": "IN_PROGRESS", "buildComplete": false, "projectName": "my-demo-project", "timeoutInMinutes": 60, "source": { "insecureSsl": false, "type": "S3", "location": "codebuild-us-west-2-123456789012-input-bucket/my-source.zip" }, "queuedTimeoutInMinutes": 5, "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3", "currentPhase": "QUEUED", "startTime": 1556905683.568, "environment": { "computeType": "BUILD_GENERAL1_MEDIUM", "environmentVariables": [], "type": "LINUX_CONTAINER", "privilegedMode": false, "image": "aws/codebuild/standard:1.0", "imagePullCredentialsType": "CODEBUILD" }, "phases": [ { "phaseStatus": "SUCCEEDED", "startTime": 1556905683.568, "phaseType": "SUBMITTED", "durationInSeconds": 0, "endTime": 1556905684.524 }, { "startTime": 1556905684.524, "phaseType": "QUEUED" } ], "logs": { "deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-west-2#logEvent:group=null;stream=null" }, "artifacts": { "encryptionDisabled": false, "location": "arn:aws:s3:::artifacts-override/my-demo-project", "overrideArtifactName": true }, "cache": { "type": "NO_CACHE" }, "id": "my-demo-project::12345678-a1b2-c3d4-e5f6-11111EXAMPLE", "initiator": "my-aws-account-name", "arn": "arn:aws:codebuild:us-west-2:123456789012:build/my-demo-project::12345678-a1b2-c3d4-e5f6-11111EXAMPLE" } } ``` Para obter mais informações, consulte [Executar uma compilação (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/run-build.html#run-build-cli) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [StartBuild](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/start-build.html) na *Referência de comandos da AWS CLI*. ### `stop-build-batch` O código de exemplo a seguir mostra como usar `stop-build-batch`. **AWS CLI** **Como interromper uma compilação em lote em andamento no AWS CodeBuild.** O exemplo `stop-build-batch` a seguir interrompe a criação em lote especificada. ``` aws codebuild stop-build-batch \ --id : ``` Resultado: ``` { "buildBatch": { "id": ":", "arn": "arn:aws:codebuild:::build-batch/:", "startTime": "2020-10-21T16:54:24.740000+00:00", "endTime": "2020-10-21T16:56:05.152000+00:00", "currentPhase": "STOPPED", "buildBatchStatus": "STOPPED", "resolvedSourceVersion": "aef7744ed069c51098e15c360f4102cd2cd1ad64", "projectName": "", "phases": [ { "phaseType": "SUBMITTED", "phaseStatus": "SUCCEEDED", "startTime": "2020-10-21T16:54:24.740000+00:00", "endTime": "2020-10-21T16:54:25.039000+00:00", "durationInSeconds": 0 }, { "phaseType": "DOWNLOAD_BATCHSPEC", "phaseStatus": "SUCCEEDED", "startTime": "2020-10-21T16:54:25.039000+00:00", "endTime": "2020-10-21T16:54:56.583000+00:00", "durationInSeconds": 31 }, { "phaseType": "IN_PROGRESS", "phaseStatus": "STOPPED", "startTime": "2020-10-21T16:54:56.583000+00:00", "endTime": "2020-10-21T16:56:05.152000+00:00", "durationInSeconds": 68 }, { "phaseType": "STOPPED", "startTime": "2020-10-21T16:56:05.152000+00:00" } ], "source": { "type": "GITHUB", "location": "", "gitCloneDepth": 1, "gitSubmodulesConfig": { "fetchSubmodules": false }, "reportBuildStatus": false, "insecureSsl": false }, "secondarySources": [], "secondarySourceVersions": [], "artifacts": { "location": "" }, "secondaryArtifacts": [], "cache": { "type": "NO_CACHE" }, "environment": { "type": "LINUX_CONTAINER", "image": "aws/codebuild/amazonlinux2-x86_64-standard:3.0", "computeType": "BUILD_GENERAL1_SMALL", "environmentVariables": [], "privilegedMode": false, "imagePullCredentialsType": "CODEBUILD" }, "logConfig": { "cloudWatchLogs": { "status": "ENABLED" }, "s3Logs": { "status": "DISABLED", "encryptionDisabled": false } }, "buildTimeoutInMinutes": 60, "queuedTimeoutInMinutes": 480, "complete": true, "initiator": "Strohm", "encryptionKey": "arn:aws:kms:::alias/aws/s3", "buildBatchNumber": 3, "buildBatchConfig": { "serviceRole": "arn:aws:iam:::role/service-role/", "restrictions": { "maximumBuildsAllowed": 100 }, "timeoutInMins": 480 }, "buildGroups": [ { "identifier": "DOWNLOAD_SOURCE", "ignoreFailure": false, "currentBuildSummary": { "arn": "arn:aws:codebuild:::build/:", "requestedOn": "2020-10-21T16:54:25.468000+00:00", "buildStatus": "SUCCEEDED", "primaryArtifact": { "type": "no_artifacts", "identifier": "DOWNLOAD_SOURCE" }, "secondaryArtifacts": [] } }, { "identifier": "linux_small", "dependsOn": [], "ignoreFailure": false, "currentBuildSummary": { "arn": "arn:aws:codebuild:::build/:", "requestedOn": "2020-10-21T16:54:56.833000+00:00", "buildStatus": "IN_PROGRESS" } }, { "identifier": "linux_medium", "dependsOn": [ "linux_small" ], "ignoreFailure": false, "currentBuildSummary": { "arn": "arn:aws:codebuild:::build/:", "requestedOn": "2020-10-21T16:54:56.211000+00:00", "buildStatus": "PENDING" } }, { "identifier": "linux_large", "dependsOn": [ "linux_medium" ], "ignoreFailure": false, "currentBuildSummary": { "arn": "arn:aws:codebuild:::build/:", "requestedOn": "2020-10-21T16:54:56.330000+00:00", "buildStatus": "PENDING" } } ] } } ``` Para obter mais informações, consulte [Compilações em lote no AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/batch-build.html) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [StopBuildBatch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/stop-build-batch.html) na *Referência de comandos da AWS CLI*. ### `stop-build` O código de exemplo a seguir mostra como usar `stop-build`. **AWS CLI** **Como interromper a compilação de um projeto de compilação do AWS CodeBuild.** O exemplo `stop-build` a seguir interrompe a compilação especificada do CodeBuild. ``` aws codebuild stop-build --id my-demo-project:12345678-a1b2-c3d4-e5f6-11111EXAMPLE ``` Resultado: ``` { "build": { "startTime": 1556906956.318, "initiator": "my-aws-account-name", "projectName": "my-demo-project", "currentPhase": "COMPLETED", "cache": { "type": "NO_CACHE" }, "source": { "insecureSsl": false, "location": "codebuild-us-west-2-123456789012-input-bucket/my-source.zip", "type": "S3" }, "id": "my-demo-project:1a2b3c4d-5678-90ab-cdef-11111EXAMPLE", "endTime": 1556906974.781, "phases": [ { "durationInSeconds": 0, "phaseType": "SUBMITTED", "endTime": 1556906956.935, "phaseStatus": "SUCCEEDED", "startTime": 1556906956.318 }, { "durationInSeconds": 1, "phaseType": "QUEUED", "endTime": 1556906958.272, "phaseStatus": "SUCCEEDED", "startTime": 1556906956.935 }, { "phaseType": "PROVISIONING", "phaseStatus": "SUCCEEDED", "durationInSeconds": 14, "contexts": [ { "message": "", "statusCode": "" } ], "endTime": 1556906972.847, "startTime": 1556906958.272 }, { "phaseType": "DOWNLOAD_SOURCE", "phaseStatus": "SUCCEEDED", "durationInSeconds": 0, "contexts": [ { "message": "", "statusCode": "" } ], "endTime": 1556906973.552, "startTime": 1556906972.847 }, { "phaseType": "INSTALL", "phaseStatus": "SUCCEEDED", "durationInSeconds": 0, "contexts": [ { "message": "", "statusCode": "" } ], "endTime": 1556906973.75, "startTime": 1556906973.552 }, { "phaseType": "PRE_BUILD", "phaseStatus": "SUCCEEDED", "durationInSeconds": 0, "contexts": [ { "message": "", "statusCode": "" } ], "endTime": 1556906973.937, "startTime": 1556906973.75 }, { "durationInSeconds": 0, "phaseType": "BUILD", "endTime": 1556906974.781, "phaseStatus": "STOPPED", "startTime": 1556906973.937 }, { "phaseType": "COMPLETED", "startTime": 1556906974.781 } ], "artifacts": { "location": "arn:aws:s3:::artifacts-override/my-demo-project", "encryptionDisabled": false, "overrideArtifactName": true }, "buildComplete": true, "buildStatus": "STOPPED", "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3", "serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role", "queuedTimeoutInMinutes": 5, "timeoutInMinutes": 60, "environment": { "type": "LINUX_CONTAINER", "environmentVariables": [], "computeType": "BUILD_GENERAL1_MEDIUM", "privilegedMode": false, "image": "aws/codebuild/standard:1.0", "imagePullCredentialsType": "CODEBUILD" }, "logs": { "streamName": "1a2b3c4d-5678-90ab-cdef-11111EXAMPLE", "deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-west-2#logEvent:group=/aws/codebuild/my-demo-project;stream=1a2b3c4d-5678-90ab-cdef-11111EXAMPLE", "groupName": "/aws/codebuild/my-demo-project" }, "arn": "arn:aws:codebuild:us-west-2:123456789012:build/my-demo-project:1a2b3c4d-5678-90ab-cdef-11111EXAMPLE" } } ``` Para obter mais informações, consulte [Interromper uma compilação (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/stop-build.html#stop-build-cli) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [StopBuild](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/stop-build.html) na *Referência de comandos da AWS CLI*. ### `update-project` O código de exemplo a seguir mostra como usar `update-project`. **AWS CLI** **Para alterar as configurações de um projeto de compilação do AWS CodeBuild.** O exemplo `update-project` a seguir altera as configurações do projeto de compilação do CodeBuild especificado chamado my-demo-project. ``` aws codebuild update-project --name "my-demo-project" \ --description "This project is updated" \ --source "{\"type\": \"S3\",\"location\": \"codebuild-us-west-2-123456789012-input-bucket/my-source-2.zip\"}" \ --artifacts {"\"type\": \"S3\",\"location\": \"codebuild-us-west-2-123456789012-output-bucket-2\""} \ --environment "{\"type\": \"LINUX_CONTAINER\",\"image\": \"aws/codebuild/standard:1.0\",\"computeType\": \"BUILD_GENERAL1_MEDIUM\"}" \ --service-role "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role" ``` A saída exibe as configurações atualizadas. ``` { "project": { "arn": "arn:aws:codebuild:us-west-2:123456789012:project/my-demo-project", "environment": { "privilegedMode": false, "environmentVariables": [], "type": "LINUX_CONTAINER", "image": "aws/codebuild/standard:1.0", "computeType": "BUILD_GENERAL1_MEDIUM", "imagePullCredentialsType": "CODEBUILD" }, "queuedTimeoutInMinutes": 480, "description": "This project is updated", "artifacts": { "packaging": "NONE", "name": "my-demo-project", "type": "S3", "namespaceType": "NONE", "encryptionDisabled": false, "location": "codebuild-us-west-2-123456789012-output-bucket-2" }, "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3", "badge": { "badgeEnabled": false }, "serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role", "lastModified": 1556840545.967, "tags": [], "timeoutInMinutes": 60, "created": 1556839783.274, "name": "my-demo-project", "cache": { "type": "NO_CACHE" }, "source": { "type": "S3", "insecureSsl": false, "location": "codebuild-us-west-2-123456789012-input-bucket/my-source-2.zip" } } } ``` Para obter mais informações, consulte [Alterar as configurações de um projeto de compilação (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/change-project.html#change-project-cli) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [UpdateProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/update-project.html) na *Referência de comandos da AWS CLI*. ### `update-report-group` O código de exemplo a seguir mostra como usar `update-report-group`. **AWS CLI** **Para atualizar um grupo de relatórios no AWS CodeBuild.** O exemplo `update-report-group` a seguir altera o tipo de exportação do grupo de relatórios para “NO\$1EXPORT”. ``` aws codebuild update-report-group \ --arn arn:aws:codebuild:::report-group/cli-created-report-group \ --export-config="exportConfigType=NO_EXPORT" ``` Resultado: ``` { "reportGroup": { "arn": "arn:aws:codebuild:::report-group/cli-created-report-group", "name": "cli-created-report-group", "type": "TEST", "exportConfig": { "exportConfigType": "NO_EXPORT" }, "created": 1602020686.009, "lastModified": 1602021033.454, "tags": [] } } ``` Para obter mais informações, consulte [Trabalhar com grupos de relatórios](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group.html) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [UpdateReportGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/update-report-group.html) na *Referência de comandos da AWS CLI*. ### `update-webhook` O código de exemplo a seguir mostra como usar `update-webhook`. **AWS CLI** **Para atualizar o webhook para um projeto do AWS CodeBuild** O exemplo `update-webhook` a seguir atualiza um webhook para o projeto CodeBuild especificado com dois grupos de filtros. O parâmetro `--rotate-secret` especifica que o GitHub alterne a chave secreta do projeto sempre que uma alteração no código acionar uma compilação. O primeiro grupo de filtros especifica as solicitações pull que são criadas, atualizadas ou reabertas nas ramificações com nomes de referência do Git que correspondam à expressão regular `^refs/heads/master$` e referências head que correspondam a `^refs/heads/myBranch$`. O segundo grupo de filtros especifica solicitações push em ramificações com nomes de referência do Git que não correspondam à expressão regular `^refs/heads/myBranch$`. ``` aws codebuild update-webhook \ --project-name Project2 \ --rotate-secret \ --filter-groups "[[{\"type\":\"EVENT\",\"pattern\":\"PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED\"},{\"type\":\"HEAD_REF\",\"pattern\":\"^refs/heads/myBranch$\",\"excludeMatchedPattern\":true},{\"type\":\"BASE_REF\",\"pattern\":\"^refs/heads/master$\",\"excludeMatchedPattern\":true}],[{\"type\":\"EVENT\",\"pattern\":\"PUSH\"},{\"type\":\"HEAD_REF\",\"pattern\":\"^refs/heads/myBranch$\",\"excludeMatchedPattern\":true}]]" ``` Resultado: ``` { "webhook": { "filterGroups": [ [ { "pattern": "PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED", "type": "EVENT" }, { "excludeMatchedPattern": true, "pattern": "refs/heads/myBranch$", "type": "HEAD_REF" }, { "excludeMatchedPattern": true, "pattern": "refs/heads/master$", "type": "BASE_REF" } ], [ { "pattern": "PUSH", "type": "EVENT" }, { "excludeMatchedPattern": true, "pattern": "refs/heads/myBranch$", "type": "HEAD_REF" } ] ], "lastModifiedSecret": 1556312220.133 } } ``` Para obter mais informações, consulte [Alterar as configurações de um projeto de compilação (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/change-project.html#change-project-cli) no *Guia do usuário do AWS CodeBuild*. + Para ver detalhes da API, consulte [UpdateWebhook](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/update-webhook.html) na *Referência de comandos da AWS CLI*. # Exemplos do CodeCommit usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o 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 ### `associate-approval-rule-template-with-repository` O código de exemplo a seguir mostra como usar `associate-approval-rule-template-with-repository`. **AWS CLI** **Como associar um modelo de regra de aprovação a um repositório** O exemplo `associate-approval-rule-template-with-repository` a seguir associa o modelo de regra de aprovação especificado a um repositório chamado `MyDemoRepo`. ``` aws codecommit associate-approval-rule-template-with-repository \ --repository-name MyDemoRepo \ --approval-rule-template-name 2-approver-rule-for-main ``` Este comando não produz saída. Para obter mais informações, consulte [Associar um modelo de regra de aprovação a um repositório](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-associate-template.html#associate-template-repository) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [AssociateApprovalRuleTemplateWithRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/associate-approval-rule-template-with-repository.html) na *Referência de comandos da AWS CLI*. ### `batch-associate-approval-rule-template-with-repositories` O código de exemplo a seguir mostra como usar `batch-associate-approval-rule-template-with-repositories`. **AWS CLI** **Como associar um modelo de regra de aprovação a vários repositórios em uma única operação** O exemplo `batch-associate-approval-rule-template-with-repositories` a seguir associa o modelo de regra de aprovação especificado a repositórios chamados `MyDemoRepo` e `MyOtherDemoRepo`. Observação: os modelos de regra de aprovação são específicos para a região da AWS onde são criados. Eles só podem ser associados a repositórios nessa região da AWS. ``` aws codecommit batch-associate-approval-rule-template-with-repositories \ --repository-names MyDemoRepo, MyOtherDemoRepo \ --approval-rule-template-name 2-approver-rule-for-main ``` Resultado: ``` { "associatedRepositoryNames": [ "MyDemoRepo", "MyOtherDemoRepo" ], "errors": [] } ``` Para obter mais informações, consulte [Associar um modelo de regra de aprovação a um repositório](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-associate-template.html#batch-associate-template-repositories) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [BatchAssociateApprovalRuleTemplateWithRepositories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/batch-associate-approval-rule-template-with-repositories.html) na * Referência de comandos da AWS CLI*. ### `batch-describe-merge-conflicts` O código de exemplo a seguir mostra como usar `batch-describe-merge-conflicts`. **AWS CLI** **Para obter informações sobre conflitos de mesclagem em todos os arquivos ou um subconjunto de arquivos em uma mesclagem entre dois especificadores de confirmação** O exemplo `batch-describe-merge-conflicts` a seguir determina os conflitos de mesclagem para mesclar uma ramificação de origem chamada `feature-randomizationfeature` com uma ramificação de destino chamada `main` usando a estratégia `THREE_WAY_MERGE` em um repositório chamado `MyDemoRepo`. ``` aws codecommit batch-describe-merge-conflicts \ --source-commit-specifier feature-randomizationfeature \ --destination-commit-specifier main \ --merge-option THREE_WAY_MERGE \ --repository-name MyDemoRepo ``` Resultado: ``` { "conflicts": [ { "conflictMetadata": { "filePath": "readme.md", "fileSizes": { "source": 139, "destination": 230, "base": 85 }, "fileModes": { "source": "NORMAL", "destination": "NORMAL", "base": "NORMAL" }, "objectTypes": { "source": "FILE", "destination": "FILE", "base": "FILE" }, "numberOfConflicts": 1, "isBinaryFile": { "source": false, "destination": false, "base": false }, "contentConflict": true, "fileModeConflict": false, "objectTypeConflict": false, "mergeOperations": { "source": "M", "destination": "M" } }, "mergeHunks": [ { "isConflict": true, "source": { "startLine": 0, "endLine": 3, "hunkContent": "VGhpcyBpEXAMPLE==" }, "destination": { "startLine": 0, "endLine": 1, "hunkContent": "VXNlIHRoEXAMPLE=" } } ] } ], "errors": [], "destinationCommitId": "86958e0aEXAMPLE", "sourceCommitId": "6ccd57fdEXAMPLE", "baseCommitId": "767b6958EXAMPLE" } ``` Para obter mais informações, consulte [Resolver conflitos em uma solicitação pull](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-resolve-conflict-pull-request.html#batch-describe-merge-conflicts) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [BatchDescribeMergeConflicts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/batch-describe-merge-conflicts.html) na *Referência de comandos da AWS CLI*. ### `batch-disassociate-approval-rule-template-from-repositories` O código de exemplo a seguir mostra como usar `batch-disassociate-approval-rule-template-from-repositories`. **AWS CLI** **Como desassociar um modelo de regra de aprovação de vários repositórios em uma única operação** O exemplo `batch-disassociate-approval-rule-template-from-repositories` a seguir desassocia o modelo de regra de aprovação especificado dos repositórios chamados `MyDemoRepo` e `MyOtherDemoRepo`. ``` aws codecommit batch-disassociate-approval-rule-template-from-repositories \ --repository-names MyDemoRepo, MyOtherDemoRepo \ --approval-rule-template-name 1-approval-rule-for-all pull requests ``` Resultado: ``` { "disassociatedRepositoryNames": [ "MyDemoRepo", "MyOtherDemoRepo" ], "errors": [] } ``` Para obter mais informações, consulte [Desassociar um modelo de regra de aprovação](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-disassociate-template.html#batch-disassociate-template) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [BatchDisassociateApprovalRuleTemplateFromRepositories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/batch-disassociate-approval-rule-template-from-repositories.html) na * Referência de comandos da AWS CLI*. ### `batch-get-commits` O código de exemplo a seguir mostra como usar `batch-get-commits`. **AWS CLI** **Como visualizar informações sobre várias confirmações** O exemplo `batch-get-commits` a seguir exibe detalhes das confirmações especificadas. ``` aws codecommit batch-get-commits \ --repository-name MyDemoRepo \ --commit-ids 317f8570EXAMPLE 4c925148EXAMPLE ``` Resultado: ``` { "commits": [ { "additionalData": "", "committer": { "date": "1508280564 -0800", "name": "Mary Major", "email": "mary_major@example.com" }, "author": { "date": "1508280564 -0800", "name": "Mary Major", "email": "mary_major@example.com" }, "commitId": "317f8570EXAMPLE", "treeId": "1f330709EXAMPLE", "parents": [ "6e147360EXAMPLE" ], "message": "Change variable name and add new response element" }, { "additionalData": "", "committer": { "date": "1508280542 -0800", "name": "Li Juan", "email": "li_juan@example.com" }, "author": { "date": "1508280542 -0800", "name": "Li Juan", "email": "li_juan@example.com" }, "commitId": "4c925148EXAMPLE", "treeId": "1f330709EXAMPLE", "parents": [ "317f8570EXAMPLE" ], "message": "Added new class" } } ``` Para obter mais informações, consulte [Visualizar detalhes da confirmação](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-view-commit-details.html#how-to-view-commit-details-cli-batch-get-commits) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [BatchGetCommits](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/batch-get-commits.html) na *Referência de comandos da AWS CLI*. ### `batch-get-repositories` O código de exemplo a seguir mostra como usar `batch-get-repositories`. **AWS CLI** **Como visualizar detalhes sobre vários repositórios** Este exemplo mostra detalhes sobre vários repositórios do AWS CodeCommit. ``` aws codecommit batch-get-repositories \ --repository-names MyDemoRepo MyOtherDemoRepo ``` Resultado: ``` { "repositoriesNotFound": [], "repositories": [ { "creationDate": 1429203623.625, "defaultBranch": "main", "repositoryName": "MyDemoRepo", "cloneUrlSsh": "ssh://git-codecommit.us-east-2.amazonaws.com/v1/repos/MyDemoRepo", "lastModifiedDate": 1430783812.0869999, "repositoryDescription": "My demonstration repository", "cloneUrlHttp": "https://codecommit.us-east-2.amazonaws.com/v1/repos/MyDemoRepo", "repositoryId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE", "Arn": "arn:aws:codecommit:us-east-2:111111111111:MyDemoRepo" "accountId": "111111111111" }, { "creationDate": 1429203623.627, "defaultBranch": "main", "repositoryName": "MyOtherDemoRepo", "cloneUrlSsh": "ssh://git-codecommit.us-east-2.amazonaws.com/v1/repos/MyOtherDemoRepo", "lastModifiedDate": 1430783812.0889999, "repositoryDescription": "My other demonstration repository", "cloneUrlHttp": "https://codecommit.us-east-2.amazonaws.com/v1/repos/MyOtherDemoRepo", "repositoryId": "cfc29ac4-b0cb-44dc-9990-f6f51EXAMPLE", "Arn": "arn:aws:codecommit:us-east-2:111111111111:MyOtherDemoRepo" "accountId": "111111111111" } ], "repositoriesNotFound": [] } ``` + Para ver detalhes da API, consulte [BatchGetRepositories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/batch-get-repositories.html) na *Referência de comandos da AWS CLI*. ### `create-approval-rule-template` O código de exemplo a seguir mostra como usar `create-approval-rule-template`. **AWS CLI** **Para criar um modelo de regra de aprovação** O exemplo `create-approval-rule-template` a seguir cria um modelo de regra de aprovação chamado `2-approver-rule-for-main ``. The template requires two users who assume the role of ``CodeCommitReview` para aprovar qualquer solicitação pull antes que ela possa ser mesclada à ramificação `main`. ``` aws codecommit create-approval-rule-template \ --approval-rule-template-name 2-approver-rule-for-main \ --approval-rule-template-description "Requires two developers from the team to approve the pull request if the destination branch is main" \ --approval-rule-template-content "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}" ``` Resultado: ``` { "approvalRuleTemplate": { "approvalRuleTemplateName": "2-approver-rule-for-main", "creationDate": 1571356106.936, "approvalRuleTemplateId": "dd8b17fe-EXAMPLE", "approvalRuleTemplateContent": "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}", "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major", "approvalRuleTemplateDescription": "Requires two developers from the team to approve the pull request if the destination branch is main", "lastModifiedDate": 1571356106.936, "ruleContentSha256": "4711b576EXAMPLE" } } ``` Para obter mais informações, consulte [Criar um modelo de regra de aprovação](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-create-template.html#create-template-cli) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [CreateApprovalRuleTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/create-approval-rule-template.html) na *Referência de comandos da AWS CLI*. ### `create-branch` O código de exemplo a seguir mostra como usar `create-branch`. **AWS CLI** **Para criar uma ramificação** Este exemplo cria uma ramificação em um repositório do AWS CodeCommit. Esse comando gerará saídas somente se houver erros. Comando: ``` aws codecommit create-branch --repository-name MyDemoRepo --branch-name MyNewBranch --commit-id 317f8570EXAMPLE ``` Resultado: ``` None. ``` + Para ver detalhes da API, consulte [CreateBranch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/create-branch.html) na *Referência de comandos da AWS CLI*. ### `create-commit` O código de exemplo a seguir mostra como usar `create-commit`. **AWS CLI** **Para criar uma confirmação** O exemplo `create-commit` a seguir demonstra como criar uma confirmação inicial para um repositório que adiciona um arquivo `readme.md` a um repositório chamado `MyDemoRepo` na ramificação `main`. ``` aws codecommit create-commit \ --repository-name MyDemoRepo \ --branch-name main \ --put-files "filePath=readme.md,fileContent='Welcome to our team repository.'" ``` Resultado: ``` { "filesAdded": [ { "blobId": "5e1c309d-EXAMPLE", "absolutePath": "readme.md", "fileMode": "NORMAL" } ], "commitId": "4df8b524-EXAMPLE", "treeId": "55b57003-EXAMPLE", "filesDeleted": [], "filesUpdated": [] } ``` Para obter mais informações, consulte [Criar uma confirmação no AWS CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-create-commit.html#how-to-create-commit-cli) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [CreateCommit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/create-commit.html) na *Referência de comandos da AWS CLI*. ### `create-pull-request-approval-rule` O código de exemplo a seguir mostra como usar `create-pull-request-approval-rule`. **AWS CLI** **Para criar uma regra de aprovação para uma solicitação pull** O exemplo `create-pull-request-approval-rule` a seguir cria uma regra de aprovação chamada `Require two approved approvers` de uma solicitação pull especificada. A regra especifica que duas aprovações são necessárias de um grupo de aprovações. O grupo inclui todos os usuários que acessam o CodeCommit ao assumirem a função de `CodeCommitReview` na conta `123456789012` da AWS. Ele também inclui um usuário do IAM ou usuário federado chamado `Nikhil_Jayashankar` na mesma conta da AWS. ``` aws codecommit create-pull-request-approval-rule \ --approval-rule-name "Require two approved approvers" \ --approval-rule-content "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"CodeCommitApprovers:123456789012:Nikhil_Jayashankar\", \"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}" ``` Resultado: ``` { "approvalRule": { "approvalRuleName": "Require two approved approvers", "lastModifiedDate": 1570752871.932, "ruleContentSha256": "7c44e6ebEXAMPLE", "creationDate": 1570752871.932, "approvalRuleId": "aac33506-EXAMPLE", "approvalRuleContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"CodeCommitApprovers:123456789012:Nikhil_Jayashankar\", \"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}", "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major" } } ``` Para obter mais informações, consulte [Criar uma regra de aprovação](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-create-pull-request-approval-rule.html#how-to-create-pull-request-approval-rule-cli) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [CreatePullRequestApprovalRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/create-pull-request-approval-rule.html) na *Referência de comandos da AWS CLI*. ### `create-pull-request` O código de exemplo a seguir mostra como usar `create-pull-request`. **AWS CLI** **Para criar uma solicitação pull** O exemplo `create-pull-request` a seguir cria uma pull request chamada “Analisador de dificuldade de pronúncia” com uma descrição de “Revise essas alterações até terça-feira” que tem como alvo a ramificação de origem “jane-branch” e deve ser mesclada com a ramificação padrão “main” em um repositório do AWS CodeCommit chamado “MyDemoRepo”. ``` aws codecommit create-pull-request \ --title "My Pull Request" \ --description "Please review these changes by Tuesday" \ --client-request-token 123Example \ --targets repositoryName=MyDemoRepo,sourceReference=MyNewBranch ``` Resultado: ``` { "pullRequest": { "approvalRules": [ { "approvalRuleContent": "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}", "approvalRuleId": "dd8b17fe-EXAMPLE", "approvalRuleName": "2-approver-rule-for-main", "creationDate": 1571356106.936, "lastModifiedDate": 571356106.936, "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major", "originApprovalRuleTemplate": { "approvalRuleTemplateId": "dd3d22fe-EXAMPLE", "approvalRuleTemplateName": "2-approver-rule-for-main" }, "ruleContentSha256": "4711b576EXAMPLE" } ], "authorArn": "arn:aws:iam::111111111111:user/Jane_Doe", "description": "Please review these changes by Tuesday", "title": "Pronunciation difficulty analyzer", "pullRequestTargets": [ { "destinationCommit": "5d036259EXAMPLE", "destinationReference": "refs/heads/main", "repositoryName": "MyDemoRepo", "sourceCommit": "317f8570EXAMPLE", "sourceReference": "refs/heads/jane-branch", "mergeMetadata": { "isMerged": false } } ], "lastActivityDate": 1508962823.285, "pullRequestId": "42", "clientRequestToken": "123Example", "pullRequestStatus": "OPEN", "creationDate": 1508962823.285 } } ``` + Para ver detalhes da API, consulte [CreatePullRequest](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/create-pull-request.html) na *Referência de comandos da AWS CLI*. ### `create-repository` O código de exemplo a seguir mostra como usar `create-repository`. **AWS CLI** **Como criar um repositório** Este exemplo cria um repositório e o associa à conta da AWS do usuário. Comando: ``` aws codecommit create-repository --repository-name MyDemoRepo --repository-description "My demonstration repository" ``` Resultado: ``` { "repositoryMetadata": { "repositoryName": "MyDemoRepo", "cloneUrlSsh": "ssh://git-codecommit.us-east-1.amazonaws.com/v1/repos/MyDemoRepo", "lastModifiedDate": 1444766838.027, "repositoryDescription": "My demonstration repository", "cloneUrlHttp": "https://git-codecommit.us-east-1.amazonaws.com/v1/repos/MyDemoRepo", "repositoryId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE", "Arn": "arn:aws:codecommit:us-east-1:111111111111EXAMPLE:MyDemoRepo", "accountId": "111111111111" } } ``` + Para ver detalhes da API, consulte [CreateRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/create-repository.html) na *Referência de comandos da AWS CLI*. ### `create-unreferenced-merge-commit` O código de exemplo a seguir mostra como usar `create-unreferenced-merge-commit`. **AWS CLI** **Para criar uma confirmação sem referência que representa o resultado da mesclagem de dois especificadores de confirmação** O exemplo `create-unreferenced-merge-commit` a seguir cria uma confirmação que representa os resultados de uma mesclagem entre uma ramificação de origem chamada `bugfix-1234` com uma ramificação de destino chamada `main` usando a estratégia THREE\$1WAY\$1MERGE em um repositório chamado `MyDemoRepo`. ``` aws codecommit create-unreferenced-merge-commit \ --source-commit-specifier bugfix-1234 \ --destination-commit-specifier main \ --merge-option THREE_WAY_MERGE \ --repository-name MyDemoRepo \ --name "Maria Garcia" \ --email "maria_garcia@example.com" \ --commit-message "Testing the results of this merge." ``` Resultado: ``` { "commitId": "4f178133EXAMPLE", "treeId": "389765daEXAMPLE" } ``` Para obter mais informações, consulte [Resolver conflitos em uma solicitação pull](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-resolve-conflict-pull-request.html#batch-describe-merge-conflicts) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [CreateUnreferencedMergeCommit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/create-unreferenced-merge-commit.html) na *Referência de comandos da AWS CLI*. ### `credential-helper` O código de exemplo a seguir mostra como usar `credential-helper`. **AWS CLI** **Como configurar o assistente de credenciais incluído na AWS CLI com o AWS CodeCommit** O utilitário `credential-helper` não foi projetado para ser chamado diretamente a partir da AWS CLI. Em vez disso, ele deve ser usado como um parâmetro com o comando `git config` para configurar seu computador local. Permite que o Git use HTTPS e uma versão assinada com criptografia de suas credenciais de usuário do IAM ou um perfil de instância do Amazon EC2 sempre que ele precisar da autenticação da AWS para interagir com os repositórios do CodeCommit. ``` git config --global credential.helper '!aws codecommit credential-helper $@' git config --global credential.UseHttpPath true ``` Resultado: ``` [credential] helper = !aws codecommit credential-helper $@ UseHttpPath = true ``` Para obter mais informações, consulte Configuração do AWS CodeCommit usando outros métodos no *Guia do usuário do AWS CodeCommit*. Revise o conteúdo com atenção e siga os procedimentos em um dos tópicos a seguir: para conexões HTTPS no Linux, macOS ou Unix ou para conexões HTTPS no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [CredentialHelper](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/credential-helper.html) na *Referência de comandos da AWS CLI*. ### `delete-approval-rule-template` O código de exemplo a seguir mostra como usar `delete-approval-rule-template`. **AWS CLI** **Para excluir um modelo de regra de aprovação** O exemplo `delete-approval-rule-template` a seguir exclui o modelo de regra de aprovação especificado. ``` aws codecommit delete-approval-rule-template \ --approval-rule-template-name 1-approver-for-all-pull-requests ``` Resultado: ``` { "approvalRuleTemplateId": "41de97b7-EXAMPLE" } ``` Para obter mais informações, consulte [Excluir um modelo de regra de aprovação](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-delete-template.html#delete-template) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [DeleteApprovalRuleTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/delete-approval-rule-template.html) na *Referência de comandos da AWS CLI*. ### `delete-branch` O código de exemplo a seguir mostra como usar `delete-branch`. **AWS CLI** **Para excluir uma ramificação** Este exemplo mostra como excluir uma ramificação de um repositório do AWS CodeCommit. Comando: ``` aws codecommit delete-branch --repository-name MyDemoRepo --branch-name MyNewBranch ``` Resultado: ``` { "branch": { "commitId": "317f8570EXAMPLE", "branchName": "MyNewBranch" } } ``` + Para ver detalhes da API, consulte [DeleteBranch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/delete-branch.html) na *Referência de comandos da AWS CLI*. ### `delete-comment-content` O código de exemplo a seguir mostra como usar `delete-comment-content`. **AWS CLI** **Para excluir o conteúdo de um comentário** Você só pode excluir o conteúdo de um comentário se você criou o comentário. Este exemplo mostra como excluir o conteúdo de um comentário com ID gerado pelo sistema de `ff30b348EXAMPLEb9aa670f`. ``` aws codecommit delete-comment-content \ --comment-id ff30b348EXAMPLEb9aa670f ``` Resultado: ``` { "comment": { "creationDate": 1508369768.142, "deleted": true, "lastModifiedDate": 1508369842.278, "clientRequestToken": "123Example", "commentId": "ff30b348EXAMPLEb9aa670f", "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", "callerReactions": [], "reactionCounts": { "CLAP" : 1 } } } ``` + Para ver detalhes da API, consulte [DeleteCommentContent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/delete-comment-content.html) na *Referência de comandos da AWS CLI*. ### `delete-file` O código de exemplo a seguir mostra como usar `delete-file`. **AWS CLI** **Para excluir um arquivo** O exemplo `delete-file` a seguir demonstra como excluir um arquivo chamado `README.md` de uma ramificação chamada `main` com um ID de confirmação mais recente de `c5709475EXAMPLE` em um repositório chamado `MyDemoRepo`. ``` aws codecommit delete-file \ --repository-name MyDemoRepo \ --branch-name main \ --file-path README.md \ --parent-commit-id c5709475EXAMPLE ``` Resultado: ``` { "blobId":"559b44fEXAMPLE", "commitId":"353cf655EXAMPLE", "filePath":"README.md", "treeId":"6bc824cEXAMPLE" } ``` Para obter mais informações, consulte [Editar ou excluir um arquivo no AWS CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-edit-file.html?shortFooter=true#how-to-edit-file-cli) no *Guia de referência da API do AWS CodeCommit*. + Para ver detalhes da API, consulte [DeleteFile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/delete-file.html) na *Referência de comandos da AWS CLI*. ### `delete-pull-request-approval-rule` O código de exemplo a seguir mostra como usar `delete-pull-request-approval-rule`. **AWS CLI** **Para excluir uma regra de aprovação para uma solicitação pull** O exemplo `delete-pull-request-approval-rule` a seguir exclui a regra de aprovação chamada `My Approval Rule` de uma solicitação pull especificada. ``` aws codecommit delete-pull-request-approval-rule \ --approval-rule-name "My Approval Rule" \ --pull-request-id 15 ``` Resultado: ``` { "approvalRuleId": "077d8e8a8-EXAMPLE" } ``` Para obter mais informações, consulte [Editar ou excluir um modelo de regra de aprovação](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-edit-delete-pull-request-approval-rule.html#delete-pull-request-approval-rule) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [DeletePullRequestApprovalRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/delete-pull-request-approval-rule.html) na *Referência de comandos da AWS CLI*. ### `delete-repository` O código de exemplo a seguir mostra como usar `delete-repository`. **AWS CLI** **Para excluir um repositório** Este exemplo mostra como excluir um repositório do AWS CodeCommit. Comando: ``` aws codecommit delete-repository --repository-name MyDemoRepo ``` Resultado: ``` { "repositoryId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE" } ``` + Para ver detalhes da API, consulte [DeleteRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/delete-repository.html) na *Referência de comandos da AWS CLI*. ### `describe-merge-conflicts` O código de exemplo a seguir mostra como usar `describe-merge-conflicts`. **AWS CLI** **Para obter informações detalhadas sobre conflitos de mesclagem** O exemplo `describe-merge-conflicts` a seguir determina os conflitos de mesclagem de um arquivo nomeado `readme.md` na ramificação de origem e na ramificação de destino especificadas usando a estratégia THREE\$1WAY\$1MERGE. ``` aws codecommit describe-merge-conflicts \ --source-commit-specifier feature-randomizationfeature \ --destination-commit-specifier main \ --merge-option THREE_WAY_MERGE \ --file-path readme.md \ --repository-name MyDemoRepo ``` Resultado: ``` { "conflictMetadata": { "filePath": "readme.md", "fileSizes": { "source": 139, "destination": 230, "base": 85 }, "fileModes": { "source": "NORMAL", "destination": "NORMAL", "base": "NORMAL" }, "objectTypes": { "source": "FILE", "destination": "FILE", "base": "FILE" }, "numberOfConflicts": 1, "isBinaryFile": { "source": false, "destination": false, "base": false }, "contentConflict": true, "fileModeConflict": false, "objectTypeConflict": false, "mergeOperations": { "source": "M", "destination": "M" } }, "mergeHunks": [ { "isConflict": true, "source": { "startLine": 0, "endLine": 3, "hunkContent": "VGhpcyBpEXAMPLE=" }, "destination": { "startLine": 0, "endLine": 1, "hunkContent": "VXNlIHRoEXAMPLE=" } } ], "destinationCommitId": "86958e0aEXAMPLE", "sourceCommitId": "6ccd57fdEXAMPLE", "baseCommitId": "767b69580EXAMPLE" } ``` Para obter mais informações, consulte [Resolver conflitos em uma solicitação pull](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-resolve-conflict-pull-request.html#describe-merge-conflicts) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [DescribeMergeConflicts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/describe-merge-conflicts.html) na *Referência de comandos da AWS CLI*. ### `describe-pull-request-events` O código de exemplo a seguir mostra como usar `describe-pull-request-events`. **AWS CLI** **Como visualizar eventos em uma solicitação pull** O exemplo `describe-pull-request-events` a seguir recupera os eventos de uma solicitação pull com o ID de “8”. ``` aws codecommit describe-pull-request-events --pull-request-id 8 ``` Resultado: ``` { "pullRequestEvents": [ { "pullRequestId": "8", "pullRequestEventType": "PULL_REQUEST_CREATED", "eventDate": 1510341779.53, "actor": "arn:aws:iam::111111111111:user/Zhang_Wei" }, { "pullRequestStatusChangedEventMetadata": { "pullRequestStatus": "CLOSED" }, "pullRequestId": "8", "pullRequestEventType": "PULL_REQUEST_STATUS_CHANGED", "eventDate": 1510341930.72, "actor": "arn:aws:iam::111111111111:user/Jane_Doe" } ] } ``` + Para ver detalhes da API, consulte [DescribePullRequestEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/describe-pull-request-events.html) na *Referência de comandos da AWS CLI*. ### `disassociate-approval-rule-template-from-repository` O código de exemplo a seguir mostra como usar `disassociate-approval-rule-template-from-repository`. **AWS CLI** **Como desassociar um modelo de regra de aprovação de um repositório** O exemplo `disassociate-approval-rule-template-from-repository` a seguir desassocia o modelo de regra de aprovação especificado de um repositório chamado `MyDemoRepo`. ``` aws codecommit disassociate-approval-rule-template-from-repository \ --repository-name MyDemoRepo \ --approval-rule-template-name 1-approver-rule-for-all-pull-requests ``` Este comando não produz saída. Para obter mais informações, consulte [Desassociar um modelo de regra de aprovação](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-disassociate-template.html#disassociate-template) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [DisassociateApprovalRuleTemplateFromRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/disassociate-approval-rule-template-from-repository.html) na *Referência de comandos da AWS CLI*. ### `evaluate-pull-request-approval-rules` O código de exemplo a seguir mostra como usar `evaluate-pull-request-approval-rules`. **AWS CLI** **Como avaliar se uma solicitação pull tem todas as suas regras de aprovação satisfeitas** O exemplo `evaluate-pull-request-approval-rules` a seguir avalia o estado das regras de aprovação na solicitação pull especificada. Neste exemplo, uma regra de aprovação não foi satisfeita para a solicitação pull, então a saída do comando mostra um valor `approved` como `false`. ``` aws codecommit evaluate-pull-request-approval-rules \ --pull-request-id 27 \ --revision-id 9f29d167EXAMPLE ``` Resultado: ``` { "evaluation": { "approved": false, "approvalRulesNotSatisfied": [ "Require two approved approvers" ], "overridden": false, "approvalRulesSatisfied": [] } } ``` Para obter mais informações, consulte [Mesclar uma solicitação pull](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-merge-pull-request.html#evaluate-pull-request-approval-rules) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [EvaluatePullRequestApprovalRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/evaluate-pull-request-approval-rules.html) na *Referência de comandos da AWS CLI*. ### `get-approval-rule-template` O código de exemplo a seguir mostra como usar `get-approval-rule-template`. **AWS CLI** **Para obter o conteúdo de um modelo de regra de aprovação** O exemplo `get-approval-rule-template` a seguir obtém o conteúdo de um modelo de regra de aprovação chamado `1-approver-rule-for-all-pull-requests`. ``` aws codecommit get-approval-rule-template \ --approval-rule-template-name 1-approver-rule-for-all-pull-requests ``` Resultado: ``` { "approvalRuleTemplate": { "approvalRuleTemplateContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 1,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}", "ruleContentSha256": "621181bbEXAMPLE", "lastModifiedDate": 1571356106.936, "creationDate": 1571356106.936, "approvalRuleTemplateName": "1-approver-rule-for-all-pull-requests", "lastModifiedUser": "arn:aws:iam::123456789012:user/Li_Juan", "approvalRuleTemplateId": "a29abb15-EXAMPLE", "approvalRuleTemplateDescription": "All pull requests must be approved by one developer on the team." } } ``` Para obter mais informações, consulte [Gerenciar modelos de regra de aprovação](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-manage-templates.html#get-template) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [GetApprovalRuleTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-approval-rule-template.html) na *Referência de comandos da AWS CLI*. ### `get-blob` O código de exemplo a seguir mostra como usar `get-blob`. **AWS CLI** **Como visualizar informações sobre um objeto do blob do Git** O exemplo `get-blob` a seguir recupera informações sobre um blob do Git com o ID de “2eb4af3bEXAMPLE” em um repositório do AWS CodeCommit chamado “MyDemoRepo”. ``` aws codecommit get-blob --repository-name MyDemoRepo --blob-id 2eb4af3bEXAMPLE ``` Resultado: ``` { "content": "QSBCaW5hcnkgTGFyToEXAMPLE=" } ``` + Para ver detalhes da API, consulte [GetBlob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-blob.html) na *Referência de comandos da AWS CLI*. ### `get-branch` O código de exemplo a seguir mostra como usar `get-branch`. **AWS CLI** **Para obter informações sobre uma ramificação** Este exemplo obtém informações sobre uma ramificação em um repositório do AWS CodeCommit. Comando: ``` aws codecommit get-branch --repository-name MyDemoRepo --branch-name MyNewBranch ``` Resultado: ``` { "BranchInfo": { "commitID": "317f8570EXAMPLE", "branchName": "MyNewBranch" } } ``` + Para ver detalhes da API, consulte [GetBranch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-branch.html) na *Referência de comandos da AWS CLI*. ### `get-comment-reactions` O código de exemplo a seguir mostra como usar `get-comment-reactions`. **AWS CLI** **Como visualizar as reações com emoji em um comentário** O exemplo `get-comment-reactions` a seguir lista todas as reações com emoji a um comentário com o ID de `abcd1234EXAMPLEb5678efgh`. Se a fonte do seu shell suportar a exibição do Emoji versão 1.0, a saída de `emoji` do emoji será exibida. ``` aws codecommit get-comment-reactions \ --comment-id abcd1234EXAMPLEb5678efgh ``` Resultado: ``` { "reactionsForComment": { [ { "reaction": { "emoji:"??", "shortCode": "thumbsup", "unicode": "U+1F44D" }, "users": [ "arn:aws:iam::123456789012:user/Li_Juan", "arn:aws:iam::123456789012:user/Mary_Major", "arn:aws:iam::123456789012:user/Jorge_Souza" ] }, { "reaction": { "emoji": "??", "shortCode": "thumbsdown", "unicode": "U+1F44E" }, "users": [ "arn:aws:iam::123456789012:user/Nikhil_Jayashankar" ] }, { "reaction": { "emoji": "??", "shortCode": "confused", "unicode": "U+1F615" }, "users": [ "arn:aws:iam::123456789012:user/Saanvi_Sarkar" ] } ] } } ``` Para obter mais informações, consulte [Comentar em uma confirmação no AWS CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-commit-comment.html#how-to-commit-comment-cli-commit-emoji-view) no *Guia do usuário do AWS CodeCommit*. + Para receber detalhes da API, consulte [GetCommentReactions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-comment-reactions.html) na *Referência de comandos da AWS CLI*. ### `get-comment` O código de exemplo a seguir mostra como usar `get-comment`. **AWS CLI** **Como visualizar detalhes em um comentário** Este exemplo demonstra como visualizar os detalhes de um comentário com o ID de `ff30b348EXAMPLEb9aa670f` de comentário gerado pelo sistema. ``` aws codecommit get-comment \ --comment-id ff30b348EXAMPLEb9aa670f ``` Resultado: ``` { "comment": { "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", "clientRequestToken": "123Example", "commentId": "ff30b348EXAMPLEb9aa670f", "content": "Whoops - I meant to add this comment to the line, but I don't see how to delete it.", "creationDate": 1508369768.142, "deleted": false, "commentId": "", "lastModifiedDate": 1508369842.278, "callerReactions": [], "reactionCounts": { "SMILE" : 6, "THUMBSUP" : 1 } } } ``` + Para ver detalhes da API, consulte [GetComment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-comment.html) na *Referência de comandos da AWS CLI*. ### `get-comments-for-compared-commit` O código de exemplo a seguir mostra como usar `get-comments-for-compared-commit`. **AWS CLI** **Como visualizar comentários em uma confirmação** Este exemplo demonstra como visualizar comentários realizados na comparação entre duas confirmações em um repositório chamado `MyDemoRepo`. ``` aws codecommit get-comments-for-compared-commit \ --repository-name MyDemoRepo \ --before-commit-ID 6e147360EXAMPLE \ --after-commit-id 317f8570EXAMPLE ``` Resultado: ``` { "commentsForComparedCommitData": [ { "afterBlobId": "1f330709EXAMPLE", "afterCommitId": "317f8570EXAMPLE", "beforeBlobId": "80906a4cEXAMPLE", "beforeCommitId": "6e147360EXAMPLE", "comments": [ { "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", "clientRequestToken": "123Example", "commentId": "ff30b348EXAMPLEb9aa670f", "content": "Whoops - I meant to add this comment to the line, not the file, but I don't see how to delete it.", "creationDate": 1508369768.142, "deleted": false, "CommentId": "123abc-EXAMPLE", "lastModifiedDate": 1508369842.278, "callerReactions": [], "reactionCounts": { "SMILE" : 6, "THUMBSUP" : 1 } }, { "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", "clientRequestToken": "123Example", "commentId": "553b509bEXAMPLE56198325", "content": "Can you add a test case for this?", "creationDate": 1508369612.240, "deleted": false, "commentId": "456def-EXAMPLE", "lastModifiedDate": 1508369612.240, "callerReactions": [], "reactionCounts": { "THUMBSUP" : 2 } } ], "location": { "filePath": "cl_sample.js", "filePosition": 1232, "relativeFileVersion": "after" }, "repositoryName": "MyDemoRepo" } ], "nextToken": "exampleToken" } ``` + Para ver detalhes da API, consulte [GetCommentsForComparedCommit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-comments-for-compared-commit.html) na *Referência de comandos da AWS CLI*. ### `get-comments-for-pull-request` O código de exemplo a seguir mostra como usar `get-comments-for-pull-request`. **AWS CLI** , **Como visualizar os comentários deixados em uma solicitação pull** Este exemplo mostra como exibir comentários para uma solicitação pull em um repositório chamado `MyDemoRepo`: ``` aws codecommit get-comments-for-pull-request \ --repository-name MyDemoRepo \ --before-commit-ID 317f8570EXAMPLE \ --after-commit-id 5d036259EXAMPLE ``` Resultado: ``` { "commentsForPullRequestData": [ { "afterBlobId": "1f330709EXAMPLE", "afterCommitId": "5d036259EXAMPLE", "beforeBlobId": "80906a4cEXAMPLE", "beforeCommitId": "317f8570EXAMPLE", "comments": [ { "authorArn": "arn:aws:iam::111111111111:user/Saanvi_Sarkar", "clientRequestToken": "", "commentId": "abcd1234EXAMPLEb5678efgh", "content": "These don't appear to be used anywhere. Can we remove them?", "creationDate": 1508369622.123, "deleted": false, "lastModifiedDate": 1508369622.123, "callerReactions": [], "reactionCounts": { "THUMBSUP" : 6, "CONFUSED" : 1 } }, { "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", "clientRequestToken": "", "commentId": "442b498bEXAMPLE5756813", "content": "Good catch. I'll remove them.", "creationDate": 1508369829.104, "deleted": false, "lastModifiedDate": 150836912.273, "callerReactions": ["THUMBSUP"] "reactionCounts": { "THUMBSUP" : 14 } } ], "location": { "filePath": "ahs_count.py", "filePosition": 367, "relativeFileVersion": "AFTER" }, "repositoryName": "MyDemoRepo", "pullRequestId": "42" } ], "nextToken": "exampleToken" } ``` + Para ver detalhes da API, consulte [GetCommentsForPullRequest](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-comments-for-pull-request.html) na *Referência de comandos da AWS CLI*. ### `get-commit` O código de exemplo a seguir mostra como usar `get-commit`. **AWS CLI** **Para visualizar informações sobre uma confirmação em um repositório** Este exemplo mostra detalhes sobre uma confirmação com o ID gerado pelo sistema de “7e9fd3091thisisanexamplethisisanexample1” em um repositório do AWS CodeCommit chamado “MyDemoRepo”. Comando: ``` aws codecommit get-commit --repository-name MyDemoRepo --commit-id 7e9fd3091thisisanexamplethisisanexample1 ``` Resultado: ``` { "commit": { "additionalData": "", "committer": { "date": "1484167798 -0800", "name": "Mary Major", "email": "mary_major@example.com" }, "author": { "date": "1484167798 -0800", "name": "Mary Major", "email": "mary_major@example.com" }, "treeId": "347a3408thisisanexampletreeidexample", "parents": [ "7aa87a031thisisanexamplethisisanexample1" ], "message": "Fix incorrect variable name" } } ``` + Para ver detalhes da API, consulte [GetCommit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-commit.html) na *Referência de comandos da AWS CLI*. ### `get-differences` O código de exemplo a seguir mostra como usar `get-differences`. **AWS CLI** **Para obter informações sobre as diferenças de um especificador de confirmação em um repositório** Este exemplo mostra informações de metadados de visualização sobre alterações entre dois especificadores de confirmação (ramificação, tag, CABEÇALHO ou outras referências totalmente qualificadas, como IDs de confirmação) em uma pasta renomeada no repositório do AWS CodeCommit chamada MyDemoRepo. O exemplo inclui várias opções que não são obrigatórias, incluindo --before-commit-specifier, --before-path e --after-path, para ilustrar melhor como você pode usar essas opções para limitar os resultados. A resposta inclui permissões do modo de arquivo. Comando: ``` aws codecommit get-differences --repository-name MyDemoRepo --before-commit-specifier 955bba12thisisanexamplethisisanexample --after-commit-specifier 14a95463thisisanexamplethisisanexample --before-path tmp/example-folder --after-path tmp/renamed-folder ``` Resultado: ``` { "differences": [ { "afterBlob": { "path": "blob.txt", "blobId": "2eb4af3b1thisisanexamplethisisanexample1", "mode": "100644" }, "changeType": "M", "beforeBlob": { "path": "blob.txt", "blobId": "bf7fcf281thisisanexamplethisisanexample1", "mode": "100644" } } ] } ``` + Para ver detalhes da API, consulte [GetDifferences](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-differences.html) na *Referência de comandos da AWS CLI*. ### `get-file` O código de exemplo a seguir mostra como usar `get-file`. **AWS CLI** **Para obter o conteúdo codificado em base-64 de um arquivo em um repositório do AWS CodeCommit** O exemplo `get-file` a seguir demonstra como obter o conteúdo codificado em base 64 de um arquivo chamado `README.md` de uma ramificação chamada `main` em um repositório chamada `MyDemoRepo`. ``` aws codecommit get-file \ --repository-name MyDemoRepo \ --commit-specifier main \ --file-path README.md ``` Resultado: ``` { "blobId":"559b44fEXAMPLE", "commitId":"c5709475EXAMPLE", "fileContent":"IyBQaHVzEXAMPLE", "filePath":"README.md", "fileMode":"NORMAL", "fileSize":1563 } ``` Para obter mais informações, consulte [GetFile](https://docs.aws.amazon.com/codecommit/latest/APIReference/API_GetFile.html) no *Guia de referência da API do AWS CodeCommit*. + Para ver detalhes da API, consulte [GetFile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-file.html) na *Referência de comandos da AWS CLI*. ### `get-folder` O código de exemplo a seguir mostra como usar `get-folder`. **AWS CLI** **Para obter o conteúdo de uma pasta em um repositório do AWS CodeCommit** O exemplo `get-folder` a seguir demonstra como obter o conteúdo de uma pasta de nível superior de um repositório chamado `MyDemoRepo`. ``` aws codecommit get-folder --repository-name MyDemoRepo --folder-path "" ``` Resultado: ``` { "commitId":"c5709475EXAMPLE", "files":[ { "absolutePath":".gitignore", "blobId":"74094e8bEXAMPLE", "fileMode":"NORMAL", "relativePath":".gitignore" }, { "absolutePath":"Gemfile", "blobId":"9ceb72f6EXAMPLE", "fileMode":"NORMAL", "relativePath":"Gemfile" }, { "absolutePath":"Gemfile.lock", "blobId":"795c4a2aEXAMPLE", "fileMode":"NORMAL", "relativePath":"Gemfile.lock" }, { "absolutePath":"LICENSE.txt", "blobId":"0c7932c8EXAMPLE", "fileMode":"NORMAL", "relativePath":"LICENSE.txt" }, { "absolutePath":"README.md", "blobId":"559b44feEXAMPLE", "fileMode":"NORMAL", "relativePath":"README.md" } ], "folderPath":"", "subFolders":[ { "absolutePath":"public", "relativePath":"public", "treeId":"d5e92ae3aEXAMPLE" }, { "absolutePath":"tmp", "relativePath":"tmp", "treeId":"d564d0bcEXAMPLE" } ], "subModules":[], "symbolicLinks":[], "treeId":"7b3c4dadEXAMPLE" } ``` Para obter mais informações, consulte GetFolder no *Guia de referência da API do AWS CodeCommit*. + Para ver detalhes da API, consulte [GetFolder](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-folder.html) na *Referência de comandos da AWS CLI*. ### `get-merge-commit` O código de exemplo a seguir mostra como usar `get-merge-commit`. **AWS CLI** **Como visualizar informações sobre uma confirmação de mesclagem** O exemplo de `get-merge-commit` a seguir mostra detalhes sobre uma confirmação de mesclagem para a ramificação de origem chamada `bugfix-bug1234` com uma ramificação de destino chamada `main` em um repositório chamado `MyDemoRepo`. ``` aws codecommit get-merge-commit \ --source-commit-specifier bugfix-bug1234 \ --destination-commit-specifier main \ --repository-name MyDemoRepo ``` Resultado: ``` { "sourceCommitId": "c5709475EXAMPLE", "destinationCommitId": "317f8570EXAMPLE", "baseCommitId": "fb12a539EXAMPLE", "mergeCommitId": "ffc4d608eEXAMPLE" } ``` Para obter mais informações, consulte [Visualizar detalhes da confirmação](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-view-commit-details.html#how-to-view-commit-details-cli-merge-commit) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [GetMergeCommit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-merge-commit.html) na *Referência de comandos da AWS CLI*. ### `get-merge-conflicts` O código de exemplo a seguir mostra como usar `get-merge-conflicts`. **AWS CLI** **Como visualizar se há conflitos de mesclagem para uma solicitação pull** O exemplo `get-merge-conflicts` a seguir exibe se há conflitos de mesclagem entre a ponta de uma ramificação de origem chamada `feature-randomizationfeature` e uma ramificação de destino chamada “main” em um repositório chamado `MyDemoRepo`. ``` aws codecommit get-merge-conflicts \ --repository-name MyDemoRepo \ --source-commit-specifier feature-randomizationfeature \ --destination-commit-specifier main \ --merge-option THREE_WAY_MERGE ``` Resultado: ``` { "mergeable": false, "destinationCommitId": "86958e0aEXAMPLE", "sourceCommitId": "6ccd57fdEXAMPLE", "baseCommitId": "767b6958EXAMPLE", "conflictMetadataList": [ { "filePath": "readme.md", "fileSizes": { "source": 139, "destination": 230, "base": 85 }, "fileModes": { "source": "NORMAL", "destination": "NORMAL", "base": "NORMAL" }, "objectTypes": { "source": "FILE", "destination": "FILE", "base": "FILE" }, "numberOfConflicts": 1, "isBinaryFile": { "source": false, "destination": false, "base": false }, "contentConflict": true, "fileModeConflict": false, "objectTypeConflict": false, "mergeOperations": { "source": "M", "destination": "M" } } ] } ``` + Para ver detalhes da API, consulte [GetMergeConflicts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-merge-conflicts.html) na *Referência de comandos da AWS CLI*. ### `get-merge-options` O código de exemplo a seguir mostra como usar `get-merge-options`. **AWS CLI** **Para obter informações sobre as opções de mesclagem disponíveis para mesclar duas ramificações especificadas** O exemplo `get-merge-options` a seguir determina as opções de mesclagem disponíveis para mesclar uma ramificação de origem chamada `bugfix-bug1234` com uma ramificação de destino chamada `main` em um repositório chamado `MyDemoRepo`. ``` aws codecommit get-merge-options \ --source-commit-specifier bugfix-bug1234 \ --destination-commit-specifier main \ --repository-name MyDemoRepo ``` Resultado: ``` { "mergeOptions": [ "FAST_FORWARD_MERGE", "SQUASH_MERGE", "THREE_WAY_MERGE" ], "sourceCommitId": "18059494EXAMPLE", "destinationCommitId": "ffd3311dEXAMPLE", "baseCommitId": "ffd3311dEXAMPLE" } ``` Para obter mais informações, consulte [Resolver conflitos em uma solicitação pull](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-resolve-conflict-pull-request.html#get-merge-options) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [GetMergeOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-merge-options.html) na *Referência de comandos da AWS CLI*. ### `get-pull-request-approval-states` O código de exemplo a seguir mostra como usar `get-pull-request-approval-states`. **AWS CLI** **Como visualizar aprovações em uma solicitação pull** O exemplo `get-pull-request-approval-states` a seguir retorna aprovações para a solicitação pull especificada. ``` aws codecommit get-pull-request-approval-states \ --pull-request-id 8 \ --revision-id 9f29d167EXAMPLE ``` Resultado: ``` { "approvals": [ { "userArn": "arn:aws:iam::123456789012:user/Mary_Major", "approvalState": "APPROVE" } ] } ``` Para obter mais informações, consulte [Visualizar solicitações pull](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-view-pull-request.html#get-pull-request-approval-state) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [GetPullRequestApprovalStates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-pull-request-approval-states.html) na *Referência de comandos da AWS CLI*. ### `get-pull-request-override-state` O código de exemplo a seguir mostra como usar `get-pull-request-override-state`. **AWS CLI** **Para obter informações sobre o status de substituição de uma solicitação pull** O exemplo `get-pull-request-override-state` a seguir retorna o estado de substituição da solicitação pull especificada. Neste exemplo, as regras de aprovação da solicitação pull foram substituídas por uma usuária chamada Mary Major, então a saída retorna um valor de `true`: ``` aws codecommit get-pull-request-override-state \ --pull-request-id 34 \ --revision-id 9f29d167EXAMPLE ``` Resultado: ``` { "overridden": true, "overrider": "arn:aws:iam::123456789012:user/Mary_Major" } ``` Para obter mais informações, consulte [Substituir regras de aprovação em uma solicitação pull](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-override-approval-rules.html#get-override-status) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [GetPullRequestOverrideState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-pull-request-override-state.html) na *Referência de comandos da AWS CLI*. ### `get-pull-request` O código de exemplo a seguir mostra como usar `get-pull-request`. **AWS CLI** **Como visualizar detalhes de uma solicitação pull** Este exemplo demonstra como visualizar informações sobre uma solicitação pull com o ID de `27`. ``` aws codecommit get-pull-request \ --pull-request-id 27 ``` Resultado: ``` { "pullRequest": { "approvalRules": [ { "approvalRuleContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}", "approvalRuleId": "dd8b17fe-EXAMPLE", "approvalRuleName": "2-approver-rule-for-main", "creationDate": 1571356106.936, "lastModifiedDate": 571356106.936, "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major", "ruleContentSha256": "4711b576EXAMPLE" } ], "lastActivityDate": 1562619583.565, "pullRequestTargets": [ { "sourceCommit": "ca45e279EXAMPLE", "sourceReference": "refs/heads/bugfix-1234", "mergeBase": "a99f5ddbEXAMPLE", "destinationReference": "refs/heads/main", "mergeMetadata": { "isMerged": false }, "destinationCommit": "2abfc6beEXAMPLE", "repositoryName": "MyDemoRepo" } ], "revisionId": "e47def21EXAMPLE", "title": "Quick fix for bug 1234", "authorArn": "arn:aws:iam::123456789012:user/Nikhil_Jayashankar", "clientRequestToken": "d8d7612e-EXAMPLE", "creationDate": 1562619583.565, "pullRequestId": "27", "pullRequestStatus": "OPEN" } } ``` + Para ver detalhes da API, consulte [GetPullRequest](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-pull-request.html) na *Referência de comandos da AWS CLI*. ### `get-repository-triggers` O código de exemplo a seguir mostra como usar `get-repository-triggers`. **AWS CLI** **Para obter informações sobre acionadores em um repositório** Este exemplo mostra detalhes sobre acionadores configurados em um repositório do AWS CodeCommit chamado `MyDemoRepo`. ``` aws codecommit get-repository-triggers \ --repository-name MyDemoRepo ``` Resultado: ``` { "configurationId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE", "triggers": [ { "destinationArn": "arn:aws:sns:us-east-1:111111111111:MyCodeCommitTopic", "branches": [ "main", "preprod" ], "name": "MyFirstTrigger", "customData": "", "events": [ "all" ] }, { "destinationArn": "arn:aws:lambda:us-east-1:111111111111:function:MyCodeCommitPythonFunction", "branches": [], "name": "MySecondTrigger", "customData": "EXAMPLE", "events": [ "all" ] } ] } ``` + Para ver detalhes da API, consulte [GetRepositoryTriggers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-repository-triggers.html) na *Referência de comandos da AWS CLI*. ### `get-repository` O código de exemplo a seguir mostra como usar `get-repository`. **AWS CLI** **Para obter informações sobre um repositório** Este exemplo mostra detalhes sobre um repositório do AWS CodeCommit. ``` aws codecommit get-repository \ --repository-name MyDemoRepo ``` Resultado: ``` { "repositoryMetadata": { "creationDate": 1429203623.625, "defaultBranch": "main", "repositoryName": "MyDemoRepo", "cloneUrlSsh": "ssh://git-codecommit.us-east-1.amazonaws.com/v1/repos/v1/repos/MyDemoRepo", "lastModifiedDate": 1430783812.0869999, "repositoryDescription": "My demonstration repository", "cloneUrlHttp": "https://codecommit.us-east-1.amazonaws.com/v1/repos/MyDemoRepo", "repositoryId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE", "Arn": "arn:aws:codecommit:us-east-1:80398EXAMPLE:MyDemoRepo "accountId": "111111111111" } } ``` + Para ver detalhes da API, consulte [GetRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-repository.html) na *Referência de comandos da AWS CLI*. ### `list-approval-rule-templates` O código de exemplo a seguir mostra como usar `list-approval-rule-templates`. **AWS CLI** **Para listar todos os modelos de regra de aprovação em uma região da AWS** O exemplo `list-approval-rule-templates` a seguir mostra todos os modelos de regras de aprovação na região especificada. Se nenhuma região da AWS for especificada como parâmetro, o comando retornará modelos de regras de aprovação para a região especificada no perfil da AWS CLI usado para executar o comando. ``` aws codecommit list-approval-rule-templates \ --region us-east-2 ``` Resultado: ``` { "approvalRuleTemplateNames": [ "2-approver-rule-for-main", "1-approver-rule-for-all-pull-requests" ] } ``` Para obter mais informações, consulte [Gerenciar modelos de regra de aprovação](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-manage-templates.html#list-templates) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [ListApprovalRuleTemplates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/list-approval-rule-templates.html) na *Referência de comandos da AWS CLI*. ### `list-associated-approval-rule-templates-for-repository` O código de exemplo a seguir mostra como usar `list-associated-approval-rule-templates-for-repository`. **AWS CLI** **Para listar todos os modelos associados a um repositório** O exemplo `list-associated-approval-rule-templates-for-repository` a seguir lista todos os modelos de regras de aprovação associados a um repositório chamado `MyDemoRepo`. ``` aws codecommit list-associated-approval-rule-templates-for-repository \ --repository-name MyDemoRepo ``` Resultado: ``` { "approvalRuleTemplateNames": [ "2-approver-rule-for-main", "1-approver-rule-for-all-pull-requests" ] } ``` Para obter mais informações, consulte [Gerenciar modelos de regra de aprovação](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-manage-templates.html#list-associated-templates) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [ListAssociatedApprovalRuleTemplatesForRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/list-associated-approval-rule-templates-for-repository.html) na *Referência de comandos da AWS CLI*. ### `list-branches` O código de exemplo a seguir mostra como usar `list-branches`. **AWS CLI** **Como visualizar uma lista de nomes de ramificação** Este exemplo lista todos os nomes de ramificações em um repositório do AWS CodeCommit. ``` aws codecommit list-branches \ --repository-name MyDemoRepo ``` Resultado: ``` { "branches": [ "MyNewBranch", "main" ] } ``` + Para ver detalhes da API, consulte [ListBranches](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/list-branches.html) na *Referência de comandos da AWS CLI*. ### `list-pull-requests` O código de exemplo a seguir mostra como usar `list-pull-requests`. **AWS CLI** **Como visualizar uma lista de solicitações pull em um repositório** Este exemplo demonstra como listar solicitações pull criadas por um usuário do IAM com o ARN “arn:aws:iam::111111111111:user/Li\$1Juan” e status “CLOSED” em um repositório do AWS CodeCommit chamado “MyDemoRepo”: ``` aws codecommit list-pull-requests --author-arn arn:aws:iam::111111111111:user/Li_Juan --pull-request-status CLOSED --repository-name MyDemoRepo ``` Resultado: ``` { "nextToken": "", "pullRequestIds": ["2","12","16","22","23","35","30","39","47"] } ``` + Para ver detalhes da API, consulte [ListPullRequests](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/list-pull-requests.html) na *Referência de comandos da AWS CLI*. ### `list-repositories-for-approval-rule-template` O código de exemplo a seguir mostra como usar `list-repositories-for-approval-rule-template`. **AWS CLI** **Para listar todos os repositórios associados a um modelo** O exemplo `list-repositories-for-approval-rule-template` a seguir lista todos os repositórios associados ao modelo de regra de aprovação especificado. ``` aws codecommit list-repositories-for-approval-rule-template \ --approval-rule-template-name 2-approver-rule-for-main ``` Resultado: ``` { "repositoryNames": [ "MyDemoRepo", "MyClonedRepo" ] } ``` Para obter mais informações, consulte [Gerenciar modelos de regra de aprovação](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-manage-templates.html#list-associated-repositories) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [ListRepositoriesForApprovalRuleTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/list-repositories-for-approval-rule-template.html) na *Referência de comandos da AWS CLI*. ### `list-repositories` O código de exemplo a seguir mostra como usar `list-repositories`. **AWS CLI** **Como visualizar uma lista de repositórios** Este exemplo lista todos os repositórios do AWS CodeCommit associados à conta do usuário da AWS. Comando: ``` aws codecommit list-repositories ``` Resultado: ``` { "repositories": [ { "repositoryName": "MyDemoRepo" "repositoryId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE", }, { "repositoryName": "MyOtherDemoRepo" "repositoryId": "cfc29ac4-b0cb-44dc-9990-f6f51EXAMPLE" } ] } ``` + Para ver detalhes da API, consulte [ListRepositories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/list-repositories.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Como exibir as tags da AWS em um repositório** O exemplo `list-tags-for-resource` a seguir lista as chaves e os valores das tags para o repositório especificado. ``` aws codecommit list-tags-for-resource \ --resource-arn arn:aws:codecommit:us-west-2:111111111111:MyDemoRepo ``` Resultado: ``` { "tags": { "Status": "Secret", "Team": "Saanvi" } } ``` Para obter mais informações, consulte [Visualizar tags em um repositório](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-tag-repository-list.html#how-to-tag-repository-list-cli) no *Guia do usuário do AWS CodeCommit*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `merge-branches-by-fast-forward` O código de exemplo a seguir mostra como usar `merge-branches-by-fast-forward`. **AWS CLI** **Para mesclar duas ramificações usando a estratégia de mesclagem de avanço rápido** O exemplo `merge-branches-by-fast-forward` a seguir mescla a ramificação de origem especificada com a ramificação de destino especificada em um repositório chamado `MyDemoRepo`. ``` aws codecommit merge-branches-by-fast-forward \ --source-commit-specifier bugfix-bug1234 \ --destination-commit-specifier bugfix-bug1233 \ --repository-name MyDemoRepo ``` Resultado: ``` { "commitId": "4f178133EXAMPLE", "treeId": "389765daEXAMPLE" } ``` Para obter mais informações, consulte [Comparar e mesclar ramificações](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-compare-branches.html#merge-branches-by-fast-forward) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [MergeBranchesByFastForward](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/merge-branches-by-fast-forward.html) na *Referência de comandos da AWS CLI*. ### `merge-branches-by-squash` O código de exemplo a seguir mostra como usar `merge-branches-by-squash`. **AWS CLI** **Para mesclar duas ramificações usando a estratégia de mesclagem squash** O exemplo `merge-branches-by-squash` a seguir mescla a ramificação de origem especificada com a ramificação de destino especificada em um repositório chamado `MyDemoRepo`. ``` aws codecommit merge-branches-by-squash \ --source-commit-specifier bugfix-bug1234 \ --destination-commit-specifier bugfix-bug1233 \ --author-name "Maria Garcia" \ --email "maria_garcia@example.com" \ --commit-message "Merging two fix branches to prepare for a general patch." \ --repository-name MyDemoRepo ``` Resultado: ``` { "commitId": "4f178133EXAMPLE", "treeId": "389765daEXAMPLE" } ``` Para obter mais informações, consulte [Comparar e mesclar ramificações](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-compare-branches.html#merge-branches-by-squash) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [MergeBranchesBySquash](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/merge-branches-by-squash.html) na *Referência de comandos da AWS CLI*. ### `merge-branches-by-three-way` O código de exemplo a seguir mostra como usar `merge-branches-by-three-way`. **AWS CLI** **Para mesclar duas ramificações usando a estratégia de mesclagem de três vias** O exemplo `merge-branches-by-three-way` a seguir mescla a ramificação de origem especificada com a ramificação de destino especificada em um repositório chamado `MyDemoRepo`. ``` aws codecommit merge-branches-by-three-way \ --source-commit-specifier main \ --destination-commit-specifier bugfix-bug1234 \ --author-name "Jorge Souza" --email "jorge_souza@example.com" \ --commit-message "Merging changes from main to bugfix branch before additional testing." \ --repository-name MyDemoRepo ``` Resultado: ``` { "commitId": "4f178133EXAMPLE", "treeId": "389765daEXAMPLE" } ``` Para obter mais informações, consulte [Comparar e mesclar ramificações](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-compare-branches.html#merge-branches-by-three-way) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [MergeBranchesByThreeWay](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/merge-branches-by-three-way.html) na *Referência de comandos da AWS CLI*. ### `merge-pull-request-by-fast-forward` O código de exemplo a seguir mostra como usar `merge-pull-request-by-fast-forward`. **AWS CLI** **Para mesclar e fechar uma solicitação pull** Este exemplo demonstra como para mesclar e fechar uma solicitação pull com o ID de “47” e um ID de confirmação de origem de “99132ab0EXAMPLE” em um repositório chamado `MyDemoRepo`. ``` aws codecommit merge-pull-request-by-fast-forward \ --pull-request-id 47 \ --source-commit-id 99132ab0EXAMPLE \ --repository-name MyDemoRepo ``` Resultado: ``` { "pullRequest": { "approvalRules": [ { "approvalRuleContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 1,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}", "approvalRuleId": "dd8b17fe-EXAMPLE", "approvalRuleName": "I want one approver for this pull request", "creationDate": 1571356106.936, "lastModifiedDate": 571356106.936, "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major", "ruleContentSha256": "4711b576EXAMPLE" } ], "authorArn": "arn:aws:iam::123456789012:user/Li_Juan", "clientRequestToken": "", "creationDate": 1508530823.142, "description": "Review the latest changes and updates to the global variables", "lastActivityDate": 1508887223.155, "pullRequestId": "47", "pullRequestStatus": "CLOSED", "pullRequestTargets": [ { "destinationCommit": "9f31c968EXAMPLE", "destinationReference": "refs/heads/main", "mergeMetadata": { "isMerged": true, "mergedBy": "arn:aws:iam::123456789012:user/Mary_Major" }, "repositoryName": "MyDemoRepo", "sourceCommit": "99132ab0EXAMPLE", "sourceReference": "refs/heads/variables-branch" } ], "title": "Consolidation of global variables" } } ``` Para obter mais informações, consulte [Mesclar uma solicitação pull](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-merge-pull-request.html#merge-pull-request-by-fast-forward) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [MergePullRequestByFastForward](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/merge-pull-request-by-fast-forward.html) na *Referência de comandos da AWS CLI*. ### `merge-pull-request-by-squash` O código de exemplo a seguir mostra como usar `merge-pull-request-by-squash`. **AWS CLI** **Para mesclar uma solicitação pull usando a estratégia de mesclagem squash** O exemplo `merge-pull-request-by-squash` a seguir mescla e fecha a solicitação pull especificada usando a estratégia de resolução de conflitos ACCEPT\$1SOURCE em um repositório chamado `MyDemoRepo`. ``` aws codecommit merge-pull-request-by-squash \ --pull-request-id 47 \ --source-commit-id 99132ab0EXAMPLE \ --repository-name MyDemoRepo \ --conflict-detail-level LINE_LEVEL \ --conflict-resolution-strategy ACCEPT_SOURCE \ --name "Jorge Souza" --email "jorge_souza@example.com" \ --commit-message "Merging pull request 47 by squash and accepting source in merge conflicts" ``` Resultado: ``` { "pullRequest": { "approvalRules": [ { "approvalRuleContent": "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}", "approvalRuleId": "dd8b17fe-EXAMPLE", "approvalRuleName": "2-approver-rule-for-main", "creationDate": 1571356106.936, "lastModifiedDate": 571356106.936, "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major", "originApprovalRuleTemplate": { "approvalRuleTemplateId": "dd8b17fe-EXAMPLE", "approvalRuleTemplateName": "2-approver-rule-for-main" }, "ruleContentSha256": "4711b576EXAMPLE" } ], "authorArn": "arn:aws:iam::123456789012:user/Li_Juan", "clientRequestToken": "", "creationDate": 1508530823.142, "description": "Review the latest changes and updates to the global variables", "lastActivityDate": 1508887223.155, "pullRequestId": "47", "pullRequestStatus": "CLOSED", "pullRequestTargets": [ { "destinationCommit": "9f31c968EXAMPLE", "destinationReference": "refs/heads/main", "mergeMetadata": { "isMerged": true, "mergedBy": "arn:aws:iam::123456789012:user/Mary_Major" }, "repositoryName": "MyDemoRepo", "sourceCommit": "99132ab0EXAMPLE", "sourceReference": "refs/heads/variables-branch" } ], "title": "Consolidation of global variables" } } ``` Para obter mais informações, consulte [Mesclar uma solicitação pull](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-merge-pull-request.html#merge-pull-request-by-squash) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [MergePullRequestBySquash](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/merge-pull-request-by-squash.html) na *Referência de comandos da AWS CLI*. ### `merge-pull-request-by-three-way` O código de exemplo a seguir mostra como usar `merge-pull-request-by-three-way`. **AWS CLI** **Para mesclar uma solicitação pull usando a estratégia de mesclagem de três vias** O exemplo `merge-pull-request-by-three-way` a seguir mescla e fecha a solicitação pull especificada usando as opções padrão para detalhes do conflito e estratégia de resolução de conflitos em um repositório chamado `MyDemoRepo`. ``` aws codecommit merge-pull-request-by-three-way \ --pull-request-id 47 \ --source-commit-id 99132ab0EXAMPLE \ --repository-name MyDemoRepo \ --name "Maria Garcia" \ --email "maria_garcia@example.com" \ --commit-message "Merging pull request 47 by three-way with default options" ``` Resultado: ``` { "pullRequest": { "approvalRules": [ { "approvalRuleContent": "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}", "approvalRuleId": "dd8b17fe-EXAMPLE", "approvalRuleName": "2-approver-rule-for-main", "creationDate": 1571356106.936, "lastModifiedDate": 571356106.936, "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major", "originApprovalRuleTemplate": { "approvalRuleTemplateId": "dd8b17fe-EXAMPLE", "approvalRuleTemplateName": "2-approver-rule-for-main" }, "ruleContentSha256": "4711b576EXAMPLE" } ], "authorArn": "arn:aws:iam::123456789012:user/Li_Juan", "clientRequestToken": "", "creationDate": 1508530823.142, "description": "Review the latest changes and updates to the global variables", "lastActivityDate": 1508887223.155, "pullRequestId": "47", "pullRequestStatus": "CLOSED", "pullRequestTargets": [ { "destinationCommit": "9f31c968EXAMPLE", "destinationReference": "refs/heads/main", "mergeMetadata": { "isMerged": true, "mergedBy": "arn:aws:iam::123456789012:user/Mary_Major" }, "repositoryName": "MyDemoRepo", "sourceCommit": "99132ab0EXAMPLE", "sourceReference": "refs/heads/variables-branch" } ], "title": "Consolidation of global variables" } } ``` Para obter mais informações, consulte [Mesclar uma solicitação pull](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-merge-pull-request.html#merge-pull-request-by-three-way) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [MergePullRequestByThreeWay](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/merge-pull-request-by-three-way.html) na *Referência de comandos da AWS CLI*. ### `override-pull-request-approval-rules` O código de exemplo a seguir mostra como usar `override-pull-request-approval-rules`. **AWS CLI** **Para substituir requisitos de regra de aprovação em uma solicitação pull** O exemplo `override-pull-request-approval-rules` a seguir substitui as regras de aprovação na solicitação pull especificada. Em vez disso, para revogar uma substituição, defina o valor do parâmetro `--override-status` como `REVOKE`. ``` aws codecommit override-pull-request-approval-rules \ --pull-request-id 34 \ --revision-id 927df8d8EXAMPLE \ --override-status OVERRIDE ``` Este comando não produz saída. Para obter mais informações, consulte [Substituir regras de aprovação em uma solicitação pull](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-override-approval-rules.html#override-approval-rules) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [OverridePullRequestApprovalRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/override-pull-request-approval-rules.html) na *Referência de comandos da AWS CLI*. ### `post-comment-for-compared-commit` O código de exemplo a seguir mostra como usar `post-comment-for-compared-commit`. **AWS CLI** **Para criar um comentário em uma confirmação** Este exemplo mostra como adicionar o comentário `"Can you add a test case for this?"` na alteração ao `cl_sample.js` arquivo na comparação entre duas confirmações em um repositório chamado `MyDemoRepo`. ``` aws codecommit post-comment-for-compared-commit \ --repository-name MyDemoRepo \ --before-commit-id 317f8570EXAMPLE \ --after-commit-id 5d036259EXAMPLE \ --client-request-token 123Example \ --content "Can you add a test case for this?" \ --location filePath=cl_sample.js,filePosition=1232,relativeFileVersion=AFTER ``` Resultado: ``` { "afterBlobId": "1f330709EXAMPLE", "afterCommitId": "317f8570EXAMPLE", "beforeBlobId": "80906a4cEXAMPLE", "beforeCommitId": "6e147360EXAMPLE", "comment": { "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", "clientRequestToken": "", "commentId": "553b509bEXAMPLE56198325", "content": "Can you add a test case for this?", "creationDate": 1508369612.203, "deleted": false, "commentId": "abc123-EXAMPLE", "lastModifiedDate": 1508369612.203, "callerReactions": [], "reactionCounts": [] }, "location": { "filePath": "cl_sample.js", "filePosition": 1232, "relativeFileVersion": "AFTER" , "repositoryName": "MyDemoRepo" } } ``` + Para ver detalhes da API, consulte [PostCommentForComparedCommit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/post-comment-for-compared-commit.html) na *Referência de comandos da AWS CLI*. ### `post-comment-for-pull-request` O código de exemplo a seguir mostra como usar `post-comment-for-pull-request`. **AWS CLI** **Para adicionar um comentário a uma solicitação pull** O exemplo `post-comment-for-pull-request` a seguir adiciona o comentário “Não parecem ser usados em nenhum outro lugar. Can we remove them?" na alteração ao arquivo `47` em uma solicitação pull com o ID `ahs_count.py` em um repositório chamado `MyDemoRepo`. ``` aws codecommit post-comment-for-pull-request \ --pull-request-id "47" \ --repository-name MyDemoRepo \ --before-commit-id 317f8570EXAMPLE \ --after-commit-id 5d036259EXAMPLE \ --client-request-token 123Example \ --content "These don't appear to be used anywhere. Can we remove them?" \ --location filePath=ahs_count.py,filePosition=367,relativeFileVersion=AFTER ``` Resultado: ``` { "afterBlobId": "1f330709EXAMPLE", "afterCommitId": "5d036259EXAMPLE", "beforeBlobId": "80906a4cEXAMPLE", "beforeCommitId": "317f8570EXAMPLE", "comment": { "authorArn": "arn:aws:iam::111111111111:user/Saanvi_Sarkar", "clientRequestToken": "123Example", "commentId": "abcd1234EXAMPLEb5678efgh", "content": "These don't appear to be used anywhere. Can we remove them?", "creationDate": 1508369622.123, "deleted": false, "CommentId": "", "lastModifiedDate": 1508369622.123, "callerReactions": [], "reactionCounts": [] }, "location": { "filePath": "ahs_count.py", "filePosition": 367, "relativeFileVersion": "AFTER" }, "repositoryName": "MyDemoRepo", "pullRequestId": "47" } ``` + Para ver detalhes da API, consulte [PostCommentForPullRequest](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/post-comment-for-pull-request.html) na *Referência de comandos da AWS CLI*. ### `post-comment-reply` O código de exemplo a seguir mostra como usar `post-comment-reply`. **AWS CLI** **Como responder a um comentário em uma confirmação ou em uma solicitação pull** Este exemplo mostra como adicionar a resposta `"Good catch. I'll remove them."` ao comentário com o ID `abcd1234EXAMPLEb5678efgh` gerado pelo sistema. ``` aws codecommit post-comment-reply \ --in-reply-to abcd1234EXAMPLEb5678efgh \ --content "Good catch. I'll remove them." \ --client-request-token 123Example ``` Resultado: ``` { "comment": { "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", "clientRequestToken": "123Example", "commentId": "442b498bEXAMPLE5756813", "content": "Good catch. I'll remove them.", "creationDate": 1508369829.136, "deleted": false, "CommentId": "abcd1234EXAMPLEb5678efgh", "lastModifiedDate": 150836912.221, "callerReactions": [], "reactionCounts": [] } } ``` + Para ver detalhes da API, consulte [PostCommentReply](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/post-comment-reply.html) na *Referência de comandos da AWS CLI*. ### `put-comment-reaction` O código de exemplo a seguir mostra como usar `put-comment-reaction`. **AWS CLI** **Como responder a um comentário em uma confirmação com um emoji** O exemplo `put-comment-reaction` a seguir responde a um comentário com o ID de `abcd1234EXAMPLEb5678efgh` com um valor de reação de emoji de `:thumbsup:`. ``` aws codecommit put-comment-reaction \ --comment-id abcd1234EXAMPLEb5678efgh \ --reaction-value :thumbsup: ``` Este comando não produz saída. Para obter mais informações, consulte [Comentar em uma confirmação no AWS CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-commit-comment.html#how-to-commit-comment-cli-commit-reply-emoji) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [PutCommentReaction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/put-comment-reaction.html) na *Referência de comandos da AWS CLI*. ### `put-file` O código de exemplo a seguir mostra como usar `put-file`. **AWS CLI** **Para adicionar um arquivo a um repositório** O exemplo `put-file` a seguir adiciona um arquivo chamado “ExampleSolution.py” a um repositório chamado “MyDemoRepo” para uma ramificação chamada 'feature-randomizationfeature' cuja confirmação mais recente apresenta um ID de 4c925148EXAMPLE: ``` aws codecommit put-file \ --repository-name MyDemoRepo \ --branch-name feature-randomizationfeature \ --file-content file://MyDirectory/ExampleSolution.py \ --file-path /solutions/ExampleSolution.py \ --parent-commit-id 4c925148EXAMPLE \ --name "Maria Garcia" \ --email "maria_garcia@example.com" \ --commit-message "I added a third randomization routine." ``` Resultado: ``` { "blobId": "2eb4af3bEXAMPLE", "commitId": "317f8570EXAMPLE", "treeId": "347a3408EXAMPLE" } ``` + Para ver detalhes da API, consulte [PutFile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/put-file.html) na *Referência de comandos da AWS CLI*. ### `put-repository-triggers` O código de exemplo a seguir mostra como usar `put-repository-triggers`. **AWS CLI** **Para adicionar ou atualizar um acionador em um repositório** Este exemplo demonstra como atualizar acionadores chamados “MyFirstTrigger” e “MySecondTrigger” usando um arquivo JSON já criado (aqui chamado MyTriggers.json) que contém a estrutura de todos os acionadores de um repositório chamado MyDemoRepo. Para saber como obter o JSON para acionadores existentes, consulte o comando get-repository-triggers. ``` aws codecommit put-repository-triggers \ --repository-name MyDemoRepo file://MyTriggers.json ``` Conteúdo de `MyTriggers.json`: ``` { "repositoryName": "MyDemoRepo", "triggers": [ { "destinationArn": "arn:aws:sns:us-east-1:80398EXAMPLE:MyCodeCommitTopic", "branches": [ "main", "preprod" ], "name": "MyFirstTrigger", "customData": "", "events": [ "all" ] }, { "destinationArn": "arn:aws:lambda:us-east-1:111111111111:function:MyCodeCommitPythonFunction", "branches": [], "name": "MySecondTrigger", "customData": "EXAMPLE", "events": [ "all" ] } ] } ``` Resultado: ``` { "configurationId": "6fa51cd8-35c1-EXAMPLE" } ``` + Consulte detalhes da API em [PutRepositoryTriggers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/put-repository-triggers.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Para adicionar tags da AWS a um repositório existente** O exemplo `tag-resource` a seguir marca o repositório especificado com duas tags. ``` aws codecommit tag-resource \ --resource-arn arn:aws:codecommit:us-west-2:111111111111:MyDemoRepo \ --tags Status=Secret,Team=Saanvi ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar uma tag a um repositório](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-tag-repository-add.html#how-to-tag-repository-add-cli) no *Guia do usuário do AWS CodeCommit*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `test-repository-triggers` O código de exemplo a seguir mostra como usar `test-repository-triggers`. **AWS CLI** **Para testar gatilhos em um repositório** Este exemplo demonstra como testar um gatilho chamado “MyFirstTrigger” em um repositório do AWS CodeCommit chamado MyDemoRepo. Neste exemplo, os eventos no repositório acionam notificações de um tópico do Amazon Simple Notification Service (Amazon SNS). Comando: ``` aws codecommit test-repository-triggers --repository-name MyDemoRepo --triggers name=MyFirstTrigger,destinationArn=arn:aws:sns:us-east-1:111111111111:MyCodeCommitTopic,branches=mainline,preprod,events=all ``` Resultado: ``` { "successfulExecutions": [ "MyFirstTrigger" ], "failedExecutions": [] } ``` + Para ver detalhes da API, consulte [TestRepositoryTriggers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/test-repository-triggers.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover tags da AWS de um repositório** O exemplo `untag-resource` a seguir remove a tag com a chave especificada do repositório chamado `MyDemoRepo`. ``` aws codecommit untag-resource \ --resource-arn arn:aws:codecommit:us-west-2:111111111111:MyDemoRepo \ --tag-keys Status ``` Este comando não produz saída. Para obter mais informações, consulte [Remover uma tag de um repositório](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-tag-repository-delete.html#how-to-tag-repository-delete-cli) no *Guia do usuário do AWS CodeCommit*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-approval-rule-template-content` O código de exemplo a seguir mostra como usar `update-approval-rule-template-content`. **AWS CLI** **Para atualizar o conteúdo de um modelo de regra de aprovação** O exemplo `update-approval-rule-template-content` a seguir altera o conteúdo de um modelo da regra de aprovação especificada para redefinir o grupo de aprovações para usuários que assumem a função de `CodeCommitReview`. ``` aws codecommit update-approval-rule-template-content \ --approval-rule-template-name 1-approver-rule \ --new-rule-content "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}" ``` Resultado: ``` { "approvalRuleTemplate": { "creationDate": 1571352720.773, "approvalRuleTemplateDescription": "Requires 1 approval for all pull requests from the CodeCommitReview pool", "lastModifiedDate": 1571358728.41, "approvalRuleTemplateId": "41de97b7-EXAMPLE", "approvalRuleTemplateContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 1,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}", "approvalRuleTemplateName": "1-approver-rule-for-all-pull-requests", "ruleContentSha256": "2f6c21a5EXAMPLE", "lastModifiedUser": "arn:aws:iam::123456789012:user/Li_Juan" } } ``` Para obter mais informações, consulte [Gerenciar modelos de regra de aprovação](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-manage-templates.html#update-template-content) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [UpdateApprovalRuleTemplateContent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-approval-rule-template-content.html) na *Referência de comandos da AWS CLI*. ### `update-approval-rule-template-description` O código de exemplo a seguir mostra como usar `update-approval-rule-template-description`. **AWS CLI** **Para atualizar a descrição de um modelo de regra de aprovação** O exemplo `update-approval-rule-template-description` a seguir altera a descrição do modelo de regra de aprovação especificado para `Requires 1 approval for all pull requests from the CodeCommitReview pool`: ``` aws codecommit update-approval-rule-template-description \ --approval-rule-template-name 1-approver-rule-for-all-pull-requests \ --approval-rule-template-description "Requires 1 approval for all pull requests from the CodeCommitReview pool" ``` Resultado: ``` { "approvalRuleTemplate": { "creationDate": 1571352720.773, "approvalRuleTemplateDescription": "Requires 1 approval for all pull requests from the CodeCommitReview pool", "lastModifiedDate": 1571358728.41, "approvalRuleTemplateId": "41de97b7-EXAMPLE", "approvalRuleTemplateContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 1,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}", "approvalRuleTemplateName": "1-approver-rule-for-all-pull-requests", "ruleContentSha256": "2f6c21a5EXAMPLE", "lastModifiedUser": "arn:aws:iam::123456789012:user/Li_Juan" } } ``` Para obter mais informações, consulte [Gerenciar modelos de regra de aprovação](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-manage-templates.html#update-template-description) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [UpdateApprovalRuleTemplateDescription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-approval-rule-template-description.html) na *Referência de comandos da AWS CLI*. ### `update-approval-rule-template-name` O código de exemplo a seguir mostra como usar `update-approval-rule-template-name`. **AWS CLI** **Para atualizar o nome de um modelo de regra de aprovação** O exemplo `update-approval-rule-template-name` a seguir altera o nome de um modelo de regra de aprovação de `1-approver-rule` para 1-approver-rule-for-all-pull-requests`. ``` aws codecommit update-approval-rule-template-name \ --old-approval-rule-template-name 1-approver-rule \ --new-approval-rule-template-name 1-approver-rule-for-all-pull-requests ``` Resultado: ``` { "approvalRuleTemplate": { "approvalRuleTemplateName": "1-approver-rule-for-all-pull-requests", "lastModifiedDate": 1571358241.619, "approvalRuleTemplateId": "41de97b7-EXAMPLE", "approvalRuleTemplateContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 1,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}", "creationDate": 1571352720.773, "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major", "approvalRuleTemplateDescription": "All pull requests must be approved by one developer on the team.", "ruleContentSha256": "2f6c21a5cEXAMPLE" } } ``` Para obter mais informações, consulte [Gerenciar modelos de regra de aprovação](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-manage-templates.html#update-template-description) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [UpdateApprovalRuleTemplateName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-approval-rule-template-name.html) na *Referência de comandos da AWS CLI*. ### `update-comment` O código de exemplo a seguir mostra como usar `update-comment`. **AWS CLI** **Para atualizar um comentário em uma confirmação** Este exemplo demonstra como adicionar o conteúdo `"Fixed as requested. I'll update the pull request."` a um comentário com um ID de `442b498bEXAMPLE5756813`. ``` aws codecommit update-comment \ --comment-id 442b498bEXAMPLE5756813 \ --content "Fixed as requested. I'll update the pull request." ``` Resultado: ``` { "comment": { "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", "clientRequestToken": "", "commentId": "442b498bEXAMPLE5756813", "content": "Fixed as requested. I'll update the pull request.", "creationDate": 1508369929.783, "deleted": false, "lastModifiedDate": 1508369929.287, "callerReactions": [], "reactionCounts": { "THUMBSUP" : 2 } } } ``` + Para ver detalhes da API, consulte [UpdateComment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-comment.html) na *Referência de comandos da AWS CLI*. ### `update-default-branch` O código de exemplo a seguir mostra como usar `update-default-branch`. **AWS CLI** **Para alterar a ramificação padrão de um repositório** Este exemplo altera a ramificação padrão em um repositório do AWS CodeCommit. Esse comando gerará saídas somente se houver erros. Comando: ``` aws codecommit update-default-branch --repository-name MyDemoRepo --default-branch-name MyNewBranch ``` Resultado: ``` None. ``` + Para ver detalhes da API, consulte [UpdateDefaultBranch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-default-branch.html) na *Referência de comandos da AWS CLI*. ### `update-pull-request-approval-rule-content` O código de exemplo a seguir mostra como usar `update-pull-request-approval-rule-content`. **AWS CLI** **Como editar uma regra de aprovação para uma solicitação pull** O exemplo `update-pull-request-approval-rule-content` a seguir mostra a regra de aprovação especificada por ela para exigir a aprovação de um usuário de um grupo de aprovação que inclui qualquer usuário do IAM na conta da AWS `123456789012`. ``` aws codecommit update-pull-request-approval-rule-content \ --pull-request-id 27 \ --approval-rule-name "Require two approved approvers" \ --approval-rule-content "{Version: 2018-11-08, Statements: [{Type: \"Approvers\", NumberOfApprovalsNeeded: 1, ApprovalPoolMembers:[\"CodeCommitApprovers:123456789012:user/*\"]}]}}" ``` Resultado: ``` { "approvalRule": { "approvalRuleContent": "{Version: 2018-11-08, Statements: [{Type: \"Approvers\", NumberOfApprovalsNeeded: 1, ApprovalPoolMembers:[\"CodeCommitApprovers:123456789012:user/*\"]}]}}", "approvalRuleId": "aac33506-EXAMPLE", "originApprovalRuleTemplate": {}, "creationDate": 1570752871.932, "lastModifiedDate": 1570754058.333, "approvalRuleName": Require two approved approvers", "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major", "ruleContentSha256": "cd93921cEXAMPLE", } } ``` Para obter mais informações, consulte [Editar ou excluir um modelo de regra de aprovação](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-edit-delete-pull-request-approval-rule.html#update-pull-request-approval-rule-content) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [UpdatePullRequestApprovalRuleContent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-pull-request-approval-rule-content.html) na *Referência de comandos da AWS CLI*. ### `update-pull-request-approval-state` O código de exemplo a seguir mostra como usar `update-pull-request-approval-state`. **AWS CLI** **Como aprovar ou revogar a aprovação de uma solicitação pull** O exemplo `update-pull-request-approval-state` a seguir aprova uma solicitação pull com o ID de `27` e um ID de revisão de `9f29d167EXAMPLE`. Se você quiser revogar a aprovação em vez disso, defina o valor do parâmetro `--approval-state` como `REVOKE`. ``` aws codecommit update-pull-request-approval-state \ --pull-request-id 27 \ --revision-id 9f29d167EXAMPLE \ --approval-state "APPROVE" ``` Este comando não produz saída. Para obter mais informações, consulte [Revisar uma solicitação pull](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-review-pull-request.html#update-pull-request-approval-state) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [UpdatePullRequestApprovalState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-pull-request-approval-state.html) na *Referência de comandos da AWS CLI*. ### `update-pull-request-description` O código de exemplo a seguir mostra como usar `update-pull-request-description`. **AWS CLI** **Para alterar a descrição de uma solicitação pull** Este exemplo mostra como alterar a descrição de uma solicitação pull com o ID de `47`. ``` aws codecommit update-pull-request-description \ --pull-request-id 47 \ --description "Updated the pull request to remove unused global variable." ``` Resultado: ``` { "pullRequest": { "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", "clientRequestToken": "", "creationDate": 1508530823.155, "description": "Updated the pull request to remove unused global variable.", "lastActivityDate": 1508372423.204, "pullRequestId": "47", "pullRequestStatus": "OPEN", "pullRequestTargets": [ { "destinationCommit": "9f31c968EXAMPLE", "destinationReference": "refs/heads/main", "mergeMetadata": { "isMerged": false, }, "repositoryName": "MyDemoRepo", "sourceCommit": "99132ab0EXAMPLE", "sourceReference": "refs/heads/variables-branch" } ], "title": "Consolidation of global variables" } } ``` + Para ver detalhes da API, consulte [UpdatePullRequestDescription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-pull-request-description.html) na *Referência de comandos da AWS CLI*. ### `update-pull-request-status` O código de exemplo a seguir mostra como usar `update-pull-request-status`. **AWS CLI** **Para alterar o status de uma solicitação pull** Este exemplo mostra como alterar o status de uma solicitação pull com o ID de `42` para um status de `CLOSED` em um repositório do AWS CodeCommit chamado `MyDemoRepo`. ``` aws codecommit update-pull-request-status \ --pull-request-id 42 \ --pull-request-status CLOSED ``` Resultado: ``` { "pullRequest": { "approvalRules": [ { "approvalRuleContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}", "approvalRuleId": "dd8b17fe-EXAMPLE", "approvalRuleName": "2-approvers-needed-for-this-change", "creationDate": 1571356106.936, "lastModifiedDate": 571356106.936, "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major", "ruleContentSha256": "4711b576EXAMPLE" } ], "authorArn": "arn:aws:iam::123456789012:user/Li_Juan", "clientRequestToken": "", "creationDate": 1508530823.165, "description": "Updated the pull request to remove unused global variable.", "lastActivityDate": 1508372423.12, "pullRequestId": "47", "pullRequestStatus": "CLOSED", "pullRequestTargets": [ { "destinationCommit": "9f31c968EXAMPLE", "destinationReference": "refs/heads/main", "mergeMetadata": { "isMerged": false, }, "repositoryName": "MyDemoRepo", "sourceCommit": "99132ab0EXAMPLE", "sourceReference": "refs/heads/variables-branch" } ], "title": "Consolidation of global variables" } } ``` + Para ver detalhes da API, consulte [UpdatePullRequestStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-pull-request-status.html) na *Referência de comandos da AWS CLI*. ### `update-pull-request-title` O código de exemplo a seguir mostra como usar `update-pull-request-title`. **AWS CLI** **Para alterar o título de uma solicitação pull** Este exemplo mostra como alterar o título de uma solicitação pull com o ID de `47`. ``` aws codecommit update-pull-request-title \ --pull-request-id 47 \ --title "Consolidation of global variables - updated review" ``` Resultado: ``` { "pullRequest": { "approvalRules": [ { "approvalRuleContent": "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}", "approvalRuleId": "dd8b17fe-EXAMPLE", "approvalRuleName": "2-approver-rule-for-main", "creationDate": 1571356106.936, "lastModifiedDate": 571356106.936, "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major", "originApprovalRuleTemplate": { "approvalRuleTemplateId": "dd8b26gr-EXAMPLE", "approvalRuleTemplateName": "2-approver-rule-for-main" }, "ruleContentSha256": "4711b576EXAMPLE" } ], "authorArn": "arn:aws:iam::123456789012:user/Li_Juan", "clientRequestToken": "", "creationDate": 1508530823.12, "description": "Review the latest changes and updates to the global variables. I have updated this request with some changes, including removing some unused variables.", "lastActivityDate": 1508372657.188, "pullRequestId": "47", "pullRequestStatus": "OPEN", "pullRequestTargets": [ { "destinationCommit": "9f31c968EXAMPLE", "destinationReference": "refs/heads/main", "mergeMetadata": { "isMerged": false, }, "repositoryName": "MyDemoRepo", "sourceCommit": "99132ab0EXAMPLE", "sourceReference": "refs/heads/variables-branch" } ], "title": "Consolidation of global variables - updated review" } } ``` + Para ver detalhes da API, consulte [UpdatePullRequestTitle](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-pull-request-title.html) na *Referência de comandos da AWS CLI*. ### `update-repository-description` O código de exemplo a seguir mostra como usar `update-repository-description`. **AWS CLI** **Para alterar a descrição de um repositório** Este exemplo altera a descrição em um repositório do AWS CodeCommit. Esse comando gerará saídas somente se houver erros. Comando: ``` aws codecommit update-repository-description --repository-name MyDemoRepo --repository-description "This description was changed" ``` Resultado: ``` None. ``` + Para ver detalhes da API, consulte [UpdateRepositoryDescription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-repository-description.html) na *Referência de comandos da AWS CLI*. ### `update-repository-name` O código de exemplo a seguir mostra como usar `update-repository-name`. **AWS CLI** **Para alterar o nome de um repositório** Este exemplo altera o nome de um repositório do AWS CodeCommit. Esse comando gerará saídas somente se houver erros. Alterar o nome do repositório do AWS CodeCommit alterará os URLs de SSH e HTTPS necessários para a conexão dos usuários ao repositório. Os usuários não poderão se conectar ao repositório até que atualizem suas configurações de conexão. Além disso, devido à alteração no ARN do repositório, alterar o nome do repositório invalidará todas as políticas de usuário do IAM que dependem do ARN desse repositório. Comando: ``` aws codecommit update-repository-name --old-name MyDemoRepo --new-name MyRenamedDemoRepo ``` Resultado: ``` None. ``` + Para ver detalhes da API, consulte [UpdateRepositoryName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-repository-name.html) na *Referência de comandos da AWS CLI*. # Exemplos do CodeDeploy usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o 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-tags-to-on-premises-instances` O código de exemplo a seguir mostra como usar `add-tags-to-on-premises-instances`. **AWS CLI** **Para adicionar tags a uma ou mais instâncias on-premises** O exemplo `add-tags-to-on-premises-instances` a seguir associa no AWS CodeDeploy a mesma tag de instância on-premises a duas instâncias on-premises. Ele não registra as instâncias on-premises no AWS CodeDeploy. ``` aws deploy add-tags-to-on-premises-instances \ --instance-names AssetTag12010298EX AssetTag23121309EX \ --tags Key=Name,Value=CodeDeployDemo-OnPrem ``` Este comando não produz saída. + Para ver detalhes da API, consulte [AddTagsToOnPremisesInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/add-tags-to-on-premises-instances.html) na *Referência de comandos da AWS CLI*. ### `batch-get-application-revisions` O código de exemplo a seguir mostra como usar `batch-get-application-revisions`. **AWS CLI** **Para recuperar informações sobre revisões de aplicações** O exemplo `batch-get-application-revisions` a seguir recupera informações sobre a revisão especificada armazenada em um repositório do GitHub. ``` aws deploy batch-get-application-revisions \ --application-name my-codedeploy-application \ --revisions "[{\"gitHubLocation\": {\"commitId\": \"fa85936EXAMPLEa31736c051f10d77297EXAMPLE\",\"repository\": \"my-github-token/my-repository\"},\"revisionType\": \"GitHub\"}]" ``` Resultado: ``` { "revisions": [ { "genericRevisionInfo": { "description": "Application revision registered by Deployment ID: d-A1B2C3111", "lastUsedTime": 1556912355.884, "registerTime": 1556912355.884, "firstUsedTime": 1556912355.884, "deploymentGroups": [] }, "revisionLocation": { "revisionType": "GitHub", "gitHubLocation": { "commitId": "fa85936EXAMPLEa31736c051f10d77297EXAMPLE", "repository": "my-github-token/my-repository" } } } ], "applicationName": "my-codedeploy-application", "errorMessage": "" } ``` Para obter mais informações, consulte [BatchGetApplicationRevisions](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_BatchGetApplicationRevisions.html) na *Referência da API do AWS CodeDeploy*. + Para ver detalhes da API, consulte [BatchGetApplicationRevisions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-application-revisions.html) na *Referência de comandos da AWS CLI*. ### `batch-get-applications` O código de exemplo a seguir mostra como usar `batch-get-applications`. **AWS CLI** **Para obter informações sobre várias aplicações** O exemplo `batch-get-applications` a seguir exibe informações sobre várias aplicações associadas à conta da AWS do usuário. ``` aws deploy batch-get-applications --application-names WordPress_App MyOther_App ``` Resultado: ``` { "applicationsInfo": [ { "applicationName": "WordPress_App", "applicationId": "d9dd6993-f171-44fa-a811-211e4EXAMPLE", "createTime": 1407878168.078, "linkedToGitHub": false }, { "applicationName": "MyOther_App", "applicationId": "8ca57519-31da-42b2-9194-8bb16EXAMPLE", "createTime": 1407453571.63, "linkedToGitHub": false } ] } ``` + Para ver detalhes da API, consulte [BatchGetApplications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-applications.html) na *Referência de comandos da AWS CLI*. ### `batch-get-deployment-groups` O código de exemplo a seguir mostra como usar `batch-get-deployment-groups`. **AWS CLI** **Para recuperar informações sobre um ou mais grupos de implantação** O exemplo `batch-get-deployment-groups` a seguir recupera informações sobre dois dos grupos de implantação associados à aplicação do CodeDeploy especificado. ``` aws deploy batch-get-deployment-groups \ --application-name my-codedeploy-application \ --deployment-group-names "[\"my-deployment-group-1\",\"my-deployment-group-2\"]" ``` Resultado: ``` { "deploymentGroupsInfo": [ { "deploymentStyle": { "deploymentOption": "WITHOUT_TRAFFIC_CONTROL", "deploymentType": "IN_PLACE" }, "autoRollbackConfiguration": { "enabled": false }, "onPremisesTagSet": { "onPremisesTagSetList": [] }, "serviceRoleArn": "arn:aws:iam::123456789012:role/CodeDeployServiceRole", "lastAttemptedDeployment": { "endTime": 1556912366.415, "status": "Failed", "createTime": 1556912355.884, "deploymentId": "d-A1B2C3111" }, "autoScalingGroups": [], "deploymentGroupName": "my-deployment-group-1", "ec2TagSet": { "ec2TagSetList": [ [ { "Type": "KEY_AND_VALUE", "Value": "my-EC2-instance", "Key": "Name" } ] ] }, "deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-11111example", "triggerConfigurations": [], "applicationName": "my-codedeploy-application", "computePlatform": "Server", "deploymentConfigName": "CodeDeployDefault.AllAtOnce" }, { "deploymentStyle": { "deploymentOption": "WITHOUT_TRAFFIC_CONTROL", "deploymentType": "IN_PLACE" }, "autoRollbackConfiguration": { "enabled": false }, "onPremisesTagSet": { "onPremisesTagSetList": [] }, "serviceRoleArn": "arn:aws:iam::123456789012:role/CodeDeployServiceRole", "autoScalingGroups": [], "deploymentGroupName": "my-deployment-group-2", "ec2TagSet": { "ec2TagSetList": [ [ { "Type": "KEY_AND_VALUE", "Value": "my-EC2-instance", "Key": "Name" } ] ] }, "deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-22222example", "triggerConfigurations": [], "applicationName": "my-codedeploy-application", "computePlatform": "Server", "deploymentConfigName": "CodeDeployDefault.AllAtOnce" } ], "errorMessage": "" } ``` Para obter mais informações, consulte [BatchGetDeploymentGroups](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_BatchGetDeploymentGroups.html) na *Referência da API do AWS CodeDeploy*. + Para ver detalhes da API, consulte [BatchGetDeploymentGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-deployment-groups.html) na *Referência de comandos da AWS CLI*. ### `batch-get-deployment-targets` O código de exemplo a seguir mostra como usar `batch-get-deployment-targets`. **AWS CLI** **Para recuperar os destinos associados a uma implantação** O exemplo `batch-get-deployment-targets` a seguir retorna informações sobre um dos destinos associados à implantação especificada. ``` aws deploy batch-get-deployment-targets \ --deployment-id "d-1A2B3C4D5" \ --target-ids "i-01a2b3c4d5e6f1111" ``` Resultado: ``` { "deploymentTargets": [ { "deploymentTargetType": "InstanceTarget", "instanceTarget": { "lifecycleEvents": [ { "startTime": 1556918592.162, "lifecycleEventName": "ApplicationStop", "status": "Succeeded", "endTime": 1556918592.247, "diagnostics": { "scriptName": "", "errorCode": "Success", "logTail": "", "message": "Succeeded" } }, { "startTime": 1556918593.193, "lifecycleEventName": "DownloadBundle", "status": "Succeeded", "endTime": 1556918593.981, "diagnostics": { "scriptName": "", "errorCode": "Success", "logTail": "", "message": "Succeeded" } }, { "startTime": 1556918594.805, "lifecycleEventName": "BeforeInstall", "status": "Succeeded", "endTime": 1556918681.807, "diagnostics": { "scriptName": "", "errorCode": "Success", "logTail": "", "message": "Succeeded" } } ], "targetArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-01a2b3c4d5e6f1111", "deploymentId": "d-1A2B3C4D5", "lastUpdatedAt": 1556918687.504, "targetId": "i-01a2b3c4d5e6f1111", "status": "Succeeded" } } ] } ``` Para obter mais informações, consulte [BatchGetDeploymentTargets](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_BatchGetDeploymentTargets.html) na *Referência da API do AWS CodeDeploy*. + Para ver detalhes da API, consulte [BatchGetDeploymentTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-deployment-targets.html) na *Referência de comandos da AWS CLI*. ### `batch-get-deployments` O código de exemplo a seguir mostra como usar `batch-get-deployments`. **AWS CLI** **Para obter informações sobre várias implantações** O exemplo `batch-get-deployments` a seguir exibe informações sobre várias implantações associadas à conta da AWS do usuário. ``` aws deploy batch-get-deployments --deployment-ids d-A1B2C3111 d-A1B2C3222 ``` Resultado: ``` { "deploymentsInfo": [ { "applicationName": "WordPress_App", "status": "Failed", "deploymentOverview": { "Failed": 0, "InProgress": 0, "Skipped": 0, "Succeeded": 1, "Pending": 0 }, "deploymentConfigName": "CodeDeployDefault.OneAtATime", "creator": "user", "deploymentGroupName": "WordPress_DG", "revision": { "revisionType": "S3", "s3Location": { "bundleType": "zip", "version": "uTecLusEXAMPLEFXtfUcyfV8bEXAMPLE", "bucket": "amzn-s3-demo-bucket", "key": "WordPressApp.zip" } }, "deploymentId": "d-A1B2C3111", "createTime": 1408480721.9, "completeTime": 1408480741.822 }, { "applicationName": "MyOther_App", "status": "Failed", "deploymentOverview": { "Failed": 1, "InProgress": 0, "Skipped": 0, "Succeeded": 0, "Pending": 0 }, "deploymentConfigName": "CodeDeployDefault.OneAtATime", "creator": "user", "errorInformation": { "message": "Deployment failed: Constraint default violated: No hosts succeeded.", "code": "HEALTH_CONSTRAINTS" }, "deploymentGroupName": "MyOther_DG", "revision": { "revisionType": "S3", "s3Location": { "bundleType": "zip", "eTag": "\"dd56cfdEXAMPLE8e768f9d77fEXAMPLE\"", "bucket": "amzn-s3-demo-bucket", "key": "MyOtherApp.zip" } }, "deploymentId": "d-A1B2C3222", "createTime": 1409764576.589, "completeTime": 1409764596.101 } ] } ``` + Para receber detalhes da API, consulte [BatchGetDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-deployments.html) na *Referência de comandos da AWS CLI*. ### `batch-get-on-premises-instances` O código de exemplo a seguir mostra como usar `batch-get-on-premises-instances`. **AWS CLI** **Para obter informações sobre uma ou mais instâncias on-premises** O exemplo `batch-get-on-premises-instances` a seguir obtém informações sobre duas instâncias on-premises. ``` aws deploy batch-get-on-premises-instances --instance-names AssetTag12010298EX AssetTag23121309EX ``` Resultado: ``` { "instanceInfos": [ { "iamUserArn": "arn:aws:iam::123456789012:user/AWS/CodeDeploy/AssetTag12010298EX", "tags": [ { "Value": "CodeDeployDemo-OnPrem", "Key": "Name" } ], "instanceName": "AssetTag12010298EX", "registerTime": 1425579465.228, "instanceArn": "arn:aws:codedeploy:us-west-2:123456789012:instance/AssetTag12010298EX_4IwLNI2Alh" }, { "iamUserArn": "arn:aws:iam::123456789012:user/AWS/CodeDeploy/AssetTag23121309EX", "tags": [ { "Value": "CodeDeployDemo-OnPrem", "Key": "Name" } ], "instanceName": "AssetTag23121309EX", "registerTime": 1425595585.988, "instanceArn": "arn:aws:codedeploy:us-west-2:80398EXAMPLE:instance/AssetTag23121309EX_PomUy64Was" } ] } ``` + Para ver detalhes da API, consulte [BatchGetOnPremisesInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-on-premises-instances.html) na *Referência de comandos da AWS CLI*. ### `continue-deployment` O código de exemplo a seguir mostra como usar `continue-deployment`. **AWS CLI** **Como começar a redirecionamento do tráfego sem esperar que ocorra um tempo de espera especificado.** O exemplo `continue-deployment` a seguir inicia o redirecionamento do tráfego de instâncias no ambiente original que estão prontas para começar a transferir tráfego para instâncias no ambiente de substituição. ``` aws deploy continue-deployment \ --deployment-id "d-A1B2C3111" \ --deployment-wait-type "READY_WAIT" ``` Este comando não produz saída. Para obter mais informações, consulte [ContinueDeployment](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_ContinueDeployment.html) na *Referência da API do AWS CodeDeploy*. + Para ver detalhes da API, consulte [ContinueDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/continue-deployment.html) na *Referência de comandos da AWS CLI*. ### `create-application` O código de exemplo a seguir mostra como usar `create-application`. **AWS CLI** **Para criar uma aplicação** O exemplo `create-application` a seguir cria uma aplicação e o associa à conta da AWS do usuário. ``` aws deploy create-application --application-name MyOther_App ``` Resultado: ``` { "applicationId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" } ``` + Para ver detalhes da API, consulte [CreateApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/create-application.html) na *Referência de comandos da AWS CLI*. ### `create-deployment-config` O código de exemplo a seguir mostra como usar `create-deployment-config`. **AWS CLI** **Para criar uma configuração de implantação personalizada** O exemplo `create-deployment-config` a seguir cria uma configuração de implantação personalizada e a associa à conta da AWS do usuário. ``` aws deploy create-deployment-config \ --deployment-config-name ThreeQuartersHealthy \ --minimum-healthy-hosts type=FLEET_PERCENT,value=75 ``` Resultado: ``` { "deploymentConfigId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" } ``` + Para ver detalhes da API, consulte [CreateDeploymentConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/create-deployment-config.html) na *Referência de comandos da AWS CLI*. ### `create-deployment-group` O código de exemplo a seguir mostra como usar `create-deployment-group`. **AWS CLI** **Para criar um grupo de implantação** O exemplo `create-deployment-group` a seguir cria um grupo de implantação e o associa à aplicação especificada e à conta da AWS do usuário. ``` aws deploy create-deployment-group \ --application-name WordPress_App \ --auto-scaling-groups CodeDeployDemo-ASG \ --deployment-config-name CodeDeployDefault.OneAtATime \ --deployment-group-name WordPress_DG \ --ec2-tag-filters Key=Name,Value=CodeDeployDemo,Type=KEY_AND_VALUE \ --service-role-arn arn:aws:iam::123456789012:role/CodeDeployDemoRole ``` Resultado: ``` { "deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" } ``` + Para ver detalhes da API, consulte [CreateDeploymentGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/create-deployment-group.html) na *Referência de comandos da AWS CLI*. ### `create-deployment` O código de exemplo a seguir mostra como usar `create-deployment`. **AWS CLI** **Exemplo 1: criar uma implantação do CodeDeploy usando a plataforma de computação EC2/on-premises** O exemplo `create-deployment` a seguir cria uma implantação e a associa à conta da AWS do usuário. ``` aws deploy create-deployment \ --application-name WordPress_App \ --deployment-config-name CodeDeployDefault.OneAtATime \ --deployment-group-name WordPress_DG \ --description "My demo deployment" \ --s3-location bucket=amzn-s3-demo-bucket,bundleType=zip,eTag=dd56cfdEXAMPLE8e768f9d77fEXAMPLE,key=WordPressApp.zip ``` Resultado: ``` { "deploymentId": "d-A1B2C3111" } ``` **Exemplo 2: criar uma implantação do CodeDeploy usando a plataforma de computação do Amazon ECS** O exemplo `create-deployment` a seguir usa os dois arquivos a seguir para implantar um serviço do Amazon ECS. Conteúdo do arquivo `create-deployment.json`: ``` { "applicationName": "ecs-deployment", "deploymentGroupName": "ecs-deployment-dg", "revision": { "revisionType": "S3", "s3Location": { "bucket": "ecs-deployment-bucket", "key": "appspec.yaml", "bundleType": "YAML" } } } ``` Esse arquivo, por sua vez, recupera o seguinte arquivo `appspec.yaml` de um bucket do S3 chamado `ecs-deployment-bucket`. ``` version: 0.0 Resources: - TargetService: Type: AWS::ECS::Service Properties: TaskDefinition: "arn:aws:ecs:region:123456789012:task-definition/ecs-task-def:2" LoadBalancerInfo: ContainerName: "sample-app" ContainerPort: 80 PlatformVersion: "LATEST" ``` Comando: ``` aws deploy create-deployment \ --cli-input-json file://create-deployment.json \ --region us-east-1 ``` Resultado: ``` { "deploymentId": "d-1234ABCDE" } ``` Para obter mais informações, consulte [CreateDeployment](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html) na *Referência da API do AWS CodeDeploy*. + Consulte detalhes da API em [CreateDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/create-deployment.html) na *Referência de comandos da AWS CLI*. ### `delete-application` O código de exemplo a seguir mostra como usar `delete-application`. **AWS CLI** **Como excluir uma aplicação do** O exemplo `delete-application` a seguir exclui a aplicação especificada que está associada à conta da AWS do usuário. ``` aws deploy delete-application --application-name WordPress_App ``` Este comando não produz saída. + Para ver detalhes da API, consulte [DeleteApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/delete-application.html) na *Referência de comandos da AWS CLI*. ### `delete-deployment-config` O código de exemplo a seguir mostra como usar `delete-deployment-config`. **AWS CLI** **Para excluir uma configuração de implantação** O exemplo `delete-deployment-config` a seguir exclui uma configuração de implantação personalizada associada à conta da AWS do usuário. ``` aws deploy delete-deployment-config --deployment-config-name ThreeQuartersHealthy ``` Este comando não produz saída. + Para ver detalhes da API, consulte [DeleteDeploymentConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/delete-deployment-config.html) na *Referência de comandos da AWS CLI*. ### `delete-deployment-group` O código de exemplo a seguir mostra como usar `delete-deployment-group`. **AWS CLI** **Para excluir um grupo de implantação** O exemplo `delete-deployment-group` a seguir exclui um grupo de implantação associado à aplicação especificada. ``` aws deploy delete-deployment-group \ --application-name WordPress_App \ --deployment-group-name WordPress_DG ``` Resultado: ``` { "hooksNotCleanedUp": [] } ``` + Para ver detalhes da API, consulte [DeleteDeploymentGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/delete-deployment-group.html) na *Referência de comandos da AWS CLI*. ### `delete-git-hub-account-token` O código de exemplo a seguir mostra como usar `delete-git-hub-account-token`. **AWS CLI** **Para excluir uma conexão de conta do GitHub** O exemplo `delete-git-hub-account-token` a seguir exclui a conexão da conta especificada do GitHub. ``` aws deploy delete-git-hub-account-token --token-name my-github-account ``` Resultado: ``` { "tokenName": "my-github-account" } ``` Para obter mais informações, consulte [DeleteGitHubAccountToken](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_DeleteGitHubAccountToken.html) na *Referência da API do AWS CodeDeploy*. + Para ver detalhes da API, consulte [DeleteGitHubAccountToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/delete-git-hub-account-token.html) na *Referência de comandos da AWS CLI*. ### `deregister-on-premises-instance` O código de exemplo a seguir mostra como usar `deregister-on-premises-instance`. **AWS CLI** **Como cancelar o registro de uma instância on-premises** O exemplo `deregister-on-premises-instance` a seguir cancela o registro de uma instância on-premises com o AWS CodeDeploy, mas não exclui o usuário do IAM associado à instância nem desassocia no AWS CodeDeploy as tags da instância on-premises da instância. Ele também não desinstala o agente do AWS CodeDeploy da instância nem remove o arquivo de configuração on-premises da instância. ``` aws deploy deregister-on-premises-instance --instance-name AssetTag12010298EX ``` Este comando não produz saída. + Para ver detalhes da API, consulte [DeregisterOnPremisesInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/deregister-on-premises-instance.html) na *Referência de comandos da AWS CLI*. ### `deregister` O código de exemplo a seguir mostra como usar `deregister`. **AWS CLI** **Como cancelar o registro de uma instância on-premises** O exemplo `deregister` a seguir cancela o registro da instância on-premises no AWS CodeDeploy. Ele não exclui o usuário do IAM que está associado à instância. Ele dissocia no AWS CodeDeploy as tags on-premises da instância. Ele não desinstala o agente do AWS CodeDeploy da instância nem remove o arquivo de configuração on-premises da instância. ``` aws deploy deregister \ --instance-name AssetTag12010298EX \ --no-delete-iam-user \ --region us-west-2 ``` Resultado: ``` Retrieving on-premises instance information... DONE IamUserArn: arn:aws:iam::80398EXAMPLE:user/AWS/CodeDeploy/AssetTag12010298EX Tags: Key=Name,Value=CodeDeployDemo-OnPrem Removing tags from the on-premises instance... DONE Deregistering the on-premises instance... DONE Run the following command on the on-premises instance to uninstall the codedeploy-agent: aws deploy uninstall ``` + Para ver detalhes da API, consulte [Deregister](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/deregister.html) na *Referência de comandos da AWS CLI*. ### `get-application-revision` O código de exemplo a seguir mostra como usar `get-application-revision`. **AWS CLI** **Para obter informações sobre uma revisão da aplicação** O exemplo `get-application-revision` a seguir exibe informações sobre uma revisão da aplicação associada à aplicação especificada. ``` aws deploy get-application-revision \ --application-name WordPress_App \ --s3-location bucket=amzn-s3-demo-bucket,bundleType=zip,eTag=dd56cfdEXAMPLE8e768f9d77fEXAMPLE,key=WordPressApp.zip ``` Resultado: ``` { "applicationName": "WordPress_App", "revisionInfo": { "description": "Application revision registered by Deployment ID: d-A1B2C3111", "registerTime": 1411076520.009, "deploymentGroups": "WordPress_DG", "lastUsedTime": 1411076520.009, "firstUsedTime": 1411076520.009 }, "revision": { "revisionType": "S3", "s3Location": { "bundleType": "zip", "eTag": "dd56cfdEXAMPLE8e768f9d77fEXAMPLE", "bucket": "amzn-s3-demo-bucket", "key": "WordPressApp.zip" } } } ``` + Para ver detalhes da API, consulte [GetApplicationRevision](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-application-revision.html) na *Referência de comandos da AWS CLI*. ### `get-application` O código de exemplo a seguir mostra como usar `get-application`. **AWS CLI** **Para obter informações sobre uma aplicação** O exemplo `get-application` a seguir exibe informações sobre uma aplicação associada à conta da AWS do usuário. ``` aws deploy get-application --application-name WordPress_App ``` Resultado: ``` { "application": { "applicationName": "WordPress_App", "applicationId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "createTime": 1407878168.078, "linkedToGitHub": false } } ``` + Para ver detalhes da API, consulte [GetApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-application.html) na *Referência de comandos da AWS CLI*. ### `get-deployment-config` O código de exemplo a seguir mostra como usar `get-deployment-config`. **AWS CLI** **Para obter informações sobre uma configuração de implantação** O exemplo `get-deployment-config` a seguir exibe informações sobre uma configuração de implantação associada à conta da AWS do usuário. ``` aws deploy get-deployment-config --deployment-config-name ThreeQuartersHealthy ``` Resultado: ``` { "deploymentConfigInfo": { "deploymentConfigId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "minimumHealthyHosts": { "type": "FLEET_PERCENT", "value": 75 }, "createTime": 1411081164.379, "deploymentConfigName": "ThreeQuartersHealthy" } } ``` + Para receber detalhes da API, consulte [GetDeploymentConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-deployment-config.html) na *Referência de comandos da AWS CLI*. ### `get-deployment-group` O código de exemplo a seguir mostra como usar `get-deployment-group`. **AWS CLI** **Como visualizar informações sobre um grupo de implantação** O exemplo `get-deployment-group` a seguir exibe informações sobre um grupo de implantação associado à aplicação especificada. ``` aws deploy get-deployment-group \ --application-name WordPress_App \ --deployment-group-name WordPress_DG ``` Resultado: ``` { "deploymentGroupInfo": { "applicationName": "WordPress_App", "autoScalingGroups": [ "CodeDeployDemo-ASG" ], "deploymentConfigName": "CodeDeployDefault.OneAtATime", "ec2TagFilters": [ { "Type": "KEY_AND_VALUE", "Value": "CodeDeployDemo", "Key": "Name" } ], "deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "serviceRoleArn": "arn:aws:iam::123456789012:role/CodeDeployDemoRole", "deploymentGroupName": "WordPress_DG" } } ``` + Para ver detalhes da API, consulte [GetDeploymentGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-deployment-group.html) na *Referência de comandos da AWS CLI*. ### `get-deployment-instance` O código de exemplo a seguir mostra como usar `get-deployment-instance`. **AWS CLI** **Para obter informações sobre uma instância de implantação** O exemplo `get-deployment-instance` a seguir exibe informações sobre uma instância de implantação associada à implantação especificada. ``` aws deploy get-deployment-instance --deployment-id d-QA4G4F9EX --instance-id i-902e9fEX ``` Resultado: ``` { "instanceSummary": { "instanceId": "arn:aws:ec2:us-east-1:80398EXAMPLE:instance/i-902e9fEX", "lifecycleEvents": [ { "status": "Succeeded", "endTime": 1408480726.569, "startTime": 1408480726.437, "lifecycleEventName": "ApplicationStop" }, { "status": "Succeeded", "endTime": 1408480728.016, "startTime": 1408480727.665, "lifecycleEventName": "DownloadBundle" }, { "status": "Succeeded", "endTime": 1408480729.744, "startTime": 1408480729.125, "lifecycleEventName": "BeforeInstall" }, { "status": "Succeeded", "endTime": 1408480730.979, "startTime": 1408480730.844, "lifecycleEventName": "Install" }, { "status": "Failed", "endTime": 1408480732.603, "startTime": 1408480732.1, "lifecycleEventName": "AfterInstall" }, { "status": "Skipped", "endTime": 1408480732.606, "lifecycleEventName": "ApplicationStart" }, { "status": "Skipped", "endTime": 1408480732.606, "lifecycleEventName": "ValidateService" } ], "deploymentId": "d-QA4G4F9EX", "lastUpdatedAt": 1408480733.152, "status": "Failed" } } ``` + Para ver detalhes da API, consulte [GetDeploymentInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-deployment-instance.html) na *Referência de comandos da AWS CLI*. ### `get-deployment-target` O código de exemplo a seguir mostra como usar `get-deployment-target`. **AWS CLI** **Como retornar informações sobre um destino de implantação** O exemplo `get-deployment-target` a seguir retorna informações sobre um destino de implantação associado à implantação especificada. ``` aws deploy get-deployment-target \ --deployment-id "d-A1B2C3111" \ --target-id "i-a1b2c3d4e5f611111" ``` Resultado: ``` { "deploymentTarget": { "deploymentTargetType": "InstanceTarget", "instanceTarget": { "lastUpdatedAt": 1556918687.504, "targetId": "i-a1b2c3d4e5f611111", "targetArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-a1b2c3d4e5f611111", "status": "Succeeded", "lifecycleEvents": [ { "status": "Succeeded", "diagnostics": { "errorCode": "Success", "message": "Succeeded", "logTail": "", "scriptName": "" }, "lifecycleEventName": "ApplicationStop", "startTime": 1556918592.162, "endTime": 1556918592.247 }, { "status": "Succeeded", "diagnostics": { "errorCode": "Success", "message": "Succeeded", "logTail": "", "scriptName": "" }, "lifecycleEventName": "DownloadBundle", "startTime": 1556918593.193, "endTime": 1556918593.981 }, { "status": "Succeeded", "diagnostics": { "errorCode": "Success", "message": "Succeeded", "logTail": "", "scriptName": "" }, "lifecycleEventName": "BeforeInstall", "startTime": 1556918594.805, "endTime": 1556918681.807 }, { "status": "Succeeded", "diagnostics": { "errorCode": "Success", "message": "Succeeded", "logTail": "", "scriptName": "" }, "lifecycleEventName": "Install", "startTime": 1556918682.696, "endTime": 1556918683.005 }, { "status": "Succeeded", "diagnostics": { "errorCode": "Success", "message": "Succeeded", "logTail": "", "scriptName": "" }, "lifecycleEventName": "AfterInstall", "startTime": 1556918684.135, "endTime": 1556918684.216 }, { "status": "Succeeded", "diagnostics": { "errorCode": "Success", "message": "Succeeded", "logTail": "", "scriptName": "" }, "lifecycleEventName": "ApplicationStart", "startTime": 1556918685.211, "endTime": 1556918685.295 }, { "status": "Succeeded", "diagnostics": { "errorCode": "Success", "message": "Succeeded", "logTail": "", "scriptName": "" }, "lifecycleEventName": "ValidateService", "startTime": 1556918686.65, "endTime": 1556918686.747 } ], "deploymentId": "d-A1B2C3111" } } } ``` Para obter mais informações, consulte [GetDeploymentTarget](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_GetDeploymentTarget.html) na *Referência da API do AWS CodeDeploy*. + Para receber detalhes da API, consulte [GetDeploymentTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-deployment-target.html) na *Referência de comandos da AWS CLI*. ### `get-deployment` O código de exemplo a seguir mostra como usar `get-deployment`. **AWS CLI** **Para obter informações sobre uma implantação** O exemplo `get-deployment` a seguir exibe informações sobre uma implantação associada à conta da AWS do usuário. ``` aws deploy get-deployment --deployment-id d-A1B2C3123 ``` Resultado: ``` { "deploymentInfo": { "applicationName": "WordPress_App", "status": "Succeeded", "deploymentOverview": { "Failed": 0, "InProgress": 0, "Skipped": 0, "Succeeded": 1, "Pending": 0 }, "deploymentConfigName": "CodeDeployDefault.OneAtATime", "creator": "user", "description": "My WordPress app deployment", "revision": { "revisionType": "S3", "s3Location": { "bundleType": "zip", "eTag": "\"dd56cfdEXAMPLE8e768f9d77fEXAMPLE\"", "bucket": "amzn-s3-demo-bucket", "key": "WordPressApp.zip" } }, "deploymentId": "d-A1B2C3123", "deploymentGroupName": "WordPress_DG", "createTime": 1409764576.589, "completeTime": 1409764596.101, "ignoreApplicationStopFailures": false } } ``` + Para ver detalhes da API, consulte [GetDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-deployment.html) na *Referência de comandos da AWS CLI*. ### `get-on-premises-instance` O código de exemplo a seguir mostra como usar `get-on-premises-instance`. **AWS CLI** **Para obter informações sobre uma única instância on-premises** O exemplo `get-on-premises-instance` a seguir retorna as informações sobre uma instância on-premises especificada. ``` aws deploy get-on-premises-instance --instance-name AssetTag12010298EX ``` Resultado: ``` { "instanceInfo": { "iamUserArn": "arn:aws:iam::123456789012:user/AWS/CodeDeploy/AssetTag12010298EX", "tags": [ { "Value": "CodeDeployDemo-OnPrem", "Key": "Name" } ], "instanceName": "AssetTag12010298EX", "registerTime": 1425579465.228, "instanceArn": "arn:aws:codedeploy:us-east-1:123456789012:instance/AssetTag12010298EX_4IwLNI2Alh" } } ``` + Para ver detalhes da API, consulte [GetOnPremisesInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-on-premises-instance.html) na *Referência de comandos da AWS CLI*. ### `install` O código de exemplo a seguir mostra como usar `install`. **AWS CLI** **Como instalar uma instância on-premises** O exemplo `install` a seguir copia o arquivo de configuração on-premises do local especificado na instância para o local na instância que o agente do AWS CodeDeploy espera encontrá-la. Ele também instala o agente do AWS CodeDeploy na instância. Ele não cria nenhum usuário do IAM, nem registra a instância on-premises com o AWS CodeDeploy, nem associa nenhuma tag de instância on-premises no AWS CodeDeploy para a instância. ``` aws deploy install \ --override-config \ --config-file C:\temp\codedeploy.onpremises.yml \ --region us-west-2 \ --agent-installer s3://aws-codedeploy-us-west-2/latest/codedeploy-agent.msi ``` Resultado: ``` Creating the on-premises instance configuration file... DONE Installing the AWS CodeDeploy Agent... DONE ``` + Para ver detalhes da API, consulte [Install](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/install.html) na *Referência de comandos da AWS CLI*. ### `list-application-revisions` O código de exemplo a seguir mostra como usar `list-application-revisions`. **AWS CLI** **Para obter informações sobre revisões da aplicação** O exemplo `list-application-revisions` a seguir exibe informações sobre todas as revisões da aplicação associadas à aplicação especificada. ``` aws deploy list-application-revisions \ --application-name WordPress_App \ --s-3-bucket amzn-s3-demo-bucket \ --deployed exclude \ --s-3-key-prefix WordPress_ \ --sort-by lastUsedTime \ --sort-order descending ``` Resultado: ``` { "revisions": [ { "revisionType": "S3", "s3Location": { "version": "uTecLusvCB_JqHFXtfUcyfV8bEXAMPLE", "bucket": "amzn-s3-demo-bucket", "key": "WordPress_App.zip", "bundleType": "zip" } }, { "revisionType": "S3", "s3Location": { "version": "tMk.UxgDpMEVb7V187ZM6wVAWEXAMPLE", "bucket": "amzn-s3-demo-bucket", "key": "WordPress_App_2-0.zip", "bundleType": "zip" } } ] } ``` + Para ver detalhes da API, consulte [ListApplicationRevisions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-application-revisions.html) na *Referência de comandos da AWS CLI*. ### `list-applications` O código de exemplo a seguir mostra como usar `list-applications`. **AWS CLI** **Para obter informações sobre aplicações** O exemplo `list-applications` a seguir exibe informações sobre todos as aplicações associadas à conta da AWS do usuário. ``` aws deploy list-applications ``` Resultado: ``` { "applications": [ "WordPress_App", "MyOther_App" ] } ``` + Para ver detalhes da API, consulte [ListApplications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-applications.html) na *Referência de comandos da AWS CLI*. ### `list-deployment-configs` O código de exemplo a seguir mostra como usar `list-deployment-configs`. **AWS CLI** **Para obter informações sobre configurações de implantação** O exemplo `list-deployment-configs` a seguir exibe informações sobre todas as configurações de implantação associadas à conta da AWS do usuário. ``` aws deploy list-deployment-configs ``` Resultado: ``` { "deploymentConfigsList": [ "ThreeQuartersHealthy", "CodeDeployDefault.AllAtOnce", "CodeDeployDefault.HalfAtATime", "CodeDeployDefault.OneAtATime" ] } ``` + Para ver detalhes da API, consulte [ListDeploymentConfigs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-deployment-configs.html) na *Referência de comandos da AWS CLI*. ### `list-deployment-groups` O código de exemplo a seguir mostra como usar `list-deployment-groups`. **AWS CLI** **Para obter informações sobre grupos de implantação** O exemplo `list-deployment-groups` a seguir exibe informações sobre todos os grupos de implantação associados à aplicação especificada. ``` aws deploy list-deployment-groups --application-name WordPress_App ``` Resultado: ``` { "applicationName": "WordPress_App", "deploymentGroups": [ "WordPress_DG", "WordPress_Beta_DG" ] } ``` + Para ver detalhes da API, consulte [ListDeploymentGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-deployment-groups.html) na *Referência de comandos da AWS CLI*. ### `list-deployment-instances` O código de exemplo a seguir mostra como usar `list-deployment-instances`. **AWS CLI** **Para obter informações sobre instâncias de implantação** O exemplo `list-deployment-instances` a seguir exibe informações sobre todas as instâncias de implantação associadas à implantação especificada. ``` aws deploy list-deployment-instances \ --deployment-id d-A1B2C3111 \ --instance-status-filter Succeeded ``` Resultado: ``` { "instancesList": [ "i-EXAMPLE11", "i-EXAMPLE22" ] } ``` + Para ver detalhes da API, consulte [ListDeploymentInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-deployment-instances.html) na *Referência de comandos da AWS CLI*. ### `list-deployment-targets` O código de exemplo a seguir mostra como usar `list-deployment-targets`. **AWS CLI** **Para recuperar uma lista de IDs de destino que estão associados a uma implantação** O exemplo `list-deployment-targets` a seguir recupera uma lista de IDs de destino associadas a implantações que têm um status de “Failed” ou “InProgress”. ``` aws deploy list-deployment-targets \ --deployment-id "d-A1B2C3111" \ --target-filters "{\"TargetStatus\":[\"Failed\",\"InProgress\"]}" ``` Resultado: ``` { "targetIds": [ "i-0f1558aaf90e5f1f9" ] } ``` Para obter mais informações, consulte [ListDeploymentTargets](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_ListDeploymentTargets.html) na *Referência da API do AWS CodeDeploy*. + Para ver detalhes da API, consulte [ListDeploymentTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-deployment-targets.html) na *Referência de comandos da AWS CLI*. ### `list-deployments` O código de exemplo a seguir mostra como usar `list-deployments`. **AWS CLI** **Para obter informações sobre implantações** O exemplo `list-deployments` a seguir exibe informações sobre todas as implantações associadas à aplicação e ao grupo de implantação especificados. ``` aws deploy list-deployments \ --application-name WordPress_App \ --create-time-range start=2014-08-19T00:00:00,end=2014-08-20T00:00:00 \ --deployment-group-name WordPress_DG \ --include-only-statuses Failed ``` Resultado: ``` { "deployments": [ "d-EXAMPLE11", "d-EXAMPLE22", "d-EXAMPLE33" ] } ``` + Para ver detalhes da API, consulte [ListDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-deployments.html) na *Referência de comandos da AWS CLI*. ### `list-git-hub-account-token-names` O código de exemplo a seguir mostra como usar `list-git-hub-account-token-names`. **AWS CLI** **Para listar os nomes das conexões armazenadas para contas do GitHub** O exemplo `list-git-hub-account-token-names` a seguir lista os nomes das conexões armazenadas nas contas do GitHub para o usuário da AWS atual. ``` aws deploy list-git-hub-account-token-names ``` Resultado: ``` { "tokenNameList": [ "my-first-token", "my-second-token", "my-third-token" ] } ``` Para obter mais informações, consulte [ListGitHubAccountTokenNames](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_ListGitHubAccountTokenNames.html) na *Referência da API do AWS CodeDeploy*. + Para ver detalhes da API, consulte [ListGitHubAccountTokenNames](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-git-hub-account-token-names.html) na *Referência de comandos da AWS CLI*. ### `list-on-premises-instances` O código de exemplo a seguir mostra como usar `list-on-premises-instances`. **AWS CLI** **Para obter informações sobre uma ou mais instâncias on-premises** O exemplo `list-on-premises-instances` a seguir recupera uma lista de nomes de instâncias on-premises disponíveis para instâncias registradas no AWS CodeDeploy e que também têm a tag de instância on-premises especificada associada no AWS CodeDeploy à instância. ``` aws deploy list-on-premises-instances \ --registration-status Registered \ --tag-filters Key=Name,Value=CodeDeployDemo-OnPrem,Type=KEY_AND_VALUE ``` Resultado: ``` { "instanceNames": [ "AssetTag12010298EX" ] } ``` + Para ver detalhes da API, consulte [ListOnPremisesInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-on-premises-instances.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar tags para um recurso (aplicação)** O exemplo `list-tags-for-resource` a seguir lista as tags aplicadas a uma aplicação chamada testApp no CodeDeploy. ``` aws deploy list-tags-for-resource \ --resource-arn arn:aws:codedeploy:us-west-2:111122223333:application:testApp ``` Resultado: ``` { "Tags": [ { "Key": "Type", "Value": "testType" }, { "Key": "Name", "Value": "testName" } ] } ``` Para obter mais informações, consulte [Marcar instâncias de grupos de implantação no CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-tagging.html) no *Guia do usuário do AWS CodeDeploy*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `push` O código de exemplo a seguir mostra como usar `push`. **AWS CLI** **Como agrupar e implantar uma revisão de aplicação compatível com o AWS CodeDeploy no Amazon S3** O exemplo `push` a seguir empacota e implanta uma revisão da aplicação no Amazon S3 e, em seguida, associa a revisão da aplicação à aplicação especificada. ``` aws deploy push \ --application-name WordPress_App \ --description "This is my deployment" \ --ignore-hidden-files \ --s3-location s3://amzn-s3-demo-bucket/WordPressApp.zip \ --source /tmp/MyLocalDeploymentFolder/ ``` A saída descreve como usar o comando `create-deployment` para criar uma implantação que usa a revisão da aplicação carregada. ``` To deploy with this revision, run: aws deploy create-deployment --application-name WordPress_App --deployment-config-name --deployment-group-name --s3-location bucket=amzn-s3-demo-bucket,key=WordPressApp.zip,bundleType=zip,eTag="cecc9b8EXAMPLE50a6e71fdb88EXAMPLE",version=LFsJAUdEXAMPLEfvKtvi79L8EXAMPLE ``` + Para ver detalhes da API, consulte [Push](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/push.html) na *Referência de comandos da AWS CLI*. ### `register-application-revision` O código de exemplo a seguir mostra como usar `register-application-revision`. **AWS CLI** **Para registrar informações sobre uma revisão de aplicação já carregada** O exemplo `register-application-revision` a seguir registra informações sobre uma revisão de aplicação já carregada armazenada no Amazon S3 com o AWS CodeDeploy. ``` aws deploy register-application-revision \ --application-name WordPress_App \ --description "Revised WordPress application" \ --s3-location bucket=amzn-s3-demo-bucket,key=RevisedWordPressApp.zip,bundleType=zip,eTag=cecc9b8a08eac650a6e71fdb88EXAMPLE ``` Este comando não produz saída. + Para ver detalhes da API, consulte [RegisterApplicationRevision](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/register-application-revision.html) na *Referência de comandos da AWS CLI*. ### `register-on-premises-instance` O código de exemplo a seguir mostra como usar `register-on-premises-instance`. **AWS CLI** **Para registrar uma instância on-premises** O exemplo `register-on-premises-instance` a seguir registrar a instância on-premises no AWS CodeDeploy. Ele não cria o usuário do IAM especificado nem associa no AWS CodeDeploy nenhuma tag de instância on-premises à instância registrada. ``` aws deploy register-on-premises-instance \ --instance-name AssetTag12010298EX \ --iam-user-arn arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser-OnPrem ``` Este comando não produz saída. + Para ver detalhes da API, consulte [RegisterOnPremisesInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/register-on-premises-instance.html) na *Referência de comandos da AWS CLI*. ### `register` O código de exemplo a seguir mostra como usar `register`. **AWS CLI** **Para registrar uma instância on-premises** O exemplo `register` a seguir registra uma instância on-premises com o AWS CodeDeploy, associa no AWS CodeDeploy a tag de instância on-premises especificada à instância registrada e cria um arquivo de configuração on-premises que pode ser copiado para a instância. Ele não cria o usuário do IAM nem instala o agente do AWS CodeDeploy na instância. ``` aws deploy register \ --instance-name AssetTag12010298EX \ --iam-user-arn arn:aws:iam::80398EXAMPLE:user/CodeDeployUser-OnPrem \ --tags Key=Name,Value=CodeDeployDemo-OnPrem \ --region us-west-2 ``` Resultado: ``` Registering the on-premises instance... DONE Adding tags to the on-premises instance... DONE Copy the on-premises configuration file named codedeploy.onpremises.yml to the on-premises instance, and run the following command on the on-premises instance to install and configure the AWS CodeDeploy Agent: aws deploy install --config-file codedeploy.onpremises.yml ``` + Para ver detalhes da API, consulte [Register](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/register.html) na *Referência de comandos da AWS CLI*. ### `remove-tags-from-on-premises-instances` O código de exemplo a seguir mostra como usar `remove-tags-from-on-premises-instances`. **AWS CLI** **Para remover tags de uma ou mais instâncias on-premises** O exemplo `remove-tags-from-on-premises-instances` a seguir dissocia as tags on-premises especificadas no AWS CodeDeploy das instâncias on-premises. Ele não cancela o registro das instâncias on-premises no AWS CodeDeploy, nem desinstala o agente do AWS CodeDeploy da instância, nem remove o arquivo de configuração on-premises das instâncias, nem exclui os usuários do IAM associados às instâncias. ``` aws deploy remove-tags-from-on-premises-instances \ --instance-names AssetTag12010298EX AssetTag23121309EX \ --tags Key=Name,Value=CodeDeployDemo-OnPrem ``` Este comando não produz saída. + Para ver detalhes da API, consulte [RemoveTagsFromOnPremisesInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/remove-tags-from-on-premises-instances.html) na *Referência de comandos da AWS CLI*. ### `stop-deployment` O código de exemplo a seguir mostra como usar `stop-deployment`. **AWS CLI** **Como tentar interromper uma implantação** O exemplo `stop-deployment` a seguir tenta interromper uma implantação em andamento associada à conta da AWS do usuário. aws deploy stop-deployment --deployment-id d-A1B2C3111 Resultado: ``` { "status": "Succeeded", "statusMessage": "No more commands will be scheduled for execution in the deployment instances" } ``` + Para ver detalhes da API, consulte [StopDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/stop-deployment.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como marcar um recurso (aplicação)** O exemplo `tag-resource` a seguir adiciona duas tags com as chaves Name e Type e os valores testName e testType a uma aplicação chamada testApp no CodeDeploy: ``` aws deploy tag-resource \ --resource-arn arn:aws:codedeploy:us-west-2:111122223333:application:testApp \ --tags Key=Name,Value=testName Key=Type,Value=testType ``` Se for bem-sucedido, esse comando não gerará nenhum resultado. Para obter mais informações, consulte [Marcar instâncias de grupos de implantação no CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-tagging.html) no *Guia do usuário do AWS CodeDeploy*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `uninstall` O código de exemplo a seguir mostra como usar `uninstall`. **AWS CLI** **Como desinstalar uma instância on-premises** O exemplo `uninstall` a seguir desinstala o agente do AWS CodeDeploy da instância on-premises e remove o arquivo de configuração on-premises da instância. Ele não cancela o registro da instância no AWS CodeDeploy, nem desassocia nenhuma tag de instância on-premises no AWS CodeDeploy da instância nem exclui o usuário do IAM associado à instância. ``` aws deploy uninstall ``` Este comando não produz saída. + Para ver detalhes da API, consulte [Uninstall](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/uninstall.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover tags de um recurso (aplicação)** O exemplo `untag-resource` a seguir remove duas tags com as chaves Name e Type de uma aplicação chamada testApp no CodeDeploy. ``` aws deploy untag-resource \ --resource-arn arn:aws:codedeploy:us-west-2:111122223333:application:testApp \ --tag-keys Name Type ``` Se for bem-sucedido, esse comando não gerará nenhum resultado. Para obter mais informações, consulte [Marcar instâncias de grupos de implantação no CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-tagging.html) no *Guia do usuário do AWS CodeDeploy*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-application` O código de exemplo a seguir mostra como usar `update-application`. **AWS CLI** **Para alterar os detalhes de uma aplicação** O exemplo `update-application` a seguir altera o nome de uma aplicação associada à conta da AWS do usuário. ``` aws deploy update-application \ --application-name WordPress_App \ --new-application-name My_WordPress_App ``` Este comando não produz saída. + Para ver detalhes da API, consulte [UpdateApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/update-application.html) na *Referência de comandos da AWS CLI*. ### `update-deployment-group` O código de exemplo a seguir mostra como usar `update-deployment-group`. **AWS CLI** **Para alterar as informações sobre um grupo de implantação** O exemplo `update-deployment-group` a seguir altera as configurações de um grupo de implantação associado à aplicação especificada. ``` aws deploy update-deployment-group \ --application-name WordPress_App \ --auto-scaling-groups My_CodeDeployDemo_ASG \ --current-deployment-group-name WordPress_DG \ --deployment-config-name CodeDeployDefault.AllAtOnce \ --ec2-tag-filters Key=Name,Type=KEY_AND_VALUE,Value=My_CodeDeployDemo \ --new-deployment-group-name My_WordPress_DepGroup \ --service-role-arn arn:aws:iam::80398EXAMPLE:role/CodeDeployDemo-2 ``` Este comando não produz saída. + Para ver detalhes da API, consulte [UpdateDeploymentGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/update-deployment-group.html) na *Referência de comandos da AWS CLI*. # Exemplos do CodeGuru Reviewer usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o CodeGuru Reviewer. *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 ### `associate-repository` O código de exemplo a seguir mostra como usar `associate-repository`. **AWS CLI** **Exemplo 1: criar uma associação de repositório do Bitbucket** O exemplo `associate-repository` a seguir cria uma associação de repositório usando um repositório do Bitbucket existente. ``` aws codeguru-reviewer associate-repository \ --repository 'Bitbucket={Owner=sample-owner, Name=mySampleRepo, ConnectionArn=arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 }' ``` Resultado: ``` { "RepositoryAssociation": { "ProviderType": "Bitbucket", "Name": "mySampleRepo", "LastUpdatedTimeStamp": 1596216896.979, "AssociationId": "association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "CreatedTimeStamp": 1596216896.979, "ConnectionArn": "arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "State": "Associating", "StateReason": "Pending Repository Association", "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "Owner": "sample-owner" } } ``` Para obter mais informações, consulte [Criar uma associação de repositório do Bitbucket no Amazon CodeGuru Reviewer](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-bitbucket-association.html) no *Guia do usuário do Amazon CodeGuru Reviewer*. **Exemplo 2: criar uma associação de repositório do GitHub Enterprise Server** O exemplo `associate-repository` a seguir cria uma associação de repositório usando um repositório do GitHub Enterprise existente. ``` aws codeguru-reviewer associate-repository \ --repository 'GitHubEnterpriseServer={Owner=sample-owner, Name=mySampleRepo, ConnectionArn=arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 }' ``` Resultado: ``` { "RepositoryAssociation": { "ProviderType": "GitHubEnterpriseServer", "Name": "mySampleRepo", "LastUpdatedTimeStamp": 1596216896.979, "AssociationId": "association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "CreatedTimeStamp": 1596216896.979, "ConnectionArn": "arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "State": "Associating", "StateReason": "Pending Repository Association", "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "Owner": "sample-owner" } } ``` Para obter mais informações, consulte [Criar uma associação de repositório do GitHub Enterprise Server](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-github-enterprise-association.html) no *Guia do usuário do Amazon CodeGuru Reviewer*. **Exemplo 3: criar uma associação de repositório do AWS CodeCommit** O exemplo `associate-repository` a seguir cria uma associação de repositório usando um repositório do AWS CodeCommit existente. ``` aws codeguru-reviewer associate-repository \ --repository CodeCommit={Name=mySampleRepo} ``` Resultado: ``` { "RepositoryAssociation": { "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "Name": "My-ecs-beta-repo", "LastUpdatedTimeStamp": 1595634764.029, "ProviderType": "CodeCommit", "CreatedTimeStamp": 1595634764.029, "Owner": "544120495673", "State": "Associating", "StateReason": "Pending Repository Association", "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:544120495673:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } } ``` Para obter mais informações, consulte [Criar uma associação de repositório do AWS CodeCommit no Amazon CodeGuru Reviewer](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-codecommit-association.html) no *Guia do usuário do Amazon CodeGuru Reviewer*. + Para ver detalhes da API, consulte [AssociateRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/associate-repository.html) na *Referência de comandos da AWS CLI*. ### `create-code-review` O código de exemplo a seguir mostra como usar `create-code-review`. **AWS CLI** **Para criar uma revisão de código.** O `create-code-review` a seguir cria uma revisão do código na ramificação `mainline` de um repositório do AWS CodeCommit chamado `my-repository-name`. ``` aws codeguru-reviewer create-code-review \ --name my-code-review \ --repository-association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --type '{"RepositoryAnalysis": {"RepositoryHead": {"BranchName": "mainline"}}}' ``` Resultado: ``` { "CodeReview": { "Name": "my-code-review", "CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222:code-review:RepositoryAnalysis-my-code-review", "RepositoryName": "my-repository-name", "Owner": "123456789012", "ProviderType": "CodeCommit", "State": "Pending", "StateReason": "CodeGuru Reviewer has received the request, and a code review is scheduled.", "CreatedTimeStamp": 1618873489.195, "LastUpdatedTimeStamp": 1618873489.195, "Type": "RepositoryAnalysis", "SourceCodeType": { "RepositoryHead": { "BranchName": "mainline" } }, "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } } ``` Para obter mais informações, consulte [Criar revisões de código no Amazon CodeGuru Reviewer](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-code-reviews.html) no *Guia do usuário do Amazon CodeGuru Reviewer*. + Para ver detalhes da API, consulte [CreateCodeReview](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/create-code-review.html) na *Referência de comandos da AWS CLI*. ### `describe-code-review` O código de exemplo a seguir mostra como usar `describe-code-review`. **AWS CLI** **Para listar detalhes sobre uma revisão de código.** O `describe-code-review` a seguir lista informações sobre uma revisão de código na ramificação “mainline” de um repositório do AWS CodeCommit chamado “my-repo-name”. ``` aws codeguru-reviewer put-recommendation-feedback \ --code-review-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:code-review:RepositoryAnalysis-my-repository-name-branch-abcdefgh12345678 \ --recommendation-id 3be1b2e5d7ef6e298a06499379ee290c9c596cf688fdcadb08285ddb0dd390eb \ --reactions ThumbsUp ``` Output ``` { "CodeReview": { "Name": "My-ecs-beta-repo-master-xs6di4kfd4j269dz", "CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222:code-review:RepositoryAnalysis-my-repo-name", "RepositoryName": "My-ecs-beta-repo", "Owner": "123456789012", "ProviderType": "CodeCommit", "State": "Pending", "StateReason": "CodeGuru Reviewer is reviewing the source code.", "CreatedTimeStamp": 1618874226.226, "LastUpdatedTimeStamp": 1618874233.689, "Type": "RepositoryAnalysis", "SourceCodeType": { "RepositoryHead": { "BranchName": "mainline" } }, "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } } ``` Para obter mais informações, consulte [Visualizar detalhes da revisão de código revisões de código](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/view-code-review-details.html) no *Guia do usuário do Amazon CodeGuru Reviewer*. + Para ver detalhes da API, consulte [DescribeCodeReview](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/describe-code-review.html) na *Referência de comandos da AWS CLI*. ### `describe-recommendation-feedback` O código de exemplo a seguir mostra como usar `describe-recommendation-feedback`. **AWS CLI** **Como ver informações sobre feedback de uma recomendação** O `describe-recommendation-feedback` a seguir exibe informações sobre comentários em uma recomendação. Essa recomendação tem uma reação `ThumbsUp`. ``` aws codeguru-reviewer describe-recommendation-feedback \ --code-review-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:code-review:RepositoryAnalysis-my-repository-name-branch-abcdefgh12345678 \ --recommendation-id 3be1b2e5d7ef6e298a06499379ee290c9c596cf688fdcadb08285ddb0dd390eb ``` Resultado: ``` { "RecommendationFeedback": { "CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:code-review:RepositoryAnalysis-my-repository-name-branch-abcdefgh12345678", "RecommendationId": "3be1b2e5d7ef6e298a06499379ee290c9c596cf688fdcadb08285ddb0dd390eb", "Reactions": [ "ThumbsUp" ], "UserId": "aws-user-id", "CreatedTimeStamp": 1618877070.313, "LastUpdatedTimeStamp": 1618877948.881 } } ``` Para obter mais informações, consulte [Visualizar recomendações e fornecer feedback](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/give-feedback-from-code-review-details.html) e [Etapa 4: fornecer feedback](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/provide-feedback.html) no *Guia do usuário do Amazon CodeGuru Reviewer*. + Para ver detalhes da API, consulte [DescribeRecommendationFeedback](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/describe-recommendation-feedback.html) na *Referência de comandos da AWS CLI*. ### `describe-repository-association` O código de exemplo a seguir mostra como usar `describe-repository-association`. **AWS CLI** **Exemplo 1: retornar informações sobre uma associação de repositório do GitHub** O exemplo `describe-repository-association` a seguir retorna informações sobre uma associação de repositório que usa um repositório do GitHub Enterprise e está no estado `Associated`. ``` aws codeguru-reviewer describe-repository-association \ --association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "RepositoryAssociation": { "AssociationId": "b822717e-0711-4e8a-bada-0e738289c75e", "Name": "mySampleRepo", "LastUpdatedTimeStamp": 1588102637.649, "ProviderType": "GitHub", "CreatedTimeStamp": 1588102615.636, "Owner": "sample-owner", "State": "Associated", "StateReason": "Pull Request Notification configuration successful", "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } } ``` Para obter mais informações, consulte [Criar uma associação de repositório do GitHub Enterprise Server](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-github-enterprise-association.html) no *Guia do usuário do Amazon CodeGuru Reviewer*. **Exemplo 2: retornar informações sobre uma associação de repositório com falha** O exemplo `describe-repository-association` a seguir retorna informações sobre uma associação de repositório que usa um repositório do GitHub Enterprise e está no estado `Failed`. ``` aws codeguru-reviewer describe-repository-association \ --association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "RepositoryAssociation": { "ProviderType": "GitHubEnterpriseServer", "Name": "mySampleRepo", "LastUpdatedTimeStamp": 1596217036.892, "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "CreatedTimeStamp": 1596216896.979, "ConnectionArn": "arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "State": "Failed", "StateReason": "Failed, Please retry.", "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "Owner": "sample-owner" } } ``` Para obter mais informações, consulte [Criar uma associação de repositório do GitHub Enterprise Server](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-github-enterprise-association.html) no *Guia do usuário do Amazon CodeGuru Reviewer*. **Exemplo 3: retornar informações sobre uma associação de repositório desassociada** O exemplo `describe-repository-association` a seguir retorna informações sobre uma associação de repositório que usa um repositório do GitHub Enterprise e está no estado `Disassociating`. ``` aws codeguru-reviewer describe-repository-association \ --association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "RepositoryAssociation": { "ProviderType": "GitHubEnterpriseServer", "Name": "mySampleRepo", "LastUpdatedTimeStamp": 1596217036.892, "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "CreatedTimeStamp": 1596216896.979, "ConnectionArn": "arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "State": "Disassociating", "StateReason": "Source code access removal in progress", "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "Owner": "sample-owner" } } ``` Para obter mais informações, consulte [Criar uma associação de repositório do GitHub Enterprise Server](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-github-enterprise-association.html) no *Guia do usuário do Amazon CodeGuru Reviewer*. + Para ver detalhes da API, consulte [DescribeRepositoryAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/describe-repository-association.html) na *Referência de comandos da AWS CLI*. ### `disassociate-repository` O código de exemplo a seguir mostra como usar `disassociate-repository`. **AWS CLI** **Como desassociar uma associação de repositório** O `disassociate-repository` a seguir dissocia uma associação de repositório que está usando um repositório do AWS CodeCommit. ``` aws codeguru-reviewer disassociate-repository \ --association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "RepositoryAssociation": { "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "Name": "my-repository", "Owner": "123456789012", "ProviderType": "CodeCommit", "State": "Disassociating", "LastUpdatedTimeStamp": 1618939174.759, "CreatedTimeStamp": 1595636947.096 }, "Tags": { "Status": "Secret", "Team": "Saanvi" } } ``` Para obter mais informações, consulte [Dissociar um repositório ao CodeGuru Reviewer](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/disassociate-repository-association.html) no *Guia do usuário do Amazon CodeGuru Reviewer*. + Para ver detalhes da API, consulte [DisassociateRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/disassociate-repository.html) na *Referência de comandos da AWS CLI*. ### `list-code-reviews` O código de exemplo a seguir mostra como usar `list-code-reviews`. **AWS CLI** **Para listar as avaliações de código criadas em sua conta da AWS nos últimos 90 dias.** O exemplo `list-code-reviews` a seguir lista as análises de código criadas nos últimos 90 dias usando solicitações pull. ``` aws codeguru-reviewer list-code-reviews \ --type PullRequest ``` Resultado: ``` { "CodeReviewSummaries": [ { "LastUpdatedTimeStamp": 1588897288.054, "Name": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "ProviderType": "GitHub", "PullRequestId": "5", "MetricsSummary": { "MeteredLinesOfCodeCount": 24, "FindingsCount": 1 }, "CreatedTimeStamp": 1588897068.512, "State": "Completed", "CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "Owner": "sample-owner", "RepositoryName": "sample-repository-name", "Type": "PullRequest" }, { "LastUpdatedTimeStamp": 1588869793.263, "Name": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "ProviderType": "GitHub", "PullRequestId": "4", "MetricsSummary": { "MeteredLinesOfCodeCount": 29, "FindingsCount": 0 }, "CreatedTimeStamp": 1588869575.949, "State": "Completed", "CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "Owner": "sample-owner", "RepositoryName": "sample-repository-name", "Type": "PullRequest" }, { "LastUpdatedTimeStamp": 1588870511.211, "Name": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "ProviderType": "GitHub", "PullRequestId": "4", "MetricsSummary": { "MeteredLinesOfCodeCount": 2, "FindingsCount": 0 }, "CreatedTimeStamp": 1588870292.425, "State": "Completed", "CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "Owner": "sample-owner", "RepositoryName": "sample-repository-name", "Type": "PullRequest" }, { "LastUpdatedTimeStamp": 1588118522.452, "Name": "a1b2c3d4-5678-90ab-cdef-EXAMPLE44444", "ProviderType": "GitHub", "PullRequestId": "3", "MetricsSummary": { "MeteredLinesOfCodeCount": 29, "FindingsCount": 0 }, "CreatedTimeStamp": 1588118301.131, "State": "Completed", "CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE44444", "Owner": "sample-owner", "RepositoryName": "sample-repository-name", "Type": "PullRequest" }, { "LastUpdatedTimeStamp": 1588112205.207, "Name": "a1b2c3d4-5678-90ab-cdef-EXAMPLE55555", "ProviderType": "GitHub", "PullRequestId": "2", "MetricsSummary": { "MeteredLinesOfCodeCount": 25, "FindingsCount": 0 }, "CreatedTimeStamp": 1588111987.443, "State": "Completed", "CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE55555", "Owner": "sample-owner", "RepositoryName": "sample-repository-name", "Type": "PullRequest" }, { "LastUpdatedTimeStamp": 1588104489.981, "Name": "a1b2c3d4-5678-90ab-cdef-EXAMPLE66666", "ProviderType": "GitHub", "PullRequestId": "1", "MetricsSummary": { "MeteredLinesOfCodeCount": 25, "FindingsCount": 0 }, "CreatedTimeStamp": 1588104270.223, "State": "Completed", "CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE66666", "Owner": "sample-owner", "RepositoryName": "sample-repository-name", "Type": "PullRequest" } ] } ``` Para obter mais informações, consulte [Visualizar todas as revisões de código](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/view-all-code-reviews.html) no *Guia do usuário do Amazon CodeGuru Reviewer*. + Para ver detalhes da API, consulte [ListCodeReviews](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/list-code-reviews.html) na *Referência de comandos da AWS CLI*. ### `list-recommendation-feedback` O código de exemplo a seguir mostra como usar `list-recommendation-feedback`. **AWS CLI** **Para listar o feedback de recomendação do cliente para uma recomendação em um repositório associado** O `list-recommendation-feedback` a seguir lista os comentários dos clientes sobre todas as recomendações sobre uma revisão de código. Essa revisão de código tem um feedback, um “ThumbsUp”, de um cliente. ``` aws codeguru-reviewer list-recommendation-feedback \ --code-review-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:code-review:RepositoryAnalysis-my-repository-name-branch-abcdefgh12345678 ``` Resultado: ``` { "RecommendationFeedbackSummaries": [ { "RecommendationId": "3be1b2e5d7ef6e298a06499379ee290c9c596cf688fdcadb08285ddb0dd390eb", "Reactions": [ "ThumbsUp" ], "UserId": "aws-user-id" } ] } ``` Para obter mais informações, consulte [Etapa 4: fornecer feedback](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/provide-feedback.html) no *Guia do usuário do Amazon CodeGuru Reviewer*. + Para ver detalhes da API, consulte [ListRecommendationFeedback](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/list-recommendation-feedback.html) na *Referência de comandos da AWS CLI*. ### `list-recommendations` O código de exemplo a seguir mostra como usar `list-recommendations`. **AWS CLI** **Para listar as recomendações para uma revisão de código completa** O exemplo `list-recommendations` a seguir lista as recomendações para uma análise de código completa. Essa revisão de código tem uma recomendação. ``` aws codeguru-reviewer list-recommendations \ --code-review-arn arn:aws:codeguru-reviewer:us-west-2:544120495673:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "RecommendationSummaries": [ { "Description": "\n\n**Problem** \n You are using a `ConcurrentHashMap`, but your usage of `containsKey()` and `get()` may not be thread-safe at lines: **63 and 64**. In between the check and the `get()` another thread can remove the key and the `get()` will return `null`. The remove that can remove the key is at line: **59**.\n\n**Fix** \n Consider calling `get()`, checking instead of your current check if the returned object is `null`, and then using that object only, without calling `get()` again.\n\n**More info** \n [View an example on GitHub](https://github.com/apache/hadoop/blob/f16cf877e565084c66bc63605659b157c4394dc8/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/s3guard/S3Guard.java#L302-L304) (external link).", "RecommendationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "StartLine": 63, "EndLine": 64, "FilePath": "src/main/java/com/company/sample/application/CreateOrderThread.java" } ] } ``` Para obter mais informações, consulte [Etapa 4: fornecer feedback](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/provide-feedback.html) no *Guia do usuário do Amazon CodeGuru Reviewer*. + Para ver detalhes da API, consulte [ListRecommendations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/list-recommendations.html) na *Referência de comandos da AWS CLI*. ### `list-repository-associations` O código de exemplo a seguir mostra como usar `list-repository-associations`. **AWS CLI** **Para listar as associações de repositórios em sua conta da AWS** O exemplo `list-repository-associations` a seguir retorna uma lista de objetos de resumo de associação de repositório em sua conta. Você pode filtrar a lista retornada por `ProviderType`, `Name`, `State` e `Owner`. ``` aws codeguru-reviewer list-repository-associations ``` Resultado: ``` { "RepositoryAssociationSummaries": [ { "LastUpdatedTimeStamp": 1595886609.616, "Name": "test", "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "Owner": "sample-owner", "State": "Associated", "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "ProviderType": "Bitbucket" }, { "LastUpdatedTimeStamp": 1595636969.035, "Name": "CodeDeploy-CodePipeline-ECS-Tutorial", "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "Owner": "123456789012", "State": "Associated", "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "ProviderType": "CodeCommit" }, { "LastUpdatedTimeStamp": 1595634785.983, "Name": "My-ecs-beta-repo", "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "Owner": "123456789012", "State": "Associated", "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "ProviderType": "CodeCommit" }, { "LastUpdatedTimeStamp": 1590712811.77, "Name": "MyTestCodeCommit", "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE44444", "Owner": "123456789012", "State": "Associated", "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE44444", "ProviderType": "CodeCommit" }, { "LastUpdatedTimeStamp": 1588102637.649, "Name": "aws-codeguru-profiler-sample-application", "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE55555", "Owner": "sample-owner", "State": "Associated", "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE55555", "ProviderType": "GitHub" }, { "LastUpdatedTimeStamp": 1588028233.995, "Name": "codeguru-profiler-demo-app", "AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE66666", "Owner": "sample-owner", "State": "Associated", "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE66666", "ProviderType": "GitHub" } ] } ``` Para obter mais informações, consulte [Visualizar todas as associações de repositório no CodeGuru Reviewer](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/repository-association-view-all.html) no *Guia do usuário do Amazon CodeGuru Reviewer*. + Para ver detalhes da API, consulte [ListRepositoryAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/list-repository-associations.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar as tags em um repositório associado** O `list-tags-for-resource` a seguir lista as tags em um repositório associado. Esse repositório associado tem duas tags. ``` aws codeguru-reviewer list-tags-for-resource \ --resource-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "Tags": { "Status": "Secret", "Team": "Saanvi" } } ``` Para obter mais informações, consulte [Visualizar tags para um repositório associado ao CodeGuru Reviewer (AWS CLI)](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/how-to-tag-associated-repository-view-cli.html) no *Guia do usuário do Amazon CodeGuru Reviewer*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `put-recommendation-feedback` O código de exemplo a seguir mostra como usar `put-recommendation-feedback`. **AWS CLI** **Para adicionar uma recomendação a uma revisão de código** O `put-recommendation-feedback` a seguir apresenta uma recomendação `ThumbsUp` em uma revisão de código. ``` aws codeguru-reviewer put-recommendation-feedback \ --code-review-arn \arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:code-review:RepositoryAnalysis-my-repository-name-branch-abcdefgh12345678 \ --recommendation-id 3be1b2e5d7ef6e298a06499379ee290c9c596cf688fdcadb08285ddb0dd390eb \ --reactions ThumbsUp ``` Este comando não produz saída. Para obter mais informações, consulte [Etapa 4: fornecer feedback](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/provide-feedback.html) no *Guia do usuário do Amazon CodeGuru Reviewer*. + Para ver detalhes da API, consulte [PutRecommendationFeedback](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/put-recommendation-feedback.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Para adicionar uma tag a um repositório associado** O `tag-resource` seguinte adiciona duas tags a um repositório associado ``` aws codeguru-reviewer tag-resource \ --resource-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --tags Status=Secret,Team=Saanvi ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar uma tag a um repositório associado ao CodeGuru Reviewer (AWS CLI](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/how-to-tag-associated-repository-add-cli.html)) e [Adicionar ou atualizar tags para um repositório associado ao CodeGuru Reviewer (AWS CLI)](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/how-to-tag-associated-repository-update-cli.html) no *Guia do usuário do Amazon CodeGuru Reviewer*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Como desmarcar um repositório associado** O `untag-resource` seguinte remove duas tags com as chaves “Secret” e “Team” de um repositório associado. ``` aws codeguru-reviewer untag-resource \ --resource-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --tag-keys Status Team ``` Este comando não produz saída. Para obter mais informações, consulte [Remover tags de um repositório associado ao CodeGuru Reviewer (AWS CLI)](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/how-to-tag-associated-repository-remove-cli.html) no *Guia do usuário do Amazon CodeGuru Reviewer*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/untag-resource.html) na *Referência de comandos da AWS CLI*. # Exemplos do CodePipeline usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o 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 ### `acknowledge-job` O código de exemplo a seguir mostra como usar `acknowledge-job`. **AWS CLI** **Para recuperar informações sobre um trabalho** Este exemplo retorna informações sobre um trabalho especificado, incluindo o status desse trabalho, se ele existir. Isso é usado somente para trabalhadores e ações personalizadas. Para determinar o valor de nonce e o ID do trabalho, use o poll-for-jobs do aws codepipeline. Comando: ``` aws codepipeline acknowledge-job --job-id f4f4ff82-2d11-EXAMPLE --nonce 3 ``` Resultado: ``` { "status": "InProgress" } ``` + Para ver detalhes da API, consulte [AcknowledgeJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/acknowledge-job.html) na *Referência de comandos da AWS CLI*. ### `create-custom-action-type` O código de exemplo a seguir mostra como usar `create-custom-action-type`. **AWS CLI** **Para criar uma ação personalizada** Este exemplo cria uma ação personalizada para o AWS CodePipeline usando um arquivo JSON já criado (aqui chamado MyCustomAction.json) que contém a estrutura da ação personalizada. Para obter mais informações sobre os requisitos para criar uma ação personalizada, incluindo a estrutura do arquivo, consulte o Guia do usuário do AWS CodePipeline. ``` aws codepipeline create-custom-action-type --cli-input-json file://MyCustomAction.json ``` Conteúdo do arquivo JSON `MyCustomAction.json`: ``` { "category": "Build", "provider": "MyJenkinsProviderName", "version": "1", "settings": { "entityUrlTemplate": "https://192.0.2.4/job/{Config:ProjectName}/", "executionUrlTemplate": "https://192.0.2.4/job/{Config:ProjectName}/lastSuccessfulBuild/{ExternalExecutionId}/" }, "configurationProperties": [ { "name": "MyJenkinsExampleBuildProject", "required": true, "key": true, "secret": false, "queryable": false, "description": "The name of the build project must be provided when this action is added to the pipeline.", "type": "String" } ], "inputArtifactDetails": { "maximumCount": 1, "minimumCount": 0 }, "outputArtifactDetails": { "maximumCount": 1, "minimumCount": 0 } } ``` Este comando retorna a estrutura da ação personalizada. + Para ver detalhes da API, consulte [CreateCustomActionType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/create-custom-action-type.html) na *Referência de comandos da AWS CLI*. ### `create-pipeline` O código de exemplo a seguir mostra como usar `create-pipeline`. **AWS CLI** **Para criar um pipeline** Este exemplo cria um pipeline no AWS CodePipeline usando um arquivo JSON já criado (aqui chamado MySecondPipeline.json) que contém a estrutura do pipeline. Para obter mais informações sobre os requisitos para criar um pipeline, incluindo a estrutura do arquivo, consulte o Guia do usuário do AWS CodePipeline. Comando: ``` aws codepipeline create-pipeline --cli-input-json file://MySecondPipeline.json ``` Conteúdo de amostra do arquivo JSON: ``` { "pipeline": { "roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service", "stages": [ { "name": "Source", "actions": [ { "inputArtifacts": [], "name": "Source", "actionTypeId": { "category": "Source", "owner": "AWS", "version": "1", "provider": "S3" }, "outputArtifacts": [ { "name": "MyApp" } ], "configuration": { "S3Bucket": "awscodepipeline-demo-bucket", "S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip" }, "runOrder": 1 } ] }, { "name": "Beta", "actions": [ { "inputArtifacts": [ { "name": "MyApp" } ], "name": "CodePipelineDemoFleet", "actionTypeId": { "category": "Deploy", "owner": "AWS", "version": "1", "provider": "CodeDeploy" }, "outputArtifacts": [], "configuration": { "ApplicationName": "CodePipelineDemoApplication", "DeploymentGroupName": "CodePipelineDemoFleet" }, "runOrder": 1 } ] } ], "artifactStore": { "type": "S3", "location": "codepipeline-us-east-1-11EXAMPLE11" }, "name": "MySecondPipeline", "version": 1 } } ``` Resultado: ``` This command returns the structure of the pipeline. ``` + Para ver detalhes da API, consulte [CreatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/create-pipeline.html) na *Referência de comandos da AWS CLI*. ### `delete-custom-action-type` O código de exemplo a seguir mostra como usar `delete-custom-action-type`. **AWS CLI** **Para excluir uma ação personalizada** Este exemplo exclui uma ação personalizada no AWS CodePipeline usando um arquivo JSON já criado (aqui chamado DeleteMyCustomAction.json) que contém o tipo de ação, o nome do provedor e o número da versão da ação a ser excluída. Use o comando list-action-types para visualizar os valores corretos para categoria, versão e provedor. Comando: ``` aws codepipeline delete-custom-action-type --cli-input-json file://DeleteMyCustomAction.json ``` Conteúdo de amostra do arquivo JSON: ``` { "category": "Build", "version": "1", "provider": "MyJenkinsProviderName" } ``` Resultado: ``` None. ``` + Para ver detalhes da API, consulte [DeleteCustomActionType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/delete-custom-action-type.html) na *Referência de comandos da AWS CLI*. ### `delete-pipeline` O código de exemplo a seguir mostra como usar `delete-pipeline`. **AWS CLI** **Para excluir um pipeline** Este exemplo exclui um pipeline chamado MySecondPipeline do AWS CodePipeline. Use o comando list-pipelines para visualizar uma lista de pipelines associados à sua conta da AWS. Comando: ``` aws codepipeline delete-pipeline --name MySecondPipeline ``` Resultado: ``` None. ``` + Para ver detalhes da API, consulte [DeletePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/delete-pipeline.html) na *Referência de comandos da AWS CLI*. ### `delete-webhook` O código de exemplo a seguir mostra como usar `delete-webhook`. **AWS CLI** **Para excluir um webhook** O exemplo `delete-webhook` a seguir exclui um webhook para uma ação de origem do GitHub versão 1. É necessário usar o comando `deregister-webhook-with-third-party` para cancelar o registro do webhook antes de excluí-lo. ``` aws codepipeline delete-webhook \ --name my-webhook ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir o webhook da sua origem do GitHub](https://docs.aws.amazon.com/codepipeline/latest/userguide/appendix-github-oauth.html#pipelines-webhooks-delete) no *Guia do usuário do AWS CodePipeline*. + Para ver detalhes da API, consulte [DeleteWebhook](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/delete-webhook.html) na *Referência de comandos da AWS CLI*. ### `deregister-webhook-with-third-party` O código de exemplo a seguir mostra como usar `deregister-webhook-with-third-party`. **AWS CLI** **Como cancelar o registro de um webhook** O exemplo `deregister-webhook-with-third-party` a seguir exclui um webhook para uma ação de origem do GitHub versão 1. É necessário cancelar o registro do webhook antes de excluí-lo. ``` aws codepipeline deregister-webhook-with-third-party \ --webhook-name my-webhook ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir o webhook da sua origem do GitHub](https://docs.aws.amazon.com/codepipeline/latest/userguide/appendix-github-oauth.html#pipelines-webhooks-delete) no *Guia do usuário do AWS CodePipeline*. + Para ver detalhes da API, consulte [DeregisterWebhookWithThirdParty](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/deregister-webhook-with-third-party.html) na *Referência de comandos da AWS CLI*. ### `disable-stage-transition` O código de exemplo a seguir mostra como usar `disable-stage-transition`. **AWS CLI** **Como desativar uma transição para um estágio em um pipeline** Este exemplo desabilita as transições para o estágio Beta do pipeline MyFirstPipeline no AWS CodePipeline. Comando: ``` aws codepipeline disable-stage-transition --pipeline-name MyFirstPipeline --stage-name Beta --transition-type Inbound ``` Resultado: ``` None. ``` + Para ver detalhes da API, consulte [DisableStageTransition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/disable-stage-transition.html) na *Referência de comandos da AWS CLI*. ### `enable-stage-transition` O código de exemplo a seguir mostra como usar `enable-stage-transition`. **AWS CLI** **Como permitir a transição para um estágio em um pipeline** Este exemplo habilita as transições para o estágio Beta do pipeline MyFirstPipeline no AWS CodePipeline. Comando: ``` aws codepipeline enable-stage-transition --pipeline-name MyFirstPipeline --stage-name Beta --transition-type Inbound ``` Resultado: ``` None. ``` + Para ver detalhes da API, consulte [EnableStageTransition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/enable-stage-transition.html) na *Referência de comandos da AWS CLI*. ### `get-job-details` O código de exemplo a seguir mostra como usar `get-job-details`. **AWS CLI** **Para obter detalhes de um trabalho** Este exemplo retorna detalhes sobre um trabalho cujo ID é representado por f4f4ff82-2d11-EXAMPLE. Esse comando é usado somente para ações personalizadas. Quando esse comando é chamado, o AWS CodePipeline retorna credenciais temporárias para o bucket do Amazon S3 usado para armazenar artefatos para o pipeline, se necessário para a ação personalizada. Esse comando também retornará quaisquer valores secretos definidos para a ação, se houver algum definido. Comando: ``` aws codepipeline get-job-details --job-id f4f4ff82-2d11-EXAMPLE ``` Resultado: ``` { "jobDetails": { "accountId": "111111111111", "data": { "actionConfiguration": { "__type": "ActionConfiguration", "configuration": { "ProjectName": "MyJenkinsExampleTestProject" } }, "actionTypeId": { "__type": "ActionTypeId", "category": "Test", "owner": "Custom", "provider": "MyJenkinsProviderName", "version": "1" }, "artifactCredentials": { "__type": "AWSSessionCredentials", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "sessionToken": "fICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcNMTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9TrDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpEIbb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0FkbFFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTbNYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=" }, "inputArtifacts": [ { "__type": "Artifact", "location": { "s3Location": { "bucketName": "codepipeline-us-east-1-11EXAMPLE11", "objectKey": "MySecondPipeline/MyAppBuild/EXAMPLE" }, "type": "S3" }, "name": "MyAppBuild" } ], "outputArtifacts": [], "pipelineContext": { "__type": "PipelineContext", "action": { "name": "MyJenkinsTest-Action" }, "pipelineName": "MySecondPipeline", "stage": { "name": "Testing" } } }, "id": "f4f4ff82-2d11-EXAMPLE" } } ``` + Para ver detalhes da API, consulte [GetJobDetails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/get-job-details.html) na *Referência de comandos da AWS CLI*. ### `get-pipeline-state` O código de exemplo a seguir mostra como usar `get-pipeline-state`. **AWS CLI** **Para obter informações sobre o estado de um pipeline** Esse exemplo retorna o estado mais recente de um pipeline chamado MyFirstPipeline. Comando: ``` aws codepipeline get-pipeline-state --name MyFirstPipeline ``` Resultado: ``` { "created": 1446137312.204, "pipelineName": "MyFirstPipeline", "pipelineVersion": 1, "stageStates": [ { "actionStates": [ { "actionName": "Source", "entityUrl": "https://console.aws.amazon.com/s3/home?#", "latestExecution": { "lastStatusChange": 1446137358.328, "status": "Succeeded" } } ], "stageName": "Source" }, { "actionStates": [ { "actionName": "CodePipelineDemoFleet", "entityUrl": "https://console.aws.amazon.com/codedeploy/home?#/applications/CodePipelineDemoApplication/deployment-groups/CodePipelineDemoFleet", "latestExecution": { "externalExecutionId": "d-EXAMPLE", "externalExecutionUrl": "https://console.aws.amazon.com/codedeploy/home?#/deployments/d-EXAMPLE", "lastStatusChange": 1446137493.131, "status": "Succeeded", "summary": "Deployment Succeeded" } } ], "inboundTransitionState": { "enabled": true }, "stageName": "Beta" } ], "updated": 1446137312.204 } ``` + Para ver detalhes da API, consulte [GetPipelineState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/get-pipeline-state.html) na *Referência de comandos da AWS CLI*. ### `get-pipeline` O código de exemplo a seguir mostra como usar `get-pipeline`. **AWS CLI** **Como visualizar a estrutura de um pipeline** Este exemplo retorna a estrutura de um pipeline chamado MyFirstPipeline. Comando: ``` aws codepipeline get-pipeline --name MyFirstPipeline ``` Resultado: ``` { "pipeline": { "roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service", "stages": [ { "name": "Source", "actions": [ { "inputArtifacts": [], "name": "Source", "actionTypeId": { "category": "Source", "owner": "AWS", "version": "1", "provider": "S3" }, "outputArtifacts": [ { "name": "MyApp" } ], "configuration": { "S3Bucket": "awscodepipeline-demo-bucket", "S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip" }, "runOrder": 1 } ] }, { "name": "Beta", "actions": [ { "inputArtifacts": [ { "name": "MyApp" } ], "name": "CodePipelineDemoFleet", "actionTypeId": { "category": "Deploy", "owner": "AWS", "version": "1", "provider": "CodeDeploy" }, "outputArtifacts": [], "configuration": { "ApplicationName": "CodePipelineDemoApplication", "DeploymentGroupName": "CodePipelineDemoFleet" }, "runOrder": 1 } ] } ], "artifactStore": { "type": "S3", "location": "codepipeline-us-east-1-11EXAMPLE11" }, "name": "MyFirstPipeline", "version": 1 } } ``` + Para ver detalhes da API, consulte [GetPipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/get-pipeline.html) na *Referência de comandos da AWS CLI*. ### `list-action-executions` O código de exemplo a seguir mostra como usar `list-action-executions`. **AWS CLI** **Para listar as execuções de ações** O exemplo `list-action-executions` a seguir visualiza a ação para um pipeline, como o ID de execução da ação, os artefatos de entrada, os artefatos de saída, o resultado da execução e o status. ``` aws codepipeline list-action-executions \ --pipeline-name myPipeline ``` Resultado: ``` { "actionExecutionDetails": [ { "pipelineExecutionId": "EXAMPLE0-adfc-488e-bf4c-1111111720d3", "actionExecutionId": "EXAMPLE4-2ee8-4853-bd6a-111111158148", "pipelineVersion": 12, "stageName": "Deploy", "actionName": "Deploy", "startTime": 1598572628.6, "lastUpdateTime": 1598572661.255, "status": "Succeeded", "input": { "actionTypeId": { "category": "Deploy", "owner": "AWS", "provider": "CodeDeploy", "version": "1" }, "configuration": { "ApplicationName": "my-application", "DeploymentGroupName": "my-deployment-group" }, "resolvedConfiguration": { "ApplicationName": "my-application", "DeploymentGroupName": "my-deployment-group" }, "region": "us-east-1", "inputArtifacts": [ { "name": "SourceArtifact", "s3location": { "bucket": "artifact-bucket", "key": "myPipeline/SourceArti/key" } } ], "namespace": "DeployVariables" }, "output": { "outputArtifacts": [], "executionResult": { "externalExecutionId": "d-EXAMPLEE5", "externalExecutionSummary": "Deployment Succeeded", "externalExecutionUrl": "https://myaddress.com" }, "outputVariables": {} } }, { "pipelineExecutionId": "EXAMPLE0-adfc-488e-bf4c-1111111720d3", "actionExecutionId": "EXAMPLE5-abb4-4192-9031-11111113a7b0", "pipelineVersion": 12, "stageName": "Source", "actionName": "Source", "startTime": 1598572624.387, "lastUpdateTime": 1598572628.16, "status": "Succeeded", "input": { "actionTypeId": { "category": "Source", "owner": "AWS", "provider": "CodeCommit", "version": "1" }, "configuration": { "BranchName": "production", "PollForSourceChanges": "false", "RepositoryName": "my-repo" }, "resolvedConfiguration": { "BranchName": "production", "PollForSourceChanges": "false", "RepositoryName": "my-repo" }, "region": "us-east-1", "inputArtifacts": [], "namespace": "SourceVariables" }, "output": { "outputArtifacts": [ { "name": "SourceArtifact", "s3location": { "bucket": "amzn-s3-demo-bucket", "key": "myPipeline/SourceArti/key" } } ], "executionResult": { "externalExecutionId": "1111111ad99dcd35914c00b7fbea13995EXAMPLE", "externalExecutionSummary": "Edited template.yml", "externalExecutionUrl": "https://myaddress.com" }, "outputVariables": { "AuthorDate": "2020-05-08T17:45:43Z", "BranchName": "production", "CommitId": "EXAMPLEad99dcd35914c00b7fbea139951111111", "CommitMessage": "Edited template.yml", "CommitterDate": "2020-05-08T17:45:43Z", "RepositoryName": "my-repo" } } }, . . . . ``` Para obter mais informações, consulte [Visualizar execuções de ações (CLI)](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-view-cli.html#pipelines-action-executions-cli) no *Guia do usuário do AWS CodePipeline*. + Para ver detalhes da API, consulte [ListActionExecutions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-action-executions.html) na *Referência de comandos da AWS CLI*. ### `list-action-types` O código de exemplo a seguir mostra como usar `list-action-types`. **AWS CLI** **Como ver os tipos de ação disponíveis** Se usado sozinho, o comando list-action-types retorna a estrutura de todas as ações disponíveis para sua conta da AWS. Este exemplo usa a opção --action-owner-filter para retornar somente ações personalizadas. Comando: ``` aws codepipeline list-action-types --action-owner-filter Custom ``` Resultado: ``` { "actionTypes": [ { "inputArtifactDetails": { "maximumCount": 5, "minimumCount": 0 }, "actionConfigurationProperties": [ { "secret": false, "required": true, "name": "MyJenkinsExampleBuildProject", "key": true, "queryable": true } ], "outputArtifactDetails": { "maximumCount": 5, "minimumCount": 0 }, "id": { "category": "Build", "owner": "Custom", "version": "1", "provider": "MyJenkinsProviderName" }, "settings": { "entityUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}", "executionUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}/{ExternalExecutionId}" } }, { "inputArtifactDetails": { "maximumCount": 5, "minimumCount": 0 }, "actionConfigurationProperties": [ { "secret": false, "required": true, "name": "MyJenkinsExampleTestProject", "key": true, "queryable": true } ], "outputArtifactDetails": { "maximumCount": 5, "minimumCount": 0 }, "id": { "category": "Test", "owner": "Custom", "version": "1", "provider": "MyJenkinsProviderName" }, "settings": { "entityUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}", "executionUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}/{ExternalExecutionId}" } } ] } ``` + Para ver detalhes da API, consulte [ListActionTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-action-types.html) na *Referência de comandos da AWS CLI*. ### `list-pipeline-executions` O código de exemplo a seguir mostra como usar `list-pipeline-executions`. **AWS CLI** **Como visualizar o histórico de execução do pipeline** O exemplo `list-pipeline-executions` a seguir mostra o histórico de execução de um pipeline em sua conta da AWS. ``` aws codepipeline list-pipeline-executions \ --pipeline-name MyPipeline ``` Resultado: ``` { "pipelineExecutionSummaries": [ { "lastUpdateTime": 1496380678.648, "pipelineExecutionId": "7cf7f7cb-3137-539g-j458-d7eu3EXAMPLE", "startTime": 1496380258.243, "status": "Succeeded" }, { "lastUpdateTime": 1496591045.634, "pipelineExecutionId": "3137f7cb-8d494hj4-039j-d84l-d7eu3EXAMPLE", "startTime": 1496590401.222, "status": "Succeeded" }, { "lastUpdateTime": 1496946071.6456, "pipelineExecutionId": "4992f7jf-7cf7-913k-k334-d7eu3EXAMPLE", "startTime": 1496945471.5645, "status": "Succeeded" } ] } ``` Para obter mais informações, consulte [Visualizar histórico de execuções](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-view-cli.html#pipelines-executions-cli) no *Guia do usuário do AWS CodePipeline*. + Para ver detalhes da API, consulte [ListPipelineExecutions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-pipeline-executions.html) na *Referência de comandos da AWS CLI*. ### `list-pipelines` O código de exemplo a seguir mostra como usar `list-pipelines`. **AWS CLI** **Como visualizar uma lista de pipelines** Este exemplo lista todos os pipelines do AWS CodePipeline associados à conta do usuário da AWS. Comando: ``` aws codepipeline list-pipelines ``` Resultado: ``` { "pipelines": [ { "updated": 1439504274.641, "version": 1, "name": "MyFirstPipeline", "created": 1439504274.641 }, { "updated": 1436461837.992, "version": 2, "name": "MySecondPipeline", "created": 1436460801.381 } ] } ``` + Para ver detalhes da API, consulte [ListPipelines](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-pipelines.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar tags** O exemplo `list-tags-for-resource` a seguir recupera uma lista de todas as tags anexadas ao recurso do pipeline especificado. ``` aws codepipeline list-tags-for-resource \ --resource-arn arn:aws:codepipeline:us-east-1:123456789012:MyPipeline ``` Resultado: ``` { "tags": { "Project": "ProjectA", "IscontainerBased": "true" } } ``` Para obter mais informações, consulte [Visualizar tags de um pipeline (CLI)](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-tag.html#pipelines-tag-list-cli) no *Guia do usuário do AWS CodePipeline*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `list-webhooks` O código de exemplo a seguir mostra como usar `list-webhooks`. **AWS CLI** **Para listar webhooks** O exemplo `list-webhooks` a seguir recupera uma lista de todas as tags anexadas ao recurso do pipeline especificado. ``` aws codepipeline list-webhooks \ --endpoint-url "https://codepipeline.eu-central-1.amazonaws.com" \ --region "eu-central-1" ``` Resultado: ``` { "webhooks": [ { "url": "https://webhooks.domain.com/trigger111111111EXAMPLE11111111111111111": { "authenticationConfiguration": { "SecretToken": "Secret" }, "name": "my-webhook", "authentication": "GITHUB_HMAC", "targetPipeline": "my-Pipeline", "targetAction": "Source", "filters": [ { "jsonPath": "$.ref", "matchEquals": "refs/heads/{Branch}" } ] }, "arn": "arn:aws:codepipeline:eu-central-1:123456789012:webhook:my-webhook" } ] } ``` Para obter mais informações, consulte [Listar webhooks em sua conta](https://docs.aws.amazon.com/codepipeline/latest/userguide/appendix-github-oauth.html#pipelines-webhooks-view) no *Guia do usuário do AWS CodePipeline*. + Para ver detalhes da API, consulte [ListWebhooks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-webhooks.html) na *Referência de comandos da AWS CLI*. ### `poll-for-jobs` O código de exemplo a seguir mostra como usar `poll-for-jobs`. **AWS CLI** **Como visualizar todos os trabalhos disponíveis** Este exemplo retorna informações sobre quaisquer trabalhos nos quais um funcionário possa atuar. Este exemplo usa um arquivo JSON predefinido (MyActionTypeInfo.json) para fornecer informações sobre o tipo de ação para o qual o funcionário processa trabalhos. Esse comando é usado somente para ações personalizadas. Quando esse comando é chamado, o AWS CodePipeline retorna credenciais temporárias para o bucket do Amazon S3 usado para armazenar artefatos para o pipeline. Esse comando também retornará quaisquer valores secretos definidos para a ação, se houver algum definido. Comando: ``` aws codepipeline poll-for-jobs --cli-input-json file://MyActionTypeInfo.json ``` Conteúdo de amostra do arquivo JSON: ``` { "actionTypeId": { "category": "Test", "owner": "Custom", "provider": "MyJenkinsProviderName", "version": "1" }, "maxBatchSize": 5, "queryParam": { "ProjectName": "MyJenkinsTestProject" } } ``` Resultado: ``` { "jobs": [ { "accountId": "111111111111", "data": { "actionConfiguration": { "__type": "ActionConfiguration", "configuration": { "ProjectName": "MyJenkinsExampleTestProject" } }, "actionTypeId": { "__type": "ActionTypeId", "category": "Test", "owner": "Custom", "provider": "MyJenkinsProviderName", "version": "1" }, "artifactCredentials": { "__type": "AWSSessionCredentials", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "sessionToken": "fICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcNMTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9TrDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpEIbb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0FkbFFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTbNYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=" }, "inputArtifacts": [ { "__type": "Artifact", "location": { "s3Location": { "bucketName": "codepipeline-us-east-1-11EXAMPLE11", "objectKey": "MySecondPipeline/MyAppBuild/EXAMPLE" }, "type": "S3" }, "name": "MyAppBuild" } ], "outputArtifacts": [], "pipelineContext": { "__type": "PipelineContext", "action": { "name": "MyJenkinsTest-Action" }, "pipelineName": "MySecondPipeline", "stage": { "name": "Testing" } } }, "id": "ef66c259-64f9-EXAMPLE", "nonce": "3" } ] } ``` + Para ver detalhes da API, consulte [PollForJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/poll-for-jobs.html) na *Referência de comandos da AWS CLI*. ### `put-webhook` O código de exemplo a seguir mostra como usar `put-webhook`. **AWS CLI** **Para criar um webhook** O exemplo `put-webhook` a seguir cria um webhook para uma ação de origem do GitHub versão 1. Depois de criar o webhook, você deve usar o comando register-webhook-with-third para registrá-lo. ``` aws codepipeline put-webhook \ --cli-input-json file://webhook_json.json \ --region "eu-central-1" ``` Conteúdo de `webhook_json.json`: ``` { "webhook": { "name": "my-webhook", "targetPipeline": "pipeline_name", "targetAction": "source_action_name", "filters": [ { "jsonPath": "$.ref", "matchEquals": "refs/heads/{Branch}" } ], "authentication": "GITHUB_HMAC", "authenticationConfiguration": { "SecretToken": "secret" } } } ``` Resultado: ``` { "webhook": { "url": "https://webhooks.domain.com/trigger111111111EXAMPLE11111111111111111", "definition": { "authenticationConfiguration": { "SecretToken": "secret" }, "name": "my-webhook", "authentication": "GITHUB_HMAC", "targetPipeline": "pipeline_name", "targetAction": "Source", "filters": [ { "jsonPath": "$.ref", "matchEquals": "refs/heads/{Branch}" } ] }, "arn": "arn:aws:codepipeline:eu-central-1:123456789012:webhook:my-webhook" }, "tags": [ { "key": "Project", "value": "ProjectA" } ] } ``` Para obter mais informações, consulte [Criar um webhook para uma origem do GitHub](https://docs.aws.amazon.com/codepipeline/latest/userguide/appendix-github-oauth.html#pipelines-webhooks-create) no *Guia do usuário do AWS CodePipeline*. + Para ver detalhes da API, consulte [PutWebhook](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/put-webhook.html) na *Referência de comandos da AWS CLI*. ### `retry-stage-execution` O código de exemplo a seguir mostra como usar `retry-stage-execution`. **AWS CLI** **Como tentar novamente uma ação com falha** O exemplo `retry-stage-execution` a seguir repete um estágio que tem uma ação com falha. ``` aws codepipeline retry-stage-execution \ --pipeline-name MyPipeline \ --stage-name Deploy \ --pipeline-execution-id b59babff-5f34-EXAMPLE \ --retry-mode FAILED_ACTIONS ``` Resultado: ``` { "pipelineExecutionId": "b59babff-5f34-EXAMPLE" } ``` Para obter mais informações, consulte [Tentar novamente as ações com falha (CLI)](https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-retry.html#actions-retry-cli) no *Guia do usuário do AWS CodePipeline*. + Para ver detalhes da API, consulte [RetryStageExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/retry-stage-execution.html) e *Referência de comandos da AWS CLI*. ### `start-pipeline-execution` O código de exemplo a seguir mostra como usar `start-pipeline-execution`. **AWS CLI** **Para executar a revisão mais recente por meio de um pipeline** Este exemplo executa a revisão mais recente presente no estágio de origem de um pipeline por meio do pipeline chamado “MyFirstPipeline”. Comando: ``` aws codepipeline start-pipeline-execution --name MyFirstPipeline ``` Resultado: ``` { "pipelineExecutionId": "3137f7cb-7cf7-EXAMPLE" } ``` + Para obter detalhes a API, consulte [StartPipelineExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/start-pipeline-execution.html) na *Referência de comandos da AWS CLI*. ### `stop-pipeline-execution` O código de exemplo a seguir mostra como usar `stop-pipeline-execution`. **AWS CLI** **Como interromper a execução de um pipeline** O exemplo `stop-pipeline-execution` a seguir usa como padrão esperar até que as ações em andamento sejam concluídas e, em seguida, interrompa o pipeline. Não é possível optar por interromper e aguardar se a execução já estiver em um estado Stopping (Interrompendo). É possível optar por interromper e abandonar uma execução que já está em um estado Stopping (Interrompendo). ``` aws codepipeline stop-pipeline-execution \ --pipeline-name MyFirstPipeline \ --pipeline-execution-id d-EXAMPLE \ --reason "Stopping pipeline after the build action is done" ``` Esse comando não retorna uma saída. Para obter mais informações, consulte [Interromper uma execução de pipeline (CLI)](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-stop.html#pipelines-stop-cli) no *Guia do usuário do AWS CodePipeline*. + Para ver detalhes da API, consulte [StopPipelineExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/stop-pipeline-execution.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como marcar um recurso** O exemplo `tag-resource` a seguir associa um conjunto de tags fornecidas a um pipeline. Use esse comando para adicionar ou editar tags. ``` aws codepipeline tag-resource \ --resource-arn arn:aws:codepipeline:us-east-1:123456789012:MyPipeline \ --tags key=Project,value=ProjectA key=IscontainerBased,value=true ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar tags a um pipeline (CLI)](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-tag.html#pipelines-tag-add-cli) no *Guia do usuário do AWS CodePipeline*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover tags da AWS de um recurso de conexões** O exemplo a seguir remove a tag com uma chave de `untag-resource` do compartilhamento de recursos especificado. ``` aws codepipeline untag-resource \ --resource-arn arn:aws:codepipeline:us-east-1:123456789012:MyPipeline \ --tag-keys Project IscontainerBased ``` Este comando não produz saída. Para obter mais informações, consulte [Remover tags de um pipeline (CLI)](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-tag.html#pipelines-tag-delete-cli) no *Guia do usuário do AWS CodePipeline*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-pipeline` O código de exemplo a seguir mostra como usar `update-pipeline`. **AWS CLI** **Para atualizar a estrutura de um pipeline** Este exemplo usa o comando update-pipeline com o argumento --cli-input-json. Este exemplo usa um arquivo JSON predefinido (MyFirstPipeline.json) para atualizar a estrutura de um pipeline. AWS O CodePipeline reconhece o nome do pipeline contido no arquivo JSON e, em seguida, aplica todas as alterações dos campos modificados na estrutura do pipeline para atualizar o pipeline. Use as diretrizes a seguir ao criar o arquivo JSON predefinido: Se você estiver trabalhando com uma estrutura de pipeline recuperada usando o comando get-pipeline, deverá remover a seção de metadados da estrutura do pipeline no arquivo JSON (as linhas “metadata”: \$1 \$1 e os campos “created”, “pipelineARN” e “updated”). O nome do pipeline não pode ser alterado. Comando: ``` aws codepipeline update-pipeline --cli-input-json file://MyFirstPipeline.json ``` Amostra de conteúdo do arquivo JSON: ``` { "pipeline": { "roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service", "stages": [ { "name": "Source", "actions": [ { "inputArtifacts": [], "name": "Source", "actionTypeId": { "category": "Source", "owner": "AWS", "version": "1", "provider": "S3" }, "outputArtifacts": [ { "name": "MyApp" } ], "configuration": { "S3Bucket": "awscodepipeline-demo-bucket2", "S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip" }, "runOrder": 1 } ] }, { "name": "Beta", "actions": [ { "inputArtifacts": [ { "name": "MyApp" } ], "name": "CodePipelineDemoFleet", "actionTypeId": { "category": "Deploy", "owner": "AWS", "version": "1", "provider": "CodeDeploy" }, "outputArtifacts": [], "configuration": { "ApplicationName": "CodePipelineDemoApplication", "DeploymentGroupName": "CodePipelineDemoFleet" }, "runOrder": 1 } ] } ], "artifactStore": { "type": "S3", "location": "codepipeline-us-east-1-11EXAMPLE11" }, "name": "MyFirstPipeline", "version": 1 } } ``` Resultado: ``` { "pipeline": { "artifactStore": { "location": "codepipeline-us-east-1-11EXAMPLE11", "type": "S3" }, "name": "MyFirstPipeline", "roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service", "stages": [ { "actions": [ { "actionTypeId": { "__type": "ActionTypeId", "category": "Source", "owner": "AWS", "provider": "S3", "version": "1" }, "configuration": { "S3Bucket": "awscodepipeline-demo-bucket2", "S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip" }, "inputArtifacts": [], "name": "Source", "outputArtifacts": [ { "name": "MyApp" } ], "runOrder": 1 } ], "name": "Source" }, { "actions": [ { "actionTypeId": { "__type": "ActionTypeId", "category": "Deploy", "owner": "AWS", "provider": "CodeDeploy", "version": "1" }, "configuration": { "ApplicationName": "CodePipelineDemoApplication", "DeploymentGroupName": "CodePipelineDemoFleet" }, "inputArtifacts": [ { "name": "MyApp" } ], "name": "CodePipelineDemoFleet", "outputArtifacts": [], "runOrder": 1 } ], "name": "Beta" } ], "version": 3 } } ``` + Para ver detalhes da API, consulte [UpdatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/update-pipeline.html) na *Referência de comandos da AWS CLI*. # Exemplos de notificações do AWS CodeStar usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com notificações do AWS CodeStar. *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 ### `create-notification-rule` O código de exemplo a seguir mostra como usar `create-notification-rule`. **AWS CLI** **Para criar uma regra de notificação** O exemplo `create-notification-rule` a seguir usa um arquivo JSON chamado `rule.json` para criar uma regra de notificação com o nome `MyNotificationRule` de um repositório chamado `MyDemoRepo` na conta da AWS especificada. As notificações com o tipo de detalhe `FULL` são enviadas para o tópico do Amazon SNS de destino especificado quando ramificações e tags são criadas. ``` aws codestar-notifications create-notification-rule \ --cli-input-json file://rule.json ``` Conteúdo de `rule.json`: ``` { "Name": "MyNotificationRule", "EventTypeIds": [ "codecommit-repository-branches-and-tags-created" ], "Resource": "arn:aws:codecommit:us-east-1:123456789012:MyDemoRepo", "Targets": [ { "TargetType": "SNS", "TargetAddress": "arn:aws:sns:us-east-1:123456789012:MyNotificationTopic" } ], "Status": "ENABLED", "DetailType": "FULL" } ``` Resultado: ``` { "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE" } ``` Para obter mais informações, consulte [Criar uma regra de notificação](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-create.html) no *Guia do usuário do console de ferramentas do desenvolvedor da AWS*. + Para ver detalhes da API, consulte [CreateNotificationRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/create-notification-rule.html) na *Referência de comandos da AWS CLI*. ### `delete-notification-rule` O código de exemplo a seguir mostra como usar `delete-notification-rule`. **AWS CLI** **Para excluir uma regra de notificação** O exemplo `delete-notification-rule` a seguir exclui a regra de notificação especificada. ``` aws codestar-notifications delete-notification-rule \ --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE ``` Resultado: ``` { "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE" } ``` Para obter mais informações, consulte [Excluir uma regra de notificação](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-delete.html) no *Guia do usuário do console de ferramentas do desenvolvedor da AWS*. + Para ver detalhes da API, consulte [DeleteNotificationRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/delete-notification-rule.html) na *Referência de comandos da AWS CLI*. ### `delete-target` O código de exemplo a seguir mostra como usar `delete-target`. **AWS CLI** **Para excluir uma regra de notificação** O exemplo `delete-target` a seguir remove o destino especificado de todas as regras de notificação configuradas para usá-lo como destino e, depois, exclui o destino. ``` aws codestar-notifications delete-target \ --target-address arn:aws:sns:us-east-1:123456789012:MyNotificationTopic \ --force-unsubscribe-all ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir um destino de regra de notificação](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-target-delete.html) no *Guia do usuário do console de ferramentas do desenvolvedor da AWS*. + Para ver detalhes da API, consulte [DeleteTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/delete-target.html) na *Referência de comandos da AWS CLI*. ### `describe-notification-rule` O código de exemplo a seguir mostra como usar `describe-notification-rule`. **AWS CLI** **Para recuperar detalhes de uma regra de notificação** O exemplo `describe-notification-rule` a seguir recupera os detalhes da regra de notificação especificada. ``` aws codestar-notifications describe-notification-rule \ --arn arn:aws:codestar-notifications:us-west-2:123456789012:notificationrule/dc82df7a-EXAMPLE ``` Resultado: ``` { "LastModifiedTimestamp": 1569199844.857, "EventTypes": [ { "ServiceName": "CodeCommit", "EventTypeName": "Branches and tags: Created", "ResourceType": "Repository", "EventTypeId": "codecommit-repository-branches-and-tags-created" } ], "Status": "ENABLED", "DetailType": "FULL", "Resource": "arn:aws:codecommit:us-west-2:123456789012:MyDemoRepo", "Arn": "arn:aws:codestar-notifications:us-west-w:123456789012:notificationrule/dc82df7a-EXAMPLE", "Targets": [ { "TargetStatus": "ACTIVE", "TargetAddress": "arn:aws:sns:us-west-2:123456789012:MyNotificationTopic", "TargetType": "SNS" } ], "Name": "MyNotificationRule", "CreatedTimestamp": 1569199844.857, "CreatedBy": "arn:aws:iam::123456789012:user/Mary_Major" } ``` Para obter mais informações, consulte [Visualizar regras de notificação](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-view.html) no *Guia do usuário do console de ferramentas do desenvolvedor da AWS*. + Para ver detalhes da API, consulte [DescribeNotificationRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/describe-notification-rule.html) na *Referência de comandos da AWS CLI*. ### `list-event-types` O código de exemplo a seguir mostra como usar `list-event-types`. **AWS CLI** **Para obter uma lista de tipos de evento para uma regra de notificação** O exemplo `list-event-types` a seguir recupera uma lista filtrada de todos os tipos de evento de notificação disponíveis para aplicações do CodeDeploy. Se, em vez disso, você não usar nenhum filtro, o comando retornará todos os tipos de eventos de notificação para todos os tipos de recursos. ``` aws codestar-notifications list-event-types \ --filters Name=SERVICE_NAME,Value=CodeDeploy ``` Resultado: ``` { "EventTypes": [ { "EventTypeId": "codedeploy-application-deployment-succeeded", "ServiceName": "CodeDeploy", "EventTypeName": "Deployment: Succeeded", "ResourceType": "Application" }, { "EventTypeId": "codedeploy-application-deployment-failed", "ServiceName": "CodeDeploy", "EventTypeName": "Deployment: Failed", "ResourceType": "Application" }, { "EventTypeId": "codedeploy-application-deployment-started", "ServiceName": "CodeDeploy", "EventTypeName": "Deployment: Started", "ResourceType": "Application" } ] } ``` Para obter mais informações, consulte [Criar uma regra de notificação](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-create.html) no *Guia do usuário do console de ferramentas do desenvolvedor da AWS*. + Para ver detalhes da API, consulte [ListEventTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/list-event-types.html) na *Referência de comandos da AWS CLI*. ### `list-notification-rules` O código de exemplo a seguir mostra como usar `list-notification-rules`. **AWS CLI** **Para recuperar uma lista de regras de notificação** O exemplo `list-notification-rules` a seguir recupera uma lista de todas as regras de notificação na região da AWS especificada. ``` aws codestar-notifications list-notification-rules --region us-east-1 ``` Resultado: ``` { "NotificationRules": [ { "Id": "dc82df7a-EXAMPLE", "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE" }, { "Id": "8d1f0983-EXAMPLE", "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/8d1f0983-EXAMPLE" } ] } ``` Para obter mais informações, consulte [Visualizar regras de notificação](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-view.html) no *Guia do usuário do console de ferramentas do desenvolvedor da AWS*. + Para ver detalhes da API, consulte [ListNotificationRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/list-notification-rules.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para obter uma lista de tags anexadas a uma regra de notificação** O exemplo `list-tags-for-resource` a seguir recupera uma lista de todas as tags anexadas à regra de notificação especificada. Neste exemplo, a regra de notificação atualmente não tem tags associadas a ela. ``` aws codestar-notifications list-tags-for-resource \ --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE ``` Resultado: ``` { "Tags": {} } ``` Para obter mais informações, consulte [Criar uma regra de notificação](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-create.html) no *Guia do usuário do console de ferramentas do desenvolvedor da AWS*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `list-targets` O código de exemplo a seguir mostra como usar `list-targets`. **AWS CLI** **Para recuperar uma lista de destinos de regra de notificação** O exemplo `list-targets` a seguir recupera uma lista de todos os destinos de regras de notificação na região da AWS especificada. ``` aws codestar-notifications list-targets \ --region us-east-1 ``` Resultado: ``` { "Targets": [ { "TargetAddress": "arn:aws:sns:us-east-1:123456789012:MySNSTopicForNotificationRules", "TargetType": "SNS", "TargetStatus": "ACTIVE" }, { "TargetAddress": "arn:aws:sns:us-east-1:123456789012:MySNSTopicForNotificationsAboutMyDemoRepo", "TargetType": "SNS", "TargetStatus": "ACTIVE" } ] } ``` Para obter mais informações, consulte [Visualizar destinos de regra de notificação](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-target-view.html) no *Guia do usuário do console de ferramentas do desenvolvedor da AWS*. + Para ver detalhes da API, consulte [ListTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/list-targets.html) na *Referência de comandos da AWS CLI*. ### `subscribe` O código de exemplo a seguir mostra como usar `subscribe`. **AWS CLI** **Para adicionar um destino a uma regra de notificação** O exemplo `subscribe` a seguir adiciona um tópico do Amazon SNS como um destino para a regra de notificação especificada. ``` aws codestar-notifications subscribe \ --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE \ --target TargetType=SNS,TargetAddress=arn:aws:sns:us-east-1:123456789012:MyNotificationTopic ``` Resultado: ``` { "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE" } ``` Para obter mais informações, consulte [Adicionar ou remover um tópico do Amazon SNS como destino para uma regra de notificação](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-target-change-rule.html) no *Guia do usuário do console de ferramentas do desenvolvedor da AWS*. + Consulte detalhes da API em [Subscribe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/subscribe.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Para adicionar uma tag a uma regra de notificação** O exemplo `tag-resource` a seguir adiciona uma tag com o nome de chave de `Team` e o valor de `Li_Juan` à regra de notificação especificada. ``` aws codestar-notifications tag-resource \ --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE \ --tags Team=Li_Juan ``` Resultado: ``` { "Tags": { "Team": "Li_Juan" } } ``` Para obter mais informações, consulte [Criar uma regra de notificação](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-create.html) no *Guia do usuário do console de ferramentas do desenvolvedor da AWS*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `unsubscribe` O código de exemplo a seguir mostra como usar `unsubscribe`. **AWS CLI** **Para remover um destino de uma regra de notificação** O exemplo `unsubscribe` a seguir remove um tópico do Amazon SNS como um destino da regra de notificação especificada. ``` aws codestar-notifications unsubscribe \ --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE \ --target TargetType=SNS,TargetAddress=arn:aws:sns:us-east-1:123456789012:MyNotificationTopic ``` Resultado: ``` { "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE" "TargetAddress": "arn:aws:sns:us-east-1:123456789012:MyNotificationTopic" } ``` Para obter mais informações, consulte [Adicionar ou remover um tópico do Amazon SNS como destino para uma regra de notificação](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-target-change-rule.html) no *Guia do usuário do console de ferramentas do desenvolvedor da AWS*. + Consulte detalhes da API em [Unsubscribe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/unsubscribe.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover uma tag de uma regra de notificação** O exemplo `untag-resource` a seguir remove a tag com uma chave de nome `Team` da regra de notificação especificada. ``` aws codestar-notifications untag-resource \ --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE \ --tag-keys Team ``` Este comando não produz saída. Para obter mais informações, consulte [Editar uma regra de notificação](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-edit.html) no *Guia do usuário do console de ferramentas do desenvolvedor da AWS*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-notification-rule` O código de exemplo a seguir mostra como usar `update-notification-rule`. **AWS CLI** **Para atualizar uma regra de notificação** O exemplo `update-notification-rule` a seguir atualiza uma regra de notificação chamada `MyNotificationRule` na conta da AWS `123456789012` usando um arquivo JSON chamado `update.json`. ``` aws codestar-notifications update-notification-rule \ --cli-input-json file://update.json ``` Conteúdo de `update.json`: ``` { "Name": "MyUpdatedNotificationRule", "EventTypeIds": [ "codecommit-repository-branches-and-tags-created" ], "Resource": "arn:aws:codecommit:us-east-1:123456789012:MyDemoRepo", "Targets": [ { "TargetType": "SNS", "TargetAddress": "arn:aws:sns:us-east-1:123456789012:MyNotificationTopic" } ], "Status": "ENABLED", "DetailType": "FULL" } ``` Resultado: ``` { "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE" } ``` Para obter mais informações, consulte [Editar uma regra de notificação](https://docs.aws.amazon.com/dtconsole/latest/userguide/notification-rule-edit.html) no *Guia do usuário do console de ferramentas do desenvolvedor da AWS*. + Para ver detalhes da API, consulte [UpdateNotificationRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/update-notification-rule.html) na *Referência de comandos da AWS CLI*. # Exemplos do CodeConnections usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o CodeConnections. *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 ### `create-connection` O código de exemplo a seguir mostra como usar `create-connection`. **AWS CLI** **Para criar uma conexão** O exemplo `create-connection` a seguir mostra como criar uma conexão com um repositório de terceiros. Este exemplo cria uma conexão em que o provedor de terceiros é o Bitbucket. Uma conexão criada por meio da AWS CLI ou do AWS CloudFormation permanece com o status Pendente por padrão. Depois de criar uma conexão com a CLI ou o AWS CloudFormation, use o console para editar a conexão e tornar seu status Disponível. ``` aws codestar-connections create-connection \ --provider-type Bitbucket \ --connection-name MyConnection ``` Resultado: ``` { "ConnectionArn": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f" } ``` Para obter mais informações, consulte [Criar uma conexão](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-create.html) no *Guia do usuário do console de ferramentas do desenvolvedor*. + Para ver detalhes da API, consulte [CreateConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/create-connection.html) na *Referência de comandos da AWS CLI*. ### `create-host` O código de exemplo a seguir mostra como usar `create-host`. **AWS CLI** **Para criar um host** O exemplo `create-host` a seguir mostra como criar um host para representar o endpoint da infraestrutura em que seu provedor de terceiros está instalado. Este exemplo cria um host em que o provedor de terceiros instalado é o GitHub Enterprise Server. Um host criado por meio da AWS CLI permanece no status Pendente por padrão. Após criar um host com a CLI, use o console ou a CLI para configurar o host e tornar seu status Disponível. ``` aws codestar-connections create-host \ --name MyHost \ --provider-type GitHubEnterpriseServer \ --provider-endpoint "https://my-instance.dev" ``` Resultado: ``` { "HostArn": "arn:aws:codestar-connections:us-east-1:123456789012:host/My-Host-28aef605" } ``` Para obter mais informações, consulte [Criar um host (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-host-create.html) no *Guia do usuário do console de ferramentas do desenvolvedor*. + Para ver detalhes da API, consulte [CreateHost](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/create-host.html) na *Referência de comandos da AWS CLI*. ### `delete-connection` O código de exemplo a seguir mostra como usar `delete-connection`. **AWS CLI** **Para excluir uma conexão** O exemplo `delete-connection` a seguir mostra como excluir uma conexão. ``` aws codestar-connections delete-connection \ --connection-arn arn:aws:codestar-connections:us-west-2:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir uma conexão (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-delete.html#connections-delete-cli) no *Guia do usuário do console de ferramentas do desenvolvedor*. + Para ver detalhes da API, consulte [DeleteConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/delete-connection.html) na *Referência de comandos da AWS CLI*. ### `delete-host` O código de exemplo a seguir mostra como usar `delete-host`. **AWS CLI** **Para excluir um host** O exemplo `delete-host` a seguir mostra como excluir um host. Para poder excluir um host, primeiro é necessário excluir todas as conexões associadas a ele. ``` aws codestar-connections delete-host \ --host-arn "arn:aws:codestar-connections:us-east-1 :123456789012:host/My-Host-28aef605" ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir um host (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-host-delete.html#connections-host-delete-cli) no *Guia do usuário do console de ferramentas do desenvolvedor*. + Para ver detalhes da API, consulte [DeleteHost](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/delete-host.html) na *Referência de comandos da AWS CLI*. ### `get-connection` O código de exemplo a seguir mostra como usar `get-connection`. **AWS CLI** **Para obter informações sobre uma conexão** O exemplo `get-connection` a seguir mostra detalhes de uma conexão. ``` aws codestar-connections get-connection \ --connection-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f ``` Resultado: ``` { "Connection": { "ConnectionName": "MyConnection", "ConnectionArn": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f", "ProviderType": "Bitbucket", "OwnerAccountId": "123456789012", "ConnectionStatus": "AVAILABLE" } } ``` Para obter mais informações, consulte [Visualizar detalhes da conexão](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-view-details.html) no *Guia do usuário do console de ferramentas do desenvolvedor*. + Para ver detalhes da API, consulte [GetConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/get-connection.html) na *Referência de comandos da AWS CLI*. ### `get-host` O código de exemplo a seguir mostra como usar `get-host`. **AWS CLI** **Para obter informações sobre um host** O exemplo `get-host` a seguir mostra detalhes sobre um host. ``` aws codestar-connections get-host \ --host-arn arn:aws:codestar-connections:us-east-1:123456789012:host/MyHost-28aef605 ``` Resultado: ``` { "Name": "MyHost", "Status": "AVAILABLE", "ProviderType": "GitHubEnterpriseServer", "ProviderEndpoint": "https://test-instance-1.dev/" } ``` Para obter mais informações, consulte [Visualizar detalhes do host (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-host-view.html#connections-host-view-cli) no *Guia do usuário do console de ferramentas do desenvolvedor*. + Para ver detalhes da API, consulte [GetHost](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/get-host.html) na *Referência de comandos da AWS CLI*. ### `list-connections` O código de exemplo a seguir mostra como usar `list-connections`. **AWS CLI** **Para listar conexões** O exemplo `list-connections` a seguir recupera uma lista de todas as conexões em sua conta para o tipo de provedor Bitbucket: ``` aws codestar-connections list-connections \ --provider-type Bitbucket \ --max-results 5 \ --next-token: next-token ``` Resultado: ``` { "Connections": [ { "ConnectionName": "my-connection", "ProviderType": "Bitbucket", "Status": "PENDING", "ARN": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f", "OwnerAccountId": "123456789012" }, { "ConnectionName": "my-other-connection", "ProviderType": "Bitbucket", "Status": "AVAILABLE", "ARN": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f", "OwnerAccountId": "123456789012" }, ], "NextToken": "next-token" } ``` Para obter mais informações sobre conexões, consulte [Listar conexões (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-list.html#connections-list-cli) no *Guia do usuário do console de ferramentas do desenvolvedor*. + Para ver detalhes da API, consulte [ListConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/list-connections.html) na *Referência de comandos da AWS CLI*. ### `list-hosts` O código de exemplo a seguir mostra como usar `list-hosts`. **AWS CLI** **Para listar hosts** O exemplo `list-hosts` a seguir recupera uma lista de todos os hosts em sua conta. ``` aws codestar-connections list-hosts ``` Resultado: ``` { "Hosts": [ { "Name": "My-Host", "HostArn": "arn:aws:codestar-connections:us-east-1:123456789012:host/My-Host-28aef605", "ProviderType": "GitHubEnterpriseServer", "ProviderEndpoint": "https://my-instance.test.dev", "Status": "AVAILABLE" } ] } ``` Para obter mais informações sobre conexões, consulte [Listar host (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-host-list.html) no *Guia do usuário do console de ferramentas do desenvolvedor*. + Para ver detalhes da API, consulte [ListHosts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/list-hosts.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar tags** O exemplo `list-tags-for-resource` a seguir recupera uma lista de todas as tags anexadas ao recurso de conexões especificado. ``` aws codestar-connections list-tags-for-resource \ --resource-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f ``` Resultado: ``` { "Tags": [ { "Key": "Project", "Value": "ProjectA" }, { "Key": "ReadOnly", "Value": "true" } ] } ``` Para obter mais informações, consulte [Visualizar tags de um recurso de conexões](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-tag.html#connections-tag-view) no *Guia do usuário do console de ferramentas do desenvolvedor*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como marcar um recurso** O exemplo `tag-resource` a seguir associa um conjunto de tags fornecidas a um conexão. Use esse comando para adicionar ou editar tags. ``` aws codestar-connections tag-resource \ --resource-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f \ --tags Key=Project,Value=ProjectA Key=IscontainerBased,Value=true ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar tags a um recurso de conexões](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-tag.html#connections-tag-add) no *Guia do usuário do console de ferramentas do desenvolvedor*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover tags da AWS de um recurso de conexões** O `untag-resource` a seguir remove uma tag do recurso especificado. ``` aws codestar-connections untag-resource \ --resource-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f \ --tag-keys Project ReadOnly ``` Resultado: ``` { "Tags": [] } ``` Para obter mais informações, consulte [Remover tags de um recurso de conexões](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-tag.html#connections-tag-delete) no *Guia do usuário do console de ferramentas do desenvolvedor*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/untag-resource.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon Cognito Identity usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface 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 ### `create-identity-pool` O código de exemplo a seguir mostra como usar `create-identity-pool`. **AWS CLI** **Como criar um banco de identidades com o provedor de banco de identidades Cognito** Este exemplo cria um banco de identidades chamado MyIdentityPool. Ele tem um provedor de banco de identidades Cognito. Identidades não autenticadas não são permitidas. Comando: ``` aws cognito-identity create-identity-pool --identity-pool-name MyIdentityPool --no-allow-unauthenticated-identities --cognito-identity-providers ProviderName="cognito-idp.us-west-2.amazonaws.com/us-west-2_aaaaaaaaa",ClientId="3n4b5urk1ft4fl3mg5e62d9ado",ServerSideTokenCheck=false ``` Resultado: ``` { "IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111", "IdentityPoolName": "MyIdentityPool", "AllowUnauthenticatedIdentities": false, "CognitoIdentityProviders": [ { "ProviderName": "cognito-idp.us-west-2.amazonaws.com/us-west-2_111111111", "ClientId": "3n4b5urk1ft4fl3mg5e62d9ado", "ServerSideTokenCheck": false } ] } ``` + Para ver detalhes da API, consulte [CreateIdentityPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/create-identity-pool.html) na *Referência de comandos da AWS CLI*. ### `delete-identities` O código de exemplo a seguir mostra como usar `delete-identities`. **AWS CLI** **Como excluir um banco de identidades** Este exemplo exclui um banco de identidades. Comando: ``` aws cognito-identity delete-identity-pool --identity-ids-to-delete "us-west-2:11111111-1111-1111-1111-111111111111" ``` Resultado: ``` { "UnprocessedIdentityIds": [] } ``` + Para ver detalhes da API, consulte [DeleteIdentities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/delete-identities.html) na *Referência de comandos da AWS CLI*. ### `delete-identity-pool` O código de exemplo a seguir mostra como usar `delete-identity-pool`. **AWS CLI** **Como excluir um banco de identidades** O exemplo `delete-identity-pool` a seguir exclui o banco de identidades especificado. Comando: ``` aws cognito-identity delete-identity-pool \ --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111" ``` Este comando não produz saída. + Consulte detalhes da API em [DeleteIdentityPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/delete-identity-pool.html) na *Referência de comandos da AWS CLI*. ### `describe-identity-pool` O código de exemplo a seguir mostra como usar `describe-identity-pool`. **AWS CLI** **Para descrever um banco de identidades** Este exemplo descreve um banco de identidades. Comando: ``` aws cognito-identity describe-identity-pool --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111" ``` Resultado: ``` { "IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111", "IdentityPoolName": "MyIdentityPool", "AllowUnauthenticatedIdentities": false, "CognitoIdentityProviders": [ { "ProviderName": "cognito-idp.us-west-2.amazonaws.com/us-west-2_111111111", "ClientId": "3n4b5urk1ft4fl3mg5e62d9ado", "ServerSideTokenCheck": false } ] } ``` + Para ver detalhes da API, consulte [DescribeIdentityPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/describe-identity-pool.html) na *Referência de comandos da AWS CLI*. ### `get-identity-pool-roles` O código de exemplo a seguir mostra como usar `get-identity-pool-roles`. **AWS CLI** **Para obter funções no banco de identidades** Este exemplo lista bancos de identidades. Comando: ``` aws cognito-identity get-identity-pool-roles --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111" ``` Resultado: ``` { "IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111", "Roles": { "authenticated": "arn:aws:iam::111111111111:role/Cognito_MyIdentityPoolAuth_Role", "unauthenticated": "arn:aws:iam::111111111111:role/Cognito_MyIdentityPoolUnauth_Role" } } ``` + Para ver detalhes da API, consulte [GetIdentityPoolRoles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/get-identity-pool-roles.html) na *Referência de comandos da AWS CLI*. ### `list-identity-pools` O código de exemplo a seguir mostra como usar `list-identity-pools`. **AWS CLI** **Para listar bancos de identidades** Este exemplo lista bancos de identidades. Há no máximo vinte identidades listadas. Comando: ``` aws cognito-identity list-identity-pools --max-results 20 ``` Resultado: ``` { "IdentityPools": [ { "IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111", "IdentityPoolName": "MyIdentityPool" }, { "IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111", "IdentityPoolName": "AnotherIdentityPool" }, { "IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111", "IdentityPoolName": "IdentityPoolRegionA" } ] } ``` + Para ver detalhes da API, consulte [ListIdentityPools](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/list-identity-pools.html) na *Referência de comandos da AWS CLI*. ### `set-identity-pool-roles` O código de exemplo a seguir mostra como usar `set-identity-pool-roles`. **AWS CLI** **Como definir funções do banco de identidades** O exemplo `set-identity-pool-roles` a seguir define funções para um banco de identidades. ``` aws cognito-identity set-identity-pool-roles \ --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111" \ --roles authenticated="arn:aws:iam::111111111111:role/Cognito_MyIdentityPoolAuth_Role" ``` + Para obter detalhes sobre a API, consulte [SetIdentityPoolRoles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/set-identity-pool-roles.html) na *AWS CLI Command Reference*. ### `update-identity-pool` O código de exemplo a seguir mostra como usar `update-identity-pool`. **AWS CLI** **Para atualizar um banco de identidades** Este exemplo atualiza um banco de identidades. Ele define o nome como MyIdentityPool. Ele tem um provedor de banco de identidades Cognito. Ele não permite identidades não autenticadas. Comando: ``` aws cognito-identity update-identity-pool --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111" --identity-pool-name "MyIdentityPool" --no-allow-unauthenticated-identities --cognito-identity-providers ProviderName="cognito-idp.us-west-2.amazonaws.com/us-west-2_111111111",ClientId="3n4b5urk1ft4fl3mg5e62d9ado",ServerSideTokenCheck=false ``` Resultado: ``` { "IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111", "IdentityPoolName": "MyIdentityPool", "AllowUnauthenticatedIdentities": false, "CognitoIdentityProviders": [ { "ProviderName": "cognito-idp.us-west-2.amazonaws.com/us-west-2_111111111", "ClientId": "3n4b5urk1ft4fl3mg5e62d9ado", "ServerSideTokenCheck": false } ] } ``` + Para ver detalhes da API, consulte [UpdateIdentityPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/update-identity-pool.html) na *Referência de comandos da AWS CLI*. # Exemplos do provedor de identidade do Amazon Cognito usando o AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando oAWS Command Line Interface com o Provedor de Identidade do Amazon Cognito. *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-custom-attributes` O código de exemplo a seguir mostra como usar `add-custom-attributes`. **AWS CLI** **Para adicionar um atributo personalizado** Este exemplo adiciona um atributo personalizado CustomAttr1 a um grupo de usuários. É do tipo String e requer um mínimo de 1 caractere e um máximo de 15. Não é obrigatório. Comando: ``` aws cognito-idp add-custom-attributes --user-pool-id us-west-2_aaaaaaaaa --custom-attributes Name="CustomAttr1",AttributeDataType="String",DeveloperOnlyAttribute=false,Required=false,StringAttributeConstraints="{MinLength=1,MaxLength=15}" ``` + Para ver detalhes da API, consulte [AddCustomAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/add-custom-attributes.html) na *Referência de comandos da AWS CLI*. ### `admin-add-user-to-group` O código de exemplo a seguir mostra como usar `admin-add-user-to-group`. **AWS CLI** **Para adicionar um usuário a um grupo** Este exemplo adiciona a usuária Jane ao grupo MyGroup. Comando: ``` aws cognito-idp admin-add-user-to-group --user-pool-id us-west-2_aaaaaaaaa --username Jane --group-name MyGroup ``` + Para ver detalhes da API, consulte [AdminAddUserToGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-add-user-to-group.html) na *Referência de comandos da AWS CLI*. ### `admin-confirm-sign-up` O código de exemplo a seguir mostra como usar `admin-confirm-sign-up`. **AWS CLI** **Como confirmar o registro do usuário** Este exemplo confirma o usuário jane@example.com. Comando: ``` aws cognito-idp admin-confirm-sign-up --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com ``` + Para ver detalhes da API, consulte [AdminConfirmSignUp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-confirm-sign-up.html) na *Referência de comandos da AWS CLI*. ### `admin-create-user` O código de exemplo a seguir mostra como usar `admin-create-user`. **AWS CLI** **Para criar um usuário** O `admin-create-user` exemplo a seguir cria um usuário com as configurações especificadas de endereço de e-mail e número de telefone. ``` aws cognito-idp admin-create-user \ --user-pool-id us-west-2_aaaaaaaaa \ --username diego \ --user-attributes Name=email,Value=diego@example.com Name=phone_number,Value="+15555551212" \ --message-action SUPPRESS ``` Resultado: ``` { "User": { "Username": "diego", "Attributes": [ { "Name": "sub", "Value": "7325c1de-b05b-4f84-b321-9adc6e61f4a2" }, { "Name": "phone_number", "Value": "+15555551212" }, { "Name": "email", "Value": "diego@example.com" } ], "UserCreateDate": 1548099495.428, "UserLastModifiedDate": 1548099495.428, "Enabled": true, "UserStatus": "FORCE_CHANGE_PASSWORD" } } ``` + Para ver detalhes da API, consulte [AdminCreateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-create-user.html) na *Referência de comandos da AWS CLI*. ### `admin-delete-user-attributes` O código de exemplo a seguir mostra como usar `admin-delete-user-attributes`. **AWS CLI** **Para excluir um atributo do usuário** Este exemplo exclui um atributo personalizado CustomAttr1 do usuário diego@example.com. Comando: ``` aws cognito-idp admin-delete-user-attributes --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --user-attribute-names "custom:CustomAttr1" ``` + Para ver detalhes da API, consulte [AdminDeleteUserAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-delete-user-attributes.html) na *Referência de comandos da AWS CLI*. ### `admin-delete-user` O código de exemplo a seguir mostra como usar `admin-delete-user`. **AWS CLI** **Como excluir um usuário** Este exemplo exclui um usuário. Comando: ``` aws cognito-idp admin-delete-user --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com ``` + Para ver detalhes da API, consulte [AdminDeleteUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-delete-user.html) na *Referência de comandos da AWS CLI*. ### `admin-disable-provider-for-user` O código de exemplo a seguir mostra como usar `admin-disable-provider-for-user`. **AWS CLI** **Como desvincular um usuário federado de um perfil de usuário local** O exemplo de `admin-disable-provider-for-user` a seguir desconecta um usuário do Google do seu perfil local vinculado. ``` aws cognito-idp admin-disable-provider-for-user \ --user-pool-id us-west-2_EXAMPLE \ --user ProviderAttributeName=Cognito_Subject,ProviderAttributeValue=0000000000000000,ProviderName=Google ``` Consulte mais informações em [Vincular usuários federados a um perfil de usuário existente](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [AdminDisableProviderForUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-disable-provider-for-user.html) na *Referência de comandos da AWS CLI*. ### `admin-disable-user` O código de exemplo a seguir mostra como usar `admin-disable-user`. **AWS CLI** **Como impedir o login de um usuário** O exemplo de `admin-disable-user` a seguir impede o login do usuário `diego@example.com`. ``` aws cognito-idp admin-disable-user \ --user-pool-id us-west-2_EXAMPLE \ --username diego@example.com ``` Consulte mais informações em [Como gerenciar usuários](https://docs.aws.amazon.com/cognito/latest/developerguide/managing-users.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [AdminDisableUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-disable-user.html) na *Referência de comandos da AWS CLI*. ### `admin-enable-user` O código de exemplo a seguir mostra como usar `admin-enable-user`. **AWS CLI** **Como habilitar o login de um usuário** O exemplo de `admin-enable-user` a seguir habilita o login do usuário diego@example.com. ``` aws cognito-idp admin-enable-user \ --user-pool-id us-west-2_EXAMPLE \ --username diego@example.com ``` Consulte mais informações em [Como gerenciar usuários](https://docs.aws.amazon.com/cognito/latest/developerguide/managing-users.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [AdminEnableUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-enable-user.html) na *Referência de comandos da AWS CLI*. ### `admin-forget-device` O código de exemplo a seguir mostra como usar `admin-forget-device`. **AWS CLI** **Como esquecer um dispositivo** Este exemplo esquece o dispositivo no nome de usuário jane@example.com Comando: ``` aws cognito-idp admin-forget-device --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com --device-key us-west-2_abcd_1234-5678 ``` + Para ver detalhes da API, consulte [AdminForgetDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-forget-device.html) na *Referência de comandos da AWS CLI*. ### `admin-get-device` O código de exemplo a seguir mostra como usar `admin-get-device`. **AWS CLI** **Para obter um dispositivo** O exemplo de `admin-get-device` a seguir exibe um dispositivo para o usuário `diego`. ``` aws cognito-idp admin-get-device \ --user-pool-id us-west-2_EXAMPLE \ --username diego \ --device-key us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "Device": { "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceAttributes": [ { "Name": "device_status", "Value": "valid" }, { "Name": "device_name", "Value": "MyDevice" }, { "Name": "dev:device_arn", "Value": "arn:aws:cognito-idp:us-west-2:123456789012:owner/diego.us-west-2_EXAMPLE/device/us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, { "Name": "dev:device_owner", "Value": "diego.us-west-2_EXAMPLE" }, { "Name": "last_ip_used", "Value": "192.0.2.1" }, { "Name": "dev:device_remembered_status", "Value": "remembered" }, { "Name": "dev:device_sdk", "Value": "aws-sdk" } ], "DeviceCreateDate": 1715100742.022, "DeviceLastModifiedDate": 1723233651.167, "DeviceLastAuthenticatedDate": 1715100742.0 } } ``` Consulte mais informações em [Trabalhar com dispositivos de usuários no grupo de usuários](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) no *Guia do desenvolvedor do Amazon Cognito*. + Para ver detalhes da API, consulte [AdminGetDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-get-device.html) na *Referência de comandos da AWS CLI*. ### `admin-get-user` O código de exemplo a seguir mostra como usar `admin-get-user`. **AWS CLI** **Como obter um usuário** Este exemplo obtém informações sobre o nome de usuário jane@example.com. Comando: ``` aws cognito-idp admin-get-user --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com ``` Resultado: ``` { "Username": "4320de44-2322-4620-999b-5e2e1c8df013", "Enabled": true, "UserStatus": "FORCE_CHANGE_PASSWORD", "UserCreateDate": 1548108509.537, "UserAttributes": [ { "Name": "sub", "Value": "4320de44-2322-4620-999b-5e2e1c8df013" }, { "Name": "email_verified", "Value": "true" }, { "Name": "phone_number_verified", "Value": "true" }, { "Name": "phone_number", "Value": "+01115551212" }, { "Name": "email", "Value": "jane@example.com" } ], "UserLastModifiedDate": 1548108509.537 } ``` + Para obter os detalhes da API, consulte [AdminGetUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-get-user.html) na *Referência de comandos da AWS CLI*. ### `admin-initiate-auth` O código de exemplo a seguir mostra como usar `admin-initiate-auth`. **AWS CLI** **Como fazer login como usuário administrador** O exemplo de `admin-initiate-auth` a seguir faz login com o usuário diego@example.com. Este exemplo também inclui metadados para proteção contra ameaças e ClientMetadata para acionadores do Lambda. O usuário está configurado para MFA TOTP e recebe um desafio para fornecer um código da aplicação autenticadora antes de concluir a autenticação. ``` aws cognito-idp admin-initiate-auth \ --user-pool-id us-west-2_EXAMPLE \ --client-id 1example23456789 \ --auth-flow ADMIN_USER_PASSWORD_AUTH \ --auth-parameters USERNAME=diego@example.com,PASSWORD="My@Example$Password3!",SECRET_HASH=ExampleEncodedClientIdSecretAndUsername= \ --context-data="{\"EncodedData\":\"abc123example\",\"HttpHeaders\":[{\"headerName\":\"UserAgent\",\"headerValue\":\"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0\"}],\"IpAddress\":\"192.0.2.1\",\"ServerName\":\"example.com\",\"ServerPath\":\"/login\"}" \ --client-metadata="{\"MyExampleKey\": \"MyExampleValue\"}" ``` Resultado: ``` { "ChallengeName": "SOFTWARE_TOKEN_MFA", "Session": "AYABeExample...", "ChallengeParameters": { "FRIENDLY_DEVICE_NAME": "MyAuthenticatorApp", "USER_ID_FOR_SRP": "diego@example.com" } } ``` Consulte mais informações em [Fluxo de autenticação de administração](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow.html#amazon-cognito-user-pools-admin-authentication-flow) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [AdminInitiateAuth](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-initiate-auth.html) na *Referência de comandos da AWS CLI*. ### `admin-link-provider-for-user` O código de exemplo a seguir mostra como usar `admin-link-provider-for-user`. **AWS CLI** **Como vincular um usuário local a um usuário federado** O exemplo de `admin-link-provider-for-user` a seguir vincula o usuário local diego a um usuário que fará login federado com o Google. ``` aws cognito-idp admin-link-provider-for-user \ --user-pool-id us-west-2_EXAMPLE \ --destination-user ProviderName=Cognito,ProviderAttributeValue=diego \ --source-user ProviderAttributeName=Cognito_Subject,ProviderAttributeValue=0000000000000000,ProviderName=Google ``` Consulte mais informações em [Vincular usuários federados a um perfil de usuário existente](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [AdminLinkProviderForUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-link-provider-for-user.html) na *Referência de comandos da AWS CLI*. ### `admin-list-devices` O código de exemplo a seguir mostra como usar `admin-list-devices`. **AWS CLI** **Para listar dispositivos para um usuário** O exemplo de `admin-list-devices` a seguir lista dispositivos para o usuário diego. ``` aws cognito-idp admin-list-devices \ --user-pool-id us-west-2_EXAMPLE \ --username diego \ --limit 1 ``` Resultado: ``` { "Devices": [ { "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceAttributes": [ { "Name": "device_status", "Value": "valid" }, { "Name": "device_name", "Value": "MyDevice" }, { "Name": "dev:device_arn", "Value": "arn:aws:cognito-idp:us-west-2:123456789012:owner/diego.us-west-2_EXAMPLE/device/us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, { "Name": "dev:device_owner", "Value": "diego.us-west-2_EXAMPLE" }, { "Name": "last_ip_used", "Value": "192.0.2.1" }, { "Name": "dev:device_remembered_status", "Value": "remembered" }, { "Name": "dev:device_sdk", "Value": "aws-sdk" } ], "DeviceCreateDate": 1715100742.022, "DeviceLastModifiedDate": 1723233651.167, "DeviceLastAuthenticatedDate": 1715100742.0 } ] } ``` Consulte mais informações em [Trabalhar com dispositivos de usuários no grupo de usuários](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) no *Guia do desenvolvedor do Amazon Cognito*. + Para ver detalhes da API, consulte [AdminListDevices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-list-devices.html) na *Referência de comandos da AWS CLI*. ### `admin-list-groups-for-user` O código de exemplo a seguir mostra como usar `admin-list-groups-for-user`. **AWS CLI** **Para listar grupos para um usuário** Este exemplo lista grupos para o nome de usuário jane@example.com. Comando: ``` aws cognito-idp admin-list-groups-for-user --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com ``` Resultado: ``` { "Groups": [ { "Description": "Sample group", "Precedence": 1, "LastModifiedDate": 1548097827.125, "RoleArn": "arn:aws:iam::111111111111:role/SampleRole", "GroupName": "SampleGroup", "UserPoolId": "us-west-2_aaaaaaaaa", "CreationDate": 1548097827.125 } ] } ``` + Para ver detalhes da API, consulte [AdminListGroupsForUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-list-groups-for-user.html) na *Referência de comandos da AWS CLI*. ### `admin-list-user-auth-events` O código de exemplo a seguir mostra como usar `admin-list-user-auth-events`. **AWS CLI** **Para listar eventos de autorização para um usuário** O exemplo de `admin-list-user-auth-events` a seguir lista o evento de logs de atividades mais recentes do usuário diego. ``` aws cognito-idp admin-list-user-auth-events \ --user-pool-id us-west-2_ywDJHlIfU \ --username brcotter+050123 \ --max-results 1 ``` Resultado: ``` { "AuthEvents": [ { "EventId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "EventType": "SignIn", "CreationDate": 1726694203.495, "EventResponse": "InProgress", "EventRisk": { "RiskDecision": "AccountTakeover", "RiskLevel": "Medium", "CompromisedCredentialsDetected": false }, "ChallengeResponses": [ { "ChallengeName": "Password", "ChallengeResponse": "Success" } ], "EventContextData": { "IpAddress": "192.0.2.1", "City": "Seattle", "Country": "United States" } } ], "NextToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222#2024-09-18T21:16:43.495Z" } ``` Consulte mais informações em [Viewing and exporting user event history](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-event-user-history) no *Guia do desenvolvedor do Amazon Cognito*. + Para ver detalhes da API, consulte [AdminListUserAuthEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-list-user-auth-events.html) na *Referência de comandos da AWS CLI*. ### `admin-remove-user-from-group` O código de exemplo a seguir mostra como usar `admin-remove-user-from-group`. **AWS CLI** **Para remover um usuário de um grupo** Este exemplo remove jane@example.com do SampleGroup. Comando: ``` aws cognito-idp admin-remove-user-from-group --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com --group-name SampleGroup ``` + Para ver detalhes da API, consulte [AdminRemoveUserFromGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-remove-user-from-group.html) na *Referência de comandos da AWS CLI*. ### `admin-reset-user-password` O código de exemplo a seguir mostra como usar `admin-reset-user-password`. **AWS CLI** **Como redefinir uma senha do usuário** Este exemplo redefine a senha de diego@example.com. Comando: ``` aws cognito-idp admin-reset-user-password --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com ``` + Para ver detalhes da API, consulte [AdminResetUserPassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-reset-user-password.html) na *Referência de comandos da AWS CLI*. ### `admin-respond-to-auth-challenge` O código de exemplo a seguir mostra como usar `admin-respond-to-auth-challenge`. **AWS CLI** **Como responder a um desafio de autenticação** Há muitas maneiras de responder a diferentes desafios de autenticação, dependendo do fluxo de autenticação, da configuração do grupo de usuários e das configurações do usuário. O exemplo de `admin-respond-to-auth-challenge` a seguir fornece um código de MFA TOTP para diego@example.com e conclui o login. Esse grupo de usuários tem a memorização de dispositivos ativada, então o resultado da autenticação também retorna uma nova chave de dispositivo. ``` aws cognito-idp admin-respond-to-auth-challenge \ --user-pool-id us-west-2_EXAMPLE \ --client-id 1example23456789 \ --challenge-name SOFTWARE_TOKEN_MFA \ --challenge-responses USERNAME=diego@example.com,SOFTWARE_TOKEN_MFA_CODE=000000 \ --session AYABeExample... ``` Resultado: ``` { "ChallengeParameters": {}, "AuthenticationResult": { "AccessToken": "eyJra456defEXAMPLE", "ExpiresIn": 3600, "TokenType": "Bearer", "RefreshToken": "eyJra123abcEXAMPLE", "IdToken": "eyJra789ghiEXAMPLE", "NewDeviceMetadata": { "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceGroupKey": "-ExAmPlE1" } } } ``` Consulte mais informações em [Fluxo de autenticação de administração](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow.html#amazon-cognito-user-pools-admin-authentication-flow) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [AdminRespondToAuthChallenge](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-respond-to-auth-challenge.html) na *Referência de comandos da AWS CLI*. ### `admin-set-user-mfa-preference` O código de exemplo a seguir mostra como usar `admin-set-user-mfa-preference`. **AWS CLI** **Como definir a preferência de MFA do usuário** Este exemplo define a preferência de SMS MFA para o nome de usuário diego@example.com. Comando: ``` aws cognito-idp admin-set-user-mfa-preference --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --sms-mfa-settings Enabled=false,PreferredMfa=false ``` + Para ver detalhes da API, consulte [AdminSetUserMfaPreference](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-set-user-mfa-preference.html) na *Referência de comandos da AWS CLI*. ### `admin-set-user-password` O código de exemplo a seguir mostra como usar `admin-set-user-password`. **AWS CLI** **Como definir uma senha de usuário como administrador** O exemplo de `admin-set-user-password` a seguir define permanentemente a senha para diego@example.com. ``` aws cognito-idp admin-set-user-password \ --user-pool-id us-west-2_EXAMPLE \ --username diego@example.com \ --password MyExamplePassword1! \ --permanent ``` Este comando não produz saída. Consulte mais informações em [Passwords, password recovery, and password policies](https://docs.aws.amazon.com/cognito/latest/developerguide/managing-users-passwords.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [AdminSetUserPassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-set-user-password.html) na *Referência de comandos da AWS CLI*. ### `admin-set-user-settings` O código de exemplo a seguir mostra como usar `admin-set-user-settings`. **AWS CLI** **Como definir as configurações de usuário** Este exemplo define a preferência de entrega de MFA para o nome de usuário diego@example.com como EMAIL. Comando: ``` aws cognito-idp admin-set-user-settings --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --mfa-options DeliveryMedium=EMAIL ``` + Para ver detalhes da API, consulte [AdminSetUserSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-set-user-settings.html) na *Referência de comandos da AWS CLI*. ### `admin-update-auth-event-feedback` O código de exemplo a seguir mostra como usar `admin-update-auth-event-feedback`. **AWS CLI** **Como fornecer feedback sobre um evento de autorização** Este exemplo define o valor do feedback para um evento de autorização identificado pelo event-id como Valid. Comando: ``` aws cognito-idp admin-update-auth-event-feedback --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --event-id c2c2cf89-c0d3-482d-aba6-99d78a5b0bfe --feedback-value Valid ``` + Para ver detalhes da API, consulte [AdminUpdateAuthEventFeedback](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-update-auth-event-feedback.html) na *Referência de comandos da AWS CLI*. ### `admin-update-device-status` O código de exemplo a seguir mostra como usar `admin-update-device-status`. **AWS CLI** **Para atualizar o status do dispositivo** Este exemplo define o status do dispositivo lembrado para o dispositivo identificado pela chave do dispositivo como not\$1remembered. Comando: ``` aws cognito-idp admin-update-device-status --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --device-key xxxx --device-remembered-status not_remembered ``` + Para ver detalhes da API, consulte [AdminUpdateDeviceStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-update-device-status.html) na *Referência de comandos da AWS CLI*. ### `admin-update-user-attributes` O código de exemplo a seguir mostra como usar `admin-update-user-attributes`. **AWS CLI** **Para atualizar os atributos do usuário** Este exemplo atualiza um atributo de usuário personalizado CustomAttr1 para o usuário diego@example.com. Comando: ``` aws cognito-idp admin-update-user-attributes --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --user-attributes Name="custom:CustomAttr1",Value="Purple" ``` + Para ver detalhes da API, consulte [AdminUpdateUserAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-update-user-attributes.html) na *Referência de comandos da AWS CLI*. ### `admin-user-global-sign-out` O código de exemplo a seguir mostra como usar `admin-user-global-sign-out`. **AWS CLI** **Como um administrador encerra a sessão de um usuário** O exemplo de `admin-user-global-sign-out` a seguir encerra a sessão do usuário diego@example.com. ``` aws cognito-idp admin-user-global-sign-out \ --user-pool-id us-west-2_EXAMPLE \ --username diego@example.com ``` Consulte mais informações em [Autenticação com um grupo de usuários](https://docs.aws.amazon.com/cognito/latest/developerguide/authentication.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [AdminUserGlobalSignOut](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-user-global-sign-out.html) na *Referência de comandos da AWS CLI*. ### `associate-software-token` O código de exemplo a seguir mostra como usar `associate-software-token`. **AWS CLI** **Como gerar uma chave secreta para uma aplicação autenticadora de MFA** O exemplo de `associate-software-token` a seguir gera uma chave privada TOTP para um usuário que fez login e recebeu um token de acesso. A chave privada resultante pode ser inserida manualmente em uma aplicação autenticadora ou as aplicações podem renderizá-la como um código QR que o usuário pode escanear. ``` aws cognito-idp associate-software-token \ --access-token eyJra456defEXAMPLE ``` Resultado: ``` { "SecretCode": "QWERTYUIOP123456EXAMPLE" } ``` Consulte mais informações em [MFA de token de software TOTP](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa-totp.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [AssociateSoftwareToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/associate-software-token.html) na *Referência de comandos da AWS CLI*. ### `change-password` O código de exemplo a seguir mostra como usar `change-password`. **AWS CLI** **Para alterar uma senha** Este exemplo altera uma senha. Comando: ``` aws cognito-idp change-password --previous-password OldPassword --proposed-password NewPassword --access-token ACCESS_TOKEN ``` + Consulte detalhes da API em [ChangePassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/change-password.html) na *Referência de comandos da AWS CLI*. ### `confirm-device` O código de exemplo a seguir mostra como usar `confirm-device`. **AWS CLI** **Como confirmar um dispositivo de usuário** O exemplo de `confirm-device` a seguir adiciona um novo dispositivo memorizado para o usuário atual. ``` aws cognito-idp confirm-device \ --access-token eyJra456defEXAMPLE \ --device-key us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --device-secret-verifier-config PasswordVerifier=TXlWZXJpZmllclN0cmluZw,Salt=TXlTUlBTYWx0 ``` Resultado: ``` { "UserConfirmationNecessary": false } ``` Consulte mais informações em [Trabalhar com dispositivos de usuários no grupo de usuários](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [ConfirmDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/confirm-device.html) na *Referência de comandos da AWS CLI*. ### `confirm-forgot-password` O código de exemplo a seguir mostra como usar `confirm-forgot-password`. **AWS CLI** **Como confirmar uma senha esquecida** Este exemplo confirma a inscrição para o nome de usuário diego@example.com. Comando: ``` aws cognito-idp confirm-forgot-password --client-id 3n4b5urk1ft4fl3mg5e62d9ado --username=diego@example.com --password PASSWORD --confirmation-code CONF_CODE ``` + Para ver detalhes da API, consulte [ConfirmForgotPassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/confirm-forgot-password.html) na *Referência de comandos da AWS CLI*. ### `confirm-sign-up` O código de exemplo a seguir mostra como usar `confirm-sign-up`. **AWS CLI** **Como confirmar a inscrição** Este exemplo confirma a inscrição para o nome de usuário diego@example.com. Comando: ``` aws cognito-idp confirm-sign-up --client-id 3n4b5urk1ft4fl3mg5e62d9ado --username=diego@example.com --confirmation-code CONF_CODE ``` + Consulte detalhes da API em [ConfirmSignUp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/confirm-sign-up.html) na *Referência de comandos da AWS CLI*. ### `create-group` O código de exemplo a seguir mostra como usar `create-group`. **AWS CLI** **Para criar um grupo** Este exemplo cria um grupo com uma descrição. Comando: ``` aws cognito-idp create-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyNewGroup --description "New group." ``` Resultado: ``` { "Group": { "GroupName": "MyNewGroup", "UserPoolId": "us-west-2_aaaaaaaaa", "Description": "New group.", "LastModifiedDate": 1548270073.795, "CreationDate": 1548270073.795 } } ``` **Para criar um grupo com uma função e precedência** Este exemplo cria um grupo com uma descrição. Ele também inclui uma função e uma precedência. Comando: ``` aws cognito-idp create-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyNewGroupWithRole --description "New group with a role." --role-arn arn:aws:iam::111111111111:role/MyNewGroupRole --precedence 2 ``` Resultado: ``` { "Group": { "GroupName": "MyNewGroupWithRole", "UserPoolId": "us-west-2_aaaaaaaaa", "Description": "New group with a role.", "RoleArn": "arn:aws:iam::111111111111:role/MyNewGroupRole", "Precedence": 2, "LastModifiedDate": 1548270211.761, "CreationDate": 1548270211.761 } } ``` + Consulte detalhes da API em [CreateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/create-group.html) na *Referência de comandos da AWS CLI*. ### `create-identity-provider` O código de exemplo a seguir mostra como usar `create-identity-provider`. **AWS CLI** **Exemplo 1: como criar um provedor de identidades (IdP) SAML do grupo de usuários com um URL de metadados** O exemplo de `create-identity-provider` a seguir cria um IdP SAML com metadados de um URL público, mapeamento de atributos e dois identificadores. ``` aws cognito-idp create-identity-provider \ --user-pool-id us-west-2_EXAMPLE \ --provider-name MySAML \ --provider-type SAML \ --provider-details IDPInit=true,IDPSignout=true,EncryptedResponses=true,MetadataURL=https://auth.example.com/sso/saml/metadata,RequestSigningAlgorithm=rsa-sha256 \ --attribute-mapping email=emailaddress,phone_number=phone,custom:111=department \ --idp-identifiers CorpSAML WestSAML ``` Resultado: ``` { "IdentityProvider": { "UserPoolId": "us-west-2_EXAMPLE", "ProviderName": "MySAML", "ProviderType": "SAML", "ProviderDetails": { "ActiveEncryptionCertificate": "MIICvTCCAaEXAMPLE", "EncryptedResponses": "true", "IDPInit": "true", "IDPSignout": "true", "MetadataURL": "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm": "rsa-sha256", "SLORedirectBindingURI": "https://auth.example.com/slo/saml", "SSORedirectBindingURI": "https://auth.example.com/sso/saml" }, "AttributeMapping": { "custom:111": "department", "emailaddress": "email", "phone": "phone_number" }, "IdpIdentifiers": [ "CorpSAML", "WestSAML" ], "LastModifiedDate": 1726853833.977, "CreationDate": 1726853833.977 } } ``` Consulte mais informações em [Como adicionar acesso a grupo de usuários por meio de terceiros](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html) no *Guia do desenvolvedor do Amazon Cognito*. **Exemplo 2: como criar um provedor de identidades (IdP) SAML do grupo de usuários com um arquivo de metadados** O exemplo de `create-identity-provider` a seguir cria um IdP SAML com metadados de um arquivo, mapeamento de atributos e dois identificadores. A sintaxe do arquivo pode diferir entre os sistemas operacionais no parâmetro `--provider-details`. É mais fácil criar um arquivo de entrada JSON para esta operação: ``` aws cognito-idp create-identity-provider \ --cli-input-json file://.\SAML-identity-provider.json ``` Conteúdo de `SAML-identity-provider.json`: ``` { "AttributeMapping": { "email" : "idp_email", "email_verified" : "idp_email_verified" }, "IdpIdentifiers": [ "platform" ], "ProviderDetails": { "MetadataFile": "[IDP_CERTIFICATE_DATA]urn:oasis:names:tc:SAML:1.1:nameid-format:unspecifiedurn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", "IDPSignout" : "true", "RequestSigningAlgorithm" : "rsa-sha256", "EncryptedResponses" : "true", "IDPInit" : "true" }, "ProviderName": "MySAML2", "ProviderType": "SAML", "UserPoolId": "us-west-2_EXAMPLE" } ``` Resultado: ``` { "IdentityProvider": { "UserPoolId": "us-west-2_EXAMPLE", "ProviderName": "MySAML2", "ProviderType": "SAML", "ProviderDetails": { "ActiveEncryptionCertificate": "[USER_POOL_ENCRYPTION_CERTIFICATE_DATA]", "EncryptedResponses": "true", "IDPInit": "true", "IDPSignout": "true", "MetadataFile": "[IDP_CERTIFICATE_DATA]urn:oasis:names:tc:SAML:1.1:nameid-format:unspecifiedurn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", "RequestSigningAlgorithm": "rsa-sha256", "SLORedirectBindingURI": "https://www.example.com/slo/saml", "SSORedirectBindingURI": "https://www.example.com/sso/saml" }, "AttributeMapping": { "email": "idp_email", "email_verified": "idp_email_verified" }, "IdpIdentifiers": [ "platform" ], "LastModifiedDate": 1726855290.731, "CreationDate": 1726855290.731 } } ``` Consulte mais informações em [Como adicionar acesso a grupo de usuários por meio de terceiros](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [CreateIdentityProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/create-identity-provider.html) na *Referência de comandos da AWS CLI*. ### `create-resource-server` O código de exemplo a seguir mostra como usar `create-resource-server`. **AWS CLI** **Para criar um cliente de grupo de usuários** O exemplo de `create-resource-server` a seguir cria um servidor de recursos com escopos personalizados. ``` aws cognito-idp create-resource-server \ --user-pool-id us-west-2_EXAMPLE \ --identifier solar-system-data \ --name "Solar system object tracker" \ --scopes ScopeName=sunproximity.read,ScopeDescription="Distance in AU from Sol" ScopeName=asteroids.add,ScopeDescription="Enter a new asteroid" ``` Resultado: ``` { "ResourceServer": { "UserPoolId": "us-west-2_EXAMPLE", "Identifier": "solar-system-data", "Name": "Solar system object tracker", "Scopes": [ { "ScopeName": "sunproximity.read", "ScopeDescription": "Distance in AU from Sol" }, { "ScopeName": "asteroids.add", "ScopeDescription": "Enter a new asteroid" } ] } } ``` Consulte mais informações em [Scopes, M2M, and APIs with resource servers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [CreateResourceServer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/create-resource-server.html) na *Referência de comandos da AWS CLI*. ### `create-user-import-job` O código de exemplo a seguir mostra como usar `create-user-import-job`. **AWS CLI** **Para criar um trabalho de importação de usuário** Este exemplo cria um trabalho de importação de usuários chamado MyImportJob. Para obter mais informações sobre a importação de usuários, consulte como importar usuários para grupos de usuários de um arquivo CSV. Comando: ``` aws cognito-idp create-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-name MyImportJob --cloud-watch-logs-role-arn arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole ``` Resultado: ``` { "UserImportJob": { "JobName": "MyImportJob", "JobId": "import-qQ0DCt2fRh", "UserPoolId": "us-west-2_aaaaaaaaa", "PreSignedUrl": "PRE_SIGNED_URL", "CreationDate": 1548271795.471, "Status": "Created", "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", "ImportedUsers": 0, "SkippedUsers": 0, "FailedUsers": 0 } } ``` Faça upload do arquivo .csv com curl usando o URL pré-assinado: Comando: ``` curl -v -T "PATH_TO_CSV_FILE" -H "x-amz-server-side-encryption:aws:kms" "PRE_SIGNED_URL" ``` + Para ver detalhes da API, consulte [CreateUserImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/create-user-import-job.html) na *Referência de comandos da AWS CLI*. ### `create-user-pool-client` O código de exemplo a seguir mostra como usar `create-user-pool-client`. **AWS CLI** **Para criar um cliente de grupo de usuários** O exemplo de `create-user-pool-client` a seguir cria um cliente de grupo de usuários com um segredo de cliente, atributos explícitos de leitura e gravação, login com nome de usuário e senha e fluxos de SRP, login com três IdPs, acesso a um subconjunto de escopos do OAuth, analytics do PinPoint e uma validade estendida da sessão de autenticação. ``` aws cognito-idp create-user-pool-client \ --user-pool-id us-west-2_EXAMPLE \ --client-name MyTestClient \ --generate-secret \ --refresh-token-validity 10 \ --access-token-validity 60 \ --id-token-validity 60 \ --token-validity-units AccessToken=minutes,IdToken=minutes,RefreshToken=days \ --read-attributes email phone_number email_verified phone_number_verified \ --write-attributes email phone_number \ --explicit-auth-flows ALLOW_USER_PASSWORD_AUTH ALLOW_USER_SRP_AUTH ALLOW_REFRESH_TOKEN_AUTH \ --supported-identity-providers Google Facebook MyOIDC \ --callback-urls https://www.amazon.com https://example.com http://localhost:8001 myapp://example \ --allowed-o-auth-flows code implicit \ --allowed-o-auth-scopes openid profile aws.cognito.signin.user.admin solar-system-data/asteroids.add \ --allowed-o-auth-flows-user-pool-client \ --analytics-configuration ApplicationArn=arn:aws:mobiletargeting:us-west-2:767671399759:apps/thisisanexamplepinpointapplicationid,UserDataShared=TRUE \ --prevent-user-existence-errors ENABLED \ --enable-token-revocation \ --enable-propagate-additional-user-context-data \ --auth-session-validity 4 ``` Resultado: ``` { "UserPoolClient": { "UserPoolId": "us-west-2_EXAMPLE", "ClientName": "MyTestClient", "ClientId": "123abc456defEXAMPLE", "ClientSecret": "this1234is5678my91011example1213client1415secret", "LastModifiedDate": 1726788459.464, "CreationDate": 1726788459.464, "RefreshTokenValidity": 10, "AccessTokenValidity": 60, "IdTokenValidity": 60, "TokenValidityUnits": { "AccessToken": "minutes", "IdToken": "minutes", "RefreshToken": "days" }, "ReadAttributes": [ "email_verified", "phone_number_verified", "phone_number", "email" ], "WriteAttributes": [ "phone_number", "email" ], "ExplicitAuthFlows": [ "ALLOW_USER_PASSWORD_AUTH", "ALLOW_USER_SRP_AUTH", "ALLOW_REFRESH_TOKEN_AUTH" ], "SupportedIdentityProviders": [ "Google", "MyOIDC", "Facebook" ], "CallbackURLs": [ "https://example.com", "https://www.amazon.com", "myapp://example", "http://localhost:8001" ], "AllowedOAuthFlows": [ "implicit", "code" ], "AllowedOAuthScopes": [ "aws.cognito.signin.user.admin", "openid", "profile", "solar-system-data/asteroids.add" ], "AllowedOAuthFlowsUserPoolClient": true, "AnalyticsConfiguration": { "ApplicationArn": "arn:aws:mobiletargeting:us-west-2:123456789012:apps/thisisanexamplepinpointapplicationid", "RoleArn": "arn:aws:iam::123456789012:role/aws-service-role/cognito-idp.amazonaws.com/AWSServiceRoleForAmazonCognitoIdp", "UserDataShared": true }, "PreventUserExistenceErrors": "ENABLED", "EnableTokenRevocation": true, "EnablePropagateAdditionalUserContextData": true, "AuthSessionValidity": 4 } } ``` Consulte mais informações em [Application-specific settings with app clients](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [CreateUserPoolClient](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/create-user-pool-client.html) na *Referência de comandos da AWS CLI*. ### `create-user-pool-domain` O código de exemplo a seguir mostra como usar `create-user-pool-domain`. **AWS CLI** **Exemplo 1: como criar um domínio de grupo de usuários** O exemplo de `create-user-pool-domain` a seguir cria um domínio personalizado. ``` aws cognito-idp create-user-pool-domain \ --user-pool-id us-west-2_EXAMPLE \ --domain auth.example.com \ --custom-domain-config CertificateArn=arn:aws:acm:us-east-1:123456789012:certificate/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 ``` Resultado: ``` { "CloudFrontDomain": "example1domain.cloudfront.net" } ``` Consulte mais informações em [Como configurar um domínio de grupo de usuários](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html) no *Guia do desenvolvedor do Amazon Cognito*. **Exemplo 2: como criar um domínio de grupo de usuários** O exemplo de `create-user-pool-domain` a seguir cria um domínio com um prefixo de propriedade do serviço. ``` aws cognito-idp create-user-pool-domain \ --user-pool-id us-west-2_EXAMPLE2 \ --domain mydomainprefix ``` Consulte mais informações em [Como configurar um domínio de grupo de usuários](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html) no *Guia do desenvolvedor do Amazon Cognito*. + Para ver detalhes da API, consulte [CreateUserPoolDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/create-user-pool-domain.html) na *Referência de comandos da AWS CLI*. ### `create-user-pool` O código de exemplo a seguir mostra como usar `create-user-pool`. **AWS CLI** **Como criar um grupo de usuários minimamente configurado** Este exemplo cria um grupo de usuários chamado MyUserPool usando valores padrão. Não há atributos nem clientes da aplicação obrigatórios. A MFA e a segurança avançada estão desabilitadas. Comando: ``` aws cognito-idp create-user-pool --pool-name MyUserPool ``` Resultado: ``` { "UserPool": { "SchemaAttributes": [ { "Name": "sub", "StringAttributeConstraints": { "MinLength": "1", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": true, "AttributeDataType": "String", "Mutable": false }, { "Name": "name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "given_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "family_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "middle_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "nickname", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "preferred_username", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "profile", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "picture", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "website", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "email", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "AttributeDataType": "Boolean", "DeveloperOnlyAttribute": false, "Required": false, "Name": "email_verified", "Mutable": true }, { "Name": "gender", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "birthdate", "StringAttributeConstraints": { "MinLength": "10", "MaxLength": "10" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "zoneinfo", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "locale", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "phone_number", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "AttributeDataType": "Boolean", "DeveloperOnlyAttribute": false, "Required": false, "Name": "phone_number_verified", "Mutable": true }, { "Name": "address", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "updated_at", "NumberAttributeConstraints": { "MinValue": "0" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "Number", "Mutable": true } ], "MfaConfiguration": "OFF", "Name": "MyUserPool", "LastModifiedDate": 1547833345.777, "AdminCreateUserConfig": { "UnusedAccountValidityDays": 7, "AllowAdminCreateUserOnly": false }, "EmailConfiguration": {}, "Policies": { "PasswordPolicy": { "RequireLowercase": true, "RequireSymbols": true, "RequireNumbers": true, "MinimumLength": 8, "RequireUppercase": true } }, "CreationDate": 1547833345.777, "EstimatedNumberOfUsers": 0, "Id": "us-west-2_aaaaaaaaa", "LambdaConfig": {} } } ``` **Como criar um grupo de usuários com dois atributos obrigatórios** Este exemplo cria um grupo de usuários chamado MyUserPool. O grupo é configurado para aceitar o e-mail como o atributo de nome de usuário. Ele também define o endereço de origem do e-mail como um endereço validado usando o Amazon Simple Email Service. Comando: ``` aws cognito-idp create-user-pool --pool-name MyUserPool --username-attributes "email" --email-configuration=SourceArn="arn:aws:ses:us-east-1:111111111111:identity/jane@example.com",ReplyToEmailAddress="jane@example.com" ``` Resultado: ``` { "UserPool": { "SchemaAttributes": [ { "Name": "sub", "StringAttributeConstraints": { "MinLength": "1", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": true, "AttributeDataType": "String", "Mutable": false }, { "Name": "name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "given_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "family_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "middle_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "nickname", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "preferred_username", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "profile", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "picture", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "website", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "email", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "AttributeDataType": "Boolean", "DeveloperOnlyAttribute": false, "Required": false, "Name": "email_verified", "Mutable": true }, { "Name": "gender", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "birthdate", "StringAttributeConstraints": { "MinLength": "10", "MaxLength": "10" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "zoneinfo", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "locale", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "phone_number", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "AttributeDataType": "Boolean", "DeveloperOnlyAttribute": false, "Required": false, "Name": "phone_number_verified", "Mutable": true }, { "Name": "address", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "updated_at", "NumberAttributeConstraints": { "MinValue": "0" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "Number", "Mutable": true } ], "MfaConfiguration": "OFF", "Name": "MyUserPool", "LastModifiedDate": 1547837788.189, "AdminCreateUserConfig": { "UnusedAccountValidityDays": 7, "AllowAdminCreateUserOnly": false }, "EmailConfiguration": { "ReplyToEmailAddress": "jane@example.com", "SourceArn": "arn:aws:ses:us-east-1:111111111111:identity/jane@example.com" }, "Policies": { "PasswordPolicy": { "RequireLowercase": true, "RequireSymbols": true, "RequireNumbers": true, "MinimumLength": 8, "RequireUppercase": true } }, "UsernameAttributes": [ "email" ], "CreationDate": 1547837788.189, "EstimatedNumberOfUsers": 0, "Id": "us-west-2_aaaaaaaaa", "LambdaConfig": {} } } ``` + Consulte detalhes da API em [CreateUserPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/create-user-pool.html) na *Referência de comandos da AWS CLI*. ### `delete-group` O código de exemplo a seguir mostra como usar `delete-group`. **AWS CLI** **Para excluir um grupo** Este exemplo exclui um grupo. Comando: ``` aws cognito-idp delete-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyGroupName ``` + Consulte detalhes da API em [DeleteGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/delete-group.html) na *Referência de comandos da AWS CLI*. ### `delete-identity-provider` O código de exemplo a seguir mostra como usar `delete-identity-provider`. **AWS CLI** **Para excluir um provedor de identidade** Este exemplo exclui um provedor de identidades. Comando: ``` aws cognito-idp delete-identity-provider --user-pool-id us-west-2_aaaaaaaaa --provider-name Facebook ``` + Para ver detalhes da API, consulte [DeleteIdentityProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/delete-identity-provider.html) na *Referência de comandos da AWS CLI*. ### `delete-resource-server` O código de exemplo a seguir mostra como usar `delete-resource-server`. **AWS CLI** **Para excluir um servidor de recursos** Este exemplo exclui um servidor de recursos chamado weather.example.com. Comando: ``` aws cognito-idp delete-resource-server --user-pool-id us-west-2_aaaaaaaaa --identifier weather.example.com ``` + Para ver detalhes da API, consulte [DeleteResourceServer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/delete-resource-server.html) na *Referência de comandos da AWS CLI*. ### `delete-user-attributes` O código de exemplo a seguir mostra como usar `delete-user-attributes`. **AWS CLI** **Para excluir um atributo do usuário** O exemplo de `delete-user-attributes` a seguir exclui o atributo personalizado “custom:attribute” do usuário conectado no momento. ``` aws cognito-idp delete-user-attributes \ --access-token ACCESS_TOKEN \ --user-attribute-names "custom:department" ``` Este comando não produz saída. Consulte mais informações em [Trabalhar com atributos do usuário](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) no *Guia do desenvolvedor do Amazon Cognito*. + Para ver detalhes da API, consulte [DeleteUserAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/delete-user-attributes.html) na *Referência de comandos da AWS CLI*. ### `delete-user-pool-client` O código de exemplo a seguir mostra como usar `delete-user-pool-client`. **AWS CLI** **Para excluir um cliente do grupo de usuários** Este exemplo exclui um usuário do grupo de usuários. Comando: ``` aws cognito-idp delete-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-id 38fjsnc484p94kpqsnet7mpld0 ``` + Para ver detalhes da API, consulte [DeleteUserPoolClient](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/delete-user-pool-client.html) na *Referência de comandos da AWS CLI*. ### `delete-user-pool-domain` O código de exemplo a seguir mostra como usar `delete-user-pool-domain`. **AWS CLI** **Para excluir um domínio de grupo de usuários** O exemplo `delete-user-pool-domain` a seguir exclui um domínio do grupo de usuários chamado `my-domain` ``` aws cognito-idp delete-user-pool-domain \ --user-pool-id us-west-2_aaaaaaaaa \ --domain my-domain ``` + Para ver detalhes da API, consulte [DeleteUserPoolDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/delete-user-pool-domain.html) na *Referência de comandos da AWS CLI*. ### `delete-user-pool` O código de exemplo a seguir mostra como usar `delete-user-pool`. **AWS CLI** **Para excluir um grupo de usuários** Este exemplo exclui um grupo de usuários usando o ID do grupo de usuários, us-west-2\$1aaaaaaaaa. Comando: ``` aws cognito-idp delete-user-pool --user-pool-id us-west-2_aaaaaaaaa ``` + Para ver detalhes da API, consulte [DeleteUserPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/delete-user-pool.html) na *Referência de comandos da AWS CLI*. ### `delete-user` O código de exemplo a seguir mostra como usar `delete-user`. **AWS CLI** **Como excluir um usuário** Este exemplo exclui um usuário. Comando: ``` aws cognito-idp delete-user --access-token ACCESS_TOKEN ``` + Consulte detalhes da API em [DeleteUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/delete-user.html) na *Referência de comandos da AWS CLI*. ### `describe-identity-provider` O código de exemplo a seguir mostra como usar `describe-identity-provider`. **AWS CLI** **Para descrever um provedor de identidade** Este exemplo descreve um provedor de identidade chamado Facebook. Comando: ``` aws cognito-idp describe-identity-provider --user-pool-id us-west-2_aaaaaaaaa --provider-name Facebook ``` Resultado: ``` { "IdentityProvider": { "UserPoolId": "us-west-2_aaaaaaaaa", "ProviderName": "Facebook", "ProviderType": "Facebook", "ProviderDetails": { "attributes_url": "https://graph.facebook.com/me?fields=", "attributes_url_add_attributes": "true", "authorize_scopes": myscope", "authorize_url": "https://www.facebook.com/v2.9/dialog/oauth", "client_id": "11111", "client_secret": "11111", "token_request_method": "GET", "token_url": "https://graph.facebook.com/v2.9/oauth/access_token" }, "AttributeMapping": { "username": "id" }, "IdpIdentifiers": [], "LastModifiedDate": 1548105901.736, "CreationDate": 1548105901.736 } } ``` + Para ver detalhes da API, consulte [DescribeIdentityProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/describe-identity-provider.html) na *Referência de comandos da AWS CLI*. ### `describe-resource-server` O código de exemplo a seguir mostra como usar `describe-resource-server`. **AWS CLI** **Para descrever uma varredura de recursos** Este exemplo descreve o servidor de recursos weather.example.com. Comando: ``` aws cognito-idp describe-resource-server --user-pool-id us-west-2_aaaaaaaaa --identifier weather.example.com ``` Resultado: ``` { "ResourceServer": { "UserPoolId": "us-west-2_aaaaaaaaa", "Identifier": "weather.example.com", "Name": "Weather", "Scopes": [ { "ScopeName": "weather.update", "ScopeDescription": "Update weather forecast" }, { "ScopeName": "weather.read", "ScopeDescription": "Read weather forecasts" }, { "ScopeName": "weather.delete", "ScopeDescription": "Delete a weather forecast" } ] } } ``` + Para ver detalhes da API, consulte [DescribeResourceServer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/describe-resource-server.html) na *Referência de comandos da AWS CLI*. ### `describe-risk-configuration` O código de exemplo a seguir mostra como usar `describe-risk-configuration`. **AWS CLI** **Para descrever uma configuração de risco** Este exemplo descreve a configuração de risco associada ao grupo us-west-2\$1aaaaaaaaa. Comando: ``` aws cognito-idp describe-risk-configuration --user-pool-id us-west-2_aaaaaaaaa ``` Resultado: ``` { "RiskConfiguration": { "UserPoolId": "us-west-2_aaaaaaaaa", "CompromisedCredentialsRiskConfiguration": { "EventFilter": [ "SIGN_IN", "SIGN_UP", "PASSWORD_CHANGE" ], "Actions": { "EventAction": "BLOCK" } }, "AccountTakeoverRiskConfiguration": { "NotifyConfiguration": { "From": "diego@example.com", "ReplyTo": "diego@example.com", "SourceArn": "arn:aws:ses:us-east-1:111111111111:identity/diego@example.com", "BlockEmail": { "Subject": "Blocked sign-in attempt", "HtmlBody": "\n\n\n\tHTML email context\n\t\n\n\n
We blocked an unrecognized sign-in to your account with this information:\n
    \n
  • Time: {login-time}
    • \n
  • Device: {device-name}
    • \n
  • Location: {city}, {country}
    • \n
\nIf this sign-in was not by you, you should change your password and notify us by clicking on this link\nIf this sign-in was by you, you can follow this link to let us know
\n\n", "TextBody": "We blocked an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "NoActionEmail": { "Subject": "New sign-in attempt", "HtmlBody": "\n\n\n\tHTML email context\n\t\n\n\n
We observed an unrecognized sign-in to your account with this information:\n
    \n
  • Time: {login-time}
    • \n
  • Device: {device-name}
    • \n
  • Location: {city}, {country}
    • \n
\nIf this sign-in was not by you, you should change your password and notify us by clicking on this link\nIf this sign-in was by you, you can follow this link to let us know
\n\n", "TextBody": "We observed an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "MfaEmail": { "Subject": "New sign-in attempt", "HtmlBody": "\n\n\n\tHTML email context\n\t\n\n\n
We required you to use multi-factor authentication for the following sign-in attempt:\n
    \n
  • Time: {login-time}
    • \n
  • Device: {device-name}
    • \n
  • Location: {city}, {country}
    • \n
\nIf this sign-in was not by you, you should change your password and notify us by clicking on this link\nIf this sign-in was by you, you can follow this link to let us know
\n\n", "TextBody": "We required you to use multi-factor authentication for the following sign-in attempt:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" } }, "Actions": { "LowAction": { "Notify": true, "EventAction": "NO_ACTION" }, "MediumAction": { "Notify": true, "EventAction": "MFA_IF_CONFIGURED" }, "HighAction": { "Notify": true, "EventAction": "MFA_IF_CONFIGURED" } } } } } ``` + Para ver detalhes da API, consulte [DescribeRiskConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/describe-risk-configuration.html) na *Referência de comandos da AWS CLI*. ### `describe-user-import-job` O código de exemplo a seguir mostra como usar `describe-user-import-job`. **AWS CLI** **Para descrever um trabalho de importação do usuário** Este exemplo descreve um trabalho de entrada do usuário. Para obter mais informações sobre a importação de usuários, consulte como importar usuários para grupos de usuários de um arquivo CSV. Comando: ``` aws cognito-idp describe-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-id import-TZqNQvDRnW ``` Resultado: ``` { "UserImportJob": { "JobName": "import-Test1", "JobId": "import-TZqNQvDRnW", "UserPoolId": "us-west-2_aaaaaaaaa", "PreSignedUrl": "PRE_SIGNED URL", "CreationDate": 1548271708.512, "Status": "Created", "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", "ImportedUsers": 0, "SkippedUsers": 0, "FailedUsers": 0 } } ``` + Para ver detalhes da API, consulte [DescribeUserImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/describe-user-import-job.html) na *Referência de comandos da AWS CLI*. ### `describe-user-pool-client` O código de exemplo a seguir mostra como usar `describe-user-pool-client`. **AWS CLI** **Para descrever um cliente do grupo de usuários** Este exemplo descreve um cliente de grupo de usuários. Comando: ``` aws cognito-idp describe-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-id 38fjsnc484p94kpqsnet7mpld0 ``` Resultado: ``` { "UserPoolClient": { "UserPoolId": "us-west-2_aaaaaaaaa", "ClientName": "MyApp", "ClientId": "38fjsnc484p94kpqsnet7mpld0", "ClientSecret": "CLIENT_SECRET", "LastModifiedDate": 1548108676.163, "CreationDate": 1548108676.163, "RefreshTokenValidity": 30, "ReadAttributes": [ "address", "birthdate", "custom:CustomAttr1", "custom:CustomAttr2", "email", "email_verified", "family_name", "gender", "given_name", "locale", "middle_name", "name", "nickname", "phone_number", "phone_number_verified", "picture", "preferred_username", "profile", "updated_at", "website", "zoneinfo" ], "WriteAttributes": [ "address", "birthdate", "custom:CustomAttr1", "custom:CustomAttr2", "email", "family_name", "gender", "given_name", "locale", "middle_name", "name", "nickname", "phone_number", "picture", "preferred_username", "profile", "updated_at", "website", "zoneinfo" ], "ExplicitAuthFlows": [ "ADMIN_NO_SRP_AUTH", "USER_PASSWORD_AUTH" ], "AllowedOAuthFlowsUserPoolClient": false } } ``` + Para ver detalhes da API, consulte [DescribeUserPoolClient](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/describe-user-pool-client.html) na *Referência de comandos da AWS CLI*. ### `describe-user-pool-domain` O código de exemplo a seguir mostra como usar `describe-user-pool-domain`. **AWS CLI** **Para descrever um cliente do grupo de usuários** Este exemplo descreve um domínio de grupo de usuários chamado my-domain. Comando: ``` aws cognito-idp describe-user-pool-domain --domain my-domain ``` Resultado: ``` { "DomainDescription": { "UserPoolId": "us-west-2_aaaaaaaaa", "AWSAccountId": "111111111111", "Domain": "my-domain", "S3Bucket": "aws-cognito-prod-pdx-assets", "CloudFrontDistribution": "aaaaaaaaaaaaa.cloudfront.net", "Version": "20190128175402", "Status": "ACTIVE", "CustomDomainConfig": {} } } ``` + Para ver detalhes da API, consulte [DescribeUserPoolDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/describe-user-pool-domain.html) na *Referência de comandos da AWS CLI*. ### `describe-user-pool` O código de exemplo a seguir mostra como usar `describe-user-pool`. **AWS CLI** **Para descrever um grupo de usuários** O exemplo a seguir descreve um grupo de usuários com o ID de grupo de usuários us-west-2\$1EXAMPLE. ``` aws cognito-idp describe-user-pool \ --user-pool-id us-west-2_EXAMPLE ``` Resultado: ``` { "UserPool": { "Id": "us-west-2_EXAMPLE", "Name": "MyUserPool", "Policies": { "PasswordPolicy": { "MinimumLength": 8, "RequireUppercase": true, "RequireLowercase": true, "RequireNumbers": true, "RequireSymbols": true, "TemporaryPasswordValidityDays": 1 } }, "DeletionProtection": "ACTIVE", "LambdaConfig": { "PreSignUp": "arn:aws:lambda:us-west-2:123456789012:function:MyPreSignUpFunction", "CustomMessage": "arn:aws:lambda:us-west-2:123456789012:function:MyCustomMessageFunction", "PostConfirmation": "arn:aws:lambda:us-west-2:123456789012:function:MyPostConfirmationFunction", "PreAuthentication": "arn:aws:lambda:us-west-2:123456789012:function:MyPreAuthenticationFunction", "PostAuthentication": "arn:aws:lambda:us-west-2:123456789012:function:MyPostAuthenticationFunction", "DefineAuthChallenge": "arn:aws:lambda:us-west-2:123456789012:function:MyDefineAuthChallengeFunction", "CreateAuthChallenge": "arn:aws:lambda:us-west-2:123456789012:function:MyCreateAuthChallengeFunction", "VerifyAuthChallengeResponse": "arn:aws:lambda:us-west-2:123456789012:function:MyVerifyAuthChallengeFunction", "PreTokenGeneration": "arn:aws:lambda:us-west-2:123456789012:function:MyPreTokenGenerationFunction", "UserMigration": "arn:aws:lambda:us-west-2:123456789012:function:MyMigrateUserFunction", "PreTokenGenerationConfig": { "LambdaVersion": "V2_0", "LambdaArn": "arn:aws:lambda:us-west-2:123456789012:function:MyPreTokenGenerationFunction" }, "CustomSMSSender": { "LambdaVersion": "V1_0", "LambdaArn": "arn:aws:lambda:us-west-2:123456789012:function:MyCustomSMSSenderFunction" }, "CustomEmailSender": { "LambdaVersion": "V1_0", "LambdaArn": "arn:aws:lambda:us-west-2:123456789012:function:MyCustomEmailSenderFunction" }, "KMSKeyID": "arn:aws:kms:us-west-2:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" }, "LastModifiedDate": 1726784814.598, "CreationDate": 1602103465.273, "SchemaAttributes": [ { "Name": "sub", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": false, "Required": true, "StringAttributeConstraints": { "MinLength": "1", "MaxLength": "2048" } }, { "Name": "name", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "given_name", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "family_name", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "middle_name", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "nickname", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "preferred_username", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "profile", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "picture", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "website", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "email", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": true, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "email_verified", "AttributeDataType": "Boolean", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false }, { "Name": "gender", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "birthdate", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "10", "MaxLength": "10" } }, { "Name": "zoneinfo", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "locale", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "phone_number", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "phone_number_verified", "AttributeDataType": "Boolean", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false }, { "Name": "address", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "updated_at", "AttributeDataType": "Number", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "NumberAttributeConstraints": { "MinValue": "0" } }, { "Name": "identities", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": {} }, { "Name": "custom:111", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "1", "MaxLength": "256" } }, { "Name": "dev:custom:222", "AttributeDataType": "String", "DeveloperOnlyAttribute": true, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "1", "MaxLength": "421" } }, { "Name": "custom:accesstoken", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MaxLength": "2048" } }, { "Name": "custom:idtoken", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MaxLength": "2048" } } ], "AutoVerifiedAttributes": [ "email" ], "SmsVerificationMessage": "Your verification code is {####}. ", "EmailVerificationMessage": "Your verification code is {####}. ", "EmailVerificationSubject": "Your verification code", "VerificationMessageTemplate": { "SmsMessage": "Your verification code is {####}. ", "EmailMessage": "Your verification code is {####}. ", "EmailSubject": "Your verification code", "EmailMessageByLink": "Please click the link below to verify your email address. {##Verify Your Email##}\n this is from us-west-2_ywDJHlIfU", "EmailSubjectByLink": "Your verification link", "DefaultEmailOption": "CONFIRM_WITH_LINK" }, "SmsAuthenticationMessage": "Your verification code is {####}. ", "UserAttributeUpdateSettings": { "AttributesRequireVerificationBeforeUpdate": [] }, "MfaConfiguration": "OPTIONAL", "DeviceConfiguration": { "ChallengeRequiredOnNewDevice": true, "DeviceOnlyRememberedOnUserPrompt": false }, "EstimatedNumberOfUsers": 166, "EmailConfiguration": { "SourceArn": "arn:aws:ses:us-west-2:123456789012:identity/admin@example.com", "EmailSendingAccount": "DEVELOPER" }, "SmsConfiguration": { "SnsCallerArn": "arn:aws:iam::123456789012:role/service-role/userpool-SMS-Role", "ExternalId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "SnsRegion": "us-west-2" }, "UserPoolTags": {}, "Domain": "myCustomDomain", "CustomDomain": "auth.example.com", "AdminCreateUserConfig": { "AllowAdminCreateUserOnly": false, "UnusedAccountValidityDays": 1, "InviteMessageTemplate": { "SMSMessage": "Your username is {username} and temporary password is {####}. ", "EmailMessage": "Your username is {username} and temporary password is {####}. ", "EmailSubject": "Your temporary password" } }, "UserPoolAddOns": { "AdvancedSecurityMode": "ENFORCED", "AdvancedSecurityAdditionalFlows": {} }, "Arn": "arn:aws:cognito-idp:us-west-2:123456789012:userpool/us-west-2_EXAMPLE", "AccountRecoverySetting": { "RecoveryMechanisms": [ { "Priority": 1, "Name": "verified_email" } ] } } } ``` Para obter mais informações, consulte [Grupos de usuários do Amazon Cognito](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools.html) no *Guia do desenvolvedor do Amazon Cognito*. + Para ver detalhes da API, consulte [DescribeUserPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/describe-user-pool.html) na *Referência de comandos da AWS CLI*. ### `forget-device` O código de exemplo a seguir mostra como usar `forget-device`. **AWS CLI** **Como esquecer um dispositivo** Este exemplo esquece um dispositivo. Comando: ``` aws cognito-idp forget-device --device-key us-west-2_abcd_1234-5678 ``` + Para ver detalhes da API, consulte [ForgetDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/forget-device.html) na *Referência de comandos da AWS CLI*. ### `forgot-password` O código de exemplo a seguir mostra como usar `forgot-password`. **AWS CLI** **Como forçar uma alteração de senha** O `forgot-password` exemplo a seguir envia uma mensagem para jane@example.com para alterar a senha. ``` aws cognito-idp forgot-password --client-id 38fjsnc484p94kpqsnet7mpld0 --username jane@example.com ``` Resultado: ``` { "CodeDeliveryDetails": { "Destination": "j***@e***.com", "DeliveryMedium": "EMAIL", "AttributeName": "email" } } ``` + Para ver detalhes da API, consulte [ForgotPassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/forgot-password.html) na *Referência de comandos da AWS CLI*. ### `get-csv-header` O código de exemplo a seguir mostra como usar `get-csv-header`. **AWS CLI** **Para criar um cabeçalho csv** Este exemplo cria um cabeçalho csv. Para obter mais informações sobre a importação de usuários, consulte como importar usuários para grupos de usuários de um arquivo CSV. Comando: ``` aws cognito-idp get-csv-header --user-pool-id us-west-2_aaaaaaaaa ``` Resultado: ``` { "UserPoolId": "us-west-2_aaaaaaaaa", "CSVHeader": [ "name", "given_name", "family_name", "middle_name", "nickname", "preferred_username", "profile", "picture", "website", "email", "email_verified", "gender", "birthdate", "zoneinfo", "locale", "phone_number", "phone_number_verified", "address", "updated_at", "cognito:mfa_enabled", "cognito:username" ] } ``` ... Importação de usuários para grupos de usuários a partir de um arquivo CSV: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html + Para ver detalhes da API, consulte [GetCsvHeader](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-csv-header.html) na *Referência de comandos da AWS CLI*. ### `get-device` O código de exemplo a seguir mostra como usar `get-device`. **AWS CLI** **Para obter um dispositivo** O exemplo de `get-device` a seguir exibe um dispositivo para o usuário conectado no momento. ``` aws cognito-idp get-device \ --access-token eyJra456defEXAMPLE \ --device-key us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "Device": { "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceAttributes": [ { "Name": "device_status", "Value": "valid" }, { "Name": "device_name", "Value": "MyDevice" }, { "Name": "dev:device_arn", "Value": "arn:aws:cognito-idp:us-west-2:123456789012:owner/diego.us-west-2_EXAMPLE/device/us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, { "Name": "dev:device_owner", "Value": "diego.us-west-2_EXAMPLE" }, { "Name": "last_ip_used", "Value": "192.0.2.1" }, { "Name": "dev:device_remembered_status", "Value": "remembered" }, { "Name": "dev:device_sdk", "Value": "aws-sdk" } ], "DeviceCreateDate": 1715100742.022, "DeviceLastModifiedDate": 1723233651.167, "DeviceLastAuthenticatedDate": 1715100742.0 } } ``` Consulte mais informações em [Trabalhar com dispositivos de usuários no grupo de usuários](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [GetDevices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-device.html) na *Referência de comandos da AWS CLI*. ### `get-group` O código de exemplo a seguir mostra como usar `get-group`. **AWS CLI** **Para obter informações sobre um grupo** O exemplo de `get-group` a seguir lista as propriedades do grupo de usuários chamado `MyGroup`. Esse grupo tem uma precedência e um perfil do IAM associado a ele. ``` aws cognito-idp get-group \ --user-pool-id us-west-2_EXAMPLE \ --group-name MyGroup ``` Resultado: ``` { "Group": { "GroupName": "MyGroup", "UserPoolId": "us-west-2_EXAMPLE", "RoleArn": "arn:aws:iam::123456789012:role/example-cognito-role", "Precedence": 7, "LastModifiedDate": 1697211218.305, "CreationDate": 1611685503.954 } } ``` Consulte mais informações em [Adding groups to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-user-groups.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [GetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-group.html) na *Referência de comandos da AWS CLI*. ### `get-identity-provider-by-identifier` O código de exemplo a seguir mostra como usar `get-identity-provider-by-identifier`. **AWS CLI** **Como obter a configuração de um provedor de identidade por meio do identificador de IdP** O exemplo de `get-identity-provider-by-identifier` a seguir retorna a configuração do provedor de identidades com o identificador `mysso`. ``` aws cognito-idp get-identity-provider-by-identifier \ --user-pool-id us-west-2_EXAMPLE \ --idp-identifier mysso ``` Resultado: ``` { "IdentityProvider": { "UserPoolId": "us-west-2_EXAMPLE", "ProviderName": "MYSAML", "ProviderType": "SAML", "ProviderDetails": { "ActiveEncryptionCertificate": "[Certificate contents]", "IDPSignout": "false", "MetadataURL": "https://auth.example.com/saml/metadata/", "SLORedirectBindingURI": "https://auth.example.com/saml/logout/", "SSORedirectBindingURI": "https://auth.example.com/saml/assertion/" }, "AttributeMapping": { "email": "email" }, "IdpIdentifiers": [ "mysso", "mysamlsso" ], "LastModifiedDate": 1705616729.188, "CreationDate": 1643734622.919 } } ``` Consulte mais informações em [Third-party IdP sign-in](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [GetIdentityProviderByIdentifier](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-identity-provider-by-identifier.html) na *Referência de comandos da AWS CLI*. ### `get-log-delivery-configuration` O código de exemplo a seguir mostra como usar `get-log-delivery-configuration`. **AWS CLI** **Como exibir a configuração de entrega de logs** O exemplo de `get-log-delivery-configuration` a seguir exibe as configurações de exportação de logs do grupo de usuários solicitado. ``` aws cognito-idp get-log-delivery-configuration \ --user-pool-id us-west-2_EXAMPLE ``` Resultado: ``` { "LogDeliveryConfiguration": { "UserPoolId": "us-west-2_EXAMPLE", "LogConfigurations": [ { "LogLevel": "INFO", "EventSource": "userAuthEvents", "FirehoseConfiguration": { "StreamArn": "arn:aws:firehose:us-west-2:123456789012:deliverystream/my-test-deliverystream" } }, { "LogLevel": "ERROR", "EventSource": "userNotification", "CloudWatchLogsConfiguration": { "LogGroupArn": "arn:aws:logs:us-west-2:123456789012:log-group:my-message-delivery-logs" } } ] } } ``` Consulte mais informações em [Exporting user pool logs](https://docs.aws.amazon.com/cognito/latest/developerguide/exporting-quotas-and-usage.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [GetLogDeliveryConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-log-delivery-configuration.html) na *Referência de comandos da AWS CLI*. ### `get-signing-certificate` O código de exemplo a seguir mostra como usar `get-signing-certificate`. **AWS CLI** **Como exibir o certificado de assinatura SAML** O exemplo de `get-signing-certificate` a seguir exibe o certificado de assinatura SAML 2.0 para o grupo de usuários solicitado. ``` aws cognito-idp get-signing-certificate \ --user-pool-id us-west-2_EXAMPLE ``` Resultado: ``` { "Certificate": "[Certificate content]" } ``` Consulte mais informações em [SAML signing and encryption](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-SAML-signing-encryption.html) no *Guia do desenvolvedor do Amazon Cognito*. + Para ver detalhes da API, consulte [GetSigningCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-signing-certificate.html) na *Referência de comandos da AWS CLI*. ### `get-ui-customization` O código de exemplo a seguir mostra como usar `get-ui-customization`. **AWS CLI** **Como exibir as configurações clássicas de personalização da interface de usuário hospedada para um cliente de aplicação** O exemplo de `get-ui-customization` a seguir exibe as configurações clássicas de personalização da interface do usuário hospedada para um cliente de aplicação que não herda as configurações do grupo de usuários. ``` aws cognito-idp get-ui-customization \ --user-pool-id us-west-2_EXAMPLE \ --client-id 1example23456789 ``` Resultado: ``` { "UICustomization": { "UserPoolId": "us-west-2_EXAMPLE", "ClientId": "1example23456789", "ImageUrl": "https://example.cloudfront.net/us-west-2_EXAMPLE/1example23456789/20250115191928/assets/images/image.jpg", "CSS": "\n.logo-customizable {\n max-width: 80%;\n max-height: 30%;\n}\n\n.banner-customizable {\n padding: 25px 0px 25px 0px;\n background-color: lightgray;\n}\n\n.label-customizable {\n font-weight: 400;\n}\n\n.textDescription-customizable {\n padding-top: 100px;\n padding-bottom: 10px;\n display: block;\n font-size: 12px;\n}\n\n.idpDescription-customizable {\n padding-top: 10px;\n padding-bottom: 10px;\n display: block;\n font-size: 16px;\n}\n\n.legalText-customizable {\n color: #747474;\n font-size: 11px;\n}\n\n.submitButton-customizable {\n font-size: 14px;\n font-weight: bold;\n margin: 20px 0px 10px 0px;\n height: 50px;\n width: 100%;\n color: #fff;\n background-color: #337ab7;\n}\n\n.submitButton-customizable:hover {\n color: #fff;\n background-color: #286090;\n}\n\n.errorMessage-customizable {\n padding: 5px;\n font-size: 12px;\n width: 100%;\n background: #F5F5F5;\n border: 2px solid #D64958;\n color: #D64958;\n}\n\n.inputField-customizable {\n width: 100%;\n height: 34px;\n color: #555;\n background-color: #fff;\n border: 1px solid #ccc;\n}\n\n.inputField-customizable:focus {\n border-color: #66afe9;\n outline: 0;\n}\n\n.idpButton-customizable {\n height: 40px;\n width: 100%;\n width: 100%;\n text-align: center;\n margin-bottom: 15px;\n color: #fff;\n background-color: #5bc0de;\n border-color: #46b8da;\n}\n\n.idpButton-customizable:hover {\n color: #fff;\n background-color: #31b0d5;\n}\n\n.socialButton-customizable {\n border-radius: 2px;\n height: 60px;\n margin-bottom: 15px;\n padding: 1px;\n text-align: left;\n width: 100%;\n}\n\n.redirect-customizable {\n text-align: center;\n}\n\n.passwordCheck-notValid-customizable {\n color: #DF3312;\n}\n\n.passwordCheck-valid-customizable {\n color: #19BF00;\n}\n\n.background-customizable {\n background-color: #fff;\n}\n", "CSSVersion": "20250115191928" } } ``` Consulte mais informações em [Hosted UI (classic) branding](https://docs.aws.amazon.com/cognito/latest/developerguide/hosted-ui-classic-branding.html) no *Guia do desenvolvedor do Amazon Cognito*. + Para ver detalhes da API, consulte [GetUiCustomization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-ui-customization.html) na *Referência de comandos da AWS CLI*. ### `get-user-attribute-verification-code` O código de exemplo a seguir mostra como usar `get-user-attribute-verification-code`. **AWS CLI** **Como enviar um código de verificação de atributo ao usuário atual** O exemplo de `get-user-attribute-verification-code` a seguir envia um código de verificação de atributo para o endereço de e-mail do usuário atualmente conectado. ``` aws cognito-idp get-user-attribute-verification-code \ --access-token eyJra456defEXAMPLE \ --attribute-name email ``` Resultado: ``` { "CodeDeliveryDetails": { "Destination": "a***@e***", "DeliveryMedium": "EMAIL", "AttributeName": "email" } } ``` Para obter mais informações, consulte [Como cadastrar e confirmar contas de usuários](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [GetUserAttributeVerificationCode](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-user-attribute-verification-code.html) na *Referência de comandos da AWS CLI*. ### `get-user-auth-factors` O código de exemplo a seguir mostra como usar `get-user-auth-factors`. **AWS CLI** **Como listar os fatores de autenticação disponíveis para o usuário atual** O exemplo de `get-user-auth-factors` a seguir lista os fatores de autenticação disponíveis para o usuário atualmente conectado. ``` aws cognito-idp get-user-auth-factors \ --access-token eyJra456defEXAMPLE ``` Resultado: ``` { "Username": "testuser", "ConfiguredUserAuthFactors": [ "PASSWORD", "EMAIL_OTP", "SMS_OTP", "WEB_AUTHN" ] } ``` Consulte mais informações em [Authentication](https://docs.aws.amazon.com/cognito/latest/developerguide/authentication.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [GetUserAuthFactors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-user-auth-factors.html) na *Referência de comandos da AWS CLI*. ### `get-user-pool-mfa-config` O código de exemplo a seguir mostra como usar `get-user-pool-mfa-config`. **AWS CLI** **Como exibir as configurações de autenticação multifator e WebAuthn de um grupo de usuários** O exemplo de `get-user-pool-mfa-config` a seguir exibe a configuração de MFA e WebAuthn do grupo de usuários solicitado. ``` aws cognito-idp get-user-pool-mfa-config \ --user-pool-id us-west-2_EXAMPLE ``` Resultado: ``` { "SmsMfaConfiguration": { "SmsAuthenticationMessage": "Your OTP for MFA or sign-in: use {####}.", "SmsConfiguration": { "SnsCallerArn": "arn:aws:iam::123456789012:role/service-role/my-SMS-Role", "ExternalId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "SnsRegion": "us-west-2" } }, "SoftwareTokenMfaConfiguration": { "Enabled": true }, "EmailMfaConfiguration": { "Message": "Your OTP for MFA or sign-in: use {####}", "Subject": "OTP test" }, "MfaConfiguration": "OPTIONAL", "WebAuthnConfiguration": { "RelyingPartyId": "auth.example.com", "UserVerification": "preferred" } } ``` Consulte mais informações em [Adding MFA](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [GetUserPoolMfaConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-user-pool-mfa-config.html) na *Referência de comandos da AWS CLI*. ### `get-user` O código de exemplo a seguir mostra como usar `get-user`. **AWS CLI** **Como obter os detalhes do usuário atual** O exemplo de `get-user` a seguir exibe o perfil do usuário atualmente conectado. ``` aws cognito-idp get-user \ --access-token eyJra456defEXAMPLE ``` Resultado: ``` { "Username": "johndoe", "UserAttributes": [ { "Name": "sub", "Value": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, { "Name": "identities", "Value": "[{\"userId\":\"a1b2c3d4-5678-90ab-cdef-EXAMPLE22222\",\"providerName\":\"SignInWithApple\",\"providerType\":\"SignInWithApple\",\"issuer\":null,\"primary\":false,\"dateCreated\":1701125599632}]" }, { "Name": "email_verified", "Value": "true" }, { "Name": "custom:state", "Value": "Maine" }, { "Name": "name", "Value": "John Doe" }, { "Name": "phone_number_verified", "Value": "true" }, { "Name": "phone_number", "Value": "+12065551212" }, { "Name": "preferred_username", "Value": "jamesdoe" }, { "Name": "locale", "Value": "EMEA" }, { "Name": "email", "Value": "jamesdoe@example.com" } ] } ``` Consulte mais informações em [Como gerenciar usuários](https://docs.aws.amazon.com/cognito/latest/developerguide/managing-users.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [GetUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-user.html) na *Referência de comandos da AWS CLI*. ### `global-sign-out` O código de exemplo a seguir mostra como usar `global-sign-out`. **AWS CLI** **Como desconectar o usuário atual** O exemplo de `global-sign-out` a seguir desconecta o usuário atual. ``` aws cognito-idp global-sign-out \ --access-token eyJra456defEXAMPLE ``` Este comando não produz saída. Consulte mais informações em [Como gerenciar usuários](https://docs.aws.amazon.com/cognito/latest/developerguide/managing-users.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [GlobalSignOut](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/global-sign-out.html) na *Referência de comandos da AWS CLI*. ### `initiate-auth` O código de exemplo a seguir mostra como usar `initiate-auth`. **AWS CLI** **Como conectar um usuário** O exemplo de `initiate-auth` a seguir conecta um usuário com o fluxo básico de nome de usuário e senha e sem desafios adicionais. ``` aws cognito-idp initiate-auth \ --auth-flow USER_PASSWORD_AUTH \ --client-id 1example23456789 \ --analytics-metadata AnalyticsEndpointId=d70b2ba36a8c4dc5a04a0451aEXAMPLE \ --auth-parameters USERNAME=testuser,PASSWORD=[Password] --user-context-data EncodedData=mycontextdata --client-metadata MyTestKey=MyTestValue ``` Resultado: ``` { "AuthenticationResult": { "AccessToken": "eyJra456defEXAMPLE", "ExpiresIn": 3600, "TokenType": "Bearer", "RefreshToken": "eyJra123abcEXAMPLE", "IdToken": "eyJra789ghiEXAMPLE", "NewDeviceMetadata": { "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceGroupKey": "-v7w9UcY6" } } } ``` Consulte mais informações em [Authentication](https://docs.aws.amazon.com/cognito/latest/developerguide/authentication.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [InitiateAuth](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/initiate-auth.html) na *Referência de comandos da AWS CLI*. ### `list-devices` O código de exemplo a seguir mostra como usar `list-devices`. **AWS CLI** **Como listar dispositivos de um usuário** O exemplo de `list-devices` a seguir lista os dispositivos que o usuário atual registrou. ``` aws cognito-idp list-devices \ --access-token eyJra456defEXAMPLE ``` Resultado: ``` { "Devices": [ { "DeviceAttributes": [ { "Name": "device_status", "Value": "valid" }, { "Name": "device_name", "Value": "Dart-device" }, { "Name": "last_ip_used", "Value": "192.0.2.1" } ], "DeviceCreateDate": 1715100742.022, "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceLastAuthenticatedDate": 1715100742.0, "DeviceLastModifiedDate": 1723233651.167 }, { "DeviceAttributes": [ { "Name": "device_status", "Value": "valid" }, { "Name": "last_ip_used", "Value": "192.0.2.2" } ], "DeviceCreateDate": 1726856147.993, "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "DeviceLastAuthenticatedDate": 1726856147.0, "DeviceLastModifiedDate": 1726856147.993 } ] } ``` Consulte mais informações em [Working with devices](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) no *Guia do desenvolvedor do Amazon Cognito*. + Para ver detalhes da API, consulte [ListDevices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-devices.html) na *Referência de comandos da AWS CLI*. ### `list-groups` O código de exemplo a seguir mostra como usar `list-groups`. **AWS CLI** **Como listar os grupos em um grupo de usuários** O exemplo de `list-groups` a seguir lista os dois primeiros grupos no grupo de usuários solicitado. ``` aws cognito-idp list-groups \ --user-pool-id us-west-2_EXAMPLE \ --max-items 2 ``` Resultado: ``` { "Groups": [ { "CreationDate": 1681760899.633, "Description": "My test group", "GroupName": "testgroup", "LastModifiedDate": 1681760899.633, "Precedence": 1, "UserPoolId": "us-west-2_EXAMPLE" }, { "CreationDate": 1642632749.051, "Description": "Autogenerated group for users who sign in using Facebook", "GroupName": "us-west-2_EXAMPLE_Facebook", "LastModifiedDate": 1642632749.051, "UserPoolId": "us-west-2_EXAMPLE" } ], "NextToken": "[Pagination token]" } ``` Consulte mais informações em [Adding groups to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-user-groups.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [ListGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-groups.html) na *Referência de comandos da AWS CLI*. ### `list-identity-providers` O código de exemplo a seguir mostra como usar `list-identity-providers`. **AWS CLI** **Como listar provedores de identidades** O exemplo de `list-identity-providers` a seguir lista os dois primeiros provedores de identidades no grupo de usuários solicitado. ``` aws cognito-idp list-identity-providers \ --user-pool-id us-west-2_EXAMPLE \ --max-items 2 ``` Resultado: ``` { "Providers": [ { "CreationDate": 1619477386.504, "LastModifiedDate": 1703798328.142, "ProviderName": "Azure", "ProviderType": "SAML" }, { "CreationDate": 1642698776.175, "LastModifiedDate": 1642699086.453, "ProviderName": "LoginWithAmazon", "ProviderType": "LoginWithAmazon" } ], "NextToken": "[Pagination token]" } ``` Consulte mais informações em [Third-party IdP sign-in](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [ListIdentityProviders](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-identity-providers.html) na *Referência de comandos da AWS CLI*. ### `list-resource-servers` O código de exemplo a seguir mostra como usar `list-resource-servers`. **AWS CLI** **Como listar servidores de recursos** O exemplo de `list-resource-servers` a seguir lista os dois primeiros servidores de recursos no grupo de usuários solicitado. ``` aws cognito-idp list-resource-servers \ --user-pool-id us-west-2_EXAMPLE \ --max-results 2 ``` Resultado: ``` { "ResourceServers": [ { "Identifier": "myapi.example.com", "Name": "Example API with custom access control scopes", "Scopes": [ { "ScopeDescription": "International customers", "ScopeName": "international.read" }, { "ScopeDescription": "Domestic customers", "ScopeName": "domestic.read" } ], "UserPoolId": "us-west-2_EXAMPLE" }, { "Identifier": "myapi2.example.com", "Name": "Another example API for access control", "Scopes": [ { "ScopeDescription": "B2B customers", "ScopeName": "b2b.read" } ], "UserPoolId": "us-west-2_EXAMPLE" } ], "NextToken": "[Pagination token]" } ``` Consulte mais informações em [Access control with resource servers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [ListResourceServers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-resource-servers.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Como listar as tags do grupo de usuários** O exemplo de `list-tags-for-resource` a seguir lista as tags atribuídas ao grupo de usuários com o ARN solicitado. ``` aws cognito-idp list-tags-for-resource \ --resource-arn arn:aws:cognito-idp:us-west-2:123456789012:userpool/us-west-2_EXAMPLE ``` Resultado: ``` { "Tags": { "administrator": "Jie", "tenant": "ExampleCorp" } } ``` Consulte mais informações em [Tagging Amazon Cognito resources](https://docs.aws.amazon.com/cognito/latest/developerguide/tagging.html) no *Guia do desenvolvedor do Amazon Cognito*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `list-user-import-jobs` O código de exemplo a seguir mostra como usar `list-user-import-jobs`. **AWS CLI** **Como listar trabalhos e status de importação de usuários** O exemplo de `list-user-import-jobs` a seguir lista os três primeiros trabalhos de importação de usuários e seus detalhes no grupo de usuários solicitado. ``` aws cognito-idp list-user-import-jobs \ --user-pool-id us-west-2_EXAMPLE \ --max-results 3 ``` Resultado: ``` { "PaginationToken": "us-west-2_EXAMPLE#import-example3#1667948397084", "UserImportJobs": [ { "CloudWatchLogsRoleArn": "arn:aws:iam::123456789012:role/service-role/Cognito-UserImport-Role", "CompletionDate": 1735329786.142, "CompletionMessage": "The user import job has expired.", "CreationDate": 1735241621.022, "FailedUsers": 0, "ImportedUsers": 0, "JobId": "import-example1", "JobName": "Test-import-job-1", "PreSignedUrl": "https://aws-cognito-idp-user-import-pdx.s3.us-west-2.amazonaws.com/123456789012/us-west-2_EXAMPLE/import-mAgUtd8PMm?X-Amz-Security-Token=[token]&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241226T193341Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=[credential]&X-Amz-Signature=[signature]", "SkippedUsers": 0, "Status": "Expired", "UserPoolId": "us-west-2_EXAMPLE" }, { "CloudWatchLogsRoleArn": "arn:aws:iam::123456789012:role/service-role/Cognito-UserImport-Role", "CompletionDate": 1681509058.408, "CompletionMessage": "Too many users have failed or been skipped during the import.", "CreationDate": 1681509001.477, "FailedUsers": 1, "ImportedUsers": 0, "JobId": "import-example2", "JobName": "Test-import-job-2", "PreSignedUrl": "https://aws-cognito-idp-user-import-pdx.s3.us-west-2.amazonaws.com/123456789012/us-west-2_EXAMPLE/import-mAgUtd8PMm?X-Amz-Security-Token=[token]&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241226T193341Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=[credential]&X-Amz-Signature=[signature]", "SkippedUsers": 0, "StartDate": 1681509057.965, "Status": "Failed", "UserPoolId": "us-west-2_EXAMPLE" }, { "CloudWatchLogsRoleArn": "arn:aws:iam::123456789012:role/service-role/Cognito-UserImport-Role", "CompletionDate": 1.667864578676E9, "CompletionMessage": "Import Job Completed Successfully.", "CreationDate": 1.667864480281E9, "FailedUsers": 0, "ImportedUsers": 6, "JobId": "import-example3", "JobName": "Test-import-job-3", "PreSignedUrl": "https://aws-cognito-idp-user-import-pdx.s3.us-west-2.amazonaws.com/123456789012/us-west-2_EXAMPLE/import-mAgUtd8PMm?X-Amz-Security-Token=[token]&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241226T193341Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=[credential]&X-Amz-Signature=[signature]", "SkippedUsers": 0, "StartDate": 1.667864578167E9, "Status": "Succeeded", "UserPoolId": "us-west-2_EXAMPLE" } ] } ``` Consulte mais informações em [Importing users from a CSV file](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html) no *Guia do desenvolvedor do Amazon Cognito*. + Para ver detalhes da API, consulte [ListUserImportJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-user-import-jobs.html) na *Referência de comandos da AWS CLI*. ### `list-user-pool-clients` O código de exemplo a seguir mostra como usar `list-user-pool-clients`. **AWS CLI** **Como listar clientes de aplicações** O exemplo de `list-user-pool-clients` a seguir lista os três primeiros clientes de aplicações no grupo de usuários solicitado. ``` aws cognito-idp list-user-pool-clients \ --user-pool-id us-west-2_EXAMPLE \ --max-results 3 ``` Resultado: ``` { "NextToken": "[Pagination token]", "UserPoolClients": [ { "ClientId": "1example23456789", "ClientName": "app-client-1", "UserPoolId": "us-west-2_EXAMPLE" }, { "ClientId": "2example34567890", "ClientName": "app-client-2", "UserPoolId": "us-west-2_EXAMPLE" }, { "ClientId": "3example45678901", "ClientName": "app-client-3", "UserPoolId": "us-west-2_EXAMPLE" } ] } ``` Consulte mais informações em [App clients](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [ListUserPoolClients](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-user-pool-clients.html) na *Referência de comandos da AWS CLI*. ### `list-user-pools` O código de exemplo a seguir mostra como usar `list-user-pools`. **AWS CLI** **Para listar grupos de usuários** O exemplo de `list-user-pools` a seguir lista três dos grupos de usuários disponíveis na conta da AWS das credenciais atuais da CLI. ``` aws cognito-idp list-user-pools \ --max-results 3 ``` Resultado: ``` { "NextToken": "[Pagination token]", "UserPools": [ { "CreationDate": 1681502497.741, "Id": "us-west-2_EXAMPLE1", "LambdaConfig": { "CustomMessage": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", "PreSignUp": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", "PreTokenGeneration": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", "PreTokenGenerationConfig": { "LambdaArn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", "LambdaVersion": "V1_0" } }, "LastModifiedDate": 1681502497.741, "Name": "user pool 1" }, { "CreationDate": 1686064178.717, "Id": "us-west-2_EXAMPLE2", "LambdaConfig": { }, "LastModifiedDate": 1686064178.873, "Name": "user pool 2" }, { "CreationDate": 1627681712.237, "Id": "us-west-2_EXAMPLE3", "LambdaConfig": { "UserMigration": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction" }, "LastModifiedDate": 1678486942.479, "Name": "user pool 3" } ] } ``` Para obter mais informações, consulte [Grupos de usuários do Amazon Cognito](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [ListUserPools](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-user-pools.html) na *Referência de comandos da AWS CLI*. ### `list-users-in-group` O código de exemplo a seguir mostra como usar `list-users-in-group`. **AWS CLI** **Para listar usuários em um grupo** Este exemplo lista os usuários no grupo MyGroup. Comando: ``` aws cognito-idp list-users-in-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyGroup ``` Resultado: ``` { "Users": [ { "Username": "acf10624-80bb-401a-ac61-607bee2110ec", "Attributes": [ { "Name": "sub", "Value": "acf10624-80bb-401a-ac61-607bee2110ec" }, { "Name": "custom:CustomAttr1", "Value": "New Value!" }, { "Name": "email", "Value": "jane@example.com" } ], "UserCreateDate": 1548102770.284, "UserLastModifiedDate": 1548103204.893, "Enabled": true, "UserStatus": "CONFIRMED" }, { "Username": "22704aa3-fc10-479a-97eb-2af5806bd327", "Attributes": [ { "Name": "sub", "Value": "22704aa3-fc10-479a-97eb-2af5806bd327" }, { "Name": "email_verified", "Value": "true" }, { "Name": "email", "Value": "diego@example.com" } ], "UserCreateDate": 1548089817.683, "UserLastModifiedDate": 1548089817.683, "Enabled": true, "UserStatus": "FORCE_CHANGE_PASSWORD" } ] } ``` + Para ver detalhes da API, consulte [ListUsersInGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-users-in-group.html) na *Referência de comandos da AWS CLI*. ### `list-users` O código de exemplo a seguir mostra como usar `list-users`. **AWS CLI** **Exemplo 1: como listar usuários com um filtro do lado do servidor** O exemplo de `list-users` a seguir lista três usuários no grupo de usuários solicitado cujos endereços de e-mail começam com `testuser`. ``` aws cognito-idp list-users \ --user-pool-id us-west-2_EXAMPLE \ --filter email^=\"testuser\" \ --max-items 3 ``` Resultado: ``` { "PaginationToken": "efgh5678EXAMPLE", "Users": [ { "Attributes": [ { "Name": "sub", "Value": "eaad0219-2117-439f-8d46-4db20e59268f" }, { "Name": "email", "Value": "testuser@example.com" } ], "Enabled": true, "UserCreateDate": 1682955829.578, "UserLastModifiedDate": 1689030181.63, "UserStatus": "CONFIRMED", "Username": "testuser" }, { "Attributes": [ { "Name": "sub", "Value": "3b994cfd-0b07-4581-be46-3c82f9a70c90" }, { "Name": "email", "Value": "testuser2@example.com" } ], "Enabled": true, "UserCreateDate": 1684427979.201, "UserLastModifiedDate": 1684427979.201, "UserStatus": "UNCONFIRMED", "Username": "testuser2" }, { "Attributes": [ { "Name": "sub", "Value": "5929e0d1-4c34-42d1-9b79-a5ecacfe66f7" }, { "Name": "email", "Value": "testuser3@example.com" } ], "Enabled": true, "UserCreateDate": 1684427823.641, "UserLastModifiedDate": 1684427823.641, "UserStatus": "UNCONFIRMED", "Username": "testuser3@example.com" } ] } ``` Consulte mais informações em [Managing and searching for users](https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html) no *Guia do desenvolvedor do Amazon Cognito*. **Exemplo 2: como listar usuários com um filtro do lado do cliente** O exemplo de `list-users` a seguir lista os atributos de três usuários que têm um atributo, nesse caso, o endereço de e-mail, que contém o domínio de e-mail “@example.com”. Se outros atributos contivessem essa string, eles também seriam exibidos. O segundo usuário não tem atributos que correspondam à consulta e é excluído da saída exibida, mas não da resposta do servidor. ``` aws cognito-idp list-users \ --user-pool-id us-west-2_EXAMPLE \ --max-items 3 --query Users\[\*\].Attributes\[\?Value\.contains\(\@\,\'@example.com\'\)\] ``` Resultado: ``` [ [ { "Name": "email", "Value": "admin@example.com" } ], [], [ { "Name": "email", "Value": "operator@example.com" } ] ] ``` Consulte mais informações em [Managing and searching for users](https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [ListUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-users.html) na *Referência de comandos da AWS CLI*. ### `list-web-authn-credentials` O código de exemplo a seguir mostra como usar `list-web-authn-credentials`. **AWS CLI** **Como listar as credenciais da chave de acesso** O exemplo de `list-web-authn-credentials` a seguir lista as credenciais da chave de acesso, ou WebAuthn, para o usuário atual. Ele tem um dispositivo registrado. ``` aws cognito-idp list-web-authn-credentials \ --access-token eyJra456defEXAMPLE ``` Resultado: ``` { "Credentials": [ { "AuthenticatorAttachment": "cross-platform", "CreatedAt": 1736293876.115, "CredentialId": "8LApgk4-lNUFHbhm2w6Und7-uxcc8coJGsPxiogvHoItc64xWQc3r4CEXAMPLE", "FriendlyCredentialName": "Roaming passkey", "RelyingPartyId": "auth.example.com" } ] } ``` Consulte mais informações em [Passkey sign-in](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow-methods.html#amazon-cognito-user-pools-authentication-flow-methods-passkey) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [ListWebAuthnCredentials](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-web-authn-credentials.html) na *Referência de comandos da AWS CLI*. ### `resend-confirmation-code` O código de exemplo a seguir mostra como usar `resend-confirmation-code`. **AWS CLI** **Como reenviar um código de confirmação** O exemplo `resend-confirmation-code` a seguir envia um código de confirmação ao usuário `jane`. ``` aws cognito-idp resend-confirmation-code \ --client-id 12a3b456c7de890f11g123hijk \ --username jane ``` Resultado: ``` { "CodeDeliveryDetails": { "Destination": "j***@e***.com", "DeliveryMedium": "EMAIL", "AttributeName": "email" } } ``` Para obter mais informações, consulte [Como cadastrar e confirmar contas de usuários](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [ResendConfirmationCode](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/resend-confirmation-code.html) na *Referência de comandos da AWS CLI*. ### `respond-to-auth-challenge` O código de exemplo a seguir mostra como usar `respond-to-auth-challenge`. **AWS CLI** **Exemplo 1: como responder ao desafio NEW\$1PASSWORD\$1REQUIRED** O exemplo de `respond-to-auth-challenge` a seguir responde a um desafio NEW\$1PASSWORD\$1REQUIRED que initiate-auth retornou. Ele define uma senha para o usuário `jane@example.com`. ``` aws cognito-idp respond-to-auth-challenge \ --client-id 1example23456789 \ --challenge-name NEW_PASSWORD_REQUIRED \ --challenge-responses USERNAME=jane@example.com,NEW_PASSWORD=[Password] \ --session AYABeEv5HklEXAMPLE ``` Resultado: ``` { "ChallengeParameters": {}, "AuthenticationResult": { "AccessToken": "ACCESS_TOKEN", "ExpiresIn": 3600, "TokenType": "Bearer", "RefreshToken": "REFRESH_TOKEN", "IdToken": "ID_TOKEN", "NewDeviceMetadata": { "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceGroupKey": "-wt2ha1Zd" } } } ``` Consulte mais informações em [Authentication](https://docs.aws.amazon.com/cognito/latest/developerguide/authentication.html) no *Guia do desenvolvedor do Amazon Cognito*. **Exemplo 2: como responder a um desafio SELECT\$1MFA\$1TYPE** O exemplo de `respond-to-auth-challenge` a seguir escolhe a MFA TOTP como a opção de MFA para o usuário atual. O usuário foi solicitado a selecionar um tipo de MFA e, depois, será solicitado a inserir o código da MFA. ``` aws cognito-idp respond-to-auth-challenge \ --client-id 1example23456789 --session AYABeEv5HklEXAMPLE --challenge-name SELECT_MFA_TYPE --challenge-responses USERNAME=testuser,ANSWER=SOFTWARE_TOKEN_MFA ``` Resultado: ``` { "ChallengeName": "SOFTWARE_TOKEN_MFA", "Session": "AYABeEv5HklEXAMPLE", "ChallengeParameters": { "FRIENDLY_DEVICE_NAME": "transparent" } } ``` Consulte mais informações em [Adding MFA](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html) no *Guia do desenvolvedor do Amazon Cognito*. **Exemplo 3: como responder a um desafio SOFTWARE\$1TOKEN\$1MFA** O exemplo de `respond-to-auth-challenge` a seguir fornece um código de MFA TOTP e conclui o login. ``` aws cognito-idp respond-to-auth-challenge \ --client-id 1example23456789 \ --session AYABeEv5HklEXAMPLE \ --challenge-name SOFTWARE_TOKEN_MFA \ --challenge-responses USERNAME=testuser,SOFTWARE_TOKEN_MFA_CODE=123456 ``` Resultado: ``` { "AuthenticationResult": { "AccessToken": "eyJra456defEXAMPLE", "ExpiresIn": 3600, "TokenType": "Bearer", "RefreshToken": "eyJra123abcEXAMPLE", "IdToken": "eyJra789ghiEXAMPLE", "NewDeviceMetadata": { "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceGroupKey": "-v7w9UcY6" } } } ``` Consulte mais informações em [Adding MFA](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [RespondToAuthChallenge](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/respond-to-auth-challenge.html) na *Referência de comandos da AWS CLI*. ### `revoke-token` O código de exemplo a seguir mostra como usar `revoke-token`. **AWS CLI** **Como revogar um token de atualização** O `revoke-token` a seguir revoga o token de atualização solicitado e os tokens de acesso associados. ``` aws cognito-idp revoke-token \ --token eyJjd123abcEXAMPLE \ --client-id 1example23456789 ``` Este comando não produz saída. Consulte mais informações em [Revoking tokens](https://docs.aws.amazon.com/cognito/latest/developerguide/token-revocation.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [RevokeToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/revoke-token.html) na *Referência de comandos da AWS CLI*. ### `set-log-delivery-configuration` O código de exemplo a seguir mostra como usar `set-log-delivery-configuration`. **AWS CLI** **Como configurar a exportação de logs de um grupo de usuários** O exemplo de `set-log-delivery-configuration` a seguir configura o grupo de usuários solicitado com o registro em log de erros de notificação do usuário em um grupo de logs e o registro em log de informações de autenticação do usuário em um bucket do S3. ``` aws cognito-idp set-log-delivery-configuration \ --user-pool-id us-west-2_EXAMPLE \ --log-configurations LogLevel=ERROR,EventSource=userNotification,CloudWatchLogsConfiguration={LogGroupArn=arn:aws:logs:us-west-2:123456789012:log-group:cognito-exported} LogLevel=INFO,EventSource=userAuthEvents,S3Configuration={BucketArn=arn:aws:s3:::amzn-s3-demo-bucket1} ``` Resultado: ``` { "LogDeliveryConfiguration": { "LogConfigurations": [ { "CloudWatchLogsConfiguration": { "LogGroupArn": "arn:aws:logs:us-west-2:123456789012:log-group:cognito-exported" }, "EventSource": "userNotification", "LogLevel": "ERROR" }, { "EventSource": "userAuthEvents", "LogLevel": "INFO", "S3Configuration": { "BucketArn": "arn:aws:s3:::amzn-s3-demo-bucket1" } } ], "UserPoolId": "us-west-2_EXAMPLE" } } ``` Consulte mais informações em [Exporting user pool logs](https://docs.aws.amazon.com/cognito/latest/developerguide/exporting-quotas-and-usage.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [SetLogDeliveryConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/set-log-delivery-configuration.html) na *Referência de comandos da AWS CLI*. ### `set-risk-configuration` O código de exemplo a seguir mostra como usar `set-risk-configuration`. **AWS CLI** **Como definir a configuração do risco de proteção contra ameaças** O exemplo de `set-risk-configuration` a seguir configura mensagens e ações de proteção contra ameaças, credenciais comprometidas e exceções de endereço IP no cliente da aplicação solicitado. Devido à complexidade do objeto NotifyConfiguration, a entrada JSON é uma prática recomendada para esse comando. ``` aws cognito-idp set-risk-configuration \ --cli-input-json file://set-risk-configuration.json ``` Conteúdo de `set-risk-configuration.json`: ``` { "AccountTakeoverRiskConfiguration": { "Actions": { "HighAction": { "EventAction": "MFA_REQUIRED", "Notify": true }, "LowAction": { "EventAction": "NO_ACTION", "Notify": true }, "MediumAction": { "EventAction": "MFA_IF_CONFIGURED", "Notify": true } }, "NotifyConfiguration": { "BlockEmail": { "HtmlBody": "\n\n\n\tHTML email context\n\t\n\n\n
We blocked an unrecognized sign-in to your account with this information:\n
    \n
  • Time: {login-time}
    • \n
  • Device: {device-name}
    • \n
  • Location: {city}, {country}
    • \n
\nIf this sign-in was not by you, you should change your password and notify us by clicking on this link\nIf this sign-in was by you, you can follow this link to let us know
\n\n", "Subject": "Blocked sign-in attempt", "TextBody": "We blocked an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "From": "admin@example.com", "MfaEmail": { "HtmlBody": "\n\n\n\tHTML email context\n\t\n\n\n
We required you to use multi-factor authentication for the following sign-in attempt:\n
    \n
  • Time: {login-time}
    • \n
  • Device: {device-name}
    • \n
  • Location: {city}, {country}
    • \n
\nIf this sign-in was not by you, you should change your password and notify us by clicking on this link\nIf this sign-in was by you, you can follow this link to let us know
\n\n", "Subject": "New sign-in attempt", "TextBody": "We required you to use multi-factor authentication for the following sign-in attempt:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "NoActionEmail": { "HtmlBody": "\n\n\n\tHTML email context\n\t\n\n\n
We observed an unrecognized sign-in to your account with this information:\n
    \n
  • Time: {login-time}
    • \n
  • Device: {device-name}
    • \n
  • Location: {city}, {country}
    • \n
\nIf this sign-in was not by you, you should change your password and notify us by clicking on this link\nIf this sign-in was by you, you can follow this link to let us know
\n\n", "Subject": "New sign-in attempt", "TextBody": "We observed an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "ReplyTo": "admin@example.com", "SourceArn": "arn:aws:ses:us-west-2:123456789012:identity/admin@example.com" } }, "ClientId": "1example23456789", "CompromisedCredentialsRiskConfiguration": { "Actions": { "EventAction": "BLOCK" }, "EventFilter": [ "PASSWORD_CHANGE", "SIGN_UP", "SIGN_IN" ] }, "RiskExceptionConfiguration": { "BlockedIPRangeList": [ "192.0.2.1/32", "192.0.2.2/32" ], "SkippedIPRangeList": [ "203.0.113.1/32", "203.0.113.2/32" ] }, "UserPoolId": "us-west-2_EXAMPLE" } ``` Resultado: ``` { "RiskConfiguration": { "AccountTakeoverRiskConfiguration": { "Actions": { "HighAction": { "EventAction": "MFA_REQUIRED", "Notify": true }, "LowAction": { "EventAction": "NO_ACTION", "Notify": true }, "MediumAction": { "EventAction": "MFA_IF_CONFIGURED", "Notify": true } }, "NotifyConfiguration": { "BlockEmail": { "HtmlBody": "\n\n\n\tHTML email context\n\t\n\n\n
We blocked an unrecognized sign-in to your account with this information:\n
    \n
  • Time: {login-time}
    • \n
  • Device: {device-name}
    • \n
  • Location: {city}, {country}
    • \n
\nIf this sign-in was not by you, you should change your password and notify us by clicking on this link\nIf this sign-in was by you, you can follow this link to let us know
\n\n", "Subject": "Blocked sign-in attempt", "TextBody": "We blocked an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "From": "admin@example.com", "MfaEmail": { "HtmlBody": "\n\n\n\tHTML email context\n\t\n\n\n
We required you to use multi-factor authentication for the following sign-in attempt:\n
    \n
  • Time: {login-time}
    • \n
  • Device: {device-name}
    • \n
  • Location: {city}, {country}
    • \n
\nIf this sign-in was not by you, you should change your password and notify us by clicking on this link\nIf this sign-in was by you, you can follow this link to let us know
\n\n", "Subject": "New sign-in attempt", "TextBody": "We required you to use multi-factor authentication for the following sign-in attempt:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "NoActionEmail": { "HtmlBody": "\n\n\n\tHTML email context\n\t\n\n\n
We observed an unrecognized sign-in to your account with this information:\n
    \n
  • Time: {login-time}
    • \n
  • Device: {device-name}
    • \n
  • Location: {city}, {country}
    • \n
\nIf this sign-in was not by you, you should change your password and notify us by clicking on this link\nIf this sign-in was by you, you can follow this link to let us know
\n\n", "Subject": "New sign-in attempt", "TextBody": "We observed an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "ReplyTo": "admin@example.com", "SourceArn": "arn:aws:ses:us-west-2:123456789012:identity/admin@example.com" } }, "ClientId": "1example23456789", "CompromisedCredentialsRiskConfiguration": { "Actions": { "EventAction": "BLOCK" }, "EventFilter": [ "PASSWORD_CHANGE", "SIGN_UP", "SIGN_IN" ] }, "RiskExceptionConfiguration": { "BlockedIPRangeList": [ "192.0.2.1/32", "192.0.2.2/32" ], "SkippedIPRangeList": [ "203.0.113.1/32", "203.0.113.2/32" ] }, "UserPoolId": "us-west-2_EXAMPLE" } } ``` Consulte mais informações em [Threat protection](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-threat-protection.html) no *Guia do desenvolvedor do Amazon Cognito*. + Para obter detalhes sobre a API, consulte [SetRiskConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/set-risk-configuration.html) na *AWS CLI Referência de comando*. ### `set-ui-customization` O código de exemplo a seguir mostra como usar `set-ui-customization`. **AWS CLI** **Exemplo 1: como personalizar a interface do usuário hospedada clássica para um cliente da aplicação** O exemplo de `set-ui-customization` a seguir configura o cliente da aplicação solicitado com algum CSS personalizado e com o logotipo do Amazon Cognito como logotipo da aplicação. ``` aws cognito-idp set-ui-customization \ --user-pool-id us-west-2_ywDJHlIfU \ --client-id 14pq32c5q2uq2q7keorloqvb23 \ --css ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 0px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 400;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 11px;\n\tfont-weight: normal;\n\tmargin: 20px -15px 10px -13px;\n\theight: 40px;\n\twidth: 108%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n\ttext-align: center;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n\tborder-radius: 0px;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\tborder-radius: 2px;\n\theight: 40px;\n\tmargin-bottom: 15px;\n\tpadding: 1px;\n\ttext-align: left;\n\twidth: 100%;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #fff;\n}\n" \ --image-file iVBORw0KGgoAAAANSUhEUgAAAFAAAABQCAMAAAC5zwKfAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAA2UExURd00TN9BV/Cmsfvm6f3y9P////fM0uqAj+yNmu6ZpvnZ3eNabuFNYuZneehzhPKzvPTAxwAAAOiMMlkAAAASdFJOU///////////////////////AOK/vxIAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAKDSURBVFhH7ZfpkoMgEISDHKuEw/d/2u2BQWMiBrG29o+fVsKatdPMAeZxc3Nz8w+ISekzmB++sYIw/I/tjHzrPpO2Tx62EbR2PNxFac+jVuKxRaV50IzXkUe76NOCoUuwlvnQKei02gNF0ykotOLRBq/nboeWRxAISx2EbsHFoRhK6Igk2JJlwScfQjgt06dOaWWiTbEDAe/iq8N9kqCw2uCbHkHlYkaXEF8EYeL9RDqT4FhC6XMIIEifdcUwCc4leNyhabadWU6OlKYJE1Oac3NSPhB5rlaXlSgmr/1lww4nPaU/1ylfLGxX1r6Y66ZZkCqvnOlqKWws59ELj7fULc2CubwySYkdDuuiY0/F0L6Q5pZiSG0SfZTSTCOUhxOCH1AdIoCpTTIjtd+VpEjUDDytQH/0Fpc661Aisas/4qmyUItD557pSCOSQQzlx27J+meyDGc5zZgfhWuXE1lGgmVOMwmWdeGdzhjqZV14x5vSj7vsC5JDz/Cl0Vhp56n2NQt1wQIpury1EPbwyaYm+IhmAQKoajkH51wg4cMZ1wQ3QG9efKWWOaDhYWnU6jXjCMdRmm21PArI+Pb5DYoH93hq0ZCPlxeGJho/DI15C6sQc/L2sTC47UFBKZGHT6k+zlXg7WebA0Nr0HTcLMfk/Y4Rc65D3iG6WDd7YLSlVqk87bVhUwhnClrx11RsVQwlAA818Mn+QEs71BhSFU6orsUfKhHp72XMGYXi4q9c64RXRvzkWurRfG2vI2be/VaNcNgpX0Evb/vio7nPMmj5qujkpQgSaPd1UcVqciHFDNZpOcGlcOPyi+AamCbIL9fitxAGeFN2Dl+3vZubm5u/4fH4Bd14HhIPdwZPAAAAAElFTkSuQmCC ``` Resultado: ``` { "UICustomization": { "UserPoolId": "us-west-2_ywDJHlIfU", "ClientId": "14pq32c5q2uq2q7keorloqvb23", "ImageUrl": "https://cf.thewrong.club/14pq32c5q2uq2q7keorloqvb23/20250117005911/assets/images/image.jpg", "CSS": ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 0px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 400;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 11px;\n\tfont-weight: normal;\n\tmargin: 20px -15px 10px -13px;\n\theight: 40px;\n\twidth: 108%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n\ttext-align: center;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n\tborder-radius: 0px;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\tborder-radius: 2px;\n\theight: 40px;\n\tmargin-bottom: 15px;\n\tpadding: 1px;\n\ttext-align: left;\n\twidth: 100%;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #fff;\n}\n", "CSSVersion": "20250117005911" } } ``` **Exemplo 2: como definir a personalização padrão da interface do usuário para todos os clientes da aplicação** O exemplo de `set-ui-customization` a seguir configura o grupo de usuários solicitado para todos os clientes da aplicação que não têm uma configuração específica do cliente. O comando aplica um CSS personalizado e usa o logotipo do Amazon Cognito como logotipo da aplicação. ``` aws cognito-idp set-ui-customization \ --user-pool-id us-west-2_ywDJHlIfU \ --client-id ALL \ --css ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 0px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 400;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 11px;\n\tfont-weight: normal;\n\tmargin: 20px -15px 10px -13px;\n\theight: 40px;\n\twidth: 108%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n\ttext-align: center;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n\tborder-radius: 0px;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\tborder-radius: 2px;\n\theight: 40px;\n\tmargin-bottom: 15px;\n\tpadding: 1px;\n\ttext-align: left;\n\twidth: 100%;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #fff;\n}\n" \ --image-file iVBORw0KGgoAAAANSUhEUgAAAFAAAABQCAMAAAC5zwKfAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAA2UExURd00TN9BV/Cmsfvm6f3y9P////fM0uqAj+yNmu6ZpvnZ3eNabuFNYuZneehzhPKzvPTAxwAAAOiMMlkAAAASdFJOU///////////////////////AOK/vxIAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAKDSURBVFhH7ZfpkoMgEISDHKuEw/d/2u2BQWMiBrG29o+fVsKatdPMAeZxc3Nz8w+ISekzmB++sYIw/I/tjHzrPpO2Tx62EbR2PNxFac+jVuKxRaV50IzXkUe76NOCoUuwlvnQKei02gNF0ykotOLRBq/nboeWRxAISx2EbsHFoRhK6Igk2JJlwScfQjgt06dOaWWiTbEDAe/iq8N9kqCw2uCbHkHlYkaXEF8EYeL9RDqT4FhC6XMIIEifdcUwCc4leNyhabadWU6OlKYJE1Oac3NSPhB5rlaXlSgmr/1lww4nPaU/1ylfLGxX1r6Y66ZZkCqvnOlqKWws59ELj7fULc2CubwySYkdDuuiY0/F0L6Q5pZiSG0SfZTSTCOUhxOCH1AdIoCpTTIjtd+VpEjUDDytQH/0Fpc661Aisas/4qmyUItD557pSCOSQQzlx27J+meyDGc5zZgfhWuXE1lGgmVOMwmWdeGdzhjqZV14x5vSj7vsC5JDz/Cl0Vhp56n2NQt1wQIpury1EPbwyaYm+IhmAQKoajkH51wg4cMZ1wQ3QG9efKWWOaDhYWnU6jXjCMdRmm21PArI+Pb5DYoH93hq0ZCPlxeGJho/DI15C6sQc/L2sTC47UFBKZGHT6k+zlXg7WebA0Nr0HTcLMfk/Y4Rc65D3iG6WDd7YLSlVqk87bVhUwhnClrx11RsVQwlAA818Mn+QEs71BhSFU6orsUfKhHp72XMGYXi4q9c64RXRvzkWurRfG2vI2be/VaNcNgpX0Evb/vio7nPMmj5qujkpQgSaPd1UcVqciHFDNZpOcGlcOPyi+AamCbIL9fitxAGeFN2Dl+3vZubm5u/4fH4Bd14HhIPdwZPAAAAAElFTkSuQmCC ``` Resultado: ``` { "UICustomization": { "UserPoolId": "us-west-2_ywDJHlIfU", "ClientId": "14pq32c5q2uq2q7keorloqvb23", "ImageUrl": "https://cf.thewrong.club/14pq32c5q2uq2q7keorloqvb23/20250117005911/assets/images/image.jpg", "CSS": ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 0px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 400;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 11px;\n\tfont-weight: normal;\n\tmargin: 20px -15px 10px -13px;\n\theight: 40px;\n\twidth: 108%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n\ttext-align: center;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n\tborder-radius: 0px;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\tborder-radius: 2px;\n\theight: 40px;\n\tmargin-bottom: 15px;\n\tpadding: 1px;\n\ttext-align: left;\n\twidth: 100%;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #fff;\n}\n", "CSSVersion": "20250117005911" } } ``` Consulte mais informações em [Hosted UI (classic) branding](https://docs.aws.amazon.com/cognito/latest/developerguide/hosted-ui-classic-branding.html) no *Guia do desenvolvedor do Amazon Cognito*. + Para ver detalhes da API, consulte [SetUiCustomization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/set-ui-customization.html) na *Referência de comandos da AWS CLI*. ### `set-user-mfa-preference` O código de exemplo a seguir mostra como usar `set-user-mfa-preference`. **AWS CLI** **Como definir a preferência de MFA de um usuário** O exemplo de `set-user-mfa-preference` a seguir configura o usuário atual para usar a MFA TOTP e desabilita todos os outros fatores de MFA. ``` aws cognito-idp set-user-mfa-preference \ --access-token eyJra456defEXAMPLE \ --software-token-mfa-settings Enabled=true,PreferredMfa=true \ --sms-mfa-settings Enabled=false,PreferredMfa=false \ --email-mfa-settings Enabled=false,PreferredMfa=false ``` Este comando não produz saída. Consulte mais informações em [Adding MFA](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html) no *Guia do desenvolvedor do Amazon Cognito*. + Para obter detalhes sobre a API, consulte [SetUserMfaPreference](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/set-user-mfa-preference.html) na *Referência de comandos da AWS CLI*. ### `set-user-pool-mfa-config` O código de exemplo a seguir mostra como usar `set-user-pool-mfa-config`. **AWS CLI** **Como configurar MFA e WebAuthn do grupo de usuários** O exemplo de `set-user-pool-mfa-config` a seguir configura o grupo de usuários solicitado com MFA opcional com todos os métodos de MFA disponíveis e define a configuração do WebAuthn. ``` aws cognito-idp set-user-pool-mfa-config \ --user-pool-id us-west-2_EXAMPLE \ --sms-mfa-configuration "SmsAuthenticationMessage=\"Your OTP for MFA or sign-in: use {####}.\",SmsConfiguration={SnsCallerArn=arn:aws:iam::123456789012:role/service-role/test-SMS-Role,ExternalId=a1b2c3d4-5678-90ab-cdef-EXAMPLE11111,SnsRegion=us-west-2}" \ --software-token-mfa-configuration Enabled=true \ --email-mfa-configuration "Message=\"Your OTP for MFA or sign-in: use {####}\",Subject=\"OTP test\"" \ --mfa-configuration OPTIONAL \ --web-authn-configuration RelyingPartyId=auth.example.com,UserVerification=preferred ``` Resultado: ``` { "EmailMfaConfiguration": { "Message": "Your OTP for MFA or sign-in: use {####}", "Subject": "OTP test" }, "MfaConfiguration": "OPTIONAL", "SmsMfaConfiguration": { "SmsAuthenticationMessage": "Your OTP for MFA or sign-in: use {####}.", "SmsConfiguration": { "ExternalId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "SnsCallerArn": "arn:aws:iam::123456789012:role/service-role/test-SMS-Role", "SnsRegion": "us-west-2" } }, "SoftwareTokenMfaConfiguration": { "Enabled": true }, "WebAuthnConfiguration": { "RelyingPartyId": "auth.example.com", "UserVerification": "preferred" } } ``` Consulte mais informações em [Adding MFA](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html) e em [Passkey sign-in](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow-methods.html#amazon-cognito-user-pools-authentication-flow-methods-passkey) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [SetUserPoolMfaConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/set-user-pool-mfa-config.html) na *Referência de comandos da AWS CLI*. ### `set-user-settings` O código de exemplo a seguir mostra como usar `set-user-settings`. **AWS CLI** **Como definir as configurações de usuário** Este exemplo define a preferência de entrega da MFA como EMAIL. Comando: ``` aws cognito-idp set-user-settings --access-token ACCESS_TOKEN --mfa-options DeliveryMedium=EMAIL ``` + Para ver detalhes da API, consulte [SetUserSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/set-user-settings.html) na *Referência de comandos da AWS CLI*. ### `sign-up` O código de exemplo a seguir mostra como usar `sign-up`. **AWS CLI** **Como inscrever um usuário** Este exemplo inscreve jane@example.com. Comando: ``` aws cognito-idp sign-up --client-id 3n4b5urk1ft4fl3mg5e62d9ado --username jane@example.com --password PASSWORD --user-attributes Name="email",Value="jane@example.com" Name="name",Value="Jane" ``` Resultado: ``` { "UserConfirmed": false, "UserSub": "e04d60a6-45dc-441c-a40b-e25a787d4862" } ``` + Consulte detalhes da API em [SignUp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/sign-up.html) na *Referência de comandos da AWS CLI*. ### `start-user-import-job` O código de exemplo a seguir mostra como usar `start-user-import-job`. **AWS CLI** **Como iniciar um trabalho de importação** O exemplo de `start-user-import-job` a seguir inicia o trabalho de importação solicitado no grupo de usuários solicitado. ``` aws cognito-idp start-user-import-job \ --user-pool-id us-west-2_EXAMPLE \ --job-id import-mAgUtd8PMm ``` Resultado: ``` { "UserImportJob": { "CloudWatchLogsRoleArn": "arn:aws:iam::123456789012:role/example-cloudwatch-logs-role", "CreationDate": 1736442975.904, "FailedUsers": 0, "ImportedUsers": 0, "JobId": "import-mAgUtd8PMm", "JobName": "Customer import", "PreSignedUrl": "https://aws-cognito-idp-user-import-pdx.s3.us-west-2.amazonaws.com/123456789012/us-west-2_EXAMPLE/import-mAgUtd8PMm?X-Amz-Security-Token=[token]&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241226T193341Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=[credential]&X-Amz-Signature=[signature]", "SkippedUsers": 0, "StartDate": 1736443020.081, "Status": "Pending", "UserPoolId": "us-west-2_EXAMPLE" } } ``` Consulte mais informações em [Importing users into a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html) no *Guia do desenvolvedor do Amazon Cognito*. + Para ver detalhes da API, consulte [StartUserImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/start-user-import-job.html) na *Referência de comandos da AWS CLI*. ### `start-web-authn-registration` O código de exemplo a seguir mostra como usar `start-web-authn-registration`. **AWS CLI** **Como obter informações de registro de chave de acesso para um usuário conectado** O exemplo de `start-web-authn-registration` a seguir gera opções de registro do WebAuthn para o usuário atual. ``` aws cognito-idp start-web-authn-registration \ --access-token eyJra456defEXAMPLE ``` Resultado: ``` { "CredentialCreationOptions": { "authenticatorSelection": { "requireResidentKey": true, "residentKey": "required", "userVerification": "preferred" }, "challenge": "wxvbDicyqQqvF2EXAMPLE", "excludeCredentials": [ { "id": "8LApgk4-lNUFHbhm2w6Und7-uxcc8coJGsPxiogvHoItc64xWQc3r4CEXAMPLE", "type": "public-key" } ], "pubKeyCredParams": [ { "alg": -7, "type": "public-key" }, { "alg": -257, "type": "public-key" } ], "rp": { "id": "auth.example.com", "name": "auth.example.com" }, "timeout": 60000, "user": { "displayName": "testuser", "id": "ZWFhZDAyMTktMjExNy00MzlmLThkNDYtNGRiMjBlNEXAMPLE", "name": "testuser" } } } ``` Consulte mais informações em [Passkey sign-in](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow-methods.html#amazon-cognito-user-pools-authentication-flow-methods-passkey) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [StartWebAuthnRegistration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/start-web-authn-registration.html) na *Referência de comandos da AWS CLI*. ### `stop-user-import-job` O código de exemplo a seguir mostra como usar `stop-user-import-job`. **AWS CLI** **Como interromper um trabalho de importação** O exemplo de `stop-user-import-job` a seguir interrompe o trabalho de importação de usuários solicitado em execução no grupo de usuários solicitado. ``` aws cognito-idp stop-user-import-job \ --user-pool-id us-west-2_EXAMPLE \ --job-id import-mAgUtd8PMm ``` Resultado: ``` { "UserImportJob": { "CloudWatchLogsRoleArn": "arn:aws:iam::123456789012:role/example-cloudwatch-logs-role", "CompletionDate": 1736443496.379, "CompletionMessage": "The Import Job was stopped by the developer.", "CreationDate": 1736443471.781, "FailedUsers": 0, "ImportedUsers": 0, "JobId": "import-mAgUtd8PMm", "JobName": "Customer import", "PreSignedUrl": "https://aws-cognito-idp-user-import-pdx.s3.us-west-2.amazonaws.com/123456789012/us-west-2_EXAMPLE/import-mAgUtd8PMm?X-Amz-Security-Token=[token]&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241226T193341Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=[credential]&X-Amz-Signature=[signature]", "SkippedUsers": 0, "StartDate": 1736443494.154, "Status": "Stopped", "UserPoolId": "us-west-2_EXAMPLE" } } ``` Consulte mais informações em [Importing users into a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html) no *Guia do desenvolvedor do Amazon Cognito*. + Para ver detalhes da API, consulte [StopUserImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/stop-user-import-job.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como aplicar tags um grupo de usuários** O exemplo de `tag-resource` a seguir aplica as tags `administrator` e `department` ao grupo de usuários solicitado. ``` aws cognito-idp tag-resource \ --resource-arn arn:aws:cognito-idp:us-west-2:123456789012:userpool/us-west-2_EXAMPLE \ --tags administrator=Jie,tenant=ExampleCorp ``` Este comando não produz saída. Consulte mais informações em [Tagging Amazon Cognito resources](https://docs.aws.amazon.com/cognito/latest/developerguide/tagging.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Como remover tags de um grupo de usuários** O exemplo de `untag-resource` a seguir remove as tags `administrator` e `department` do grupo de usuários solicitado. ``` aws cognito-idp untag-resource \ --resource-arn arn:aws:cognito-idp:us-west-2:767671399759:userpool/us-west-2_l5cxwdm2K \ --tag-keys administrator tenant ``` Este comando não produz saída. Consulte mais informações em [Tagging Amazon Cognito resources](https://docs.aws.amazon.com/cognito/latest/developerguide/tagging.html) no *Guia do desenvolvedor do Amazon Cognito*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-auth-event-feedback` O código de exemplo a seguir mostra como usar `update-auth-event-feedback`. **AWS CLI** **Para atualizar o feedback do evento de autenticação** Este exemplo atualiza o feedback do evento de autorização. Ele marca o evento como “Valid”. Comando: ``` aws cognito-idp update-auth-event-feedback --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --event-id EVENT_ID --feedback-token FEEDBACK_TOKEN --feedback-value "Valid" ``` + Para ver detalhes da API, consulte [UpdateAuthEventFeedback](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-auth-event-feedback.html) na *Referência de comandos da AWS CLI*. ### `update-device-status` O código de exemplo a seguir mostra como usar `update-device-status`. **AWS CLI** **Para atualizar o status do dispositivo** Este exemplo atualiza o status de um dispositivo para “not\$1remembered”. Comando: ``` aws cognito-idp update-device-status --access-token ACCESS_TOKEN --device-key DEVICE_KEY --device-remembered-status "not_remembered" ``` + Para ver detalhes da API, consulte [UpdateDeviceStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-device-status.html) na *Referência de comandos da AWS CLI*. ### `update-group` O código de exemplo a seguir mostra como usar `update-group`. **AWS CLI** **Para atualizar um grupo** Este exemplo atualiza a descrição e a precedência de MyGroup. Comando: ``` aws cognito-idp update-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyGroup --description "New description" --precedence 2 ``` Resultado: ``` { "Group": { "GroupName": "MyGroup", "UserPoolId": "us-west-2_aaaaaaaaa", "Description": "New description", "RoleArn": "arn:aws:iam::111111111111:role/MyRole", "Precedence": 2, "LastModifiedDate": 1548800862.812, "CreationDate": 1548097827.125 } } ``` + Consulte detalhes da API em [UpdateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-group.html) na *Referência de comandos da AWS CLI*. ### `update-identity-provider` O código de exemplo a seguir mostra como usar `update-identity-provider`. **AWS CLI** **Como atualizar um provedor de identidades do grupo de usuários** O exemplo de `update-identity-provider` a seguir atualiza o provedor OIDC “MyOIDCIdP” no grupo de usuários solicitado. ``` aws cognito-idp update-identity-provider \ --cli-input-json file://update-identity-provider.json ``` Conteúdo de `update-identity-provider.json`: ``` { "AttributeMapping": { "email": "idp_email", "email_verified": "idp_email_verified", "username": "sub" }, "CreationDate": 1.701129701653E9, "IdpIdentifiers": [ "corp", "dev" ], "LastModifiedDate": 1.701129701653E9, "ProviderDetails": { "attributes_request_method": "GET", "attributes_url": "https://example.com/userInfo", "attributes_url_add_attributes": "false", "authorize_scopes": "openid profile", "authorize_url": "https://example.com/authorize", "client_id": "idpexampleclient123", "client_secret": "idpexamplesecret456", "jwks_uri": "https://example.com/.well-known/jwks.json", "oidc_issuer": "https://example.com", "token_url": "https://example.com/token" }, "ProviderName": "MyOIDCIdP", "UserPoolId": "us-west-2_EXAMPLE" } ``` Resultado: ``` { "IdentityProvider": { "AttributeMapping": { "email": "idp_email", "email_verified": "idp_email_verified", "username": "sub" }, "CreationDate": 1701129701.653, "IdpIdentifiers": [ "corp", "dev" ], "LastModifiedDate": 1736444278.211, "ProviderDetails": { "attributes_request_method": "GET", "attributes_url": "https://example.com/userInfo", "attributes_url_add_attributes": "false", "authorize_scopes": "openid profile", "authorize_url": "https://example.com/authorize", "client_id": "idpexampleclient123", "client_secret": "idpexamplesecret456", "jwks_uri": "https://example.com/.well-known/jwks.json", "oidc_issuer": "https://example.com", "token_url": "https://example.com/token" }, "ProviderName": "MyOIDCIdP", "ProviderType": "OIDC", "UserPoolId": "us-west-2_EXAMPLE" } } ``` Consulte mais informações em [Configuring a domain](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [UpdateIdentityProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-identity-provider.html) na *Referência de comandos AWS CLI*. ### `update-managed-login-branding` O código de exemplo a seguir mostra como usar `update-managed-login-branding`. **AWS CLI** **Como atualizar um estilo de marca de login gerenciado** O exemplo de `update-managed-login-branding` a seguir atualiza o estilo de marca do cliente da aplicação solicitado. ``` aws cognito-idp update-managed-login-branding \ --cli-input-json file://update-managed-login-branding.json ``` Conteúdo de `update-managed-login-branding.json`: ``` { "Assets": [ { "Bytes": "PHN2ZyB3aWR0aD0iMjAwMDAiIGhlaWdodD0iNDAwIiB2aWV3Qm94PSIwIDAgMjAwMDAgNDAwIiBmaWxsPSJub25lIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8ZyBjbGlwLXBhdGg9InVybCgjY2xpcDBfMTcyNTlfMjM2Njc0KSI+CjxyZWN0IHdpZHRoPSIyMDAwMCIgaGVpZ2h0PSI0MDAiIGZpbGw9InVybCgjcGFpbnQwX2xpbmVhcl8xNzI1OV8yMzY2NzQpIi8+CjxwYXRoIGQ9Ik0wIDBIMjAwMDBWNDAwSDBWMFoiIGZpbGw9IiMxMjIwMzciIGZpbGwtb3BhY2l0eT0iMC41Ii8+CjwvZz4KPGRlZnM+CjxsaW5lYXJHcmFkaWVudCBpZD0icGFpbnQwX2xpbmVhcl8xNzI1OV8yMzY2NzQiIHgxPSItODk0LjI0OSIgeTE9IjE5OS45MzEiIHgyPSIxODAzNC41IiB5Mj0iLTU4OTkuNTciIGdyYWRpZW50VW5pdHM9InVzZXJTcGFjZU9uVXNlIj4KPHN0b3Agc3RvcC1jb2xvcj0iI0JGODBGRiIvPgo8c3RvcCBvZmZzZXQ9IjEiIHN0b3AtY29sb3I9IiNGRjhGQUIiLz4KPC9saW5lYXJHcmFkaWVudD4KPGNsaXBQYXRoIGlkPSJjbGlwMF8xNzI1OV8yMzY2NzQiPgo8cmVjdCB3aWR0aD0iMjAwMDAiIGhlaWdodD0iNDAwIiBmaWxsPSJ3aGl0ZSIvPgo8L2NsaXBQYXRoPgo8L2RlZnM+Cjwvc3ZnPgo=", "Category": "PAGE_FOOTER_BACKGROUND", "ColorMode": "DARK", "Extension": "SVG" } ], "ManagedLoginBrandingId": "63f30090-6b1f-4278-b885-2bbb81f8e545", "Settings": { "categories": { "auth": { "authMethodOrder": [ [ { "display": "BUTTON", "type": "FEDERATED" }, { "display": "INPUT", "type": "USERNAME_PASSWORD" } ] ], "federation": { "interfaceStyle": "BUTTON_LIST", "order": [ ] } }, "form": { "displayGraphics": true, "instructions": { "enabled": false }, "languageSelector": { "enabled": false }, "location": { "horizontal": "CENTER", "vertical": "CENTER" }, "sessionTimerDisplay": "NONE" }, "global": { "colorSchemeMode": "LIGHT", "pageFooter": { "enabled": false }, "pageHeader": { "enabled": false }, "spacingDensity": "REGULAR" }, "signUp": { "acceptanceElements": [ { "enforcement": "NONE", "textKey": "en" } ] } }, "componentClasses": { "buttons": { "borderRadius": 8.0 }, "divider": { "darkMode": { "borderColor": "232b37ff" }, "lightMode": { "borderColor": "ebebf0ff" } }, "dropDown": { "borderRadius": 8.0, "darkMode": { "defaults": { "itemBackgroundColor": "192534ff" }, "hover": { "itemBackgroundColor": "081120ff", "itemBorderColor": "5f6b7aff", "itemTextColor": "e9ebedff" }, "match": { "itemBackgroundColor": "d1d5dbff", "itemTextColor": "89bdeeff" } }, "lightMode": { "defaults": { "itemBackgroundColor": "ffffffff" }, "hover": { "itemBackgroundColor": "f4f4f4ff", "itemBorderColor": "7d8998ff", "itemTextColor": "000716ff" }, "match": { "itemBackgroundColor": "414d5cff", "itemTextColor": "0972d3ff" } } }, "focusState": { "darkMode": { "borderColor": "539fe5ff" }, "lightMode": { "borderColor": "0972d3ff" } }, "idpButtons": { "icons": { "enabled": true } }, "input": { "borderRadius": 8.0, "darkMode": { "defaults": { "backgroundColor": "0f1b2aff", "borderColor": "5f6b7aff" }, "placeholderColor": "8d99a8ff" }, "lightMode": { "defaults": { "backgroundColor": "ffffffff", "borderColor": "7d8998ff" }, "placeholderColor": "5f6b7aff" } }, "inputDescription": { "darkMode": { "textColor": "8d99a8ff" }, "lightMode": { "textColor": "5f6b7aff" } }, "inputLabel": { "darkMode": { "textColor": "d1d5dbff" }, "lightMode": { "textColor": "000716ff" } }, "link": { "darkMode": { "defaults": { "textColor": "539fe5ff" }, "hover": { "textColor": "89bdeeff" } }, "lightMode": { "defaults": { "textColor": "0972d3ff" }, "hover": { "textColor": "033160ff" } } }, "optionControls": { "darkMode": { "defaults": { "backgroundColor": "0f1b2aff", "borderColor": "7d8998ff" }, "selected": { "backgroundColor": "539fe5ff", "foregroundColor": "000716ff" } }, "lightMode": { "defaults": { "backgroundColor": "ffffffff", "borderColor": "7d8998ff" }, "selected": { "backgroundColor": "0972d3ff", "foregroundColor": "ffffffff" } } }, "statusIndicator": { "darkMode": { "error": { "backgroundColor": "1a0000ff", "borderColor": "eb6f6fff", "indicatorColor": "eb6f6fff" }, "pending": { "indicatorColor": "AAAAAAAA" }, "success": { "backgroundColor": "001a02ff", "borderColor": "29ad32ff", "indicatorColor": "29ad32ff" }, "warning": { "backgroundColor": "1d1906ff", "borderColor": "e0ca57ff", "indicatorColor": "e0ca57ff" } }, "lightMode": { "error": { "backgroundColor": "fff7f7ff", "borderColor": "d91515ff", "indicatorColor": "d91515ff" }, "pending": { "indicatorColor": "AAAAAAAA" }, "success": { "backgroundColor": "f2fcf3ff", "borderColor": "037f0cff", "indicatorColor": "037f0cff" }, "warning": { "backgroundColor": "fffce9ff", "borderColor": "8d6605ff", "indicatorColor": "8d6605ff" } } } }, "components": { "alert": { "borderRadius": 12.0, "darkMode": { "error": { "backgroundColor": "1a0000ff", "borderColor": "eb6f6fff" } }, "lightMode": { "error": { "backgroundColor": "fff7f7ff", "borderColor": "d91515ff" } } }, "favicon": { "enabledTypes": [ "ICO", "SVG" ] }, "form": { "backgroundImage": { "enabled": false }, "borderRadius": 8.0, "darkMode": { "backgroundColor": "0f1b2aff", "borderColor": "424650ff" }, "lightMode": { "backgroundColor": "ffffffff", "borderColor": "c6c6cdff" }, "logo": { "enabled": false, "formInclusion": "IN", "location": "CENTER", "position": "TOP" } }, "idpButton": { "custom": { }, "standard": { "darkMode": { "active": { "backgroundColor": "354150ff", "borderColor": "89bdeeff", "textColor": "89bdeeff" }, "defaults": { "backgroundColor": "0f1b2aff", "borderColor": "c6c6cdff", "textColor": "c6c6cdff" }, "hover": { "backgroundColor": "192534ff", "borderColor": "89bdeeff", "textColor": "89bdeeff" } }, "lightMode": { "active": { "backgroundColor": "d3e7f9ff", "borderColor": "033160ff", "textColor": "033160ff" }, "defaults": { "backgroundColor": "ffffffff", "borderColor": "424650ff", "textColor": "424650ff" }, "hover": { "backgroundColor": "f2f8fdff", "borderColor": "033160ff", "textColor": "033160ff" } } } }, "pageBackground": { "darkMode": { "color": "0f1b2aff" }, "image": { "enabled": true }, "lightMode": { "color": "ffffffff" } }, "pageFooter": { "backgroundImage": { "enabled": false }, "darkMode": { "background": { "color": "0f141aff" }, "borderColor": "424650ff" }, "lightMode": { "background": { "color": "fafafaff" }, "borderColor": "d5dbdbff" }, "logo": { "enabled": false, "location": "START" } }, "pageHeader": { "backgroundImage": { "enabled": false }, "darkMode": { "background": { "color": "0f141aff" }, "borderColor": "424650ff" }, "lightMode": { "background": { "color": "fafafaff" }, "borderColor": "d5dbdbff" }, "logo": { "enabled": false, "location": "START" } }, "pageText": { "darkMode": { "bodyColor": "b6bec9ff", "descriptionColor": "b6bec9ff", "headingColor": "d1d5dbff" }, "lightMode": { "bodyColor": "414d5cff", "descriptionColor": "414d5cff", "headingColor": "000716ff" } }, "phoneNumberSelector": { "displayType": "TEXT" }, "primaryButton": { "darkMode": { "active": { "backgroundColor": "539fe5ff", "textColor": "000716ff" }, "defaults": { "backgroundColor": "539fe5ff", "textColor": "000716ff" }, "disabled": { "backgroundColor": "ffffffff", "borderColor": "ffffffff" }, "hover": { "backgroundColor": "89bdeeff", "textColor": "000716ff" } }, "lightMode": { "active": { "backgroundColor": "033160ff", "textColor": "ffffffff" }, "defaults": { "backgroundColor": "0972d3ff", "textColor": "ffffffff" }, "disabled": { "backgroundColor": "ffffffff", "borderColor": "ffffffff" }, "hover": { "backgroundColor": "033160ff", "textColor": "ffffffff" } } }, "secondaryButton": { "darkMode": { "active": { "backgroundColor": "354150ff", "borderColor": "89bdeeff", "textColor": "89bdeeff" }, "defaults": { "backgroundColor": "0f1b2aff", "borderColor": "539fe5ff", "textColor": "539fe5ff" }, "hover": { "backgroundColor": "192534ff", "borderColor": "89bdeeff", "textColor": "89bdeeff" } }, "lightMode": { "active": { "backgroundColor": "d3e7f9ff", "borderColor": "033160ff", "textColor": "033160ff" }, "defaults": { "backgroundColor": "ffffffff", "borderColor": "0972d3ff", "textColor": "0972d3ff" }, "hover": { "backgroundColor": "f2f8fdff", "borderColor": "033160ff", "textColor": "033160ff" } } } } }, "UseCognitoProvidedValues": false, "UserPoolId": "ca-central-1_EXAMPLE" } ``` Resultado: ``` { "ManagedLoginBranding": { "Assets": [ { "Bytes": "PHN2ZyB3aWR0aD0iMjAwMDAiIGhlaWdodD0iNDAwIiB2aWV3Qm94PSIwIDAgMjAwMDAgNDAwIiBmaWxsPSJub25lIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8ZyBjbGlwLXBhdGg9InVybCgjY2xpcDBfMTcyNTlfMjM2Njc0KSI+CjxyZWN0IHdpZHRoPSIyMDAwMCIgaGVpZ2h0PSI0MDAiIGZpbGw9InVybCgjcGFpbnQwX2xpbmVhcl8xNzI1OV8yMzY2NzQpIi8+CjxwYXRoIGQ9Ik0wIDBIMjAwMDBWNDAwSDBWMFoiIGZpbGw9IiMxMjIwMzciIGZpbGwtb3BhY2l0eT0iMC41Ii8+CjwvZz4KPGRlZnM+CjxsaW5lYXJHcmFkaWVudCBpZD0icGFpbnQwX2xpbmVhcl8xNzI1OV8yMzY2NzQiIHgxPSItODk0LjI0OSIgeTE9IjE5OS45MzEiIHgyPSIxODAzNC41IiB5Mj0iLTU4OTkuNTciIGdyYWRpZW50VW5pdHM9InVzZXJTcGFjZU9uVXNlIj4KPHN0b3Agc3RvcC1jb2xvcj0iI0JGODBGRiIvPgo8c3RvcCBvZmZzZXQ9IjEiIHN0b3AtY29sb3I9IiNGRjhGQUIiLz4KPC9saW5lYXJHcmFkaWVudD4KPGNsaXBQYXRoIGlkPSJjbGlwMF8xNzI1OV8yMzY2NzQiPgo8cmVjdCB3aWR0aD0iMjAwMDAiIGhlaWdodD0iNDAwIiBmaWxsPSJ3aGl0ZSIvPgo8L2NsaXBQYXRoPgo8L2RlZnM+Cjwvc3ZnPgo=", "Category": "PAGE_FOOTER_BACKGROUND", "ColorMode": "DARK", "Extension": "SVG" } ], "CreationDate": 1732138490.642, "LastModifiedDate": 1732140420.301, "ManagedLoginBrandingId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "Settings": { "categories": { "auth": { "authMethodOrder": [ [ { "display": "BUTTON", "type": "FEDERATED" }, { "display": "INPUT", "type": "USERNAME_PASSWORD" } ] ], "federation": { "interfaceStyle": "BUTTON_LIST", "order": [ ] } }, "form": { "displayGraphics": true, "instructions": { "enabled": false }, "languageSelector": { "enabled": false }, "location": { "horizontal": "CENTER", "vertical": "CENTER" }, "sessionTimerDisplay": "NONE" }, "global": { "colorSchemeMode": "LIGHT", "pageFooter": { "enabled": false }, "pageHeader": { "enabled": false }, "spacingDensity": "REGULAR" }, "signUp": { "acceptanceElements": [ { "enforcement": "NONE", "textKey": "en" } ] } }, "componentClasses": { "buttons": { "borderRadius": 8.0 }, "divider": { "darkMode": { "borderColor": "232b37ff" }, "lightMode": { "borderColor": "ebebf0ff" } }, "dropDown": { "borderRadius": 8.0, "darkMode": { "defaults": { "itemBackgroundColor": "192534ff" }, "hover": { "itemBackgroundColor": "081120ff", "itemBorderColor": "5f6b7aff", "itemTextColor": "e9ebedff" }, "match": { "itemBackgroundColor": "d1d5dbff", "itemTextColor": "89bdeeff" } }, "lightMode": { "defaults": { "itemBackgroundColor": "ffffffff" }, "hover": { "itemBackgroundColor": "f4f4f4ff", "itemBorderColor": "7d8998ff", "itemTextColor": "000716ff" }, "match": { "itemBackgroundColor": "414d5cff", "itemTextColor": "0972d3ff" } } }, "focusState": { "darkMode": { "borderColor": "539fe5ff" }, "lightMode": { "borderColor": "0972d3ff" } }, "idpButtons": { "icons": { "enabled": true } }, "input": { "borderRadius": 8.0, "darkMode": { "defaults": { "backgroundColor": "0f1b2aff", "borderColor": "5f6b7aff" }, "placeholderColor": "8d99a8ff" }, "lightMode": { "defaults": { "backgroundColor": "ffffffff", "borderColor": "7d8998ff" }, "placeholderColor": "5f6b7aff" } }, "inputDescription": { "darkMode": { "textColor": "8d99a8ff" }, "lightMode": { "textColor": "5f6b7aff" } }, "inputLabel": { "darkMode": { "textColor": "d1d5dbff" }, "lightMode": { "textColor": "000716ff" } }, "link": { "darkMode": { "defaults": { "textColor": "539fe5ff" }, "hover": { "textColor": "89bdeeff" } }, "lightMode": { "defaults": { "textColor": "0972d3ff" }, "hover": { "textColor": "033160ff" } } }, "optionControls": { "darkMode": { "defaults": { "backgroundColor": "0f1b2aff", "borderColor": "7d8998ff" }, "selected": { "backgroundColor": "539fe5ff", "foregroundColor": "000716ff" } }, "lightMode": { "defaults": { "backgroundColor": "ffffffff", "borderColor": "7d8998ff" }, "selected": { "backgroundColor": "0972d3ff", "foregroundColor": "ffffffff" } } }, "statusIndicator": { "darkMode": { "error": { "backgroundColor": "1a0000ff", "borderColor": "eb6f6fff", "indicatorColor": "eb6f6fff" }, "pending": { "indicatorColor": "AAAAAAAA" }, "success": { "backgroundColor": "001a02ff", "borderColor": "29ad32ff", "indicatorColor": "29ad32ff" }, "warning": { "backgroundColor": "1d1906ff", "borderColor": "e0ca57ff", "indicatorColor": "e0ca57ff" } }, "lightMode": { "error": { "backgroundColor": "fff7f7ff", "borderColor": "d91515ff", "indicatorColor": "d91515ff" }, "pending": { "indicatorColor": "AAAAAAAA" }, "success": { "backgroundColor": "f2fcf3ff", "borderColor": "037f0cff", "indicatorColor": "037f0cff" }, "warning": { "backgroundColor": "fffce9ff", "borderColor": "8d6605ff", "indicatorColor": "8d6605ff" } } } }, "components": { "alert": { "borderRadius": 12.0, "darkMode": { "error": { "backgroundColor": "1a0000ff", "borderColor": "eb6f6fff" } }, "lightMode": { "error": { "backgroundColor": "fff7f7ff", "borderColor": "d91515ff" } } }, "favicon": { "enabledTypes": [ "ICO", "SVG" ] }, "form": { "backgroundImage": { "enabled": false }, "borderRadius": 8.0, "darkMode": { "backgroundColor": "0f1b2aff", "borderColor": "424650ff" }, "lightMode": { "backgroundColor": "ffffffff", "borderColor": "c6c6cdff" }, "logo": { "enabled": false, "formInclusion": "IN", "location": "CENTER", "position": "TOP" } }, "idpButton": { "custom": { }, "standard": { "darkMode": { "active": { "backgroundColor": "354150ff", "borderColor": "89bdeeff", "textColor": "89bdeeff" }, "defaults": { "backgroundColor": "0f1b2aff", "borderColor": "c6c6cdff", "textColor": "c6c6cdff" }, "hover": { "backgroundColor": "192534ff", "borderColor": "89bdeeff", "textColor": "89bdeeff" } }, "lightMode": { "active": { "backgroundColor": "d3e7f9ff", "borderColor": "033160ff", "textColor": "033160ff" }, "defaults": { "backgroundColor": "ffffffff", "borderColor": "424650ff", "textColor": "424650ff" }, "hover": { "backgroundColor": "f2f8fdff", "borderColor": "033160ff", "textColor": "033160ff" } } } }, "pageBackground": { "darkMode": { "color": "0f1b2aff" }, "image": { "enabled": true }, "lightMode": { "color": "ffffffff" } }, "pageFooter": { "backgroundImage": { "enabled": false }, "darkMode": { "background": { "color": "0f141aff" }, "borderColor": "424650ff" }, "lightMode": { "background": { "color": "fafafaff" }, "borderColor": "d5dbdbff" }, "logo": { "enabled": false, "location": "START" } }, "pageHeader": { "backgroundImage": { "enabled": false }, "darkMode": { "background": { "color": "0f141aff" }, "borderColor": "424650ff" }, "lightMode": { "background": { "color": "fafafaff" }, "borderColor": "d5dbdbff" }, "logo": { "enabled": false, "location": "START" } }, "pageText": { "darkMode": { "bodyColor": "b6bec9ff", "descriptionColor": "b6bec9ff", "headingColor": "d1d5dbff" }, "lightMode": { "bodyColor": "414d5cff", "descriptionColor": "414d5cff", "headingColor": "000716ff" } }, "phoneNumberSelector": { "displayType": "TEXT" }, "primaryButton": { "darkMode": { "active": { "backgroundColor": "539fe5ff", "textColor": "000716ff" }, "defaults": { "backgroundColor": "539fe5ff", "textColor": "000716ff" }, "disabled": { "backgroundColor": "ffffffff", "borderColor": "ffffffff" }, "hover": { "backgroundColor": "89bdeeff", "textColor": "000716ff" } }, "lightMode": { "active": { "backgroundColor": "033160ff", "textColor": "ffffffff" }, "defaults": { "backgroundColor": "0972d3ff", "textColor": "ffffffff" }, "disabled": { "backgroundColor": "ffffffff", "borderColor": "ffffffff" }, "hover": { "backgroundColor": "033160ff", "textColor": "ffffffff" } } }, "secondaryButton": { "darkMode": { "active": { "backgroundColor": "354150ff", "borderColor": "89bdeeff", "textColor": "89bdeeff" }, "defaults": { "backgroundColor": "0f1b2aff", "borderColor": "539fe5ff", "textColor": "539fe5ff" }, "hover": { "backgroundColor": "192534ff", "borderColor": "89bdeeff", "textColor": "89bdeeff" } }, "lightMode": { "active": { "backgroundColor": "d3e7f9ff", "borderColor": "033160ff", "textColor": "033160ff" }, "defaults": { "backgroundColor": "ffffffff", "borderColor": "0972d3ff", "textColor": "0972d3ff" }, "hover": { "backgroundColor": "f2f8fdff", "borderColor": "033160ff", "textColor": "033160ff" } } } } }, "UseCognitoProvidedValues": false, "UserPoolId": "ca-central-1_EXAMPLE" } } ``` Consulte mais informações em [Apply branding to managed login pages](https://docs.aws.amazon.com/cognito/latest/developerguide/managed-login-branding.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [UpdateManagedLoginBranding](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-managed-login-branding.html) na *Referência de comandos da AWS CLI*. ### `update-resource-server` O código de exemplo a seguir mostra como usar `update-resource-server`. **AWS CLI** **Para atualizar um servidor de recursos** Este exemplo atualiza o servidor de recursos Weather. Ele adiciona um novo escopo. Comando: ``` aws cognito-idp update-resource-server --user-pool-id us-west-2_aaaaaaaaa --identifier weather.example.com --name Weather --scopes ScopeName=NewScope,ScopeDescription="New scope description" ``` Resultado: ``` { "ResourceServer": { "UserPoolId": "us-west-2_aaaaaaaaa", "Identifier": "weather.example.com", "Name": "Happy", "Scopes": [ { "ScopeName": "NewScope", "ScopeDescription": "New scope description" } ] } } ``` + Para ver detalhes da API, consulte [UpdateResourceServer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-resource-server.html) na *Referência de comandos da AWS CLI*. ### `update-user-attributes` O código de exemplo a seguir mostra como usar `update-user-attributes`. **AWS CLI** **Para atualizar os atributos do usuário** Este exemplo atualiza o atributo de usuário “nickname”. Comando: ``` aws cognito-idp update-user-attributes --access-token ACCESS_TOKEN --user-attributes Name="nickname",Value="Dan" ``` + Para ver detalhes da API, consulte [UpdateUserAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-user-attributes.html) na *Referência de comandos da AWS CLI*. ### `update-user-pool-client` O código de exemplo a seguir mostra como usar `update-user-pool-client`. **AWS CLI** **Como atualizar um cliente de aplicação** O exemplo de `update-user-pool-client` a seguir atualiza a configuração do cliente de aplicação solicitado. ``` aws cognito-idp update-user-pool-client \ --user-pool-id us-west-2_EXAMPLE \ --client-id 1example23456789 \ --client-name my-test-app \ --refresh-token-validity 30 \ --access-token-validity 60 \ --id-token-validity 60 \ --token-validity-units AccessToken=minutes,IdToken=minutes,RefreshToken=days \ --read-attributes "address" "birthdate" "email" "email_verified" "family_name" "gender" "locale" "middle_name" "name" "nickname" "phone_number" "phone_number_verified" "picture" "preferred_username" "profile" "updated_at" "website" "zoneinfo" \ --write-attributes "address" "birthdate" "email" "family_name" "gender" "locale" "middle_name" "name" "nickname" "phone_number" "picture" "preferred_username" "profile" "updated_at" "website" "zoneinfo" \ --explicit-auth-flows "ALLOW_ADMIN_USER_PASSWORD_AUTH" "ALLOW_CUSTOM_AUTH" "ALLOW_REFRESH_TOKEN_AUTH" "ALLOW_USER_PASSWORD_AUTH" "ALLOW_USER_SRP_AUTH" \ --supported-identity-providers "MySAML" "COGNITO" "Google" \ --callback-urls "https://www.example.com" "https://app2.example.com" \ --logout-urls "https://auth.example.com/login?client_id=1example23456789&response_type=code&redirect_uri=https%3A%2F%2Fwww.example.com" "https://example.com/logout" \ --default-redirect-uri "https://www.example.com" \ --allowed-o-auth-flows "code" "implicit" \ --allowed-o-auth-scopes "openid" "profile" "aws.cognito.signin.user.admin" \ --allowed-o-auth-flows-user-pool-client \ --prevent-user-existence-errors ENABLED \ --enable-token-revocation \ --no-enable-propagate-additional-user-context-data \ --auth-session-validity 3 ``` Resultado: ``` { "UserPoolClient": { "UserPoolId": "us-west-2_EXAMPLE", "ClientName": "my-test-app", "ClientId": "1example23456789", "LastModifiedDate": "2025-01-31T14:40:12.498000-08:00", "CreationDate": "2023-09-13T16:26:34.408000-07:00", "RefreshTokenValidity": 30, "AccessTokenValidity": 60, "IdTokenValidity": 60, "TokenValidityUnits": { "AccessToken": "minutes", "IdToken": "minutes", "RefreshToken": "days" }, "ReadAttributes": [ "website", "zoneinfo", "address", "birthdate", "email_verified", "gender", "profile", "phone_number_verified", "preferred_username", "locale", "middle_name", "picture", "updated_at", "name", "nickname", "phone_number", "family_name", "email" ], "WriteAttributes": [ "website", "zoneinfo", "address", "birthdate", "gender", "profile", "preferred_username", "locale", "middle_name", "picture", "updated_at", "name", "nickname", "phone_number", "family_name", "email" ], "ExplicitAuthFlows": [ "ALLOW_CUSTOM_AUTH", "ALLOW_USER_PASSWORD_AUTH", "ALLOW_ADMIN_USER_PASSWORD_AUTH", "ALLOW_USER_SRP_AUTH", "ALLOW_REFRESH_TOKEN_AUTH" ], "SupportedIdentityProviders": [ "Google", "COGNITO", "MySAML" ], "CallbackURLs": [ "https://www.example.com", "https://app2.example.com" ], "LogoutURLs": [ "https://example.com/logout", "https://auth.example.com/login?client_id=1example23456789&response_type=code&redirect_uri=https%3A%2F%2Fwww.example.com" ], "DefaultRedirectURI": "https://www.example.com", "AllowedOAuthFlows": [ "implicit", "code" ], "AllowedOAuthScopes": [ "aws.cognito.signin.user.admin", "openid", "profile" ], "AllowedOAuthFlowsUserPoolClient": true, "PreventUserExistenceErrors": "ENABLED", "EnableTokenRevocation": true, "EnablePropagateAdditionalUserContextData": false, "AuthSessionValidity": 3 } } ``` Consulte mais informações em [Application-specific settings with app clients](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html) no *Guia do desenvolvedor do Amazon Cognito*. + Para ver detalhes da API, consulte [UpdateUserPoolClient](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-user-pool-client.html) na *Referência de comandos da AWS CLI*. ### `update-user-pool-domain` O código de exemplo a seguir mostra como usar `update-user-pool-domain`. **AWS CLI** **Como atualizar um nome de domínio personalizado** O exemplo de `update-user-pool-domain` a seguir configura a versão da marca e o certificado para o domínio personalizado do grupo de usuários solicitado. ``` aws cognito-idp update-user-pool-domain \ --user-pool-id ca-central-1_EXAMPLE \ --domain auth.example.com \ --managed-login-version 2 \ --custom-domain-config CertificateArn=arn:aws:acm:us-east-1:123456789012:certificate/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "CloudFrontDomain": "example.cloudfront.net", "ManagedLoginVersion": 2 } ``` Consulte mais informações em [Managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) e em [Configuring a domain](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [UpdateUserPoolDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-user-pool-domain.html) na *Referência de comandos da AWS CLI*. ### `update-user-pool` O código de exemplo a seguir mostra como usar `update-user-pool`. **AWS CLI** **Para criar um grupo de usuários** O `update-user-pool` exemplo a seguir modifica um grupo de usuários com um exemplo de sintaxe para cada uma das opções de configuração disponíveis. Para atualizar um grupo de usuários, você deve especificar todas as opções configuradas anteriormente ou elas serão redefinidas para um valor padrão. ``` aws cognito-idp update-user-pool --user-pool-id us-west-2_EXAMPLE \ --policies PasswordPolicy=\{MinimumLength=6,RequireUppercase=true,RequireLowercase=true,RequireNumbers=true,RequireSymbols=true,TemporaryPasswordValidityDays=7\} \ --deletion-protection ACTIVE \ --lambda-config PreSignUp="arn:aws:lambda:us-west-2:123456789012:function:cognito-test-presignup-function",PreTokenGeneration="arn:aws:lambda:us-west-2:123456789012:function:cognito-test-pretoken-function" \ --auto-verified-attributes "phone_number" "email" \ --verification-message-template \{\"SmsMessage\":\""Your code is {####}"\",\"EmailMessage\":\""Your code is {####}"\",\"EmailSubject\":\""Your verification code"\",\"EmailMessageByLink\":\""Click {##here##} to verify your email address."\",\"EmailSubjectByLink\":\""Your verification link"\",\"DefaultEmailOption\":\"CONFIRM_WITH_LINK\"\} \ --sms-authentication-message "Your code is {####}" \ --user-attribute-update-settings AttributesRequireVerificationBeforeUpdate="email","phone_number" \ --mfa-configuration "OPTIONAL" \ --device-configuration ChallengeRequiredOnNewDevice=true,DeviceOnlyRememberedOnUserPrompt=true \ --email-configuration SourceArn="arn:aws:ses:us-west-2:123456789012:identity/admin@example.com",ReplyToEmailAddress="amdin+noreply@example.com",EmailSendingAccount=DEVELOPER,From="admin@amazon.com",ConfigurationSet="test-configuration-set" \ --sms-configuration SnsCallerArn="arn:aws:iam::123456789012:role/service-role/SNS-SMS-Role",ExternalId="12345",SnsRegion="us-west-2" \ --admin-create-user-config AllowAdminCreateUserOnly=false,InviteMessageTemplate=\{SMSMessage=\""Welcome {username}. Your confirmation code is {####}"\",EmailMessage=\""Welcome {username}. Your confirmation code is {####}"\",EmailSubject=\""Welcome to MyMobileGame"\"\} \ --user-pool-tags "Function"="MyMobileGame","Developers"="Berlin" \ --admin-create-user-config AllowAdminCreateUserOnly=false,InviteMessageTemplate=\{SMSMessage=\""Welcome {username}. Your confirmation code is {####}"\",EmailMessage=\""Welcome {username}. Your confirmation code is {####}"\",EmailSubject=\""Welcome to MyMobileGame"\"\} \ --user-pool-add-ons AdvancedSecurityMode="AUDIT" \ --account-recovery-setting RecoveryMechanisms=\[\{Priority=1,Name="verified_email"\},\{Priority=2,Name="verified_phone_number"\}\] ``` Este comando não produz saída. Para obter mais informações, consulte [Configurar um cliente de aplicação de grupo de usuários](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-updating.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte detalhes da API em [UpdateUserPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-user-pool.html) na *Referência de comandos da AWS CLI*. ### `verify-software-token` O código de exemplo a seguir mostra como usar `verify-software-token`. **AWS CLI** **Como confirmar o registro de um autenticador TOTP** O exemplo de `verify-software-token` a seguir completa o registro TOTP para o usuário atual. ``` aws cognito-idp verify-software-token \ --access-token eyJra456defEXAMPLE \ --user-code 123456 ``` Resultado: ``` { "Status": "SUCCESS" } ``` Para obter mais informações, consulte [Adicionar MFA a um grupo de usuários](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte os detalhes da API em [VerifySoftwareToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/verify-software-token.html) na *Referência de comandos da AWS CLI*. ### `verify-user-attribute` O código de exemplo a seguir mostra como usar `verify-user-attribute`. **AWS CLI** **Como verificar uma alteração de atributo** O exemplo de `verify-user-attribute` a seguir verifica uma alteração no atributo de e-mail do usuário atual. ``` aws cognito-idp verify-user-attribute \ --access-token eyJra456defEXAMPLE \ --attribute-name email \ --code 123456 ``` Consulte mais informações em [Configuring email or phone verification](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html) no *Guia do desenvolvedor do Amazon Cognito*. + Consulte os detalhes da API em [VerifyUserAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/verify-user-attribute.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon Comprehend usando o AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando oAWS Command Line Interface com Amazon Comprehend. *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 ### `batch-detect-dominant-language` O código de exemplo a seguir mostra como usar `batch-detect-dominant-language`. **AWS CLI** **Para detectar o idioma dominante de vários textos de entrada** O exemplo `batch-detect-dominant-language` a seguir analisa vários textos de entrada e retorna o idioma dominante de cada um. A pontuação de confiança de modelos pré-treinados também é gerada para cada previsão. ``` aws comprehend batch-detect-dominant-language \ --text-list "Physics is the natural science that involves the study of matter and its motion and behavior through space and time, along with related concepts such as energy and force." ``` Resultado: ``` { "ResultList": [ { "Index": 0, "Languages": [ { "LanguageCode": "en", "Score": 0.9986501932144165 } ] } ], "ErrorList": [] } ``` Para obter mais informações, consulte [Idioma dominante](https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [BatchDetectDominantLanguage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/batch-detect-dominant-language.html) na *Referência de comandos da AWS CLI*. ### `batch-detect-entities` O código de exemplo a seguir mostra como usar `batch-detect-entities`. **AWS CLI** **Para detectar entidades de vários textos de entrada** O exemplo `batch-detect-entities` a seguir analisa vários textos de entrada e retorna as entidades nomeadas de cada um. A pontuação de confiança do modelo pré-treinado também é gerada para cada previsão. ``` aws comprehend batch-detect-entities \ --language-code en \ --text-list "Dear Jane, Your AnyCompany Financial Services LLC credit card account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st." "Please send customer feedback to Sunshine Spa, 123 Main St, Anywhere or to Alice at AnySpa@example.com." ``` Resultado: ``` { "ResultList": [ { "Index": 0, "Entities": [ { "Score": 0.9985517859458923, "Type": "PERSON", "Text": "Jane", "BeginOffset": 5, "EndOffset": 9 }, { "Score": 0.9767839312553406, "Type": "ORGANIZATION", "Text": "AnyCompany Financial Services, LLC", "BeginOffset": 16, "EndOffset": 50 }, { "Score": 0.9856694936752319, "Type": "OTHER", "Text": "1111-XXXX-1111-XXXX", "BeginOffset": 71, "EndOffset": 90 }, { "Score": 0.9652159810066223, "Type": "QUANTITY", "Text": ".53", "BeginOffset": 116, "EndOffset": 119 }, { "Score": 0.9986667037010193, "Type": "DATE", "Text": "July 31st", "BeginOffset": 135, "EndOffset": 144 } ] }, { "Index": 1, "Entities": [ { "Score": 0.720084547996521, "Type": "ORGANIZATION", "Text": "Sunshine Spa", "BeginOffset": 33, "EndOffset": 45 }, { "Score": 0.9865870475769043, "Type": "LOCATION", "Text": "123 Main St", "BeginOffset": 47, "EndOffset": 58 }, { "Score": 0.5895616412162781, "Type": "LOCATION", "Text": "Anywhere", "BeginOffset": 60, "EndOffset": 68 }, { "Score": 0.6809214353561401, "Type": "PERSON", "Text": "Alice", "BeginOffset": 75, "EndOffset": 80 }, { "Score": 0.9979087114334106, "Type": "OTHER", "Text": "AnySpa@example.com", "BeginOffset": 84, "EndOffset": 99 } ] } ], "ErrorList": [] } ``` Para obter mais informações, consulte [Entidades](https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [BatchDetectEntities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/batch-detect-entities.html) na *Referência de comandos da AWS CLI*. ### `batch-detect-key-phrases` O código de exemplo a seguir mostra como usar `batch-detect-key-phrases`. **AWS CLI** **Para detectar frases-chave de várias entradas de texto** O exemplo `batch-detect-key-phrases` a seguir analisa vários textos de entrada e retorna as principais frases nominais de cada um. A pontuação de confiança de modelos pré-treinados para cada previsão também é gerada. ``` aws comprehend batch-detect-key-phrases \ --language-code en \ --text-list "Hello Zhang Wei, I am John, writing to you about the trip for next Saturday." "Dear Jane, Your AnyCompany Financial Services LLC credit card account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st." "Please send customer feedback to Sunshine Spa, 123 Main St, Anywhere or to Alice at AnySpa@example.com." ``` Resultado: ``` { "ResultList": [ { "Index": 0, "KeyPhrases": [ { "Score": 0.99700927734375, "Text": "Zhang Wei", "BeginOffset": 6, "EndOffset": 15 }, { "Score": 0.9929308891296387, "Text": "John", "BeginOffset": 22, "EndOffset": 26 }, { "Score": 0.9997230172157288, "Text": "the trip", "BeginOffset": 49, "EndOffset": 57 }, { "Score": 0.9999470114707947, "Text": "next Saturday", "BeginOffset": 62, "EndOffset": 75 } ] }, { "Index": 1, "KeyPhrases": [ { "Score": 0.8358274102210999, "Text": "Dear Jane", "BeginOffset": 0, "EndOffset": 9 }, { "Score": 0.989359974861145, "Text": "Your AnyCompany Financial Services", "BeginOffset": 11, "EndOffset": 45 }, { "Score": 0.8812323808670044, "Text": "LLC credit card account 1111-XXXX-1111-XXXX", "BeginOffset": 47, "EndOffset": 90 }, { "Score": 0.9999381899833679, "Text": "a minimum payment", "BeginOffset": 95, "EndOffset": 112 }, { "Score": 0.9997439980506897, "Text": ".53", "BeginOffset": 116, "EndOffset": 119 }, { "Score": 0.996875524520874, "Text": "July 31st", "BeginOffset": 135, "EndOffset": 144 } ] }, { "Index": 2, "KeyPhrases": [ { "Score": 0.9990295767784119, "Text": "customer feedback", "BeginOffset": 12, "EndOffset": 29 }, { "Score": 0.9994127750396729, "Text": "Sunshine Spa", "BeginOffset": 33, "EndOffset": 45 }, { "Score": 0.9892991185188293, "Text": "123 Main St", "BeginOffset": 47, "EndOffset": 58 }, { "Score": 0.9969810843467712, "Text": "Alice", "BeginOffset": 75, "EndOffset": 80 }, { "Score": 0.9703696370124817, "Text": "AnySpa@example.com", "BeginOffset": 84, "EndOffset": 99 } ] } ], "ErrorList": [] } ``` Para obter mais informações, consulte [Frases-chave](https://docs.aws.amazon.com/comprehend/latest/dg/how-key-phrases.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [BatchDetectKeyPhrases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/batch-detect-key-phrases.html) na *Referência de comandos da AWS CLI*. ### `batch-detect-sentiment` O código de exemplo a seguir mostra como usar `batch-detect-sentiment`. **AWS CLI** **Para detectar o sentimento predominante de vários textos de entrada** O exemplo `batch-detect-sentiment` a seguir analisa vários textos de entrada e retorna o sentimento predominante (`POSITIVE`, `NEUTRAL`, `MIXED` ou `NEGATIVE` de cada um). ``` aws comprehend batch-detect-sentiment \ --text-list "That movie was very boring, I can't believe it was over four hours long." "It is a beautiful day for hiking today." "My meal was okay, I'm excited to try other restaurants." \ --language-code en ``` Resultado: ``` { "ResultList": [ { "Index": 0, "Sentiment": "NEGATIVE", "SentimentScore": { "Positive": 0.00011316669406369328, "Negative": 0.9995445609092712, "Neutral": 0.00014722718333359808, "Mixed": 0.00019498742767609656 } }, { "Index": 1, "Sentiment": "POSITIVE", "SentimentScore": { "Positive": 0.9981263279914856, "Negative": 0.00015240783977787942, "Neutral": 0.0013876151060685515, "Mixed": 0.00033366199932061136 } }, { "Index": 2, "Sentiment": "MIXED", "SentimentScore": { "Positive": 0.15930435061454773, "Negative": 0.11471917480230331, "Neutral": 0.26897063851356506, "Mixed": 0.45700588822364807 } } ], "ErrorList": [] } ``` Para obter mais informações, consulte [Sentimento](https://docs.aws.amazon.com/comprehend/latest/dg/how-sentiment.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [BatchDetectSentiment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/batch-detect-sentiment.html) na *Referência de comandos da AWS CLI*. ### `batch-detect-syntax` O código de exemplo a seguir mostra como usar `batch-detect-syntax`. **AWS CLI** **Para inspecionar a sintaxe e partes da fala de palavras em vários textos de entrada** O exemplo `batch-detect-syntax` a seguir analisa a sintaxe de vários textos de entrada e retorna as diferentes partes da fala. A pontuação de confiança do modelo pré-treinado também é gerada para cada previsão. ``` aws comprehend batch-detect-syntax \ --text-list "It is a beautiful day." "Can you please pass the salt?" "Please pay the bill before the 31st." \ --language-code en ``` Resultado: ``` { "ResultList": [ { "Index": 0, "SyntaxTokens": [ { "TokenId": 1, "Text": "It", "BeginOffset": 0, "EndOffset": 2, "PartOfSpeech": { "Tag": "PRON", "Score": 0.9999740719795227 } }, { "TokenId": 2, "Text": "is", "BeginOffset": 3, "EndOffset": 5, "PartOfSpeech": { "Tag": "VERB", "Score": 0.999937117099762 } }, { "TokenId": 3, "Text": "a", "BeginOffset": 6, "EndOffset": 7, "PartOfSpeech": { "Tag": "DET", "Score": 0.9999926686286926 } }, { "TokenId": 4, "Text": "beautiful", "BeginOffset": 8, "EndOffset": 17, "PartOfSpeech": { "Tag": "ADJ", "Score": 0.9987891912460327 } }, { "TokenId": 5, "Text": "day", "BeginOffset": 18, "EndOffset": 21, "PartOfSpeech": { "Tag": "NOUN", "Score": 0.9999778866767883 } }, { "TokenId": 6, "Text": ".", "BeginOffset": 21, "EndOffset": 22, "PartOfSpeech": { "Tag": "PUNCT", "Score": 0.9999974966049194 } } ] }, { "Index": 1, "SyntaxTokens": [ { "TokenId": 1, "Text": "Can", "BeginOffset": 0, "EndOffset": 3, "PartOfSpeech": { "Tag": "AUX", "Score": 0.9999770522117615 } }, { "TokenId": 2, "Text": "you", "BeginOffset": 4, "EndOffset": 7, "PartOfSpeech": { "Tag": "PRON", "Score": 0.9999986886978149 } }, { "TokenId": 3, "Text": "please", "BeginOffset": 8, "EndOffset": 14, "PartOfSpeech": { "Tag": "INTJ", "Score": 0.9681622385978699 } }, { "TokenId": 4, "Text": "pass", "BeginOffset": 15, "EndOffset": 19, "PartOfSpeech": { "Tag": "VERB", "Score": 0.9999874830245972 } }, { "TokenId": 5, "Text": "the", "BeginOffset": 20, "EndOffset": 23, "PartOfSpeech": { "Tag": "DET", "Score": 0.9999827146530151 } }, { "TokenId": 6, "Text": "salt", "BeginOffset": 24, "EndOffset": 28, "PartOfSpeech": { "Tag": "NOUN", "Score": 0.9995040893554688 } }, { "TokenId": 7, "Text": "?", "BeginOffset": 28, "EndOffset": 29, "PartOfSpeech": { "Tag": "PUNCT", "Score": 0.999998152256012 } } ] }, { "Index": 2, "SyntaxTokens": [ { "TokenId": 1, "Text": "Please", "BeginOffset": 0, "EndOffset": 6, "PartOfSpeech": { "Tag": "INTJ", "Score": 0.9997857809066772 } }, { "TokenId": 2, "Text": "pay", "BeginOffset": 7, "EndOffset": 10, "PartOfSpeech": { "Tag": "VERB", "Score": 0.9999252557754517 } }, { "TokenId": 3, "Text": "the", "BeginOffset": 11, "EndOffset": 14, "PartOfSpeech": { "Tag": "DET", "Score": 0.9999842643737793 } }, { "TokenId": 4, "Text": "bill", "BeginOffset": 15, "EndOffset": 19, "PartOfSpeech": { "Tag": "NOUN", "Score": 0.9999588131904602 } }, { "TokenId": 5, "Text": "before", "BeginOffset": 20, "EndOffset": 26, "PartOfSpeech": { "Tag": "ADP", "Score": 0.9958304762840271 } }, { "TokenId": 6, "Text": "the", "BeginOffset": 27, "EndOffset": 30, "PartOfSpeech": { "Tag": "DET", "Score": 0.9999947547912598 } }, { "TokenId": 7, "Text": "31st", "BeginOffset": 31, "EndOffset": 35, "PartOfSpeech": { "Tag": "NOUN", "Score": 0.9924124479293823 } }, { "TokenId": 8, "Text": ".", "BeginOffset": 35, "EndOffset": 36, "PartOfSpeech": { "Tag": "PUNCT", "Score": 0.9999955892562866 } } ] } ], "ErrorList": [] } ``` Para obter mais informações, consulte [Análise de sintaxe](https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [BatchDetectSyntax](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/batch-detect-syntax.html) na *Referência de comandos da AWS CLI*. ### `batch-detect-targeted-sentiment` O código de exemplo a seguir mostra como usar `batch-detect-targeted-sentiment`. **AWS CLI** **Para detectar o sentimento e cada entidade nomeada para vários textos de entrada** O exemplo `batch-detect-targeted-sentiment` a seguir analisa vários textos de entrada e retorna as entidades nomeadas junto com o sentimento predominante associado a cada entidade. A pontuação de confiança do modelo pré-treinado também é gerada para cada previsão. ``` aws comprehend batch-detect-targeted-sentiment \ --language-code en \ --text-list "That movie was really boring, the original was way more entertaining" "The trail is extra beautiful today." "My meal was just okay." ``` Resultado: ``` { "ResultList": [ { "Index": 0, "Entities": [ { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "Score": 0.9999009966850281, "GroupScore": 1.0, "Text": "movie", "Type": "MOVIE", "MentionSentiment": { "Sentiment": "NEGATIVE", "SentimentScore": { "Positive": 0.13887299597263336, "Negative": 0.8057460188865662, "Neutral": 0.05525200068950653, "Mixed": 0.00012799999967683107 } }, "BeginOffset": 5, "EndOffset": 10 } ] }, { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "Score": 0.9921110272407532, "GroupScore": 1.0, "Text": "original", "Type": "MOVIE", "MentionSentiment": { "Sentiment": "POSITIVE", "SentimentScore": { "Positive": 0.9999989867210388, "Negative": 9.999999974752427e-07, "Neutral": 0.0, "Mixed": 0.0 } }, "BeginOffset": 34, "EndOffset": 42 } ] } ] }, { "Index": 1, "Entities": [ { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "Score": 0.7545599937438965, "GroupScore": 1.0, "Text": "trail", "Type": "OTHER", "MentionSentiment": { "Sentiment": "POSITIVE", "SentimentScore": { "Positive": 1.0, "Negative": 0.0, "Neutral": 0.0, "Mixed": 0.0 } }, "BeginOffset": 4, "EndOffset": 9 } ] }, { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "Score": 0.9999960064888, "GroupScore": 1.0, "Text": "today", "Type": "DATE", "MentionSentiment": { "Sentiment": "NEUTRAL", "SentimentScore": { "Positive": 9.000000318337698e-06, "Negative": 1.9999999949504854e-06, "Neutral": 0.9999859929084778, "Mixed": 3.999999989900971e-06 } }, "BeginOffset": 29, "EndOffset": 34 } ] } ] }, { "Index": 2, "Entities": [ { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "Score": 0.9999880194664001, "GroupScore": 1.0, "Text": "My", "Type": "PERSON", "MentionSentiment": { "Sentiment": "NEUTRAL", "SentimentScore": { "Positive": 0.0, "Negative": 0.0, "Neutral": 1.0, "Mixed": 0.0 } }, "BeginOffset": 0, "EndOffset": 2 } ] }, { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "Score": 0.9995260238647461, "GroupScore": 1.0, "Text": "meal", "Type": "OTHER", "MentionSentiment": { "Sentiment": "NEUTRAL", "SentimentScore": { "Positive": 0.04695599898695946, "Negative": 0.003226999891921878, "Neutral": 0.6091709733009338, "Mixed": 0.34064599871635437 } }, "BeginOffset": 3, "EndOffset": 7 } ] } ] } ], "ErrorList": [] } ``` Para obter mais informações, consulte [Sentimentos direcionados](https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [BatchDetectTargetedSentiment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/batch-detect-targeted-sentiment.html) na *Referência de comandos da AWS CLI*. ### `classify-document` O código de exemplo a seguir mostra como usar `classify-document`. **AWS CLI** **Para classificar o documento com um endpoint específico do modelo** O exemplo `classify-document` a seguir classifica um documento com um endpoint de um modelo personalizado. O modelo neste exemplo foi treinado em um conjunto de dados contendo mensagens SMS rotuladas como spam ou não spam, ou “ham”. ``` aws comprehend classify-document \ --endpoint-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint \ --text "CONGRATULATIONS! TXT 1235550100 to win $5000" ``` Resultado: ``` { "Classes": [ { "Name": "spam", "Score": 0.9998599290847778 }, { "Name": "ham", "Score": 0.00014001205272506922 } ] } ``` Para obter mais informações, consulte [Classificação personalizada](https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [ClassifyDocument](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/classify-document.html) na *Referência de comandos da AWS CLI*. ### `contains-pii-entities` O código de exemplo a seguir mostra como usar `contains-pii-entities`. **AWS CLI** **Para analisar o texto de entrada quanto à presença de informações de PII** O exemplo `contains-pii-entities` a seguir analisa o texto de entrada para detectar a presença de informações de identificação pessoal (PII) e retorna os rótulos dos tipos de entidade de PII identificados, como nome, endereço, número da conta bancária ou número de telefone. ``` aws comprehend contains-pii-entities \ --language-code en \ --text "Hello Zhang Wei, I am John. Your AnyCompany Financial Services, LLC credit card account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st. Based on your autopay settings, we will withdraw your payment on the due date from your bank account number XXXXXX1111 with the routing number XXXXX0000. Customer feedback for Sunshine Spa, 100 Main St, Anywhere. Send comments to Alice at AnySpa@example.com." ``` Resultado: ``` { "Labels": [ { "Name": "NAME", "Score": 1.0 }, { "Name": "EMAIL", "Score": 1.0 }, { "Name": "BANK_ACCOUNT_NUMBER", "Score": 0.9995794296264648 }, { "Name": "BANK_ROUTING", "Score": 0.9173126816749573 }, { "Name": "CREDIT_DEBIT_NUMBER", "Score": 1.0 } } ``` Para obter mais informações, consulte [Informações de identificação pessoal (PII)](https://docs.aws.amazon.com/comprehend/latest/dg/pii.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [ContainsPiiEntities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/contains-pii-entities.html) na *Referência de comandos da AWS CLI*. ### `create-dataset` O código de exemplo a seguir mostra como usar `create-dataset`. **AWS CLI** **Para criar um conjunto de dados do flywheel** O exemplo `create-dataset` a seguir cria um conjunto de dados para um flywheel. Esse conjunto de dados será usado como dados adicionais de treinamento, conforme especificado pela tag `--dataset-type`. ``` aws comprehend create-dataset \ --flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity \ --dataset-name example-dataset \ --dataset-type "TRAIN" \ --input-data-config file://inputConfig.json ``` Conteúdo de `file://inputConfig.json`: ``` { "DataFormat": "COMPREHEND_CSV", "DocumentClassifierInputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/training-data.csv" } } ``` Resultado: ``` { "DatasetArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity/dataset/example-dataset" } ``` Para obter mais informações, consulte [Visão geral do flywheel](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [CreateDataset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/create-dataset.html) na *Referência de comandos da AWS CLI*. ### `create-document-classifier` O código de exemplo a seguir mostra como usar `create-document-classifier`. **AWS CLI** **Para criar um classificador de documentos para categorizar documentos** O exemplo de `create-document-classifier` a seguir inicia o processo de treinamento para um modelo de classificador de documentos. O arquivo de dados de treinamento, `training.csv`, está localizado na tag `--input-data-config`. `training.csv` é um documento de duas colunas em que os rótulos ou classificações são fornecidos na primeira coluna e os documentos são fornecidos na segunda coluna. ``` aws comprehend create-document-classifier \ --document-classifier-name example-classifier \ --data-access-arn arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/123456abcdeb0e11022f22a11EXAMPLE \ --input-data-config "S3Uri=s3://amzn-s3-demo-bucket/" \ --language-code en ``` Resultado: ``` { "DocumentClassifierArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier" } ``` Para obter mais informações, consulte [Classificação personalizada](https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Consulte detalhes da API em [CreateDocumentClassifier](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/create-document-classifier.html) na *Referência de comandos da AWS CLI*. ### `create-endpoint` O código de exemplo a seguir mostra como usar `create-endpoint`. **AWS CLI** **Para criar um endpoint para um modelo personalizado** O exemplo `create-endpoint` a seguir cria um endpoint para inferência síncrona de um modelo personalizado previamente treinado. ``` aws comprehend create-endpoint \ --endpoint-name example-classifier-endpoint-1 \ --model-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier \ --desired-inference-units 1 ``` Resultado: ``` { "EndpointArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint-1" } ``` Para obter mais informações, consulte [Gerenciar endpoints do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [CreateEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/create-endpoint.html) na *Referência de comandos da AWS CLI*. ### `create-entity-recognizer` O código de exemplo a seguir mostra como usar `create-entity-recognizer`. **AWS CLI** **Para criar um reconhecedor de entidades personalizado** O exemplo `create-entity-recognizer` a seguir inicia o processo de treinamento para um modelo de reconhecimento personalizado de entidades. Este exemplo usa um arquivo CSV contendo documentos de treinamento, `raw_text.csv`, e uma lista de entidades CSV, `entity_list.csv`, para treinar o modelo. `entity-list.csv` contém as seguintes colunas: texto e tipo. ``` aws comprehend create-entity-recognizer \ --recognizer-name example-entity-recognizer --data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role \ --input-data-config "EntityTypes=[{Type=DEVICE}],Documents={S3Uri=s3://amzn-s3-demo-bucket/trainingdata/raw_text.csv},EntityList={S3Uri=s3://amzn-s3-demo-bucket/trainingdata/entity_list.csv}" --language-code en ``` Resultado: ``` { "EntityRecognizerArn": "arn:aws:comprehend:us-west-2:111122223333:example-entity-recognizer/entityrecognizer1" } ``` Para obter mais informações, consulte [Reconhecimento de entidades personalizado](https://docs.aws.amazon.com/comprehend/latest/dg/custom-entity-recognition.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [CreateEntityRecognizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/create-entity-recognizer.html) na *Referência de comandos da AWS CLI*. ### `create-flywheel` O código de exemplo a seguir mostra como usar `create-flywheel`. **AWS CLI** **Para criar um flywheel** O exemplo `create-flywheel` a seguir cria um flywheel para orquestrar o treinamento contínuo de um modelo de classificação de documentos ou de reconhecimento de entidades. O flywheel neste exemplo foi criado para gerenciar um modelo treinado existente especificado pela tag `--active-model-arn`. Quando o flywheel é criado, um data lake é criado na tag `--input-data-lake`. ``` aws comprehend create-flywheel \ --flywheel-name example-flywheel \ --active-model-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-model/version/1 \ --data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role \ --data-lake-s3-uri "s3://amzn-s3-demo-bucket" ``` Resultado: ``` { "FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel" } ``` Para obter mais informações, consulte [Visão geral do flywheel](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [CreateFlywheel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/create-flywheel.html) na *Referência de comandos da AWS CLI*. ### `delete-document-classifier` O código de exemplo a seguir mostra como usar `delete-document-classifier`. **AWS CLI** **Para excluir um classificador de documentos personalizado** O exemplo de `delete-document-classifier` a seguir exclui um modelo de classificador de documentos personalizado. ``` aws comprehend delete-document-classifier \ --document-classifier-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier-1 ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar endpoints do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Consulte detalhes da API em [DeleteDocumentClassifier](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/delete-document-classifier.html) na *Referência de comandos da AWS CLI*. ### `delete-endpoint` O código de exemplo a seguir mostra como usar `delete-endpoint`. **AWS CLI** **Para excluir um endpoint para um modelo personalizado** O exemplo `delete-endpoint` a seguir exclui um endpoint específico do modelo. Todos os endpoints devem ser excluídos para que o modelo seja excluído. ``` aws comprehend delete-endpoint \ --endpoint-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint-1 ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar endpoints do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [DeleteEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/delete-endpoint.html) na *Referência de comandos da AWS CLI*. ### `delete-entity-recognizer` O código de exemplo a seguir mostra como usar `delete-entity-recognizer`. **AWS CLI** **Para excluir um modelo de reconhecimento personalizado de entidades** O exemplo `delete-entity-recognizer` a seguir exclui um modelo de reconhecimento de entidades. ``` aws comprehend delete-entity-recognizer \ --entity-recognizer-arn arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/example-entity-recognizer-1 ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar endpoints do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [DeleteEntityRecognizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/delete-entity-recognizer.html) na *Referência de comandos da AWS CLI*. ### `delete-flywheel` O código de exemplo a seguir mostra como usar `delete-flywheel`. **AWS CLI** **Para excluir um flywheel** O exemplo `delete-flywheel` a seguir exclui um flywheel. O data lake ou o modelo associado ao flywheel não é excluído. ``` aws comprehend delete-flywheel \ --flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel-1 ``` Este comando não produz saída. Para obter mais informações, consulte [Visão geral do flywheel](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [DeleteFlywheel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/delete-flywheel.html) na *Referência de comandos da AWS CLI*. ### `delete-resource-policy` O código de exemplo a seguir mostra como usar `delete-resource-policy`. **AWS CLI** **Para excluir uma política baseada em recurso** O exemplo `delete-resource-policy` a seguir exclui uma política baseada em recursos de um recurso do Amazon Comprehend. ``` aws comprehend delete-resource-policy \ --resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier-1/version/1 ``` Este comando não produz saída. Para obter mais informações, consulte [Copiar modelos personalizados entre contas da AWS](https://docs.aws.amazon.com/comprehend/latest/dg/custom-copy.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [DeleteResourcePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/delete-resource-policy.html) na *Referência de comandos da AWS CLI*. ### `describe-dataset` O código de exemplo a seguir mostra como usar `describe-dataset`. **AWS CLI** **Para descrever um conjunto de dados do flywheel** O exemplo `describe-dataset` a seguir obtém as propriedades de um conjunto de dados do flywheel. ``` aws comprehend describe-dataset \ --dataset-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity/dataset/example-dataset ``` Resultado: ``` { "DatasetProperties": { "DatasetArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity/dataset/example-dataset", "DatasetName": "example-dataset", "DatasetType": "TRAIN", "DatasetS3Uri": "s3://amzn-s3-demo-bucket/flywheel-entity/schemaVersion=1/12345678A123456Z/datasets/example-dataset/20230616T203710Z/", "Status": "CREATING", "CreationTime": "2023-06-16T20:37:10.400000+00:00" } } ``` Para obter mais informações, consulte [Visão geral do flywheel](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [DescribeDataset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-dataset.html) na *Referência de comandos da AWS CLI*. ### `describe-document-classification-job` O código de exemplo a seguir mostra como usar `describe-document-classification-job`. **AWS CLI** **Para descrever um trabalho de classificação de documentos** O exemplo de `describe-document-classification-job` a seguir obtém as propriedades de um trabalho assíncrono de classificação de documentos. ``` aws comprehend describe-document-classification-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` Resultado: ``` { "DocumentClassificationJobProperties": { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:document-classification-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "exampleclassificationjob", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-14T17:09:51.788000+00:00", "EndTime": "2023-06-14T17:15:58.582000+00:00", "DocumentClassifierArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/mymodel/version/1", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/jobdata/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-CLN-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-servicerole" } } ``` Para obter mais informações, consulte [Classificação personalizada](https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Consulte detalhes da API em [DescribeDocumentClassificationJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-document-classification-job.html) na *Referência de comandos da AWS CLI*. ### `describe-document-classifier` O código de exemplo a seguir mostra como usar `describe-document-classifier`. **AWS CLI** **Para descrever um classificador de documentos** O exemplo de `describe-document-classifier` a seguir obtém as propriedades de um modelo de classificador de documentos personalizado. ``` aws comprehend describe-document-classifier \ --document-classifier-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier-1 ``` Resultado: ``` { "DocumentClassifierProperties": { "DocumentClassifierArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier-1", "LanguageCode": "en", "Status": "TRAINED", "SubmitTime": "2023-06-13T19:04:15.735000+00:00", "EndTime": "2023-06-13T19:42:31.752000+00:00", "TrainingStartTime": "2023-06-13T19:08:20.114000+00:00", "TrainingEndTime": "2023-06-13T19:41:35.080000+00:00", "InputDataConfig": { "DataFormat": "COMPREHEND_CSV", "S3Uri": "s3://amzn-s3-demo-bucket/trainingdata" }, "OutputDataConfig": {}, "ClassifierMetadata": { "NumberOfLabels": 3, "NumberOfTrainedDocuments": 5016, "NumberOfTestDocuments": 557, "EvaluationMetrics": { "Accuracy": 0.9856, "Precision": 0.9919, "Recall": 0.9459, "F1Score": 0.9673, "MicroPrecision": 0.9856, "MicroRecall": 0.9856, "MicroF1Score": 0.9856, "HammingLoss": 0.0144 } }, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role", "Mode": "MULTI_CLASS" } } ``` Para obter mais informações, consulte [Criação e gerenciamento de modelos personalizados](https://docs.aws.amazon.com/comprehend/latest/dg/manage-models.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Consulte detalhes da API em [DescribeDocumentClassifier](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-document-classifier.html) na *Referência de comandos da AWS CLI*. ### `describe-dominant-language-detection-job` O código de exemplo a seguir mostra como usar `describe-dominant-language-detection-job`. **AWS CLI** **Para descrever um trabalho de detecção de idioma dominante.** O exemplo `describe-dominant-language-detection-job` a seguir obtém as propriedades de um trabalho assíncrono de detecção de idioma dominante. ``` aws comprehend describe-dominant-language-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` Resultado: ``` { "DominantLanguageDetectionJobProperties": { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "languageanalysis1", "JobStatus": "IN_PROGRESS", "SubmitTime": "2023-06-09T18:10:38.037000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-LANGUAGE-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" } } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [DescribeDominantLanguageDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-dominant-language-detection-job.html) na *Referência de comandos da AWS CLI*. ### `describe-endpoint` O código de exemplo a seguir mostra como usar `describe-endpoint`. **AWS CLI** **Para descrever um endpoint específico** O exemplo `describe-endpoint` a seguir obtém as propriedades de um endpoint específico do modelo. ``` aws comprehend describe-endpoint \ --endpoint-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint ``` Resultado: ``` { "EndpointProperties": { "EndpointArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint, "Status": "IN_SERVICE", "ModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier1", "DesiredModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier1", "DesiredInferenceUnits": 1, "CurrentInferenceUnits": 1, "CreationTime": "2023-06-13T20:32:54.526000+00:00", "LastModifiedTime": "2023-06-13T20:32:54.526000+00:00" } } ``` Para obter mais informações, consulte [Gerenciar endpoints do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Consulte detalhes da API em [DescribeEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-endpoint.html) na *Referência de comandos da AWS CLI*. ### `describe-entities-detection-job` O código de exemplo a seguir mostra como usar `describe-entities-detection-job`. **AWS CLI** **Para descrever um trabalho de detecção de entidades** O exemplo `describe-entities-detection-job` a seguir obtém as propriedades de um trabalho assíncrono de detecção de entidades. ``` aws comprehend describe-entities-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` Resultado: ``` { "EntitiesDetectionJobProperties": { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "example-entity-detector", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-08T21:30:15.323000+00:00", "EndTime": "2023-06-08T21:40:23.509000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/AsyncBatchJobs/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/thefolder/111122223333-NER-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::12345678012:role/service-role/AmazonComprehendServiceRole-example-role" } } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [DescribeEntitiesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-entities-detection-job.html) na *Referência de comandos da AWS CLI*. ### `describe-entity-recognizer` O código de exemplo a seguir mostra como usar `describe-entity-recognizer`. **AWS CLI** **Para descrever um reconhecedor de entidades** O exemplo `describe-entity-recognizer` a seguir obtém as propriedades de um modelo de reconhecimento personalizado de entidades. ``` aws comprehend describe-entity-recognizer \ entity-recognizer-arn arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/business-recongizer-1/version/1 ``` Resultado: ``` { "EntityRecognizerProperties": { "EntityRecognizerArn": "arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/business-recongizer-1/version/1", "LanguageCode": "en", "Status": "TRAINED", "SubmitTime": "2023-06-14T20:44:59.631000+00:00", "EndTime": "2023-06-14T20:59:19.532000+00:00", "TrainingStartTime": "2023-06-14T20:48:52.811000+00:00", "TrainingEndTime": "2023-06-14T20:58:11.473000+00:00", "InputDataConfig": { "DataFormat": "COMPREHEND_CSV", "EntityTypes": [ { "Type": "BUSINESS" } ], "Documents": { "S3Uri": "s3://amzn-s3-demo-bucket/trainingdata/dataset/", "InputFormat": "ONE_DOC_PER_LINE" }, "EntityList": { "S3Uri": "s3://amzn-s3-demo-bucket/trainingdata/entity.csv" } }, "RecognizerMetadata": { "NumberOfTrainedDocuments": 1814, "NumberOfTestDocuments": 486, "EvaluationMetrics": { "Precision": 100.0, "Recall": 100.0, "F1Score": 100.0 }, "EntityTypes": [ { "Type": "BUSINESS", "EvaluationMetrics": { "Precision": 100.0, "Recall": 100.0, "F1Score": 100.0 }, "NumberOfTrainMentions": 1520 } ] }, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role", "VersionName": "1" } } ``` Para obter mais informações, consulte [Reconhecimento de entidades personalizado](https://docs.aws.amazon.com/comprehend/latest/dg/custom-entity-recognition.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [DescribeEntityRecognizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-entity-recognizer.html) na *Referência de comandos da AWS CLI*. ### `describe-events-detection-job` O código de exemplo a seguir mostra como usar `describe-events-detection-job`. **AWS CLI** **Para descrever um trabalho de detecção de eventos.** O exemplo `describe-events-detection-job` a seguir obtém as propriedades de um trabalho assíncrono de detecção de eventos. ``` aws comprehend describe-events-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` Resultado: ``` { "EventsDetectionJobProperties": { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:events-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "events_job_1", "JobStatus": "IN_PROGRESS", "SubmitTime": "2023-06-12T18:45:56.054000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/EventsData", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-EVENTS-123456abcdeb0e11022f22a11EXAMPLE/output/" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role", "TargetEventTypes": [ "BANKRUPTCY", "EMPLOYMENT", "CORPORATE_ACQUISITION", "CORPORATE_MERGER", "INVESTMENT_GENERAL" ] } } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [DescribeEventsDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-events-detection-job.html) na *Referência de comandos da AWS CLI*. ### `describe-flywheel-iteration` O código de exemplo a seguir mostra como usar `describe-flywheel-iteration`. **AWS CLI** **Para descrever uma iteração do flywheel** O exemplo `describe-flywheel-iteration` a seguir obtém as propriedades de uma iteração do flywheel. ``` aws comprehend describe-flywheel-iteration \ --flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel \ --flywheel-iteration-id 20232222AEXAMPLE ``` Resultado: ``` { "FlywheelIterationProperties": { "FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity", "FlywheelIterationId": "20232222AEXAMPLE", "CreationTime": "2023-06-16T21:10:26.385000+00:00", "EndTime": "2023-06-16T23:33:16.827000+00:00", "Status": "COMPLETED", "Message": "FULL_ITERATION: Flywheel iteration performed all functions successfully.", "EvaluatedModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1", "EvaluatedModelMetrics": { "AverageF1Score": 0.7742663922375772, "AveragePrecision": 0.8287636394041166, "AverageRecall": 0.7427084833645399, "AverageAccuracy": 0.8795394154118689 }, "TrainedModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/Comprehend-Generated-v1-bb52d585", "TrainedModelMetrics": { "AverageF1Score": 0.9767700253081214, "AveragePrecision": 0.9767700253081214, "AverageRecall": 0.9767700253081214, "AverageAccuracy": 0.9858281665190434 }, "EvaluationManifestS3Prefix": "s3://amzn-s3-demo-destination-bucket/flywheel-entity/schemaVersion=1/20230616T200543Z/evaluation/20230616T211026Z/" } } ``` Para obter mais informações, consulte [Visão geral do flywheel](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [DescribeFlywheelIteration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-flywheel-iteration.html) na *Referência de comandos da AWS CLI*. ### `describe-flywheel` O código de exemplo a seguir mostra como usar `describe-flywheel`. **AWS CLI** **Para descrever um flywheel** O exemplo `describe-flywheel` a seguir obtém as propriedades de um flywheel. Neste exemplo, o modelo associado ao flywheel é um modelo de classificador personalizado treinado para classificar documentos como spam ou não spam, ou como “ham”. ``` aws comprehend describe-flywheel \ --flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel ``` Resultado: ``` { "FlywheelProperties": { "FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel", "ActiveModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-model/version/1", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role", "TaskConfig": { "LanguageCode": "en", "DocumentClassificationConfig": { "Mode": "MULTI_CLASS", "Labels": [ "ham", "spam" ] } }, "DataLakeS3Uri": "s3://amzn-s3-demo-bucket/example-flywheel/schemaVersion=1/20230616T200543Z/", "DataSecurityConfig": {}, "Status": "ACTIVE", "ModelType": "DOCUMENT_CLASSIFIER", "CreationTime": "2023-06-16T20:05:43.242000+00:00", "LastModifiedTime": "2023-06-16T20:21:43.567000+00:00" } } ``` Para obter mais informações, consulte [Visão geral do flywheel](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [DescribeFlywheel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-flywheel.html) na *Referência de comandos da AWS CLI*. ### `describe-key-phrases-detection-job` O código de exemplo a seguir mostra como usar `describe-key-phrases-detection-job`. **AWS CLI** **Para descrever um trabalho de detecção de frases-chave** O exemplo `describe-key-phrases-detection-job` a seguir obtém as propriedades de um trabalho assíncrono de detecção de frases-chave. ``` aws comprehend describe-key-phrases-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` Resultado: ``` { "KeyPhrasesDetectionJobProperties": { "JobId": "69aa080c00fc68934a6a98f10EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/69aa080c00fc68934a6a98f10EXAMPLE", "JobName": "example-key-phrases-detection-job", "JobStatus": "COMPLETED", "SubmitTime": 1686606439.177, "EndTime": 1686606806.157, "InputDataConfig": { "S3Uri": "s3://dereksbucket1001/EventsData/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://dereksbucket1002/testfolder/111122223333-KP-69aa080c00fc68934a6a98f10EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-testrole" } } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [DescribeKeyPhrasesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-key-phrases-detection-job.html) na *Referência de comandos da AWS CLI*. ### `describe-pii-entities-detection-job` O código de exemplo a seguir mostra como usar `describe-pii-entities-detection-job`. **AWS CLI** **Para descrever um trabalho de detecção de entidades de PII** O exemplo `describe-pii-entities-detection-job` a seguir obtém as propriedades de um trabalho assíncrono de detecção de entidades de pii. ``` aws comprehend describe-pii-entities-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` Resultado: ``` { "PiiEntitiesDetectionJobProperties": { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "example-pii-entities-job", "JobStatus": "IN_PROGRESS", "SubmitTime": "2023-06-08T21:30:15.323000+00:00", "EndTime": "2023-06-08T21:40:23.509000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/AsyncBatchJobs/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/thefolder/111122223333-NER-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::12345678012:role/service-role/AmazonComprehendServiceRole-example-role" } } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [DescribePiiEntitiesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-pii-entities-detection-job.html) na *Referência de comandos da AWS CLI*. ### `describe-resource-policy` O código de exemplo a seguir mostra como usar `describe-resource-policy`. **AWS CLI** **Para descrever uma política de recursos anexada a um modelo** O exemplo `describe-resource-policy` a seguir obtém as propriedades de uma política baseada em recursos anexada a um modelo. ``` aws comprehend describe-resource-policy \ --resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1 ``` Resultado: ``` { "ResourcePolicy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::444455556666:root\"},\"Action\":\"comprehend:ImportModel\",\"Resource\":\"*\"}]}", "CreationTime": "2023-06-19T18:44:26.028000+00:00", "LastModifiedTime": "2023-06-19T18:53:02.002000+00:00", "PolicyRevisionId": "baa675d069d07afaa2aa3106ae280f61" } ``` Para obter mais informações, consulte [Copiar modelos personalizados entre contas da AWS](https://docs.aws.amazon.com/comprehend/latest/dg/custom-copy.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [DescribeResourcePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-resource-policy.html) na *Referência de comandos da AWS CLI*. ### `describe-sentiment-detection-job` O código de exemplo a seguir mostra como usar `describe-sentiment-detection-job`. **AWS CLI** **Para descrever um trabalho de detecção de sentimentos** O exemplo `describe-sentiment-detection-job` a seguir obtém as propriedades de um trabalho assíncrono de detecção de sentimentos. ``` aws comprehend describe-sentiment-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` Resultado: ``` { "SentimentDetectionJobProperties": { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "movie_review_analysis", "JobStatus": "IN_PROGRESS", "SubmitTime": "2023-06-09T23:16:15.956000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/MovieData", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-TS-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-servicerole" } } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [DescribeSentimentDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-sentiment-detection-job.html) na *Referência de comandos da AWS CLI*. ### `describe-targeted-sentiment-detection-job` O código de exemplo a seguir mostra como usar `describe-targeted-sentiment-detection-job`. **AWS CLI** **Para descrever um trabalho de detecção de sentimentos direcionados** O exemplo `describe-targeted-sentiment-detection-job` a seguir obtém as propriedades de um trabalho assíncrono de detecção de sentimentos direcionados. ``` aws comprehend describe-targeted-sentiment-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` Resultado: ``` { "TargetedSentimentDetectionJobProperties": { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "movie_review_analysis", "JobStatus": "IN_PROGRESS", "SubmitTime": "2023-06-09T23:16:15.956000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/MovieData", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-TS-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-servicerole" } } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [DescribeTargetedSentimentDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-targeted-sentiment-detection-job.html) na *Referência de comandos da AWS CLI*. ### `describe-topics-detection-job` O código de exemplo a seguir mostra como usar `describe-topics-detection-job`. **AWS CLI** **Para descrever um trabalho de detecção de tópicos** O exemplo de `describe-topics-detection-job` a seguir obtém as propriedades de um trabalho assíncrono de detecção de tópicos. ``` aws comprehend describe-topics-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` Resultado: ``` { "TopicsDetectionJobProperties": { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "example_topics_detection", "JobStatus": "IN_PROGRESS", "SubmitTime": "2023-06-09T18:44:43.414000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-TOPICS-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "NumberOfTopics": 10, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-examplerole" } } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Consulte detalhes da API em [DescribeTopicsDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-topics-detection-job.html) na *Referência de comandos da AWS CLI*. ### `detect-dominant-language` O código de exemplo a seguir mostra como usar `detect-dominant-language`. **AWS CLI** **Para detectar o idioma dominante do texto de entrada** O `detect-dominant-language` a seguir analisa o texto de entrada e identifica o idioma dominante. A pontuação de confiança do modelo pré-treinado também é gerada. ``` aws comprehend detect-dominant-language \ --text "It is a beautiful day in Seattle." ``` Resultado: ``` { "Languages": [ { "LanguageCode": "en", "Score": 0.9877256155014038 } ] } ``` Para obter mais informações, consulte [Idioma dominante](https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Consulte detalhes da API em [DetectDominantLanguage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-dominant-language.html) na *Referência de comandos da AWS CLI*. ### `detect-entities` O código de exemplo a seguir mostra como usar `detect-entities`. **AWS CLI** **Para detectar entidades nomeadas no texto de entrada** O exemplo de `detect-entities` a seguir analisa o texto de entrada e retorna as entidades nomeadas. A pontuação de confiança do modelo pré-treinado também é gerada para cada previsão. ``` aws comprehend detect-entities \ --language-code en \ --text "Hello Zhang Wei, I am John. Your AnyCompany Financial Services, LLC credit card \ account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st. Based on your autopay settings, \ we will withdraw your payment on the due date from your bank account number XXXXXX1111 with the routing number XXXXX0000. \ Customer feedback for Sunshine Spa, 123 Main St, Anywhere. Send comments to Alice at AnySpa@example.com." ``` Resultado: ``` { "Entities": [ { "Score": 0.9994556307792664, "Type": "PERSON", "Text": "Zhang Wei", "BeginOffset": 6, "EndOffset": 15 }, { "Score": 0.9981022477149963, "Type": "PERSON", "Text": "John", "BeginOffset": 22, "EndOffset": 26 }, { "Score": 0.9986887574195862, "Type": "ORGANIZATION", "Text": "AnyCompany Financial Services, LLC", "BeginOffset": 33, "EndOffset": 67 }, { "Score": 0.9959119558334351, "Type": "OTHER", "Text": "1111-XXXX-1111-XXXX", "BeginOffset": 88, "EndOffset": 107 }, { "Score": 0.9708039164543152, "Type": "QUANTITY", "Text": ".53", "BeginOffset": 133, "EndOffset": 136 }, { "Score": 0.9987268447875977, "Type": "DATE", "Text": "July 31st", "BeginOffset": 152, "EndOffset": 161 }, { "Score": 0.9858865737915039, "Type": "OTHER", "Text": "XXXXXX1111", "BeginOffset": 271, "EndOffset": 281 }, { "Score": 0.9700471758842468, "Type": "OTHER", "Text": "XXXXX0000", "BeginOffset": 306, "EndOffset": 315 }, { "Score": 0.9591118693351746, "Type": "ORGANIZATION", "Text": "Sunshine Spa", "BeginOffset": 340, "EndOffset": 352 }, { "Score": 0.9797496795654297, "Type": "LOCATION", "Text": "123 Main St", "BeginOffset": 354, "EndOffset": 365 }, { "Score": 0.994929313659668, "Type": "PERSON", "Text": "Alice", "BeginOffset": 394, "EndOffset": 399 }, { "Score": 0.9949769377708435, "Type": "OTHER", "Text": "AnySpa@example.com", "BeginOffset": 403, "EndOffset": 418 } ] } ``` Para obter mais informações, consulte [Entidades](https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para obter detalhes da API, consulte.[DetectEntities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-entities.html) na *Referência de comandos da AWS CLI*. ### `detect-key-phrases` O código de exemplo a seguir mostra como usar `detect-key-phrases`. **AWS CLI** **Para detectar frases-chave no texto de entrada** O exemplo de `detect-key-phrases` a seguir analisa o texto de entrada e identifica as principais frases nominais. A pontuação de confiança do modelo pré-treinado também é gerada para cada previsão. ``` aws comprehend detect-key-phrases \ --language-code en \ --text "Hello Zhang Wei, I am John. Your AnyCompany Financial Services, LLC credit card \ account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st. Based on your autopay settings, \ we will withdraw your payment on the due date from your bank account number XXXXXX1111 with the routing number XXXXX0000. \ Customer feedback for Sunshine Spa, 123 Main St, Anywhere. Send comments to Alice at AnySpa@example.com." ``` Resultado: ``` { "KeyPhrases": [ { "Score": 0.8996376395225525, "Text": "Zhang Wei", "BeginOffset": 6, "EndOffset": 15 }, { "Score": 0.9992469549179077, "Text": "John", "BeginOffset": 22, "EndOffset": 26 }, { "Score": 0.988385021686554, "Text": "Your AnyCompany Financial Services", "BeginOffset": 28, "EndOffset": 62 }, { "Score": 0.8740853071212769, "Text": "LLC credit card account 1111-XXXX-1111-XXXX", "BeginOffset": 64, "EndOffset": 107 }, { "Score": 0.9999437928199768, "Text": "a minimum payment", "BeginOffset": 112, "EndOffset": 129 }, { "Score": 0.9998900890350342, "Text": ".53", "BeginOffset": 133, "EndOffset": 136 }, { "Score": 0.9979453086853027, "Text": "July 31st", "BeginOffset": 152, "EndOffset": 161 }, { "Score": 0.9983011484146118, "Text": "your autopay settings", "BeginOffset": 172, "EndOffset": 193 }, { "Score": 0.9996572136878967, "Text": "your payment", "BeginOffset": 211, "EndOffset": 223 }, { "Score": 0.9995037317276001, "Text": "the due date", "BeginOffset": 227, "EndOffset": 239 }, { "Score": 0.9702621698379517, "Text": "your bank account number XXXXXX1111", "BeginOffset": 245, "EndOffset": 280 }, { "Score": 0.9179925918579102, "Text": "the routing number XXXXX0000.Customer feedback", "BeginOffset": 286, "EndOffset": 332 }, { "Score": 0.9978160858154297, "Text": "Sunshine Spa", "BeginOffset": 337, "EndOffset": 349 }, { "Score": 0.9706913232803345, "Text": "123 Main St", "BeginOffset": 351, "EndOffset": 362 }, { "Score": 0.9941995143890381, "Text": "comments", "BeginOffset": 379, "EndOffset": 387 }, { "Score": 0.9759287238121033, "Text": "Alice", "BeginOffset": 391, "EndOffset": 396 }, { "Score": 0.8376792669296265, "Text": "AnySpa@example.com", "BeginOffset": 400, "EndOffset": 415 } ] } ``` Para obter mais informações, consulte [Frases-chave](https://docs.aws.amazon.com/comprehend/latest/dg/how-key-phrases.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Consulte detalhes da API em [DetectKeyPhrases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-key-phrases.html) na *Referência de comandos da AWS CLI*. ### `detect-pii-entities` O código de exemplo a seguir mostra como usar `detect-pii-entities`. **AWS CLI** **Para detectar entidades PII no texto de entrada** O exemplo de `detect-pii-entities` a seguir analisa o texto de entrada e identifica entidades que contêm informações de identificação pessoal (PII). A pontuação de confiança do modelo pré-treinado também é gerada para cada previsão. ``` aws comprehend detect-pii-entities \ --language-code en \ --text "Hello Zhang Wei, I am John. Your AnyCompany Financial Services, LLC credit card \ account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st. Based on your autopay settings, \ we will withdraw your payment on the due date from your bank account number XXXXXX1111 with the routing number XXXXX0000. \ Customer feedback for Sunshine Spa, 123 Main St, Anywhere. Send comments to Alice at AnySpa@example.com." ``` Resultado: ``` { "Entities": [ { "Score": 0.9998322129249573, "Type": "NAME", "BeginOffset": 6, "EndOffset": 15 }, { "Score": 0.9998878240585327, "Type": "NAME", "BeginOffset": 22, "EndOffset": 26 }, { "Score": 0.9994089603424072, "Type": "CREDIT_DEBIT_NUMBER", "BeginOffset": 88, "EndOffset": 107 }, { "Score": 0.9999760985374451, "Type": "DATE_TIME", "BeginOffset": 152, "EndOffset": 161 }, { "Score": 0.9999449253082275, "Type": "BANK_ACCOUNT_NUMBER", "BeginOffset": 271, "EndOffset": 281 }, { "Score": 0.9999847412109375, "Type": "BANK_ROUTING", "BeginOffset": 306, "EndOffset": 315 }, { "Score": 0.999925434589386, "Type": "ADDRESS", "BeginOffset": 354, "EndOffset": 365 }, { "Score": 0.9989161491394043, "Type": "NAME", "BeginOffset": 394, "EndOffset": 399 }, { "Score": 0.9994171857833862, "Type": "EMAIL", "BeginOffset": 403, "EndOffset": 418 } ] } ``` Para obter mais informações, consulte [Informações de identificação pessoal (PII)](https://docs.aws.amazon.com/comprehend/latest/dg/pii.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Consulte detalhes da API em [DetectPiiEntities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-pii-entities.html) na *Referência de comandos da AWS CLI*. ### `detect-sentiment` O código de exemplo a seguir mostra como usar `detect-sentiment`. **AWS CLI** **Para detectar o sentimento de um texto de entrada** O exemplo de `detect-sentiment` a seguir analisa o texto de entrada e retorna uma inferência do sentimento predominante (`POSITIVE`, `NEUTRAL`, `MIXED` ou `NEGATIVE`). ``` aws comprehend detect-sentiment \ --language-code en \ --text "It is a beautiful day in Seattle" ``` Resultado: ``` { "Sentiment": "POSITIVE", "SentimentScore": { "Positive": 0.9976957440376282, "Negative": 9.653854067437351e-05, "Neutral": 0.002169104292988777, "Mixed": 3.857641786453314e-05 } } ``` Para obter mais informações, consulte [Sentimento](https://docs.aws.amazon.com/comprehend/latest/dg/how-sentiment.html) no *Guia do desenvolvedor do Amazon Comprehend* + Consulte detalhes da API em [DetectSentiment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-sentiment.html) na *Referência de comandos da AWS CLI*. ### `detect-syntax` O código de exemplo a seguir mostra como usar `detect-syntax`. **AWS CLI** **Para detectar as partes da fala em um texto de entrada** O exemplo de `detect-syntax` a seguir analisa a sintaxe do texto de entrada e retorna as diferentes partes da fala. A pontuação de confiança do modelo pré-treinado também é gerada para cada previsão. ``` aws comprehend detect-syntax \ --language-code en \ --text "It is a beautiful day in Seattle." ``` Resultado: ``` { "SyntaxTokens": [ { "TokenId": 1, "Text": "It", "BeginOffset": 0, "EndOffset": 2, "PartOfSpeech": { "Tag": "PRON", "Score": 0.9999740719795227 } }, { "TokenId": 2, "Text": "is", "BeginOffset": 3, "EndOffset": 5, "PartOfSpeech": { "Tag": "VERB", "Score": 0.999901294708252 } }, { "TokenId": 3, "Text": "a", "BeginOffset": 6, "EndOffset": 7, "PartOfSpeech": { "Tag": "DET", "Score": 0.9999938607215881 } }, { "TokenId": 4, "Text": "beautiful", "BeginOffset": 8, "EndOffset": 17, "PartOfSpeech": { "Tag": "ADJ", "Score": 0.9987351894378662 } }, { "TokenId": 5, "Text": "day", "BeginOffset": 18, "EndOffset": 21, "PartOfSpeech": { "Tag": "NOUN", "Score": 0.9999796748161316 } }, { "TokenId": 6, "Text": "in", "BeginOffset": 22, "EndOffset": 24, "PartOfSpeech": { "Tag": "ADP", "Score": 0.9998047947883606 } }, { "TokenId": 7, "Text": "Seattle", "BeginOffset": 25, "EndOffset": 32, "PartOfSpeech": { "Tag": "PROPN", "Score": 0.9940530061721802 } } ] } ``` Para obter mais informações, consulte [Análise de sintaxe](https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para obter detalhes da API, consulte.[DetectSyntax](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-syntax.html) na *Referência de comandos da AWS CLI*. ### `detect-targeted-sentiment` O código de exemplo a seguir mostra como usar `detect-targeted-sentiment`. **AWS CLI** **Para detectar o sentimento direcionado de entidades nomeadas em um texto de entrada** O exemplo `detect-targeted-sentiment` a seguir analisa o texto de entrada e retorna as entidades nomeadas, além do sentimento direcionado associado a cada entidade. A pontuação de confiança de modelos pré-treinados para cada previsão também é gerada. ``` aws comprehend detect-targeted-sentiment \ --language-code en \ --text "I do not enjoy January because it is too cold but August is the perfect temperature" ``` Resultado: ``` { "Entities": [ { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "Score": 0.9999979734420776, "GroupScore": 1.0, "Text": "I", "Type": "PERSON", "MentionSentiment": { "Sentiment": "NEUTRAL", "SentimentScore": { "Positive": 0.0, "Negative": 0.0, "Neutral": 1.0, "Mixed": 0.0 } }, "BeginOffset": 0, "EndOffset": 1 } ] }, { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "Score": 0.9638869762420654, "GroupScore": 1.0, "Text": "January", "Type": "DATE", "MentionSentiment": { "Sentiment": "NEGATIVE", "SentimentScore": { "Positive": 0.0031610000878572464, "Negative": 0.9967250227928162, "Neutral": 0.00011100000119768083, "Mixed": 1.9999999949504854e-06 } }, "BeginOffset": 15, "EndOffset": 22 } ] }, { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { { "Score": 0.9664419889450073, "GroupScore": 1.0, "Text": "August", "Type": "DATE", "MentionSentiment": { "Sentiment": "POSITIVE", "SentimentScore": { "Positive": 0.9999549984931946, "Negative": 3.999999989900971e-06, "Neutral": 4.099999932805076e-05, "Mixed": 0.0 } }, "BeginOffset": 50, "EndOffset": 56 } ] }, { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "Score": 0.9803199768066406, "GroupScore": 1.0, "Text": "temperature", "Type": "ATTRIBUTE", "MentionSentiment": { "Sentiment": "POSITIVE", "SentimentScore": { "Positive": 1.0, "Negative": 0.0, "Neutral": 0.0, "Mixed": 0.0 } }, "BeginOffset": 77, "EndOffset": 88 } ] } ] } ``` Para obter mais informações, consulte [Sentimentos direcionados](https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [DetectTargetedSentiment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-targeted-sentiment.html) na *Referência de comandos da AWS CLI*. ### `import-model` O código de exemplo a seguir mostra como usar `import-model`. **AWS CLI** **Para importar um modelo** O exemplo `import-model` a seguir importa um modelo de uma conta da AWS diferente. O modelo de classificador de documentos na conta `444455556666` tem uma política baseada em recursos que permite que a conta `111122223333` importe o modelo. ``` aws comprehend import-model \ --source-model-arn arn:aws:comprehend:us-west-2:444455556666:document-classifier/example-classifier ``` Resultado: ``` { "ModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier" } ``` Para obter mais informações, consulte [Copiar modelos personalizados entre contas da AWS](https://docs.aws.amazon.com/comprehend/latest/dg/custom-copy.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [ImportModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/import-model.html) na *Referência de comandos da AWS CLI*. ### `list-datasets` O código de exemplo a seguir mostra como usar `list-datasets`. **AWS CLI** **Para listar todos os conjuntos de dados do flywheel** O exemplo `list-datasets` a seguir lista todos os conjuntos de dados associados a um flywheel. ``` aws comprehend list-datasets \ --flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity ``` Resultado: ``` { "DatasetPropertiesList": [ { "DatasetArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity/dataset/example-dataset-1", "DatasetName": "example-dataset-1", "DatasetType": "TRAIN", "DatasetS3Uri": "s3://amzn-s3-demo-bucket/flywheel-entity/schemaVersion=1/20230616T200543Z/datasets/example-dataset-1/20230616T203710Z/", "Status": "CREATING", "CreationTime": "2023-06-16T20:37:10.400000+00:00" }, { "DatasetArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity/dataset/example-dataset-2", "DatasetName": "example-dataset-2", "DatasetType": "TRAIN", "DatasetS3Uri": "s3://amzn-s3-demo-bucket/flywheel-entity/schemaVersion=1/20230616T200543Z/datasets/example-dataset-2/20230616T200607Z/", "Description": "TRAIN Dataset created by Flywheel creation.", "Status": "COMPLETED", "NumberOfDocuments": 5572, "CreationTime": "2023-06-16T20:06:07.722000+00:00" } ] } ``` Para obter mais informações, consulte [Visão geral do flywheel](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [ListDatasets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-datasets.html) na *Referência de comandos da AWS CLI*. ### `list-document-classification-jobs` O código de exemplo a seguir mostra como usar `list-document-classification-jobs`. **AWS CLI** **Para listar trabalhos de classificação de documento** O exemplo de `list-document-classification-jobs` a seguir lista todos os trabalhos de classificação de documentos. ``` aws comprehend list-document-classification-jobs ``` Resultado: ``` { "DocumentClassificationJobPropertiesList": [ { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:1234567890101:document-classification-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "exampleclassificationjob", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-14T17:09:51.788000+00:00", "EndTime": "2023-06-14T17:15:58.582000+00:00", "DocumentClassifierArn": "arn:aws:comprehend:us-west-2:1234567890101:document-classifier/mymodel/version/12", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/jobdata/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/1234567890101-CLN-e758dd56b824aa717ceab551f11749fb/output/output.tar.gz" }, "DataAccessRoleArn": "arn:aws:iam::1234567890101:role/service-role/AmazonComprehendServiceRole-example-role" }, { "JobId": "123456abcdeb0e11022f22a1EXAMPLE2", "JobArn": "arn:aws:comprehend:us-west-2:1234567890101:document-classification-job/123456abcdeb0e11022f22a1EXAMPLE2", "JobName": "exampleclassificationjob2", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-14T17:22:39.829000+00:00", "EndTime": "2023-06-14T17:28:46.107000+00:00", "DocumentClassifierArn": "arn:aws:comprehend:us-west-2:1234567890101:document-classifier/mymodel/version/12", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/jobdata/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/1234567890101-CLN-123456abcdeb0e11022f22a1EXAMPLE2/output/output.tar.gz" }, "DataAccessRoleArn": "arn:aws:iam::1234567890101:role/service-role/AmazonComprehendServiceRole-example-role" } ] } ``` Para obter mais informações, consulte [Classificação personalizada](https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Consulte detalhes da API em [ListDocumentClassificationJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-document-classification-jobs.html) na *Referência de comandos da AWS CLI*. ### `list-document-classifier-summaries` O código de exemplo a seguir mostra como usar `list-document-classifier-summaries`. **AWS CLI** **Para listar os resumos de todos os classificadores de documentos criados** O exemplo `list-document-classifier-summaries` a seguir lista todos os resumos de classificador de documentos criados. ``` aws comprehend list-document-classifier-summaries ``` Resultado: ``` { "DocumentClassifierSummariesList": [ { "DocumentClassifierName": "example-classifier-1", "NumberOfVersions": 1, "LatestVersionCreatedAt": "2023-06-13T22:07:59.825000+00:00", "LatestVersionName": "1", "LatestVersionStatus": "TRAINED" }, { "DocumentClassifierName": "example-classifier-2", "NumberOfVersions": 2, "LatestVersionCreatedAt": "2023-06-13T21:54:59.589000+00:00", "LatestVersionName": "2", "LatestVersionStatus": "TRAINED" } ] } ``` Para obter mais informações, consulte [Criação e gerenciamento de modelos personalizados](https://docs.aws.amazon.com/comprehend/latest/dg/manage-models.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [ListDocumentClassifierSummaries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-document-classifier-summaries.html) na *Referência de comandos da AWS CLI*. ### `list-document-classifiers` O código de exemplo a seguir mostra como usar `list-document-classifiers`. **AWS CLI** **Para listar todos os classificadores de documentos** O exemplo de `list-document-classifiers` a seguir lista todos os modelos de classificadores de documentos treinados e em treinamento. ``` aws comprehend list-document-classifiers ``` Resultado: ``` { "DocumentClassifierPropertiesList": [ { "DocumentClassifierArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier1", "LanguageCode": "en", "Status": "TRAINED", "SubmitTime": "2023-06-13T19:04:15.735000+00:00", "EndTime": "2023-06-13T19:42:31.752000+00:00", "TrainingStartTime": "2023-06-13T19:08:20.114000+00:00", "TrainingEndTime": "2023-06-13T19:41:35.080000+00:00", "InputDataConfig": { "DataFormat": "COMPREHEND_CSV", "S3Uri": "s3://amzn-s3-demo-bucket/trainingdata" }, "OutputDataConfig": {}, "ClassifierMetadata": { "NumberOfLabels": 3, "NumberOfTrainedDocuments": 5016, "NumberOfTestDocuments": 557, "EvaluationMetrics": { "Accuracy": 0.9856, "Precision": 0.9919, "Recall": 0.9459, "F1Score": 0.9673, "MicroPrecision": 0.9856, "MicroRecall": 0.9856, "MicroF1Score": 0.9856, "HammingLoss": 0.0144 } }, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-testorle", "Mode": "MULTI_CLASS" }, { "DocumentClassifierArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier2", "LanguageCode": "en", "Status": "TRAINING", "SubmitTime": "2023-06-13T21:20:28.690000+00:00", "InputDataConfig": { "DataFormat": "COMPREHEND_CSV", "S3Uri": "s3://amzn-s3-demo-bucket/trainingdata" }, "OutputDataConfig": {}, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-testorle", "Mode": "MULTI_CLASS" } ] } ``` Para obter mais informações, consulte [Criação e gerenciamento de modelos personalizados](https://docs.aws.amazon.com/comprehend/latest/dg/manage-models.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Consulte detalhes da API em [ListDocumentClassifiers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-document-classifiers.html) na *Referência de comandos da AWS CLI*. ### `list-dominant-language-detection-jobs` O código de exemplo a seguir mostra como usar `list-dominant-language-detection-jobs`. **AWS CLI** **Para listar todas as tarefas de detecção de idioma dominante** O exemplo `list-dominant-language-detection-jobs` a seguir lista todos os trabalhos assíncronos de detecção de idioma dominante em andamento e concluídos. ``` aws comprehend list-dominant-language-detection-jobs ``` Resultado: ``` { "DominantLanguageDetectionJobPropertiesList": [ { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "languageanalysis1", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-09T18:10:38.037000+00:00", "EndTime": "2023-06-09T18:18:45.498000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-LANGUAGE-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" }, { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "languageanalysis2", "JobStatus": "STOPPED", "SubmitTime": "2023-06-09T18:16:33.690000+00:00", "EndTime": "2023-06-09T18:24:40.608000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-LANGUAGE-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" } ] } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [ListDominantLanguageDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-dominant-language-detection-jobs.html) na *Referência de comandos da AWS CLI*. ### `list-endpoints` O código de exemplo a seguir mostra como usar `list-endpoints`. **AWS CLI** **Para listar todos os endpoints** O exemplo `list-endpoints` a seguir lista todos os endpoints ativos específicos do modelo. ``` aws comprehend list-endpoints ``` Resultado: ``` { "EndpointPropertiesList": [ { "EndpointArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/ExampleClassifierEndpoint", "Status": "IN_SERVICE", "ModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier1", "DesiredModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier1", "DesiredInferenceUnits": 1, "CurrentInferenceUnits": 1, "CreationTime": "2023-06-13T20:32:54.526000+00:00", "LastModifiedTime": "2023-06-13T20:32:54.526000+00:00" }, { "EndpointArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/ExampleClassifierEndpoint2", "Status": "IN_SERVICE", "ModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier2", "DesiredModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier2", "DesiredInferenceUnits": 1, "CurrentInferenceUnits": 1, "CreationTime": "2023-06-13T20:32:54.526000+00:00", "LastModifiedTime": "2023-06-13T20:32:54.526000+00:00" } ] } ``` Para obter mais informações, consulte [Gerenciar endpoints do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [ListEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-endpoints.html) na *Referência de comandos da AWS CLI*. ### `list-entities-detection-jobs` O código de exemplo a seguir mostra como usar `list-entities-detection-jobs`. **AWS CLI** **Para listar todos os trabalhos de detecção de entidades** O exemplo `list-entities-detection-jobs` a seguir lista todos os trabalhos assíncronos de detecção de entidades. ``` aws comprehend list-entities-detection-jobs ``` Resultado: ``` { "EntitiesDetectionJobPropertiesList": [ { "JobId": "468af39c28ab45b83eb0c4ab9EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/468af39c28ab45b83eb0c4ab9EXAMPLE", "JobName": "example-entities-detection", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-08T20:57:46.476000+00:00", "EndTime": "2023-06-08T21:05:53.718000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/AsyncBatchJobs/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/111122223333-NER-468af39c28ab45b83eb0c4ab9EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" }, { "JobId": "809691caeaab0e71406f80a28EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/809691caeaab0e71406f80a28EXAMPLE", "JobName": "example-entities-detection-2", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-08T21:30:15.323000+00:00", "EndTime": "2023-06-08T21:40:23.509000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/AsyncBatchJobs/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/111122223333-NER-809691caeaab0e71406f80a28EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" }, { "JobId": "e00597c36b448b91d70dea165EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/e00597c36b448b91d70dea165EXAMPLE", "JobName": "example-entities-detection-3", "JobStatus": "STOPPED", "SubmitTime": "2023-06-08T22:19:28.528000+00:00", "EndTime": "2023-06-08T22:27:33.991000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/AsyncBatchJobs/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/111122223333-NER-e00597c36b448b91d70dea165EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" } ] } ``` Para obter mais informações, consulte [Entidades](https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [ListEntitiesDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-entities-detection-jobs.html) na *Referência de comandos da AWS CLI*. ### `list-entity-recognizer-summaries` O código de exemplo a seguir mostra como usar `list-entity-recognizer-summaries`. **AWS CLI** **Para listar os resumos de todos os reconhecedores de entidades criados** O exemplo `list-entity-recognizer-summaries` a seguir lista todos os resumos do reconhecedor de entidades. ``` aws comprehend list-entity-recognizer-summaries ``` Resultado: ``` { "EntityRecognizerSummariesList": [ { "RecognizerName": "entity-recognizer-3", "NumberOfVersions": 2, "LatestVersionCreatedAt": "2023-06-15T23:15:07.621000+00:00", "LatestVersionName": "2", "LatestVersionStatus": "STOP_REQUESTED" }, { "RecognizerName": "entity-recognizer-2", "NumberOfVersions": 1, "LatestVersionCreatedAt": "2023-06-14T22:55:27.805000+00:00", "LatestVersionName": "2" "LatestVersionStatus": "TRAINED" }, { "RecognizerName": "entity-recognizer-1", "NumberOfVersions": 1, "LatestVersionCreatedAt": "2023-06-14T20:44:59.631000+00:00", "LatestVersionName": "1", "LatestVersionStatus": "TRAINED" } ] } ``` Para obter mais informações, consulte [Reconhecimento de entidades personalizado](https://docs.aws.amazon.com/comprehend/latest/dg/custom-entity-recognition.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [ListEntityRecognizerSummaries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-entity-recognizer-summaries.html) na *Referência de comandos da AWS CLI*. ### `list-entity-recognizers` O código de exemplo a seguir mostra como usar `list-entity-recognizers`. **AWS CLI** **Para listar todos os reconhecedores de entidades personalizados** O exemplo `list-entity-recognizers` a seguir lista todos os reconhecedores de entidades personalizados criados. ``` aws comprehend list-entity-recognizers ``` Resultado: ``` { "EntityRecognizerPropertiesList": [ { "EntityRecognizerArn": "arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/EntityRecognizer/version/1", "LanguageCode": "en", "Status": "TRAINED", "SubmitTime": "2023-06-14T20:44:59.631000+00:00", "EndTime": "2023-06-14T20:59:19.532000+00:00", "TrainingStartTime": "2023-06-14T20:48:52.811000+00:00", "TrainingEndTime": "2023-06-14T20:58:11.473000+00:00", "InputDataConfig": { "DataFormat": "COMPREHEND_CSV", "EntityTypes": [ { "Type": "BUSINESS" } ], "Documents": { "S3Uri": "s3://amzn-s3-demo-bucket/trainingdata/dataset/", "InputFormat": "ONE_DOC_PER_LINE" }, "EntityList": { "S3Uri": "s3://amzn-s3-demo-bucket/trainingdata/entity.csv" } }, "RecognizerMetadata": { "NumberOfTrainedDocuments": 1814, "NumberOfTestDocuments": 486, "EvaluationMetrics": { "Precision": 100.0, "Recall": 100.0, "F1Score": 100.0 }, "EntityTypes": [ { "Type": "BUSINESS", "EvaluationMetrics": { "Precision": 100.0, "Recall": 100.0, "F1Score": 100.0 }, "NumberOfTrainMentions": 1520 } ] }, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-servicerole", "VersionName": "1" }, { "EntityRecognizerArn": "arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/entityrecognizer3", "LanguageCode": "en", "Status": "TRAINED", "SubmitTime": "2023-06-14T22:57:51.056000+00:00", "EndTime": "2023-06-14T23:14:13.894000+00:00", "TrainingStartTime": "2023-06-14T23:01:33.984000+00:00", "TrainingEndTime": "2023-06-14T23:13:02.984000+00:00", "InputDataConfig": { "DataFormat": "COMPREHEND_CSV", "EntityTypes": [ { "Type": "DEVICE" } ], "Documents": { "S3Uri": "s3://amzn-s3-demo-bucket/trainingdata/raw_txt.csv", "InputFormat": "ONE_DOC_PER_LINE" }, "EntityList": { "S3Uri": "s3://amzn-s3-demo-bucket/trainingdata/entity_list.csv" } }, "RecognizerMetadata": { "NumberOfTrainedDocuments": 4616, "NumberOfTestDocuments": 3489, "EvaluationMetrics": { "Precision": 98.54227405247813, "Recall": 100.0, "F1Score": 99.26578560939794 }, "EntityTypes": [ { "Type": "DEVICE", "EvaluationMetrics": { "Precision": 98.54227405247813, "Recall": 100.0, "F1Score": 99.26578560939794 }, "NumberOfTrainMentions": 2764 } ] }, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-servicerole" } ] } ``` Para obter mais informações, consulte [Reconhecimento de entidades personalizado](https://docs.aws.amazon.com/comprehend/latest/dg/custom-entity-recognition.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [ListEntityRecognizers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-entity-recognizers.html) na *Referência de comandos da AWS CLI*. ### `list-events-detection-jobs` O código de exemplo a seguir mostra como usar `list-events-detection-jobs`. **AWS CLI** **Para listar todos os trabalhos de detecção de eventos** O exemplo `list-events-detection-jobs` a seguir lista todos os trabalhos assíncronos de detecção de eventos. ``` aws comprehend list-events-detection-jobs ``` Resultado: ``` { "EventsDetectionJobPropertiesList": [ { "JobId": "aa9593f9203e84f3ef032ce18EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:1111222233333:events-detection-job/aa9593f9203e84f3ef032ce18EXAMPLE", "JobName": "events_job_1", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-12T19:14:57.751000+00:00", "EndTime": "2023-06-12T19:21:04.962000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-source-bucket/EventsData/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/1111222233333-EVENTS-aa9593f9203e84f3ef032ce18EXAMPLE/output/" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::1111222233333:role/service-role/AmazonComprehendServiceRole-example-role", "TargetEventTypes": [ "BANKRUPTCY", "EMPLOYMENT", "CORPORATE_ACQUISITION", "CORPORATE_MERGER", "INVESTMENT_GENERAL" ] }, { "JobId": "4a990a2f7e82adfca6e171135EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:1111222233333:events-detection-job/4a990a2f7e82adfca6e171135EXAMPLE", "JobName": "events_job_2", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-12T19:55:43.702000+00:00", "EndTime": "2023-06-12T20:03:49.893000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-source-bucket/EventsData/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/1111222233333-EVENTS-4a990a2f7e82adfca6e171135EXAMPLE/output/" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::1111222233333:role/service-role/AmazonComprehendServiceRole-example-role", "TargetEventTypes": [ "BANKRUPTCY", "EMPLOYMENT", "CORPORATE_ACQUISITION", "CORPORATE_MERGER", "INVESTMENT_GENERAL" ] } ] } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [ListEventsDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-events-detection-jobs.html) na *Referência de comandos da AWS CLI*. ### `list-flywheel-iteration-history` O código de exemplo a seguir mostra como usar `list-flywheel-iteration-history`. **AWS CLI** **Para listar todo o histórico de iteração do flywheel** O exemplo `list-flywheel-iteration-history` a seguir lista todas as iterações de um flywheel. ``` aws comprehend list-flywheel-iteration-history --flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel ``` Resultado: ``` { "FlywheelIterationPropertiesList": [ { "FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel", "FlywheelIterationId": "20230619TEXAMPLE", "CreationTime": "2023-06-19T04:00:32.594000+00:00", "EndTime": "2023-06-19T04:00:49.248000+00:00", "Status": "COMPLETED", "Message": "FULL_ITERATION: Flywheel iteration performed all functions successfully.", "EvaluatedModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1", "EvaluatedModelMetrics": { "AverageF1Score": 0.7742663922375772, "AverageF1Score": 0.9876464664646313, "AveragePrecision": 0.9800000253081214, "AverageRecall": 0.9445600253081214, "AverageAccuracy": 0.9997281665190434 }, "EvaluationManifestS3Prefix": "s3://amzn-s3-demo-bucket/example-flywheel/schemaVersion=1/20230619TEXAMPLE/evaluation/20230619TEXAMPLE/" }, { "FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel-2", "FlywheelIterationId": "20230616TEXAMPLE", "CreationTime": "2023-06-16T21:10:26.385000+00:00", "EndTime": "2023-06-16T23:33:16.827000+00:00", "Status": "COMPLETED", "Message": "FULL_ITERATION: Flywheel iteration performed all functions successfully.", "EvaluatedModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/spamvshamclassify/version/1", "EvaluatedModelMetrics": { "AverageF1Score": 0.7742663922375772, "AverageF1Score": 0.9767700253081214, "AveragePrecision": 0.9767700253081214, "AverageRecall": 0.9767700253081214, "AverageAccuracy": 0.9858281665190434 }, "EvaluationManifestS3Prefix": "s3://amzn-s3-demo-bucket/example-flywheel-2/schemaVersion=1/20230616TEXAMPLE/evaluation/20230616TEXAMPLE/" } ] } ``` Para obter mais informações, consulte [Visão geral do flywheel](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [ListFlywheelIterationHistory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-flywheel-iteration-history.html) na *Referência de comandos da AWS CLI*. ### `list-flywheels` O código de exemplo a seguir mostra como usar `list-flywheels`. **AWS CLI** **Para listar todos os flywheels** O exemplo `list-flywheels` a seguir lista todos os flywheels criados. ``` aws comprehend list-flywheels ``` Resultado: ``` { "FlywheelSummaryList": [ { "FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel-1", "ActiveModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier/version/1", "DataLakeS3Uri": "s3://amzn-s3-demo-bucket/example-flywheel-1/schemaVersion=1/20230616T200543Z/", "Status": "ACTIVE", "ModelType": "DOCUMENT_CLASSIFIER", "CreationTime": "2023-06-16T20:05:43.242000+00:00", "LastModifiedTime": "2023-06-19T04:00:43.027000+00:00", "LatestFlywheelIteration": "20230619T040032Z" }, { "FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel-2", "ActiveModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier2/version/1", "DataLakeS3Uri": "s3://amzn-s3-demo-bucket/example-flywheel-2/schemaVersion=1/20220616T200543Z/", "Status": "ACTIVE", "ModelType": "DOCUMENT_CLASSIFIER", "CreationTime": "2022-06-16T20:05:43.242000+00:00", "LastModifiedTime": "2022-06-19T04:00:43.027000+00:00", "LatestFlywheelIteration": "20220619T040032Z" } ] } ``` Para obter mais informações, consulte [Visão geral do flywheel](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [ListFlywheels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-flywheels.html) na *Referência de comandos da AWS CLI*. ### `list-key-phrases-detection-jobs` O código de exemplo a seguir mostra como usar `list-key-phrases-detection-jobs`. **AWS CLI** **Para listar todos os trabalhos de detecção de frases-chave** O exemplo `list-key-phrases-detection-jobs` a seguir lista todos os trabalhos assíncronos de detecção de frases-chave em andamento e concluídos. ``` aws comprehend list-key-phrases-detection-jobs ``` Resultado: ``` { "KeyPhrasesDetectionJobPropertiesList": [ { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "keyphrasesanalysis1", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-08T22:31:43.767000+00:00", "EndTime": "2023-06-08T22:39:52.565000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-source-bucket/AsyncBatchJobs/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-KP-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" }, { "JobId": "123456abcdeb0e11022f22a33EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/123456abcdeb0e11022f22a33EXAMPLE", "JobName": "keyphrasesanalysis2", "JobStatus": "STOPPED", "SubmitTime": "2023-06-08T22:57:52.154000+00:00", "EndTime": "2023-06-08T23:05:48.385000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/AsyncBatchJobs/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-KP-123456abcdeb0e11022f22a33EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" }, { "JobId": "123456abcdeb0e11022f22a44EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/123456abcdeb0e11022f22a44EXAMPLE", "JobName": "keyphrasesanalysis3", "JobStatus": "FAILED", "Message": "NO_READ_ACCESS_TO_INPUT: The provided data access role does not have proper access to the input data.", "SubmitTime": "2023-06-09T16:47:04.029000+00:00", "EndTime": "2023-06-09T16:47:18.413000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-KP-123456abcdeb0e11022f22a44EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" } ] } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [ListKeyPhrasesDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-key-phrases-detection-jobs.html) na *Referência de comandos da AWS CLI*. ### `list-pii-entities-detection-jobs` O código de exemplo a seguir mostra como usar `list-pii-entities-detection-jobs`. **AWS CLI** **Para listar todos os trabalhos de detecção de entidades de pii** O exemplo `list-pii-entities-detection-jobs` a seguir lista todos os trabalhos assíncronos de detecção de pii em andamento e concluídos. ``` aws comprehend list-pii-entities-detection-jobs ``` Resultado: ``` { "PiiEntitiesDetectionJobPropertiesList": [ { "JobId": "6f9db0c42d0c810e814670ee4EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/6f9db0c42d0c810e814670ee4EXAMPLE", "JobName": "example-pii-detection-job", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-09T21:02:46.241000+00:00", "EndTime": "2023-06-09T21:12:52.602000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/AsyncBatchJobs/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-source-bucket/111122223333-PII-6f9db0c42d0c810e814670ee4EXAMPLE/output/" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role", "Mode": "ONLY_OFFSETS" }, { "JobId": "d927562638cfa739331a99b3cEXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/d927562638cfa739331a99b3cEXAMPLE", "JobName": "example-pii-detection-job-2", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-09T21:20:58.211000+00:00", "EndTime": "2023-06-09T21:31:06.027000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/AsyncBatchJobs/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/111122223333-PII-d927562638cfa739331a99b3cEXAMPLE/output/" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role", "Mode": "ONLY_OFFSETS" } ] } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [ListPiiEntitiesDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-pii-entities-detection-jobs.html) na *Referência de comandos da AWS CLI*. ### `list-sentiment-detection-jobs` O código de exemplo a seguir mostra como usar `list-sentiment-detection-jobs`. **AWS CLI** **Para listar todos os trabalhos de detecção de sentimentos** O exemplo `list-sentiment-detection-jobs` a seguir lista todos os trabalhos assíncronos de detecção de sentimentos em andamento e concluídos. ``` aws comprehend list-sentiment-detection-jobs ``` Resultado: ``` { "SentimentDetectionJobPropertiesList": [ { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "example-sentiment-detection-job", "JobStatus": "IN_PROGRESS", "SubmitTime": "2023-06-09T22:42:20.545000+00:00", "EndTime": "2023-06-09T22:52:27.416000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/MovieData", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-TS-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" }, { "JobId": "123456abcdeb0e11022f22a1EXAMPLE2", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/123456abcdeb0e11022f22a1EXAMPLE2", "JobName": "example-sentiment-detection-job-2", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-09T23:16:15.956000+00:00", "EndTime": "2023-06-09T23:26:00.168000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/MovieData2", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-TS-123456abcdeb0e11022f22a1EXAMPLE2/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" } ] } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [ListSentimentDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-sentiment-detection-jobs.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar tags para recurso** O exemplo `list-tags-for-resource` a seguir lista as tags de um recurso do Amazon Comprehend. ``` aws comprehend list-tags-for-resource \ --resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1 ``` Resultado: ``` { "ResourceArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1", "Tags": [ { "Key": "Department", "Value": "Finance" }, { "Key": "location", "Value": "Seattle" } ] } ``` Para obter mais informações, consulte [Marcar recursos](https://docs.aws.amazon.com/comprehend/latest/dg/tagging.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `list-targeted-sentiment-detection-jobs` O código de exemplo a seguir mostra como usar `list-targeted-sentiment-detection-jobs`. **AWS CLI** **Para listar todos os trabalhos de detecção de sentimentos direcionados** O exemplo `list-targeted-sentiment-detection-jobs` a seguir lista todos os trabalhos assíncronos de detecção de sentimentos direcionados em andamento e concluídos. ``` aws comprehend list-targeted-sentiment-detection-jobs ``` Resultado: ``` { "TargetedSentimentDetectionJobPropertiesList": [ { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "example-targeted-sentiment-detection-job", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-09T22:42:20.545000+00:00", "EndTime": "2023-06-09T22:52:27.416000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/MovieData", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-TS-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-IOrole" }, { "JobId": "123456abcdeb0e11022f22a1EXAMPLE2", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/123456abcdeb0e11022f22a1EXAMPLE2", "JobName": "example-targeted-sentiment-detection-job-2", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-09T23:16:15.956000+00:00", "EndTime": "2023-06-09T23:26:00.168000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/MovieData2", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-TS-123456abcdeb0e11022f22a1EXAMPLE2/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" } ] } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [ListTargetedSentimentDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-targeted-sentiment-detection-jobs.html) na *Referência de comandos da AWS CLI*. ### `list-topics-detection-jobs` O código de exemplo a seguir mostra como usar `list-topics-detection-jobs`. **AWS CLI** **Para listar todos os trabalhos de detecção de tópicos** O exemplo de `list-topics-detection-jobs` a seguir lista todos os trabalhos de detecção de tópicos assíncronos em andamento e concluídos. ``` aws comprehend list-topics-detection-jobs ``` Resultado: ``` { "TopicsDetectionJobPropertiesList": [ { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName" "topic-analysis-1" "JobStatus": "IN_PROGRESS", "SubmitTime": "2023-06-09T18:40:35.384000+00:00", "EndTime": "2023-06-09T18:46:41.936000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/111122223333-TOPICS-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "NumberOfTopics": 10, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" }, { "JobId": "123456abcdeb0e11022f22a1EXAMPLE2", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/123456abcdeb0e11022f22a1EXAMPLE2", "JobName": "topic-analysis-2", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-09T18:44:43.414000+00:00", "EndTime": "2023-06-09T18:50:50.872000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/111122223333-TOPICS-123456abcdeb0e11022f22a1EXAMPLE2/output/output.tar.gz" }, "NumberOfTopics": 10, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" }, { "JobId": "123456abcdeb0e11022f22a1EXAMPLE3", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/123456abcdeb0e11022f22a1EXAMPLE3", "JobName": "topic-analysis-2", "JobStatus": "IN_PROGRESS", "SubmitTime": "2023-06-09T18:50:56.737000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/111122223333-TOPICS-123456abcdeb0e11022f22a1EXAMPLE3/output/output.tar.gz" }, "NumberOfTopics": 10, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" } ] } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Consulte detalhes da API em [ListTopicsDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-topics-detection-jobs.html) na *Referência de comandos da AWS CLI*. ### `put-resource-policy` O código de exemplo a seguir mostra como usar `put-resource-policy`. **AWS CLI** **Para anexar uma política baseada em recursos** O exemplo `put-resource-policy` a seguir anexa uma política baseada em recursos a um modelo para que ela possa ser importada por outra conta da AWS. A política é anexada ao modelo na conta `111122223333` e permite que a conta `444455556666` importe o modelo. ``` aws comprehend put-resource-policy \ --resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1 \ --resource-policy '{"Version":"2012-10-17", "Statement":[{"Effect":"Allow","Action":"comprehend:ImportModel","Resource":"*","Principal":{"AWS":["arn:aws:iam::444455556666:root"]}}]}' ``` Resultado: ``` { "PolicyRevisionId": "aaa111d069d07afaa2aa3106aEXAMPLE" } ``` Para obter mais informações, consulte [Copiar modelos personalizados entre contas da AWS](https://docs.aws.amazon.com/comprehend/latest/dg/custom-copy.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [PutResourcePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/put-resource-policy.html) na *Referência de comandos da AWS CLI*. ### `start-document-classification-job` O código de exemplo a seguir mostra como usar `start-document-classification-job`. **AWS CLI** **Para iniciar um trabalho de classificação de documento** O exemplo de `start-document-classification-job` a seguir inicia um trabalho de classificação de documentos com um modelo personalizado em todos os arquivos no endereço especificado pela tag `--input-data-config`. Neste exemplo, o bucket do S3 de entrada contém `SampleSMStext1.txt`, `SampleSMStext2.txt` e `SampleSMStext3.txt`. O modelo foi previamente treinado na classificação de documentos de mensagens de spam e não spam, ou “ham”, e mensagens SMS. Quando o trabalho é concluído, `output.tar.gz` é colocado no local especificado pela tag `--output-data-config`. `output.tar.gz` contém `predictions.jsonl`, que lista a classificação de cada documento. A saída Json é impressa em uma linha por arquivo, mas foi formatada aqui para facilitar a leitura. ``` aws comprehend start-document-classification-job \ --job-name exampleclassificationjob \ --input-data-config "S3Uri=s3://amzn-s3-demo-bucket-INPUT/jobdata/" \ --output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \ --data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role \ --document-classifier-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/mymodel/version/12 ``` Conteúdo de `SampleSMStext1.txt`: ``` "CONGRATULATIONS! TXT 2155550100 to win $5000" ``` Conteúdo de `SampleSMStext2.txt`: ``` "Hi, when do you want me to pick you up from practice?" ``` Conteúdo de `SampleSMStext3.txt`: ``` "Plz send bank account # to 2155550100 to claim prize!!" ``` Resultado: ``` { "JobId": "e758dd56b824aa717ceab551fEXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:document-classification-job/e758dd56b824aa717ceab551fEXAMPLE", "JobStatus": "SUBMITTED" } ``` Conteúdo de `predictions.jsonl`: ``` {"File": "SampleSMSText1.txt", "Line": "0", "Classes": [{"Name": "spam", "Score": 0.9999}, {"Name": "ham", "Score": 0.0001}]} {"File": "SampleSMStext2.txt", "Line": "0", "Classes": [{"Name": "ham", "Score": 0.9994}, {"Name": "spam", "Score": 0.0006}]} {"File": "SampleSMSText3.txt", "Line": "0", "Classes": [{"Name": "spam", "Score": 0.9999}, {"Name": "ham", "Score": 0.0001}]} ``` Para obter mais informações, consulte [Classificação personalizada](https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Consulte detalhes da API em [StartDocumentClassificationJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-document-classification-job.html) na *Referência de comandos da AWS CLI*. ### `start-dominant-language-detection-job` O código de exemplo a seguir mostra como usar `start-dominant-language-detection-job`. **AWS CLI** **Para iniciar um trabalho assíncrono de detecção de idioma** O exemplo `start-dominant-language-detection-job` a seguir inicia um trabalho assíncrono de detecção de idioma para todos os arquivos localizados no endereço especificado pela tag `--input-data-config`. O bucket do S3 neste exemplo contém `Sampletext1.txt`. Quando o trabalho é concluído, a pasta, `output`, é colocada no local especificado pela tag `--output-data-config`. A pasta contém `output.txt`, que contém o idioma dominante de cada um dos arquivos de texto, bem como a pontuação de confiança do modelo pré-treinado para cada previsão. ``` aws comprehend start-dominant-language-detection-job \ --job-name example_language_analysis_job \ --language-code en \ --input-data-config "S3Uri=s3://amzn-s3-demo-bucket/" \ --output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \ --data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role \ --language-code en ``` Conteúdo de Sampletext1.txt: ``` "Physics is the natural science that involves the study of matter and its motion and behavior through space and time, along with related concepts such as energy and force." ``` Resultado: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobStatus": "SUBMITTED" } ``` Conteúdo de `output.txt`: ``` {"File": "Sampletext1.txt", "Languages": [{"LanguageCode": "en", "Score": 0.9913753867149353}], "Line": 0} ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [StartDominantLanguageDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-dominant-language-detection-job.html) na *Referência de comandos da AWS CLI*. ### `start-entities-detection-job` O código de exemplo a seguir mostra como usar `start-entities-detection-job`. **AWS CLI** **Exemplo 1: iniciar um trabalho de detecção de entidade padrão usando o modelo pré-treinado** O exemplo `start-entities-detection-job` a seguir inicia um trabalho assíncrono de detecção de entidades para todos os arquivos localizados no endereço especificado pela tag `--input-data-config`. O bucket do S3 neste exemplo contém `Sampletext1.txt`, `Sampletext2.txt` e `Sampletext3.txt`. Quando o trabalho é concluído, a pasta, `output`, é colocada no local especificado pela tag `--output-data-config`. A pasta `output.txt` contém a lista de todas as entidades nomeadas detectadas em cada arquivo de texto, bem como a pontuação de confiança do modelo pré-treinado para cada previsão. A saída Json é impressa em uma linha por arquivo de entrada, mas foi formatada aqui para facilitar a leitura. ``` aws comprehend start-entities-detection-job \ --job-name entitiestest \ --language-code en \ --input-data-config "S3Uri=s3://amzn-s3-demo-bucket/" \ --output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \ --data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role \ --language-code en ``` Conteúdo de `Sampletext1.txt`: ``` "Hello Zhang Wei, I am John. Your AnyCompany Financial Services, LLC credit card account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st." ``` Conteúdo de `Sampletext2.txt`: ``` "Dear Max, based on your autopay settings for your account example1.org account, we will withdraw your payment on the due date from your bank account number XXXXXX1111 with the routing number XXXXX0000. " ``` Conteúdo de `Sampletext3.txt`: ``` "Jane, please submit any customer feedback from this weekend to AnySpa, 123 Main St, Anywhere and send comments to Alice at AnySpa@example.com." ``` Resultado: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobStatus": "SUBMITTED" } ``` Conteúdo de `output.txt` com recuos de linha para facilitar a leitura: ``` { "Entities": [ { "BeginOffset": 6, "EndOffset": 15, "Score": 0.9994006636420306, "Text": "Zhang Wei", "Type": "PERSON" }, { "BeginOffset": 22, "EndOffset": 26, "Score": 0.9976647915128143, "Text": "John", "Type": "PERSON" }, { "BeginOffset": 33, "EndOffset": 67, "Score": 0.9984608700836206, "Text": "AnyCompany Financial Services, LLC", "Type": "ORGANIZATION" }, { "BeginOffset": 88, "EndOffset": 107, "Score": 0.9868521019555556, "Text": "1111-XXXX-1111-XXXX", "Type": "OTHER" }, { "BeginOffset": 133, "EndOffset": 139, "Score": 0.998242565709204, "Text": "$24.53", "Type": "QUANTITY" }, { "BeginOffset": 155, "EndOffset": 164, "Score": 0.9993039263159287, "Text": "July 31st", "Type": "DATE" } ], "File": "SampleText1.txt", "Line": 0 } { "Entities": [ { "BeginOffset": 5, "EndOffset": 8, "Score": 0.9866232147545232, "Text": "Max", "Type": "PERSON" }, { "BeginOffset": 156, "EndOffset": 166, "Score": 0.9797723450933329, "Text": "XXXXXX1111", "Type": "OTHER" }, { "BeginOffset": 191, "EndOffset": 200, "Score": 0.9247838572396843, "Text": "XXXXX0000", "Type": "OTHER" } ], "File": "SampleText2.txt", "Line": 0 } { "Entities": [ { "Score": 0.9990532994270325, "Type": "PERSON", "Text": "Jane", "BeginOffset": 0, "EndOffset": 4 }, { "Score": 0.9519651532173157, "Type": "DATE", "Text": "this weekend", "BeginOffset": 47, "EndOffset": 59 }, { "Score": 0.5566426515579224, "Type": "ORGANIZATION", "Text": "AnySpa", "BeginOffset": 63, "EndOffset": 69 }, { "Score": 0.8059805631637573, "Type": "LOCATION", "Text": "123 Main St, Anywhere", "BeginOffset": 71, "EndOffset": 92 }, { "Score": 0.998830258846283, "Type": "PERSON", "Text": "Alice", "BeginOffset": 114, "EndOffset": 119 }, { "Score": 0.997818112373352, "Type": "OTHER", "Text": "AnySpa@example.com", "BeginOffset": 123, "EndOffset": 138 } ], "File": "SampleText3.txt", "Line": 0 } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. **Exemplo 2: iniciar um trabalho personalizado de detecção de entidades** O exemplo `start-entities-detection-job` a seguir inicia um trabalho assíncrono de detecção de entidades personalizadas para todos os arquivos localizados no endereço especificado pela tag `--input-data-config`. Neste exemplo, o bucket do S3 contém `SampleFeedback1.txt`, `SampleFeedback2.txt` e `SampleFeedback3.txt`. O modelo de reconhecimento de entidades foi treinado em feedbacks de suporte ao cliente para reconhecer nomes de dispositivos. Quando o trabalho é concluído, a pasta, `output`, é colocada no local especificado pela tag `--output-data-config`. A pasta `output.txt` contém a lista de todas as entidades nomeadas detectadas em cada arquivo de texto, bem como a pontuação de confiança do modelo pré-treinado para cada previsão. A saída Json é impressa em uma linha por arquivo, mas foi formatada aqui para facilitar a leitura. ``` aws comprehend start-entities-detection-job \ --job-name customentitiestest \ --entity-recognizer-arn "arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/entityrecognizer" \ --language-code en \ --input-data-config "S3Uri=s3://amzn-s3-demo-bucket/jobdata/" \ --output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \ --data-access-role-arn "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-IOrole" ``` Conteúdo de `SampleFeedback1.txt`: ``` "I've been on the AnyPhone app have had issues for 24 hours when trying to pay bill. Cannot make payment. Sigh. | Oh man! Lets get that app up and running. DM me, and we can get to work!" ``` Conteúdo de `SampleFeedback2.txt`: ``` "Hi, I have a discrepancy with my new bill. Could we get it sorted out? A rep added stuff I didn't sign up for when I did my AnyPhone 10 upgrade. | We can absolutely get this sorted!" ``` Conteúdo de `SampleFeedback3.txt`: ``` "Is the by 1 get 1 free AnySmartPhone promo still going on? | Hi Christian! It ended yesterday, send us a DM if you have any questions and we can take a look at your options!" ``` Resultado: ``` { "JobId": "019ea9edac758806850fa8a79ff83021", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/019ea9edac758806850fa8a79ff83021", "JobStatus": "SUBMITTED" } ``` Conteúdo de `output.txt` com recuos de linha para facilitar a leitura: ``` { "Entities": [ { "BeginOffset": 17, "EndOffset": 25, "Score": 0.9999728210205924, "Text": "AnyPhone", "Type": "DEVICE" } ], "File": "SampleFeedback1.txt", "Line": 0 } { "Entities": [ { "BeginOffset": 123, "EndOffset": 133, "Score": 0.9999892116761524, "Text": "AnyPhone 10", "Type": "DEVICE" } ], "File": "SampleFeedback2.txt", "Line": 0 } { "Entities": [ { "BeginOffset": 23, "EndOffset": 35, "Score": 0.9999971389852362, "Text": "AnySmartPhone", "Type": "DEVICE" } ], "File": "SampleFeedback3.txt", "Line": 0 } ``` Para obter mais informações, consulte [Reconhecimento de entidades personalizado](https://docs.aws.amazon.com/comprehend/latest/dg/custom-entity-recognition.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [StartEntitiesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-entities-detection-job.html) na *Referência de comandos da AWS CLI*. ### `start-events-detection-job` O código de exemplo a seguir mostra como usar `start-events-detection-job`. **AWS CLI** **Para iniciar um trabalho de detecção de eventos assíncronos** O exemplo `start-events-detection-job` a seguir inicia um trabalho assíncrono de detecção de eventos para todos os arquivos localizados no endereço especificado pela tag `--input-data-config`. Os possíveis tipos de eventos-alvo incluem `BANKRUPCTY`, `EMPLOYMENT`, `CORPORATE_ACQUISITION`, `INVESTMENT_GENERAL`, `CORPORATE_MERGER`, `IPO`, `RIGHTS_ISSUE`, `SECONDARY_OFFERING`, `SHELF_OFFERING`, `TENDER_OFFERING` e `STOCK_SPLIT`. O bucket do S3 neste exemplo contém `SampleText1.txt`, `SampleText2.txt` e `SampleText3.txt`. Quando o trabalho é concluído, a pasta, `output`, é colocada no local especificado pela tag `--output-data-config`. A pasta contém `SampleText1.txt.out`, `SampleText2.txt.out` e `SampleText3.txt.out`. A saída JSON é impressa em uma linha por arquivo, mas foi formatada aqui para facilitar a leitura. ``` aws comprehend start-events-detection-job \ --job-name events-detection-1 \ --input-data-config "S3Uri=s3://amzn-s3-demo-bucket/EventsData" \ --output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \ --data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-servicerole \ --language-code en \ --target-event-types "BANKRUPTCY" "EMPLOYMENT" "CORPORATE_ACQUISITION" "CORPORATE_MERGER" "INVESTMENT_GENERAL" ``` Conteúdo de `SampleText1.txt`: ``` "Company AnyCompany grew by increasing sales and through acquisitions. After purchasing competing firms in 2020, AnyBusiness, a part of the AnyBusinessGroup, gave Jane Does firm a going rate of one cent a gallon or forty-two cents a barrel." ``` Conteúdo de `SampleText2.txt`: ``` "In 2021, AnyCompany officially purchased AnyBusiness for 100 billion dollars, surprising and exciting the shareholders." ``` Conteúdo de `SampleText3.txt`: ``` "In 2022, AnyCompany stock crashed 50. Eventually later that year they filed for bankruptcy." ``` Resultado: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:events-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobStatus": "SUBMITTED" } ``` Conteúdo de `SampleText1.txt.out` com recuos de linha para facilitar a leitura: ``` { "Entities": [ { "Mentions": [ { "BeginOffset": 8, "EndOffset": 18, "Score": 0.99977, "Text": "AnyCompany", "Type": "ORGANIZATION", "GroupScore": 1 }, { "BeginOffset": 112, "EndOffset": 123, "Score": 0.999747, "Text": "AnyBusiness", "Type": "ORGANIZATION", "GroupScore": 0.979826 }, { "BeginOffset": 171, "EndOffset": 175, "Score": 0.999615, "Text": "firm", "Type": "ORGANIZATION", "GroupScore": 0.871647 } ] }, { "Mentions": [ { "BeginOffset": 97, "EndOffset": 102, "Score": 0.987687, "Text": "firms", "Type": "ORGANIZATION", "GroupScore": 1 } ] }, { "Mentions": [ { "BeginOffset": 103, "EndOffset": 110, "Score": 0.999458, "Text": "in 2020", "Type": "DATE", "GroupScore": 1 } ] }, { "Mentions": [ { "BeginOffset": 160, "EndOffset": 168, "Score": 0.999649, "Text": "John Doe", "Type": "PERSON", "GroupScore": 1 } ] } ], "Events": [ { "Type": "CORPORATE_ACQUISITION", "Arguments": [ { "EntityIndex": 0, "Role": "INVESTOR", "Score": 0.99977 } ], "Triggers": [ { "BeginOffset": 56, "EndOffset": 68, "Score": 0.999967, "Text": "acquisitions", "Type": "CORPORATE_ACQUISITION", "GroupScore": 1 } ] }, { "Type": "CORPORATE_ACQUISITION", "Arguments": [ { "EntityIndex": 1, "Role": "INVESTEE", "Score": 0.987687 }, { "EntityIndex": 2, "Role": "DATE", "Score": 0.999458 }, { "EntityIndex": 3, "Role": "INVESTOR", "Score": 0.999649 } ], "Triggers": [ { "BeginOffset": 76, "EndOffset": 86, "Score": 0.999973, "Text": "purchasing", "Type": "CORPORATE_ACQUISITION", "GroupScore": 1 } ] } ], "File": "SampleText1.txt", "Line": 0 } ``` Conteúdo de `SampleText2.txt.out`: ``` { "Entities": [ { "Mentions": [ { "BeginOffset": 0, "EndOffset": 7, "Score": 0.999473, "Text": "In 2021", "Type": "DATE", "GroupScore": 1 } ] }, { "Mentions": [ { "BeginOffset": 9, "EndOffset": 19, "Score": 0.999636, "Text": "AnyCompany", "Type": "ORGANIZATION", "GroupScore": 1 } ] }, { "Mentions": [ { "BeginOffset": 45, "EndOffset": 56, "Score": 0.999712, "Text": "AnyBusiness", "Type": "ORGANIZATION", "GroupScore": 1 } ] }, { "Mentions": [ { "BeginOffset": 61, "EndOffset": 80, "Score": 0.998886, "Text": "100 billion dollars", "Type": "MONETARY_VALUE", "GroupScore": 1 } ] } ], "Events": [ { "Type": "CORPORATE_ACQUISITION", "Arguments": [ { "EntityIndex": 3, "Role": "AMOUNT", "Score": 0.998886 }, { "EntityIndex": 2, "Role": "INVESTEE", "Score": 0.999712 }, { "EntityIndex": 0, "Role": "DATE", "Score": 0.999473 }, { "EntityIndex": 1, "Role": "INVESTOR", "Score": 0.999636 } ], "Triggers": [ { "BeginOffset": 31, "EndOffset": 40, "Score": 0.99995, "Text": "purchased", "Type": "CORPORATE_ACQUISITION", "GroupScore": 1 } ] } ], "File": "SampleText2.txt", "Line": 0 } ``` Conteúdo de `SampleText3.txt.out`: ``` { "Entities": [ { "Mentions": [ { "BeginOffset": 9, "EndOffset": 19, "Score": 0.999774, "Text": "AnyCompany", "Type": "ORGANIZATION", "GroupScore": 1 }, { "BeginOffset": 66, "EndOffset": 70, "Score": 0.995717, "Text": "they", "Type": "ORGANIZATION", "GroupScore": 0.997626 } ] }, { "Mentions": [ { "BeginOffset": 50, "EndOffset": 65, "Score": 0.999656, "Text": "later that year", "Type": "DATE", "GroupScore": 1 } ] } ], "Events": [ { "Type": "BANKRUPTCY", "Arguments": [ { "EntityIndex": 1, "Role": "DATE", "Score": 0.999656 }, { "EntityIndex": 0, "Role": "FILER", "Score": 0.995717 } ], "Triggers": [ { "BeginOffset": 81, "EndOffset": 91, "Score": 0.999936, "Text": "bankruptcy", "Type": "BANKRUPTCY", "GroupScore": 1 } ] } ], "File": "SampleText3.txt", "Line": 0 } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [StartEventsDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-events-detection-job.html) na *Referência de comandos da AWS CLI*. ### `start-flywheel-iteration` O código de exemplo a seguir mostra como usar `start-flywheel-iteration`. **AWS CLI** **Para iniciar uma iteração do flywheel** O exemplo `start-flywheel-iteration` a seguir inicia uma iteração do flywheel. Essa operação usa qualquer novo conjunto de dados no flywheel para treinar uma nova versão do modelo. ``` aws comprehend start-flywheel-iteration \ --flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel ``` Resultado: ``` { "FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel", "FlywheelIterationId": "12345123TEXAMPLE" } ``` Para obter mais informações, consulte [Visão geral do flywheel](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para obter detalhes a API, consulte [StartFlywheelIteration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-flywheel-iteration.html) na *Referência de comandos da AWS CLI*. ### `start-key-phrases-detection-job` O código de exemplo a seguir mostra como usar `start-key-phrases-detection-job`. **AWS CLI** **Para iniciar uma tarefa de detecção de frases-chave** O exemplo `start-key-phrases-detection-job` a seguir inicia um trabalho assíncrono de detecção de frases-chave para todos os arquivos localizados no endereço especificado pela tag `--input-data-config`. O bucket do S3 neste exemplo contém `Sampletext1.txt`, `Sampletext2.txt` e `Sampletext3.txt`. Quando o trabalho é concluído, a pasta, `output`, é colocada no local especificado pela tag `--output-data-config`. A pasta contém o arquivo `output.txt`, que contém todas as frases-chave detectadas em cada arquivo de texto e a pontuação de confiança do modelo pré-treinado para cada previsão. A saída Json é impressa em uma linha por arquivo, mas foi formatada aqui para facilitar a leitura. ``` aws comprehend start-key-phrases-detection-job \ --job-name keyphrasesanalysistest1 \ --language-code en \ --input-data-config "S3Uri=s3://amzn-s3-demo-bucket/" \ --output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \ --data-access-role-arn "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" \ --language-code en ``` Conteúdo de `Sampletext1.txt`: ``` "Hello Zhang Wei, I am John. Your AnyCompany Financial Services, LLC credit card account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st." ``` Conteúdo de `Sampletext2.txt`: ``` "Dear Max, based on your autopay settings for your account Internet.org account, we will withdraw your payment on the due date from your bank account number XXXXXX1111 with the routing number XXXXX0000. " ``` Conteúdo de `Sampletext3.txt`: ``` "Jane, please submit any customer feedback from this weekend to Sunshine Spa, 123 Main St, Anywhere and send comments to Alice at AnySpa@example.com." ``` Resultado: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobStatus": "SUBMITTED" } ``` Conteúdo de `output.txt` com recuos de linha para facilitar a leitura: ``` { "File": "SampleText1.txt", "KeyPhrases": [ { "BeginOffset": 6, "EndOffset": 15, "Score": 0.9748965572679326, "Text": "Zhang Wei" }, { "BeginOffset": 22, "EndOffset": 26, "Score": 0.9997344722354619, "Text": "John" }, { "BeginOffset": 28, "EndOffset": 62, "Score": 0.9843791074032948, "Text": "Your AnyCompany Financial Services" }, { "BeginOffset": 64, "EndOffset": 107, "Score": 0.8976122401721824, "Text": "LLC credit card account 1111-XXXX-1111-XXXX" }, { "BeginOffset": 112, "EndOffset": 129, "Score": 0.9999612982629748, "Text": "a minimum payment" }, { "BeginOffset": 133, "EndOffset": 139, "Score": 0.99975728947036, "Text": "$24.53" }, { "BeginOffset": 155, "EndOffset": 164, "Score": 0.9940866241449973, "Text": "July 31st" } ], "Line": 0 } { "File": "SampleText2.txt", "KeyPhrases": [ { "BeginOffset": 0, "EndOffset": 8, "Score": 0.9974021100118472, "Text": "Dear Max" }, { "BeginOffset": 19, "EndOffset": 40, "Score": 0.9961120519515884, "Text": "your autopay settings" }, { "BeginOffset": 45, "EndOffset": 78, "Score": 0.9980620070116009, "Text": "your account Internet.org account" }, { "BeginOffset": 97, "EndOffset": 109, "Score": 0.999919660140754, "Text": "your payment" }, { "BeginOffset": 113, "EndOffset": 125, "Score": 0.9998370719754205, "Text": "the due date" }, { "BeginOffset": 131, "EndOffset": 166, "Score": 0.9955068678502509, "Text": "your bank account number XXXXXX1111" }, { "BeginOffset": 172, "EndOffset": 200, "Score": 0.8653433315829526, "Text": "the routing number XXXXX0000" } ], "Line": 0 } { "File": "SampleText3.txt", "KeyPhrases": [ { "BeginOffset": 0, "EndOffset": 4, "Score": 0.9142947833681668, "Text": "Jane" }, { "BeginOffset": 20, "EndOffset": 41, "Score": 0.9984325676596763, "Text": "any customer feedback" }, { "BeginOffset": 47, "EndOffset": 59, "Score": 0.9998782448150636, "Text": "this weekend" }, { "BeginOffset": 63, "EndOffset": 75, "Score": 0.99866741830757, "Text": "Sunshine Spa" }, { "BeginOffset": 77, "EndOffset": 88, "Score": 0.9695803485466054, "Text": "123 Main St" }, { "BeginOffset": 108, "EndOffset": 116, "Score": 0.9997065928550928, "Text": "comments" }, { "BeginOffset": 120, "EndOffset": 125, "Score": 0.9993466833825161, "Text": "Alice" }, { "BeginOffset": 129, "EndOffset": 144, "Score": 0.9654563612885667, "Text": "AnySpa@example.com" } ], "Line": 0 } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [StartKeyPhrasesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-key-phrases-detection-job.html) na *Referência de comandos da AWS CLI*. ### `start-pii-entities-detection-job` O código de exemplo a seguir mostra como usar `start-pii-entities-detection-job`. **AWS CLI** **Para iniciar um trabalho assíncrono de detecção de PII** O exemplo `start-pii-entities-detection-job` a seguir inicia um trabalho assíncrono de detecção de entidades de informações de identificação pessoal (PII) para todos os arquivos localizados no endereço especificado pela tag `--input-data-config`. O bucket do S3 neste exemplo contém `Sampletext1.txt`, `Sampletext2.txt` e `Sampletext3.txt`. Quando o trabalho é concluído, a pasta, `output`, é colocada no local especificado pela tag `--output-data-config`. A pasta contém `SampleText1.txt.out`, `SampleText2.txt.out` e `SampleText3.txt.out`, que lista as entidades nomeadas em cada arquivo de texto. A saída Json é impressa em uma linha por arquivo, mas foi formatada aqui para facilitar a leitura. ``` aws comprehend start-pii-entities-detection-job \ --job-name entities_test \ --language-code en \ --input-data-config "S3Uri=s3://amzn-s3-demo-bucket/" \ --output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \ --data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role \ --language-code en \ --mode ONLY_OFFSETS ``` Conteúdo de `Sampletext1.txt`: ``` "Hello Zhang Wei, I am John. Your AnyCompany Financial Services, LLC credit card account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st." ``` Conteúdo de `Sampletext2.txt`: ``` "Dear Max, based on your autopay settings for your account Internet.org account, we will withdraw your payment on the due date from your bank account number XXXXXX1111 with the routing number XXXXX0000. " ``` Conteúdo de `Sampletext3.txt`: ``` "Jane, please submit any customer feedback from this weekend to Sunshine Spa, 123 Main St, Anywhere and send comments to Alice at AnySpa@example.com." ``` Resultado: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobStatus": "SUBMITTED" } ``` Conteúdo de `SampleText1.txt.out` com recuos de linha para facilitar a leitura: ``` { "Entities": [ { "BeginOffset": 6, "EndOffset": 15, "Type": "NAME", "Score": 0.9998490510222595 }, { "BeginOffset": 22, "EndOffset": 26, "Type": "NAME", "Score": 0.9998937958019426 }, { "BeginOffset": 88, "EndOffset": 107, "Type": "CREDIT_DEBIT_NUMBER", "Score": 0.9554297245278491 }, { "BeginOffset": 155, "EndOffset": 164, "Type": "DATE_TIME", "Score": 0.9999720462925257 } ], "File": "SampleText1.txt", "Line": 0 } ``` Conteúdo de `SampleText2.txt.out` com recuos de linha para facilitar a leitura: ``` { "Entities": [ { "BeginOffset": 5, "EndOffset": 8, "Type": "NAME", "Score": 0.9994390774924007 }, { "BeginOffset": 58, "EndOffset": 70, "Type": "URL", "Score": 0.9999958276922101 }, { "BeginOffset": 156, "EndOffset": 166, "Type": "BANK_ACCOUNT_NUMBER", "Score": 0.9999721058045592 }, { "BeginOffset": 191, "EndOffset": 200, "Type": "BANK_ROUTING", "Score": 0.9998968945989909 } ], "File": "SampleText2.txt", "Line": 0 } ``` Conteúdo de `SampleText3.txt.out` com recuos de linha para facilitar a leitura: ``` { "Entities": [ { "BeginOffset": 0, "EndOffset": 4, "Type": "NAME", "Score": 0.999949934606805 }, { "BeginOffset": 77, "EndOffset": 88, "Type": "ADDRESS", "Score": 0.9999035300466904 }, { "BeginOffset": 120, "EndOffset": 125, "Type": "NAME", "Score": 0.9998203838716296 }, { "BeginOffset": 129, "EndOffset": 144, "Type": "EMAIL", "Score": 0.9998313473105228 } ], "File": "SampleText3.txt", "Line": 0 } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [StartPiiEntitiesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-pii-entities-detection-job.html) na *Referência de comandos da AWS CLI*. ### `start-sentiment-detection-job` O código de exemplo a seguir mostra como usar `start-sentiment-detection-job`. **AWS CLI** **Para iniciar um trabalho de análise assíncrona de sentimentos** O exemplo `start-sentiment-detection-job` a seguir inicia um trabalho assíncrono de detecção de análise de sentimentos para todos os arquivos localizados no endereço especificado pela tag `--input-data-config`. A pasta do bucket do S3 neste exemplo contém `SampleMovieReview1.txt`, `SampleMovieReview2.txt` e `SampleMovieReview3.txt`. Quando o trabalho é concluído, a pasta, `output`, é colocada no local especificado pela tag `--output-data-config`. A pasta contém o arquivo, `output.txt`, que contém os sentimentos predominantes para cada arquivo de texto e a pontuação de confiança do modelo pré-treinado para cada previsão. A saída Json é impressa em uma linha por arquivo, mas foi formatada aqui para facilitar a leitura. ``` aws comprehend start-sentiment-detection-job \ --job-name example-sentiment-detection-job \ --language-code en \ --input-data-config "S3Uri=s3://amzn-s3-demo-bucket/MovieData" \ --output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \ --data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role ``` Conteúdo de `SampleMovieReview1.txt`: ``` "The film, AnyMovie2, is fairly predictable and just okay." ``` Conteúdo de `SampleMovieReview2.txt`: ``` "AnyMovie2 is the essential sci-fi film that I grew up watching when I was a kid. I highly recommend this movie." ``` Conteúdo de `SampleMovieReview3.txt`: ``` "Don't get fooled by the 'awards' for AnyMovie2. All parts of the film were poorly stolen from other modern directors." ``` Resultado: ``` { "JobId": "0b5001e25f62ebb40631a9a1a7fde7b3", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/0b5001e25f62ebb40631a9a1a7fde7b3", "JobStatus": "SUBMITTED" } ``` Conteúdo de `output.txt` com linha de recuos para fins de legibilidade: ``` { "File": "SampleMovieReview1.txt", "Line": 0, "Sentiment": "MIXED", "SentimentScore": { "Mixed": 0.6591159105300903, "Negative": 0.26492202281951904, "Neutral": 0.035430654883384705, "Positive": 0.04053137078881264 } } { "File": "SampleMovieReview2.txt", "Line": 0, "Sentiment": "POSITIVE", "SentimentScore": { "Mixed": 0.000008718466233403888, "Negative": 0.00006134175055194646, "Neutral": 0.0002941041602753103, "Positive": 0.9996358156204224 } } { "File": "SampleMovieReview3.txt", "Line": 0, "Sentiment": "NEGATIVE", "SentimentScore": { "Mixed": 0.004146667663007975, "Negative": 0.9645107984542847, "Neutral": 0.016559595242142677, "Positive": 0.014782938174903393 } } } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [StartSentimentDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-sentiment-detection-job.html) na *Referência de comandos da AWS CLI*. ### `start-targeted-sentiment-detection-job` O código de exemplo a seguir mostra como usar `start-targeted-sentiment-detection-job`. **AWS CLI** **Para iniciar um trabalho assíncrono de análise de sentimentos direcionados** O exemplo `start-targeted-sentiment-detection-job` a seguir inicia um trabalho assíncrono de detecção de análise de sentimentos direcionados para todos os arquivos localizados no endereço especificado pela tag `--input-data-config`. A pasta do bucket do S3 neste exemplo contém `SampleMovieReview1.txt`, `SampleMovieReview2.txt` e `SampleMovieReview3.txt`. Quando o trabalho é concluído, `output.tar.gz` é colocado no local especificado pela tag `--output-data-config`. `output.tar.gz` contém os arquivos `SampleMovieReview1.txt.out`, `SampleMovieReview2.txt.out` e `SampleMovieReview3.txt.out`, cada um contendo todas as entidades nomeadas e sentimentos associados a um único arquivo de texto de entrada. ``` aws comprehend start-targeted-sentiment-detection-job \ --job-name targeted_movie_review_analysis1 \ --language-code en \ --input-data-config "S3Uri=s3://amzn-s3-demo-bucket/MovieData" \ --output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \ --data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role ``` Conteúdo de `SampleMovieReview1.txt`: ``` "The film, AnyMovie, is fairly predictable and just okay." ``` Conteúdo de `SampleMovieReview2.txt`: ``` "AnyMovie is the essential sci-fi film that I grew up watching when I was a kid. I highly recommend this movie." ``` Conteúdo de `SampleMovieReview3.txt`: ``` "Don't get fooled by the 'awards' for AnyMovie. All parts of the film were poorly stolen from other modern directors." ``` Resultado: ``` { "JobId": "0b5001e25f62ebb40631a9a1a7fde7b3", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/0b5001e25f62ebb40631a9a1a7fde7b3", "JobStatus": "SUBMITTED" } ``` Conteúdo de `SampleMovieReview1.txt.out` com recuos de linha para facilitar a leitura: ``` { "Entities": [ { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "BeginOffset": 4, "EndOffset": 8, "Score": 0.994972, "GroupScore": 1, "Text": "film", "Type": "MOVIE", "MentionSentiment": { "Sentiment": "NEUTRAL", "SentimentScore": { "Mixed": 0, "Negative": 0, "Neutral": 1, "Positive": 0 } } } ] }, { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "BeginOffset": 10, "EndOffset": 18, "Score": 0.631368, "GroupScore": 1, "Text": "AnyMovie", "Type": "ORGANIZATION", "MentionSentiment": { "Sentiment": "POSITIVE", "SentimentScore": { "Mixed": 0.001729, "Negative": 0.000001, "Neutral": 0.000318, "Positive": 0.997952 } } } ] } ], "File": "SampleMovieReview1.txt", "Line": 0 } ``` Conteúdo de recuos de linha de `SampleMovieReview2.txt.out` para fins de legibilidade: ``` { "Entities": [ { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "BeginOffset": 0, "EndOffset": 8, "Score": 0.854024, "GroupScore": 1, "Text": "AnyMovie", "Type": "MOVIE", "MentionSentiment": { "Sentiment": "POSITIVE", "SentimentScore": { "Mixed": 0, "Negative": 0, "Neutral": 0.000007, "Positive": 0.999993 } } }, { "BeginOffset": 104, "EndOffset": 109, "Score": 0.999129, "GroupScore": 0.502937, "Text": "movie", "Type": "MOVIE", "MentionSentiment": { "Sentiment": "POSITIVE", "SentimentScore": { "Mixed": 0, "Negative": 0, "Neutral": 0, "Positive": 1 } } }, { "BeginOffset": 33, "EndOffset": 37, "Score": 0.999823, "GroupScore": 0.999252, "Text": "film", "Type": "MOVIE", "MentionSentiment": { "Sentiment": "POSITIVE", "SentimentScore": { "Mixed": 0, "Negative": 0, "Neutral": 0.000001, "Positive": 0.999999 } } } ] }, { "DescriptiveMentionIndex": [ 0, 1, 2 ], "Mentions": [ { "BeginOffset": 43, "EndOffset": 44, "Score": 0.999997, "GroupScore": 1, "Text": "I", "Type": "PERSON", "MentionSentiment": { "Sentiment": "NEUTRAL", "SentimentScore": { "Mixed": 0, "Negative": 0, "Neutral": 1, "Positive": 0 } } }, { "BeginOffset": 80, "EndOffset": 81, "Score": 0.999996, "GroupScore": 0.52523, "Text": "I", "Type": "PERSON", "MentionSentiment": { "Sentiment": "NEUTRAL", "SentimentScore": { "Mixed": 0, "Negative": 0, "Neutral": 1, "Positive": 0 } } }, { "BeginOffset": 67, "EndOffset": 68, "Score": 0.999994, "GroupScore": 0.999499, "Text": "I", "Type": "PERSON", "MentionSentiment": { "Sentiment": "NEUTRAL", "SentimentScore": { "Mixed": 0, "Negative": 0, "Neutral": 1, "Positive": 0 } } } ] }, { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "BeginOffset": 75, "EndOffset": 78, "Score": 0.999978, "GroupScore": 1, "Text": "kid", "Type": "PERSON", "MentionSentiment": { "Sentiment": "NEUTRAL", "SentimentScore": { "Mixed": 0, "Negative": 0, "Neutral": 1, "Positive": 0 } } } ] } ], "File": "SampleMovieReview2.txt", "Line": 0 } ``` Conteúdo de `SampleMovieReview3.txt.out` com recuos de linha para facilitar a leitura: ``` { "Entities": [ { "DescriptiveMentionIndex": [ 1 ], "Mentions": [ { "BeginOffset": 64, "EndOffset": 68, "Score": 0.992953, "GroupScore": 0.999814, "Text": "film", "Type": "MOVIE", "MentionSentiment": { "Sentiment": "NEUTRAL", "SentimentScore": { "Mixed": 0.000004, "Negative": 0.010425, "Neutral": 0.989543, "Positive": 0.000027 } } }, { "BeginOffset": 37, "EndOffset": 45, "Score": 0.999782, "GroupScore": 1, "Text": "AnyMovie", "Type": "ORGANIZATION", "MentionSentiment": { "Sentiment": "POSITIVE", "SentimentScore": { "Mixed": 0.000095, "Negative": 0.039847, "Neutral": 0.000673, "Positive": 0.959384 } } } ] }, { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "BeginOffset": 47, "EndOffset": 50, "Score": 0.999991, "GroupScore": 1, "Text": "All", "Type": "QUANTITY", "MentionSentiment": { "Sentiment": "NEUTRAL", "SentimentScore": { "Mixed": 0.000001, "Negative": 0.000001, "Neutral": 0.999998, "Positive": 0 } } } ] }, { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "BeginOffset": 106, "EndOffset": 115, "Score": 0.542083, "GroupScore": 1, "Text": "directors", "Type": "PERSON", "MentionSentiment": { "Sentiment": "NEUTRAL", "SentimentScore": { "Mixed": 0, "Negative": 0, "Neutral": 1, "Positive": 0 } } } ] } ], "File": "SampleMovieReview3.txt", "Line": 0 } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [StartTargetedSentimentDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-targeted-sentiment-detection-job.html) na *Referência de comandos da AWS CLI*. ### `start-topics-detection-job` O código de exemplo a seguir mostra como usar `start-topics-detection-job`. **AWS CLI** **Para iniciar um trabalho de análise de detecção de tópicos** O exemplo de `start-topics-detection-job` a seguir inicia um trabalho assíncrono de detecção de tópicos para todos os arquivos localizados no endereço especificado pela tag `--input-data-config`. Quando o trabalho é concluído, a pasta, `output`, é colocada no local especificado pela tag `--ouput-data-config`. `output` contém topic-terms.csv e doc-topics.csv. O primeiro arquivo de saída, topic-terms.csv, é uma lista de tópicos na coleção. Para cada tópico, a lista inclui por padrão os principais termos por tópico de acordo com seu peso. O segundo arquivo, `doc-topics.csv`, lista os documentos associados a um tópico e a proporção do documento relacionada ao tópico. ``` aws comprehend start-topics-detection-job \ --job-name example_topics_detection_job \ --language-code en \ --input-data-config "S3Uri=s3://amzn-s3-demo-bucket/" \ --output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \ --data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role \ --language-code en ``` Resultado: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobStatus": "SUBMITTED" } ``` Para obter mais informações, consulte [Modelagem de tópicos](https://docs.aws.amazon.com/comprehend/latest/dg/topic-modeling.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Consulte detalhes da API em [StartTopicsDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-topics-detection-job.html) na *Referência de comandos da AWS CLI*. ### `stop-dominant-language-detection-job` O código de exemplo a seguir mostra como usar `stop-dominant-language-detection-job`. **AWS CLI** **Para interromper um trabalho assíncrono de detecção de idioma dominante** O exemplo `stop-dominant-language-detection-job` a seguir interrompe um trabalho assíncrono de detecção de idioma dominante. Se o estado atual do trabalho for `IN_PROGRESS`, o trabalho será marcado para ser interrompido e colocado no estado `STOP_REQUESTED`. Se o trabalho for concluído antes de ser interrompido, ele será colocado no estado `COMPLETED`. ``` aws comprehend stop-dominant-language-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` Resultado: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE, "JobStatus": "STOP_REQUESTED" } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [StopDominantLanguageDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-dominant-language-detection-job.html) na *Referência de comandos da AWS CLI*. ### `stop-entities-detection-job` O código de exemplo a seguir mostra como usar `stop-entities-detection-job`. **AWS CLI** **Para interromper um trabalho assíncrono de detecção de entidades** O exemplo `stop-entities-detection-job` a seguir interrompe um trabalho assíncrono de detecção de entidades. Se o estado atual do trabalho for `IN_PROGRESS`, o trabalho será marcado para ser interrompido e colocado no estado `STOP_REQUESTED`. Se o trabalho for concluído antes de ser interrompido, ele será colocado no estado `COMPLETED`. ``` aws comprehend stop-entities-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` Resultado: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE, "JobStatus": "STOP_REQUESTED" } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [StopEntitiesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-entities-detection-job.html) na *Referência de comandos da AWS CLI*. ### `stop-events-detection-job` O código de exemplo a seguir mostra como usar `stop-events-detection-job`. **AWS CLI** **Para interromper um trabalho assíncrono de detecção de eventos assíncronos** O exemplo `stop-events-detection-job` a seguir interrompe um trabalho assíncrono de detecção de eventos. Se o estado atual do trabalho for `IN_PROGRESS`, o trabalho será marcado para ser interrompido e colocado no estado `STOP_REQUESTED`. Se o trabalho for concluído antes de ser interrompido, ele será colocado no estado `COMPLETED`. ``` aws comprehend stop-events-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` Resultado: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE, "JobStatus": "STOP_REQUESTED" } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [StopEventsDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-events-detection-job.html) na *Referência de comandos da AWS CLI*. ### `stop-key-phrases-detection-job` O código de exemplo a seguir mostra como usar `stop-key-phrases-detection-job`. **AWS CLI** **Para interromper um trabalho assíncrono de detecção de frases-chave assíncronas** O exemplo `stop-key-phrases-detection-job` a seguir interrompe um trabalho assíncrono de detecção de frases-chave. Se o estado atual do trabalho for `IN_PROGRESS`, o trabalho será marcado para ser interrompido e colocado no estado `STOP_REQUESTED`. Se o trabalho for concluído antes de ser interrompido, ele será colocado no estado `COMPLETED`. ``` aws comprehend stop-key-phrases-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` Resultado: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE, "JobStatus": "STOP_REQUESTED" } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [StopKeyPhrasesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-key-phrases-detection-job.html) na *Referência de comandos da AWS CLI*. ### `stop-pii-entities-detection-job` O código de exemplo a seguir mostra como usar `stop-pii-entities-detection-job`. **AWS CLI** **Para interromper um trabalho assíncrono de detecção de entidades de pii** O exemplo `stop-pii-entities-detection-job` a seguir interrompe um trabalho assíncrono de detecção de entidades de pii. Se o estado atual do trabalho for `IN_PROGRESS`, o trabalho será marcado para ser interrompido e colocado no estado `STOP_REQUESTED`. Se o trabalho for concluído antes de ser interrompido, ele será colocado no estado `COMPLETED`. ``` aws comprehend stop-pii-entities-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` Resultado: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE, "JobStatus": "STOP_REQUESTED" } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [StopPiiEntitiesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-pii-entities-detection-job.html) na *Referência de comandos da AWS CLI*. ### `stop-sentiment-detection-job` O código de exemplo a seguir mostra como usar `stop-sentiment-detection-job`. **AWS CLI** **Para interromper um trabalho assíncrono de detecção de sentimentos** O exemplo `stop-sentiment-detection-job` a seguir interrompe um trabalho assíncrono de detecção de sentimentos. Se o estado atual do trabalho for `IN_PROGRESS`, o trabalho será marcado para ser interrompido e colocado no estado `STOP_REQUESTED`. Se o trabalho for concluído antes de ser interrompido, ele será colocado no estado `COMPLETED`. ``` aws comprehend stop-sentiment-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` Resultado: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE, "JobStatus": "STOP_REQUESTED" } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [StopSentimentDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-sentiment-detection-job.html) na *Referência de comandos da AWS CLI*. ### `stop-targeted-sentiment-detection-job` O código de exemplo a seguir mostra como usar `stop-targeted-sentiment-detection-job`. **AWS CLI** **Para interromper um trabalho assíncrono de detecção de sentimentos direcionados** O exemplo `stop-targeted-sentiment-detection-job` a seguir interrompe um trabalho assíncrono de detecção de sentimentos direcionados. Se o estado atual do trabalho for `IN_PROGRESS`, o trabalho será marcado para ser interrompido e colocado no estado `STOP_REQUESTED`. Se o trabalho for concluído antes de ser interrompido, ele será colocado no estado `COMPLETED`. ``` aws comprehend stop-targeted-sentiment-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` Resultado: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE, "JobStatus": "STOP_REQUESTED" } ``` Para obter mais informações, consulte [Análise assíncrona para insights do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [StopTargetedSentimentDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-targeted-sentiment-detection-job.html) na *Referência de comandos da AWS CLI*. ### `stop-training-document-classifier` O código de exemplo a seguir mostra como usar `stop-training-document-classifier`. **AWS CLI** **Para interromper o treinamento de um modelo de classificador de documentos** O exemplo `stop-training-document-classifier` a seguir interrompe o treinamento de um modelo de classificador de documentos enquanto está em andamento. ``` aws comprehend stop-training-document-classifier --document-classifier-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier ``` Este comando não produz saída. Para obter mais informações, consulte [Criação e gerenciamento de modelos personalizados](https://docs.aws.amazon.com/comprehend/latest/dg/manage-models.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [StopTrainingDocumentClassifier](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-training-document-classifier.html) na *Referência de comandos da AWS CLI*. ### `stop-training-entity-recognizer` O código de exemplo a seguir mostra como usar `stop-training-entity-recognizer`. **AWS CLI** **Para interromper o treinamento de um modelo de reconhecimento de entidades** O exemplo `stop-training-entity-recognizer` a seguir interrompe o treinamento de um modelo de reconhecimento de entidades enquanto está em andamento. ``` aws comprehend stop-training-entity-recognizer --entity-recognizer-arn "arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/examplerecognizer1" ``` Este comando não produz saída. Para obter mais informações, consulte [Criação e gerenciamento de modelos personalizados](https://docs.aws.amazon.com/comprehend/latest/dg/manage-models.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [StopTrainingEntityRecognizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-training-entity-recognizer.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Exemplo 1: adicionar uma tag a um recurso** O exemplo `tag-resource` a seguir adiciona uma única tag a um recurso do Amazon Comprehend. ``` aws comprehend tag-resource \ --resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1 \ --tags Key=Location,Value=Seattle ``` Este comando não tem uma saída. Para obter mais informações, consulte [Marcar recursos](https://docs.aws.amazon.com/comprehend/latest/dg/tagging.html) no *Guia do desenvolvedor do Amazon Comprehend*. **Exemplo 2: adicionar várias tags a um recurso** O exemplo `tag-resource` a seguir adiciona várias tags a um recurso do Amazon Comprehend. ``` aws comprehend tag-resource \ --resource-arn "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1" \ --tags Key=location,Value=Seattle Key=Department,Value=Finance ``` Este comando não tem uma saída. Para obter mais informações, consulte [Marcar recursos](https://docs.aws.amazon.com/comprehend/latest/dg/tagging.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Exemplo 1: remover uma única tag de um recurso** O exemplo `untag-resource` a seguir remove uma única tag de um recurso do Amazon Comprehend. ``` aws comprehend untag-resource \ --resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1 --tag-keys Location ``` Este comando não produz saída. Para obter mais informações, consulte [Marcar recursos](https://docs.aws.amazon.com/comprehend/latest/dg/tagging.html) no *Guia do desenvolvedor do Amazon Comprehend*. **Exemplo 2: remover várias tags de um recurso** O exemplo `untag-resource` a seguir remove várias tags de um recurso do Amazon Comprehend. ``` aws comprehend untag-resource \ --resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1 --tag-keys Location Department ``` Este comando não produz saída. Para obter mais informações, consulte [Marcar recursos](https://docs.aws.amazon.com/comprehend/latest/dg/tagging.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-endpoint` O código de exemplo a seguir mostra como usar `update-endpoint`. **AWS CLI** **Exemplo 1: atualizar as unidades de inferência de um endpoint** O exemplo `update-endpoint` a seguir atualiza as informações sobre um endpoint. Neste exemplo, o número de unidades de inferência é aumentado. ``` aws comprehend update-endpoint \ --endpoint-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint --desired-inference-units 2 ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar endpoints do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html) no *Guia do desenvolvedor do Amazon Comprehend*. **Exemplo 2: atualizar o modelo ativo de um endpoint** O exemplo `update-endpoint` a seguir atualiza as informações sobre um endpoint. Neste exemplo, o modelo ativo é alterado. ``` aws comprehend update-endpoint \ --endpoint-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint --active-model-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier-new ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar endpoints do Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [UpdateEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/update-endpoint.html) na *Referência de comandos da AWS CLI*. ### `update-flywheel` O código de exemplo a seguir mostra como usar `update-flywheel`. **AWS CLI** **Para atualizar uma configuração de flywheel** O exemplo `update-flywheel` a seguir atualiza uma configuração de flywheel. Neste exemplo, o modelo ativo do flywheel é atualizado. ``` aws comprehend update-flywheel \ --flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel-1 \ --active-model-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/new-example-classifier-model ``` Resultado: ``` { "FlywheelProperties": { "FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity", "ActiveModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/new-example-classifier-model", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role", "TaskConfig": { "LanguageCode": "en", "DocumentClassificationConfig": { "Mode": "MULTI_CLASS" } }, "DataLakeS3Uri": "s3://amzn-s3-demo-bucket/flywheel-entity/schemaVersion=1/20230616T200543Z/", "DataSecurityConfig": {}, "Status": "ACTIVE", "ModelType": "DOCUMENT_CLASSIFIER", "CreationTime": "2023-06-16T20:05:43.242000+00:00", "LastModifiedTime": "2023-06-19T04:00:43.027000+00:00", "LatestFlywheelIteration": "20230619T040032Z" } } ``` Para obter mais informações, consulte [Visão geral do flywheel](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) no *Guia do desenvolvedor do Amazon Comprehend*. + Para ver detalhes da API, consulte [UpdateFlywheel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/update-flywheel.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon Comprehend Medical usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando oAWS Command Line Interface com Amazon Comprehend Medical. *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 ### `describe-entities-detection-v2-job` O código de exemplo a seguir mostra como usar `describe-entities-detection-v2-job`. **AWS CLI** **Para descrever um trabalho de detecção de entidades** O exemplo `describe-entities-detection-v2-job` a seguir exibe as propriedades associadas a uma tarefa assíncrona de detecção de entidades. ``` aws comprehendmedical describe-entities-detection-v2-job \ --job-id "ab9887877365fe70299089371c043b96" ``` Resultado: ``` { "ComprehendMedicalAsyncJobProperties": { "JobId": "ab9887877365fe70299089371c043b96", "JobStatus": "COMPLETED", "SubmitTime": "2020-03-18T21:20:15.614000+00:00", "EndTime": "2020-03-18T21:27:07.350000+00:00", "ExpirationTime": "2020-07-16T21:20:15+00:00", "InputDataConfig": { "S3Bucket": "comp-med-input", "S3Key": "" }, "OutputDataConfig": { "S3Bucket": "comp-med-output", "S3Key": "867139942017-EntitiesDetection-ab9887877365fe70299089371c043b96/" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole", "ModelVersion": "DetectEntitiesModelV20190930" } } ``` Para obter mais informações, consulte [APIs em lote](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-batchapi.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. + Para ver detalhes da API, consulte [DescribeEntitiesDetectionV2Job](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/describe-entities-detection-v2-job.html) na *Referência de comandos da AWS CLI*. ### `describe-icd10-cm-inference-job` O código de exemplo a seguir mostra como usar `describe-icd10-cm-inference-job`. **AWS CLI** **Para descrever um trabalho de inferência da ICD-10-CM** O exemplo `describe-icd10-cm-inference-job` a seguir descreve as propriedades do trabalho de inferência solicitado com o job-id especificado. ``` aws comprehendmedical describe-icd10-cm-inference-job \ --job-id "5780034166536cdb52ffa3295a1b00a7" ``` Resultado: ``` { "ComprehendMedicalAsyncJobProperties": { "JobId": "5780034166536cdb52ffa3295a1b00a7", "JobStatus": "COMPLETED", "SubmitTime": "2020-05-18T21:20:15.614000+00:00", "EndTime": "2020-05-18T21:27:07.350000+00:00", "ExpirationTime": "2020-09-16T21:20:15+00:00", "InputDataConfig": { "S3Bucket": "comp-med-input", "S3Key": "AKIAIOSFODNN7EXAMPLE" }, "OutputDataConfig": { "S3Bucket": "comp-med-output", "S3Key": "AKIAIOSFODNN7EXAMPLE" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole", "ModelVersion": "0.1.0" } } ``` Para obter mais informações, consulte [Vinculação de ontologias a análises em lotes](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. + Para ver detalhes da API, consulte [DescribeIcd10CmInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/describe-icd10-cm-inference-job.html) na *Referência de comandos da AWS CLI*. ### `describe-phi-detection-job` O código de exemplo a seguir mostra como usar `describe-phi-detection-job`. **AWS CLI** **Para descrever um trabalho de detecção de PHI** O exemplo `describe-phi-detection-job` a seguir exibe as propriedades associadas a uma tarefa assíncrona de detecção de informações de saúde protegidas (PHI). ``` aws comprehendmedical describe-phi-detection-job \ --job-id "4750034166536cdb52ffa3295a1b00a3" ``` Resultado: ``` { "ComprehendMedicalAsyncJobProperties": { "JobId": "4750034166536cdb52ffa3295a1b00a3", "JobStatus": "COMPLETED", "SubmitTime": "2020-03-19T20:38:37.594000+00:00", "EndTime": "2020-03-19T20:45:07.894000+00:00", "ExpirationTime": "2020-07-17T20:38:37+00:00", "InputDataConfig": { "S3Bucket": "comp-med-input", "S3Key": "" }, "OutputDataConfig": { "S3Bucket": "comp-med-output", "S3Key": "867139942017-PHIDetection-4750034166536cdb52ffa3295a1b00a3/" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole", "ModelVersion": "PHIModelV20190903" } } ``` Para obter mais informações, consulte [APIs em lote](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-batchapi.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. + Para ver detalhes da API, consulte [DescribePhiDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/describe-phi-detection-job.html) na *Referência de comandos da AWS CLI*. ### `describe-rx-norm-inference-job` O código de exemplo a seguir mostra como usar `describe-rx-norm-inference-job`. **AWS CLI** **Para descrever um trabalho de inferência do RxNorm** O exemplo `describe-rx-norm-inference-job` a seguir descreve as propriedades do trabalho de inferência solicitado com o job-id especificado. ``` aws comprehendmedical describe-rx-norm-inference-job \ --job-id "eg8199877365fc70299089371c043b96" ``` Resultado: ``` { "ComprehendMedicalAsyncJobProperties": { "JobId": "g8199877365fc70299089371c043b96", "JobStatus": "COMPLETED", "SubmitTime": "2020-05-18T21:20:15.614000+00:00", "EndTime": "2020-05-18T21:27:07.350000+00:00", "ExpirationTime": "2020-09-16T21:20:15+00:00", "InputDataConfig": { "S3Bucket": "comp-med-input", "S3Key": "AKIAIOSFODNN7EXAMPLE" }, "OutputDataConfig": { "S3Bucket": "comp-med-output", "S3Key": "AKIAIOSFODNN7EXAMPLE" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole", "ModelVersion": "0.0.0" } } ``` Para obter mais informações, consulte [Vinculação de ontologias a análises em lotes](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. + Para ver detalhes da API, consulte [DescribeRxNormInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/describe-rx-norm-inference-job.html) na *Referência de comandos da AWS CLI*. ### `describe-snomedct-inference-job` O código de exemplo a seguir mostra como usar `describe-snomedct-inference-job`. **AWS CLI** **Para descrever um trabalho de inferência da SNOMED CT** O exemplo `describe-snomedct-inference-job` a seguir descreve as propriedades do trabalho de inferência solicitado com o job-id especificado. ``` aws comprehendmedical describe-snomedct-inference-job \ --job-id "2630034166536cdb52ffa3295a1b00a7" ``` Resultado: ``` { "ComprehendMedicalAsyncJobProperties": { "JobId": "2630034166536cdb52ffa3295a1b00a7", "JobStatus": "COMPLETED", "SubmitTime": "2021-12-18T21:20:15.614000+00:00", "EndTime": "2021-12-18T21:27:07.350000+00:00", "ExpirationTime": "2022-05-16T21:20:15+00:00", "InputDataConfig": { "S3Bucket": "comp-med-input", "S3Key": "AKIAIOSFODNN7EXAMPLE" }, "OutputDataConfig": { "S3Bucket": "comp-med-output", "S3Key": "AKIAIOSFODNN7EXAMPLE" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole", "ModelVersion": "0.1.0" } } ``` Para obter mais informações, consulte [Vinculação de ontologias a análises em lotes](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. + Para ver detalhes da API, consulte [DescribeSnomedctInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/describe-snomedct-inference-job.html) na *Referência de comandos da AWS CLI*. ### `detect-entities-v2` O código de exemplo a seguir mostra como usar `detect-entities-v2`. **AWS CLI** **Exemplo 1: detectar entidades diretamente do texto** O exemplo `detect-entities-v2` a seguir mostra as entidades detectadas e as rotula de acordo com o tipo, diretamente do texto de entrada. ``` aws comprehendmedical detect-entities-v2 \ --text "Sleeping trouble on present dosage of Clonidine. Severe rash on face and leg, slightly itchy." ``` Resultado: ``` { "Id": 0, "BeginOffset": 38, "EndOffset": 47, "Score": 0.9942955374717712, "Text": "Clonidine", "Category": "MEDICATION", "Type": "GENERIC_NAME", "Traits": [] } ``` Para obter mais informações, consulte [Detectar entidades versão 2](https://docs.aws.amazon.com/comprehend/latest/dg/extracted-med-info-V2.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. **Exemplo 2: detectar entidades a partir de um caminho de arquivo** O exemplo `detect-entities-v2` a seguir mostra as entidades detectadas e as rotula de acordo com o tipo de um caminho de arquivo. ``` aws comprehendmedical detect-entities-v2 \ --text file://medical_entities.txt ``` Conteúdo de `medical_entities.txt`: ``` { "Sleeping trouble on present dosage of Clonidine. Severe rash on face and leg, slightly itchy." } ``` Resultado: ``` { "Id": 0, "BeginOffset": 38, "EndOffset": 47, "Score": 0.9942955374717712, "Text": "Clonidine", "Category": "MEDICATION", "Type": "GENERIC_NAME", "Traits": [] } ``` Para obter mais informações, consulte [Detectar entidades versão 2](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-entitiesv2.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. + Para ver detalhes da API, consulte [DetectEntitiesV2](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/detect-entities-v2.html) na *Referência de comandos da AWS CLI*. ### `detect-phi` O código de exemplo a seguir mostra como usar `detect-phi`. **AWS CLI** **Exemplo 1: detectar informações de saúde protegidas (PHI) diretamente do texto** O exemplo `detect-phi` a seguir exibe as entidades de informações de saúde protegidas (PHI) detectadas diretamente do texto de entrada. ``` aws comprehendmedical detect-phi \ --text "Patient Carlos Salazar presented with rash on his upper extremities and dry cough. He lives at 100 Main Street, Anytown, USA where he works from his home as a carpenter." ``` Resultado: ``` { "Entities": [ { "Id": 0, "BeginOffset": 8, "EndOffset": 21, "Score": 0.9914507269859314, "Text": "Carlos Salazar", "Category": "PROTECTED_HEALTH_INFORMATION", "Type": "NAME", "Traits": [] }, { "Id": 1, "BeginOffset": 94, "EndOffset": 109, "Score": 0.871849775314331, "Text": "100 Main Street, Anytown, USA", "Category": "PROTECTED_HEALTH_INFORMATION", "Type": "ADDRESS", "Traits": [] }, { "Id": 2, "BeginOffset": 145, "EndOffset": 154, "Score": 0.8302185535430908, "Text": "carpenter", "Category": "PROTECTED_HEALTH_INFORMATION", "Type": "PROFESSION", "Traits": [] } ], "ModelVersion": "0.0.0" } ``` Para obter mais informações, consulte [Detectar PHI](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-phi.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. **Exemplo 2: detectar informações de saúde protegidas (PHI) diretamente de um caminho de arquivo** O exemplo `detect-phi` a seguir mostra as entidades de informações de saúde protegidas (PHI) detectadas em um caminho de arquivo. ``` aws comprehendmedical detect-phi \ --text file://phi.txt ``` Conteúdo de `phi.txt`: ``` "Patient Carlos Salazar presented with a rash on his upper extremities and a dry cough. He lives at 100 Main Street, Anytown, USA, where he works from his home as a carpenter." ``` Resultado: ``` { "Entities": [ { "Id": 0, "BeginOffset": 8, "EndOffset": 21, "Score": 0.9914507269859314, "Text": "Carlos Salazar", "Category": "PROTECTED_HEALTH_INFORMATION", "Type": "NAME", "Traits": [] }, { "Id": 1, "BeginOffset": 94, "EndOffset": 109, "Score": 0.871849775314331, "Text": "100 Main Street, Anytown, USA", "Category": "PROTECTED_HEALTH_INFORMATION", "Type": "ADDRESS", "Traits": [] }, { "Id": 2, "BeginOffset": 145, "EndOffset": 154, "Score": 0.8302185535430908, "Text": "carpenter", "Category": "PROTECTED_HEALTH_INFORMATION", "Type": "PROFESSION", "Traits": [] } ], "ModelVersion": "0.0.0" } ``` Para obter mais informações, consulte [Detectar PHI](https://docs.aws.amazon.com/comprehend/latest/dg/how-medical-phi.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. + Para ver detalhes da API, consulte [DetectPhi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/detect-phi.html) na *Referência de comandos da AWS CLI*. ### `infer-icd10-cm` O código de exemplo a seguir mostra como usar `infer-icd10-cm`. **AWS CLI** **Exemplo 1: detectar entidades de condições médicas e vincular à ontologia da ICD-10-CM diretamente do texto** O exemplo `infer-icd10-cm` a seguir rotula as entidades de condições médicas detectadas e vincula essas entidades com códigos na edição de 2019 da International Classification of Diseases Clinical Modification (ICD-10-CM). ``` aws comprehendmedical infer-icd10-cm \ --text "The patient complains of abdominal pain, has a long-standing history of diabetes treated with Micronase daily." ``` Resultado: ``` { "Entities": [ { "Id": 0, "Text": "abdominal pain", "Category": "MEDICAL_CONDITION", "Type": "DX_NAME", "Score": 0.9475538730621338, "BeginOffset": 28, "EndOffset": 42, "Attributes": [], "Traits": [ { "Name": "SYMPTOM", "Score": 0.6724207401275635 } ], "ICD10CMConcepts": [ { "Description": "Unspecified abdominal pain", "Code": "R10.9", "Score": 0.6904221177101135 }, { "Description": "Epigastric pain", "Code": "R10.13", "Score": 0.1364113688468933 }, { "Description": "Generalized abdominal pain", "Code": "R10.84", "Score": 0.12508003413677216 }, { "Description": "Left lower quadrant pain", "Code": "R10.32", "Score": 0.10063883662223816 }, { "Description": "Lower abdominal pain, unspecified", "Code": "R10.30", "Score": 0.09933677315711975 } ] }, { "Id": 1, "Text": "diabetes", "Category": "MEDICAL_CONDITION", "Type": "DX_NAME", "Score": 0.9899052977561951, "BeginOffset": 75, "EndOffset": 83, "Attributes": [], "Traits": [ { "Name": "DIAGNOSIS", "Score": 0.9258432388305664 } ], "ICD10CMConcepts": [ { "Description": "Type 2 diabetes mellitus without complications", "Code": "E11.9", "Score": 0.7158446311950684 }, { "Description": "Family history of diabetes mellitus", "Code": "Z83.3", "Score": 0.5704703330993652 }, { "Description": "Family history of other endocrine, nutritional and metabolic diseases", "Code": "Z83.49", "Score": 0.19856023788452148 }, { "Description": "Type 1 diabetes mellitus with ketoacidosis without coma", "Code": "E10.10", "Score": 0.13285516202449799 }, { "Description": "Type 2 diabetes mellitus with hyperglycemia", "Code": "E11.65", "Score": 0.0993388369679451 } ] } ], "ModelVersion": "0.1.0" } ``` Para obter mais informações, consulte [Inferir ICD10-CM](https://docs.aws.amazon.com/comprehend/latest/dg/ontology-linking-icd10.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. **Exemplo 2: detectar entidades de condições médicas e vincular-se à ontologia da ICD-10-CM a partir de um caminho de arquivo** O exemplo `infer-icd-10-cm` a seguir rotula as entidades de condições médicas detectadas e vincula essas entidades com códigos na edição de 2019 da International Classification of Diseases Clinical Modification (ICD-10-CM). ``` aws comprehendmedical infer-icd10-cm \ --text file://icd10cm.txt ``` Conteúdo de `icd10cm.txt`: ``` { "The patient complains of abdominal pain, has a long-standing history of diabetes treated with Micronase daily." } ``` Resultado: ``` { "Entities": [ { "Id": 0, "Text": "abdominal pain", "Category": "MEDICAL_CONDITION", "Type": "DX_NAME", "Score": 0.9475538730621338, "BeginOffset": 28, "EndOffset": 42, "Attributes": [], "Traits": [ { "Name": "SYMPTOM", "Score": 0.6724207401275635 } ], "ICD10CMConcepts": [ { "Description": "Unspecified abdominal pain", "Code": "R10.9", "Score": 0.6904221177101135 }, { "Description": "Epigastric pain", "Code": "R10.13", "Score": 0.1364113688468933 }, { "Description": "Generalized abdominal pain", "Code": "R10.84", "Score": 0.12508003413677216 }, { "Description": "Left lower quadrant pain", "Code": "R10.32", "Score": 0.10063883662223816 }, { "Description": "Lower abdominal pain, unspecified", "Code": "R10.30", "Score": 0.09933677315711975 } ] }, { "Id": 1, "Text": "diabetes", "Category": "MEDICAL_CONDITION", "Type": "DX_NAME", "Score": 0.9899052977561951, "BeginOffset": 75, "EndOffset": 83, "Attributes": [], "Traits": [ { "Name": "DIAGNOSIS", "Score": 0.9258432388305664 } ], "ICD10CMConcepts": [ { "Description": "Type 2 diabetes mellitus without complications", "Code": "E11.9", "Score": 0.7158446311950684 }, { "Description": "Family history of diabetes mellitus", "Code": "Z83.3", "Score": 0.5704703330993652 }, { "Description": "Family history of other endocrine, nutritional and metabolic diseases", "Code": "Z83.49", "Score": 0.19856023788452148 }, { "Description": "Type 1 diabetes mellitus with ketoacidosis without coma", "Code": "E10.10", "Score": 0.13285516202449799 }, { "Description": "Type 2 diabetes mellitus with hyperglycemia", "Code": "E11.65", "Score": 0.0993388369679451 } ] } ], "ModelVersion": "0.1.0" } ``` Para obter mais informações, consulte [Infer-ICD10-CM](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontology-icd10.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. + Para ver detalhes da API, consulte [InferIcd10Cm](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/infer-icd10-cm.html) na *Referência de comandos da AWS CLI*. ### `infer-rx-norm` O código de exemplo a seguir mostra como usar `infer-rx-norm`. **AWS CLI** **Exemplo 1: detectar entidades de medicamentos e vincular ao RxNorm diretamente do texto** O exemplo `infer-rx-norm` a seguir mostra e rotula as entidades de medicamentos detectadas e vincula essas entidades aos identificadores de conceito (RxCUI) do banco de dados RxNorm da National Library of Medicine. ``` aws comprehendmedical infer-rx-norm \ --text "Patient reports taking Levothyroxine 125 micrograms p.o. once daily, but denies taking Synthroid." ``` Resultado: ``` { "Entities": [ { "Id": 0, "Text": "Levothyroxine", "Category": "MEDICATION", "Type": "GENERIC_NAME", "Score": 0.9996285438537598, "BeginOffset": 23, "EndOffset": 36, "Attributes": [ { "Type": "DOSAGE", "Score": 0.9892290830612183, "RelationshipScore": 0.9997978806495667, "Id": 1, "BeginOffset": 37, "EndOffset": 51, "Text": "125 micrograms", "Traits": [] }, { "Type": "ROUTE_OR_MODE", "Score": 0.9988924860954285, "RelationshipScore": 0.998291552066803, "Id": 2, "BeginOffset": 52, "EndOffset": 56, "Text": "p.o.", "Traits": [] }, { "Type": "FREQUENCY", "Score": 0.9953463673591614, "RelationshipScore": 0.9999889135360718, "Id": 3, "BeginOffset": 57, "EndOffset": 67, "Text": "once daily", "Traits": [] } ], "Traits": [], "RxNormConcepts": [ { "Description": "Levothyroxine Sodium 0.125 MG Oral Tablet", "Code": "966224", "Score": 0.9912070631980896 }, { "Description": "Levothyroxine Sodium 0.125 MG Oral Capsule", "Code": "966405", "Score": 0.8698278665542603 }, { "Description": "Levothyroxine Sodium 0.125 MG Oral Tablet [Synthroid]", "Code": "966191", "Score": 0.7448257803916931 }, { "Description": "levothyroxine", "Code": "10582", "Score": 0.7050482630729675 }, { "Description": "Levothyroxine Sodium 0.125 MG Oral Tablet [Levoxyl]", "Code": "966190", "Score": 0.6921631693840027 } ] }, { "Id": 4, "Text": "Synthroid", "Category": "MEDICATION", "Type": "BRAND_NAME", "Score": 0.9946461319923401, "BeginOffset": 86, "EndOffset": 95, "Attributes": [], "Traits": [ { "Name": "NEGATION", "Score": 0.5167351961135864 } ], "RxNormConcepts": [ { "Description": "Synthroid", "Code": "224920", "Score": 0.9462039470672607 }, { "Description": "Levothyroxine Sodium 0.088 MG Oral Tablet [Synthroid]", "Code": "966282", "Score": 0.8309829235076904 }, { "Description": "Levothyroxine Sodium 0.125 MG Oral Tablet [Synthroid]", "Code": "966191", "Score": 0.4945160448551178 }, { "Description": "Levothyroxine Sodium 0.05 MG Oral Tablet [Synthroid]", "Code": "966247", "Score": 0.3674522042274475 }, { "Description": "Levothyroxine Sodium 0.025 MG Oral Tablet [Synthroid]", "Code": "966158", "Score": 0.2588822841644287 } ] } ], "ModelVersion": "0.0.0" } ``` Para obter mais informações, consulte [Inferir RxNorm](https://docs.aws.amazon.com/comprehend/latest/dg/ontology-linking-rxnorm.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. **Exemplo 2: detectar entidades de medicamentos e vincular ao RxNorm a partir de um caminho de arquivo.** O exemplo `infer-rx-norm` a seguir mostra e rotula as entidades de medicamentos detectadas e vincula essas entidades aos identificadores de conceito (RxCUI) do banco de dados RxNorm da National Library of Medicine. ``` aws comprehendmedical infer-rx-norm \ --text file://rxnorm.txt ``` Conteúdo de `rxnorm.txt`: ``` { "Patient reports taking Levothyroxine 125 micrograms p.o. once daily, but denies taking Synthroid." } ``` Resultado: ``` { "Entities": [ { "Id": 0, "Text": "Levothyroxine", "Category": "MEDICATION", "Type": "GENERIC_NAME", "Score": 0.9996285438537598, "BeginOffset": 23, "EndOffset": 36, "Attributes": [ { "Type": "DOSAGE", "Score": 0.9892290830612183, "RelationshipScore": 0.9997978806495667, "Id": 1, "BeginOffset": 37, "EndOffset": 51, "Text": "125 micrograms", "Traits": [] }, { "Type": "ROUTE_OR_MODE", "Score": 0.9988924860954285, "RelationshipScore": 0.998291552066803, "Id": 2, "BeginOffset": 52, "EndOffset": 56, "Text": "p.o.", "Traits": [] }, { "Type": "FREQUENCY", "Score": 0.9953463673591614, "RelationshipScore": 0.9999889135360718, "Id": 3, "BeginOffset": 57, "EndOffset": 67, "Text": "once daily", "Traits": [] } ], "Traits": [], "RxNormConcepts": [ { "Description": "Levothyroxine Sodium 0.125 MG Oral Tablet", "Code": "966224", "Score": 0.9912070631980896 }, { "Description": "Levothyroxine Sodium 0.125 MG Oral Capsule", "Code": "966405", "Score": 0.8698278665542603 }, { "Description": "Levothyroxine Sodium 0.125 MG Oral Tablet [Synthroid]", "Code": "966191", "Score": 0.7448257803916931 }, { "Description": "levothyroxine", "Code": "10582", "Score": 0.7050482630729675 }, { "Description": "Levothyroxine Sodium 0.125 MG Oral Tablet [Levoxyl]", "Code": "966190", "Score": 0.6921631693840027 } ] }, { "Id": 4, "Text": "Synthroid", "Category": "MEDICATION", "Type": "BRAND_NAME", "Score": 0.9946461319923401, "BeginOffset": 86, "EndOffset": 95, "Attributes": [], "Traits": [ { "Name": "NEGATION", "Score": 0.5167351961135864 } ], "RxNormConcepts": [ { "Description": "Synthroid", "Code": "224920", "Score": 0.9462039470672607 }, { "Description": "Levothyroxine Sodium 0.088 MG Oral Tablet [Synthroid]", "Code": "966282", "Score": 0.8309829235076904 }, { "Description": "Levothyroxine Sodium 0.125 MG Oral Tablet [Synthroid]", "Code": "966191", "Score": 0.4945160448551178 }, { "Description": "Levothyroxine Sodium 0.05 MG Oral Tablet [Synthroid]", "Code": "966247", "Score": 0.3674522042274475 }, { "Description": "Levothyroxine Sodium 0.025 MG Oral Tablet [Synthroid]", "Code": "966158", "Score": 0.2588822841644287 } ] } ], "ModelVersion": "0.0.0" } ``` Para obter mais informações, consulte [Inferir RxNorm](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontology-RxNorm.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. + Para ver detalhes da API, consulte [InferRxNorm](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/infer-rx-norm.html) na *Referência de comandos da AWS CLI*. ### `infer-snomedct` O código de exemplo a seguir mostra como usar `infer-snomedct`. **AWS CLI** **Exemplo: como detectar entidades e vincular à ontologia da SNOMED CT diretamente do texto** O exemplo `infer-snomedct` a seguir mostra como detectar entidades médicas e vinculá-las a conceitos da versão 2021-03 da Nomenclatura Sistematizada de Medicina, Termos Clínicos (SNOMED CT). ``` aws comprehendmedical infer-snomedct \ --text "The patient complains of abdominal pain, has a long-standing history of diabetes treated with Micronase daily." ``` Resultado: ``` { "Entities": [ { "Id": 3, "BeginOffset": 26, "EndOffset": 40, "Score": 0.9598260521888733, "Text": "abdominal pain", "Category": "MEDICAL_CONDITION", "Type": "DX_NAME", "Traits": [ { "Name": "SYMPTOM", "Score": 0.6819021701812744 } ] }, { "Id": 4, "BeginOffset": 73, "EndOffset": 81, "Score": 0.9905840158462524, "Text": "diabetes", "Category": "MEDICAL_CONDITION", "Type": "DX_NAME", "Traits": [ { "Name": "DIAGNOSIS", "Score": 0.9255214333534241 } ] }, { "Id": 1, "BeginOffset": 95, "EndOffset": 104, "Score": 0.6371926665306091, "Text": "Micronase", "Category": "MEDICATION", "Type": "BRAND_NAME", "Traits": [], "Attributes": [ { "Type": "FREQUENCY", "Score": 0.9761165380477905, "RelationshipScore": 0.9984188079833984, "RelationshipType": "FREQUENCY", "Id": 2, "BeginOffset": 105, "EndOffset": 110, "Text": "daily", "Category": "MEDICATION", "Traits": [] } ] } ], "UnmappedAttributes": [], "ModelVersion": "1.0.0" } ``` Para obter mais informações, consulte [InferSNOMEDCT](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontology-linking-snomed.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. + Para ver detalhes da API, consulte [InferSnomedct](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/infer-snomedct.html) na *Referência de comandos da AWS CLI*. ### `list-entities-detection-v2-jobs` O código de exemplo a seguir mostra como usar `list-entities-detection-v2-jobs`. **AWS CLI** **Para listar trabalhos de detecção de entidades** O exemplo `list-entities-detection-v2-jobs` a seguir lista os trabalhos atuais de detecção assíncrona. ``` aws comprehendmedical list-entities-detection-v2-jobs ``` Resultado: ``` { "ComprehendMedicalAsyncJobPropertiesList": [ { "JobId": "ab9887877365fe70299089371c043b96", "JobStatus": "COMPLETED", "SubmitTime": "2020-03-19T20:38:37.594000+00:00", "EndTime": "2020-03-19T20:45:07.894000+00:00", "ExpirationTime": "2020-07-17T20:38:37+00:00", "InputDataConfig": { "S3Bucket": "comp-med-input", "S3Key": "" }, "OutputDataConfig": { "S3Bucket": "comp-med-output", "S3Key": "867139942017-EntitiesDetection-ab9887877365fe70299089371c043b96/" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole", "ModelVersion": "DetectEntitiesModelV20190930" } ] } ``` Para obter mais informações, consulte [APIs em lote](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-batchapi.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. + Para ver detalhes da API, consulte [ListEntitiesDetectionV2Jobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/list-entities-detection-v2-jobs.html) na *Referência de comandos da AWS CLI*. ### `list-icd10-cm-inference-jobs` O código de exemplo a seguir mostra como usar `list-icd10-cm-inference-jobs`. **AWS CLI** **Para listar todos os trabalhos atuais de inferência da ICD-10-CM** O exemplo a seguir mostra como a operação `list-icd10-cm-inference-jobs` retorna uma lista dos trabalhos de inferência em lote assíncronos atuais da ICD-10-CM. ``` aws comprehendmedical list-icd10-cm-inference-jobs ``` Resultado: ``` { "ComprehendMedicalAsyncJobPropertiesList": [ { "JobId": "5780034166536cdb52ffa3295a1b00a7", "JobStatus": "COMPLETED", "SubmitTime": "2020-05-19T20:38:37.594000+00:00", "EndTime": "2020-05-19T20:45:07.894000+00:00", "ExpirationTime": "2020-09-17T20:38:37+00:00", "InputDataConfig": { "S3Bucket": "comp-med-input", "S3Key": "AKIAIOSFODNN7EXAMPLE" }, "OutputDataConfig": { "S3Bucket": "comp-med-output", "S3Key": "AKIAIOSFODNN7EXAMPLE" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole", "ModelVersion": "0.1.0" } ] } ``` Para obter mais informações, consulte [Vinculação de ontologias a análises em lotes](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. + Para ver detalhes da API, consulte [ListIcd10CmInferenceJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/list-icd10-cm-inference-jobs.html) na *Referência de comandos da AWS CLI*. ### `list-phi-detection-jobs` O código de exemplo a seguir mostra como usar `list-phi-detection-jobs`. **AWS CLI** **Para listar as tarefas de detecção de informações de saúde protegidas (PHI)** O exemplo `list-phi-detection-jobs` a seguir lista as tarefas de detecção de informações de saúde protegidas (PHI) atuais ``` aws comprehendmedical list-phi-detection-jobs ``` Resultado: ``` { "ComprehendMedicalAsyncJobPropertiesList": [ { "JobId": "4750034166536cdb52ffa3295a1b00a3", "JobStatus": "COMPLETED", "SubmitTime": "2020-03-19T20:38:37.594000+00:00", "EndTime": "2020-03-19T20:45:07.894000+00:00", "ExpirationTime": "2020-07-17T20:38:37+00:00", "InputDataConfig": { "S3Bucket": "comp-med-input", "S3Key": "" }, "OutputDataConfig": { "S3Bucket": "comp-med-output", "S3Key": "867139942017-PHIDetection-4750034166536cdb52ffa3295a1b00a3/" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole", "ModelVersion": "PHIModelV20190903" } ] } ``` Para obter mais informações, consulte [APIs em lote](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-batchapi.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. + Para ver detalhes da API, consulte [ListPhiDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/list-phi-detection-jobs.html) na *Referência de comandos da AWS CLI*. ### `list-rx-norm-inference-jobs` O código de exemplo a seguir mostra como usar `list-rx-norm-inference-jobs`. **AWS CLI** **Para listar todos os trabalhos atuais de inferência do Rx-Norm** O exemplo a seguir mostra como `list-rx-norm-inference-jobs` retorna uma lista dos trabalhos de inferência em lote assíncronos atuais do Rx-Norm. ``` aws comprehendmedical list-rx-norm-inference-jobs ``` Resultado: ``` { "ComprehendMedicalAsyncJobPropertiesList": [ { "JobId": "4980034166536cfb52gga3295a1b00a3", "JobStatus": "COMPLETED", "SubmitTime": "2020-05-19T20:38:37.594000+00:00", "EndTime": "2020-05-19T20:45:07.894000+00:00", "ExpirationTime": "2020-09-17T20:38:37+00:00", "InputDataConfig": { "S3Bucket": "comp-med-input", "S3Key": "AKIAIOSFODNN7EXAMPLE" }, "OutputDataConfig": { "S3Bucket": "comp-med-output", "S3Key": "AKIAIOSFODNN7EXAMPLE" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole", "ModelVersion": "0.0.0" } ] } ``` Para obter mais informações, consulte [Vinculação de ontologias a análises em lotes](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. + Para ver detalhes da API, consulte [ListRxNormInferenceJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/list-rx-norm-inference-jobs.html) na *Referência de comandos da AWS CLI*. ### `list-snomedct-inference-jobs` O código de exemplo a seguir mostra como usar `list-snomedct-inference-jobs`. **AWS CLI** **Para listar todos os trabalhos de inferência da SNOMED CT** O exemplo a seguir mostra como a operação `list-snomedct-inference-jobs` retorna uma lista dos trabalhos de inferência em lote da SNOMED CT assíncronos atuais. ``` aws comprehendmedical list-snomedct-inference-jobs ``` Resultado: ``` { "ComprehendMedicalAsyncJobPropertiesList": [ { "JobId": "5780034166536cdb52ffa3295a1b00a7", "JobStatus": "COMPLETED", "SubmitTime": "2020-05-19T20:38:37.594000+00:00", "EndTime": "2020-05-19T20:45:07.894000+00:00", "ExpirationTime": "2020-09-17T20:38:37+00:00", "InputDataConfig": { "S3Bucket": "comp-med-input", "S3Key": "AKIAIOSFODNN7EXAMPLE" }, "OutputDataConfig": { "S3Bucket": "comp-med-output", "S3Key": "AKIAIOSFODNN7EXAMPLE" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole", "ModelVersion": "0.1.0" } ] } ``` Para obter mais informações, consulte [Vinculação de ontologias a análises em lotes](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. + Para ver detalhes da API, consulte [ListSnomedctInferenceJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/list-snomedct-inference-jobs.html) na *Referência de comandos da AWS CLI*. ### `start-entities-detection-v2-job` O código de exemplo a seguir mostra como usar `start-entities-detection-v2-job`. **AWS CLI** **Para iniciar um trabalho de detecção de entidades** O exemplo `start-entities-detection-v2-job` a seguir inicia um trabalho assíncrono de detecção de entidades. ``` aws comprehendmedical start-entities-detection-v2-job \ --input-data-config "S3Bucket=comp-med-input" \ --output-data-config "S3Bucket=comp-med-output" \ --data-access-role-arn arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole \ --language-code en ``` Resultado: ``` { "JobId": "ab9887877365fe70299089371c043b96" } ``` Para obter mais informações, consulte [APIs em lote](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-batchapi.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. + Para ver detalhes da API, consulte [StartEntitiesDetectionV2Job](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/start-entities-detection-v2-job.html) na *Referência de comandos da AWS CLI*. ### `start-icd10-cm-inference-job` O código de exemplo a seguir mostra como usar `start-icd10-cm-inference-job`. **AWS CLI** **Para iniciar um trabalho de inferência da ICD-10-CM** O exemplo `start-icd10-cm-inference-job` a seguir inicia um trabalho de análise em lote de inferência da ICD-10-CM. ``` aws comprehendmedical start-icd10-cm-inference-job \ --input-data-config "S3Bucket=comp-med-input" \ --output-data-config "S3Bucket=comp-med-output" \ --data-access-role-arn arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole \ --language-code en ``` Resultado: ``` { "JobId": "ef7289877365fc70299089371c043b96" } ``` Para obter mais informações, consulte [Vinculação de ontologias a análises em lotes](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. + Para ver detalhes da API, consulte [StartIcd10CmInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/start-icd10-cm-inference-job.html) na *Referência de comandos da AWS CLI*. ### `start-phi-detection-job` O código de exemplo a seguir mostra como usar `start-phi-detection-job`. **AWS CLI** **Para iniciar um trabalho de detecção de PHI** O exemplo `start-phi-detection-job` a seguir inicia um trabalho assíncrono de detecção de entidades PHI. ``` aws comprehendmedical start-phi-detection-job \ --input-data-config "S3Bucket=comp-med-input" \ --output-data-config "S3Bucket=comp-med-output" \ --data-access-role-arn arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole \ --language-code en ``` Resultado: ``` { "JobId": "ab9887877365fe70299089371c043b96" } ``` Para obter mais informações, consulte [APIs em lote](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-batchapi.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. + Para obter detalhes sobre a API, consulte [StartPhiDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/start-phi-detection-job.html) na *Referência de comandos da AWS CLI*. ### `start-rx-norm-inference-job` O código de exemplo a seguir mostra como usar `start-rx-norm-inference-job`. **AWS CLI** **Para iniciar um trabalho de inferência do RxNorm** O exemplo `start-rx-norm-inference-job` a seguir inicia um trabalho de análise em lote de inferência do RxNorm. ``` aws comprehendmedical start-rx-norm-inference-job \ --input-data-config "S3Bucket=comp-med-input" \ --output-data-config "S3Bucket=comp-med-output" \ --data-access-role-arn arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole \ --language-code en ``` Resultado: ``` { "JobId": "eg8199877365fc70299089371c043b96" } ``` Para obter mais informações, consulte [Vinculação de ontologias a análises em lotes](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. + Para ver detalhes da API, consulte [StartRxNormInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/start-rx-norm-inference-job.html) na *Referência de comandos da AWS CLI*. ### `start-snomedct-inference-job` O código de exemplo a seguir mostra como usar `start-snomedct-inference-job`. **AWS CLI** **Para iniciar um trabalho de inferência da SNOMED CT** O exemplo `start-snomedct-inference-job` a seguir inicia um trabalho de análise em lote de inferência da SNOMED CT. ``` aws comprehendmedical start-snomedct-inference-job \ --input-data-config "S3Bucket=comp-med-input" \ --output-data-config "S3Bucket=comp-med-output" \ --data-access-role-arn arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole \ --language-code en ``` Resultado: ``` { "JobId": "dg7289877365fc70299089371c043b96" } ``` Para obter mais informações, consulte [Vinculação de ontologias a análises em lotes](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. + Para ver detalhes da API, consulte [StartSnomedctInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/start-snomedct-inference-job.html) na *Referência de comandos da AWS CLI*. ### `stop-entities-detection-v2-job` O código de exemplo a seguir mostra como usar `stop-entities-detection-v2-job`. **AWS CLI** **Como interromper um trabalho de detecção de entidades** O exemplo `stop-entities-detection-v2-job` a seguir interrompe um trabalho assíncrono de detecção de entidades. ``` aws comprehendmedical stop-entities-detection-v2-job \ --job-id "ab9887877365fe70299089371c043b96" ``` Resultado: ``` { "JobId": "ab9887877365fe70299089371c043b96" } ``` Para obter mais informações, consulte [APIs em lote](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-batchapi.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. + Para ver detalhes da API, consulte [StopEntitiesDetectionV2Job](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/stop-entities-detection-v2-job.html) na *Referência de comandos da AWS CLI*. ### `stop-icd10-cm-inference-job` O código de exemplo a seguir mostra como usar `stop-icd10-cm-inference-job`. **AWS CLI** **Como interromper um trabalho de inferência da ICD-10-CM** O exemplo `stop-icd10-cm-inference-job` a seguir interrompe um trabalho de análise em lote de inferência da ICD-10-CM. ``` aws comprehendmedical stop-icd10-cm-inference-job \ --job-id "4750034166536cdb52ffa3295a1b00a3" ``` Resultado: ``` { "JobId": "ef7289877365fc70299089371c043b96", } ``` Para obter mais informações, consulte [Vinculação de ontologias a análises em lotes](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. + Para ver detalhes da API, consulte [StopIcd10CmInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/stop-icd10-cm-inference-job.html) na *Referência de comandos da AWS CLI*. ### `stop-phi-detection-job` O código de exemplo a seguir mostra como usar `stop-phi-detection-job`. **AWS CLI** **Como interromper um trabalho de detecção de informações de saúde protegidas (PHI)** O exemplo `stop-phi-detection-job` a seguir interrompe uma tarefa assíncrona de detecção de informações de saúde protegidas (PHI). ``` aws comprehendmedical stop-phi-detection-job \ --job-id "4750034166536cdb52ffa3295a1b00a3" ``` Resultado: ``` { "JobId": "ab9887877365fe70299089371c043b96" } ``` Para obter mais informações, consulte [APIs em lote](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-batchapi.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. + Para ver detalhes da API, consulte [StopPhiDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/stop-phi-detection-job.html) na *Referência de comandos da AWS CLI*. ### `stop-rx-norm-inference-job` O código de exemplo a seguir mostra como usar `stop-rx-norm-inference-job`. **AWS CLI** **Como interromper um trabalho de inferência do RxNorm** O exemplo `stop-rx-norm-inference-job` a seguir interrompe um trabalho de análise em lote de inferência da ICD-10-CM. ``` aws comprehendmedical stop-rx-norm-inference-job \ --job-id "eg8199877365fc70299089371c043b96" ``` Resultado: ``` { "JobId": "eg8199877365fc70299089371c043b96", } ``` Para obter mais informações, consulte [Vinculação de ontologias a análises em lotes](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. + Para ver detalhes da API, consulte [StopRxNormInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/stop-rx-norm-inference-job.html) na *Referência de comandos da AWS CLI*. ### `stop-snomedct-inference-job` O código de exemplo a seguir mostra como usar `stop-snomedct-inference-job`. **AWS CLI** **Como interromper um trabalho de inferência da SNOMED CT** O exemplo `stop-snomedct-inference-job` a seguir interrompe um trabalho de análise em lote de inferência da SNOMED CT. ``` aws comprehendmedical stop-snomedct-inference-job \ --job-id "8750034166436cdb52ffa3295a1b00a1" ``` Resultado: ``` { "JobId": "8750034166436cdb52ffa3295a1b00a1", } ``` Para obter mais informações, consulte [Vinculação de ontologias a análises em lotes](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html) no *Guia do desenvolvedor do Amazon Comprehend Medical*. + Para ver detalhes da API, consulte [StopSnomedctInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/stop-snomedct-inference-job.html) na *Referência de comandos da AWS CLI*. # AWS Config Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o 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 ### `delete-config-rule` O código de exemplo a seguir mostra como usar `delete-config-rule`. **AWS CLI** **Para excluir uma regra do AWS Config** O seguinte comando exclui uma regra do AWS Config chamada `MyConfigRule`: ``` aws configservice delete-config-rule --config-rule-name MyConfigRule ``` + Consulte detalhes da API em [DeleteConfigRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/delete-config-rule.html) na *Referência de comandos da AWS CLI*. ### `delete-delivery-channel` O código de exemplo a seguir mostra como usar `delete-delivery-channel`. **AWS CLI** **Para excluir um canal de entrega** O comando a seguir exclui o canal de entrega padrão: ``` aws configservice delete-delivery-channel --delivery-channel-name default ``` + Para ver detalhes da API, consulte [DeleteDeliveryChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/delete-delivery-channel.html) na *Referência de comandos da AWS CLI*. ### `delete-evaluation-results` O código de exemplo a seguir mostra como usar `delete-evaluation-results`. **AWS CLI** **Para excluir manualmente os resultados da avaliação** O seguinte comando exclui os resultados da avaliação atual da regra gerenciada pela AWS s3-bucket-versioning-enabled: ``` aws configservice delete-evaluation-results --config-rule-name s3-bucket-versioning-enabled ``` + Para ver detalhes da API, consulte [DeleteEvaluationResults](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/delete-evaluation-results.html) na *Referência de comandos da AWS CLI*. ### `deliver-config-snapshot` O código de exemplo a seguir mostra como usar `deliver-config-snapshot`. **AWS CLI** **Para entregar um snapshot de configuração** O seguinte comando entrega um snapshot de configuração para o bucket do Amazon S3 que pertence ao canal de entrega padrão: ``` aws configservice deliver-config-snapshot --delivery-channel-name default ``` Resultado: ``` { "configSnapshotId": "d0333b00-a683-44af-921e-examplefb794" } ``` + Para ver detalhes da API, consulte [DeliverConfigSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/deliver-config-snapshot.html) na *Referência de comandos da AWS CLI*. ### `describe-compliance-by-config-rule` O código de exemplo a seguir mostra como usar `describe-compliance-by-config-rule`. **AWS CLI** **Para obter informações de conformidade para suas regras do AWS Config** O comando a seguir retorna informações de conformidade para cada regra do AWS Config violada por um ou mais recursos: AWS ``` aws configservice describe-compliance-by-config-rule --compliance-types NON_COMPLIANT ``` Na saída, o valor de cada atributo `CappedCount` indica quantos recursos não estão em conformidade com a regra relacionada. Por exemplo, a saída a seguir indica que três recursos não estão em conformidade com a regra chamada `InstanceTypesAreT2micro`. Resultado: ``` { "ComplianceByConfigRules": [ { "Compliance": { "ComplianceContributorCount": { "CappedCount": 3, "CapExceeded": false }, "ComplianceType": "NON_COMPLIANT" }, "ConfigRuleName": "InstanceTypesAreT2micro" }, { "Compliance": { "ComplianceContributorCount": { "CappedCount": 10, "CapExceeded": false }, "ComplianceType": "NON_COMPLIANT" }, "ConfigRuleName": "RequiredTagsForVolumes" } ] } ``` + Para ver detalhes da API, consulte [DescribeComplianceByConfigRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-compliance-by-config-rule.html) na *Referência de comandos da AWS CLI*. ### `describe-compliance-by-resource` O código de exemplo a seguir mostra como usar `describe-compliance-by-resource`. **AWS CLI** **Para obter informações de conformidade para seus recursos da AWS** O comando a seguir retorna informações de conformidade para cada instância do EC2 gravada pelo AWS Config e que viole uma ou mais regras: ``` aws configservice describe-compliance-by-resource --resource-type AWS::EC2::Instance --compliance-types NON_COMPLIANT ``` Na saída, o valor de cada atributo `CappedCount` indica quantas regras o recurso viola. Por exemplo, a saída a seguir indica que a instância `i-1a2b3c4d` viola duas regras. Resultado: ``` { "ComplianceByResources": [ { "ResourceType": "AWS::EC2::Instance", "ResourceId": "i-1a2b3c4d", "Compliance": { "ComplianceContributorCount": { "CappedCount": 2, "CapExceeded": false }, "ComplianceType": "NON_COMPLIANT" } }, { "ResourceType": "AWS::EC2::Instance", "ResourceId": "i-2a2b3c4d ", "Compliance": { "ComplianceContributorCount": { "CappedCount": 3, "CapExceeded": false }, "ComplianceType": "NON_COMPLIANT" } } ] } ``` + Para ver detalhes da API, consulte [DescribeComplianceByResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-compliance-by-resource.html) na *Referência de comandos da AWS CLI*. ### `describe-config-rule-evaluation-status` O código de exemplo a seguir mostra como usar `describe-config-rule-evaluation-status`. **AWS CLI** **Para obter informações de status de uma regra do AWS Config** O seguinte comando retorna as informações de status para uma regra do AWS Config chamada `MyConfigRule`: ``` aws configservice describe-config-rule-evaluation-status --config-rule-names MyConfigRule ``` Resultado: ``` { "ConfigRulesEvaluationStatus": [ { "ConfigRuleArn": "arn:aws:config:us-east-1:123456789012:config-rule/config-rule-abcdef", "FirstActivatedTime": 1450311703.844, "ConfigRuleId": "config-rule-abcdef", "LastSuccessfulInvocationTime": 1450314643.156, "ConfigRuleName": "MyConfigRule" } ] } ``` + Para ver detalhes da API, consulte [DescribeConfigRuleEvaluationStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-config-rule-evaluation-status.html) na *Referência de comandos da AWS CLI*. ### `describe-config-rules` O código de exemplo a seguir mostra como usar `describe-config-rules`. **AWS CLI** **Como obter detalhes de uma regra do AWS Config** O seguinte comando retorna detalhes de uma regra do AWS Config chamada `InstanceTypesAreT2micro`: ``` aws configservice describe-config-rules --config-rule-names InstanceTypesAreT2micro ``` Resultado: ``` { "ConfigRules": [ { "ConfigRuleState": "ACTIVE", "Description": "Evaluates whether EC2 instances are the t2.micro type.", "ConfigRuleName": "InstanceTypesAreT2micro", "ConfigRuleArn": "arn:aws:config:us-east-1:123456789012:config-rule/config-rule-abcdef", "Source": { "Owner": "CUSTOM_LAMBDA", "SourceIdentifier": "arn:aws:lambda:us-east-1:123456789012:function:InstanceTypeCheck", "SourceDetails": [ { "EventSource": "aws.config", "MessageType": "ConfigurationItemChangeNotification" } ] }, "InputParameters": "{\"desiredInstanceType\":\"t2.micro\"}", "Scope": { "ComplianceResourceTypes": [ "AWS::EC2::Instance" ] }, "ConfigRuleId": "config-rule-abcdef" } ] } ``` + Consulte detalhes da API em [DescribeConfigRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-config-rules.html) na *Referência de comandos da AWS CLI*. ### `describe-configuration-recorder-status` O código de exemplo a seguir mostra como usar `describe-configuration-recorder-status`. **AWS CLI** **Para obter informações de status do gravador de configuração** O seguinte comando retorna o status do gravador de configuração padrão: ``` aws configservice describe-configuration-recorder-status ``` Resultado: ``` { "ConfigurationRecordersStatus": [ { "name": "default", "lastStatus": "SUCCESS", "recording": true, "lastStatusChangeTime": 1452193834.344, "lastStartTime": 1441039997.819, "lastStopTime": 1441039992.835 } ] } ``` + Para ver detalhes da API, consulte [DescribeConfigurationRecorderStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-configuration-recorder-status.html) na *Referência de comandos da AWS CLI*. ### `describe-configuration-recorders` O código de exemplo a seguir mostra como usar `describe-configuration-recorders`. **AWS CLI** **Para obter detalhes sobre o gravador de configuração** O seguinte comando retorna detalhes sobre o gravador de configuração padrão: ``` aws configservice describe-configuration-recorders ``` Resultado: ``` { "ConfigurationRecorders": [ { "recordingGroup": { "allSupported": true, "resourceTypes": [], "includeGlobalResourceTypes": true }, "roleARN": "arn:aws:iam::123456789012:role/config-ConfigRole-A1B2C3D4E5F6", "name": "default" } ] } ``` + Para ver detalhes da API, consulte [DescribeConfigurationRecorders](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-configuration-recorders.html) na *Referência de comandos da AWS CLI*. ### `describe-delivery-channel-status` O código de exemplo a seguir mostra como usar `describe-delivery-channel-status`. **AWS CLI** **Para obter informações de status do canal de entrega** O seguinte comando retornará o status do canal de entrega: ``` aws configservice describe-delivery-channel-status ``` Resultado: ``` { "DeliveryChannelsStatus": [ { "configStreamDeliveryInfo": { "lastStatusChangeTime": 1452193834.381, "lastStatus": "SUCCESS" }, "configHistoryDeliveryInfo": { "lastSuccessfulTime": 1450317838.412, "lastStatus": "SUCCESS", "lastAttemptTime": 1450317838.412 }, "configSnapshotDeliveryInfo": { "lastSuccessfulTime": 1452185597.094, "lastStatus": "SUCCESS", "lastAttemptTime": 1452185597.094 }, "name": "default" } ] } ``` + Para ver detalhes da API, consulte [DescribeDeliveryChannelStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-delivery-channel-status.html) na *Referência de comandos da AWS CLI*. ### `describe-delivery-channels` O código de exemplo a seguir mostra como usar `describe-delivery-channels`. **AWS CLI** **Para obter detalhes sobre o canal de entrega** O seguinte comando retorna detalhes sobre o canal de entrega: ``` aws configservice describe-delivery-channels ``` Resultado: ``` { "DeliveryChannels": [ { "snsTopicARN": "arn:aws:sns:us-east-1:123456789012:config-topic", "name": "default", "s3BucketName": "config-bucket-123456789012" } ] } ``` + Para ver detalhes da API, consulte [DescribeDeliveryChannels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-delivery-channels.html) na *Referência de comandos da AWS CLI*. ### `get-compliance-details-by-config-rule` O código de exemplo a seguir mostra como usar `get-compliance-details-by-config-rule`. **AWS CLI** **Para obter os resultados da avaliação de uma regra do AWS Config** O seguinte comando retorna os resultados da avaliação de todos os recursos que não estão em conformidade com uma regra do AWS Config chamada `InstanceTypesAreT2micro`: ``` aws configservice get-compliance-details-by-config-rule --config-rule-name InstanceTypesAreT2micro --compliance-types NON_COMPLIANT ``` Resultado: ``` { "EvaluationResults": [ { "EvaluationResultIdentifier": { "OrderingTimestamp": 1450314635.065, "EvaluationResultQualifier": { "ResourceType": "AWS::EC2::Instance", "ResourceId": "i-1a2b3c4d", "ConfigRuleName": "InstanceTypesAreT2micro" } }, "ResultRecordedTime": 1450314645.261, "ConfigRuleInvokedTime": 1450314642.948, "ComplianceType": "NON_COMPLIANT" }, { "EvaluationResultIdentifier": { "OrderingTimestamp": 1450314635.065, "EvaluationResultQualifier": { "ResourceType": "AWS::EC2::Instance", "ResourceId": "i-2a2b3c4d", "ConfigRuleName": "InstanceTypesAreT2micro" } }, "ResultRecordedTime": 1450314645.18, "ConfigRuleInvokedTime": 1450314642.902, "ComplianceType": "NON_COMPLIANT" }, { "EvaluationResultIdentifier": { "OrderingTimestamp": 1450314635.065, "EvaluationResultQualifier": { "ResourceType": "AWS::EC2::Instance", "ResourceId": "i-3a2b3c4d", "ConfigRuleName": "InstanceTypesAreT2micro" } }, "ResultRecordedTime": 1450314643.346, "ConfigRuleInvokedTime": 1450314643.124, "ComplianceType": "NON_COMPLIANT" } ] } ``` + Para ver detalhes da API, consulte [GetComplianceDetailsByConfigRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-compliance-details-by-config-rule.html) na *Referência de comandos da AWS CLI*. ### `get-compliance-details-by-resource` O código de exemplo a seguir mostra como usar `get-compliance-details-by-resource`. **AWS CLI** **Para obter os resultados da avaliação de um recurso da AWS** O comando a seguir retorna os resultados da avaliação de cada regra com a qual a instância do EC2 `i-1a2b3c4d` não está em conformidade: ``` aws configservice get-compliance-details-by-resource --resource-type AWS::EC2::Instance --resource-id i-1a2b3c4d --compliance-types NON_COMPLIANT ``` Resultado: ``` { "EvaluationResults": [ { "EvaluationResultIdentifier": { "OrderingTimestamp": 1450314635.065, "EvaluationResultQualifier": { "ResourceType": "AWS::EC2::Instance", "ResourceId": "i-1a2b3c4d", "ConfigRuleName": "InstanceTypesAreT2micro" } }, "ResultRecordedTime": 1450314643.288, "ConfigRuleInvokedTime": 1450314643.034, "ComplianceType": "NON_COMPLIANT" }, { "EvaluationResultIdentifier": { "OrderingTimestamp": 1450314635.065, "EvaluationResultQualifier": { "ResourceType": "AWS::EC2::Instance", "ResourceId": "i-1a2b3c4d", "ConfigRuleName": "RequiredTagForEC2Instances" } }, "ResultRecordedTime": 1450314645.261, "ConfigRuleInvokedTime": 1450314642.948, "ComplianceType": "NON_COMPLIANT" } ] } ``` + Para ver detalhes da API, consulte [GetComplianceDetailsByResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-compliance-details-by-resource.html) na *Referência de comandos da AWS CLI*. ### `get-compliance-summary-by-config-rule` O código de exemplo a seguir mostra como usar `get-compliance-summary-by-config-rule`. **AWS CLI** **Para obter o resumo de conformidade de suas regras do AWS Config** O seguinte comando retorna o número de regras que estão em conformidade e o número das que não estão: ``` aws configservice get-compliance-summary-by-config-rule ``` Na saída, o valor de cada atributo `CappedCount` indica quantas regras estão em conformidade ou não. Resultado: ``` { "ComplianceSummary": { "NonCompliantResourceCount": { "CappedCount": 3, "CapExceeded": false }, "ComplianceSummaryTimestamp": 1452204131.493, "CompliantResourceCount": { "CappedCount": 2, "CapExceeded": false } } } ``` + Para ver detalhes da API, consulte [GetComplianceSummaryByConfigRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-compliance-summary-by-config-rule.html) na *Referência de comandos da AWS CLI*. ### `get-compliance-summary-by-resource-type` O código de exemplo a seguir mostra como usar `get-compliance-summary-by-resource-type`. **AWS CLI** **Para obter o resumo de conformidade para todos os tipos de recursos** O seguinte comando retorna o número de recursos da AWS que não estão em conformidade e o número dos que estão: ``` aws configservice get-compliance-summary-by-resource-type ``` Na saída, o valor de cada atributo `CappedCount` indica quantos recursos estão em conformidade ou não. Resultado: ``` { "ComplianceSummariesByResourceType": [ { "ComplianceSummary": { "NonCompliantResourceCount": { "CappedCount": 16, "CapExceeded": false }, "ComplianceSummaryTimestamp": 1453237464.543, "CompliantResourceCount": { "CappedCount": 10, "CapExceeded": false } } } ] } ``` **Para obter o resumo de conformidade para um tipo específico de recurso** O seguinte comando retorna o número de instâncias do EC2 que não estão em conformidade e o número das que estão: ``` aws configservice get-compliance-summary-by-resource-type --resource-types AWS::EC2::Instance ``` Na saída, o valor de cada atributo `CappedCount` indica quantos recursos estão em conformidade ou não. Resultado: ``` { "ComplianceSummariesByResourceType": [ { "ResourceType": "AWS::EC2::Instance", "ComplianceSummary": { "NonCompliantResourceCount": { "CappedCount": 3, "CapExceeded": false }, "ComplianceSummaryTimestamp": 1452204923.518, "CompliantResourceCount": { "CappedCount": 7, "CapExceeded": false } } } ] } ``` + Para ver detalhes da API, consulte [GetComplianceSummaryByResourceType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-compliance-summary-by-resource-type.html) na *Referência de comandos da AWS CLI*. ### `get-resource-config-history` O código de exemplo a seguir mostra como usar `get-resource-config-history`. **AWS CLI** **Para obter o histórico de configuração de um recurso da AWS** O comando a seguir retorna uma lista de itens de configuração para uma instância do EC2 com um ID de `i-1a2b3c4d`: ``` aws configservice get-resource-config-history --resource-type AWS::EC2::Instance --resource-id i-1a2b3c4d ``` + Para ver detalhes da API, consulte [GetResourceConfigHistory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-resource-config-history.html) na *Referência de comandos da AWS CLI*. ### `get-status` O código de exemplo a seguir mostra como usar `get-status`. **AWS CLI** **Para obter o status do AWS Config** O seguinte comando retornará o status do canal de entrega e do gravador de configuração: ``` aws configservice get-status ``` Resultado: ``` Configuration Recorders: name: default recorder: ON last status: SUCCESS Delivery Channels: name: default last stream delivery status: SUCCESS last history delivery status: SUCCESS last snapshot delivery status: SUCCESS ``` + Para ver detalhes da API, consulte [GetStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-status.html) na *Referência de comandos da AWS CLI*. ### `list-discovered-resources` O código de exemplo a seguir mostra como usar `list-discovered-resources`. **AWS CLI** **Para listar os recursos que o AWS Config descobriu** O comando a seguir lista as instâncias do EC2 que o AWS Config descobriu: ``` aws configservice list-discovered-resources --resource-type AWS::EC2::Instance ``` Resultado: ``` { "resourceIdentifiers": [ { "resourceType": "AWS::EC2::Instance", "resourceId": "i-1a2b3c4d" }, { "resourceType": "AWS::EC2::Instance", "resourceId": "i-2a2b3c4d" }, { "resourceType": "AWS::EC2::Instance", "resourceId": "i-3a2b3c4d" } ] } ``` + Para ver detalhes da API, consulte [ListDiscoveredResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/list-discovered-resources.html) na *Referência de comandos da AWS CLI*. ### `put-config-rule` O código de exemplo a seguir mostra como usar `put-config-rule`. **AWS CLI** **Como adicionar uma regra gerenciada do AWS Config** O seguinte comando fornece o código JSON para adicionar uma regra gerenciada do AWS Config: ``` aws configservice put-config-rule --config-rule file://RequiredTagsForEC2Instances.json ``` `RequiredTagsForEC2Instances.json` é um arquivo JSON que contém a configuração da regra: ``` { "ConfigRuleName": "RequiredTagsForEC2Instances", "Description": "Checks whether the CostCenter and Owner tags are applied to EC2 instances.", "Scope": { "ComplianceResourceTypes": [ "AWS::EC2::Instance" ] }, "Source": { "Owner": "AWS", "SourceIdentifier": "REQUIRED_TAGS" }, "InputParameters": "{\"tag1Key\":\"CostCenter\",\"tag2Key\":\"Owner\"}" } ``` Esse código JSON limita o escopo do atributo `ComplianceResourceTypes` aos recursos do tipo `AWS::EC2::Instance`. Desta forma, o AWS Config avaliará somente instâncias do EC2 em relação à regra. Como a regra é uma regra gerenciada, o atributo `Owner` é definido como `AWS` e o atributo `SourceIdentifier` é definido como o identificador da regra, `REQUIRED_TAGS`. Para o atributo `InputParameters`, as chaves de tag exigidas pela regra, `CostCenter` e `Owner` são especificados. Se o comando for bem-sucedido, o AWS Config não retornará nenhuma saída. Para verificar a configuração da regra, execute o comando describe-config-rules e especifique o nome da regra. **Como adicionar uma regra do Config gerenciada pelo cliente** O seguinte comando fornece o código JSON para adicionar uma regra do Config gerenciada pelo cliente: ``` aws configservice put-config-rule --config-rule file://InstanceTypesAreT2micro.json ``` `InstanceTypesAreT2micro.json` é um arquivo JSON que contém a configuração da regra: ``` { "ConfigRuleName": "InstanceTypesAreT2micro", "Description": "Evaluates whether EC2 instances are the t2.micro type.", "Scope": { "ComplianceResourceTypes": [ "AWS::EC2::Instance" ] }, "Source": { "Owner": "CUSTOM_LAMBDA", "SourceIdentifier": "arn:aws:lambda:us-east-1:123456789012:function:InstanceTypeCheck", "SourceDetails": [ { "EventSource": "aws.config", "MessageType": "ConfigurationItemChangeNotification" } ] }, "InputParameters": "{\"desiredInstanceType\":\"t2.micro\"}" } ``` Esse código JSON limita o escopo do atributo `ComplianceResourceTypes` aos recursos do tipo `AWS::EC2::Instance`. Desta forma, o AWS Config avaliará somente instâncias do EC2 em relação à regra. Como essa é uma regra gerenciada pelo cliente, o atributo `Owner` é definido como `CUSTOM_LAMBDA` e o atributo `SourceIdentifier` é definido como o ARN da função do AWS Lambda. O `SourceDetails` objeto é obrigatório. Os parâmetros especificados para o atributo `InputParameters` são passados para a função do AWS Lambda quando o AWS Config o invoca para avaliar os recursos em relação à regra. Se o comando for bem-sucedido, o AWS Config não retornará nenhuma saída. Para verificar a configuração da regra, execute o comando describe-config-rules e especifique o nome da regra. + Consulte detalhes da API em [PutConfigRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/put-config-rule.html) na *Referência de comandos da AWS CLI*. ### `put-configuration-recorder` O código de exemplo a seguir mostra como usar `put-configuration-recorder`. **AWS CLI** **Exemplo 1: registrar todos os recursos com suporte** O comando a seguir cria um gravador de configuração que rastreia as alterações em todos os tipos de recursos compatíveis, incluindo os tipos de recursos globais: ``` aws configservice put-configuration-recorder \ --configuration-recorder name=default,roleARN=arn:aws:iam::123456789012:role/config-role \ --recording-group allSupported=true,includeGlobalResourceTypes=true ``` Se o comando for bem-sucedido, o AWS Config não retornará nenhuma saída. Para verificar as configurações do seu gravador de configuração, execute o comando describe-configuration-recorders. **Exemplo 2: registrar tipos específicos de recursos** O comando a seguir cria um gravador de configuração que rastreia as alterações somente nos tipos de recursos especificados no arquivo JSON para a opção --recording-group: ``` aws configservice put-configuration-recorder \ --configuration-recorder name=default,roleARN=arn:aws:iam::123456789012:role/config-role \ --recording-group file://recordingGroup.json ``` recordingGroup.json é um arquivo JSON que especifica os tipos de recursos que o AWS Config registrará: ``` { "allSupported": false, "includeGlobalResourceTypes": false, "resourceTypes": [ "AWS::EC2::EIP", "AWS::EC2::Instance", "AWS::EC2::NetworkAcl", "AWS::EC2::SecurityGroup", "AWS::CloudTrail::Trail", "AWS::EC2::Volume", "AWS::EC2::VPC", "AWS::IAM::User", "AWS::IAM::Policy" ] } ``` Antes de poder especificar os tipos de recursos para a chave resourceTypes, você deve definir o allSupported e as opções includeGlobalResourceTypes para falso ou omiti-las. Se o comando for bem-sucedido, o AWS Config não retornará nenhuma saída. Para verificar as configurações do seu gravador de configuração, execute o comando describe-configuration-recorders. **Exemplo 3: selecionar todos os recursos com suporte, excluindo tipos específicos de recursos** O comando a seguir cria um gravador de configuração que rastreia as alterações em todos os tipos de recursos compatíveis atuais e futuros, excluindo os tipos de recursos especificados no arquivo JSON para a opção --recording-group: ``` aws configservice put-configuration-recorder \ --configuration-recorder name=default,roleARN=arn:aws:iam::123456789012:role/config-role \ --recording-group file://recordingGroup.json ``` recordingGroup.json é um arquivo JSON que especifica os tipos de recursos que o AWS Config registrará: ``` { "allSupported": false, "exclusionByResourceTypes": { "resourceTypes": [ "AWS::Redshift::ClusterSnapshot", "AWS::RDS::DBClusterSnapshot", "AWS::CloudFront::StreamingDistribution" ] }, "includeGlobalResourceTypes": false, "recordingStrategy": { "useOnly": "EXCLUSION_BY_RESOURCE_TYPES" }, } ``` Antes de especificar os tipos de recursos a serem excluídos da gravação: 1) Você deve definir as opções allSupported e includeGlobalResourceTypes como false ou omiti-las e 2) Definir o campo useOnly de RecordingStrategy como EXCLUSION\$1BY\$1RESOURCE\$1TYPES. Se o comando for bem-sucedido, o AWS Config não retornará nenhuma saída. Para verificar as configurações do seu gravador de configuração, execute o comando describe-configuration-recorders. + Para ver detalhes da API, consulte [PutConfigurationRecorder](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/put-configuration-recorder.html) na *Referência de comandos da AWS CLI*. ### `put-delivery-channel` O código de exemplo a seguir mostra como usar `put-delivery-channel`. **AWS CLI** **Para criar um canal de entrega** O seguinte comando fornece as configurações do canal de entrega como código JSON: ``` aws configservice put-delivery-channel --delivery-channel file://deliveryChannel.json ``` O arquivo `deliveryChannel.json` especifica os atributos do canal de entrega: ``` { "name": "default", "s3BucketName": "config-bucket-123456789012", "snsTopicARN": "arn:aws:sns:us-east-1:123456789012:config-topic", "configSnapshotDeliveryProperties": { "deliveryFrequency": "Twelve_Hours" } } ``` Este exemplo define os seguintes atributos: `name`: o nome do canal de entrega. Por padrão, o AWS Config atribui o nome `default` a um novo canal de entrega. Você não pode atualizar o nome do canal de entrega com o comando `put-delivery-channel`. Para ver as etapas para alterar o nome, consulte Como renomear o canal de entrega.`s3BucketName` - O nome do bucket do Amazon S3 para o qual o AWS Config entrega instantâneos de configuração e arquivos de histórico de configuração. Se você especificar um bucket que pertença a outra conta da AWS, esse bucket deverá ter políticas que concedam permissões de acesso ao AWS Config. Para obter mais informações, consulte Permissões para o bucket do Amazon S3. `snsTopicARN`: o nome do recurso da Amazon (ARN) do tópico do Amazon SNS para o qual o AWS Config envia notificações sobre alterações de configuração. Se você escolher um tópico de outra conta, o tópico deverá ter políticas que concedam permissões de acesso ao AWS Config. Para obter mais informações, consulte o tópico Permissões para o Amazon SNS. `configSnapshotDeliveryProperties`: contém o atributo `deliveryFrequency`, que define com que frequência o AWS Config fornece instantâneos de configuração e com que frequência ele invoca avaliações para regras periódicas do Config. Se o comando for bem-sucedido, o AWS Config não retornará nenhuma saída. Para verificar as configurações do seu canal de entrega, execute o comando describe-delivery-channels. + Para ver detalhes da API, consulte [PutDeliveryChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/put-delivery-channel.html) na *Referência de comandos da AWS CLI*. ### `start-config-rules-evaluation` O código de exemplo a seguir mostra como usar `start-config-rules-evaluation`. **AWS CLI** **Para executar uma avaliação sob demanda das regras do AWS Config** O comando a seguir inicia uma avaliação para duas regras gerenciadas pela AWS: ``` aws configservice start-config-rules-evaluation --config-rule-names s3-bucket-versioning-enabled cloudtrail-enabled ``` + Para ver detalhes da API, consulte [StartConfigRulesEvaluation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/start-config-rules-evaluation.html) na *Referência de comandos da AWS CLI*. ### `start-configuration-recorder` O código de exemplo a seguir mostra como usar `start-configuration-recorder`. **AWS CLI** **Para iniciar o gravador de configuração** O comando a seguir inicia o gravador de configuração padrão: ``` aws configservice start-configuration-recorder --configuration-recorder-name default ``` Se o comando for bem-sucedido, o AWS Config não retornará nenhuma saída. Para verificar se o AWS Config está gravando seus recursos, execute o comando get-status. + Para ver detalhes da API, consulte [StartConfigurationRecorder](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/start-configuration-recorder.html) na *Referência de comandos da AWS CLI*. ### `stop-configuration-recorder` O código de exemplo a seguir mostra como usar `stop-configuration-recorder`. **AWS CLI** **Para interromper o gravador de configuração** O comando a seguir interrompe o gravador de configuração padrão: ``` aws configservice stop-configuration-recorder --configuration-recorder-name default ``` Se o comando for bem-sucedido, o AWS Config não retornará nenhuma saída. Para verificar se o AWS Config não está gravando seus recursos, execute o comando get-status. + Para ver detalhes da API, consulte [StopConfigurationRecorder](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/stop-configuration-recorder.html) na *Referência de comandos da AWS CLI*. ### `subscribe` O código de exemplo a seguir mostra como usar `subscribe`. **AWS CLI** **Para assinar o AWS Config** O comando a seguir cria o canal de entrega e o gravador de configuração padrão. O comando também especifica o bucket do Amazon S3 e o tópico do Amazon SNS para o qual o AWS Config fornecerá as informações de configuração: ``` aws configservice subscribe --s3-bucket config-bucket-123456789012 --sns-topic arn:aws:sns:us-east-1:123456789012:config-topic --iam-role arn:aws:iam::123456789012:role/ConfigRole-A1B2C3D4E5F6 ``` Resultado: ``` Using existing S3 bucket: config-bucket-123456789012 Using existing SNS topic: arn:aws:sns:us-east-1:123456789012:config-topic Subscribe succeeded: Configuration Recorders: [ { "recordingGroup": { "allSupported": true, "resourceTypes": [], "includeGlobalResourceTypes": false }, "roleARN": "arn:aws:iam::123456789012:role/ConfigRole-A1B2C3D4E5F6", "name": "default" } ] Delivery Channels: [ { "snsTopicARN": "arn:aws:sns:us-east-1:123456789012:config-topic", "name": "default", "s3BucketName": "config-bucket-123456789012" } ] ``` + Consulte detalhes da API em [Subscribe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/subscribe.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon Connect usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Amazon Connect. *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 ### `create-user` O código de exemplo a seguir mostra como usar `create-user`. **AWS CLI** **Para criar um usuário** O exemplo `create-user` a seguir adiciona um usuário com os atributos especificados à instância especificada do Amazon Connect. ``` aws connect create-user \ --username Mary \ --password Pass@Word1 \ --identity-info FirstName=Mary,LastName=Major \ --phone-config PhoneType=DESK_PHONE,AutoAccept=true,AfterContactWorkTimeLimit=60,DeskPhoneNumber=+15555551212 \ --security-profile-id 12345678-1111-2222-aaaa-a1b2c3d4f5g7 \ --routing-profile-id 87654321-9999-3434-abcd-x1y2z3a1b2c3 \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "UserId": "87654321-2222-1234-1234-111234567891", "UserArn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent/87654321-2222-1234-1234-111234567891" } ``` Para obter mais informações, consulte [Adicionar usuários](https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html) no *Guia do administrador do Amazon Connect*. + Consulte detalhes da API em [CreateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/create-user.html) na *Referência de comandos da AWS CLI*. ### `delete-user` O código de exemplo a seguir mostra como usar `delete-user`. **AWS CLI** **Para excluir um usuário** O exemplo `delete-user` a seguir exclui o usuário especificado da instância especificada do Amazon Connect. ``` aws connect delete-user \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --user-id 87654321-2222-1234-1234-111234567891 ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar usuários](https://docs.aws.amazon.com/connect/latest/adminguide/manage-users.html) no *Guia do administrador do Amazon Connect*. + Consulte detalhes da API em [DeleteUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/delete-user.html) na *Referência de comandos da AWS CLI*. ### `describe-user-hierarchy-group` O código de exemplo a seguir mostra como usar `describe-user-hierarchy-group`. **AWS CLI** **Para exibir os detalhes de um grupo de hierarquias** O exemplo `describe-user-hierarchy-group` a seguir exibe os detalhes do grupo de hierarquias especificado do Amazon Connect. ``` aws connect describe-user-hierarchy-group \ --hierarchy-group-id 12345678-1111-2222-800e-aaabbb555gg \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "HierarchyGroup": { "Id": "12345678-1111-2222-800e-a2b3c4d5f6g7", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group/12345678-1111-2222-800e-a2b3c4d5f6g7", "Name": "Example Corporation", "LevelId": "1", "HierarchyPath": { "LevelOne": { "Id": "abcdefgh-3333-4444-8af3-201123456789", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group/abcdefgh-3333-4444-8af3-201123456789", "Name": "Example Corporation" } } } } ``` Para obter mais informações, consulte [Configurar hierarquias dos agentes](https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html) no *Guia do administrador do Amazon Connect*. + Para ver detalhes da API, consulte [DescribeUserHierarchyGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/describe-user-hierarchy-group.html) na *Referência de comandos da AWS CLI*. ### `describe-user-hierarchy-structure` O código de exemplo a seguir mostra como usar `describe-user-hierarchy-structure`. **AWS CLI** **Para exibir os detalhes de uma estrutura de hierarquias** O exemplo `describe-user-hierarchy-structure` a seguir exibe os detalhes da estrutura de hierarquias da instância especificada do Amazon Connect. ``` aws connect describe-user-hierarchy-group \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "HierarchyStructure": { "LevelOne": { "Id": "12345678-1111-2222-800e-aaabbb555gg", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group-level/1", "Name": "Corporation" }, "LevelTwo": { "Id": "87654321-2222-3333-ac99-123456789102", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group-level/2", "Name": "Services Division" }, "LevelThree": { "Id": "abcdefgh-3333-4444-8af3-201123456789", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group-level/3", "Name": "EU Site" } } } ``` Para obter mais informações, consulte [Configurar hierarquias dos agentes](https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html) no *Guia do administrador do Amazon Connect*. + Para ver detalhes da API, consulte [DescribeUserHierarchyStructure](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/describe-user-hierarchy-structure.html) na *Referência de comandos da AWS CLI*. ### `describe-user` O código de exemplo a seguir mostra como usar `describe-user`. **AWS CLI** **Para exibir os detalhes de um usuário** O exemplo `describe-user` a seguir exibe os detalhes do usuário especificado do Amazon Connect. ``` aws connect describe-user \ --user-id 0c245dc0-0cf5-4e37-800e-2a7481cc8a60 --instance-id 40c83b68-ea62-414c-97bb-d018e39e158e ``` Resultado: ``` { "User": { "Id": "0c245dc0-0cf5-4e37-800e-2a7481cc8a60", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/0c245dc0-0cf5-4e37-800e-2a7481cc8a60", "Username": "Jane", "IdentityInfo": { "FirstName": "Jane", "LastName": "Doe", "Email": "example.com" }, "PhoneConfig": { "PhoneType": "SOFT_PHONE", "AutoAccept": false, "AfterContactWorkTimeLimit": 0, "DeskPhoneNumber": "" }, "DirectoryUserId": "8b444cf6-b368-4f29-ba18-07af27405658", "SecurityProfileIds": [ "b6f85a42-1dc5-443b-b621-de0abf70c9cf" ], "RoutingProfileId": "0be36ee9-2b5f-4ef4-bcf7-87738e5be0e5", "Tags": {} } } ``` Para obter mais informações, consulte [Gerenciar usuários](https://docs.aws.amazon.com/connect/latest/adminguide/manage-users.html) no *Guia do administrador do Amazon Connect*. + Para ver detalhes da API, consulte [DescribeUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/describe-user.html) na *Referência de comandos da AWS CLI*. ### `get-contact-attributes` O código de exemplo a seguir mostra como usar `get-contact-attributes`. **AWS CLI** **Para recuperar os atributos de um contato** O exemplo `get-contact-attributes` a seguir recupera os atributos que foram definidos para o contato especificado do Amazon Connect. ``` aws connect get-contact-attributes \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --initial-contact-id 12345678-1111-2222-800e-a2b3c4d5f6g7 ``` Resultado: ``` { "Attributes": { "greetingPlayed": "true" } } ``` Para obter mais informações, consulte [Usar atributos de contato do Amazon Connect](https://docs.aws.amazon.com/connect/latest/adminguide/connect-contact-attributes.html) no *Guia do administrador do Amazon Connect*. + Para ver detalhes da API, consulte [GetContactAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/get-contact-attributes.html) na *Referência de comandos da AWS CLI*. ### `list-contact-flows` O código de exemplo a seguir mostra como usar `list-contact-flows`. **AWS CLI** **Para listar os fluxos de contato em uma instância** O exemplo `list-contact-flows` a seguir lista os fluxos de contato na instância especificada do Amazon Connect. ``` aws connect list-contact-flows \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "ContactFlowSummaryList": [ { "Id": "12345678-1111-2222-800e-a2b3c4d5f6g7", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/contact-flow/12345678-1111-2222-800e-a2b3c4d5f6g7", "Name": "Default queue transfer", "ContactFlowType": "QUEUE_TRANSFER" }, { "Id": "87654321-2222-3333-ac99-123456789102", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/contact-flow/87654321-2222-3333-ac99-123456789102", "Name": "Default agent hold", "ContactFlowType": "AGENT_HOLD" }, { "Id": "abcdefgh-3333-4444-8af3-201123456789", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/contact-flow/abcdefgh-3333-4444-8af3-201123456789", "Name": "Default customer hold", "ContactFlowType": "CUSTOMER_HOLD" }, ] } ``` Para obter mais informações, consulte [Criar fluxos de contato do Amazon Connect](https://docs.aws.amazon.com/connect/latest/adminguide/connect-contact-flows.html) no *Guia do administrador do Amazon Connect*. + Para ver detalhes da API, consulte [ListContactFlows](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/list-contact-flows.html) na *Referência de comandos da AWS CLI*. ### `list-hours-of-operations` O código de exemplo a seguir mostra como usar `list-hours-of-operations`. **AWS CLI** **Para listar as horas de operação em uma instância** O exemplo `list-hours-of-operations` a seguir lista as horas de operação da instância especificada do Amazon Connect. ``` aws connect list-hours-of-operations \ --instance-id 40c83b68-ea62-414c-97bb-d018e39e158e ``` Resultado: ``` { "HoursOfOperationSummaryList": [ { "Id": "d69f1f84-7457-4924-8fbe-e64875546259", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/operating-hours/d69f1f84-7457-4924-8fbe-e64875546259", "Name": "Basic Hours" } ] } ``` Para obter mais informações, consulte [Definir as horas de operação de uma fila](https://docs.aws.amazon.com/connect/latest/adminguide/set-hours-operation.html) no *Guia do administrador do Amazon Connect*. + Para ver detalhes da API, consulte [ListHoursOfOperations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/list-hours-of-operations.html) na *Referência de comandos da AWS CLI*. ### `list-phone-numbers` O código de exemplo a seguir mostra como usar `list-phone-numbers`. **AWS CLI** **Para listar os números de telefone em uma instância** O exemplo `list-phone-numbers` a seguir lista os números de telefone na instância especificada do Amazon Connect. ``` aws connect list-phone-numbers \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "PhoneNumberSummaryList": [ { "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/phone-number/xyz80zxy-xyz1-80zx-zx80-11111EXAMPLE", "PhoneNumber": "+17065551212", "PhoneNumberType": "DID", "PhoneNumberCountryCode": "US" }, { "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/phone-number/ccc0ccc-xyz1-80zx-zx80-22222EXAMPLE", "PhoneNumber": "+18555551212", "PhoneNumberType": "TOLL_FREE", "PhoneNumberCountryCode": "US" } ] } ``` Para obter mais informações, consulte [Configurar números de telefone para a central de atendimento](https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html) no *Guia do administrador do Amazon Connect*. + Para ver detalhes da API, consulte [ListPhoneNumbers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/list-phone-numbers.html) na *Referência de comandos da AWS CLI*. ### `list-queues` O código de exemplo a seguir mostra como usar `list-queues`. **AWS CLI** **Para listar as filas em uma instância** O exemplo `list-queues` a seguir lista as filas na instância especificada do Amazon Connect. ``` aws connect list-queues \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "QueueSummaryList": [ { "Id": "12345678-1111-2222-800e-a2b3c4d5f6g7", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/queue/agent/12345678-1111-2222-800e-a2b3c4d5f6g7", "QueueType": "AGENT" }, { "Id": "87654321-2222-3333-ac99-123456789102", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/queue/agent/87654321-2222-3333-ac99-123456789102", "QueueType": "AGENT" }, { "Id": "abcdefgh-3333-4444-8af3-201123456789", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/queue/agent/abcdefgh-3333-4444-8af3-201123456789", "QueueType": "AGENT" }, { "Id": "hgfedcba-4444-5555-a31f-123456789102", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/queue/hgfedcba-4444-5555-a31f-123456789102", "Name": "BasicQueue", "QueueType": "STANDARD" }, ] } ``` Para obter mais informações, consulte [Criar uma fila](https://docs.aws.amazon.com/connect/latest/adminguide/create-queue.html) no *Guia do administrador do Amazon Connect*. + Consulte detalhes da API em [ListQueues](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/list-queues.html) na *Referência de comandos da AWS CLI*. ### `list-routing-profiles` O código de exemplo a seguir mostra como usar `list-routing-profiles`. **AWS CLI** **Para listar os perfis de roteamento em uma instância** O exemplo `list-routing-profiles` a seguir lista os perfis de roteamento na instância especificada do Amazon Connect. ``` aws connect list-routing-profiles \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "RoutingProfileSummaryList": [ { "Id": "12345678-1111-2222-800e-a2b3c4d5f6g7", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/routing-profile/12345678-1111-2222-800e-a2b3c4d5f6g7", "Name": "Basic Routing Profile" }, ] } ``` Para obter mais informações, consulte [Criar um perfil de roteamento](https://docs.aws.amazon.com/connect/latest/adminguide/routing-profiles.html) no *Guia do administrador do Amazon Connect*. + Para ver detalhes da API, consulte [ListRoutingProfiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/list-routing-profiles.html) na *Referência de comandos da AWS CLI*. ### `list-security-profiles` O código de exemplo a seguir mostra como usar `list-security-profiles`. **AWS CLI** **Para listar os perfis de segurança em uma instância** O exemplo `list-security-profiles` a seguir lista os perfis de segurança na instância especificada do Amazon Connect. ``` aws connect list-security-profiles \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "SecurityProfileSummaryList": [ { "Id": "12345678-1111-2222-800e-a2b3c4d5f6g7", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/security-profile/12345678-1111-2222-800e-a2b3c4d5f6g7", "Name": "CallCenterManager" }, { "Id": "87654321-2222-3333-ac99-123456789102", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/security-profile/87654321-2222-3333-ac99-123456789102", "Name": "QualityAnalyst" }, { "Id": "abcdefgh-3333-4444-8af3-201123456789", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/security-profile/abcdefgh-3333-4444-8af3-201123456789", "Name": "Agent" }, { "Id": "12345678-1111-2222-800e-x2y3c4d5fzzzz", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/security-profile/12345678-1111-2222-800e-x2y3c4d5fzzzz", "Name": "Admin" } ] } ``` Para obter mais informações, consulte [Atribuir permissões: perfis de segurança](https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html) no *Guia do administrador do Amazon Connect*. + Para ver detalhes da API, consulte [ListSecurityProfiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/list-security-profiles.html) na *Referência de comandos da AWS CLI*. ### `list-user-hierarchy-groups` O código de exemplo a seguir mostra como usar `list-user-hierarchy-groups`. **AWS CLI** **Para listar os grupos de hierarquia de usuários em uma instância** O exemplo `list-user-hierarchy-groups` a seguir lista os grupos de hierarquias de usuários na instância especificada do Amazon Connect. ``` aws connect list-user-hierarchy-groups \ --instance-id 40c83b68-ea62-414c-97bb-d018e39e158e ``` Resultado: ``` { "UserHierarchyGroupSummaryList": [ { "Id": "0e2f6d1d-b3ca-494b-8dbc-ba81d9f8182a", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent-group/0e2f6d1d-b3ca-494b-8dbc-ba81d9f8182a", "Name": "Example Corporation" }, ] } ``` Para obter mais informações, consulte [Configurar hierarquias dos agentes](https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html) no *Guia do administrador do Amazon Connect*. + Para ver detalhes da API, consulte [ListUserHierarchyGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/list-user-hierarchy-groups.html) na *Referência de comandos da AWS CLI*. ### `list-users` O código de exemplo a seguir mostra como usar `list-users`. **AWS CLI** **Para listar os grupos de hierarquia de usuários em uma instância** O exemplo `list-users` a seguir lista os usuários na instância especificada do Amazon Connect. ``` aws connect list-users \ --instance-id 40c83b68-ea62-414c-97bb-d018e39e158e ``` Resultado: ``` { "UserSummaryList": [ { "Id": "0c245dc0-0cf5-4e37-800e-2a7481cc8a60", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/0c245dc0-0cf5-4e37-800e-2a7481cc8a60", "Username": "Jane" }, { "Id": "46f0c67c-3fc7-4806-ac99-403798788c14", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/46f0c67c-3fc7-4806-ac99-403798788c14", "Username": "Paulo" }, { "Id": "55a83578-95e1-4710-8af3-2b7afe310e48", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/55a83578-95e1-4710-8af3-2b7afe310e48", "Username": "JohnD" }, { "Id": "703e27b5-c9f0-4f1f-a239-64ccbb160125", "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/703e27b5-c9f0-4f1f-a239-64ccbb160125", "Username": "JohnS" } ] } ``` Para obter mais informações, consulte [Adicionar usuários](https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html) no *Guia do administrador do Amazon Connect*. + Consulte detalhes da API em [ListUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/list-users.html) na *Referência de comandos da AWS CLI*. ### `update-contact-attributes` O código de exemplo a seguir mostra como usar `update-contact-attributes`. **AWS CLI** **Para atualizar o atributo de um contato** O exemplo `update-contact-attributes` a seguir atualiza o atributo `greetingPlayed` do usuário especificado do Amazon Connect. ``` aws connect update-contact-attributes \ --initial-contact-id 11111111-2222-3333-4444-12345678910 \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --attributes greetingPlayed=false ``` Este comando não produz saída. Para obter mais informações, consulte [Usar atributos de contato do Amazon Connect](https://docs.aws.amazon.com/connect/latest/adminguide/connect-contact-attributes.html) no *Guia do administrador do Amazon Connect*. + Para ver detalhes da API, consulte [UpdateContactAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/update-contact-attributes.html) na *Referência de comandos da AWS CLI*. ### `update-user-hierarchy` O código de exemplo a seguir mostra como usar `update-user-hierarchy`. **AWS CLI** **Para atualizar a hierarquia de um usuário** O exemplo `update-user-hierarchy` a seguir atualiza a hierarquia de agentes do usuário especificado do Amazon Connect. ``` aws connect update-user-hierarchy \ --hierarchy-group-id 12345678-a1b2-c3d4-e5f6-123456789abc \ --user-id 87654321-2222-1234-1234-111234567891 \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Este comando não produz saída. Para obter mais informações, consulte [Definir configurações do agente](https://docs.aws.amazon.com/connect/latest/adminguide/configure-agents.html) no *Guia do administrador do Amazon Connect*. + Para ver detalhes da API, consulte [UpdateUserHierarchy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/update-user-hierarchy.html) na *Referência de comandos da AWS CLI*. ### `update-user-identity-info` O código de exemplo a seguir mostra como usar `update-user-identity-info`. **AWS CLI** **Para atualizar as informações de identidade de um usuário** O exemplo `update-user-identity-info` a seguir atualiza as informações de identidade do usuário especificado do Amazon Connect. ``` aws connect update-user-identity-info \ --identity-info FirstName=Mary,LastName=Major,Email=marym@example.com \ --user-id 87654321-2222-1234-1234-111234567891 \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Este comando não produz saída. Para obter mais informações, consulte [Definir configurações do agente](https://docs.aws.amazon.com/connect/latest/adminguide/configure-agents.html) no *Guia do administrador do Amazon Connect*. + Para ver detalhes da API, consulte [UpdateUserIdentityInfo](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/update-user-identity-info.html) na *Referência de comandos da AWS CLI*. ### `update-user-phone-config` O código de exemplo a seguir mostra como usar `update-user-phone-config`. **AWS CLI** **Para atualizar a configuração do telefone de um usuário** O exemplo `update-user-phone-config` a seguir atualiza a configuração do telefone do usuário especificado. ``` aws connect update-user-phone-config \ --phone-config PhoneType=SOFT_PHONE,AutoAccept=false,AfterContactWorkTimeLimit=60,DeskPhoneNumber=+18005551212 \ --user-id 12345678-4444-3333-2222-111122223333 \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Este comando não produz saída. Para obter mais informações, consulte [Definir configurações do agente](https://docs.aws.amazon.com/connect/latest/adminguide/configure-agents.html) no *Guia do administrador do Amazon Connect*. + Para ver detalhes da API, consulte [UpdateUserPhoneConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/update-user-phone-config.html) na *Referência de comandos da AWS CLI*. ### `update-user-routing-profile` O código de exemplo a seguir mostra como usar `update-user-routing-profile`. **AWS CLI** **Para atualizar o perfil de roteamento de um usuário** O exemplo `update-user-routing-profile` a seguir atualiza o perfil de roteamento do usuário especificado do Amazon Connect. ``` aws connect update-user-routing-profile \ --routing-profile-id 12345678-1111-3333-2222-4444EXAMPLE \ --user-id 87654321-2222-1234-1234-111234567891 \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Este comando não produz saída. Para obter mais informações, consulte [Definir configurações do agente](https://docs.aws.amazon.com/connect/latest/adminguide/configure-agents.html) no *Guia do administrador do Amazon Connect*. + Para ver detalhes da API, consulte [UpdateUserRoutingProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/update-user-routing-profile.html) na *Referência de comandos da AWS CLI*. ### `update-user-security-profiles` O código de exemplo a seguir mostra como usar `update-user-security-profiles`. **AWS CLI** **Para atualizar os perfis de segurança de um usuário** O exemplo `update-user-security-profiles` a seguir atualiza o perfil de segurança do usuário especificado do Amazon Connect. ``` aws connect update-user-security-profiles \ --security-profile-ids 12345678-1234-1234-1234-1234567892111 \ --user-id 87654321-2222-1234-1234-111234567891 \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Este comando não produz saída. Para obter mais informações, consulte [Atribuir permissões: perfis de segurança](https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html) no *Guia do administrador do Amazon Connect*. + Para ver detalhes da API, consulte [UpdateUserSecurityProfiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/update-user-security-profiles.html) na *Referência de comandos da AWS CLI*. # AWS Cost and Usage Report Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o AWS Cost and Usage Report. *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 ### `delete-report-definition` O código de exemplo a seguir mostra como usar `delete-report-definition`. **AWS CLI** **Para excluir um relatório custos e uso da AWS** Este exemplo exclui um relatório de custos e uso da AWS. Comando: ``` aws cur --region us-east-1 delete-report-definition --report-name "ExampleReport" ``` + Para ver detalhes da API, consulte [DeleteReportDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cur/delete-report-definition.html) na *Referência de comandos da AWS CLI*. ### `describe-report-definitions` O código de exemplo a seguir mostra como usar `describe-report-definitions`. **AWS CLI** **Para recuperar uma lista de relatórios de custos e uso da AWS** Este exemplo descreve uma lista de relatórios de custos e uso da AWS pertencentes a uma conta. Comando: ``` aws cur --region us-east-1 describe-report-definitions --max-items 5 ``` Resultado: ``` { "ReportDefinitions": [ { "ReportName": "ExampleReport", "Compression": "ZIP", "S3Region": "us-east-1", "Format": "textORcsv", "S3Prefix": "exampleprefix", "S3Bucket": "example-s3-bucket", "TimeUnit": "DAILY", "AdditionalArtifacts": [ "REDSHIFT", "QUICKSIGHT" ], "AdditionalSchemaElements": [ "RESOURCES" ] } ] } ``` + Para ver detalhes da API, consulte [DescribeReportDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cur/describe-report-definitions.html) na *Referência de comandos da AWS CLI*. ### `put-report-definition` O código de exemplo a seguir mostra como usar `put-report-definition`. **AWS CLI** **Para criar relatórios de custos e uso da AWS** O exemplo `put-report-definition` a seguir cria um relatório diário de custos e uso da AWS que você pode carregar no Amazon Redshift ou no Amazon QuickSight. ``` aws cur put-report-definition --report-definition file://report-definition.json ``` Conteúdo de `report-definition.json`: ``` { "ReportName": "ExampleReport", "TimeUnit": "DAILY", "Format": "textORcsv", "Compression": "ZIP", "AdditionalSchemaElements": [ "RESOURCES" ], "S3Bucket": "example-s3-bucket", "S3Prefix": "exampleprefix", "S3Region": "us-east-1", "AdditionalArtifacts": [ "REDSHIFT", "QUICKSIGHT" ] } ``` + Consulte detalhes da API em [PutReportDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cur/put-report-definition.html) na *Referência de comandos da AWS CLI*. # Exemplos do Cost Explorer Service usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Cost Explorer 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 ### `get-cost-and-usage` O código de exemplo a seguir mostra como usar `get-cost-and-usage`. **AWS CLI** **Para recuperar o uso do S3 de uma conta no mês de setembro de 2017** O exemplo `get-cost-and-usage` a seguir recupera o uso do S3 de uma conta no mês de setembro de 2017. ``` aws ce get-cost-and-usage \ --time-period Start=2017-09-01,End=2017-10-01 \ --granularity MONTHLY \ --metrics "BlendedCost" "UnblendedCost" "UsageQuantity" \ --group-by Type=DIMENSION,Key=SERVICE Type=TAG,Key=Environment \ --filter file://filters.json ``` Conteúdo de `filters.json`: ``` { "Dimensions": { "Key": "SERVICE", "Values": [ "Amazon Simple Storage Service" ] } } ``` Resultado: ``` { "GroupDefinitions": [ { "Type": "DIMENSION", "Key": "SERVICE" }, { "Type": "TAG", "Key": "Environment" } ], "ResultsByTime": [ { "Estimated": false, "TimePeriod": { "Start": "2017-09-01", "End": "2017-10-01" }, "Total": {}, "Groups": [ { "Keys": [ "Amazon Simple Storage Service", "Environment$" ], "Metrics": { "BlendedCost": { "Amount": "40.3527508453", "Unit": "USD" }, "UnblendedCost": { "Amount": "40.3543773134", "Unit": "USD" }, "UsageQuantity": { "Amount": "9312771.098461578", "Unit": "N/A" } } }, { "Keys": [ "Amazon Simple Storage Service", "Environment$Dev" ], "Metrics": { "BlendedCost": { "Amount": "0.2682364644", "Unit": "USD" }, "UnblendedCost": { "Amount": "0.2682364644", "Unit": "USD" }, "UsageQuantity": { "Amount": "22403.4395271182", "Unit": "N/A" } } } ] } ] } ``` + Para ver detalhes da API, consulte [GetCostAndUsage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ce/get-cost-and-usage.html) na *Referência de comandos da AWS CLI*. ### `get-dimension-values` O código de exemplo a seguir mostra como usar `get-dimension-values`. **AWS CLI** **Para recuperar as tags da dimensão SERVICE, com um valor de “Elastic”** Este exemplo recupera as tags da dimensão SERVICE, com um valor de “Elastic” de 01 de janeiro de 2017 a 18 de maio de 2017. Comando: ``` aws ce get-dimension-values --search-string Elastic --time-period Start=2017-01-01,End=2017-05-18 --dimension SERVICE ``` Resultado: ``` { "TotalSize": 6, "DimensionValues": [ { "Attributes": {}, "Value": "Amazon ElastiCache" }, { "Attributes": {}, "Value": "EC2 - Other" }, { "Attributes": {}, "Value": "Amazon Elastic Compute Cloud - Compute" }, { "Attributes": {}, "Value": "Amazon Elastic Load Balancing" }, { "Attributes": {}, "Value": "Amazon Elastic MapReduce" }, { "Attributes": {}, "Value": "Amazon Elasticsearch Service" } ], "ReturnSize": 6 } ``` + Para ver detalhes da API, consulte [GetDimensionValues](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ce/get-dimension-values.html) na *Referência de comandos da AWS CLI*. ### `get-reservation-coverage` O código de exemplo a seguir mostra como usar `get-reservation-coverage`. **AWS CLI** **Para recuperar a cobertura da reserva de instâncias t2.nano do EC2 na região us-east-1** Este exemplo recupera a cobertura da reserva de instâncias t2.nano do EC2 na região us-east-1 de julho a setembro de 2017. Comando: ``` aws ce get-reservation-coverage --time-period Start=2017-07-01,End=2017-10-01 --group-by Type=Dimension,Key=REGION --filter file://filters.json ``` filters.json: ``` { "And": [ { "Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "t2.nano" ] }, "Dimensions": { "Key": "REGION", "Values": [ "us-east-1" ] } } ] } ``` Resultado: ``` { "TotalSize": 6, "DimensionValues": [ { "Attributes": {}, "Value": "Amazon ElastiCache" }, { "Attributes": {}, "Value": "EC2 - Other" }, { "Attributes": {}, "Value": "Amazon Elastic Compute Cloud - Compute" }, { "Attributes": {}, "Value": "Amazon Elastic Load Balancing" }, { "Attributes": {}, "Value": "Amazon Elastic MapReduce" }, { "Attributes": {}, "Value": "Amazon Elasticsearch Service" } ], "ReturnSize": 6 } ``` + Para ver detalhes da API, consulte [GetReservationCoverage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ce/get-reservation-coverage.html) na *Referência de comandos da AWS CLI*. ### `get-reservation-purchase-recommendation` O código de exemplo a seguir mostra como usar `get-reservation-purchase-recommendation`. **AWS CLI** **Para recuperar as recomendações de reserva de IRs do EC2 com pagamento adiantado parcial com prazo de três anos** O exemplo `get-reservation-purchase-recommendation` a seguir recupera recomendações de instâncias do EC2 com pagamento adiantado parcial com prazo de três anos, com base nos últimos 60 dias de uso do EC2. ``` aws ce get-reservation-purchase-recommendation \ --service "Amazon Redshift" \ --lookback-period-in-days SIXTY_DAYS \ --term-in-years THREE_YEARS \ --payment-option PARTIAL_UPFRONT ``` Resultado: ``` { "Recommendations": [], "Metadata": { "GenerationTimestamp": "2018-08-08T15:20:57Z", "RecommendationId": "00d59dde-a1ad-473f-8ff2-iexample3330b" } } ``` + Para ver detalhes da API, consulte [GetReservationPurchaseRecommendation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ce/get-reservation-purchase-recommendation.html) na *Referência de comandos da AWS CLI*. ### `get-reservation-utilization` O código de exemplo a seguir mostra como usar `get-reservation-utilization`. **AWS CLI** **Para recuperar a utilização de reserva de sua conta** O exemplo `get-reservation-utilization` a seguir recupera a utilização de IR para todos os tipos de instância t2.nano de 01/03/2018 a 01/08/2018 da conta. ``` aws ce get-reservation-utilization \ --time-period Start=2018-03-01,End=2018-08-01 \ --filter file://filters.json ``` Conteúdo de `filters.json`: ``` { "Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "t2.nano" ] } } ``` Resultado: ``` { "Total": { "TotalAmortizedFee": "0", "UtilizationPercentage": "0", "PurchasedHours": "0", "NetRISavings": "0", "TotalActualHours": "0", "AmortizedRecurringFee": "0", "UnusedHours": "0", "TotalPotentialRISavings": "0", "OnDemandCostOfRIHoursUsed": "0", "AmortizedUpfrontFee": "0" }, "UtilizationsByTime": [] } ``` + Para ver detalhes da API, consulte [GetReservationUtilization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ce/get-reservation-utilization.html) na *Referência de comandos da AWS CLI*. ### `get-tags` O código de exemplo a seguir mostra como usar `get-tags`. **AWS CLI** **Para recuperar chaves e valores para uma tag de alocação de custos** Este exemplo recupera todas as tags de alocação de custos com uma chave de “Projeto” e um valor que contém “secretProject”. Comando: ``` aws ce get-tags --search-string secretProject --time-period Start=2017-01-01,End=2017-05-18 --tag-key Project ``` Resultado: ``` { "ReturnSize": 2, "Tags": [ "secretProject1", "secretProject2" ], "TotalSize": 2 } ``` + Para ver detalhes da API, consulte [GetTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ce/get-tags.html) na *Referência de comandos da AWS CLI*. # Exemplos de Firehose usando AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Firehose. *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 ### `list-delivery-streams` O código de exemplo a seguir mostra como usar `list-delivery-streams`. **AWS CLI** **Listar os fluxos de entrega disponíveis** O exemplo `list-delivery-streams` a seguir lista os fluxos de entrega disponíveis em sua conta da AWS. ``` aws firehose list-delivery-streams ``` Resultado: ``` { "DeliveryStreamNames": [ "my-stream" ], "HasMoreDeliveryStreams": false } ``` Para obter mais informações, consulte [Como criar um fluxo de entrega do Amazon Kinesis Firehose Data](https://docs.aws.amazon.com/firehose/latest/dev/basic-create.html) no *Guia do desenvolvedor do Amazon Kinesis Data Firehose*. + Para ver detalhes da API, consulte [ListDeliveryStreams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/firehose/list-delivery-streams.html) na *Referência de comandos da AWS CLI*. ### `put-record-batch` O código de exemplo a seguir mostra como usar `put-record-batch`. **AWS CLI** **Como gravar vários registros em um fluxo** O exemplo de `put-record-batch` a seguir grava três registro em um fluxo. Os dados são codificados no formato Base64. ``` aws firehose put-record-batch \ --delivery-stream-name my-stream \ --records file://records.json ``` Conteúdo de `myfile.json`: ``` [ {"Data": "Rmlyc3QgdGhpbmc="}, {"Data": "U2Vjb25kIHRoaW5n"}, {"Data": "VGhpcmQgdGhpbmc="} ] ``` Resultado: ``` { "FailedPutCount": 0, "Encrypted": false, "RequestResponses": [ { "RecordId": "9D2OJ6t2EqCTZTXwGzeSv/EVHxRoRCw89xd+o3+sXg8DhYOaWKPSmZy/CGlRVEys1u1xbeKh6VofEYKkoeiDrcjrxhQp9iF7sUW7pujiMEQ5LzlrzCkGosxQn+3boDnURDEaD42V7GiixpOyLJkYZcae1i7HzlCEoy9LJhMr8EjDSi4Om/9Vc2uhwwuAtGE0XKpxJ2WD7ZRWtAnYlKAnvgSPRgg7zOWL" }, { "RecordId": "jFirejqxCLlK5xjH/UNmlMVcjktEN76I7916X9PaZ+PVaOSXDfU1WGOqEZhxq2js7xcZ552eoeDxsuTU1MSq9nZTbVfb6cQTIXnm/GsuF37Uhg67GKmR5z90l6XKJ+/+pDloFv7Hh9a3oUS6wYm3DcNRLTHHAimANp1PhkQvWpvLRfzbuCUkBphR2QVzhP9OiHLbzGwy8/DfH8sqWEUYASNJKS8GXP5s" }, { "RecordId": "oy0amQ40o5Y2YV4vxzufdcMOOw6n3EPr3tpPJGoYVNKH4APPVqNcbUgefo1stEFRg4hTLrf2k6eliHu/9+YJ5R3iiedHkdsfkIqX0XTySSutvgFYTjNY1TSrK0pM2sWxpjqqnk3+2UX1MV5z88xGro3cQm/DTBt3qBlmTj7Xq8SKVbO1S7YvMTpWkMKA86f8JfmT8BMKoMb4XZS/sOkQLe+qh0sYKXWl" } ] } ``` Para obter mais informações, consulte [Sending Data to an Amazon Kinesis Data Firehose Delivery Stream](https://docs.aws.amazon.com/firehose/latest/dev/basic-write.html) no *Guia do desenvolvedor do Amazon Kinesis Data Firehose*. + Consulte detalhes da API em [PutRecordBatch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/firehose/put-record-batch.html) na *Referência de comandos da AWS CLI*. ### `put-record` O código de exemplo a seguir mostra como usar `put-record`. **AWS CLI** **Gravar um registro em um fluxo** O exemplo `put-record` a seguir grava dados em um fluxo. Os dados são codificados no formato Base64. ``` aws firehose put-record \ --delivery-stream-name my-stream \ --record '{"Data":"SGVsbG8gd29ybGQ="}' ``` Resultado: ``` { "RecordId": "RjB5K/nnoGFHqwTsZlNd/TTqvjE8V5dsyXZTQn2JXrdpMTOwssyEb6nfC8fwf1whhwnItt4mvrn+gsqeK5jB7QjuLg283+Ps4Sz/j1Xujv31iDhnPdaLw4BOyM9Amv7PcCuB2079RuM0NhoakbyUymlwY8yt20G8X2420wu1jlFafhci4erAt7QhDEvpwuK8N1uOQ1EuaKZWxQHDzcG6tk1E49IPeD9k", "Encrypted": false } ``` Para obter mais informações, consulte [Sending Data to an Amazon Kinesis Data Firehose Delivery Stream](https://docs.aws.amazon.com/firehose/latest/dev/basic-write.html) no *Guia do desenvolvedor do Amazon Kinesis Data Firehose*. + Consulte detalhes da API em [PutRecord](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/firehose/put-record.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon Data Lifecycle Manager usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o Amazon Data Lifecycle 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 ### `create-default-role` O código de exemplo a seguir mostra como usar `create-default-role`. **AWS CLI** **Para criar o perfil do IAM necessário para o Amazon DLM** O exemplo `dlm create-default-role` a seguir cria a função padrão da AWS DataLifecycleManagerDefaultRole para gerenciar snapshots. ``` aws dlm create-default-role \ --resource-type snapshot ``` Este comando não produz saída. Para obter mais informações, consulte [Perfis de serviço padrão para o Amazon Data Lifecycle Manager](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/service-role.html#default-service-roles) no *Guia do usuário do Amazon Elastic Compute Cloud*. + Para ver detalhes da API, consulte [CreateDefaultRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dlm/create-default-role.html) na *Referência de comandos da AWS CLI*. ### `create-lifecycle-policy` O código de exemplo a seguir mostra como usar `create-lifecycle-policy`. **AWS CLI** **Para criar uma política de ciclo de vida** O exemplo `create-lifecycle-policy` a seguir cria uma política de ciclo de vida que cria um snapshot diário dos volumes no horário especificado. As tags especificadas são adicionadas aos snapshots, e as tags também são copiadas do volume e adicionadas aos snapshots. Se a criação de um novo snapshot exceder a contagem máxima especificada, o snapshot mais antigo será excluído. ``` aws dlm create-lifecycle-policy \ --description "My first policy" \ --state ENABLED \ --execution-role-arn arn:aws:iam::12345678910:role/AWSDataLifecycleManagerDefaultRole \ --policy-details file://policyDetails.json ``` Conteúdo de `policyDetails.json`: ``` { "ResourceTypes": [ "VOLUME" ], "TargetTags": [ { "Key": "costCenter", "Value": "115" } ], "Schedules":[ { "Name": "DailySnapshots", "CopyTags": true, "TagsToAdd": [ { "Key": "type", "Value": "myDailySnapshot" } ], "CreateRule": { "Interval": 24, "IntervalUnit": "HOURS", "Times": [ "03:00" ] }, "RetainRule": { "Count":5 } } ] } ``` Resultado: ``` { "PolicyId": "policy-0123456789abcdef0" } ``` + Para ver detalhes da API, consulte [CreateLifecyclePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dlm/create-lifecycle-policy.html) na *Referência de comandos da AWS CLI*. ### `delete-lifecycle-policy` O código de exemplo a seguir mostra como usar `delete-lifecycle-policy`. **AWS CLI** **Para excluir uma política de ciclo de vida** O exemplo a seguir exclui a política de ciclo de vida especificada: ``` aws dlm delete-lifecycle-policy --policy-id policy-0123456789abcdef0 ``` + Para ver detalhes da API, consulte [DeleteLifecyclePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dlm/delete-lifecycle-policy.html) na *Referência de comandos da AWS CLI*. ### `get-lifecycle-policies` O código de exemplo a seguir mostra como usar `get-lifecycle-policies`. **AWS CLI** **Para obter um resumo de suas políticas de ciclo de vida** O exemplo `get-lifecycle-policies` a seguir lista todas as suas políticas de ciclo de vida. ``` aws dlm get-lifecycle-policies ``` Resultado: ``` { "Policies": [ { "PolicyId": "policy-0123456789abcdef0", "Description": "My first policy", "State": "ENABLED" } ] } ``` + Para ver detalhes da API, consulte [GetLifecyclePolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dlm/get-lifecycle-policies.html) na *Referência de comandos da AWS CLI*. ### `get-lifecycle-policy` O código de exemplo a seguir mostra como usar `get-lifecycle-policy`. **AWS CLI** **Para descrever uma política de ciclo de vida** O exemplo `get-lifecycle-policy` a seguir exibe os detalhes da política de ciclo de vida especificada. ``` aws dlm get-lifecycle-policy \ --policy-id policy-0123456789abcdef0 ``` Resultado: ``` { "Policy": { "PolicyId": "policy-0123456789abcdef0", "Description": "My policy", "State": "ENABLED", "ExecutionRoleArn": "arn:aws:iam::123456789012:role/AWSDataLifecycleManagerDefaultRole", "DateCreated": "2019-08-08T17:45:42Z", "DateModified": "2019-08-08T17:45:42Z", "PolicyDetails": { "PolicyType": "EBS_SNAPSHOT_MANAGEMENT", "ResourceTypes": [ "VOLUME" ], "TargetTags": [ { "Key": "costCenter", "Value": "115" } ], "Schedules": [ { "Name": "DailySnapshots", "CopyTags": true, "TagsToAdd": [ { "Key": "type", "Value": "myDailySnapshot" } ], "CreateRule": { "Interval": 24, "IntervalUnit": "HOURS", "Times": [ "03:00" ] }, "RetainRule": { "Count": 5 } } ] } } } ``` + Para ver detalhes da API, consulte [GetLifecyclePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dlm/get-lifecycle-policy.html) na *Referência de comandos da AWS CLI*. ### `update-lifecycle-policy` O código de exemplo a seguir mostra como usar `update-lifecycle-policy`. **AWS CLI** **Exemplo 1: habilitar uma política de ciclo de vida** O exemplo `update-lifecycle-policy` a seguir habilita a política de ciclo de vida especificada. ``` aws dlm update-lifecycle-policy \ --policy-id policy-0123456789abcdef0 \ --state ENABLED ``` **Exemplo 2: desabilitar uma política de ciclo de vida** O exemplo `update-lifecycle-policy` a seguir desabilita a política de ciclo de vida especificada. ``` aws dlm update-lifecycle-policy \ --policy-id policy-0123456789abcdef0 \ --state DISABLED ``` **Exemplo 3: atualizar os detalhes da política de ciclo de vida** O exemplo `update-lifecycle-policy` a seguir atualiza as tags de destino para a política de ciclo de vida especificada. ``` aws dlm update-lifecycle-policy \ --policy-id policy-0123456789abcdef0 --policy-details file://policyDetails.json ``` Conteúdo de `policyDetails.json`. Outros detalhes não referenciados neste arquivo não são alterados pelo comando. ``` { "TargetTags": [ { "Key": "costCenter", "Value": "120" }, { "Key": "project", "Value": "lima" } ] } ``` + Para ver detalhes da API, consulte [UpdateLifecyclePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dlm/update-lifecycle-policy.html) na *Referência de comandos da AWS CLI*. # AWS Data Pipeline Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o AWS Data Pipeline. *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 ### `activate-pipeline` O código de exemplo a seguir mostra como usar `activate-pipeline`. **AWS CLI** **Para ativar um pipeline** Este exemplo ativa o pipeline especificado: ``` aws datapipeline activate-pipeline --pipeline-id df-00627471SOVYZEXAMPLE ``` Para ativar o pipeline em uma data e hora específicas, use o seguinte comando: ``` aws datapipeline activate-pipeline --pipeline-id df-00627471SOVYZEXAMPLE --start-timestamp 2015-04-07T00:00:00Z ``` + Para ver detalhes da API, consulte [ActivatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/activate-pipeline.html) na *Referência de comandos da AWS CLI*. ### `add-tags` O código de exemplo a seguir mostra como usar `add-tags`. **AWS CLI** **Para adicionar uma tag a um pipeline** Este exemplo adiciona a tag especificada ao pipeline especificado: ``` aws datapipeline add-tags --pipeline-id df-00627471SOVYZEXAMPLE --tags key=environment,value=production key=owner,value=sales ``` Para visualizar as tags, use o comando describe-pipelines. Por exemplo, as tags adicionadas no comando de exemplo aparecem da seguinte forma na saída de describe-pipelines: ``` { ... "tags": [ { "value": "production", "key": "environment" }, { "value": "sales", "key": "owner" } ] ... } ``` + Para ver detalhes da API, consulte [AddTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/add-tags.html) na *Referência de comandos da AWS CLI*. ### `create-pipeline` O código de exemplo a seguir mostra como usar `create-pipeline`. **AWS CLI** **Para criar um pipeline** Este exemplo cria um pipeline: ``` aws datapipeline create-pipeline --name my-pipeline --unique-id my-pipeline-token ``` A seguir está um exemplo de saída: ``` { "pipelineId": "df-00627471SOVYZEXAMPLE" } ``` + Para ver detalhes da API, consulte [CreatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/create-pipeline.html) na *Referência de comandos da AWS CLI*. ### `deactivate-pipeline` O código de exemplo a seguir mostra como usar `deactivate-pipeline`. **AWS CLI** **Para desativar um pipeline** Este exemplo desativa o pipeline especificado: ``` aws datapipeline deactivate-pipeline --pipeline-id df-00627471SOVYZEXAMPLE ``` Para desativar o pipeline somente depois que todas as atividades em execução forem concluídas, use o seguinte comando: ``` aws datapipeline deactivate-pipeline --pipeline-id df-00627471SOVYZEXAMPLE --no-cancel-active ``` + Para ver detalhes da API, consulte [DeactivatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/deactivate-pipeline.html) na *Referência de comandos da AWS CLI*. ### `delete-pipeline` O código de exemplo a seguir mostra como usar `delete-pipeline`. **AWS CLI** **Para excluir um pipeline** Este exemplo exclui o pipeline especificado: ``` aws datapipeline delete-pipeline --pipeline-id df-00627471SOVYZEXAMPLE ``` + Para ver detalhes da API, consulte [DeletePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/delete-pipeline.html) na *Referência de comandos da AWS CLI*. ### `describe-pipelines` O código de exemplo a seguir mostra como usar `describe-pipelines`. **AWS CLI** **Para descrever seus pipelines** Este exemplo descreve o pipeline especificado: ``` aws datapipeline describe-pipelines --pipeline-ids df-00627471SOVYZEXAMPLE ``` A seguir está um exemplo de saída: ``` { "pipelineDescriptionList": [ { "fields": [ { "stringValue": "PENDING", "key": "@pipelineState" }, { "stringValue": "my-pipeline", "key": "name" }, { "stringValue": "2015-04-07T16:05:58", "key": "@creationTime" }, { "stringValue": "df-00627471SOVYZEXAMPLE", "key": "@id" }, { "stringValue": "123456789012", "key": "pipelineCreator" }, { "stringValue": "PIPELINE", "key": "@sphere" }, { "stringValue": "123456789012", "key": "@userId" }, { "stringValue": "123456789012", "key": "@accountId" }, { "stringValue": "my-pipeline-token", "key": "uniqueId" } ], "pipelineId": "df-00627471SOVYZEXAMPLE", "name": "my-pipeline", "tags": [] } ] } ``` + Para ver detalhes da API, consulte [DescribePipelines](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/describe-pipelines.html) na *Referência de comandos da AWS CLI*. ### `get-pipeline-definition` O código de exemplo a seguir mostra como usar `get-pipeline-definition`. **AWS CLI** **Para obter uma definição de pipeline** Este exemplo obtém a definição do pipeline especificado: ``` aws datapipeline get-pipeline-definition --pipeline-id df-00627471SOVYZEXAMPLE ``` A seguir está um exemplo de saída: ``` { "parameters": [ { "type": "AWS::S3::ObjectKey", "id": "myS3OutputLoc", "description": "S3 output folder" }, { "default": "s3://us-east-1.elasticmapreduce.samples/pig-apache-logs/data", "type": "AWS::S3::ObjectKey", "id": "myS3InputLoc", "description": "S3 input folder" }, { "default": "grep -rc \"GET\" ${INPUT1_STAGING_DIR}/* > ${OUTPUT1_STAGING_DIR}/output.txt", "type": "String", "id": "myShellCmd", "description": "Shell command to run" } ], "objects": [ { "type": "Ec2Resource", "terminateAfter": "20 Minutes", "instanceType": "t1.micro", "id": "EC2ResourceObj", "name": "EC2ResourceObj" }, { "name": "Default", "failureAndRerunMode": "CASCADE", "resourceRole": "DataPipelineDefaultResourceRole", "schedule": { "ref": "DefaultSchedule" }, "role": "DataPipelineDefaultRole", "scheduleType": "cron", "id": "Default" }, { "directoryPath": "#{myS3OutputLoc}/#{format(@scheduledStartTime, 'YYYY-MM-dd-HH-mm-ss')}", "type": "S3DataNode", "id": "S3OutputLocation", "name": "S3OutputLocation" }, { "directoryPath": "#{myS3InputLoc}", "type": "S3DataNode", "id": "S3InputLocation", "name": "S3InputLocation" }, { "startAt": "FIRST_ACTIVATION_DATE_TIME", "name": "Every 15 minutes", "period": "15 minutes", "occurrences": "4", "type": "Schedule", "id": "DefaultSchedule" }, { "name": "ShellCommandActivityObj", "command": "#{myShellCmd}", "output": { "ref": "S3OutputLocation" }, "input": { "ref": "S3InputLocation" }, "stage": "true", "type": "ShellCommandActivity", "id": "ShellCommandActivityObj", "runsOn": { "ref": "EC2ResourceObj" } } ], "values": { "myS3OutputLoc": "s3://amzn-s3-demo-bucket/", "myS3InputLoc": "s3://us-east-1.elasticmapreduce.samples/pig-apache-logs/data", "myShellCmd": "grep -rc \"GET\" ${INPUT1_STAGING_DIR}/* > ${OUTPUT1_STAGING_DIR}/output.txt" } } ``` + Para ver detalhes da API, consulte [GetPipelineDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/get-pipeline-definition.html) na *Referência de comandos da AWS CLI*. ### `list-pipelines` O código de exemplo a seguir mostra como usar `list-pipelines`. **AWS CLI** **Para listar seus pipelines** Este exemplo lista seus pipelines: ``` aws datapipeline list-pipelines ``` A seguir está um exemplo de saída: ``` { "pipelineIdList": [ { "id": "df-00627471SOVYZEXAMPLE", "name": "my-pipeline" }, { "id": "df-09028963KNVMREXAMPLE", "name": "ImportDDB" }, { "id": "df-0870198233ZYVEXAMPLE", "name": "CrossRegionDDB" }, { "id": "df-00189603TB4MZEXAMPLE", "name": "CopyRedshift" } ] } ``` + Para ver detalhes da API, consulte [ListPipelines](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/list-pipelines.html) na *Referência de comandos da AWS CLI*. ### `list-runs` O código de exemplo a seguir mostra como usar `list-runs`. **AWS CLI** **Exemplo 1: listar as execuções do seu pipeline** O exemplo `list-runs` a seguir lista as execuções do pipeline especificado. ``` aws datapipeline list-runs --pipeline-id df-00627471SOVYZEXAMPLE ``` Resultado: ``` Name Scheduled Start Status ID Started Ended ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. EC2ResourceObj 2015-04-12T17:33:02 CREATING @EC2ResourceObj_2015-04-12T17:33:02 2015-04-12T17:33:10 2. S3InputLocation 2015-04-12T17:33:02 FINISHED @S3InputLocation_2015-04-12T17:33:02 2015-04-12T17:33:09 2015-04-12T17:33:09 3. S3OutputLocation 2015-04-12T17:33:02 WAITING_ON_DEPENDENCIES @S3OutputLocation_2015-04-12T17:33:02 2015-04-12T17:33:09 4. ShellCommandActivityObj 2015-04-12T17:33:02 WAITING_FOR_RUNNER @ShellCommandActivityObj_2015-04-12T17:33:02 2015-04-12T17:33:09 ``` **Exemplo 2: listar as execuções do pipeline entre as datas especificadas** O exemplo `list-runs` a seguir usa o `--start-interval` para especificar as datas a serem incluídas na saída. ``` aws datapipeline list-runs --pipeline-id df-01434553B58A2SHZUKO5 --start-interval 2017-10-07T00:00:00,2017-10-08T00:00:00 ``` + Para ver detalhes da API, consulte [ListRuns](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/list-runs.html) na *Referência de comandos da AWS CLI*. ### `put-pipeline-definition` O código de exemplo a seguir mostra como usar `put-pipeline-definition`. **AWS CLI** **Para carregar uma definição de pipeline** Este exemplo carrega a definição do pipeline especificado no pipeline especificado: ``` aws datapipeline put-pipeline-definition --pipeline-id df-00627471SOVYZEXAMPLE --pipeline-definition file://my-pipeline-definition.json ``` A seguir está um exemplo de saída: ``` { "validationErrors": [], "errored": false, "validationWarnings": [] } ``` + Consulte detalhes da API em [PutPipelineDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/put-pipeline-definition.html) na *Referência de comandos da AWS CLI*. ### `remove-tags` O código de exemplo a seguir mostra como usar `remove-tags`. **AWS CLI** **Para remover uma tag de um pipeline** Esse exemplo remove a tag especificada do pipeline especificado: ``` aws datapipeline remove-tags --pipeline-id df-00627471SOVYZEXAMPLE --tag-keys environment ``` + Para ver detalhes da API, consulte [RemoveTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/remove-tags.html) na *Referência de comandos da AWS CLI*. # Exemplos do DataSync usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o DataSync. *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 ### `update-location-azure-blob` O código de exemplo a seguir mostra como usar `update-location-azure-blob`. **AWS CLI** **Para atualizar seu local de transferência com um novo agente** O exemplo `update-location-object-storage` a seguir atualiza sua localização do DataSync para o Microsoft Azure Blob Storage com um novo agente. ``` aws datasync update-location-azure-blob \ --location-arn arn:aws:datasync:us-west-2:123456789012:location/loc-abcdef01234567890 \ --agent-arns arn:aws:datasync:us-west-2:123456789012:agent/agent-1234567890abcdef0 \ --sas-configuration '{ \ "Token": "sas-token-for-azure-blob-storage-access" \ }' ``` Este comando não produz saída. Para obter mais informações, consulte [Substituir seu agente](https://docs.aws.amazon.com/datasync/latest/userguide/replacing-agent.html) no *Guia do usuário do AWS DataSync*. + Para ver detalhes da API, consulte [UpdateLocationAzureBlob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datasync/update-location-azure-blob.html) na *Referência de comandos da AWS CLI*. ### `update-location-hdfs` O código de exemplo a seguir mostra como usar `update-location-hdfs`. **AWS CLI** **Para atualizar seu local de transferência com um novo agente** O exemplo `update-location-hdfs` a seguir atualiza sua localização do DataSync HDFS com um novo agente. Você só precisará das opções `--kerberos-keytab` e `--kerberos-krb5-conf` se seu cluster do HDFS usar a autenticação do Kerberos. ``` aws datasync update-location-hdfs \ --location-arn arn:aws:datasync:us-west-2:123456789012:location/loc-abcdef01234567890 \ --agent-arns arn:aws:datasync:us-west-2:123456789012:agent/agent-1234567890abcdef0 \ --kerberos-keytab file://hdfs.keytab --kerberos-krb5-conf file://krb5.conf ``` Conteúdo de `hdfs.keytab`: ``` N/A. The content of this file is encrypted and not human readable. ``` Conteúdo de `krb5.conf`: ``` [libdefaults] default_realm = EXAMPLE.COM dns_lookup_realm = false dns_lookup_kdc = false rdns = true ticket_lifetime = 24h forwardable = true udp_preference_limit = 1000000 default_tkt_enctypes = aes256-cts-hmac-sha1-96 aes128-cts-hmac-sha1-96 des3-cbc-sha1 default_tgs_enctypes = aes256-cts-hmac-sha1-96 aes128-cts-hmac-sha1-96 des3-cbc-sha1 permitted_enctypes = aes256-cts-hmac-sha1-96 aes128-cts-hmac-sha1-96 des3-cbc-sha1 [realms] EXAMPLE.COM = { kdc = kdc1.example.com admin_server = krbadmin.example.com default_domain = example.com } [domain_realm] .example.com = EXAMPLE.COM example.com = EXAMPLE.COM [logging] kdc = FILE:/var/log/krb5kdc.log admin_server = FILE:/var/log/kerberos/kadmin.log default = FILE:/var/log/krb5libs.log ``` Este comando não produz saída. Para obter mais informações, consulte [Substituir seu agente](https://docs.aws.amazon.com/datasync/latest/userguide/replacing-agent.html) no *Guia do usuário do AWS DataSync*. + Para ver detalhes da API, consulte [UpdateLocationHdfs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datasync/update-location-hdfs.html) na *Referência de comandos da AWS CLI*. ### `update-location-nfs` O código de exemplo a seguir mostra como usar `update-location-nfs`. **AWS CLI** **Para atualizar seu local de transferência com um novo agente** O exemplo `update-location-nfs` a seguir atualiza sua localização do DataSync NFS com um novo agente. ``` aws datasync update-location-nfs \ --location-arn arn:aws:datasync:us-west-2:123456789012:location/loc-abcdef01234567890 \ --on-prem-config AgentArns=arn:aws:datasync:us-west-2:123456789012:agent/agent-1234567890abcdef0 ``` Este comando não produz saída. Para obter mais informações, consulte [Substituir seu agente](https://docs.aws.amazon.com/datasync/latest/userguide/replacing-agent.html) no *Guia do usuário do AWS DataSync*. + Para ver detalhes da API, consulte [UpdateLocationNfs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datasync/update-location-nfs.html) na *Referência de comandos da AWS CLI*. ### `update-location-object-storage` O código de exemplo a seguir mostra como usar `update-location-object-storage`. **AWS CLI** **Para atualizar seu local de transferência com um novo agente** O exemplo `update-location-object-storage` a seguir atualiza seu local de armazenamento de objetos DataSync com um novo agente. ``` aws datasync update-location-object-storage \ --location-arn arn:aws:datasync:us-west-2:123456789012:location/loc-abcdef01234567890 \ --agent-arns arn:aws:datasync:us-west-2:123456789012:agent/agent-1234567890abcdef0 \ --secret-key secret-key-for-object-storage ``` Este comando não produz saída. Para obter mais informações, consulte [Substituir seu agente](https://docs.aws.amazon.com/datasync/latest/userguide/replacing-agent.html) no *Guia do usuário do AWS DataSync*. + Para ver detalhes da API, consulte [UpdateLocationObjectStorage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datasync/update-location-object-storage.html) na *Referência de comandos da AWS CLI*. ### `update-location-smb` O código de exemplo a seguir mostra como usar `update-location-smb`. **AWS CLI** **Para atualizar seu local de transferência com um novo agente** O exemplo `update-location-smb` a seguir atualiza sua localização do DataSync SMB com um novo agente. ``` aws datasync update-location-smb \ --location-arn arn:aws:datasync:us-west-2:123456789012:location/loc-abcdef01234567890 \ --agent-arns arn:aws:datasync:us-west-2:123456789012:agent/agent-1234567890abcdef0 \ --password smb-file-server-password ``` Este comando não produz saída. Para obter mais informações, consulte [Substituir seu agente](https://docs.aws.amazon.com/datasync/latest/userguide/replacing-agent.html) no *Guia do usuário do AWS DataSync*. + Para ver detalhes da API, consulte [UpdateLocationSmb](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datasync/update-location-smb.html) na *Referência de comandos da AWS CLI*. # Exemplos do DAX usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o DAX. *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 ### `create-cluster` O código de exemplo a seguir mostra como usar `create-cluster`. **AWS CLI** **Para criar um cluster do DAX** O exemplo `create-cluster` a seguir cria um cluster do DAX com as configurações especificadas. ``` aws dax create-cluster \ --cluster-name daxcluster \ --node-type dax.r4.large \ --replication-factor 3 \ --iam-role-arn roleARN \ --sse-specification Enabled=true ``` Resultado: ``` { "Cluster": { "ClusterName": "daxcluster", "ClusterArn": "arn:aws:dax:us-west-2:123456789012:cache/daxcluster", "TotalNodes": 3, "ActiveNodes": 0, "NodeType": "dax.r4.large", "Status": "creating", "ClusterDiscoveryEndpoint": { "Port": 8111 }, "PreferredMaintenanceWindow": "thu:13:00-thu:14:00", "SubnetGroup": "default", "SecurityGroups": [ { "SecurityGroupIdentifier": "sg-1af6e36e", "Status": "active" } ], "IamRoleArn": "arn:aws:iam::123456789012:role/DAXServiceRoleForDynamoDBAccess", "ParameterGroup": { "ParameterGroupName": "default.dax1.0", "ParameterApplyStatus": "in-sync", "NodeIdsToReboot": [] }, "SSEDescription": { "Status": "ENABLED" } } } ``` Para obter mais informações, consulte [Etapa 3: criar um cluster do DAX](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.create-cluster.cli.create-cluster.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Consulte detalhes da API em [CreateCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/create-cluster.html) na *Referência de comandos da AWS CLI*. ### `create-parameter-group` O código de exemplo a seguir mostra como usar `create-parameter-group`. **AWS CLI** **Para criar um grupo de parâmetros** O exemplo ``create-parameter-group`` a seguir cria um grupo de parâmetros com as configurações especificadas. ``` aws dax create-parameter-group \ --parameter-group-name daxparametergroup \ --description "A new parameter group" ``` Resultado: ``` { "ParameterGroup": { "ParameterGroupName": "daxparametergroup", "Description": "A new parameter group" } } ``` Para obter mais informações, consulte [Gerenciar clusters do DAX](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.cluster-management.custom-settings.ttl) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [CreateParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/create-parameter-group.html) na *Referência de comandos da AWS CLI*. ### `create-subnet-group` O código de exemplo a seguir mostra como usar `create-subnet-group`. **AWS CLI** **Criar um grupo de sub-redes do DAX** O exemplo `create-subnet-group` a seguir cria um grupo de sub-redes com as configurações especificadas. ``` aws dax create-subnet-group \ --subnet-group-name daxSubnetGroup \ --subnet-ids subnet-11111111 subnet-22222222 ``` Resultado: ``` { "SubnetGroup": { "SubnetGroupName": "daxSubnetGroup", "VpcId": "vpc-05a1fa8e00c325226", "Subnets": [ { "SubnetIdentifier": "subnet-11111111", "SubnetAvailabilityZone": "us-west-2b" }, { "SubnetIdentifier": "subnet-22222222", "SubnetAvailabilityZone": "us-west-2c" } ] } } ``` Para obter mais informações, consulte [Etapa 2: criar um grupo de sub-rede](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.create-cluster.cli.create-subnet-group.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [CreateSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/create-subnet-group.html) na *Referência de comandos da AWS CLI*. ### `decrease-replication-factor` O código de exemplo a seguir mostra como usar `decrease-replication-factor`. **AWS CLI** **Para remover um ou mais nós do cluster** O exemplo `decrease-replication-factor` a seguir diminui o número de nós no cluster do DAX especificado para um. ``` aws dax decrease-replication-factor \ --cluster-name daxcluster \ --new-replication-factor 1 ``` Resultado: ``` { "Cluster": { "ClusterName": "daxcluster", "ClusterArn": "arn:aws:dax:us-west-2:123456789012:cache/daxcluster", "TotalNodes": 3, "ActiveNodes": 3, "NodeType": "dax.r4.large", "Status": "modifying", "ClusterDiscoveryEndpoint": { "Address": "daxcluster.ey3o9d.clustercfg.dax.usw2.cache.amazonaws.com", "Port": 8111 }, "Nodes": [ { "NodeId": "daxcluster-a", "Endpoint": { "Address": "daxcluster-a.ey3o9d.0001.dax.usw2.cache.amazonaws.com", "Port": 8111 }, "NodeCreateTime": 1576625059.509, "AvailabilityZone": "us-west-2c", "NodeStatus": "available", "ParameterGroupStatus": "in-sync" }, { "NodeId": "daxcluster-b", "Endpoint": { "Address": "daxcluster-b.ey3o9d.0001.dax.usw2.cache.amazonaws.com", "Port": 8111 }, "NodeCreateTime": 1576625059.509, "AvailabilityZone": "us-west-2a", "NodeStatus": "available", "ParameterGroupStatus": "in-sync" }, { "NodeId": "daxcluster-c", "Endpoint": { "Address": "daxcluster-c.ey3o9d.0001.dax.usw2.cache.amazonaws.com", "Port": 8111 }, "NodeCreateTime": 1576625059.509, "AvailabilityZone": "us-west-2b", "NodeStatus": "available", "ParameterGroupStatus": "in-sync" } ], "PreferredMaintenanceWindow": "thu:13:00-thu:14:00", "SubnetGroup": "default", "SecurityGroups": [ { "SecurityGroupIdentifier": "sg-1af6e36e", "Status": "active" } ], "IamRoleArn": "arn:aws:iam::123456789012:role/DAXServiceRoleForDynamoDBAccess", "ParameterGroup": { "ParameterGroupName": "default.dax1.0", "ParameterApplyStatus": "in-sync", "NodeIdsToReboot": [] }, "SSEDescription": { "Status": "ENABLED" } } } ``` Para obter mais informações, consulte [Gerenciar clusters do DAX](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.cluster-management.custom-settings) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [DecreaseReplicationFactor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/decrease-replication-factor.html) na *Referência de comandos da AWS CLI*. ### `delete-cluster` O código de exemplo a seguir mostra como usar `delete-cluster`. **AWS CLI** **Para excluir um cluster do DAX** O exemplo `delete-cluster` a seguir exclui o cluster do DAX especificado. ``` aws dax delete-cluster \ --cluster-name daxcluster ``` Resultado: ``` { "Cluster": { "ClusterName": "daxcluster", "ClusterArn": "arn:aws:dax:us-west-2:123456789012:cache/daxcluster", "TotalNodes": 3, "ActiveNodes": 0, "NodeType": "dax.r4.large", "Status": "deleting", "ClusterDiscoveryEndpoint": { "Address": "dd.ey3o9d.clustercfg.dax.usw2.cache.amazonaws.com", "Port": 8111 }, "PreferredMaintenanceWindow": "fri:06:00-fri:07:00", "SubnetGroup": "default", "SecurityGroups": [ { "SecurityGroupIdentifier": "sg-1af6e36e", "Status": "active" } ], "IamRoleArn": "arn:aws:iam::123456789012:role/DAXServiceRoleForDynamoDBAccess", "ParameterGroup": { "ParameterGroupName": "default.dax1.0", "ParameterApplyStatus": "in-sync", "NodeIdsToReboot": [] }, "SSEDescription": { "Status": "ENABLED" } } } ``` Para obter mais informações, consulte [Gerenciar clusters do DAX](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.cluster-management.deleting) no *Guia do desenvolvedor do Amazon DynamoDB*. + Consulte detalhes da API em [DeleteCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/delete-cluster.html) na *Referência de comandos da AWS CLI*. ### `delete-parameter-group` O código de exemplo a seguir mostra como usar `delete-parameter-group`. **AWS CLI** **Para excluir um grupo de parâmetros** O exemplo `delete-parameter-group` a seguir exclui o grupo de parâmetros do DAX especificado. ``` aws dax delete-parameter-group \ --parameter-group-name daxparametergroup ``` Resultado: ``` { "DeletionMessage": "Parameter group daxparametergroup has been deleted." } ``` Para obter mais informações, consulte [Gerenciar clusters do DAX](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [DeleteParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/delete-parameter-group.html) na *Referência de comandos da AWS CLI*. ### `delete-subnet-group` O código de exemplo a seguir mostra como usar `delete-subnet-group`. **AWS CLI** **Para excluir um grupo de sub-redes** O exemplo `delete-subnet-group` a seguir exclui o grupo de sub-redes do DAX especificado. ``` aws dax delete-subnet-group \ --subnet-group-name daxSubnetGroup ``` Resultado: ``` { "DeletionMessage": "Subnet group daxSubnetGroup has been deleted." } ``` Para obter mais informações, consulte [Gerenciar clusters do DAX](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [DeleteSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/delete-subnet-group.html) na *Referência de comandos da AWS CLI*. ### `describe-clusters` O código de exemplo a seguir mostra como usar `describe-clusters`. **AWS CLI** **Como retornar informações sobre todos os clusters do DAX provisionados** O exemplo `describe-clusters` a seguir exibe detalhes sobre todos os clusters provisionados do DAX. ``` aws dax describe-clusters ``` Resultado: ``` { "Clusters": [ { "ClusterName": "daxcluster", "ClusterArn": "arn:aws:dax:us-west-2:123456789012:cache/daxcluster", "TotalNodes": 1, "ActiveNodes": 1, "NodeType": "dax.r4.large", "Status": "available", "ClusterDiscoveryEndpoint": { "Address": "daxcluster.ey3o9d.clustercfg.dax.usw2.cache.amazonaws.com", "Port": 8111 }, "Nodes": [ { "NodeId": "daxcluster-a", "Endpoint": { "Address": "daxcluster-a.ey3o9d.0001.dax.usw2.cache.amazonaws.com", "Port": 8111 }, "NodeCreateTime": 1576625059.509, "AvailabilityZone": "us-west-2c", "NodeStatus": "available", "ParameterGroupStatus": "in-sync" } ], "PreferredMaintenanceWindow": "thu:13:00-thu:14:00", "SubnetGroup": "default", "SecurityGroups": [ { "SecurityGroupIdentifier": "sg-1af6e36e", "Status": "active" } ], "IamRoleArn": "arn:aws:iam::123456789012:role/DAXServiceRoleForDynamoDBAccess", "ParameterGroup": { "ParameterGroupName": "default.dax1.0", "ParameterApplyStatus": "in-sync", "NodeIdsToReboot": [] }, "SSEDescription": { "Status": "ENABLED" } } ] } ``` Para obter mais informações, consulte [Gerenciar clusters do DAX](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Consulte detalhes da API em [DescribeClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/describe-clusters.html) na *Referência de comandos da AWS CLI*. ### `describe-default-parameters` O código de exemplo a seguir mostra como usar `describe-default-parameters`. **AWS CLI** **Como retornar as informações sobre o parâmetro do sistema padrão para o DAX** O exemplo `describe-default-parameters` a seguir exibe informações sobre o parâmetro do sistema padrão para o DAX. ``` aws dax describe-default-parameters ``` Resultado: ``` { "Parameters": [ { "ParameterName": "query-ttl-millis", "ParameterType": "DEFAULT", "ParameterValue": "300000", "NodeTypeSpecificValues": [], "Description": "Duration in milliseconds for queries to remain cached", "Source": "user", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": "TRUE", "ChangeType": "IMMEDIATE" }, { "ParameterName": "record-ttl-millis", "ParameterType": "DEFAULT", "ParameterValue": "300000", "NodeTypeSpecificValues": [], "Description": "Duration in milliseconds for records to remain valid in cache (Default: 0 = infinite)", "Source": "user", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": "TRUE", "ChangeType": "IMMEDIATE" } ] } ``` Para obter mais informações, consulte [Gerenciar clusters do DAX](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [DescribeDefaultParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/describe-default-parameters.html) na *Referência de comandos da AWS CLI*. ### `describe-events` O código de exemplo a seguir mostra como usar `describe-events`. **AWS CLI** **Como retornar todos os eventos relacionados a clusters e grupos de parâmetros do DAX** O exemplo `describe-events` a seguir exibe detalhes sobre eventos relacionados a clusters do DAX e grupos de parâmetros. ``` aws dax describe-events ``` Resultado: ``` { "Events": [ { "SourceName": "daxcluster", "SourceType": "CLUSTER", "Message": "Cluster deleted.", "Date": 1576702736.706 }, { "SourceName": "daxcluster", "SourceType": "CLUSTER", "Message": "Removed node daxcluster-b.", "Date": 1576702691.738 }, { "SourceName": "daxcluster", "SourceType": "CLUSTER", "Message": "Removed node daxcluster-a.", "Date": 1576702633.498 }, { "SourceName": "daxcluster", "SourceType": "CLUSTER", "Message": "Removed node daxcluster-c.", "Date": 1576702631.329 }, { "SourceName": "daxcluster", "SourceType": "CLUSTER", "Message": "Cluster created.", "Date": 1576626560.057 } ] } ``` Para obter mais informações, consulte [Gerenciar clusters do DAX](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [DescribeEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/describe-events.html) na *Referência de comandos da AWS CLI*. ### `describe-parameter-groups` O código de exemplo a seguir mostra como usar `describe-parameter-groups`. **AWS CLI** **Para descrever os grupos de parâmetros definidos no DAX** O exemplo `describe-parameter-groups` a seguir recupera detalhes sobre os grupos de parâmetros definidos no DAX. ``` aws dax describe-parameter-groups ``` Resultado: ``` { "ParameterGroups": [ { "ParameterGroupName": "default.dax1.0", "Description": "Default parameter group for dax1.0" } ] } ``` Para obter mais informações, consulte [Gerenciar clusters do DAX](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [DescribeParameterGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/describe-parameter-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-parameters` O código de exemplo a seguir mostra como usar `describe-parameters`. **AWS CLI** **Para descrever os parâmetros definidos em um grupo de parâmetros do DAX** O exemplo `describe-parameters` a seguir recupera detalhes sobre os parâmetros definidos no grupo de parâmetros do DAX especificado. ``` aws dax describe-parameters \ --parameter-group-name default.dax1.0 ``` Resultado: ``` { "Parameters": [ { "ParameterName": "query-ttl-millis", "ParameterType": "DEFAULT", "ParameterValue": "300000", "NodeTypeSpecificValues": [], "Description": "Duration in milliseconds for queries to remain cached", "Source": "user", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": "TRUE", "ChangeType": "IMMEDIATE" }, { "ParameterName": "record-ttl-millis", "ParameterType": "DEFAULT", "ParameterValue": "300000", "NodeTypeSpecificValues": [], "Description": "Duration in milliseconds for records to remain valid in cache (Default: 0 = infinite)", "Source": "user", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": "TRUE", "ChangeType": "IMMEDIATE" } ] } ``` Para obter mais informações, consulte [Gerenciar clusters do DAX](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Consulte detalhes da API em [DescribeParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/describe-parameters.html) na *Referência de comandos da AWS CLI*. ### `describe-subnet-groups` O código de exemplo a seguir mostra como usar `describe-subnet-groups`. **AWS CLI** **Para descrever grupos de sub-redes definidos no DAX** O exemplo `describe-subnet-groups` a seguir recupera detalhes dos grupos de sub-redes definidos no DAX. ``` aws dax describe-subnet-groups ``` Resultado: ``` { "SubnetGroups": [ { "SubnetGroupName": "default", "Description": "Default CacheSubnetGroup", "VpcId": "vpc-ee70a196", "Subnets": [ { "SubnetIdentifier": "subnet-874953af", "SubnetAvailabilityZone": "us-west-2d" }, { "SubnetIdentifier": "subnet-bd3d1fc4", "SubnetAvailabilityZone": "us-west-2a" }, { "SubnetIdentifier": "subnet-72c2ff28", "SubnetAvailabilityZone": "us-west-2c" }, { "SubnetIdentifier": "subnet-09e6aa42", "SubnetAvailabilityZone": "us-west-2b" } ] } ] } ``` Para obter mais informações, consulte [Gerenciar clusters do DAX](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.concepts.cluster.html#DAX.concepts.cluster.security) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [DescribeSubnetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/describe-subnet-groups.html) na *Referência de comandos da AWS CLI*. ### `increase-replication-factor` O código de exemplo a seguir mostra como usar `increase-replication-factor`. **AWS CLI** **Como aumentar o fator de replicação de um cluster do DAX** O exemplo `increase-replication-factor` a seguir aumenta o fator de replicação do cluster do DAX especificado para 3. ``` aws dax increase-replication-factor \ --cluster-name daxcluster \ --new-replication-factor 3 ``` Resultado: ``` { "Cluster": { "ClusterName": "daxcluster", "ClusterArn": "arn:aws:dax:us-west-2:123456789012:cache/daxcluster", "TotalNodes": 3, "ActiveNodes": 1, "NodeType": "dax.r4.large", "Status": "modifying", "ClusterDiscoveryEndpoint": { "Address": "daxcluster.ey3o9d.clustercfg.dax.usw2.cache.amazonaws.com", "Port": 8111 }, "Nodes": [ { "NodeId": "daxcluster-a", "Endpoint": { "Address": "daxcluster-a.ey3o9d.0001.dax.usw2.cache.amazonaws.com", "Port": 8111 }, "NodeCreateTime": 1576625059.509, "AvailabilityZone": "us-west-2c", "NodeStatus": "available", "ParameterGroupStatus": "in-sync" }, { "NodeId": "daxcluster-b", "NodeStatus": "creating" }, { "NodeId": "daxcluster-c", "NodeStatus": "creating" } ], "PreferredMaintenanceWindow": "thu:13:00-thu:14:00", "SubnetGroup": "default", "SecurityGroups": [ { "SecurityGroupIdentifier": "sg-1af6e36e", "Status": "active" } ], "IamRoleArn": "arn:aws:iam::123456789012:role/DAXServiceRoleForDynamoDBAccess", "ParameterGroup": { "ParameterGroupName": "default.dax1.0", "ParameterApplyStatus": "in-sync", "NodeIdsToReboot": [] }, "SSEDescription": { "Status": "ENABLED" } } } ``` Para obter mais informações, consulte [Gerenciar clusters do DAX](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.cluster-management.custom-settings) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [IncreaseReplicationFactor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/increase-replication-factor.html) na *Referência de comandos da AWS CLI*. ### `list-tags` O código de exemplo a seguir mostra como usar `list-tags`. **AWS CLI** **Para listar as tags em um recurso do DAX** O exemplo `list-tags` a seguir lista as chaves e os valores de tag anexados ao cluster do DAX especificado. ``` aws dax list-tags \ --resource-name arn:aws:dax:us-west-2:123456789012:cache/daxcluster ``` Resultado: ``` { "Tags": [ { "Key": "ClusterUsage", "Value": "prod" } ] } ``` Para obter mais informações, consulte [Gerenciar clusters do DAX](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.management.tagging) no *Guia do desenvolvedor do Amazon DynamoDB*. + Consulte detalhes da API em [ListTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/list-tags.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como marcar um recurso do DAX** O exemplo `tag-resource` a seguir anexa o nome da chave de tag especificada e o valor associado ao cluster do DAX especificado para descrever o uso do cluster. ``` aws dax tag-resource \ --resource-name arn:aws:dax:us-west-2:123456789012:cache/daxcluster \ --tags="Key=ClusterUsage,Value=prod" ``` Resultado: ``` { "Tags": [ { "Key": "ClusterUsage", "Value": "prod" } ] } ``` Para obter mais informações, consulte [Gerenciar clusters do DAX](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.management.tagging) no *Guia do desenvolvedor do Amazon DynamoDB*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover as tags de um recurso do DAX** O exemplo `untag-resource` a seguir remove a tag com o nome de chave especificado de um cluster do DAX. ``` aws dax untag-resource \ --resource-name arn:aws:dax:us-west-2:123456789012:cache/daxcluster \ --tag-keys="ClusterUsage" ``` Resultado: ``` { "Tags": [] } ``` Para obter mais informações, consulte [Gerenciar clusters do DAX](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.management.tagging) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/untag-resource.html) na *Referência de comandos da AWS CLI*. # Exemplos do Detective usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o Detective. *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 ### `accept-invitation` O código de exemplo a seguir mostra como usar `accept-invitation`. **AWS CLI** **Como aceitar um convite para ser uma conta de membro em um gráfico de comportamento** O exemplo `accept-invitation` a seguir aceita um convite para se tornar uma conta de membro no gráfico de comportamento arn:aws:detective:us-east-1:111122223333:graph:123412341234. ``` aws detective accept-invitation \ --graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 ``` Este comando não produz saída. Para obter mais informações, consulte [Responder a um convite de gráfico de comportamento](https://docs.aws.amazon.com/detective/latest/adminguide/member-invitation-response.html) no *Guia de administração do Amazon Detective*. + Para ver detalhes da API, consulte [AcceptInvitation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/accept-invitation.html) na *Referência de comandos da AWS CLI*. ### `create-graph` O código de exemplo a seguir mostra como usar `create-graph`. **AWS CLI** **Para habilitar o Amazon Detective e criar um novo gráfico de comportamento** O exemplo `create-graph` a seguir habilita o Detective para a conta da AWS que executa o comando na região em que o comando é executado. É criado um novo gráfico de comportamento que tem essa conta como conta de administrador. O comando também atribui o valor Finance à tag Department. ``` aws detective create-graph \ --tags '{"Department": "Finance"}' ``` Resultado: ``` { "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:027c7c4610ea4aacaf0b883093cab899" } ``` Para obter mais informações, consulte [Habilitar o Amazon Detective](https://docs.aws.amazon.com/detective/latest/adminguide/detective-enabling.html) no *Guia de administração do Amazon Detective*. + Para ver detalhes da API, consulte [CreateGraph](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/create-graph.html) na *Referência de comandos da AWS CLI*. ### `create-members` O código de exemplo a seguir mostra como usar `create-members`. **AWS CLI** **Como convidar contas de membros para um gráfico de comportamento** O exemplo `create-members` a seguir convida duas contas da AWS a se tornarem contas de membros no gráfico de comportamento arn:aws:detective:us-east-1:111122223333:graph:123412341234. Para cada conta, a solicitação fornece o ID de conta da AWS e o endereço de e-mail do usuário-raiz da conta. A solicitação inclui uma mensagem personalizada para inserir no e-mail de convite. ``` aws detective create-members \ --accounts AccountId=444455556666,EmailAddress=mmajor@example.com AccountId=123456789012,EmailAddress=jstiles@example.com \ --graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 \ --message "This is Paul Santos. I need to add your account to the data we use for security investigation in Amazon Detective. If you have any questions, contact me at psantos@example.com." ``` Resultado: ``` { "Members": [ { "AccountId": "444455556666", "AdministratorId": "111122223333", "EmailAddress": "mmajor@example.com", "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234", "InvitedTime": 1579826107000, "MasterId": "111122223333", "Status": "INVITED", "UpdatedTime": 1579826107000 }, { "AccountId": "123456789012", "AdministratorId": "111122223333", "EmailAddress": "jstiles@example.com", "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234", "InvitedTime": 1579826107000, "MasterId": "111122223333", "Status": "VERIFICATION_IN_PROGRESS", "UpdatedTime": 1579826107000 } ], "UnprocessedAccounts": [ ] } ``` Para obter mais informações, consulte Convidar contas de membros para um gráfico de comportamento no *Guia de administração do Amazon Detective*. **Como convidar contas de membros sem enviar e-mails de convite** O exemplo `create-members` a seguir convida duas contas da AWS a se tornarem contas membros no gráfico de comportamento arn:aws:detective:us-east-1:111122223333:graph:123412341234. Para cada conta, a solicitação fornece o ID de conta da AWS e o endereço de e-mail do usuário-raiz da conta. As contas dos membros não recebem e-mails de convite. ``` aws detective create-members \ --accounts AccountId=444455556666,EmailAddress=mmajor@example.com AccountId=123456789012,EmailAddress=jstiles@example.com \ --graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 \ --disable-email-notification ``` Resultado: ``` { "Members": [ { "AccountId": "444455556666", "AdministratorId": "111122223333", "EmailAddress": "mmajor@example.com", "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234", "InvitedTime": 1579826107000, "MasterId": "111122223333", "Status": "INVITED", "UpdatedTime": 1579826107000 }, { "AccountId": "123456789012", "AdministratorId": "111122223333", "EmailAddress": "jstiles@example.com", "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234", "InvitedTime": 1579826107000, "MasterId": "111122223333", "Status": "VERIFICATION_IN_PROGRESS", "UpdatedTime": 1579826107000 } ], "UnprocessedAccounts": [ ] } ``` Para obter mais informações, consulte Convidar contas de membros para um gráfico de comportamento no *Guia de administração do Amazon Detective*. + Para ver detalhes da API, consulte [CreateMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/create-members.html) na *Referência de comandos da AWS CLI*. ### `delete-graph` O código de exemplo a seguir mostra como usar `delete-graph`. **AWS CLI** **Para desativar o Detective e excluir o gráfico de comportamento** O exemplo `delete-graph` a seguir desabilita o Detective e exclui o gráfico de comportamento especificado. ``` aws detective delete-graph \ --graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 ``` Este comando não produz saída. Para obter mais informações, consulte [Desabilitar o Amazon Detective](https://docs.aws.amazon.com/detective/latest/adminguide/detective-disabling.html) no *Guia de administração do Amazon Detective*. + Para ver detalhes da API, consulte [DeleteGraph](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/delete-graph.html) na *Referência de comandos da AWS CLI*. ### `delete-members` O código de exemplo a seguir mostra como usar `delete-members`. **AWS CLI** **Para remover conta de membro de um gráfico de comportamento** O exemplo `delete-members` a seguir remove duas contas de membros do gráfico de comportamento arn:aws:detective:us-east-1:111122223333:graph:123412341234. Como identificar as contas, a solicitação fornece os IDs da conta da AWS. ``` aws detective delete-members \ --account-ids 444455556666 123456789012 \ --graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 ``` Resultado: ``` { "AccountIds": [ "444455556666", "123456789012" ], "UnprocessedAccounts": [ ] } ``` Para obter mais informações, consulte Remover contas de membros de um gráfico de comportamento no *Guia de administração do Amazon Detective*. + Para ver detalhes da API, consulte [DeleteMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/delete-members.html) na *Referência de comandos da AWS CLI*. ### `disassociate-membership` O código de exemplo a seguir mostra como usar `disassociate-membership`. **AWS CLI** **Como renunciar à associação a partir de um gráfico de comportamento** O exemplo de dissociate-membership a seguir remove a conta da AWS que executa o comando do gráfico de comportamento arn:aws:detective:us-east-1:111122223333:graph:123412341234. ``` aws detective disassociate-membership \ --graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 ``` Para obter mais informações, consulte Remover sua conta de um gráfico de comportamento no *Guia de administração do Amazon Detective*. + Para ver detalhes da API, consulte [DisassociateMembership](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/disassociate-membership.html) na *Referência de comandos da AWS CLI*. ### `get-members` O código de exemplo a seguir mostra como usar `get-members`. **AWS CLI** **Para recuperar informações sobre contas de membros do gráfico de comportamento selecionado** O exemplo `get-members` a seguir recupera informações sobre duas contas de membros no gráfico de comportamento arn:aws:detective:us-east-1:111122223333:graph:123412341234. Para as duas contas, a solicitação fornece os IDs da conta da AWS. ``` aws detective get-members \ --account-ids 444455556666 123456789012 \ --graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 ``` Resultado: ``` { "MemberDetails": [ { "AccountId": "444455556666", "AdministratorId": "111122223333", "EmailAddress": "mmajor@example.com", "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234", "InvitedTime": 1579826107000, "MasterId": "111122223333", "Status": "INVITED", "UpdatedTime": 1579826107000 } { "AccountId": "123456789012", "AdministratorId": "111122223333", "EmailAddress": "jstiles@example.com", "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234", "InvitedTime": 1579826107000, "MasterId": "111122223333", "Status": "INVITED", "UpdatedTime": 1579826107000 } ], "UnprocessedAccounts": [ ] } ``` Para obter mais informações, consulte Visualizar a lista de contas em um gráfico de comportamento no *Guia de administração do Amazon Detective*. + Para ver detalhes da API, consulte [GetMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/get-members.html) na *Referência de comandos da AWS CLI*. ### `list-graphs` O código de exemplo a seguir mostra como usar `list-graphs`. **AWS CLI** **Para visualizar uma lista de gráficos de comportamento dos quais sua conta é administradora** O exemplo `list-graphs` a seguir recupera os gráficos de comportamento dos quais a conta de chamada é administradora na região atual. ``` aws detective list-graphs ``` Resultado: ``` { "GraphList": [ { "Arn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234", "CreatedTime": 1579736111000 } ] } ``` + Para ver detalhes da API, consulte [ListGraphs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/list-graphs.html) na *Referência de comandos da AWS CLI*. ### `list-invitations` O código de exemplo a seguir mostra como usar `list-invitations`. **AWS CLI** **Para visualizar uma lista de gráficos de comportamento dos quais uma conta é membro ou para a qual foi convidada** O exemplo `list-invitations` a seguir recupera os gráficos de comportamento para os quais a conta de chamada foi convidada. Os resultados incluem somente convites abertos e aceitos. Eles não incluem convites rejeitados ou assinaturas removidas. ``` aws detective list-invitations ``` Resultado: ``` { "Invitations": [ { "AccountId": "444455556666", "AdministratorId": "111122223333", "EmailAddress": "mmajor@example.com", "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234", "InvitedTime": 1579826107000, "MasterId": "111122223333", "Status": "INVITED", "UpdatedTime": 1579826107000 } ] } ``` Para obter mais informações, consulte Visualizar sua lista de convites para gráficos de comportamento no *Guia de administração Amazon Detective*. + Para ver detalhes da API, consulte [ListInvitations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/list-invitations.html) na *Referência de comandos da AWS CLI*. ### `list-members` O código de exemplo a seguir mostra como usar `list-members`. **AWS CLI** **Para listar as contas de membros em um gráfico de comportamento** O exemplo `list-members` a seguir recupera as contas de membros convidadas e habilitadas para o gráfico de comportamento `arn:aws:detective:us-east-1:111122223333:graph:123412341234`. Os resultados não incluem contas-membro que foram removidas. ``` aws detective list-members \ --graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 ``` Resultado: ``` { "MemberDetails": [ { "AccountId": "444455556666", "AdministratorId": "111122223333", "EmailAddress": "mmajor@example.com", "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234", "InvitedTime": 1579826107000, "MasterId": "111122223333", "Status": "INVITED", "UpdatedTime": 1579826107000 }, { "AccountId": "123456789012", "AdministratorId": "111122223333", "EmailAddress": "jstiles@example.com", "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234", "InvitedTime": 1579826107000, "MasterId": "111122223333", "PercentOfGraphUtilization": 2, "PercentOfGraphUtilizationUpdatedTime": 1586287843, "Status": "ENABLED", "UpdatedTime": 1579973711000, "VolumeUsageInBytes": 200, "VolumeUsageUpdatedTime": 1586287843 } ] } ``` Para obter mais informações, consulte [Visualizar a lista de contas em um gráfico de comportamento](https://docs.aws.amazon.com/detective/latest/adminguide/graph-admin-view-accounts.html) no *Guia de administração do Amazon Detective*. + Para ver detalhes da API, consulte [ListMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/list-members.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para recuperar as tags atribuídas a um gráfico de comportamento** O exemplo `list-tags-for-resource` a seguir retorna as tags atribuídas ao gráfico de comportamento especificado. ``` aws detective list-tags-for-resource \ --resource-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 ``` Resultado: ``` { "Tags": { "Department" : "Finance" } } ``` Para obter mais informações, consulte [Gerenciar tags para um gráfico de comportamento](https://docs.aws.amazon.com/detective/latest/adminguide/graph-tags.html) no *Guia de administração do Amazon Detective*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `reject-invitation` O código de exemplo a seguir mostra como usar `reject-invitation`. **AWS CLI** **Como rejeitar um convite para ser uma conta de membro em um gráfico de comportamento** O exemplo `reject-invitation` a seguir rejeita um convite para se tornar uma conta de membro no gráfico de comportamento arn:aws:detective:us-east-1:111122223333:graph:123412341234. ``` aws detective reject-invitation \ --graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 ``` Este comando não produz saída. Para obter mais informações, consulte Responder a um convite de gráfico de comportamento no *Guia de administração do Amazon Detective*. + Para ver detalhes da API, consulte [RejectInvitation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/reject-invitation.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como atribuir uma tag a um recurso** O exemplo `tag-resource` a seguir atribui um valor para a tag Department ao gráfico de comportamento especificado. ``` aws detective tag-resource \ --resource-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 \ --tags '{"Department":"Finance"}' ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar tags para um gráfico de comportamento](https://docs.aws.amazon.com/detective/latest/adminguide/graph-tags.html) no *Guia de administração do Amazon Detective*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Remover um valor de tag de um recurso** O exemplo `untag-resource` a seguir remove a tag Department do gráfico de comportamento especificado. ``` aws detective untag-resource \ --resource-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 \ --tag-keys "Department" ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar tags para um gráfico de comportamento](https://docs.aws.amazon.com/detective/latest/adminguide/graph-tags.html) no *Guia de administração do Amazon Detective*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/untag-resource.html) na *Referência de comandos da AWS CLI*. # Exemplos do Device Farm usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o 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 ### `create-device-pool` O código de exemplo a seguir mostra como usar `create-device-pool`. **AWS CLI** **Para criar um grupo de dispositivos** O comando a seguir cria um grupo de dispositivos Android para um projeto: ``` aws devicefarm create-device-pool --name pool1 --rules file://device-pool-rules.json --project-arn "arn:aws:devicefarm:us-west-2:123456789012:project:070fc3ca-7ec1-4741-9c1f-d3e044efc506" ``` É possível obter o ARN do projeto a partir da saída de `create-project` ou `list-projects`. O arquivo `device-pool-rules.json` é um documento JSON na pasta atual que especifica a plataforma do dispositivo: ``` [ { "attribute": "PLATFORM", "operator": "EQUALS", "value": "\"ANDROID\"" } ] ``` Resultado: ``` { "devicePool": { "rules": [ { "operator": "EQUALS", "attribute": "PLATFORM", "value": "\"ANDROID\"" } ], "type": "PRIVATE", "name": "pool1", "arn": "arn:aws:devicefarm:us-west-2:123456789012:devicepool:070fc3ca-7ec1-4741-9c1f-d3e044efc506/2aa8d2a9-5e73-47ca-b929-659cb34b7dcd" } } ``` + Para ver detalhes da API, consulte [CreateDevicePool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/devicefarm/create-device-pool.html) na *Referência de comandos da AWS CLI*. ### `create-project` O código de exemplo a seguir mostra como usar `create-project`. **AWS CLI** **Para criar um projeto** O seguinte comando cria um projeto chamado `my-project`: ``` aws devicefarm create-project --name my-project ``` Resultado: ``` { "project": { "name": "myproject", "arn": "arn:aws:devicefarm:us-west-2:123456789012:project:070fc3ca-7ec1-4741-9c1f-d3e044efc506", "created": 1503612890.057 } } ``` + Consulte detalhes da API em [CreateProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/devicefarm/create-project.html) na *Referência de comandos da AWS CLI*. ### `create-upload` O código de exemplo a seguir mostra como usar `create-upload`. **AWS CLI** **Para criar um upload** O comando a seguir cria um upload para uma aplicação do Android: ``` aws devicefarm create-upload --project-arn "arn:aws:devicefarm:us-west-2:123456789012:project:070fc3ca-7ec1-4741-9c1f-d3e044efc506" --name app.apk --type ANDROID_APP ``` É possível obter o ARN do projeto a partir da saída de create-project ou list-projects. Resultado: ``` { "upload": { "status": "INITIALIZED", "name": "app.apk", "created": 1503614408.769, "url": "https://prod-us-west-2-uploads.s3-us-west-2.amazonaws.com/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789012%3Aproject%3A070fc3ca-c7e1-4471-91cf-d3e4efc50604/uploads/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789012%3Aupload%3A070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514/app.apk?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20170824T224008Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAEXAMPLEPBUMBC3GA%2F20170824%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=05050370c38894ef5bd09f5d009f36fc8f96fa4bb04e1bba9aca71b8dbe49a0f", "type": "ANDROID_APP", "arn": "arn:aws:devicefarm:us-west-2:123456789012:upload:070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514" } } ``` Use o URL assinado na saída para carregar um arquivo no Device Farm: ``` curl -T app.apk "https://prod-us-west-2-uploads.s3-us-west-2.amazonaws.com/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789012%3Aproject%3A070fc3ca-c7e1-4471-91cf-d3e4efc50604/uploads/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789012%3Aupload%3A070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514/app.apk?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20170824T224008Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAEXAMPLEPBUMBC3GA%2F20170824%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=05050370c38894ef5bd09f5d009f36fc8f96fa4bb04e1bba9aca71b8dbe49a0f" ``` + Para ver detalhes da API, consulte [CreateUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/devicefarm/create-upload.html) na *Referência de comandos da AWS CLI*. ### `get-upload` O código de exemplo a seguir mostra como usar `get-upload`. **AWS CLI** **Como visualizar um upload** O comando a seguir recupera informações sobre um upload: ``` aws devicefarm get-upload --arn "arn:aws:devicefarm:us-west-2:123456789012:upload:070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514" ``` É possível obter o ARN de upload a partir da saída de `create-upload`. Resultado: ``` { "upload": { "status": "SUCCEEDED", "name": "app.apk", "created": 1505262773.186, "type": "ANDROID_APP", "arn": "arn:aws:devicefarm:us-west-2:123456789012:upload:070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514", "metadata": "{\"device_admin\":false,\"activity_name\":\"ccom.example.client.LauncherActivity\",\"version_name\":\"1.0.2.94\",\"screens\":[\"small\",\"normal\",\"large\",\"xlarge\"],\"error_type\":null,\"sdk_version\":\"16\",\"package_name\":\"com.example.client\",\"version_code\":\"20994\",\"native_code\":[\"armeabi-v7a\"],\"target_sdk_version\":\"25\"}" } } ``` + Para ver detalhes da API, consulte [GetUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/devicefarm/get-upload.html) na *Referência de comandos da AWS CLI*. ### `list-projects` O código de exemplo a seguir mostra como usar `list-projects`. **AWS CLI** **Para listar projetos** A opção seguinte recupera uma lista de projetos: ``` aws devicefarm list-projects ``` Resultado: ``` { "projects": [ { "name": "myproject", "arn": "arn:aws:devicefarm:us-west-2:123456789012:project:070fc3ca-7ec1-4741-9c1f-d3e044efc506", "created": 1503612890.057 }, { "name": "otherproject", "arn": "arn:aws:devicefarm:us-west-2:123456789012:project:a5f5b752-8098-49d1-86bf-5f7682c1c77e", "created": 1505257519.337 } ] } ``` + Para ver detalhes da API, consulte [ListProjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/devicefarm/list-projects.html) na *Referência de comandos da AWS CLI*. # Direct Connect Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Direct Connect. *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 ### `accept-direct-connect-gateway-association-proposal` O código de exemplo a seguir mostra como usar `accept-direct-connect-gateway-association-proposal`. **AWS CLI** **Como aceitar uma proposta de associação do gateway** O `accept-direct-connect-gateway-association-proposal` a seguir aceita a proposta especificada. ``` aws directconnect accept-direct-connect-gateway-association-proposal \ --direct-connect-gateway-id 11460968-4ac1-4fd3-bdb2-00599EXAMPLE \ --proposal-id cb7f41cb-8128-43a5-93b1-dcaedEXAMPLE \ --associated-gateway-owner-account 111122223333 { "directConnectGatewayAssociation": { "directConnectGatewayId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE", "directConnectGatewayOwnerAccount": "111122223333", "associationState": "associating", "associatedGateway": { "id": "tgw-02f776b1a7EXAMPLE", "type": "transitGateway", "ownerAccount": "111122223333", "region": "us-east-1" }, "associationId": "6441f8bf-5917-4279-ade1-9708bEXAMPLE", "allowedPrefixesToDirectConnectGateway": [ { "cidr": "192.168.1.0/30" } ] } } ``` Para obter mais informações, consulte [Aceitar ou rejeitar uma proposta de associação a um gateway de trânsito](https://docs.aws.amazon.com/directconnect/latest/UserGuide/multi-account-associate-tgw.html#multi-account-tgw-accept-reject-proposal) no *Guia do usuário do AWS Direct Connect*. + Para ver detalhes da API, consulte [AcceptDirectConnectGatewayAssociationProposal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/accept-direct-connect-gateway-association-proposal.html) na *Referência de comandos da AWS CLI*. ### `allocate-connection-on-interconnect` O código de exemplo a seguir mostra como usar `allocate-connection-on-interconnect`. **AWS CLI** **Para criar uma conexão hospedada em uma interconexão** O comando `allocate-connection-on-interconnect` a seguir cria uma conexão hospedada em uma interconexão: ``` aws directconnect allocate-connection-on-interconnect --bandwidth 500Mbps --connection-name mydcinterconnect --owner-account 123456789012 --interconnect-id dxcon-fgktov66 --vlan 101 ``` Resultado: ``` { "partnerName": "TIVIT", "vlan": 101, "ownerAccount": "123456789012", "connectionId": "dxcon-ffzc51m1", "connectionState": "ordering", "bandwidth": "500Mbps", "location": "TIVIT", "connectionName": "mydcinterconnect", "region": "sa-east-1" } ``` + Para ver detalhes da API, consulte [AllocateConnectionOnInterconnect](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/allocate-connection-on-interconnect.html) na *Referência de comandos da AWS CLI*. ### `allocate-hosted-connection` O código de exemplo a seguir mostra como usar `allocate-hosted-connection`. **AWS CLI** **Para criar uma conexão hospedada em uma interconexão** O exemplo `allocate-hosted-connection` a seguir cria uma conexão hospedada na interconexão especificada. ``` aws directconnect allocate-hosted-connection \ --bandwidth 500Mbps \ --connection-name mydcinterconnect \ --owner-account 123456789012 -connection-id dxcon-fgktov66 -vlan 101 ``` Resultado: ``` { "partnerName": "TIVIT", "vlan": 101, "ownerAccount": "123456789012", "connectionId": "dxcon-ffzc51m1", "connectionState": "ordering", "bandwidth": "500Mbps", "location": "TIVIT", "connectionName": "mydcinterconnect", "region": "sa-east-1" } ``` + Para ver detalhes da API, consulte [AllocateHostedConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/allocate-hosted-connection.html) na *Referência de comandos da AWS CLI*. ### `allocate-private-virtual-interface` O código de exemplo a seguir mostra como usar `allocate-private-virtual-interface`. **AWS CLI** **Como provisionar uma interface virtual privada** O comando `allocate-private-virtual-interface` a seguir provisiona uma interface virtual privada para pertencer a outro cliente: ``` aws directconnect allocate-private-virtual-interface --connection-id dxcon-ffjrkx17 --owner-account 123456789012 --new-private-virtual-interface-allocation virtualInterfaceName=PrivateVirtualInterface,vlan=1000,asn=65000,authKey=asdf34example,amazonAddress=192.168.1.1/30,customerAddress=192.168.1.2/30 ``` Resultado: ``` { "virtualInterfaceState": "confirming", "asn": 65000, "vlan": 1000, "customerAddress": "192.168.1.2/30", "ownerAccount": "123456789012", "connectionId": "dxcon-ffjrkx17", "virtualInterfaceId": "dxvif-fgy8orxu", "authKey": "asdf34example", "routeFilterPrefixes": [], "location": "TIVIT", "customerRouterConfig": "\n \n 1000\n 192.168.1.2/30\n 192.168.1.1/30\n 65000\n asdf34example\n 7224\n private\n\n", "amazonAddress": "192.168.1.1/30", "virtualInterfaceType": "private", "virtualInterfaceName": "PrivateVirtualInterface" } ``` + Para ver detalhes da API, consulte [AllocatePrivateVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/allocate-private-virtual-interface.html) na *Referência de comandos da AWS CLI*. ### `allocate-public-virtual-interface` O código de exemplo a seguir mostra como usar `allocate-public-virtual-interface`. **AWS CLI** **Como provisionar uma interface virtual pública** O comando `allocate-public-virtual-interface` a seguir provisiona uma interface virtual pública para pertencer a outro cliente: ``` aws directconnect allocate-public-virtual-interface --connection-id dxcon-ffjrkx17 --owner-account 123456789012 --new-public-virtual-interface-allocation virtualInterfaceName=PublicVirtualInterface,vlan=2000,asn=65000,authKey=asdf34example,amazonAddress=203.0.113.1/30,customerAddress=203.0.113.2/30,routeFilterPrefixes=[{cidr=203.0.113.0/30},{cidr=203.0.113.4/30}] ``` Resultado: ``` { "virtualInterfaceState": "confirming", "asn": 65000, "vlan": 2000, "customerAddress": "203.0.113.2/30", "ownerAccount": "123456789012", "connectionId": "dxcon-ffjrkx17", "virtualInterfaceId": "dxvif-fg9xo9vp", "authKey": "asdf34example", "routeFilterPrefixes": [ { "cidr": "203.0.113.0/30" }, { "cidr": "203.0.113.4/30" } ], "location": "TIVIT", "customerRouterConfig": "\n\n 2000\n 203.0.113.2/30\n 203.0.113.1/30\n 65000\n asdf34example\n 7224\n public\n\n", "amazonAddress": "203.0.113.1/30", "virtualInterfaceType": "public", "virtualInterfaceName": "PublicVirtualInterface" } ``` + Para ver detalhes da API, consulte [AllocatePublicVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/allocate-public-virtual-interface.html) na *Referência de comandos da AWS CLI*. ### `allocate-transit-virtual-interface` O código de exemplo a seguir mostra como usar `allocate-transit-virtual-interface`. **AWS CLI** **Como provisionar uma interface virtual em trânsito para pertencer à conta da AWS especificada** O exemplo `allocate-transit-virtual-interface` a seguir provisiona uma interface virtual de trânsito para a conta especificada. ``` aws directconnect allocate-transit-virtual-interface \ --connection-id dxlag-fEXAMPLE \ --owner-account 123456789012 \ --new-transit-virtual-interface-allocation "virtualInterfaceName=Example Transit Virtual Interface,vlan=126,asn=65110,mtu=1500,authKey=0xzxgA9YoW9h58u8SEXAMPLE,amazonAddress=192.168.1.1/30,customerAddress=192.168.1.2/30,addressFamily=ipv4,tags=[{key=Tag,value=Example}]" ``` Resultado: ``` { "virtualInterface": { "ownerAccount": "123456789012", "virtualInterfaceId": "dxvif-fEXAMPLE", "location": "loc1", "connectionId": "dxlag-fEXAMPLE", "virtualInterfaceType": "transit", "virtualInterfaceName": "Example Transit Virtual Interface", "vlan": 126, "asn": 65110, "amazonSideAsn": 7224, "authKey": "0xzxgA9YoW9h58u8SEXAMPLE", "amazonAddress": "192.168.1.1/30", "customerAddress": "192.168.1.2/30", "addressFamily": "ipv4", "virtualInterfaceState": "confirming", "customerRouterConfig": "\n\n 126\n 192.168.1.2/30\n 192.168.1.1/30\n 65110\n 0xzxgA9YoW9h58u8SEXAMPLE\n 7224\n transit\n\n", "mtu": 1500, "jumboFrameCapable": true, "virtualGatewayId": "", "directConnectGatewayId": "", "routeFilterPrefixes": [], "bgpPeers": [ { "bgpPeerId": "dxpeer-fEXAMPLE", "asn": 65110, "authKey": "0xzxgA9YoW9h58u8EXAMPLE", "addressFamily": "ipv4", "amazonAddress": "192.168.1.1/30", "customerAddress": "192.168.1.2/30", "bgpPeerState": "pending", "bgpStatus": "down", "awsDeviceV2": "loc1-26wz6vEXAMPLE" } ], "region": "sa-east-1", "awsDeviceV2": "loc1-26wz6vEXAMPLE", "tags": [ { "key": "Tag", "value": "Example" } ] } } ``` Para obter informações, consulte [Criar uma interface virtual de trânsito hospedada](https://docs.aws.amazon.com/directconnect/latest/UserGuide/createhostedvirtualinterface.html#create-hosted-transit-vif) no *Guia do usuário do AWS Direct Connect*. + Para ver detalhes da API, consulte [AllocateTransitVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/allocate-transit-virtual-interface.html) na *Referência de comandos da AWS CLI*. ### `associate-connection-with-lag` O código de exemplo a seguir mostra como usar `associate-connection-with-lag`. **AWS CLI** **Como associar uma conexão a um LAG** O exemplo a seguir associa a conexão especificada ao LAG especificado. Comando: ``` aws directconnect associate-connection-with-lag --lag-id dxlag-fhccu14t --connection-id dxcon-fg9607vm ``` Resultado: ``` { "ownerAccount": "123456789012", "connectionId": "dxcon-fg9607vm", "lagId": "dxlag-fhccu14t", "connectionState": "requested", "bandwidth": "1Gbps", "location": "EqDC2", "connectionName": "Con2ForLag", "region": "us-east-1" } ``` + Para ver detalhes da API, consulte [AssociateConnectionWithLag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/associate-connection-with-lag.html) na *Referência de comandos da AWS CLI*. ### `associate-hosted-connection` O código de exemplo a seguir mostra como usar `associate-hosted-connection`. **AWS CLI** **Como associar uma conexão hospedada a um LAG** O exemplo a seguir associa a conexão hospedada especificada ao LAG especificado. Comando: ``` aws directconnect associate-hosted-connection --parent-connection-id dxlag-fhccu14t --connection-id dxcon-fg9607vm ``` Resultado: ``` { "partnerName": "TIVIT", "vlan": 101, "ownerAccount": "123456789012", "connectionId": "dxcon-fg9607vm", "lagId": "dxlag-fhccu14t", "connectionState": "ordering", "bandwidth": "500Mbps", "location": "TIVIT", "connectionName": "mydcinterconnect", "region": "sa-east-1" } ``` + Para ver detalhes da API, consulte [AssociateHostedConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/associate-hosted-connection.html) na *Referência de comandos da AWS CLI*. ### `associate-virtual-interface` O código de exemplo a seguir mostra como usar `associate-virtual-interface`. **AWS CLI** **Como associar uma interface virtual a uma conexão** O exemplo a seguir associa a interface virtual especificada ao LAG especificado. Como alternativa, para associar a interface virtual a uma conexão, especifique o ID de uma conexão do AWS Direct Connect para `--connection-id`, por exemplo, `dxcon-ffnikghc`. Comando: ``` aws directconnect associate-virtual-interface --connection-id dxlag-ffjhj9lx --virtual-interface-id dxvif-fgputw0j ``` Resultado: ``` { "virtualInterfaceState": "pending", "asn": 65000, "vlan": 123, "customerAddress": "169.254.255.2/30", "ownerAccount": "123456789012", "connectionId": "dxlag-ffjhj9lx", "addressFamily": "ipv4", "virtualGatewayId": "vgw-38e90b51", "virtualInterfaceId": "dxvif-fgputw0j", "authKey": "0x123pK5_VBqv.UQ3kJ4123_", "routeFilterPrefixes": [], "location": "CSVA1", "bgpPeers": [ { "bgpStatus": "down", "customerAddress": "169.254.255.2/30", "addressFamily": "ipv4", "authKey": "0x123pK5_VBqv.UQ3kJ4123_", "bgpPeerState": "deleting", "amazonAddress": "169.254.255.1/30", "asn": 65000 }, { "bgpStatus": "down", "customerAddress": "169.254.255.2/30", "addressFamily": "ipv4", "authKey": "0x123pK5_VBqv.UQ3kJ4123_", "bgpPeerState": "pending", "amazonAddress": "169.254.255.1/30", "asn": 65000 } ], "customerRouterConfig": "\n\n 123\n 169.254.255.2/30\n 169.254.255.1/30\n 65000\n 0x123pK5_VBqv.UQ3kJ4123_\n 7224\n private\n\n", "amazonAddress": "169.254.255.1/30", "virtualInterfaceType": "private", "virtualInterfaceName": "VIF1A" } ``` + Para ver detalhes da API, consulte [AssociateVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/associate-virtual-interface.html) na *Referência de comandos da AWS CLI*. ### `confirm-connection` O código de exemplo a seguir mostra como usar `confirm-connection`. **AWS CLI** **Como confirmar a criação de uma conexão hospedada em uma interconexão** O comando `confirm-connection` a seguir confirma a criação de uma conexão hospedada em uma interconexão: ``` aws directconnect confirm-connection --connection-id dxcon-fg2wi7hy ``` Resultado: ``` { "connectionState": "pending" } ``` + Para ver detalhes da API, consulte [ConfirmConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/confirm-connection.html) na *Referência de comandos da AWS CLI*. ### `confirm-private-virtual-interface` O código de exemplo a seguir mostra como usar `confirm-private-virtual-interface`. **AWS CLI** **Como aceitar a propriedade de uma interface virtual privada** O comando `confirm-private-virtual-interface` a seguir aceita a propriedade de uma interface virtual privada criada por outro cliente: ``` aws directconnect confirm-private-virtual-interface --virtual-interface-id dxvif-fgy8orxu --virtual-gateway-id vgw-e4a47df9 ``` Resultado: ``` { "virtualInterfaceState": "pending" } ``` + Para ver detalhes da API, consulte [ConfirmPrivateVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/confirm-private-virtual-interface.html) na *Referência de comandos da AWS CLI*. ### `confirm-public-virtual-interface` O código de exemplo a seguir mostra como usar `confirm-public-virtual-interface`. **AWS CLI** **Como aceitar a propriedade de uma interface virtual pública** O comando `confirm-public-virtual-interface` a seguir aceita a propriedade de uma interface virtual pública criada por outro cliente: ``` aws directconnect confirm-public-virtual-interface --virtual-interface-id dxvif-fg9xo9vp ``` Resultado: ``` { "virtualInterfaceState": "verifying" } ``` + Para ver detalhes da API, consulte [ConfirmPublicVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/confirm-public-virtual-interface.html) na *Referência de comandos da AWS CLI*. ### `confirm-transit-virtual-interface` O código de exemplo a seguir mostra como usar `confirm-transit-virtual-interface`. **AWS CLI** **Como aceitar a propriedade de uma interface virtual em trânsito** O `confirm-transit-virtual-interface` a seguir aceita a propriedade de uma interface virtual de trânsito criada por outro cliente. ``` aws directconnect confirm-transit-virtual-interface \ --virtual-interface-id dxvif-fEXAMPLE \ --direct-connect-gateway-id 4112ccf9-25e9-4111-8237-b6c5dEXAMPLE ``` Resultado: ``` { "virtualInterfaceState": "pending" } ``` Para obter informações, consulte [Aceitar uma interface virtual hospedada](https://docs.aws.amazon.com/directconnect/latest/UserGuide/accepthostedvirtualinterface.html) no *Guia do usuário do AWS Direct Connect*. + Para ver detalhes da API, consulte [ConfirmTransitVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/confirm-transit-virtual-interface.html) na *Referência de comandos da AWS CLI*. ### `create-bgp-peer` O código de exemplo a seguir mostra como usar `create-bgp-peer`. **AWS CLI** **Para criar uma sessão de emparelhamento BGP IPv6** O exemplo a seguir cria uma sessão de emparelhamento BGP IPv6 em uma interface virtual privada `dxvif-fg1vuj3d`. Os endereços IPv6 de mesmo nível são alocados automaticamente pela Amazon. Comando: ``` aws directconnect create-bgp-peer --virtual-interface-id dxvif-fg1vuj3d --new-bgp-peer asn=64600,addressFamily=ipv6 ``` Resultado: ``` { "virtualInterface": { "virtualInterfaceState": "available", "asn": 65000, "vlan": 125, "customerAddress": "169.254.255.2/30", "ownerAccount": "123456789012", "connectionId": "dxcon-fguhmqlc", "addressFamily": "ipv4", "virtualGatewayId": "vgw-f9eb0c90", "virtualInterfaceId": "dxvif-fg1vuj3d", "authKey": "0xC_ukbCerl6EYA0example", "routeFilterPrefixes": [], "location": "EqDC2", "bgpPeers": [ { "bgpStatus": "down", "customerAddress": "169.254.255.2/30", "addressFamily": "ipv4", "authKey": "0xC_ukbCerl6EYA0uexample", "bgpPeerState": "available", "amazonAddress": "169.254.255.1/30", "asn": 65000 }, { "bgpStatus": "down", "customerAddress": "2001:db8:1100:2f0:0:1:9cb4:4216/125", "addressFamily": "ipv6", "authKey": "0xS27kAIU_VHPjjAexample", "bgpPeerState": "pending", "amazonAddress": "2001:db8:1100:2f0:0:1:9cb4:4211/125", "asn": 64600 } ], "customerRouterConfig": "\n\n 125\n 169.254.255.2/30\n 169.254.255.1/30\n 65000\n 0xC_ukbCerl6EYA0uexample\n 2001:db8:1100:2f0:0:1:9cb4:4216/125\n 2001:db8:1100:2f0:0:1:9cb4:4211/125\n 64600\n 0xS27kAIU_VHPjjAexample\n 7224\n private\n\n", "amazonAddress": "169.254.255.1/30", "virtualInterfaceType": "private", "virtualInterfaceName": "Test" } } ``` + Para ver detalhes da API, consulte [CreateBgpPeer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-bgp-peer.html) na *Referência de comandos da AWS CLI*. ### `create-connection` O código de exemplo a seguir mostra como usar `create-connection`. **AWS CLI** **Para criar uma conexão da sua rede com um local do AWS Direct Connect** O comando `create-connection` a seguir cria uma conexão da sua rede com um local do AWS Direct Connect: ``` aws directconnect create-connection --location TIVIT --bandwidth 1Gbps --connection-name "Connection to AWS" ``` Resultado: ``` { "ownerAccount": "123456789012", "connectionId": "dxcon-fg31dyv6", "connectionState": "requested", "bandwidth": "1Gbps", "location": "TIVIT", "connectionName": "Connection to AWS", "region": "sa-east-1" } ``` + Para ver detalhes da API, consulte [CreateConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-connection.html) na *Referência de comandos da AWS CLI*. ### `create-direct-connect-gateway-association-proposal` O código de exemplo a seguir mostra como usar `create-direct-connect-gateway-association-proposal`. **AWS CLI** **Para criar uma proposta para associar o gateway de trânsito ao gateway do Direct Connect** O exemplo `create-direct-connect-gateway-association-proposal` a seguir cria uma proposta que associa o gateway de trânsito especificado ao gateway do Direct Connect especificado. ``` aws directconnect create-direct-connect-gateway-association-proposal \ --direct-connect-gateway-id 11460968-4ac1-4fd3-bdb2-00599EXAMPLE \ --direct-connect-gateway-owner-account 111122223333 \ --gateway-id tgw-02f776b1a7EXAMPLE \ --add-allowed-prefixes-to-direct-connect-gateway cidr=192.168.1.0/30 ``` Resultado: ``` { "directConnectGatewayAssociationProposal": { "proposalId": "cb7f41cb-8128-43a5-93b1-dcaedEXAMPLE", "directConnectGatewayId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE", "directConnectGatewayOwnerAccount": "111122223333", "proposalState": "requested", "associatedGateway": { "id": "tgw-02f776b1a7EXAMPLE", "type": "transitGateway", "ownerAccount": "111122223333", "region": "us-east-1" }, "requestedAllowedPrefixesToDirectConnectGateway": [ { "cidr": "192.168.1.0/30" } ] } } ``` Para obter mais informações, consulte [Criar uma proposta de associação a um gateway de trânsito](https://docs.aws.amazon.com/directconnect/latest/UserGuide/multi-account-associate-tgw.html#multi-account-tgw-create-proposal) no *Guia do usuário do AWS Direct Connect*. + Para ver detalhes da API, consulte [CreateDirectConnectGatewayAssociationProposal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-direct-connect-gateway-association-proposal.html) na *Referência de comandos da AWS CLI*. ### `create-direct-connect-gateway-association` O código de exemplo a seguir mostra como usar `create-direct-connect-gateway-association`. **AWS CLI** **Como associar um gateway privado virtual a um gateway do Direct Connect** O exemplo a seguir associa o gateway privado virtual `vgw-6efe725e` ao gateway Direct Connect `5f294f92-bafb-4011-916d-9b0bexample`. Você deve executar o comando na região em que o gateway privado virtual está localizado. Comando: ``` aws directconnect create-direct-connect-gateway-association --direct-connect-gateway-id 5f294f92-bafb-4011-916d-9b0bexample --virtual-gateway-id vgw-6efe725e ``` Resultado: ``` { "directConnectGatewayAssociation": { "associationState": "associating", "virtualGatewayOwnerAccount": "123456789012", "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample", "virtualGatewayId": "vgw-6efe725e", "virtualGatewayRegion": "us-east-2" } } ``` + Para ver detalhes da API, consulte [CreateDirectConnectGatewayAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-direct-connect-gateway-association.html) na *Referência de comandos da AWS CLI*. ### `create-direct-connect-gateway` O código de exemplo a seguir mostra como usar `create-direct-connect-gateway`. **AWS CLI** **Para criar um gateway Direct Connect** O exemplo a seguir cria um gateway do Direct Connect com o nome `DxGateway1`. Comando: ``` aws directconnect create-direct-connect-gateway --direct-connect-gateway-name "DxGateway1" ``` Resultado: ``` { "directConnectGateway": { "amazonSideAsn": 64512, "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bdexample", "ownerAccount": "123456789012", "directConnectGatewayName": "DxGateway1", "directConnectGatewayState": "available" } } ``` + Para ver detalhes da API, consulte [CreateDirectConnectGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-direct-connect-gateway.html) na *Referência de comandos da AWS CLI*. ### `create-interconnect` O código de exemplo a seguir mostra como usar `create-interconnect`. **AWS CLI** **Para criar uma interconexão entre a rede de um parceiro e a AWS** O comando `create-interconnect` a seguir cria uma nova interconexão entre uma rede de parceiro do AWS Direct Connect e um local específico do AWS Direct Connect: ``` aws directconnect create-interconnect --interconnect-name "1G Interconnect to AWS" --bandwidth 1Gbps --location TIVIT ``` Resultado: ``` { "region": "sa-east-1", "bandwidth": "1Gbps", "location": "TIVIT", "interconnectName": "1G Interconnect to AWS", "interconnectId": "dxcon-fgktov66", "interconnectState": "requested" } ``` + Para ver detalhes da API, consulte [CreateInterconnect](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-interconnect.html) na *Referência de comandos da AWS CLI*. ### `create-lag` O código de exemplo a seguir mostra como usar `create-lag`. **AWS CLI** **Para criar um LAG com novas conexões** O exemplo a seguir cria um LAG e solicita duas novas conexões com o AWS Direct Connect para o LAG com uma largura de banda de 1 Gbps. Comando: ``` aws directconnect create-lag --location CSVA1 --number-of-connections 2 --connections-bandwidth 1Gbps --lag-name 1GBLag ``` Resultado: ``` { "awsDevice": "CSVA1-23u8tlpaz8iks", "numberOfConnections": 2, "lagState": "pending", "ownerAccount": "123456789012", "lagName": "1GBLag", "connections": [ { "ownerAccount": "123456789012", "connectionId": "dxcon-ffqr6x5q", "lagId": "dxlag-ffjhj9lx", "connectionState": "requested", "bandwidth": "1Gbps", "location": "CSVA1", "connectionName": "Requested Connection 1 for Lag dxlag-ffjhj9lx", "region": "us-east-1" }, { "ownerAccount": "123456789012", "connectionId": "dxcon-fflqyj95", "lagId": "dxlag-ffjhj9lx", "connectionState": "requested", "bandwidth": "1Gbps", "location": "CSVA1", "connectionName": "Requested Connection 2 for Lag dxlag-ffjhj9lx", "region": "us-east-1" } ], "lagId": "dxlag-ffjhj9lx", "minimumLinks": 0, "connectionsBandwidth": "1Gbps", "region": "us-east-1", "location": "CSVA1" } ``` **Para criar um LAG usando uma conexão existente** O exemplo a seguir cria um LAG a partir de uma conexão existente em sua conta e solicita uma segunda nova conexão para o LAG com a mesma largura de banda e localização da conexão existente. Comando: ``` aws directconnect create-lag --location EqDC2 --number-of-connections 2 --connections-bandwidth 1Gbps --lag-name 2ConnLAG --connection-id dxcon-fgk145dr ``` Resultado: ``` { "awsDevice": "EqDC2-4h6ce2r1bes6", "numberOfConnections": 2, "lagState": "pending", "ownerAccount": "123456789012", "lagName": "2ConnLAG", "connections": [ { "ownerAccount": "123456789012", "connectionId": "dxcon-fh6ljcvo", "lagId": "dxlag-fhccu14t", "connectionState": "requested", "bandwidth": "1Gbps", "location": "EqDC2", "connectionName": "Requested Connection 1 for Lag dxlag-fhccu14t", "region": "us-east-1" }, { "ownerAccount": "123456789012", "connectionId": "dxcon-fgk145dr", "lagId": "dxlag-fhccu14t", "connectionState": "down", "bandwidth": "1Gbps", "location": "EqDC2", "connectionName": "VAConn1", "region": "us-east-1" } ], "lagId": "dxlag-fhccu14t", "minimumLinks": 0, "connectionsBandwidth": "1Gbps", "region": "us-east-1", "location": "EqDC2" } ``` + Para ver detalhes da API, consulte [CreateLag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-lag.html) na *Referência de comandos da AWS CLI*. ### `create-private-virtual-interface` O código de exemplo a seguir mostra como usar `create-private-virtual-interface`. **AWS CLI** **Para criar uma interface virtual privada** O comando `create-private-virtual-interface` a seguir cria uma interface virtual privada: ``` aws directconnect create-private-virtual-interface --connection-id dxcon-ffjrkx17 --new-private-virtual-interface virtualInterfaceName=PrivateVirtualInterface,vlan=101,asn=65000,authKey=asdf34example,amazonAddress=192.168.1.1/30,customerAddress=192.168.1.2/30,virtualGatewayId=vgw-aba37db6 ``` Resultado: ``` { "virtualInterfaceState": "pending", "asn": 65000, "vlan": 101, "customerAddress": "192.168.1.2/30", "ownerAccount": "123456789012", "connectionId": "dxcon-ffjrkx17", "virtualGatewayId": "vgw-aba37db6", "virtualInterfaceId": "dxvif-ffhhk74f", "authKey": "asdf34example", "routeFilterPrefixes": [], "location": "TIVIT", "customerRouterConfig": "\n\n 101\n 192.168.1.2/30\n 192.168.1.1/30\n 65000\n asdf34example\n 7224\n private\n\n", "amazonAddress": "192.168.1.1/30", "virtualInterfaceType": "private", "virtualInterfaceName": "PrivateVirtualInterface" } ``` + Para ver detalhes da API, consulte [CreatePrivateVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-private-virtual-interface.html) na *Referência de comandos da AWS CLI*. ### `create-public-virtual-interface` O código de exemplo a seguir mostra como usar `create-public-virtual-interface`. **AWS CLI** **Para criar uma interface virtual pública** O comando `create-public-virtual-interface` a seguir cria uma interface virtual pública: ``` aws directconnect create-public-virtual-interface --connection-id dxcon-ffjrkx17 --new-public-virtual-interface virtualInterfaceName=PublicVirtualInterface,vlan=2000,asn=65000,authKey=asdf34example,amazonAddress=203.0.113.1/30,customerAddress=203.0.113.2/30,routeFilterPrefixes=[{cidr=203.0.113.0/30},{cidr=203.0.113.4/30}] ``` Resultado: ``` { "virtualInterfaceState": "verifying", "asn": 65000, "vlan": 2000, "customerAddress": "203.0.113.2/30", "ownerAccount": "123456789012", "connectionId": "dxcon-ffjrkx17", "virtualInterfaceId": "dxvif-fgh0hcrk", "authKey": "asdf34example", "routeFilterPrefixes": [ { "cidr": "203.0.113.0/30" }, { "cidr": "203.0.113.4/30" } ], "location": "TIVIT", "customerRouterConfig": "\n\n 2000\n 203.0.113.2/30\n 203.0.113.1/30\n 65000\n asdf34example\n 7224\n public\n\n", "amazonAddress": "203.0.113.1/30", "virtualInterfaceType": "public", "virtualInterfaceName": "PublicVirtualInterface" } ``` + Para ver detalhes da API, consulte [CreatePublicVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-public-virtual-interface.html) na *Referência de comandos da AWS CLI*. ### `create-transit-virtual-interface` O código de exemplo a seguir mostra como usar `create-transit-virtual-interface`. **AWS CLI** **Para criar uma interface virtual de trânsito** O exemplo `create-transit-virtual-interface` a seguir cria uma interface virtual de trânsito para a conexão especificada. ``` aws directconnect create-transit-virtual-interface \ --connection-id dxlag-fEXAMPLE \ --new-transit-virtual-interface "virtualInterfaceName=Example Transit Virtual Interface,vlan=126,asn=65110,mtu=1500,authKey=0xzxgA9YoW9h58u8SvEXAMPLE,amazonAddress=192.168.1.1/30,customerAddress=192.168.1.2/30,addressFamily=ipv4,directConnectGatewayId=8384da05-13ce-4a91-aada-5a1baEXAMPLE,tags=[{key=Tag,value=Example}]" ``` Resultado: ``` { "virtualInterface": { "ownerAccount": "1111222233333", "virtualInterfaceId": "dxvif-fEXAMPLE", "location": "loc1", "connectionId": "dxlag-fEXAMPLE", "virtualInterfaceType": "transit", "virtualInterfaceName": "Example Transit Virtual Interface", "vlan": 126, "asn": 65110, "amazonSideAsn": 4200000000, "authKey": "0xzxgA9YoW9h58u8SEXAMPLE", "amazonAddress": "192.168.1.1/30", "customerAddress": "192.168.1.2/30", "addressFamily": "ipv4", "virtualInterfaceState": "pending", "customerRouterConfig": "\n\n 126\n 192.168.1.2/30\n 192.168.1.1/30\n 65110\n 0xzxgA9YoW9h58u8SvOmXRTw\n 4200000000\n transit\n\n", "mtu": 1500, "jumboFrameCapable": true, "virtualGatewayId": "", "directConnectGatewayId": "8384da05-13ce-4a91-aada-5a1baEXAMPLE", "routeFilterPrefixes": [], "bgpPeers": [ { "bgpPeerId": "dxpeer-EXAMPLE", "asn": 65110, "authKey": "0xzxgA9YoW9h58u8SEXAMPLE", "addressFamily": "ipv4", "amazonAddress": "192.168.1.1/30", "customerAddress": "192.168.1.2/30", "bgpPeerState": "pending", "bgpStatus": "down", "awsDeviceV2": "loc1-26wz6vEXAMPLE" } ], "region": "sa-east-1", "awsDeviceV2": "loc1-26wz6vEXAMPLE", "tags": [ { "key": "Tag", "value": "Example" } ] } } ``` Para obter informações, consulte [Criar uma interface virtual de gateway do Direct Connect](https://docs.aws.amazon.com/directconnect/latest/UserGuide/create-vif.html#create-transit-vif) no *Guia do usuário do AWS Direct Connect*. + Para ver detalhes da API, consulte [CreateTransitVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-transit-virtual-interface.html) na *Referência de comandos da AWS CLI*. ### `delete-bgp-peer` O código de exemplo a seguir mostra como usar `delete-bgp-peer`. **AWS CLI** **Para excluir um pareamento BGP de uma interface virtual** O exemplo a seguir exclui o peer IPv6 BGP da interface virtual `dxvif-fg1vuj3d`. Comando: ``` aws directconnect delete-bgp-peer --virtual-interface-id dxvif-fg1vuj3d --asn 64600 --customer-address 2001:db8:1100:2f0:0:1:9cb4:4216/125 ``` Resultado: ``` { "virtualInterface": { "virtualInterfaceState": "available", "asn": 65000, "vlan": 125, "customerAddress": "169.254.255.2/30", "ownerAccount": "123456789012", "connectionId": "dxcon-fguhmqlc", "addressFamily": "ipv4", "virtualGatewayId": "vgw-f9eb0c90", "virtualInterfaceId": "dxvif-fg1vuj3d", "authKey": "0xC_ukbCerl6EYA0example", "routeFilterPrefixes": [], "location": "EqDC2", "bgpPeers": [ { "bgpStatus": "down", "customerAddress": "169.254.255.2/30", "addressFamily": "ipv4", "authKey": "0xC_ukbCerl6EYA0uexample", "bgpPeerState": "available", "amazonAddress": "169.254.255.1/30", "asn": 65000 }, { "bgpStatus": "down", "customerAddress": "2001:db8:1100:2f0:0:1:9cb4:4216/125", "addressFamily": "ipv6", "authKey": "0xS27kAIU_VHPjjAexample", "bgpPeerState": "deleting", "amazonAddress": "2001:db8:1100:2f0:0:1:9cb4:4211/125", "asn": 64600 } ], "customerRouterConfig": "\n\n 125\n 169.254.255.2/30\n 169.254.255.1/30\n 65000\n 0xC_ukbCerl6EYA0example\n 7224\n private\n\n", "amazonAddress": "169.254.255.1/30", "virtualInterfaceType": "private", "virtualInterfaceName": "Test" } } ``` + Para ver detalhes da API, consulte [DeleteBgpPeer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/delete-bgp-peer.html) na *Referência de comandos da AWS CLI*. ### `delete-connection` O código de exemplo a seguir mostra como usar `delete-connection`. **AWS CLI** **Para excluir uma conexão** O comando `delete-connection` a seguir exclui a conexão especificada. ``` aws directconnect delete-connection --connection-id dxcon-fg31dyv6 ``` Resultado: ``` { "ownerAccount": "123456789012", "connectionId": "dxcon-fg31dyv6", "connectionState": "deleted", "bandwidth": "1Gbps", "location": "TIVIT", "connectionName": "Connection to AWS", "region": "sa-east-1" } ``` + Para ver detalhes da API, consulte [DeleteConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/delete-connection.html) na *Referência de comandos da AWS CLI*. ### `delete-direct-connect-gateway-association` O código de exemplo a seguir mostra como usar `delete-direct-connect-gateway-association`. **AWS CLI** **Para excluir uma associação de gateway do Direct Connect** O exemplo `delete-direct-connect-gateway-association` a seguir exclui a associação do gateway do Direct Connect com um gateway de trânsito que tem o ID de associação especificado. ``` aws directconnect delete-direct-connect-gateway-association --association-id be85116d-46eb-4b43-a27a-da0c2ad648de ``` Resultado: ``` { "directConnectGatewayAssociation": { "directConnectGatewayId": "11460968-4ac1-4fd3-bdb2-00599EXAMPlE", "directConnectGatewayOwnerAccount": "123456789012", "associationState": "disassociating", "associatedGateway": { "id": "tgw-095b3b0b54EXAMPLE", "type": "transitGateway", "ownerAccount": "123456789012", "region": "us-east-1" }, "associationId": " be85116d-46eb-4b43-a27a-da0c2ad648deEXAMPLE ", "allowedPrefixesToDirectConnectGateway": [ { "cidr": "192.0.1.0/28" } ] } } ``` Para obter mais informações, consulte [Associar e desassociar gateways de trânsito](https://docs.aws.amazon.com/directconnect/latest/UserGuide/direct-connect-transit-gateways.html#associate-tgw-with-direct-connect-gateway) no *Guia do usuário do AWS Direct Connect*. + Para ver detalhes da API, consulte [DeleteDirectConnectGatewayAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/delete-direct-connect-gateway-association.html) na *Referência de comandos da AWS CLI*. ### `delete-direct-connect-gateway` O código de exemplo a seguir mostra como usar `delete-direct-connect-gateway`. **AWS CLI** **Para excluir um gateway do Direct Connect** O exemplo a seguir exclui o gateway `5f294f92-bafb-4011-916d-9b0bexample` do Direct Connect. Comando: ``` aws directconnect delete-direct-connect-gateway --direct-connect-gateway-id 5f294f92-bafb-4011-916d-9b0bexample ``` Resultado: ``` { "directConnectGateway": { "amazonSideAsn": 64512, "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample", "ownerAccount": "123456789012", "directConnectGatewayName": "DxGateway1", "directConnectGatewayState": "deleting" } } ``` + Para ver detalhes da API, consulte [DeleteDirectConnectGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/delete-direct-connect-gateway.html) na *Referência de comandos da AWS CLI*. ### `delete-interconnect` O código de exemplo a seguir mostra como usar `delete-interconnect`. **AWS CLI** **Para excluir uma interconexão** O comando `delete-interconnect` a seguir exclui a interconexão especificada: ``` aws directconnect delete-interconnect --interconnect-id dxcon-fgktov66 ``` Resultado: ``` { "interconnectState": "deleted" } ``` + Para ver detalhes da API, consulte [DeleteInterconnect](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/delete-interconnect.html) na *Referência de comandos da AWS CLI*. ### `delete-lag` O código de exemplo a seguir mostra como usar `delete-lag`. **AWS CLI** **Para excluir um LAG** O exemplo a seguir exclui o LAG especificado. Comando: ``` aws directconnect delete-lag --lag-id dxlag-ffrhowd9 ``` Resultado: ``` { "awsDevice": "EqDC2-4h6ce2r1bes6", "numberOfConnections": 0, "lagState": "deleted", "ownerAccount": "123456789012", "lagName": "TestLAG", "connections": [], "lagId": "dxlag-ffrhowd9", "minimumLinks": 0, "connectionsBandwidth": "1Gbps", "region": "us-east-1", "location": "EqDC2" } ``` + Para ver detalhes da API, consulte [DeleteLag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/delete-lag.html) na *Referência de comandos da AWS CLI*. ### `delete-virtual-interface` O código de exemplo a seguir mostra como usar `delete-virtual-interface`. **AWS CLI** **Para excluir uma interface virtual** O comando `delete-virtual-interface` a seguir exclui a interface virtual especificada: ``` aws directconnect delete-virtual-interface --virtual-interface-id dxvif-ffhhk74f ``` Resultado: ``` { "virtualInterfaceState": "deleting" } ``` + Para ver detalhes da API, consulte [DeleteVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/delete-virtual-interface.html) na *Referência de comandos da AWS CLI*. ### `describe-connection-loa` O código de exemplo a seguir mostra como usar `describe-connection-loa`. **AWS CLI** **Para descrever sua LOA-CFA para uma conexão usando Linux ou Mac OS X** O exemplo a seguir descreve sua LOA-CFA para conexão `dxcon-fh6ayh1d`. O conteúdo da LOA-CFA é codificado em base64. Esse comando usa os parâmetros `--output` e `--query` para controlar a saída e extrair o conteúdo da estrutura `loaContent`. A parte final do comando decodifica o conteúdo usando o utilitário `base64` e envia a saída para um arquivo PDF. ``` aws directconnect describe-connection-loa --connection-id dxcon-fh6ayh1d --output text --query loa.loaContent|base64 --decode > myLoaCfa.pdf ``` **Para descrever sua LOA-CFA para uma conexão usando o Windows** O exemplo anterior requer o uso do utilitário `base64` para decodificar a saída. Em um computador Windows, você pode usar `certutil` em vez disso. No exemplo a seguir, o primeiro comando descreve sua LOA-CFA para a conexão `dxcon-fh6ayh1d` e usa os parâmetros `--output` e `--query` e para controlar a saída e extrair o conteúdo da estrutura `loaContent` em um arquivo chamado `myLoaCfa.base64`. O segundo comando usa o utilitário `certutil` para decodificar o arquivo e enviar a saída a um arquivo PDF. ``` aws directconnect describe-connection-loa --connection-id dxcon-fh6ayh1d --output text --query loa.loaContent > myLoaCfa.base64 ``` ``` certutil -decode myLoaCfa.base64 myLoaCfa.pdf ``` Para mais informações sobre controlar a saída da AWS CLI, consulte [Controlar a saída do comando da AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/controlling-output.html) no *Guia do usuário da AWS Command Line Interface*. + Para ver detalhes da API, consulte [DescribeConnectionLoa](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-connection-loa.html) na *Referência de comandos da AWS CLI*. ### `describe-connections-on-interconnect` O código de exemplo a seguir mostra como usar `describe-connections-on-interconnect`. **AWS CLI** **Para listar conexões em uma interconexão** O comando `describe-connections-on-interconnect` a seguir lista as conexões que foram provisionadas na interconexão fornecida: ``` aws directconnect describe-connections-on-interconnect --interconnect-id dxcon-fgktov66 ``` Resultado: ``` { "connections": [ { "partnerName": "TIVIT", "vlan": 101, "ownerAccount": "123456789012", "connectionId": "dxcon-ffzc51m1", "connectionState": "ordering", "bandwidth": "500Mbps", "location": "TIVIT", "connectionName": "mydcinterconnect", "region": "sa-east-1" } ] } ``` + Para ver detalhes da API, consulte [DescribeConnectionsOnInterconnect](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-connections-on-interconnect.html) na *Referência de comandos da AWS CLI*. ### `describe-connections` O código de exemplo a seguir mostra como usar `describe-connections`. **AWS CLI** **Para listar todas as conexões na região atual** O comando `describe-connections` a seguir lista todas as conexões na região atual: ``` aws directconnect describe-connections ``` Resultado: ``` { "connections": [ { "awsDevice": "EqDC2-123h49s71dabc", "ownerAccount": "123456789012", "connectionId": "dxcon-fguhmqlc", "lagId": "dxlag-ffrz71kw", "connectionState": "down", "bandwidth": "1Gbps", "location": "EqDC2", "connectionName": "My_Connection", "loaIssueTime": 1491568964.0, "region": "us-east-1" } ] } ``` + Para ver detalhes da API, consulte [DescribeConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-connections.html) na *Referência de comandos da AWS CLI*. ### `describe-direct-connect-gateway-association-proposals` O código de exemplo a seguir mostra como usar `describe-direct-connect-gateway-association-proposals`. **AWS CLI** **Para descrever suas propostas de associação de gateway do Direct Connect** O exemplo `describe-direct-connect-gateway-association-proposals` a seguir exibe detalhes sobre suas propostas de associação de gateway do Direct Connect. ``` aws directconnect describe-direct-connect-gateway-association-proposals ``` Resultado: ``` { "directConnectGatewayAssociationProposals": [ { "proposalId": "c2ede9b4-bbc6-4d33-923c-bc4feEXAMPLE", "directConnectGatewayId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE", "directConnectGatewayOwnerAccount": "111122223333", "proposalState": "requested", "associatedGateway": { "id": "tgw-02f776b1a7EXAMPLE", "type": "transitGateway", "ownerAccount": "111122223333", "region": "us-east-1" }, "existingAllowedPrefixesToDirectConnectGateway": [ { "cidr": "192.168.2.0/30" }, { "cidr": "192.168.1.0/30" } ], "requestedAllowedPrefixesToDirectConnectGateway": [ { "cidr": "192.168.1.0/30" } ] }, { "proposalId": "cb7f41cb-8128-43a5-93b1-dcaedEXAMPLE", "directConnectGatewayId": "11560968-4ac1-4fd3-bcb2-00599EXAMPLE", "directConnectGatewayOwnerAccount": "111122223333", "proposalState": "accepted", "associatedGateway": { "id": "tgw-045776b1a7EXAMPLE", "type": "transitGateway", "ownerAccount": "111122223333", "region": "us-east-1" }, "existingAllowedPrefixesToDirectConnectGateway": [ { "cidr": "192.168.4.0/30" }, { "cidr": "192.168.5.0/30" } ], "requestedAllowedPrefixesToDirectConnectGateway": [ { "cidr": "192.168.5.0/30" } ] } ] } ``` Para obter mais informações, consulte [Associar e desassociar gateways de trânsito](https://docs.aws.amazon.com/directconnect/latest/UserGuide/direct-connect-transit-gateways.html#associate-tgw-with-direct-connect-gateway) no *Guia do usuário do AWS Direct Connect*. + Para ver detalhes da API, consulte [DescribeDirectConnectGatewayAssociationProposals](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-direct-connect-gateway-association-proposals.html) na *Referência de comandos da AWS CLI*. ### `describe-direct-connect-gateway-associations` O código de exemplo a seguir mostra como usar `describe-direct-connect-gateway-associations`. **AWS CLI** **Para descrever associações de gateway do Direct Connect** O exemplo a seguir descreve todas as associações com o gateway do `5f294f92-bafb-4011-916d-9b0bexample` Direct Connect. Comando: ``` aws directconnect describe-direct-connect-gateway-associations --direct-connect-gateway-id 5f294f92-bafb-4011-916d-9b0bexample ``` Resultado: ``` { "nextToken": "eyJ2IjoxLCJzIjoxLCJpIjoiOU83OTFodzdycnZCbkN4MExHeHVwQT09IiwiYyI6InIxTEN0UEVHV0I1UFlkaWFnNlUxanJkRWF6eW1iOElHM0FRVW1MdHRJK0dxcnN1RWtvcFBKWFE2ZjRNRGdGTkhCa0tDZmVINEtZOEYwZ0dEYWZpbmU0ZnZMYVhKRjdXRVdENmdQZ1Y4d2w0PSJ9", "directConnectGatewayAssociations": [ { "associationState": "associating", "virtualGatewayOwnerAccount": "123456789012", "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample", "virtualGatewayId": "vgw-6efe725e", "virtualGatewayRegion": "us-east-2" }, { "associationState": "disassociating", "virtualGatewayOwnerAccount": "123456789012", "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample", "virtualGatewayId": "vgw-ebaa27db", "virtualGatewayRegion": "us-east-2" } ] } ``` + Para ver detalhes da API, consulte [DescribeDirectConnectGatewayAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-direct-connect-gateway-associations.html) na *Referência de comandos da AWS CLI*. ### `describe-direct-connect-gateway-attachments` O código de exemplo a seguir mostra como usar `describe-direct-connect-gateway-attachments`. **AWS CLI** **Para descrever anexos de gateway do Direct Connect** O exemplo a seguir descreve as interfaces virtuais conectadas ao gateway `5f294f92-bafb-4011-916d-9b0bexample` do Direct Connect. Comando: ``` aws directconnect describe-direct-connect-gateway-attachments --direct-connect-gateway-id 5f294f92-bafb-4011-916d-9b0bexample ``` Resultado: ``` { "directConnectGatewayAttachments": [ { "virtualInterfaceOwnerAccount": "123456789012", "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample", "virtualInterfaceRegion": "us-east-2", "attachmentState": "attaching", "virtualInterfaceId": "dxvif-fg9zyabc" } ], "nextToken": "eyJ2IjoxLCJzIjoxLCJpIjoibEhXdlNpUXF5RzhoL1JyUW52SlV2QT09IiwiYyI6Im5wQjFHQ0RyQUdRS3puNnNXcUlINCtkTTA4dTk3KzBiU0xtb05JQmlaczZ6NXRIYmk3c3VESUxFTTd6a2FzVHM0VTFwaGJkZGNxTytqWmQ3QzMzOGRQaTVrTThrOG1zelRsV3gyMWV3VTNFPSJ9" } ``` + Para ver detalhes da API, consulte [DescribeDirectConnectGatewayAttachments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-direct-connect-gateway-attachments.html) na *Referência de comandos da AWS CLI*. ### `describe-direct-connect-gateways` O código de exemplo a seguir mostra como usar `describe-direct-connect-gateways`. **AWS CLI** **Para descrever seus gateways do Direct Connect** O exemplo a seguir descreve todos os seus gateways do Direct Connect. Comando: ``` aws directconnect describe-direct-connect-gateways ``` Resultado: ``` { "directConnectGateways": [ { "amazonSideAsn": 64512, "directConnectGatewayId": "cf68415c-f4ae-48f2-87a7-3b52cexample", "ownerAccount": "123456789012", "directConnectGatewayName": "DxGateway2", "directConnectGatewayState": "available" }, { "amazonSideAsn": 64512, "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bdexample", "ownerAccount": "123456789012", "directConnectGatewayName": "DxGateway1", "directConnectGatewayState": "available" } ] } ``` + Para ver detalhes da API, consulte [DescribeDirectConnectGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-direct-connect-gateways.html) na *Referência de comandos da AWS CLI*. ### `describe-hosted-connections` O código de exemplo a seguir mostra como usar `describe-hosted-connections`. **AWS CLI** **Para listar conexões em uma interconexão** O exemplo a seguir lista as conexões que foram provisionadas na interconexão fornecida. Comando: ``` aws directconnect describe-hosted-connections --connection-id dxcon-fgktov66 ``` Resultado: ``` { "connections": [ { "partnerName": "TIVIT", "vlan": 101, "ownerAccount": "123456789012", "connectionId": "dxcon-ffzc51m1", "connectionState": "ordering", "bandwidth": "500Mbps", "location": "TIVIT", "connectionName": "mydcinterconnect", "region": "sa-east-1" } ] } ``` + Para ver detalhes da API, consulte [DescribeHostedConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-hosted-connections.html) na *Referência de comandos da AWS CLI*. ### `describe-interconnect-loa` O código de exemplo a seguir mostra como usar `describe-interconnect-loa`. **AWS CLI** **Para descrever sua LOA-CFA para uma interconexão usando Linux ou Mac OS X** O exemplo a seguir descreve sua LOA-CFA para a interconexão `dxcon-fh6ayh1d`. O conteúdo da LOA-CFA é codificado em base64. Esse comando usa os parâmetros `--output` e `--query` para controlar a saída e extrair o conteúdo da estrutura `loaContent`. A parte final do comando decodifica o conteúdo usando o utilitário `base64` e envia a saída para um arquivo PDF. ``` aws directconnect describe-interconnect-loa --interconnect-id dxcon-fh6ayh1d --output text --query loa.loaContent|base64 --decode > myLoaCfa.pdf ``` **Para descrever sua LOA-CFA para uma interconexão usando o Windows** O exemplo anterior requer o uso do utilitário `base64` para decodificar a saída. Em um computador Windows, você pode usar `certutil` em vez disso. No exemplo a seguir, o primeiro comando descreve sua LOA-CFA para a interconexão `dxcon-fh6ayh1d` e usa os parâmetros `--output` e `--query` e para controlar a saída e extrair o conteúdo da estrutura `loaContent` em um arquivo chamado `myLoaCfa.base64`. O segundo comando usa o utilitário `certutil` para decodificar o arquivo e enviar a saída a um arquivo PDF. ``` aws directconnect describe-interconnect-loa --interconnect-id dxcon-fh6ayh1d --output text --query loa.loaContent > myLoaCfa.base64 ``` ``` certutil -decode myLoaCfa.base64 myLoaCfa.pdf ``` Para mais informações sobre controlar a saída da AWS CLI, consulte [Controlar a saída do comando da AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/controlling-output.html) no *Guia do usuário da AWS Command Line Interface*. + Para ver detalhes da API, consulte [DescribeInterconnectLoa](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-interconnect-loa.html) na *Referência de comandos da AWS CLI*. ### `describe-interconnects` O código de exemplo a seguir mostra como usar `describe-interconnects`. **AWS CLI** **Para listar as interconexões** O comando `describe-interconnects` a seguir lista as interconexões pertencentes à sua conta da AWS: ``` aws directconnect describe-interconnects ``` Resultado: ``` { "interconnects": [ { "region": "sa-east-1", "bandwidth": "1Gbps", "location": "TIVIT", "interconnectName": "1G Interconnect to AWS", "interconnectId": "dxcon-fgktov66", "interconnectState": "down" } ] } ``` + Para ver detalhes da API, consulte [DescribeInterconnects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-interconnects.html) na *Referência de comandos da AWS CLI*. ### `describe-lags` O código de exemplo a seguir mostra como usar `describe-lags`. **AWS CLI** **Para descrever seus LAGs** O comando a seguir descreve todos os seus LAGs da região atual. Comando: ``` aws directconnect describe-lags ``` Resultado: ``` { "lags": [ { "awsDevice": "EqDC2-19y7z3m17xpuz", "numberOfConnections": 2, "lagState": "down", "ownerAccount": "123456789012", "lagName": "DA-LAG", "connections": [ { "ownerAccount": "123456789012", "connectionId": "dxcon-ffnikghc", "lagId": "dxlag-fgsu9erb", "connectionState": "requested", "bandwidth": "10Gbps", "location": "EqDC2", "connectionName": "Requested Connection 1 for Lag dxlag-fgsu9erb", "region": "us-east-1" }, { "ownerAccount": "123456789012", "connectionId": "dxcon-fglgbdea", "lagId": "dxlag-fgsu9erb", "connectionState": "requested", "bandwidth": "10Gbps", "location": "EqDC2", "connectionName": "Requested Connection 2 for Lag dxlag-fgsu9erb", "region": "us-east-1" } ], "lagId": "dxlag-fgsu9erb", "minimumLinks": 0, "connectionsBandwidth": "10Gbps", "region": "us-east-1", "location": "EqDC2" } ] } ``` + Para ver detalhes da API, consulte [DescribeLags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-lags.html) na *Referência de comandos da AWS CLI*. ### `describe-loa` O código de exemplo a seguir mostra como usar `describe-loa`. **AWS CLI** **Para descrever sua LOA-CFA para uma conexão usando Linux ou Mac OS X** O exemplo a seguir descreve sua LOA-CFA para conexão `dxcon-fh6ayh1d`. O conteúdo da LOA-CFA é codificado em base64. Esse comando usa os parâmetros `--output` e `--query` para controlar a saída e extrair o conteúdo da estrutura `loaContent`. A parte final do comando decodifica o conteúdo usando o utilitário `base64` e envia a saída para um arquivo PDF. ``` aws directconnect describe-loa --connection-id dxcon-fh6ayh1d --output text --query loa.loaContent|base64 --decode > myLoaCfa.pdf ``` **Para descrever sua LOA-CFA para uma conexão usando o Windows** O exemplo anterior requer o uso do utilitário `base64` para decodificar a saída. Em um computador Windows, você pode usar `certutil` em vez disso. No exemplo a seguir, o primeiro comando descreve sua LOA-CFA para a conexão `dxcon-fh6ayh1d` e usa os parâmetros `--output` e `--query` e para controlar a saída e extrair o conteúdo da estrutura `loaContent` em um arquivo chamado `myLoaCfa.base64`. O segundo comando usa o utilitário `certutil` para decodificar o arquivo e enviar a saída a um arquivo PDF. ``` aws directconnect describe-loa --connection-id dxcon-fh6ayh1d --output text --query loa.loaContent > myLoaCfa.base64 ``` ``` certutil -decode myLoaCfa.base64 myLoaCfa.pdf ``` Para mais informações sobre controlar a saída da AWS CLI, consulte [Controlar a saída do comando da AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/controlling-output.html) no *Guia do usuário da AWS Command Line Interface*. + Para ver detalhes da API, consulte [DescribeLoa](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-loa.html) na *Referência de comandos da AWS CLI*. ### `describe-locations` O código de exemplo a seguir mostra como usar `describe-locations`. **AWS CLI** **Para listar parceiros e locais do AWS Direct Connect** O comando `describe-locations` a seguir lista os parceiros e locais do AWS Direct Connect na região atual: ``` aws directconnect describe-locations ``` Resultado: ``` { "locations": [ { "locationName": "NAP do Brasil, Barueri, Sao Paulo", "locationCode": "TNDB" }, { "locationName": "Tivit - Site Transamerica (Sao Paulo)", "locationCode": "TIVIT" } ] } ``` + Para ver detalhes da API, consulte [DescribeLocations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-locations.html) na *Referência de comandos da AWS CLI*. ### `describe-tags` O código de exemplo a seguir mostra como usar `describe-tags`. **AWS CLI** **Para descrever tags para seus recursos do AWS Direct Connect** O comando a seguir descreve as tags da conexão `dxcon-abcabc12`. Comando: ``` aws directconnect describe-tags --resource-arns arn:aws:directconnect:us-east-1:123456789012:dxcon/dxcon-abcabc12 ``` Resultado: ``` { "resourceTags": [ { "resourceArn": "arn:aws:directconnect:us-east-1:123456789012:dxcon/dxcon-abcabc12", "tags": [ { "value": "VAConnection", "key": "Name" } ] } ] } ``` + Para ver detalhes da API, consulte [DescribeTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-tags.html) na *Referência de comandos da AWS CLI*. ### `describe-virtual-gateways` O código de exemplo a seguir mostra como usar `describe-virtual-gateways`. **AWS CLI** **Para listar gateways privados virtuais** O comando `describe-virtual-gateways` a seguir lista gateways privados virtuais pertencentes à sua conta da AWS: ``` aws directconnect describe-virtual-gateways ``` Resultado: ``` { "virtualGateways": [ { "virtualGatewayId": "vgw-aba37db6", "virtualGatewayState": "available" } ] } ``` + Para ver detalhes da API, consulte [DescribeVirtualGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-virtual-gateways.html) na *Referência de comandos da AWS CLI*. ### `describe-virtual-interfaces` O código de exemplo a seguir mostra como usar `describe-virtual-interfaces`. **AWS CLI** **Para listar todas as interfaces virtuais** O comando `describe-virtual-interfaces` a seguir lista as informações sobre todas as interfaces virtuais associadas à sua conta da AWS: ``` aws directconnect describe-virtual-interfaces --connection-id dxcon-ffjrkx17 ``` Resultado: ``` { "virtualInterfaces": [ { "virtualInterfaceState": "down", "asn": 65000, "vlan": 101, "customerAddress": "192.168.1.2/30", "ownerAccount": "123456789012", "connectionId": "dxcon-ffjrkx17", "virtualGatewayId": "vgw-aba37db6", "virtualInterfaceId": "dxvif-ffhhk74f", "authKey": "asdf34example", "routeFilterPrefixes": [], "location": "TIVIT", "customerRouterConfig": "\n\n 101\n 192.168.1.2/30\n 192.168.1.1/30\n 65000\n asdf34example\n 7224\n private\n\n", "amazonAddress": "192.168.1.1/30", "virtualInterfaceType": "private", "virtualInterfaceName": "PrivateVirtualInterface" }, { "virtualInterfaceState": "verifying", "asn": 65000, "vlan": 2000, "customerAddress": "203.0.113.2/30", "ownerAccount": "123456789012", "connectionId": "dxcon-ffjrkx17", "virtualGatewayId": "", "virtualInterfaceId": "dxvif-fgh0hcrk", "authKey": "asdf34example", "routeFilterPrefixes": [ { "cidr": "203.0.113.4/30" }, { "cidr": "203.0.113.0/30" } ], "location": "TIVIT", "customerRouterConfig": "\n\n 2000\n 203.0.113.2/30\n 203.0.113.1/30\n 65000\n asdf34example\n 7224\n public\n\n", "amazonAddress": "203.0.113.1/30", "virtualInterfaceType": "public", "virtualInterfaceName": "PublicVirtualInterface" } ] } ``` + Para ver detalhes da API, consulte [DescribeVirtualInterfaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-virtual-interfaces.html) na *Referência de comandos da AWS CLI*. ### `disassociate-connection-from-lag` O código de exemplo a seguir mostra como usar `disassociate-connection-from-lag`. **AWS CLI** **Como desassociar uma conexão de um LAG** O exemplo a seguir dissocia a conexão especificada do LAG especificado. Comando: ``` aws directconnect disassociate-connection-from-lag --lag-id dxlag-fhccu14t --connection-id dxcon-fg9607vm ``` Resultado: ``` { "ownerAccount": "123456789012", "connectionId": "dxcon-fg9607vm", "connectionState": "requested", "bandwidth": "1Gbps", "location": "EqDC2", "connectionName": "Con2ForLag", "region": "us-east-1" } ``` + Para ver detalhes da API, consulte [DisassociateConnectionFromLag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/disassociate-connection-from-lag.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Para adicionar uma tag a um recurso do AWS Direct Connect** O comando a seguir adiciona uma tag com uma chave de `Name` e um valor de `VAConnection` à instância `dxcon-abcabc12`. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws directconnect tag-resource --resource-arn arn:aws:directconnect:us-east-1:123456789012:dxcon/dxcon-abcabc12 --tags "key=Name,value=VAConnection" ``` + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover uma tag de um recurso do AWS Direct Connect** O comando a seguir remove a tag com a chave `Name` da conexão `dxcon-abcabc12`. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws directconnect untag-resource --resource-arn arn:aws:directconnect:us-east-1:123456789012:dxcon/dxcon-abcabc12 --tag-keys Name ``` + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-direct-connect-gateway-association` O código de exemplo a seguir mostra como usar `update-direct-connect-gateway-association`. **AWS CLI** **Para atualizar os atributos especificados da associação do gateway do Direct Connect** O exemplo `update-direct-connect-gateway-association` a seguir adiciona o bloco CIDR especificado a uma associação de gateway do Direct Connect. ``` aws directconnect update-direct-connect-gateway-association \ --association-id 820a6e4f-5374-4004-8317-3f64bEXAMPLE \ --add-allowed-prefixes-to-direct-connect-gateway cidr=192.168.2.0/30 ``` Resultado: ``` { "directConnectGatewayAssociation": { "directConnectGatewayId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE", "directConnectGatewayOwnerAccount": "111122223333", "associationState": "updating", "associatedGateway": { "id": "tgw-02f776b1a7EXAMPLE", "type": "transitGateway", "ownerAccount": "111122223333", "region": "us-east-1" }, "associationId": "820a6e4f-5374-4004-8317-3f64bEXAMPLE", "allowedPrefixesToDirectConnectGateway": [ { "cidr": "192.168.2.0/30" }, { "cidr": "192.168.1.0/30" } ] } } ``` Para obter mais informações, consulte [Trabalhar com gateways do Direct Connect](https://docs.aws.amazon.com/directconnect/latest/UserGuide/direct-connect-gateways.html) no *Guia do usuário do AWS Direct Connect*. + Para ver detalhes da API, consulte [UpdateDirectConnectGatewayAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/update-direct-connect-gateway-association.html) na *Referência de comandos da AWS CLI*. ### `update-lag` O código de exemplo a seguir mostra como usar `update-lag`. **AWS CLI** **Para atualizar um LAG** O exemplo a seguir altera o nome do LAG específico. Comando: ``` aws directconnect update-lag --lag-id dxlag-ffjhj9lx --lag-name 2ConnLag ``` Resultado: ``` { "awsDevice": "CSVA1-23u8tlpaz8iks", "numberOfConnections": 2, "lagState": "down", "ownerAccount": "123456789012", "lagName": "2ConnLag", "connections": [ { "ownerAccount": "123456789012", "connectionId": "dxcon-fflqyj95", "lagId": "dxlag-ffjhj9lx", "connectionState": "requested", "bandwidth": "1Gbps", "location": "CSVA1", "connectionName": "Requested Connection 2 for Lag dxlag-ffjhj9lx", "region": "us-east-1" }, { "ownerAccount": "123456789012", "connectionId": "dxcon-ffqr6x5q", "lagId": "dxlag-ffjhj9lx", "connectionState": "requested", "bandwidth": "1Gbps", "location": "CSVA1", "connectionName": "Requested Connection 1 for Lag dxlag-ffjhj9lx", "region": "us-east-1" } ], "lagId": "dxlag-ffjhj9lx", "minimumLinks": 0, "connectionsBandwidth": "1Gbps", "region": "us-east-1", "location": "CSVA1" } ``` + Para ver detalhes da API, consulte [UpdateLag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/update-lag.html) na *Referência de comandos da AWS CLI*. ### `update-virtual-interface-attributes` O código de exemplo a seguir mostra como usar `update-virtual-interface-attributes`. **AWS CLI** **Para atualizar a MTU de uma interface virtual** O exemplo `update-virtual-interface-attributes` a seguir atualiza a MTU da interface virtual especificada. ``` aws directconnect update-virtual-interface-attributes \ --virtual-interface-id dxvif-fEXAMPLE \ --mtu 1500 ``` Resultado: ``` { "ownerAccount": "1111222233333", "virtualInterfaceId": "dxvif-fEXAMPLE", "location": "loc1", "connectionId": "dxlag-fEXAMPLE", "virtualInterfaceType": "transit", "virtualInterfaceName": "example transit virtual interface", "vlan": 125, "asn": 650001, "amazonSideAsn": 64512, "authKey": "0xzxgA9YoW9h58u8SEXAMPLE", "amazonAddress": "169.254.248.1/30", "customerAddress": "169.254.248.2/30", "addressFamily": "ipv4", "virtualInterfaceState": "down", "customerRouterConfig": "\n\n 125\n 169.254.248.2/30\n 169.254.248.1/30\n 650001\n 0xzxgA9YoW9h58u8SEXAMPLE\n 64512\n transit\n\n", "mtu": 1500, "jumboFrameCapable": true, "virtualGatewayId": "", "directConnectGatewayId": "879b76a1-403d-4700-8b53-4a56ed85436e", "routeFilterPrefixes": [], "bgpPeers": [ { "bgpPeerId": "dxpeer-fEXAMPLE", "asn": 650001, "authKey": "0xzxgA9YoW9h58u8SEXAMPLE", "addressFamily": "ipv4", "amazonAddress": "169.254.248.1/30", "customerAddress": "169.254.248.2/30", "bgpPeerState": "available", "bgpStatus": "down", "awsDeviceV2": "loc1-26wz6vEXAMPLE" } ], "region": "sa-east-1", "awsDeviceV2": "loc1-26wz6vEXAMPLE", "tags": [] } ``` Para obter mais informações, consulte [Configurar a MTU de rede para interfaces virtuais privadas ou interfaces virtuais de trânsito](https://docs.aws.amazon.com/directconnect/latest/UserGuide/set-jumbo-frames-vif.html) no *Guia do usuário do AWS Direct Connect*. + Para ver detalhes da API, consulte [UpdateVirtualInterfaceAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/update-virtual-interface-attributes.html) na *Referência de comandos da AWS CLI*. # Directory Service Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o 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 ### `describe-directories` O código de exemplo a seguir mostra como usar `describe-directories`. **AWS CLI** **Para obter detalhes sobre todos os seus diretório** O exemplo `describe-directories` a seguir exibe os detalhes do diretório especificado. ``` aws ds describe-directories \ --directory-id d-a1b2c3d4e5 ``` Resultado: ``` { "DirectoryDescriptions": [ { "DirectoryId": "d-a1b2c3d4e5", "Name": "mydirectory.example.com", "ShortName": "mydirectory", "Size": "Small", "Edition": "Standard", "Alias": "d-a1b2c3d4e5", "AccessUrl": "d-a1b2c3d4e5.awsapps.com", "Stage": "Active", "ShareStatus": "Shared", "ShareMethod": "HANDSHAKE", "ShareNotes": "These are my share notes", "LaunchTime": "2019-07-08T15:33:46.327000-07:00", "StageLastUpdatedDateTime": "2019-07-08T15:59:12.307000-07:00", "Type": "SharedMicrosoftAD", "SsoEnabled": false, "DesiredNumberOfDomainControllers": 0, "OwnerDirectoryDescription": { "DirectoryId": "d-b2c3d4e5f6", "AccountId": "123456789111", "DnsIpAddrs": [ "203.113.0.248", "203.113.0.253" ], "VpcSettings": { "VpcId": "vpc-a1b2c3d4", "SubnetIds": [ "subnet-a1b2c3d4", "subnet-d4c3b2a1" ], "AvailabilityZones": [ "us-west-2a", "us-west-2c" ] } } } ] } ``` + Para ver detalhes da API, consulte [DescribeDirectories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ds/describe-directories.html) na *Referência de comandos da AWS CLI*. ### `describe-trusts` O código de exemplo a seguir mostra como usar `describe-trusts`. **AWS CLI** **Para obter detalhes sobre suas relações de confiança** O exemplo `describe-trusts` a seguir exibe detalhes sobre as relações de confiança do diretório especificado. ``` aws ds describe-trusts \ --directory-id d-a1b2c3d4e5 ``` Resultado: ``` { "Trusts": [ { "DirectoryId": "d-a1b2c3d4e5", "TrustId": "t-9a8b7c6d5e", "RemoteDomainName": "other.example.com", "TrustType": "Forest", "TrustDirection": "Two-Way", "TrustState": "Verified", "CreatedDateTime": "2017-06-20T18:08:45.614000-07:00", "LastUpdatedDateTime": "2019-06-04T10:52:12.410000-07:00", "StateLastUpdatedDateTime": "2019-06-04T10:52:12.410000-07:00", "SelectiveAuth": "Disabled" } ] } ``` + Para ver detalhes da API, consulte [DescribeTrusts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ds/describe-trusts.html) na *Referência de comandos da AWS CLI*. # Exemplos do Directory Service Data usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o Directory Service Data. *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-group-member` O código de exemplo a seguir mostra como usar `add-group-member`. **AWS CLI** **Como adicionar um membro do grupo a um diretório** O exemplo de `add-group-member` a seguir adiciona o usuário especificado ao grupo determinado no diretório indicado. ``` aws ds-data add-group-member \ --directory-id d-1234567890 \ --group-name 'sales' \ --member-name 'john.doe' ``` Este comando não produz saída. Consulte mais informações em [Adding or removing AWS Managed Microsoft AD members to groups and groups to groups](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_add_remove_user_group.html) no *Guia de administração do AWS Directory Service*. + Consulte detalhes da API em [AddGroupMember](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/add-group-member.html) na *Referência de comandos da AWS CLI*. ### `create-group` O código de exemplo a seguir mostra como usar `create-group`. **AWS CLI** **Para listar os widgets disponíveis** O exemplo de `create-group` a seguir cria um grupo em um diretório especificado. ``` aws ds-data create-group \ --directory-id d-1234567890 \ --sam-account-name "sales" ``` Resultado: ``` { "DirectoryId": "d-1234567890", "SAMAccountName": "sales", "SID": "S-1-2-34-5567891234-5678912345-67891234567-8912" } ``` Consulte mais informações em [Creating an AWS Managed Microsoft AD group](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_create_group.html) no *Guia de administração do AWS Directory Service*. + Consulte detalhes da API em [CreateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/create-group.html) na *Referência de comandos da AWS CLI*. ### `create-user` O código de exemplo a seguir mostra como usar `create-user`. **AWS CLI** **Para criar um usuário** O exemplo de `create-user` a seguir cria um usuário no diretório especificado. ``` aws ds-data create-user \ --directory-id d-1234567890 \ --sam-account-name 'john.doe' ``` Resultado: ``` { "DirectoryId": "d-1234567890", "SAMAccountName": "john.doe", "SID": "S-1-2-34-5567891234-5678912345-67891234567-8912" } ``` Consulte mais informações em [Creating an AWS Managed Microsoft AD user](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_create_user.html) no *Guia de administração do AWS Directory Service*. + Consulte detalhes da API em [CreateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/create-user.html) na *Referência de comandos da AWS CLI*. ### `delete-group` O código de exemplo a seguir mostra como usar `delete-group`. **AWS CLI** **Para excluir um grupo** O exemplo de `delete-group` a seguir exclui o grupo especificado do diretório indicado. ``` aws ds-data delete-group \ --directory-id d-1234567890 \ --sam-account-name 'sales' ``` Este comando não produz saída. Consulte mais informações em [Deleting an AWS Managed Microsoft AD group](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_delete_group.html) no *Guia de administração do AWS Directory Service*. + Consulte detalhes da API em [DeleteGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/delete-group.html) na *Referência de comandos da AWS CLI*. ### `delete-user` O código de exemplo a seguir mostra como usar `delete-user`. **AWS CLI** **Para excluir um usuário** O exemplo de `delete-user` a seguir exclui o usuário especificado do diretório indicado. ``` aws ds-data delete-user \ --directory-id d-1234567890 \ --sam-account-name 'john.doe' ``` Este comando não produz saída. Consulte mais informações em [Deleting an AWS Managed Microsoft AD user](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_delete_user.html) no *Guia de administração do AWS Directory Service*. + Consulte detalhes da API em [DeleteUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/delete-user.html) na *Referência de comandos da AWS CLI*. ### `describe-group` O código de exemplo a seguir mostra como usar `describe-group`. **AWS CLI** **Como listar detalhes de um grupo** O exemplo de `describe-group` a seguir obtém informações sobre o grupo especificado no diretório indicado. ``` aws ds-data describe-group \ --directory-id d-1234567890 \ --sam-account-name 'sales' ``` Resultado: ``` { "DirectoryId": "d-1234567890", "DistinguishedName": "CN=sales,OU=Users,OU=CORP,DC=corp,DC=example,DC=com", "GroupScope": "Global", "GroupType": "Security", "Realm": "corp.example.com", "SAMAccountName": "sales", "SID": "S-1-2-34-5567891234-5678912345-67891234567-8912" } ``` Consulte mais informações em [Viewing and updating an AWS Managed Microsoft AD group's details](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_group.html) no *Guia de administração do AWS Directory Service*. + Para ver detalhes da API, consulte [DescribeGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/describe-group.html) na *Referência de comandos da AWS CLI*. ### `describe-user` O código de exemplo a seguir mostra como usar `describe-user`. **AWS CLI** **Como listar informações de um usuário** O exemplo de `describe-user` a seguir obtém informações sobre o usuário especificado no diretório indicado. ``` aws ds-data describe-user command-name \ --directory-id d-1234567890 \ --sam-account-name 'john.doe' ``` Resultado: ``` { "DirectoryId": "d-1234567890", "DistinguishedName": "CN=john.doe,OU=Users,OU=CORP,DC=corp,DC=example,DC=com", "Enabled": false, "Realm": "corp.example.com", "SAMAccountName": "john.doe", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4567", "UserPrincipalName": "john.doe@CORP.EXAMPLE.COM" } ``` Consulte mais informações em [Viewing and updating an AWS Managed Microsoft AD user](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_user.html) no *Guia de administração do AWS Directory Service*. + Para ver detalhes da API, consulte [DescribeUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/describe-user.html) na *Referência de comandos da AWS CLI*. ### `disable-directory-data-access` O código de exemplo a seguir mostra como usar `disable-directory-data-access`. **AWS CLI** **Como desabilitar a API de dados do Directory Service para um diretório** O exemplo de `disable-directory-data-access` a seguir desabilita a API de dados do Directory Service para o diretório especificado. ``` aws ds disable-directory-data-access \ --directory-id d-1234567890 ``` Este comando não produz saída. Consulte mais informações em [Enabling or disabling user and group management or AWS Directory Service Data](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_users_groups_mgmt_enable_disable.html) no *Guia de administração do AWS Directory Service*. + Consulte detalhes da API em [DisableDirectoryDataAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/disable-directory-data-access.html) na *Referência de comandos da AWS CLI*. ### `disable-user` O código de exemplo a seguir mostra como usar `disable-user`. **AWS CLI** **Para desativar um usuário** O exemplo de `disable-user` a seguir desabilita o usuário especificado no diretório indicado. ``` aws ds-data disable-user \ --directory-id d-1234567890 \ --sam-account-name 'john.doe' ``` Este comando não produz saída. Consulte mais informações em [Disabling an AWS Managed Microsoft AD user](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_disable_user.html) no *Guia de administração do AWS Directory Service*. + Consulte detalhes da API em [DisableUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/disable-user.html) na *Referência de comandos da AWS CLI*. ### `enable-directory-data-access` O código de exemplo a seguir mostra como usar `enable-directory-data-access`. **AWS CLI** **Como habilitar a API de dados do Directory Service para um diretório** O exemplo de `enable-directory-data-access` a seguir habilita a API de dados do Directory Service para o diretório especificado. ``` aws ds enable-directory-data-access \ --directory-id d-1234567890 ``` Este comando não produz saída. Consulte mais informações em [Enabling or disabling user and group management or AWS Directory Service Data](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_users_groups_mgmt_enable_disable.html) no *Guia de administração do AWS Directory Service*. + Consulte detalhes da API em [EnableDirectoryDataAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/enable-directory-data-access.html) na *Referência de comandos da AWS CLI*. ### `list-group-members` O código de exemplo a seguir mostra como usar `list-group-members`. **AWS CLI** **Como listar os membros do grupo de um diretório** O exemplo de `list-group-members` a seguir lista os membros do grupo especificado no diretório indicado. ``` aws ds-data list-group-members \ --directory-id d-1234567890 \ --sam-account-name 'sales' ``` Resultado: ``` { "Members": [ { "MemberType": "USER", "SAMAccountName": "Jane Doe", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4568" }, { "MemberType": "USER", "SAMAccountName": "John Doe", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4569" } ], "DirectoryId": "d-1234567890", "MemberRealm": "corp.example.com", "Realm": "corp.example.com" } ``` Consulte mais informações em [Viewing and updating an AWS Managed Microsoft AD group's details](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_group.html) no *Guia de administração do AWS Directory Service*. + Para ver detalhes da API, consulte [ListGroupMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/list-group-members.html) na *Referência de comandos da AWS CLI*. ### `list-groups-for-member` O código de exemplo a seguir mostra como usar `list-groups-for-member`. **AWS CLI** **Como listar a associação de grupo de um diretório** O exemplo de `list-groups-for-member` a seguir lista a associação de grupo do usuário especificado no diretório indicado. ``` aws ds-data list-groups-for-member \ --directory-id d-1234567890 \ --sam-account-name 'john.doe' ``` Resultado: ``` { "Groups": [ { "GroupScope": "Global", "GroupType": "Security", "SAMAccountName": "Domain Users", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4567" } ], "DirectoryId": "d-1234567890", "MemberRealm": "corp.example.com", "Realm": "corp.example.com" } ``` Consulte mais informações em [Viewing and updating an AWS Managed Microsoft AD user](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_user.html) no *Guia de administração do AWS Directory Service*. + Consulte detalhes da API em [ListGroupsForMember](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/list-groups-for-member.html) na *Referência de comandos da AWS CLI*. ### `list-groups` O código de exemplo a seguir mostra como usar `list-groups`. **AWS CLI** **Como listar os grupos de um diretório** O exemplo de `list-groups` a seguir lista grupos no diretório especificado. ``` aws ds-data list-groups \ --directory-id d-1234567890 ``` Resultado: ``` { "Groups": [ { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "Administrators", "SID": "S-1-2-33-441" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "Users", "SID": "S-1-2-33-442" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "Guests", "SID": "S-1-2-33-443" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "Print Operators", "SID": "S-1-2-33-444" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "Backup Operators", "SID": "S-1-2-33-445" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "Replicator", "SID": "S-1-2-33-446" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "Remote Desktop Users", "SID": "S-1-2-33-447" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "Network Configuration Operators", "SID": "S-1-2-33-448" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "Performance Monitor Users", "SID": "S-1-2-33-449" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "Performance Log Users", "SID": "S-1-2-33-450" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "Distributed COM Users", "SID": "S-1-2-33-451" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "IIS_IUSRS", "SID": "S-1-2-33-452" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "Cryptographic Operators", "SID": "S-1-2-33-453" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "Event Log Readers", "SID": "S-1-2-33-454" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "Certificate Service DCOM Access", "SID": "S-1-2-33-456" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "RDS Remote Access Servers", "SID": "S-1-2-33-457" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "RDS Endpoint Servers", "SID": "S-1-2-33-458" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "RDS Management Servers", "SID": "S-1-2-33-459" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "Hyper-V Administrators", "SID": "S-1-2-33-460" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "Access Control Assistance Operators", "SID": "S-1-2-33-461" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "Remote Management Users", "SID": "S-1-2-33-462" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "Storage Replica Administrators", "SID": "S-1-2-33-463" }, { "GroupScope": "Global", "GroupType": "Security", "SAMAccountName": "Domain Computers", "SID": "S-1-2-34-56789123456-7891012345-6789123486-789" }, { "GroupScope": "Global", "GroupType": "Security", "SAMAccountName": "Domain Controllers", "SID": "S-1-2-34-56789123456-7891012345-6789123486-790" }, { "GroupScope": "Universal", "GroupType": "Security", "SAMAccountName": "Schema Admins", "SID": "S-1-2-34-56789123456-7891012345-6789123486-791" }, { "GroupScope": "Universal", "GroupType": "Security", "SAMAccountName": "Enterprise Admins", "SID": "S-1-2-34-56789123456-7891012345-6789123486-792" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "Cert Publishers", "SID": "S-1-2-34-56789123456-7891012345-6789123486-793" }, { "GroupScope": "Global", "GroupType": "Security", "SAMAccountName": "Domain Admins", "SID": "S-1-2-34-56789123456-7891012345-6789123486-794" }, { "GroupScope": "Global", "GroupType": "Security", "SAMAccountName": "Domain Users", "SID": "S-1-2-34-56789123456-7891012345-6789123486-795" }, { "GroupScope": "Global", "GroupType": "Security", "SAMAccountName": "Domain Guests", "SID": "S-1-2-34-56789123456-7891012345-6789123486-796" }, { "GroupScope": "Global", "GroupType": "Security", "SAMAccountName": "Group Policy Creator Owners", "SID": "S-1-2-34-56789123456-7891012345-6789123486-797" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "RAS and IAS Servers", "SID": "S-1-2-34-56789123456-7891012345-6789123486-798" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "Server Operators", "SID": "S-1-2-33-464" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "Account Operators", "SID": "S-1-2-33-465" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "Pre-Windows 2000 Compatible Access", "SID": "S-1-2-33-466" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "Incoming Forest Trust Builders", "SID": "S-1-2-33-467" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "Windows Authorization Access Group", "SID": "S-1-2-33-468" }, { "GroupScope": "BuiltinLocal", "GroupType": "Security", "SAMAccountName": "Terminal Server License Servers", "SID": "S-1-2-33-469" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "Allowed RODC Password Replication Group", "SID": "S-1-2-34-56789123456-7891012345-6789123486-798" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "Denied RODC Password Replication Group", "SID": "S-1-2-34-56789123456-7891012345-6789123486-799" }, { "GroupScope": "Global", "GroupType": "Security", "SAMAccountName": "Read-only Domain Controllers", "SID": "S-1-2-34-56789123456-7891012345-6789123486-800" }, { "GroupScope": "Universal", "GroupType": "Security", "SAMAccountName": "Enterprise Read-only Domain Controllers", "SID": "S-1-2-34-56789123456-7891012345-6789123486-801" }, { "GroupScope": "Global", "GroupType": "Security", "SAMAccountName": "Cloneable Domain Controllers", "SID": "S-1-2-34-56789123456-7891012345-6789123486-802" }, { "GroupScope": "Global", "GroupType": "Security", "SAMAccountName": "Protected Users", "SID": "S-1-2-34-56789123456-7891012345-6789123486-803" }, { "GroupScope": "Global", "GroupType": "Security", "SAMAccountName": "Key Admins", "SID": "S-1-2-34-56789123456-7891012345-6789123486-804" }, { "GroupScope": "Universal", "GroupType": "Security", "SAMAccountName": "Enterprise Key Admins", "SID": "S-1-2-34-56789123456-7891012345-6789123486-805" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "DnsAdmins", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4567" }, { "GroupScope": "Global", "GroupType": "Security", "SAMAccountName": "DnsUpdateProxy", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4568" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "Admins", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4569" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWSAdministrators", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4570" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Object Management Service Accounts", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4571" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Private CA Connector for AD Delegated Group", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4572" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Application and Service Delegated Group", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4573" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Delegated Administrators", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4574" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Delegated FSx Administrators", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4575" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Delegated Account Operators", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4576" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Delegated Active Directory Based Activation Administrators", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4577" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Delegated Allowed to Authenticate Objects", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4578" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Delegated Allowed to Authenticate to Domain Controllers", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4579" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Delegated Deleted Object Lifetime Administrators", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4580" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Delegated Distributed File System Administrators", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4581" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Delegated Dynamic Host Configuration Protocol Administrators", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4582" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Delegated Enterprise Certificate Authority Administrators", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4583" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Delegated Fine Grained Password Policy Administrators", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4584" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Delegated Group Policy Administrators", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4585" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Delegated Managed Service Account Administrators", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4586" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Delegated Read Foreign Security Principals", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4587" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Delegated Remote Access Service Administrators", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4588" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Delegated Replicate Directory Changes Administrators", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4588" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Delegated Sites and Services Administrators", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4589" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Delegated System Management Administrators", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4590" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Delegated Terminal Server Licensing Administrators", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4591" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Delegated User Principal Name Suffix Administrators", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4592" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Delegated Add Workstations To Domain Users", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4593" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Delegated Domain Name System Administrators", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4594" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Delegated Kerberos Delegation Administrators", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4595" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Delegated Server Administrators", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4596" }, { "GroupScope": "DomainLocal", "GroupType": "Security", "SAMAccountName": "AWS Delegated MS-NPRC Non-Compliant Devices", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4597" }, { "GroupScope": "Global", "GroupType": "Security", "SAMAccountName": "Remote Access", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4598" }, { "GroupScope": "Global", "GroupType": "Security", "SAMAccountName": "Accounting", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4599" }, { "GroupScope": "Global", "GroupType": "Distribution", "SAMAccountName": "sales", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4567" } ], "DirectoryId": "d-1234567890", "Realm": "corp.example.com" } ``` Consulte mais informações em [Viewing and updating an AWS Managed Microsoft AD group's details](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_group.html) no *Guia de administração do AWS Directory Service*. + Consulte detalhes da API em [ListGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/list-groups.html) na *Referência de comandos da AWS CLI*. ### `list-users` O código de exemplo a seguir mostra como usar `list-users`. **AWS CLI** **Como listar os usuários de um diretório** O exemplo de `list-users` a seguir lista usuários no diretório especificado. ``` aws ds-data list-users \ --directory-id d-1234567890 ``` Resultado: ``` { "Users": [ { "Enabled": true, "SAMAccountName": "Administrator", "SID": "S-1-2-34-5678910123-4567895012-3456789012-345" }, { "Enabled": false, "SAMAccountName": "Guest", "SID": "S-1-2-34-5678910123-4567895012-3456789012-345" }, { "Enabled": false, "SAMAccountName": "krbtgt", "SID": "S-1-2-34-5678910123-4567895012-3456789012-346" }, { "Enabled": true, "SAMAccountName": "Admin", "SID": "S-1-2-34-5678910123-4567895012-3456789012-347" }, { "Enabled": true, "SAMAccountName": "Richard Roe", "SID": "S-1-2-34-5678910123-4567895012-3456789012-348" }, { "Enabled": true, "SAMAccountName": "Jane Doe", "SID": "S-1-2-34-5678910123-4567895012-3456789012-349" }, { "Enabled": true, "SAMAccountName": "AWS_WGnzYlN6YyY", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4567" }, { "Enabled": true, "SAMAccountName": "john.doe", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4568" } ], "DirectoryId": "d-1234567890", "Realm": "corp.example.com" } ``` Consulte mais informações em [Viewing and updating an AWS Managed Microsoft AD user](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_user.html) no *Guia de administração do AWS Directory Service*. + Consulte detalhes da API em [ListUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/list-users.html) na *Referência de comandos da AWS CLI*. ### `remove-group-member` O código de exemplo a seguir mostra como usar `remove-group-member`. **AWS CLI** **Como remover um membro do grupo de um diretório** O exemplo de `remove-group-member` a seguir remove o membro especificado do grupo determinado no diretório indicado. ``` aws ds-data remove-group-member \ --directory-id d-1234567890 \ --group-name 'sales' \ --member-name 'john.doe' ``` Este comando não produz saída. Consulte mais informações em [Adding and removing AWS Managed Microsoft AD members to groups and groups to groups](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_add_remove_user_group.html) no *Guia de administração do AWS Directory Service*. + Para ver detalhes da API, consulte [RemoveGroupMember](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/remove-group-member.html) na *Referência de comandos da AWS CLI*. ### `reset-user-password` O código de exemplo a seguir mostra como usar `reset-user-password`. **AWS CLI** **Como redefinir a senha de um usuário em um diretório** O exemplo de `reset-user-password` a seguir redefine e habilita o usuário especificado no diretório indicado. ``` aws ds reset-user-password \ --directory-id d-1234567890 \ --user-name 'john.doe' \ --new-password 'password' ``` Este comando não produz saída. Consulte mais informações em [Resetting and enabling an AWS Managed Microsoft AD user’s password](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_reset_user_pswd.html) no *Guia de administração do AWS Directory Service*. + Consulte detalhes da API em [ResetUserPassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/reset-user-password.html) na *Referência de comandos da AWS CLI*. ### `search-groups` O código de exemplo a seguir mostra como usar `search-groups`. **AWS CLI** **Como pesquisar um grupo em um diretório** O exemplo de `search-groups` a seguir pesquisa o grupo especificado no diretório indicado. ``` aws ds-data search-groups \ --directory-id d-1234567890 \ --search-attributes 'SamAccountName' \ --search-string 'sales' ``` Resultado: ``` { "Groups": [ { "GroupScope": "Global", "GroupType": "Distribution", "SAMAccountName": "sales", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4567" } ], "DirectoryId": "d-1234567890", "Realm": "corp.example.com" } ``` Consulte mais informações em [Viewing and updating an AWS Managed Microsoft AD group's details](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_group.html) no *Guia de administração do AWS Directory Service*. + Consulte detalhes da API em [SearchGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/search-groups.html) na *Referência de comandos da AWS CLI*. ### `search-users` O código de exemplo a seguir mostra como usar `search-users`. **AWS CLI** **Como pesquisar um usuário em um diretório** O exemplo de `search-users` a seguir pesquisa o usuário especificado no diretório indicado. ``` aws ds-data search-users \ --directory-id d-1234567890 \ --search-attributes 'SamAccountName' \ --Search-string 'john.doe' ``` Resultado: ``` { "Users": [ { "Enabled": true, "SAMAccountName": "john.doe", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4567" } ], "DirectoryId": "d-1234567890", "Realm": "corp.example.com" } ``` Consulte mais informações em [Viewing and updating an AWS Managed Microsoft AD user](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_user.html) no *Guia de administração do AWS Directory Service*. + Consulte detalhes da API em [SearchUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/search-users.html) na *Referência de comandos da AWS CLI*. ### `update-group` O código de exemplo a seguir mostra como usar `update-group`. **AWS CLI** **Como atualizar o atributo de um grupo em um diretório** O exemplo de `update-group` a seguir atualiza o atributo especificado para o grupo determinado no diretório indicado. ``` aws ds-data update-group \ --directory-id d-1234567890 \ --sam-account-name 'sales' \ --update-type 'REPLACE' \ --group-type 'Distribution' ``` Este comando não produz saída. Consulte mais informações em [Viewing and updating an AWS Managed Microsoft AD group's details](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_group.html) no *Guia de administração do AWS Directory Service*. + Consulte detalhes da API em [UpdateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/update-group.html) na *Referência de comandos da AWS CLI*. ### `update-user` O código de exemplo a seguir mostra como usar `update-user`. **AWS CLI** **Como atualizar o atributo de um usuário em um diretório** O exemplo de `update-user` a seguir atualiza o atributo especificado para o usuário determinado no diretório indicado. ``` aws ds-data update-user \ --directory-id d-1234567890 \ --sam-account-name 'john.doe' \ --update-type 'ADD' \ --email-address 'example.corp.com' ``` Este comando não produz saída. Consulte mais informações em [Viewing and updating an AWS Managed Microsoft AD user](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_user.html) no *Guia de administração do AWS Directory Service*. + Consulte detalhes da API em [UpdateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/update-user.html) na *Referência de comandos da AWS CLI*. # AWS DMS Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o 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 ### `add-tags-to-resource` O código de exemplo a seguir mostra como usar `add-tags-to-resource`. **AWS CLI** **Para adicionar tags a um recurso** O exemplo `add-tags-to-resource` a seguir adiciona tags a uma instância de replicação. ``` aws dms add-tags-to-resource \ --resource-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE \ --tags Key=Environment,Value=PROD Key=Project,Value=dbMigration ``` Este comando não produz saída. Para ter mais informações, consulte [Marcação de recursos](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tagging.html) no *Guia do usuário do AWS Database Migration Service*. + Consulte detalhes da API em [AddTagsToResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/add-tags-to-resource.html) na *Referência de comandos da AWS CLI*. ### `create-endpoint` O código de exemplo a seguir mostra como usar `create-endpoint`. **AWS CLI** **Para criar um endpoint** O exemplo `create-endpoint` a seguir cria um endpoint para uma origem do Amazon S3. ``` aws dms create-endpoint \ --endpoint-type source \ --engine-name s3 \ --endpoint-identifier src-endpoint \ --s3-settings file://s3-settings.json ``` Conteúdo de `s3-settings.json`: ``` { "BucketName":"my-corp-data", "BucketFolder":"sourcedata", "ServiceAccessRoleArn":"arn:aws:iam::123456789012:role/my-s3-access-role" } ``` Resultado: ``` { "Endpoint": { "EndpointIdentifier": "src-endpoint", "EndpointType": "SOURCE", "EngineName": "s3", "EngineDisplayName": "Amazon S3", "ExtraConnectionAttributes": "bucketFolder=sourcedata;bucketName=my-corp-data;compressionType=NONE;csvDelimiter=,;csvRowDelimiter=\\n;", "Status": "active", "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:GUVAFG34EECUOJ6QVZ56DAHT3U", "SslMode": "none", "ServiceAccessRoleArn": "arn:aws:iam::123456789012:role/my-s3-access-role", "S3Settings": { "ServiceAccessRoleArn": "arn:aws:iam::123456789012:role/my-s3-access-role", "CsvRowDelimiter": "\\n", "CsvDelimiter": ",", "BucketFolder": "sourcedata", "BucketName": "my-corp-data", "CompressionType": "NONE", "EnableStatistics": true } } } ``` Para obter mais informações, consulte [Como trabalhar com endpoints do AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html) no *Guia do usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [CreateEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/create-endpoint.html) na *Referência de comandos da AWS CLI*. ### `create-event-subscription` O código de exemplo a seguir mostra como usar `create-event-subscription`. **AWS CLI** **Para listar assinaturas de eventos** O exemplo `create-event-subscription` a seguir cria uma assinatura de evento para um tópico do Amazon SNS (my-sns-topic). ``` aws dms create-event-subscription \ --subscription-name my-dms-events \ --sns-topic-arn arn:aws:sns:us-east-1:123456789012:my-sns-topic ``` Resultado: ``` { "EventSubscription": { "CustomerAwsId": "123456789012", "CustSubscriptionId": "my-dms-events", "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:my-sns-topic", "Status": "creating", "SubscriptionCreationTime": "2020-05-21 21:58:38.598", "Enabled": true } } ``` Para obter mais informações, consulte [Como trabalhar com eventos e notificações](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) no *Guia do usuário do AWS Database Migration Service.* + Para ver detalhes da API, consulte [CreateEventSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/create-event-subscription.html) na *Referência de comandos da AWS CLI*. ### `create-replication-instance` O código de exemplo a seguir mostra como usar `create-replication-instance`. **AWS CLI** **Para criar uma instância de replicação** O exemplo `create-replication-instance` a seguir cria uma instância de replicação. ``` aws dms create-replication-instance \ --replication-instance-identifier my-repl-instance \ --replication-instance-class dms.t2.micro \ --allocated-storage 5 ``` Resultado: ``` { "ReplicationInstance": { "ReplicationInstanceIdentifier": "my-repl-instance", "ReplicationInstanceClass": "dms.t2.micro", "ReplicationInstanceStatus": "creating", "AllocatedStorage": 5, "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sg-f839b688", "Status": "active" } ], "ReplicationSubnetGroup": { "ReplicationSubnetGroupIdentifier": "default", "ReplicationSubnetGroupDescription": "default", "VpcId": "vpc-136a4c6a", "SubnetGroupStatus": "Complete", "Subnets": [ { "SubnetIdentifier": "subnet-da327bf6", "SubnetAvailabilityZone": { "Name": "us-east-1a" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-42599426", "SubnetAvailabilityZone": { "Name": "us-east-1d" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-bac383e0", "SubnetAvailabilityZone": { "Name": "us-east-1c" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-6746046b", "SubnetAvailabilityZone": { "Name": "us-east-1f" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-d7c825e8", "SubnetAvailabilityZone": { "Name": "us-east-1e" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-cbfff283", "SubnetAvailabilityZone": { "Name": "us-east-1b" }, "SubnetStatus": "Active" } ] }, "PreferredMaintenanceWindow": "sat:12:35-sat:13:05", "PendingModifiedValues": {}, "MultiAZ": false, "EngineVersion": "3.3.2", "AutoMinorVersionUpgrade": true, "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/f7bc0f8e-1a3a-4ace-9faa-e8494fa3921a", "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:ZK2VQBUWFDBAWHIXHAYG5G2PKY", "PubliclyAccessible": true } } ``` Para obter mais informações, consulte [Trabalhar com uma instância de replicação do AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html) no *Guia do usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [CreateReplicationInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/create-replication-instance.html) na *Referência de comandos da AWS CLI*. ### `create-replication-subnet-group` O código de exemplo a seguir mostra como usar `create-replication-subnet-group`. **AWS CLI** **Para criar um grupo de sub-redes** O exemplo `create-replication-subnet-group` a seguir cria um grupo que consiste em 3 sub-redes. ``` aws dms create-replication-subnet-group \ --replication-subnet-group-identifier my-subnet-group \ --replication-subnet-group-description "my subnet group" \ --subnet-ids subnet-da327bf6 subnet-bac383e0 subnet-d7c825e8 ``` Resultado: ``` { "ReplicationSubnetGroup": { "ReplicationSubnetGroupIdentifier": "my-subnet-group", "ReplicationSubnetGroupDescription": "my subnet group", "VpcId": "vpc-136a4c6a", "SubnetGroupStatus": "Complete", "Subnets": [ { "SubnetIdentifier": "subnet-da327bf6", "SubnetAvailabilityZone": { "Name": "us-east-1a" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-bac383e0", "SubnetAvailabilityZone": { "Name": "us-east-1c" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-d7c825e8", "SubnetAvailabilityZone": { "Name": "us-east-1e" }, "SubnetStatus": "Active" } ] } } ``` Para obter mais informações, consulte [Configurar uma rede para uma instância de replicação](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.VPC.html) no *Guia do Usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [CreateReplicationSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/create-replication-subnet-group.html) na *Referência de comandos da AWS CLI*. ### `create-replication-task` O código de exemplo a seguir mostra como usar `create-replication-task`. **AWS CLI** **Para criar uma tarefa de replicação** O exemplo `create-replication-task` a seguir cria uma tarefa de replicação. ``` aws dms create-replication-task \ --replication-task-identifier movedata \ --source-endpoint-arn arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA \ --target-endpoint-arn arn:aws:dms:us-east-1:123456789012:endpoint:EOM4SFKCZEYHZBFGAGZT3QEC5U \ --replication-instance-arn $RI_ARN \ --migration-type full-load \ --table-mappings file://table-mappings.json ``` Conteúdo de `table-mappings.json`: ``` { "rules": [ { "rule-type": "selection", "rule-id": "1", "rule-name": "1", "object-locator": { "schema-name": "prodrep", "table-name": "%" }, "rule-action": "include", "filters": [] } ] } ``` Resultado: ``` { "ReplicationTask": { "ReplicationTaskIdentifier": "moveit2", "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA", "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:EOM4SFKCZEYHZBFGAGZT3QEC5U", "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE", "MigrationType": "full-load", "TableMappings": ...output omitted... , "ReplicationTaskSettings": ...output omitted... , "Status": "creating", "ReplicationTaskCreationDate": 1590524772.505, "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII" } } ``` Para obter mais informações, consulte [Como trabalhar com tarefas do AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html) no *Guia do usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [CreateReplicationTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/create-replication-task.html) na *Referência de comandos da AWS CLI*. ### `delete-connection` O código de exemplo a seguir mostra como usar `delete-connection`. **AWS CLI** **Para excluir uma conexão** O exemplo `delete-connection` a seguir dissocia um endpoint de uma instância de replicação. ``` aws dms delete-connection \ --endpoint-arn arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA \ --replication-instance-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE ``` Resultado: ``` { "Connection": { "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE", "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA", "Status": "deleting", "EndpointIdentifier": "src-database-1", "ReplicationInstanceIdentifier": "my-repl-instance" } } ``` Para obter mais informações, consulte [https://docs.aws.amazon.com/dms/latest/userguide/CHAP\$1Endpoints.Creating.html](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.Creating.html) no *Guia do Usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [DeleteConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-connection.html) na *Referência de comandos da AWS CLI*. ### `delete-endpoint` O código de exemplo a seguir mostra como usar `delete-endpoint`. **AWS CLI** **Para excluir um endpoint** O exemplo `delete-endpoint` a seguir exclui um endpoint. ``` aws dms delete-endpoint \ --endpoint-arn arn:aws:dms:us-east-1:123456789012:endpoint:OUJJVXO4XZ4CYTSEG5XGMN2R3Y ``` Resultado: ``` { "Endpoint": { "EndpointIdentifier": "src-endpoint", "EndpointType": "SOURCE", "EngineName": "s3", "EngineDisplayName": "Amazon S3", "ExtraConnectionAttributes": "bucketFolder=sourcedata;bucketName=my-corp-data;compressionType=NONE;csvDelimiter=,;csvRowDelimiter=\\n;", "Status": "deleting", "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:OUJJVXO4XZ4CYTSEG5XGMN2R3Y", "SslMode": "none", "ServiceAccessRoleArn": "arn:aws:iam::123456789012:role/my-s3-access-role", "S3Settings": { "ServiceAccessRoleArn": "arn:aws:iam::123456789012:role/my-s3-access-role", "CsvRowDelimiter": "\\n", "CsvDelimiter": ",", "BucketFolder": "sourcedata", "BucketName": "my-corp-data", "CompressionType": "NONE", "EnableStatistics": true } } } ``` Para obter mais informações, consulte [Como trabalhar com endpoints do AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html) no *Guia do usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [DeleteEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-endpoint.html) na *Referência de comandos da AWS CLI*. ### `delete-event-subscription` O código de exemplo a seguir mostra como usar `delete-event-subscription`. **AWS CLI** **Para excluir uma assinatura de evento** O exemplo `delete-event-subscription` a seguir exclui uma assinatura de um tópico do Amazon SNS. ``` aws dms delete-event-subscription \ --subscription-name "my-dms-events" ``` Resultado: ``` { "EventSubscription": { "CustomerAwsId": "123456789012", "CustSubscriptionId": "my-dms-events", "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:my-sns-topic", "Status": "deleting", "SubscriptionCreationTime": "2020-05-21 21:58:38.598", "Enabled": true } } ``` Para obter mais informações, consulte [Como trabalhar com eventos e notificações](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) no *Guia do usuário do AWS Database Migration Service.* + Para ver detalhes da API, consulte [DeleteEventSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-event-subscription.html) na *Referência de comandos da AWS CLI*. ### `delete-replication-instance` O código de exemplo a seguir mostra como usar `delete-replication-instance`. **AWS CLI** **Para excluir uma instância de replicação** O exemplo da `delete-replication-instance` a seguir exclui uma instância de replicação. ``` aws dms delete-replication-instance \ --replication-instance-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE ``` Resultado: ``` { "ReplicationInstance": { "ReplicationInstanceIdentifier": "my-repl-instance", "ReplicationInstanceClass": "dms.t2.micro", "ReplicationInstanceStatus": "deleting", "AllocatedStorage": 5, "InstanceCreateTime": 1590011235.952, "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sg-f839b688", "Status": "active" } ], "AvailabilityZone": "us-east-1e", "ReplicationSubnetGroup": { "ReplicationSubnetGroupIdentifier": "default", "ReplicationSubnetGroupDescription": "default", "VpcId": "vpc-136a4c6a", "SubnetGroupStatus": "Complete", "Subnets": [ { "SubnetIdentifier": "subnet-da327bf6", "SubnetAvailabilityZone": { "Name": "us-east-1a" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-42599426", "SubnetAvailabilityZone": { "Name": "us-east-1d" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-bac383e0", "SubnetAvailabilityZone": { "Name": "us-east-1c" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-6746046b", "SubnetAvailabilityZone": { "Name": "us-east-1f" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-d7c825e8", "SubnetAvailabilityZone": { "Name": "us-east-1e" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-cbfff283", "SubnetAvailabilityZone": { "Name": "us-east-1b" }, "SubnetStatus": "Active" } ] }, "PreferredMaintenanceWindow": "wed:11:42-wed:12:12", "PendingModifiedValues": {}, "MultiAZ": true, "EngineVersion": "3.3.2", "AutoMinorVersionUpgrade": true, "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/f7bc0f8e-1a3a-4ace-9faa-e8494fa3921a", "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE", "ReplicationInstancePublicIpAddress": "54.225.120.92", "ReplicationInstancePrivateIpAddress": "172.31.30.121", "ReplicationInstancePublicIpAddresses": [ "54.225.120.92", "3.230.18.248" ], "ReplicationInstancePrivateIpAddresses": [ "172.31.30.121", "172.31.75.90" ], "PubliclyAccessible": true, "SecondaryAvailabilityZone": "us-east-1b" } } ``` Para obter mais informações, consulte [Trabalhar com uma instância de replicação do AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html) no *Guia do usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [DeleteReplicationInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-replication-instance.html) na *Referência de comandos da AWS CLI*. ### `delete-replication-subnet-group` O código de exemplo a seguir mostra como usar `delete-replication-subnet-group`. **AWS CLI** **Para excluir um grupo de sub-redes** O exemplo `delete-replication-subnet-group` a seguir exclui um grupo de sub-redes. ``` aws dms delete-replication-subnet-group \ --replication-subnet-group-identifier my-subnet-group ``` Resultado: ``` (none) ``` Para obter mais informações, consulte [Configurar uma rede para uma instância de replicação](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.VPC.html) no *Guia do Usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [DeleteReplicationSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-replication-subnet-group.html) na *Referência de comandos da AWS CLI*. ### `delete-replication-task` O código de exemplo a seguir mostra como usar `delete-replication-task`. **AWS CLI** **Para excluir uma tarefa de replicação** O exemplo `delete-replication-task` a seguir exclui uma tarefa de replicação. ``` aws dms delete-replication-task \ --replication-task-arn arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII ``` Resultado: ``` { "ReplicationTask": { "ReplicationTaskIdentifier": "moveit2", "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA", "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:EOM4SFKCZEYHZBFGAGZT3QEC5U", "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE", "MigrationType": "full-load", "TableMappings": ...output omitted..., "ReplicationTaskSettings": ...output omitted..., "Status": "deleting", "StopReason": "Stop Reason FULL_LOAD_ONLY_FINISHED", "ReplicationTaskCreationDate": 1590524772.505, "ReplicationTaskStartDate": 1590789988.677, "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII" } } ``` Para obter mais informações, consulte [Como trabalhar com tarefas do AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html) no *Guia do usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [DeleteReplicationTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-replication-task.html) na *Referência de comandos da AWS CLI*. ### `describe-account-attributes` O código de exemplo a seguir mostra como usar `describe-account-attributes`. **AWS CLI** **Como descrever os atributos da conta** O exemplo `describe-account-attributes` a seguir lista os atributos da sua conta da AWS. ``` aws dms describe-account-attributes ``` Resultado: ``` { "AccountQuotas": [ { "AccountQuotaName": "ReplicationInstances", "Used": 1, "Max": 20 }, { "AccountQuotaName": "AllocatedStorage", "Used": 5, "Max": 10000 }, ...remaining output omitted... ], "UniqueAccountIdentifier": "cqahfbfy5xee" } ``` + Consulte detalhes da API em [DescribeAccountAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-account-attributes.html) na *Referência de comandos da AWS CLI*. ### `describe-certificates` O código de exemplo a seguir mostra como usar `describe-certificates`. **AWS CLI** **Para listar os certificados disponíveis** O exemplo `describe-certificates` a seguir lista os certificados disponíveis em sua conta da AWS. ``` aws dms describe-certificates ``` Resultado: ``` { "Certificates": [ { "CertificateIdentifier": "my-cert", "CertificateCreationDate": 1543259542.506, "CertificatePem": "-----BEGIN CERTIFICATE-----\nMIID9DCCAtygAwIBAgIBQjANBgkqhkiG9w0BAQ ...U" ... remaining output omittted ... } ] } ``` Para ter mais informações, consulte [Como usar o SSL](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.SSL) no *Guia do usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [DescribeCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-certificates.html) na *Referência de comandos da AWS CLI*. ### `describe-connections` O código de exemplo a seguir mostra como usar `describe-connections`. **AWS CLI** **Para descrever conexões** O exemplo `describe-connections` a seguir lista as conexões que você testou entre uma instância de replicação e um endpoint. ``` aws dms describe-connections ``` Resultado: ``` { "Connections": [ { "Status": "successful", "ReplicationInstanceIdentifier": "test", "EndpointArn": "arn:aws:dms:us-east-arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", "EndpointIdentifier": "testsrc1", "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ" } ] } ``` Para obter mais informações, consulte [Criação de endpoints de origem e destino](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.Creating.html) no *Guia do usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [DescribeConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-connections.html) na *Referência de comandos da AWS CLI*. ### `describe-endpoint-types` O código de exemplo a seguir mostra como usar `describe-endpoint-types`. **AWS CLI** **Para listar os tipos de endpoint disponíveis** O exemplo `describe-endpoint-types` a seguir lista os tipos de endpoint do MySQL que estão disponíveis. ``` aws dms describe-endpoint-types \ --filters "Name=engine-name,Values=mysql" ``` Resultado: ``` { "SupportedEndpointTypes": [ { "EngineName": "mysql", "SupportsCDC": true, "EndpointType": "source", "EngineDisplayName": "MySQL" }, { "EngineName": "mysql", "SupportsCDC": true, "EndpointType": "target", "EngineDisplayName": "MySQL" } ] } ``` Para obter mais informações, consulte Como trabalhar com endpoints do AWS DMS `\$1\$1 no *Guia do usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [DescribeEndpointTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-endpoint-types.html) na *Referência de comandos da AWS CLI*. ### `describe-endpoints` O código de exemplo a seguir mostra como usar `describe-endpoints`. **AWS CLI** **Para descrever endpoints** O exemplo `describe-endpoints` a seguir lista os endpoints em sua conta da AWS. ``` aws dms describe-endpoints ``` Resultado: ``` { "Endpoints": [ { "Username": "dms", "Status": "active", "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:SF2WOFLWYWKVEOHID2EKLP3SJI", "ServerName": "ec2-52-32-48-61.us-west-2.compute.amazonaws.com", "EndpointType": "SOURCE", "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/94d5c4e7-4e4c-44be-b58a-c8da7adf57cd", "DatabaseName": "test", "EngineName": "mysql", "EndpointIdentifier": "pri100", "Port": 8193 }, { "Username": "admin", "Status": "active", "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:TJJZCIH3CJ24TJRU4VC32WEWFR", "ServerName": "test.example.com", "EndpointType": "SOURCE", "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/2431021b-1cf2-a2d4-77b2-59a9e4bce323", "DatabaseName": "EMPL", "EngineName": "oracle", "EndpointIdentifier": "test", "Port": 1521 } ] } ``` Para obter mais informações, consulte [Como trabalhar com endpoints do AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html) no *Guia do usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [DescribeEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-endpoints.html) na *Referência de comandos da AWS CLI*. ### `describe-event-categories` O código de exemplo a seguir mostra como usar `describe-event-categories`. **AWS CLI** **Para descrever categorias de eventos** O exemplo `describe-event-categories` a seguir lista as categorias de eventos disponíveis. ``` aws dms describe-event-categories ``` Resultado: ``` { "EventCategoryGroupList": [ { "SourceType": "replication-instance", "EventCategories": [ "low storage", "configuration change", "maintenance", "deletion", "creation", "failover", "failure" ] }, { "SourceType": "replication-task", "EventCategories": [ "configuration change", "state change", "deletion", "creation", "failure" ] } ] } ``` Para obter mais informações, consulte [Como trabalhar com eventos e notificações](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) no *Guia do usuário do AWS Database Migration Service.* + Para ver detalhes da API, consulte [DescribeEventCategories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-event-categories.html) na *Referência de comandos da AWS CLI*. ### `describe-event-subscriptions` O código de exemplo a seguir mostra como usar `describe-event-subscriptions`. **AWS CLI** **Para descrever assinaturas de eventos** O exemplo `describe-event-subscriptions` a seguir lista as assinaturas para um evento para um tópico do Amazon SNS. ``` aws dms describe-event-subscriptions ``` Resultado: ``` { "EventSubscriptionsList": [ { "CustomerAwsId": "123456789012", "CustSubscriptionId": "my-dms-events", "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:my-sns-topic", "Status": "deleting", "SubscriptionCreationTime": "2020-05-21 22:28:51.924", "Enabled": true } ] } ``` Para obter mais informações, consulte [Como trabalhar com eventos e notificações](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) no *Guia do usuário do AWS Database Migration Service.* + Para ver detalhes da API, consulte [DescribeEventSubscriptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-event-subscriptions.html) na *Referência de comandos da AWS CLI*. ### `describe-events` O código de exemplo a seguir mostra como usar `describe-events`. **AWS CLI** **Para listar eventos do DMS** O exemplo `describe-events` a seguir lista os eventos que se originaram de uma instância de replicação. ``` aws dms describe-events \ --source-type "replication-instance" ``` Resultado: ``` { "Events": [ { "SourceIdentifier": "my-repl-instance", "SourceType": "replication-instance", "Message": "Replication application shutdown", "EventCategories": [], "Date": 1590771645.776 } ] } ``` Para obter mais informações, consulte [Como trabalhar com eventos e notificações](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) no *Guia do usuário do AWS Database Migration Service.* + Para ver detalhes da API, consulte [DescribeEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-events.html) na *Referência de comandos da AWS CLI*. ### `describe-orderable-replication-instances` O código de exemplo a seguir mostra como usar `describe-orderable-replication-instances`. **AWS CLI** **Para descrever instâncias de replicação solicitáveis** O exemplo `describe-orderable-replication-instances` a seguir lista os tipos de instância de replicação que você pode solicitar. ``` aws dms describe-orderable-replication-instances ``` Resultado: ``` { "OrderableReplicationInstances": [ { "EngineVersion": "3.3.2", "ReplicationInstanceClass": "dms.c4.2xlarge", "StorageType": "gp2", "MinAllocatedStorage": 5, "MaxAllocatedStorage": 6144, "DefaultAllocatedStorage": 100, "IncludedAllocatedStorage": 100, "AvailabilityZones": [ "us-east-1a", "us-east-1b", "us-east-1c", "us-east-1d", "us-east-1e", "us-east-1f" ] }, { "EngineVersion": "3.3.2", "ReplicationInstanceClass": "dms.c4.4xlarge", "StorageType": "gp2", "MinAllocatedStorage": 5, "MaxAllocatedStorage": 6144, "DefaultAllocatedStorage": 100, "IncludedAllocatedStorage": 100, "AvailabilityZones": [ "us-east-1a", "us-east-1b", "us-east-1c", "us-east-1d", "us-east-1e", "us-east-1f" ] }, ...remaining output omitted... } ``` Para obter mais informações, consulte [Trabalhar com uma instância de replicação do AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html) no *Guia do usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [DescribeOrderableReplicationInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-orderable-replication-instances.html) na *Referência de comandos da AWS CLI*. ### `describe-refresh-schemas-status` O código de exemplo a seguir mostra como usar `describe-refresh-schemas-status`. **AWS CLI** **Para listar o status de atualização de um endpoint** O exemplo `describe-refresh-schemas-status` a seguir retorna o status de uma solicitação de atualização anterior. ``` aws dms describe-refresh-schemas-status \ --endpoint-arn arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA ``` Resultado: ``` { "RefreshSchemasStatus": { "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA", "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE", "Status": "successful", "LastRefreshDate": 1590786544.605 } } ``` + Para ver detalhes da API, consulte [DescribeRefreshSchemasStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-refresh-schemas-status.html) na *Referência de comandos da AWS CLI*. ### `describe-replication-instances` O código de exemplo a seguir mostra como usar `describe-replication-instances`. **AWS CLI** **Para descrever instâncias de replicação** O exemplo `describe-replication-instances` a seguir lista as instâncias de replicação na sua conta da AWS. ``` aws dms describe-replication-instances ``` Resultado: ``` { "ReplicationInstances": [ { "ReplicationInstanceIdentifier": "my-repl-instance", "ReplicationInstanceClass": "dms.t2.micro", "ReplicationInstanceStatus": "available", "AllocatedStorage": 5, "InstanceCreateTime": 1590011235.952, "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sg-f839b688", "Status": "active" } ], "AvailabilityZone": "us-east-1e", "ReplicationSubnetGroup": { "ReplicationSubnetGroupIdentifier": "default", "ReplicationSubnetGroupDescription": "default", "VpcId": "vpc-136a4c6a", "SubnetGroupStatus": "Complete", "Subnets": [ { "SubnetIdentifier": "subnet-da327bf6", "SubnetAvailabilityZone": { "Name": "us-east-1a" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-42599426", "SubnetAvailabilityZone": { "Name": "us-east-1d" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-bac383e0", "SubnetAvailabilityZone": { "Name": "us-east-1c" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-6746046b", "SubnetAvailabilityZone": { "Name": "us-east-1f" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-d7c825e8", "SubnetAvailabilityZone": { "Name": "us-east-1e" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-cbfff283", "SubnetAvailabilityZone": { "Name": "us-east-1b" }, "SubnetStatus": "Active" } ] }, "PreferredMaintenanceWindow": "wed:11:42-wed:12:12", "PendingModifiedValues": { "MultiAZ": true }, "MultiAZ": false, "EngineVersion": "3.3.2", "AutoMinorVersionUpgrade": true, "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/f7bc0f8e-1a3a-4ace-9faa-e8494fa3921a", "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE", "ReplicationInstancePublicIpAddress": "3.230.18.248", "ReplicationInstancePrivateIpAddress": "172.31.75.90", "ReplicationInstancePublicIpAddresses": [ "3.230.18.248" ], "ReplicationInstancePrivateIpAddresses": [ "172.31.75.90" ], "PubliclyAccessible": true, "FreeUntil": 1590194829.267 } ] } ``` Para obter mais informações, consulte [Trabalhar com uma instância de replicação do AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html) no *Guia do usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [DescribeReplicationInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-replication-instances.html) na *Referência de comandos da AWS CLI*. ### `describe-replication-subnet-groups` O código de exemplo a seguir mostra como usar `describe-replication-subnet-groups`. **AWS CLI** **Para exibir os grupos de sub-redes disponíveis** O exemplo `describe-replication-subnet-groups` a seguir lista os grupos de sub-redes disponíveis. ``` aws dms describe-replication-subnet-groups \ --filter "Name=replication-subnet-group-id,Values=my-subnet-group" ``` Resultado: ``` { "ReplicationSubnetGroups": [ { "ReplicationSubnetGroupIdentifier": "my-subnet-group", "ReplicationSubnetGroupDescription": "my subnet group", "VpcId": "vpc-136a4c6a", "SubnetGroupStatus": "Complete", "Subnets": [ { "SubnetIdentifier": "subnet-da327bf6", "SubnetAvailabilityZone": { "Name": "us-east-1a" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-bac383e0", "SubnetAvailabilityZone": { "Name": "us-east-1c" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-d7c825e8", "SubnetAvailabilityZone": { "Name": "us-east-1e" }, "SubnetStatus": "Active" } ] } ] } ``` Para obter mais informações, consulte [Configurar uma rede para uma instância de replicação](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.VPC.html) no *Guia do Usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [DescribeReplicationSubnetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-replication-subnet-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-replication-task-assessment-results` O código de exemplo a seguir mostra como usar `describe-replication-task-assessment-results`. **AWS CLI** **Para listar os resultados das avaliações de tarefas de replicação** O exemplo `describe-replication-task-assessment-results` a seguir lista os resultados de uma avaliação anterior da tarefa. ``` aws dms describe-replication-task-assessment-results ``` Resultado: ``` { "ReplicationTaskAssessmentResults": [ { "ReplicationTaskIdentifier": "moveit2", "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII", "ReplicationTaskLastAssessmentDate": 1590790230.0, "AssessmentStatus": "No issues found", "AssessmentResultsFile": "moveit2/2020-05-29-22-10" } ] } ``` Para obter mais informações, consulte [Criação de um relatório de avaliação de tarefas](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html) no *Guia do Usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [DescribeReplicationTaskAssessmentResults](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-replication-task-assessment-results.html) na *Referência de comandos da AWS CLI*. ### `describe-replication-tasks` O código de exemplo a seguir mostra como usar `describe-replication-tasks`. **AWS CLI** **Para descrever uma tarefa de replicação** O exemplo `describe-replication-tasks` a seguir descreve as tarefas de replicação atuais. ``` aws dms describe-replication-tasks ``` Resultado: ``` { "ReplicationTasks": [ { "ReplicationTaskIdentifier": "moveit2", "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA", "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:EOM4SFKCZEYHZBFGAGZT3QEC5U", "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE", "MigrationType": "full-load", "TableMappings": ...output omitted... , "ReplicationTaskSettings": ...output omitted... , "Status": "stopped", "StopReason": "Stop Reason FULL_LOAD_ONLY_FINISHED", "ReplicationTaskCreationDate": 1590524772.505, "ReplicationTaskStartDate": 1590619805.212, "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII", "ReplicationTaskStats": { "FullLoadProgressPercent": 100, "ElapsedTimeMillis": 0, "TablesLoaded": 0, "TablesLoading": 0, "TablesQueued": 0, "TablesErrored": 0, "FreshStartDate": 1590619811.528, "StartDate": 1590619811.528, "StopDate": 1590619842.068 } } ] } ``` Para obter mais informações, consulte [Como trabalhar com tarefas do AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html) no *Guia do usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [DescribeReplicationTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-replication-tasks.html) na *Referência de comandos da AWS CLI*. ### `describe-schemas` O código de exemplo a seguir mostra como usar `describe-schemas`. **AWS CLI** **Como descrever esquemas de banco de dados** O exemplo `describe-schemas` a seguir lista as tabelas disponíveis em um endpoint. ``` aws dms describe-schemas \ --endpoint-arn "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA" ``` Resultado: ``` { "Schemas": [ "prodrep" ] } ``` Para ter mais informações, consulte [Este é o título do tópico](https://link.to.the/topic/page) no *Guia do usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [DescribeSchemas](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-schemas.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar as tags de um recurso** O exemplo `list-tags-for-resource` a seguir lista as tags de uma instância de replicação. ``` aws dms list-tags-for-resource \ --resource-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE ``` Resultado: ``` { "TagList": [ { "Key": "Project", "Value": "dbMigration" }, { "Key": "Environment", "Value": "PROD" } ] } ``` Para ter mais informações, consulte [Marcação de recursos](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tagging.html) no *Guia do usuário do AWS Database Migration Service*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `modify-endpoint` O código de exemplo a seguir mostra como usar `modify-endpoint`. **AWS CLI** **Para modificar um endpoint** O exemplo `modify-endpoint` a seguir adiciona um atributo de conexão adicional a um endpoint. ``` aws dms modify-endpoint \ --endpoint-arn "arn:aws:dms:us-east-1:123456789012:endpoint:GUVAFG34EECUOJ6QVZ56DAHT3U" \ --extra-connection-attributes "compressionType=GZIP" ``` Resultado: ``` { "Endpoint": { "EndpointIdentifier": "src-endpoint", "EndpointType": "SOURCE", "EngineName": "s3", "EngineDisplayName": "Amazon S3", "ExtraConnectionAttributes": "compressionType=GZIP;csvDelimiter=,;csvRowDelimiter=\\n;", "Status": "active", "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:GUVAFG34EECUOJ6QVZ56DAHT3U", "SslMode": "none", "ServiceAccessRoleArn": "arn:aws:iam::123456789012:role/my-s3-access-role", "S3Settings": { "ServiceAccessRoleArn": "arn:aws:iam::123456789012:role/my-s3-access-role", "CsvRowDelimiter": "\\n", "CsvDelimiter": ",", "BucketFolder": "", "BucketName": "", "CompressionType": "GZIP", "EnableStatistics": true } } } ``` Para obter mais informações, consulte Como trabalhar com endpoints do AWS DMS `\$1\$1 no *Guia do usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [ModifyEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/modify-endpoint.html) na *Referência de comandos da AWS CLI*. ### `modify-event-subscription` O código de exemplo a seguir mostra como usar `modify-event-subscription`. **AWS CLI** **Para modificar a assinatura de um evento** O exemplo `modify-event-subscription` a seguir altera o tipo de origem de uma assinatura de evento. ``` aws dms modify-event-subscription \ --subscription-name "my-dms-events" \ --source-type replication-task ``` Resultado: ``` { "EventSubscription": { "CustomerAwsId": "123456789012", "CustSubscriptionId": "my-dms-events", "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:my-sns-topic", "Status": "modifying", "SubscriptionCreationTime": "2020-05-29 17:04:40.262", "SourceType": "replication-task", "Enabled": true } } ``` Para obter mais informações, consulte [Como trabalhar com eventos e notificações](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) no *Guia do usuário do AWS Database Migration Service.* + Para ver detalhes da API, consulte [ModifyEventSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/modify-event-subscription.html) na *Referência de comandos da AWS CLI*. ### `modify-replication-instance` O código de exemplo a seguir mostra como usar `modify-replication-instance`. **AWS CLI** **Para modificar uma instância de replicação** O exemplo `modify-replication-instance` a seguir modifica uma instância de replicação para que ela use uma implantação Multi-AZ. ``` aws dms modify-replication-instance \ --replication-instance-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE \ --multi-az ``` Resultado: ``` { "ReplicationInstance": { "ReplicationInstanceIdentifier": "my-repl-instance", "ReplicationInstanceClass": "dms.t2.micro", "ReplicationInstanceStatus": "available", "AllocatedStorage": 5, "InstanceCreateTime": 1590011235.952, ...output omitted... "PendingModifiedValues": { "MultiAZ": true }, "MultiAZ": false, "EngineVersion": "3.3.2", "AutoMinorVersionUpgrade": true, "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/f7bc0f8e-1a3a-4ace-9faa-e8494fa3921a", ...output omitted... } } ``` Para obter mais informações, consulte [Trabalhar com uma instância de replicação do AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html) no *Guia do usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [ModifyReplicationInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/modify-replication-instance.html) na *Referência de comandos da AWS CLI*. ### `modify-replication-subnet-group` O código de exemplo a seguir mostra como usar `modify-replication-subnet-group`. **AWS CLI** **Para modificar um grupo de sub-redes** O exemplo `modify-replication-subnet-group` a seguir altera as listas de sub-redes associadas a um grupo de sub-redes. ``` aws dms modify-replication-subnet-group \ --replication-subnet-group-identifier my-subnet-group \ --subnet-id subnet-da327bf6 subnet-bac383e0 ``` Resultado: ``` { "ReplicationSubnetGroup": { "ReplicationSubnetGroupIdentifier": "my-subnet-group", "ReplicationSubnetGroupDescription": "my subnet group", "VpcId": "vpc-136a4c6a", "SubnetGroupStatus": "Complete", "Subnets": [ { "SubnetIdentifier": "subnet-da327bf6", "SubnetAvailabilityZone": { "Name": "us-east-1a" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-bac383e0", "SubnetAvailabilityZone": { "Name": "us-east-1c" }, "SubnetStatus": "Active" } ] } } ``` Para obter mais informações, consulte [Configurar uma rede para uma instância de replicação](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.VPC.html) no *Guia do Usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [ModifyReplicationSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/modify-replication-subnet-group.html) na *Referência de comandos da AWS CLI*. ### `modify-replication-task` O código de exemplo a seguir mostra como usar `modify-replication-task`. **AWS CLI** **Para modificar uma tarefa de replicação** O exemplo `modify-replication-task` a seguir altera os mapeamentos de tabela de uma tarefa. ``` aws dms modify-replication-task \ --replication-task-arn "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII" \ --table-mappings file://table-mappings.json ``` Conteúdo de `table-mappings.json`: ``` { "rules": [ { "rule-type": "selection", "rule-id": "1", "rule-name": "1", "object-locator": { "schema-name": "prodrep", "table-name": "ACCT_%" }, "rule-action": "include", "filters": [] } ] } ``` Resultado: ``` { "ReplicationTask": { "ReplicationTaskIdentifier": "moveit2", "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA", "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:EOM4SFKCZEYHZBFGAGZT3QEC5U", "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE", "MigrationType": "full-load", "TableMappings": ...output omitted..., "ReplicationTaskSettings": ...output omitted..., "Status": "modifying", "StopReason": "Stop Reason FULL_LOAD_ONLY_FINISHED", "ReplicationTaskCreationDate": 1590524772.505, "ReplicationTaskStartDate": 1590789424.653, "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII" } } ``` Para obter mais informações, consulte [Como trabalhar com tarefas do AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html) no *Guia do usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [ModifyReplicationTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/modify-replication-task.html) na *Referência de comandos da AWS CLI*. ### `reboot-replication-instance` O código de exemplo a seguir mostra como usar `reboot-replication-instance`. **AWS CLI** **Para reiniciar uma instância de replicação** O exemplo da `reboot-replication-instance` a seguir reinicializa uma instância de replicação. ``` aws dms reboot-replication-instance \ --replication-instance-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE ``` Resultado: ``` { "ReplicationInstance": { "ReplicationInstanceIdentifier": "my-repl-instance", "ReplicationInstanceClass": "dms.t2.micro", "ReplicationInstanceStatus": "rebooting", "AllocatedStorage": 5, "InstanceCreateTime": 1590011235.952, ... output omitted ... } } ``` Para obter mais informações, consulte [Trabalhar com uma instância de replicação do AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html) no *Guia do usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [RebootReplicationInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/reboot-replication-instance.html) na *Referência de comandos da AWS CLI*. ### `refresh-schemas` O código de exemplo a seguir mostra como usar `refresh-schemas`. **AWS CLI** **Para atualizar esquemas de banco de dados** O exemplo `refresh-schemas` a seguir solicita que o AWS DMS atualize a lista de esquemas em um endpoint. ``` aws dms refresh-schemas \ --replication-instance-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE \ --endpoint-arn "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA" ``` Resultado: ``` { "RefreshSchemasStatus": { "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA", "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE", "Status": "refreshing", "LastRefreshDate": 1590019949.103 } } ``` + Para ver detalhes da API, consulte [RefreshSchemas](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/refresh-schemas.html) na *Referência de comandos da AWS CLI*. ### `reload-tables` O código de exemplo a seguir mostra como usar `reload-tables`. **AWS CLI** **Para atualizar a lista de tabelas disponíveis em um endpoint** O exemplo `reload-tables` a seguir recarrega a lista de tabelas disponíveis em um endpoint. ``` aws dms reload-tables \ --replication-task-arn "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII" \ --tables-to-reload "SchemaName=prodrep,TableName=ACCT_BAL" ``` Resultado: ``` { "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII" } ``` + Para ver detalhes da API, consulte [ReloadTables](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/reload-tables.html) na *Referência de comandos da AWS CLI*. ### `remove-tags-from-resource` O código de exemplo a seguir mostra como usar `remove-tags-from-resource`. **AWS CLI** **Para remover tags de uma instância de replicação** O exemplo `remove-tags-from-resource` a seguir remove tags de uma instância de replicação. ``` aws dms remove-tags-from-resource \ --resource-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE \ --tag-keys Environment Project ``` Este comando não produz saída. Para ter mais informações, consulte [Marcação de recursos](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tagging.html) no *Guia do usuário do AWS Database Migration Service*. + Consulte detalhes da API em [RemoveTagsFromResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/remove-tags-from-resource.html) na *Referência de comandos da AWS CLI*. ### `start-replication-task-assessment` O código de exemplo a seguir mostra como usar `start-replication-task-assessment`. **AWS CLI** **Para iniciar uma avaliação de tarefas** O exemplo `start-replication-task-assessment` a seguir inicia uma avaliação da tarefa de replicação. ``` aws dms start-replication-task-assessment \ --replication-task-arn arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII ``` Resultado: ``` { "ReplicationTask": { "ReplicationTaskIdentifier": "moveit2", "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA", "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:EOM4SFKCZEYHZBFGAGZT3QEC5U", "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE", "MigrationType": "full-load", "TableMappings": ...output omitted..., "ReplicationTaskSettings": ...output omitted..., "Status": "testing", "StopReason": "Stop Reason FULL_LOAD_ONLY_FINISHED", "ReplicationTaskCreationDate": 1590524772.505, "ReplicationTaskStartDate": 1590789988.677, "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII" } } ``` Para obter mais informações, consulte [Criação de um relatório de avaliação de tarefas](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html) no *Guia do Usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [StartReplicationTaskAssessment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/start-replication-task-assessment.html) na *Referência de comandos da AWS CLI*. ### `start-replication-task` O código de exemplo a seguir mostra como usar `start-replication-task`. **AWS CLI** **Para iniciar uma tarefa de replicação** O exemplo `command-name` a seguir lista os widgets disponíveis na sua conta da AWS. ``` aws dms start-replication-task \ --replication-task-arn arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII \ --start-replication-task-type reload-target ``` Resultado: ``` { "ReplicationTask": { "ReplicationTaskIdentifier": "moveit2", "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA", "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:EOM4SFKCZEYHZBFGAGZT3QEC5U", "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE", "MigrationType": "full-load", "TableMappings": ...output omitted... , "ReplicationTaskSettings": ...output omitted... , "Status": "starting", "ReplicationTaskCreationDate": 1590524772.505, "ReplicationTaskStartDate": 1590619805.212, "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII" } } ``` Para obter mais informações, consulte [Como trabalhar com tarefas do AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html) no *Guia do usuário do AWS Database Migration Service*. + Para obter detalhes sobre a API, consulte [StartReplicationTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/start-replication-task.html) na *Referência de comandos da AWS CLI*. ### `stop-replication-task` O código de exemplo a seguir mostra como usar `stop-replication-task`. **AWS CLI** **Para interromper uma tarefa** O exemplo `stop-replication-task` a seguir interrompe uma tarefa. ``` aws dms stop-replication-task \ --replication-task-arn arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII ``` Resultado: ``` { "ReplicationTask": { "ReplicationTaskIdentifier": "moveit2", "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA", "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:EOM4SFKCZEYHZBFGAGZT3QEC5U", "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE", "MigrationType": "full-load", "TableMappings": ...output omitted..., "ReplicationTaskSettings": ...output omitted..., "Status": "stopping", "ReplicationTaskCreationDate": 1590524772.505, "ReplicationTaskStartDate": 1590789424.653, "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII" } } ``` Para obter mais informações, consulte [Como trabalhar com tarefas do AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html) no *Guia do usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [StopReplicationTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/stop-replication-task.html) na *Referência de comandos da AWS CLI*. ### `test-connection` O código de exemplo a seguir mostra como usar `test-connection`. **AWS CLI** **Para testar uma conexão com um endpoint** O exemplo `test-connection` a seguir testa se um endpoint pode ser acessado a partir de uma instância de replicação. ``` aws dms test-connection \ --replication-instance-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE \ --endpoint-arn arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA ``` Resultado: ``` { "Connection": { "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE", "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA", "Status": "testing", "EndpointIdentifier": "src-database-1", "ReplicationInstanceIdentifier": "my-repl-instance" } } ``` Para obter mais informações, consulte [Criação de endpoints de origem e destino](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.Creating.html) no *Guia do usuário do AWS Database Migration Service*. + Para ver detalhes da API, consulte [TestConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/test-connection.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon DocumentDB usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o Amazon DocumentDB. *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-tags-to-resource` O código de exemplo a seguir mostra como usar `add-tags-to-resource`. **AWS CLI** **Para adicionar uma ou mais tags a um recurso especificado** O exemplo `add-tags-to-resource` a seguir adiciona o ID a `sample-cluster`. Uma tag (`CropB`) tem um nome de chave, mas nenhum valor. ``` aws docdb add-tags-to-resource \ --resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \ --tags Key="CropA",Value="Apple" Key="CropB" Key="CropC",Value="Corn" ``` Este comando não produz saída. Para obter mais informações, consulte [Marcar recursos do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/tagging.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Consulte detalhes da API em [AddTagsToResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/add-tags-to-resource.html) na *Referência de comandos da AWS CLI*. ### `apply-pending-maintenance-action` O código de exemplo a seguir mostra como usar `apply-pending-maintenance-action`. **AWS CLI** **Como fazer com que as ações de manutenção pendentes ocorram durante a próxima janela de manutenção** O exemplo `apply-pending-maintenance-action` a seguir faz com que todas as ações de atualização do sistema sejam executadas durante a próxima janela de manutenção programada. ``` aws docdb apply-pending-maintenance-action \ --resource-identifier arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \ --apply-action system-update \ --opt-in-type next-maintenance ``` Este comando não produz saída. Para obter mais informações, consulte [plicar atualizações ao Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-maintain.html#db-instance-updates-apply) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [ApplyPendingMaintenanceAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/apply-pending-maintenance-action.html) na *Referência de comandos da AWS CLI*. ### `copy-db-cluster-parameter-group` O código de exemplo a seguir mostra como usar `copy-db-cluster-parameter-group`. **AWS CLI** **Como duplicar um grupo de parâmetro de cluster de banco de dados existente** O exemplo `copy-db-cluster-parameter-group` a seguir faz uma cópia do grupo de parâmetro `custom-docdb3-6` chamado `custom-docdb3-6-copy`. Ao fazer a cópia, ele adiciona tags ao novo grupo de parâmetros. ``` aws docdb copy-db-cluster-parameter-group \ --source-db-cluster-parameter-group-identifier custom-docdb3-6 \ --target-db-cluster-parameter-group-identifier custom-docdb3-6-copy \ --target-db-cluster-parameter-group-description "Copy of custom-docdb3-6" \ --tags Key="CopyNumber",Value="1" Key="Modifiable",Value="Yes" ``` Resultado: ``` { "DBClusterParameterGroup": { "DBParameterGroupFamily": "docdb3.6", "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:12345678901:cluster-pg:custom-docdb3-6-copy", "DBClusterParameterGroupName": "custom-docdb3-6-copy", "Description": "Copy of custom-docdb3-6" } } ``` Para obter mais informações, consulte [Copiar um grupo de parâmetros do cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-copy.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [CopyDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/copy-db-cluster-parameter-group.html) na *Referência de comandos da AWS CLI*. ### `copy-db-cluster-snapshot` O código de exemplo a seguir mostra como usar `copy-db-cluster-snapshot`. **AWS CLI** **Para criar cópia de um snapshot** O exemplo da `copy-db-cluster-snapshot` a seguir faz uma cópia do `sample-cluster-snapshot` denominado `sample-cluster-snapshot-copy`. A cópia tem todas as tags do original, além de uma nova tag com o nome da chave `CopyNumber`. ``` aws docdb copy-db-cluster-snapshot \ --source-db-cluster-snapshot-identifier sample-cluster-snapshot \ --target-db-cluster-snapshot-identifier sample-cluster-snapshot-copy \ --copy-tags \ --tags Key="CopyNumber",Value="1" ``` Este comando não produz saída. Para obter mais informações, consulte [Copiar um snapshot de cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshot-copy.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [CopyDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/copy-db-cluster-snapshot.html) na *Referência de comandos da AWS CLI*. ### `create-db-cluster-parameter-group` O código de exemplo a seguir mostra como usar `create-db-cluster-parameter-group`. **AWS CLI** **Para criar grupos de parâmetros de cluster do Amazon DocumentDB** O exemplo `create-db-cluster-parameter-group` a seguir cria o grupo de parâmetros do cluster de banco de dados `sample-parameter-group` usando a família `docdb3.6`. ``` aws docdb create-db-cluster-parameter-group \ --db-cluster-parameter-group-name sample-parameter-group \ --db-parameter-group-family docdb3.6 \ --description "Sample parameter group based on docdb3.6" ``` Resultado: ``` { "DBClusterParameterGroup": { "Description": "Sample parameter group based on docdb3.6", "DBParameterGroupFamily": "docdb3.6", "DBClusterParameterGroupArn": "arn:aws:rds:us-west-2:123456789012:cluster-pg:sample-parameter-group", "DBClusterParameterGroupName": "sample-parameter-group" } } ``` Para obter mais informações, consulte [Criar um grupo de parâmetros do cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-create.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [CreateDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-cluster-parameter-group.html) na *Referência de comandos da AWS CLI*. ### `create-db-cluster-snapshot` O código de exemplo a seguir mostra como usar `create-db-cluster-snapshot`. **AWS CLI** **Para criar um snapshot manual do cluster do Amazon DocumentDB** O exemplo `create-db-cluster-snapshot` a seguir cria um snapshot de cluster de banco de dados da Amazon chamado sample-cluster-snapshot. ``` aws docdb create-db-cluster-snapshot \ --db-cluster-identifier sample-cluster \ --db-cluster-snapshot-identifier sample-cluster-snapshot ``` Resultado: ``` { "DBClusterSnapshot": { "MasterUsername": "master-user", "SnapshotCreateTime": "2019-03-18T18:27:14.794Z", "AvailabilityZones": [ "us-west-2a", "us-west-2b", "us-west-2c", "us-west-2d", "us-west-2e", "us-west-2f" ], "SnapshotType": "manual", "DBClusterSnapshotArn": "arn:aws:rds:us-west-2:123456789012:cluster-snapshot:sample-cluster-snapshot", "EngineVersion": "3.6.0", "PercentProgress": 0, "DBClusterSnapshotIdentifier": "sample-cluster-snapshot", "Engine": "docdb", "DBClusterIdentifier": "sample-cluster", "Status": "creating", "ClusterCreateTime": "2019-03-15T20:29:58.836Z", "Port": 0, "StorageEncrypted": false, "VpcId": "vpc-91280df6" } } ``` Para obter mais informações, consulte [Criar um snapshot de cluster manual](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshot-create.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [CreateDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-cluster-snapshot.html) na *Referência de comandos da AWS CLI*. ### `create-db-cluster` O código de exemplo a seguir mostra como usar `create-db-cluster`. **AWS CLI** **Para criar um cluster do Amazon DocumentDB** O exemplo `create-db-cluster` a seguir cria um cluster do Amazon DocumentDB chamado `sample-cluster` com a janela de manutenção preferencial aos domingos, entre 20h30 e 11h00. ``` aws docdb create-db-cluster \ --db-cluster-identifier sample-cluster \ --engine docdb \ --master-username master-user \ --master-user-password password \ --preferred-maintenance-window Sun:20:30-Sun:21:00 ``` Resultado: ``` { "DBCluster": { "DBClusterParameterGroup": "default.docdb3.6", "AssociatedRoles": [], "DBSubnetGroup": "default", "ClusterCreateTime": "2019-03-18T18:06:34.616Z", "Status": "creating", "Port": 27017, "PreferredMaintenanceWindow": "sun:20:30-sun:21:00", "HostedZoneId": "ZNKXH85TT8WVW", "DBClusterMembers": [], "Engine": "docdb", "DBClusterIdentifier": "sample-cluster", "PreferredBackupWindow": "10:12-10:42", "AvailabilityZones": [ "us-west-2d", "us-west-2f", "us-west-2e" ], "MasterUsername": "master-user", "BackupRetentionPeriod": 1, "ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com", "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sg-77186e0d", "Status": "active" } ], "StorageEncrypted": false, "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster", "DbClusterResourceId": "cluster-L3R4YRSBUYDP4GLMTJ2WF5GH5Q", "MultiAZ": false, "Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com", "EngineVersion": "3.6.0" } } ``` Para obter mais informações, consulte [Criar um cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-create.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [CreateDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-cluster.html) na *Referência de comandos da AWS CLI*. ### `create-db-instance` O código de exemplo a seguir mostra como usar `create-db-instance`. **AWS CLI** **Para criar uma instância do cluster do Amazon DocumentDB** O exemplo `create-db-instance` a seguir cria a instância `sample-cluster-instance-2` em um cluster do Amazon DocumentDB `sample-cluster`. ``` aws docdb create-db-instance \ --db-cluster-identifier sample-cluster \ --db-instance-class db.r4.xlarge \ --db-instance-identifier sample-cluster-instance-2 \ --engine docdb ``` Resultado: ``` { "DBInstance": { "DBInstanceStatus": "creating", "PendingModifiedValues": { "PendingCloudwatchLogsExports": { "LogTypesToEnable": [ "audit" ] } }, "PubliclyAccessible": false, "PreferredBackupWindow": "00:00-00:30", "PromotionTier": 1, "EngineVersion": "3.6.0", "BackupRetentionPeriod": 3, "DBInstanceIdentifier": "sample-cluster-instance-2", "PreferredMaintenanceWindow": "tue:10:28-tue:10:58", "StorageEncrypted": false, "Engine": "docdb", "DBClusterIdentifier": "sample-cluster", "DBSubnetGroup": { "Subnets": [ { "SubnetAvailabilityZone": { "Name": "us-west-2a" }, "SubnetStatus": "Active", "SubnetIdentifier": "subnet-4e26d263" }, { "SubnetAvailabilityZone": { "Name": "us-west-2c" }, "SubnetStatus": "Active", "SubnetIdentifier": "subnet-afc329f4" }, { "SubnetAvailabilityZone": { "Name": "us-west-2d" }, "SubnetStatus": "Active", "SubnetIdentifier": "subnet-53ab3636" }, { "SubnetAvailabilityZone": { "Name": "us-west-2b" }, "SubnetStatus": "Active", "SubnetIdentifier": "subnet-991cb8d0" } ], "DBSubnetGroupDescription": "default", "SubnetGroupStatus": "Complete", "VpcId": "vpc-91280df6", "DBSubnetGroupName": "default" }, "DBInstanceClass": "db.r4.xlarge", "VpcSecurityGroups": [ { "Status": "active", "VpcSecurityGroupId": "sg-77186e0d" } ], "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster-instance-2", "DbiResourceId": "db-XEKJLEMGRV5ZKCARUVA4HO3ITE" } } ``` Para obter mais informações, consulte [Adicionar uma instância do Amazon DocumentDB a um cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-add.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [CreateDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-instance.html) na *Referência de comandos da AWS CLI*. ### `create-db-subnet-group` O código de exemplo a seguir mostra como usar `create-db-subnet-group`. **AWS CLI** **Para criar um grupo de sub-redes do Amazon DocumentDB** O exemplo `create-db-subnet-group` a seguir cria um grupo de sub-redes do Amazon DocumentDB chamado `sample-subnet-group`. ``` aws docdb create-db-subnet-group \ --db-subnet-group-description "a sample subnet group" \ --db-subnet-group-name sample-subnet-group \ --subnet-ids "subnet-29ab1025" "subnet-991cb8d0" "subnet-53ab3636" ``` Resultado: ``` { "DBSubnetGroup": { "SubnetGroupStatus": "Complete", "DBSubnetGroupName": "sample-subnet-group", "DBSubnetGroupDescription": "a sample subnet group", "VpcId": "vpc-91280df6", "DBSubnetGroupArn": "arn:aws:rds:us-west-2:123456789012:subgrp:sample-subnet-group", "Subnets": [ { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-53ab3636", "SubnetAvailabilityZone": { "Name": "us-west-2d" } }, { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-991cb8d0", "SubnetAvailabilityZone": { "Name": "us-west-2b" } }, { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-29ab1025", "SubnetAvailabilityZone": { "Name": "us-west-2c" } } ] } } ``` Para obter mais informações, consulte [Criar um grupo de sub-rede do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-group-create) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [CreateDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-subnet-group.html) na *Referência de comandos da AWS CLI*. ### `delete-db-cluster-parameter-group` O código de exemplo a seguir mostra como usar `delete-db-cluster-parameter-group`. **AWS CLI** **Para excluir grupos de parâmetros de cluster do Amazon DocumentDB** O exemplo `delete-db-cluster-parameter-group` a seguir exclui o grupo de parâmetros `sample-parameter-group` do Amazon DocumentDB. ``` aws docdb delete-db-cluster-parameter-group \ --db-cluster-parameter-group-name sample-parameter-group ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir um grupo de parâmetros do cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-delete.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [DeleteDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-cluster-parameter-group.html) na *Referência de comandos da AWS CLI*. ### `delete-db-cluster-snapshot` O código de exemplo a seguir mostra como usar `delete-db-cluster-snapshot`. **AWS CLI** **Para excluir um snapshot de cluster do Amazon DocumentDB** O exemplo `delete-db-cluster-snapshot` a seguir exclui o snapshot do cluster do Amazon DocumentDB `sample-cluster-snapshot`. ``` aws docdb delete-db-cluster-snapshot \ --db-cluster-snapshot-identifier sample-cluster-snapshot ``` Resultado: ``` { "DBClusterSnapshot": { "DBClusterIdentifier": "sample-cluster", "AvailabilityZones": [ "us-west-2a", "us-west-2b", "us-west-2c", "us-west-2d" ], "DBClusterSnapshotIdentifier": "sample-cluster-snapshot", "VpcId": "vpc-91280df6", "DBClusterSnapshotArn": "arn:aws:rds:us-west-2:123456789012:cluster-snapshot:sample-cluster-snapshot", "EngineVersion": "3.6.0", "Engine": "docdb", "SnapshotCreateTime": "2019-03-18T18:27:14.794Z", "Status": "available", "MasterUsername": "master-user", "ClusterCreateTime": "2019-03-15T20:29:58.836Z", "PercentProgress": 100, "StorageEncrypted": false, "SnapshotType": "manual", "Port": 0 } } ``` Para obter mais informações, consulte [Excluir um snapshot de cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshot-delete.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [DeleteDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-cluster-snapshot.html) na *Referência de comandos da AWS CLI*. ### `delete-db-cluster` O código de exemplo a seguir mostra como usar `delete-db-cluster`. **AWS CLI** **Para excluir um cluster do Amazon DocumentDB** O exemplo `delete-db-cluster` a seguir exclui o cluster do Amazon DocumentDB `sample-cluster`. Nenhum backup do cluster é feito antes de excluí-lo. OBSERVAÇÃO: você deve excluir todas as instâncias associadas ao cluster para excluí-lo. ``` aws docdb delete-db-cluster \ --db-cluster-identifier sample-cluster \ --skip-final-snapshot ``` Resultado: ``` { "DBCluster": { "DBClusterIdentifier": "sample-cluster", "DBSubnetGroup": "default", "EngineVersion": "3.6.0", "Engine": "docdb", "LatestRestorableTime": "2019-03-18T18:07:24.610Z", "PreferredMaintenanceWindow": "sun:20:30-sun:21:00", "StorageEncrypted": false, "EarliestRestorableTime": "2019-03-18T18:07:24.610Z", "Port": 27017, "VpcSecurityGroups": [ { "Status": "active", "VpcSecurityGroupId": "sg-77186e0d" } ], "MultiAZ": false, "MasterUsername": "master-user", "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster", "Status": "available", "PreferredBackupWindow": "10:12-10:42", "ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com", "AvailabilityZones": [ "us-west-2c", "us-west-2b", "us-west-2a" ], "Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com", "DbClusterResourceId": "cluster-L3R4YRSBUYDP4GLMTJ2WF5GH5Q", "ClusterCreateTime": "2019-03-18T18:06:34.616Z", "AssociatedRoles": [], "DBClusterParameterGroup": "default.docdb3.6", "HostedZoneId": "ZNKXH85TT8WVW", "BackupRetentionPeriod": 1, "DBClusterMembers": [] } } ``` Para obter mais informações, consulte [Excluir um cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-delete.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [DeleteDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-cluster.html) na *Referência de comandos da AWS CLI*. ### `delete-db-instance` O código de exemplo a seguir mostra como usar `delete-db-instance`. **AWS CLI** **Para excluir uma instância do Amazon DocumentDB** O exemplo `delete-db-instance` a seguir exclui a instância do Amazon DocumentDB `sample-cluster-instance-2`. ``` aws docdb delete-db-instance \ --db-instance-identifier sample-cluster-instance-2 ``` Resultado: ``` { "DBInstance": { "DBSubnetGroup": { "Subnets": [ { "SubnetAvailabilityZone": { "Name": "us-west-2a" }, "SubnetStatus": "Active", "SubnetIdentifier": "subnet-4e26d263" }, { "SubnetAvailabilityZone": { "Name": "us-west-2c" }, "SubnetStatus": "Active", "SubnetIdentifier": "subnet-afc329f4" }, { "SubnetAvailabilityZone": { "Name": "us-west-2d" }, "SubnetStatus": "Active", "SubnetIdentifier": "subnet-53ab3636" }, { "SubnetAvailabilityZone": { "Name": "us-west-2b" }, "SubnetStatus": "Active", "SubnetIdentifier": "subnet-991cb8d0" } ], "DBSubnetGroupName": "default", "DBSubnetGroupDescription": "default", "VpcId": "vpc-91280df6", "SubnetGroupStatus": "Complete" }, "PreferredBackupWindow": "00:00-00:30", "InstanceCreateTime": "2019-03-18T18:37:33.709Z", "DBInstanceClass": "db.r4.xlarge", "DbiResourceId": "db-XEKJLEMGRV5ZKCARUVA4HO3ITE", "BackupRetentionPeriod": 3, "Engine": "docdb", "VpcSecurityGroups": [ { "Status": "active", "VpcSecurityGroupId": "sg-77186e0d" } ], "AutoMinorVersionUpgrade": true, "PromotionTier": 1, "EngineVersion": "3.6.0", "Endpoint": { "Address": "sample-cluster-instance-2.corcjozrlsfc.us-west-2.docdb.amazonaws.com", "HostedZoneId": "ZNKXH85TT8WVW", "Port": 27017 }, "DBInstanceIdentifier": "sample-cluster-instance-2", "PreferredMaintenanceWindow": "tue:10:28-tue:10:58", "EnabledCloudwatchLogsExports": [ "audit" ], "PendingModifiedValues": {}, "DBInstanceStatus": "deleting", "PubliclyAccessible": false, "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster-instance-2", "DBClusterIdentifier": "sample-cluster", "AvailabilityZone": "us-west-2c", "StorageEncrypted": false } } ``` Para obter mais informações, consulte [Excluir uma instância do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-delete.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [DeleteDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-instance.html) na *Referência de comandos da AWS CLI*. ### `delete-db-subnet-group` O código de exemplo a seguir mostra como usar `delete-db-subnet-group`. **AWS CLI** **Para excluir um grupo de sub-redes do Amazon DocumentDB** O exemplo `delete-db-subnet-group` a seguir exclui o grupo de sub-redes `sample-subnet-group` do Amazon DocumentDB. ``` aws docdb delete-db-subnet-group \ --db-subnet-group-name sample-subnet-group ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir um grupo de sub-rede do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-group-delete) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [DeleteDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-subnet-group.html) na *Referência de comandos da AWS CLI*. ### `describe-db-cluster-parameter-groups` O código de exemplo a seguir mostra como usar `describe-db-cluster-parameter-groups`. **AWS CLI** **Como ver os detalhes de um ou mais grupos de parâmetros de cluster do Amazon DocumentDB** O exemplo `describe-db-cluster-parameter-groups` a seguir exibe detalhes do grupo de parâmetros do cluster do Amazon DocumentDB `custom3-6-param-grp`. ``` aws docdb describe-db-cluster-parameter-groups \ --db-cluster-parameter-group-name custom3-6-param-grp ``` Resultado: ``` { "DBClusterParameterGroups": [ { "DBParameterGroupFamily": "docdb3.6", "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:custom3-6-param-grp", "Description": "Custom docdb3.6 parameter group", "DBClusterParameterGroupName": "custom3-6-param-grp" } ] } ``` Para obter mais informações, consulte [Visualizar grupos de parâmetros do cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-describe.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [DescribeDbClusterParameterGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-parameter-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-db-cluster-parameters` O código de exemplo a seguir mostra como usar `describe-db-cluster-parameters`. **AWS CLI** **Como visualizar a lista de parâmetros detalhada de um grupo de parâmetros do cluster do Amazon DocumentDB.** O exemplo `describe-db-cluster-parameters` a seguir lista os parâmetros do grupo de parâmetros custom3-6-param-grp do Amazon DocumentDB. ``` aws docdb describe-db-cluster-parameters \ --db-cluster-parameter-group-name custom3-6-param-grp ``` Resultado: ``` { "Parameters": [ { "DataType": "string", "ParameterName": "audit_logs", "IsModifiable": true, "ApplyMethod": "pending-reboot", "Source": "system", "ApplyType": "dynamic", "AllowedValues": "enabled,disabled", "Description": "Enables auditing on cluster.", "ParameterValue": "disabled" }, { "DataType": "string", "ParameterName": "tls", "IsModifiable": true, "ApplyMethod": "pending-reboot", "Source": "system", "ApplyType": "static", "AllowedValues": "disabled,enabled", "Description": "Config to enable/disable TLS", "ParameterValue": "enabled" }, { "DataType": "string", "ParameterName": "ttl_monitor", "IsModifiable": true, "ApplyMethod": "pending-reboot", "Source": "user", "ApplyType": "dynamic", "AllowedValues": "disabled,enabled", "Description": "Enables TTL Monitoring", "ParameterValue": "enabled" } ] } ``` Para obter mais informações, consulte [Visualizar parâmetros do cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameters-describe.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [DescribeDbClusterParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-parameters.html) na *Referência de comandos da AWS CLI*. ### `describe-db-cluster-snapshot-attributes` O código de exemplo a seguir mostra como usar `describe-db-cluster-snapshot-attributes`. **AWS CLI** **Para listar os nomes e valores de atributos de um snapshot do Amazon DocumentDB** O exemplo `describe-db-cluster-snapshot-attributes` a seguir lista os nomes e valores dos atributos para o snapshot do Amazon DocumentDB `sample-cluster-snapshot`. ``` aws docdb describe-db-cluster-snapshot-attributes \ --db-cluster-snapshot-identifier sample-cluster-snapshot ``` Resultado: ``` { "DBClusterSnapshotAttributesResult": { "DBClusterSnapshotAttributes": [ { "AttributeName": "restore", "AttributeValues": [] } ], "DBClusterSnapshotIdentifier": "sample-cluster-snapshot" } } ``` Para obter mais informações, consulte [DescribeDBClusterSnapshotAttributes](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBClusterSnapshotAttributes.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [DescribeDbClusterSnapshotAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-snapshot-attributes.html) na *Referência de comandos da AWS CLI*. ### `describe-db-cluster-snapshots` O código de exemplo a seguir mostra como usar `describe-db-cluster-snapshots`. **AWS CLI** **Para descrever os snapshots do Amazon DocumentDB** O exemplo `describe-db-cluster-snapshots` a seguir exibe detalhes do snapshot do Amazon DocumentDB `sample-cluster-snapshot`. ``` aws docdb describe-db-cluster-snapshots \ --db-cluster-snapshot-identifier sample-cluster-snapshot ``` Resultado: ``` { "DBClusterSnapshots": [ { "AvailabilityZones": [ "us-west-2a", "us-west-2b", "us-west-2c", "us-west-2d" ], "Status": "available", "DBClusterSnapshotArn": "arn:aws:rds:us-west-2:123456789012:cluster-snapshot:sample-cluster-snapshot", "SnapshotCreateTime": "2019-03-15T20:41:26.515Z", "SnapshotType": "manual", "DBClusterSnapshotIdentifier": "sample-cluster-snapshot", "DBClusterIdentifier": "sample-cluster", "MasterUsername": "master-user", "StorageEncrypted": false, "VpcId": "vpc-91280df6", "EngineVersion": "3.6.0", "PercentProgress": 100, "Port": 0, "Engine": "docdb", "ClusterCreateTime": "2019-03-15T20:29:58.836Z" } ] } ``` Para obter mais informações, consulte [DescribeDBClusterSnapshots](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBClusterSnapshots.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [DescribeDbClusterSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-snapshots.html) na *Referência de comandos da AWS CLI*. ### `describe-db-clusters` O código de exemplo a seguir mostra como usar `describe-db-clusters`. **AWS CLI** **Para obter informações detalhadas sobre um ou mais clusters do Amazon DocumentDB.** O exemplo `describe-db-clusters` a seguir exibe detalhes do cluster do Amazon DocumentDB `sample-cluster`. Ao omitir o parâmetro `--db-cluster-identifier`, você pode obter informações de até 100 clusters. ``` aws docdb describe-db-clusters --db-cluster-identifier sample-cluster ``` Resultado: ``` { "DBClusters": [ { "DBClusterParameterGroup": "default.docdb3.6", "Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com", "PreferredBackupWindow": "00:00-00:30", "DBClusterIdentifier": "sample-cluster", "ClusterCreateTime": "2019-03-15T20:29:58.836Z", "LatestRestorableTime": "2019-03-18T20:28:03.239Z", "MasterUsername": "master-user", "DBClusterMembers": [ { "PromotionTier": 1, "DBClusterParameterGroupStatus": "in-sync", "IsClusterWriter": false, "DBInstanceIdentifier": "sample-cluster" }, { "PromotionTier": 1, "DBClusterParameterGroupStatus": "in-sync", "IsClusterWriter": true, "DBInstanceIdentifier": "sample-cluster2" } ], "PreferredMaintenanceWindow": "sat:04:30-sat:05:00", "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sg-77186e0d", "Status": "active" } ], "Engine": "docdb", "ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com", "DBSubnetGroup": "default", "MultiAZ": true, "AvailabilityZones": [ "us-west-2a", "us-west-2c", "us-west-2b" ], "EarliestRestorableTime": "2019-03-15T20:30:47.020Z", "DbClusterResourceId": "cluster-UP4EF2PVDDFVHHDJQTYDAIGHLE", "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster", "BackupRetentionPeriod": 3, "HostedZoneId": "ZNKXH85TT8WVW", "StorageEncrypted": false, "EnabledCloudwatchLogsExports": [ "audit" ], "AssociatedRoles": [], "EngineVersion": "3.6.0", "Port": 27017, "Status": "available" } ] } ``` Para obter mais informações, consulte [Descrever clusters do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-view-details.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [DescribeDbClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-clusters.html) na *Referência de comandos da AWS CLI*. ### `describe-db-engine-versions` O código de exemplo a seguir mostra como usar `describe-db-engine-versions`. **AWS CLI** **Para listar as versões disponíveis do mecanismo Amazon DocumentDB** O exemplo `describe-db-engine-versions` a seguir lista todas as versões disponíveis do mecanismo do Amazon DocumentDB. ``` aws docdb describe-db-engine-versions \ --engine docdb ``` Resultado: ``` { "DBEngineVersions": [ { "DBEngineVersionDescription": "DocDB version 1.0.200837", "DBParameterGroupFamily": "docdb3.6", "EngineVersion": "3.6.0", "ValidUpgradeTarget": [], "DBEngineDescription": "Amazon DocumentDB (with MongoDB compatibility)", "SupportsLogExportsToCloudwatchLogs": true, "Engine": "docdb", "ExportableLogTypes": [ "audit" ] } ] } ``` Para obter mais informações, consulte [DescribeDBEngineVersions](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBEngineVersions.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [DescribeDbEngineVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-engine-versions.html) na *Referência de comandos da AWS CLI*. ### `describe-db-instances` O código de exemplo a seguir mostra como usar `describe-db-instances`. **AWS CLI** **Como encontrar informações sobre instâncias do Amazon DocumentDB provisionadas** O exemplo `describe-db-instances` a seguir exibe detalhes da instância do Amazon DocumentDB `sample-cluster-instance`. Ao omitir o parâmetro `--db-instance-identifier`, você obtém informações de até 100 instâncias. ``` aws docdb describe-db-instances \ --db-instance-identifier sample-cluster-instance ``` Resultado: ``` { "DBInstances": [ { "Endpoint": { "HostedZoneId": "ZNKXH85TT8WVW", "Address": "sample-cluster-instance.corcjozrlsfc.us-west-2.docdb.amazonaws.com", "Port": 27017 }, "PreferredBackupWindow": "00:00-00:30", "DBInstanceStatus": "available", "DBInstanceClass": "db.r4.large", "EnabledCloudwatchLogsExports": [ "audit" ], "DBInstanceIdentifier": "sample-cluster-instance", "DBSubnetGroup": { "Subnets": [ { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-4e26d263", "SubnetAvailabilityZone": { "Name": "us-west-2a" } }, { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-afc329f4", "SubnetAvailabilityZone": { "Name": "us-west-2c" } }, { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-53ab3636", "SubnetAvailabilityZone": { "Name": "us-west-2d" } }, { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-991cb8d0", "SubnetAvailabilityZone": { "Name": "us-west-2b" } } ], "DBSubnetGroupName": "default", "SubnetGroupStatus": "Complete", "DBSubnetGroupDescription": "default", "VpcId": "vpc-91280df6" }, "InstanceCreateTime": "2019-03-15T20:36:06.338Z", "Engine": "docdb", "StorageEncrypted": false, "AutoMinorVersionUpgrade": true, "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster-instance", "PreferredMaintenanceWindow": "tue:08:39-tue:09:09", "VpcSecurityGroups": [ { "Status": "active", "VpcSecurityGroupId": "sg-77186e0d" } ], "DBClusterIdentifier": "sample-cluster", "PendingModifiedValues": {}, "BackupRetentionPeriod": 3, "PubliclyAccessible": false, "EngineVersion": "3.6.0", "PromotionTier": 1, "AvailabilityZone": "us-west-2c", "DbiResourceId": "db-A2GIKUV6KPOHITGGKI2NHVISZA" } ] } ``` Para obter mais informações, consulte [Descrever instâncias do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-view-details.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [DescribeDbInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-instances.html) na *Referência de comandos da AWS CLI*. ### `describe-db-subnet-groups` O código de exemplo a seguir mostra como usar `describe-db-subnet-groups`. **AWS CLI** **Para recuperar uma lista de descrições de sub-rede do Amazon DocumentDB** O exemplo `describe-db-subnet-groups` a seguir descreve detalhes da sub-rede do Amazon DocumentDB chamada `default`. ``` aws docdb describe-db-subnet-groups \ --db-subnet-group-name default ``` Resultado: ``` { "DBSubnetGroups": [ { "VpcId": "vpc-91280df6", "DBSubnetGroupArn": "arn:aws:rds:us-west-2:123456789012:subgrp:default", "Subnets": [ { "SubnetIdentifier": "subnet-4e26d263", "SubnetStatus": "Active", "SubnetAvailabilityZone": { "Name": "us-west-2a" } }, { "SubnetIdentifier": "subnet-afc329f4", "SubnetStatus": "Active", "SubnetAvailabilityZone": { "Name": "us-west-2c" } }, { "SubnetIdentifier": "subnet-53ab3636", "SubnetStatus": "Active", "SubnetAvailabilityZone": { "Name": "us-west-2d" } }, { "SubnetIdentifier": "subnet-991cb8d0", "SubnetStatus": "Active", "SubnetAvailabilityZone": { "Name": "us-west-2b" } } ], "DBSubnetGroupName": "default", "SubnetGroupStatus": "Complete", "DBSubnetGroupDescription": "default" } ] } ``` Para obter mais informações, consulte [Descrever grupos de sub-rede](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-groups-describe) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [DescribeDbSubnetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-subnet-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-engine-default-cluster-parameters` O código de exemplo a seguir mostra como usar `describe-engine-default-cluster-parameters`. **AWS CLI** **Para descrever as informações sobre o mecanismo padrão e parâmetros do sistema do Amazon DocumentDB** O exemplo `describe-engine-default-cluster-parameters` a seguir exibe detalhes sobre as informações sobre o mecanismo padrão e parâmetros do sistema do grupo de parâmetros do Amazon DocumentDB `docdb3.6`. ``` aws docdb describe-engine-default-cluster-parameters \ --db-parameter-group-family docdb3.6 ``` Resultado: ``` { "EngineDefaults": { "DBParameterGroupFamily": "docdb3.6", "Parameters": [ { "ApplyType": "dynamic", "ParameterValue": "disabled", "Description": "Enables auditing on cluster.", "Source": "system", "DataType": "string", "MinimumEngineVersion": "3.6.0", "AllowedValues": "enabled,disabled", "ParameterName": "audit_logs", "IsModifiable": true }, { "ApplyType": "static", "ParameterValue": "enabled", "Description": "Config to enable/disable TLS", "Source": "system", "DataType": "string", "MinimumEngineVersion": "3.6.0", "AllowedValues": "disabled,enabled", "ParameterName": "tls", "IsModifiable": true }, { "ApplyType": "dynamic", "ParameterValue": "enabled", "Description": "Enables TTL Monitoring", "Source": "system", "DataType": "string", "MinimumEngineVersion": "3.6.0", "AllowedValues": "disabled,enabled", "ParameterName": "ttl_monitor", "IsModifiable": true } ] } } ``` Para obter mais informações, consulte [DescribeEngineDefaultClusterParameters](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeEngineDefaultClusterParameters.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [DescribeEngineDefaultClusterParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-engine-default-cluster-parameters.html) na *Referência de comandos da AWS CLI*. ### `describe-event-categories` O código de exemplo a seguir mostra como usar `describe-event-categories`. **AWS CLI** **Para descrever todas as categorias de eventos do Amazon DocumentDB** O exemplo `describe-event-categories` a seguir lista todas as categorias do tipo de fonte de eventos da Amazon DocumentDB `db-instance`. ``` aws docdb describe-event-categories \ --source-type db-cluster ``` Resultado: ``` { "EventCategoriesMapList": [ { "SourceType": "db-cluster", "EventCategories": [ "failover", "maintenance", "notification", "failure" ] } ] } ``` Para obter mais informações, consulte [Visualizar categorias de eventos](https://docs.aws.amazon.com/documentdb/latest/developerguide/managing-events.html#viewing-event-categories) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [DescribeEventCategories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-event-categories.html) na *Referência de comandos da AWS CLI*. ### `describe-events` O código de exemplo a seguir mostra como usar `describe-events`. **AWS CLI** **Para listar eventos do Amazon DocumentDB** O exemplo `describe-events` a seguir lista todos os eventos do Amazon DocumentDB das últimas 24 horas (1.440 minutos). ``` aws docdb describe-events \ --duration 1440 ``` Este comando não produz saída. Resultado: ``` { "Events": [ { "EventCategories": [ "failover" ], "Message": "Started cross AZ failover to DB instance: sample-cluster", "Date": "2019-03-18T21:36:29.807Z", "SourceArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster", "SourceIdentifier": "sample-cluster", "SourceType": "db-cluster" }, { "EventCategories": [ "availability" ], "Message": "DB instance restarted", "Date": "2019-03-18T21:36:40.793Z", "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster", "SourceIdentifier": "sample-cluster", "SourceType": "db-instance" }, { "EventCategories": [], "Message": "A new writer was promoted. Restarting database as a reader.", "Date": "2019-03-18T21:36:43.873Z", "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", "SourceIdentifier": "sample-cluster2", "SourceType": "db-instance" }, { "EventCategories": [ "availability" ], "Message": "DB instance restarted", "Date": "2019-03-18T21:36:51.257Z", "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", "SourceIdentifier": "sample-cluster2", "SourceType": "db-instance" }, { "EventCategories": [ "failover" ], "Message": "Completed failover to DB instance: sample-cluster", "Date": "2019-03-18T21:36:53.462Z", "SourceArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster", "SourceIdentifier": "sample-cluster", "SourceType": "db-cluster" }, { "Date": "2019-03-19T16:51:48.847Z", "EventCategories": [ "configuration change" ], "Message": "Updated parameter audit_logs to enabled with apply method pending-reboot", "SourceIdentifier": "custom3-6-param-grp", "SourceType": "db-parameter-group" }, { "EventCategories": [ "configuration change" ], "Message": "Applying modification to database instance class", "Date": "2019-03-19T17:55:20.095Z", "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", "SourceIdentifier": "sample-cluster2", "SourceType": "db-instance" }, { "EventCategories": [ "availability" ], "Message": "DB instance shutdown", "Date": "2019-03-19T17:56:31.127Z", "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", "SourceIdentifier": "sample-cluster2", "SourceType": "db-instance" }, { "EventCategories": [ "configuration change" ], "Message": "Finished applying modification to DB instance class", "Date": "2019-03-19T18:00:45.822Z", "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", "SourceIdentifier": "sample-cluster2", "SourceType": "db-instance" }, { "EventCategories": [ "availability" ], "Message": "DB instance restarted", "Date": "2019-03-19T18:00:53.397Z", "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", "SourceIdentifier": "sample-cluster2", "SourceType": "db-instance" }, { "EventCategories": [ "availability" ], "Message": "DB instance shutdown", "Date": "2019-03-19T18:23:36.045Z", "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", "SourceIdentifier": "sample-cluster2", "SourceType": "db-instance" }, { "EventCategories": [ "availability" ], "Message": "DB instance restarted", "Date": "2019-03-19T18:23:46.209Z", "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", "SourceIdentifier": "sample-cluster2", "SourceType": "db-instance" }, { "Date": "2019-03-19T18:39:05.822Z", "EventCategories": [ "configuration change" ], "Message": "Updated parameter ttl_monitor to enabled with apply method immediate", "SourceIdentifier": "custom3-6-param-grp", "SourceType": "db-parameter-group" }, { "Date": "2019-03-19T18:39:48.067Z", "EventCategories": [ "configuration change" ], "Message": "Updated parameter audit_logs to disabled with apply method immediate", "SourceIdentifier": "custom3-6-param-grp", "SourceType": "db-parameter-group" } ] } ``` Para obter mais informações, consulte [Visualizar eventos do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/managing-events.html#viewing-events) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [DescribeEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-events.html) na *Referência de comandos da AWS CLI*. ### `describe-orderable-db-instance-options` O código de exemplo a seguir mostra como usar `describe-orderable-db-instance-options`. **AWS CLI** **Como encontrar as opções de instância do Amazon DocumentDB que você pode solicitar** O exemplo `describe-orderable-db-instance-options` a seguir lista todas as opções de instância do Amazon DocumentDB para uma região. ``` aws docdb describe-orderable-db-instance-options \ --engine docdb \ --region us-east-1 ``` Resultado: ``` { "OrderableDBInstanceOptions": [ { "Vpc": true, "AvailabilityZones": [ { "Name": "us-east-1a" }, { "Name": "us-east-1b" }, { "Name": "us-east-1c" }, { "Name": "us-east-1d" } ], "EngineVersion": "3.6.0", "DBInstanceClass": "db.r4.16xlarge", "LicenseModel": "na", "Engine": "docdb" }, { "Vpc": true, "AvailabilityZones": [ { "Name": "us-east-1a" }, { "Name": "us-east-1b" }, { "Name": "us-east-1c" }, { "Name": "us-east-1d" } } ], "EngineVersion": "3.6.0", "DBInstanceClass": "db.r4.2xlarge", "LicenseModel": "na", "Engine": "docdb" }, { "Vpc": true, "AvailabilityZones": [ { "Name": "us-east-1a" }, { "Name": "us-east-1b" }, { "Name": "us-east-1c" }, { "Name": "us-east-1d" } ], "EngineVersion": "3.6.0", "DBInstanceClass": "db.r4.4xlarge", "LicenseModel": "na", "Engine": "docdb" }, { "Vpc": true, "AvailabilityZones": [ { "Name": "us-east-1a" }, { "Name": "us-east-1b" }, { "Name": "us-east-1c" }, { "Name": "us-east-1d" } ], "EngineVersion": "3.6.0", "DBInstanceClass": "db.r4.8xlarge", "LicenseModel": "na", "Engine": "docdb" }, { "Vpc": true, "AvailabilityZones": [ { "Name": "us-east-1a" }, { "Name": "us-east-1b" }, { "Name": "us-east-1c" }, { "Name": "us-east-1d" } ], "EngineVersion": "3.6.0", "DBInstanceClass": "db.r4.large", "LicenseModel": "na", "Engine": "docdb" }, { "Vpc": true, "AvailabilityZones": [ { "Name": "us-east-1a" }, { "Name": "us-east-1b" }, { "Name": "us-east-1c" }, { "Name": "us-east-1d" } ], "EngineVersion": "3.6.0", "DBInstanceClass": "db.r4.xlarge", "LicenseModel": "na", "Engine": "docdb" } ] } ``` Para obter mais informações, consulte [Adicionar uma instância do Amazon DocumentDB a um cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-add.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [DescribeOrderableDbInstanceOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-orderable-db-instance-options.html) na *Referência de comandos da AWS CLI*. ### `describe-pending-maintenance-actions` O código de exemplo a seguir mostra como usar `describe-pending-maintenance-actions`. **AWS CLI** **Para listar suas ações de manutenção pendentes do Amazon DocumentDB** O exemplo `describe-pending-maintenance-actions` a seguir lista todas as suas ações pendentes de manutenção do Amazon DocumentDB. ``` aws docdb describe-pending-maintenance-actions ``` Resultado: ``` { "PendingMaintenanceActions": [] } ``` Para obter mais informações, consulte [Manutenção do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-maintain.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [DescribePendingMaintenanceActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-pending-maintenance-actions.html) na *Referência de comandos da AWS CLI*. ### `failover-db-cluster` O código de exemplo a seguir mostra como usar `failover-db-cluster`. **AWS CLI** **Como forçar o failover de um cluster do Amazon DocumentDB em uma réplica** O exemplo `failover-db-cluster` a seguir faz com que a instância primária no cluster sample-cluster do Amazon DocumentDB realize o failover para uma réplica. ``` aws docdb failover-db-cluster \ --db-cluster-identifier sample-cluster ``` Resultado: ``` { "DBCluster": { "AssociatedRoles": [], "DBClusterIdentifier": "sample-cluster", "EngineVersion": "3.6.0", "DBSubnetGroup": "default", "MasterUsername": "master-user", "EarliestRestorableTime": "2019-03-15T20:30:47.020Z", "Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com", "AvailabilityZones": [ "us-west-2a", "us-west-2c", "us-west-2b" ], "LatestRestorableTime": "2019-03-18T21:35:23.548Z", "PreferredMaintenanceWindow": "sat:04:30-sat:05:00", "PreferredBackupWindow": "00:00-00:30", "Port": 27017, "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sg-77186e0d", "Status": "active" } ], "StorageEncrypted": false, "ClusterCreateTime": "2019-03-15T20:29:58.836Z", "MultiAZ": true, "Status": "available", "DBClusterMembers": [ { "DBClusterParameterGroupStatus": "in-sync", "IsClusterWriter": false, "DBInstanceIdentifier": "sample-cluster", "PromotionTier": 1 }, { "DBClusterParameterGroupStatus": "in-sync", "IsClusterWriter": true, "DBInstanceIdentifier": "sample-cluster2", "PromotionTier": 2 } ], "EnabledCloudwatchLogsExports": [ "audit" ], "DBClusterParameterGroup": "default.docdb3.6", "HostedZoneId": "ZNKXH85TT8WVW", "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster", "BackupRetentionPeriod": 3, "DbClusterResourceId": "cluster-UP4EF2PVDDFVHHDJQTYDAIGHLE", "ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com", "Engine": "docdb" } } ``` Para obter mais informações, consulte [Failover do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/failover.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [FailoverDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/failover-db-cluster.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar todas as tags em um recurso do Amazon DocumentDB** O exemplo `list-tags-for-resource` a seguir lista todas as tags do cluster do Amazon DocumentDB `sample-cluster`. ``` aws docdb list-tags-for-resource \ --resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster ``` Resultado: ``` { "TagList": [ { "Key": "A", "Value": "ALPHA" }, { "Key": "B", "Value": "" }, { "Key": "C", "Value": "CHARLIE" } ] } ``` Para obter mais informações, consulte [Listar tags em um recurso do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/tagging.html#tagging-list) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `modify-db-cluster-parameter-group` O código de exemplo a seguir mostra como usar `modify-db-cluster-parameter-group`. **AWS CLI** **Para modificar grupos de parâmetros de cluster do Amazon DocumentDB** O exemplo `modify-db-cluster-parameter-group` a seguir modifica o grupo de parâmetros do cluster Amazon DocumentDB `custom3-6-param-grp` definindo os dois parâmetros `audit_logs` e `ttl_monitor` como habilitados. As alterações serão aplicadas na próxima reinicialização. ``` aws docdb modify-db-cluster-parameter-group \ --db-cluster-parameter-group-name custom3-6-param-grp \ --parameters ParameterName=audit_logs,ParameterValue=enabled,ApplyMethod=pending-reboot \ ParameterName=ttl_monitor,ParameterValue=enabled,ApplyMethod=pending-reboot ``` Resultado: ``` { "DBClusterParameterGroupName": "custom3-6-param-grp" } ``` Para obter mais informações, consulte [Modificar um grupo de parâmetros do cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-modify.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [ModifyDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-cluster-parameter-group.html) na *Referência de comandos da AWS CLI*. ### `modify-db-cluster-snapshot-attribute` O código de exemplo a seguir mostra como usar `modify-db-cluster-snapshot-attribute`. **AWS CLI** **Exemplo 1: adicionar um atributo a um snapshot do Amazon DocumentDB** O exemplo `modify-db-cluster-snapshot-attribute` a seguir adiciona quatro valores de atributos a um snapshot do cluster do Amazon DocumentDB. ``` aws docdb modify-db-cluster-snapshot-attribute \ --db-cluster-snapshot-identifier sample-cluster-snapshot \ --attribute-name restore \ --values-to-add 123456789011 123456789012 123456789013 ``` Resultado: ``` { "DBClusterSnapshotAttributesResult": { "DBClusterSnapshotAttributes": [ { "AttributeName": "restore", "AttributeValues": [ "123456789011", "123456789012", "123456789013" ] } ], "DBClusterSnapshotIdentifier": "sample-cluster-snapshot" } } ``` **Exemplo 2: remover atributos de um snapshot do Amazon DocumentDB** O exemplo `modify-db-cluster-snapshot-attribute` a seguir remove dois valores de atributos de um snapshot do cluster do Amazon DocumentDB. ``` aws docdb modify-db-cluster-snapshot-attribute \ --db-cluster-snapshot-identifier sample-cluster-snapshot \ --attribute-name restore \ --values-to-remove 123456789012 ``` Resultado: ``` { "DBClusterSnapshotAttributesResult": { "DBClusterSnapshotAttributes": [ { "AttributeName": "restore", "AttributeValues": [ "123456789011", "123456789013" ] } ], "DBClusterSnapshotIdentifier": "sample-cluster-snapshot" } } ``` Para obter mais informações, consulte [ModifyDBClusterSnapshotAttribute](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ModifyDBClusterSnapshotAttribute.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [ModifyDbClusterSnapshotAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-cluster-snapshot-attribute.html) na *Referência de comandos da AWS CLI*. ### `modify-db-cluster` O código de exemplo a seguir mostra como usar `modify-db-cluster`. **AWS CLI** **Para modificar um cluster do Amazon DocumentDB** O exemplo `modify-db-cluster` a seguir modifica o cluster do Amazon DocumentDB `sample-cluster` fazendo com que o período de retenção dos backups automáticos seja de 7 dias e alterando as janelas preferenciais para backups e manutenção. Todas as alterações serão aplicadas durante a próxima janela de manutenção. ``` aws docdb modify-db-cluster \ --db-cluster-identifier sample-cluster \ --no-apply-immediately \ --backup-retention-period 7 \ --preferred-backup-window 18:00-18:30 \ --preferred-maintenance-window sun:20:00-sun:20:30 ``` Resultado: ``` { "DBCluster": { "Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com", "DBClusterMembers": [ { "DBClusterParameterGroupStatus": "in-sync", "DBInstanceIdentifier": "sample-cluster", "IsClusterWriter": true, "PromotionTier": 1 }, { "DBClusterParameterGroupStatus": "in-sync", "DBInstanceIdentifier": "sample-cluster2", "IsClusterWriter": false, "PromotionTier": 2 } ], "HostedZoneId": "ZNKXH85TT8WVW", "StorageEncrypted": false, "PreferredBackupWindow": "18:00-18:30", "MultiAZ": true, "EngineVersion": "3.6.0", "MasterUsername": "master-user", "ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com", "DBSubnetGroup": "default", "LatestRestorableTime": "2019-03-18T22:08:13.408Z", "EarliestRestorableTime": "2019-03-15T20:30:47.020Z", "PreferredMaintenanceWindow": "sun:20:00-sun:20:30", "AssociatedRoles": [], "EnabledCloudwatchLogsExports": [ "audit" ], "Engine": "docdb", "DBClusterParameterGroup": "default.docdb3.6", "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster", "BackupRetentionPeriod": 7, "DBClusterIdentifier": "sample-cluster", "AvailabilityZones": [ "us-west-2a", "us-west-2c", "us-west-2b" ], "Status": "available", "DbClusterResourceId": "cluster-UP4EF2PVDDFVHHDJQTYDAIGHLE", "ClusterCreateTime": "2019-03-15T20:29:58.836Z", "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sg-77186e0d", "Status": "active" } ], "Port": 27017 } } ``` Para obter mais informações, consulte [Modificar um cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-modify.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [ModifyDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-cluster.html) na *Referência de comandos da AWS CLI*. ### `modify-db-instance` O código de exemplo a seguir mostra como usar `modify-db-instance`. **AWS CLI** **Para modificar uma instância do Amazon DocumentDB** O exemplo `modify-db-instance` a seguir modifica a instância `sample-cluster2` do Amazon DocumentDB alterando sua classe de instância para `db.r4.4xlarge` e seu nível de promoção para `5`. As alterações são aplicadas imediatamente, mas só podem ser vistas depois que o status da instância estiver disponível. ``` aws docdb modify-db-instance \ --db-instance-identifier sample-cluster2 \ --apply-immediately \ --db-instance-class db.r4.4xlarge \ --promotion-tier 5 ``` Resultado: ``` { "DBInstance": { "EngineVersion": "3.6.0", "StorageEncrypted": false, "DBInstanceClass": "db.r4.large", "PreferredMaintenanceWindow": "mon:08:39-mon:09:09", "AutoMinorVersionUpgrade": true, "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sg-77186e0d", "Status": "active" } ], "PreferredBackupWindow": "18:00-18:30", "EnabledCloudwatchLogsExports": [ "audit" ], "AvailabilityZone": "us-west-2f", "DBInstanceIdentifier": "sample-cluster2", "InstanceCreateTime": "2019-03-15T20:36:06.338Z", "Engine": "docdb", "BackupRetentionPeriod": 7, "DBSubnetGroup": { "DBSubnetGroupName": "default", "DBSubnetGroupDescription": "default", "SubnetGroupStatus": "Complete", "Subnets": [ { "SubnetIdentifier": "subnet-4e26d263", "SubnetAvailabilityZone": { "Name": "us-west-2a" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-afc329f4", "SubnetAvailabilityZone": { "Name": "us-west-2c" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-53ab3636", "SubnetAvailabilityZone": { "Name": "us-west-2d" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-991cb8d0", "SubnetAvailabilityZone": { "Name": "us-west-2b" }, "SubnetStatus": "Active" } ], "VpcId": "vpc-91280df6" }, "PromotionTier": 2, "Endpoint": { "Address": "sample-cluster2.corcjozrlsfc.us-west-2.docdb.amazonaws.com", "HostedZoneId": "ZNKXH85TT8WVW", "Port": 27017 }, "DbiResourceId": "db-A2GIKUV6KPOHITGGKI2NHVISZA", "DBClusterIdentifier": "sample-cluster", "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", "PendingModifiedValues": { "DBInstanceClass": "db.r4.4xlarge" }, "PubliclyAccessible": false, "DBInstanceStatus": "available" } } ``` Para obter mais informações, consulte [Modificar uma instância do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-modify.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [ModifyDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-instance.html) na *Referência de comandos da AWS CLI*. ### `modify-db-subnet-group` O código de exemplo a seguir mostra como usar `modify-db-subnet-group`. **AWS CLI** **Para modificar um grupo de sub-redes do Amazon DocumentDB** O exemplo `modify-db-subnet-group` a seguir modifica o grupo de sub-redes `sample-subnet-group` adicionando as sub-redes especificadas e uma nova descrição. ``` aws docdb modify-db-subnet-group \ --db-subnet-group-name sample-subnet-group \ --subnet-ids subnet-b3806e8f subnet-53ab3636 subnet-991cb8d0 \ --db-subnet-group-description "New subnet description" ``` Resultado: ``` { "DBSubnetGroup": { "DBSubnetGroupName": "sample-subnet-group", "SubnetGroupStatus": "Complete", "DBSubnetGroupArn": "arn:aws:rds:us-west-2:123456789012:subgrp:sample-subnet-group", "VpcId": "vpc-91280df6", "DBSubnetGroupDescription": "New subnet description", "Subnets": [ { "SubnetIdentifier": "subnet-b3806e8f", "SubnetStatus": "Active", "SubnetAvailabilityZone": { "Name": "us-west-2a" } }, { "SubnetIdentifier": "subnet-53ab3636", "SubnetStatus": "Active", "SubnetAvailabilityZone": { "Name": "us-west-2c" } }, { "SubnetIdentifier": "subnet-991cb8d0", "SubnetStatus": "Active", "SubnetAvailabilityZone": { "Name": "us-west-2b" } } ] } } ``` Para obter mais informações, consulte [Modificar um grupo de sub-rede do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-group-modify) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [ModifyDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-subnet-group.html) na *Referência de comandos da AWS CLI*. ### `reboot-db-instance` O código de exemplo a seguir mostra como usar `reboot-db-instance`. **AWS CLI** **Como reinicializar uma instância do Amazon DocumentDB** O exemplo `reboot-db-instance` a seguir reinicializa a instância do Amazon DocumentDB `sample-cluster2`. ``` aws docdb reboot-db-instance \ --db-instance-identifier sample-cluster2 ``` Este comando não produz saída. Resultado: ``` { "DBInstance": { "PreferredBackupWindow": "18:00-18:30", "DBInstanceIdentifier": "sample-cluster2", "VpcSecurityGroups": [ { "Status": "active", "VpcSecurityGroupId": "sg-77186e0d" } ], "DBSubnetGroup": { "VpcId": "vpc-91280df6", "Subnets": [ { "SubnetStatus": "Active", "SubnetAvailabilityZone": { "Name": "us-west-2a" }, "SubnetIdentifier": "subnet-4e26d263" }, { "SubnetStatus": "Active", "SubnetAvailabilityZone": { "Name": "us-west-2c" }, "SubnetIdentifier": "subnet-afc329f4" }, { "SubnetStatus": "Active", "SubnetAvailabilityZone": { "Name": "us-west-2d" }, "SubnetIdentifier": "subnet-53ab3636" }, { "SubnetStatus": "Active", "SubnetAvailabilityZone": { "Name": "us-west-2b" }, "SubnetIdentifier": "subnet-991cb8d0" } ], "SubnetGroupStatus": "Complete", "DBSubnetGroupName": "default", "DBSubnetGroupDescription": "default" }, "PendingModifiedValues": {}, "Endpoint": { "Address": "sample-cluster2.corcjozrlsfc.us-west-2.docdb.amazonaws.com", "HostedZoneId": "ZNKXH85TT8WVW", "Port": 27017 }, "EnabledCloudwatchLogsExports": [ "audit" ], "StorageEncrypted": false, "DbiResourceId": "db-A2GIKUV6KPOHITGGKI2NHVISZA", "AutoMinorVersionUpgrade": true, "Engine": "docdb", "InstanceCreateTime": "2019-03-15T20:36:06.338Z", "EngineVersion": "3.6.0", "PromotionTier": 5, "BackupRetentionPeriod": 7, "DBClusterIdentifier": "sample-cluster", "PreferredMaintenanceWindow": "mon:08:39-mon:09:09", "PubliclyAccessible": false, "DBInstanceClass": "db.r4.4xlarge", "AvailabilityZone": "us-west-2d", "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", "DBInstanceStatus": "rebooting" } } ``` Para obter mais informações, consulte [Reinicializar uma instância do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-reboot.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [RebootDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/reboot-db-instance.html) na *Referência de comandos da AWS CLI*. ### `remove-tags-from-resource` O código de exemplo a seguir mostra como usar `remove-tags-from-resource`. **AWS CLI** **Para remover as tags de metadados de um recurso do Amazon DocumentDB** O exemplo `remove-tags-from-resource` a seguir remove a tag com a chave chamada `B` do cluster do Amazon DocumentDB `sample-cluster`. ``` aws docdb remove-tags-from-resource \ --resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \ --tag-keys B ``` Este comando não produz saída. Para obter mais informações, consulte [Remover as tags de um recurso do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/tagging.html#tagging-remove) no *Guia do desenvolvedor do Amazon DocumentDB*. + Consulte detalhes da API em [RemoveTagsFromResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/remove-tags-from-resource.html) na *Referência de comandos da AWS CLI*. ### `reset-db-cluster-parameter-group` O código de exemplo a seguir mostra como usar `reset-db-cluster-parameter-group`. **AWS CLI** **Como redefinir o valor do parâmetro especificado para seus padrões em um grupo de parâmetros do Amazon DocumentDB** O exemplo `reset-db-cluster-parameter-group` a seguir redefine o parâmetro `ttl_monitor` no grupo de parâmetro de do Amazon DocumentDB `custom3-6-param-grp` para seu valor padrão. ``` aws docdb reset-db-cluster-parameter-group \ --db-cluster-parameter-group-name custom3-6-param-grp \ --parameters ParameterName=ttl_monitor,ApplyMethod=immediate ``` Resultado: ``` { "DBClusterParameterGroupName": "custom3-6-param-grp" } ``` Para obter mais informações, consulte o título no *Guia do desenvolvedor do Amazon DocumentDB*. **Como redefinir os valores especificados ou todos os parâmetros para seus padrões em um grupo de parâmetros do Amazon DocumentDB** O exemplo `reset-db-cluster-parameter-group` a seguir redefine todos os parâmetros no grupo de parâmetro do Amazon DocumentDB `custom3-6-param-grp` para seu valor padrão. ``` aws docdb reset-db-cluster-parameter-group \ --db-cluster-parameter-group-name custom3-6-param-grp \ --reset-all-parameters ``` Resultado: ``` { "DBClusterParameterGroupName": "custom3-6-param-grp" } ``` Para obter mais informações, consulte [Redefinir um grupo de parâmetros do cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-reset.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [ResetDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/reset-db-cluster-parameter-group.html) na *Referência de comandos da AWS CLI*. ### `restore-db-cluster-from-snapshot` O código de exemplo a seguir mostra como usar `restore-db-cluster-from-snapshot`. **AWS CLI** **Como restaurar um cluster do Amazon DocumentDB a partir de um snapshot automático ou manual** O exemplo `restore-db-cluster-from-snapshot` a seguir cria um novo cluster do Amazon DocumentDB chamado `sample-cluster-2019-03-16-00-01-restored` a partir do snapshot`rds:sample-cluster-2019-03-16-00-01`. ``` aws docdb restore-db-cluster-from-snapshot \ --db-cluster-identifier sample-cluster-2019-03-16-00-01-restored \ --engine docdb \ --snapshot-identifier rds:sample-cluster-2019-03-16-00-01 ``` Resultado: ``` { "DBCluster": { "ClusterCreateTime": "2019-03-19T18:45:01.857Z", "HostedZoneId": "ZNKXH85TT8WVW", "Engine": "docdb", "DBClusterMembers": [], "MultiAZ": false, "AvailabilityZones": [ "us-west-2a", "us-west-2c", "us-west-2b" ], "StorageEncrypted": false, "ReaderEndpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com", "Endpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com", "Port": 27017, "PreferredBackupWindow": "00:00-00:30", "DBSubnetGroup": "default", "DBClusterIdentifier": "sample-cluster-2019-03-16-00-01-restored", "PreferredMaintenanceWindow": "sat:04:30-sat:05:00", "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster-2019-03-16-00-01-restored", "DBClusterParameterGroup": "default.docdb3.6", "DbClusterResourceId": "cluster-XOO46Q3RH4LWSYNH3NMZKXPISU", "MasterUsername": "master-user", "EngineVersion": "3.6.0", "BackupRetentionPeriod": 3, "AssociatedRoles": [], "Status": "creating", "VpcSecurityGroups": [ { "Status": "active", "VpcSecurityGroupId": "sg-77186e0d" } ] } } ``` Para obter mais informações, consulte [Restaurar a partir de um snapshot de cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.restore-from-snapshot.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [RestoreDbClusterFromSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/restore-db-cluster-from-snapshot.html) na *Referência de comandos da AWS CLI*. ### `restore-db-cluster-to-point-in-time` O código de exemplo a seguir mostra como usar `restore-db-cluster-to-point-in-time`. **AWS CLI** **Como restaurar um cluster do Amazon DocumentDB em um ponto no tempo a partir de um snapshot manual** O exemplo `restore-db-cluster-to-point-in-time` a seguir usa o `sample-cluster-snapshot` para criar um novo cluster do Amazon DocumentDB, `sample-cluster-pit`, usando o tempo restaurável mais recente. ``` aws docdb restore-db-cluster-to-point-in-time \ --db-cluster-identifier sample-cluster-pit \ --source-db-cluster-identifier arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \ --use-latest-restorable-time ``` Resultado: ``` { "DBCluster": { "StorageEncrypted": false, "BackupRetentionPeriod": 3, "MasterUsername": "master-user", "HostedZoneId": "ZNKXH85TT8WVW", "PreferredBackupWindow": "00:00-00:30", "MultiAZ": false, "DBClusterIdentifier": "sample-cluster-pit", "DBSubnetGroup": "default", "ClusterCreateTime": "2019-04-03T15:55:21.320Z", "AssociatedRoles": [], "DBClusterParameterGroup": "default.docdb3.6", "DBClusterMembers": [], "Status": "creating", "AvailabilityZones": [ "us-west-2a", "us-west-2d", "us-west-2b" ], "ReaderEndpoint": "sample-cluster-pit.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com", "Port": 27017, "Engine": "docdb", "EngineVersion": "3.6.0", "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sg-77186e0d", "Status": "active" } ], "PreferredMaintenanceWindow": "sat:04:30-sat:05:00", "Endpoint": "sample-cluster-pit.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com", "DbClusterResourceId": "cluster-NLCABBXOSE2QPQ4GOLZIFWEPLM", "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster-pit" } } ``` Para obter mais informações, consulte [Restaurar um snapshot para um ponto no tempo](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.point-in-time-recovery.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [RestoreDbClusterToPointInTime](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/restore-db-cluster-to-point-in-time.html) na *Referência de comandos da AWS CLI*. ### `start-db-cluster` O código de exemplo a seguir mostra como usar `start-db-cluster`. **AWS CLI** **Para iniciar um cluster interrompido do Amazon DocumentDB** O exemplo `start-db-cluster` a seguir inicia o cluster do Amazon DocumentDB especificado. ``` aws docdb start-db-cluster \ --db-cluster-identifier sample-cluster ``` Resultado: ``` { "DBCluster": { "ClusterCreateTime": "2019-03-19T18:45:01.857Z", "HostedZoneId": "ZNKXH85TT8WVW", "Engine": "docdb", "DBClusterMembers": [], "MultiAZ": false, "AvailabilityZones": [ "us-east-1a", "us-east-1c", "us-east-1f" ], "StorageEncrypted": false, "ReaderEndpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-ro-corcjozrlsfc.us-east-1.docdb.amazonaws.com", "Endpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-corcjozrlsfc.us-east-1.docdb.amazonaws.com", "Port": 27017, "PreferredBackupWindow": "00:00-00:30", "DBSubnetGroup": "default", "DBClusterIdentifier": "sample-cluster-2019-03-16-00-01-restored", "PreferredMaintenanceWindow": "sat:04:30-sat:05:00", "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster-2019-03-16-00-01-restored", "DBClusterParameterGroup": "default.docdb3.6", "DbClusterResourceId": "cluster-XOO46Q3RH4LWSYNH3NMZKXPISU", "MasterUsername": "master-user", "EngineVersion": "3.6.0", "BackupRetentionPeriod": 3, "AssociatedRoles": [], "Status": "creating", "VpcSecurityGroups": [ { "Status": "active", "VpcSecurityGroupId": "sg-77186e0d" } ] } } ``` Para obter mais informações, consulte [Interromper e iniciar um cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [StartDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/start-db-cluster.html) na *Referência de comandos da AWS CLI*. ### `stop-db-cluster` O código de exemplo a seguir mostra como usar `stop-db-cluster`. **AWS CLI** **Como interromper um cluster em execução do Amazon DocumentDB** O exemplo `stop-db-cluster` a seguir interrompe o cluster do Amazon DocumentDB especificado. ``` aws docdb stop-db-cluster \ --db-cluster-identifier sample-cluster ``` Resultado: ``` { "DBCluster": { "ClusterCreateTime": "2019-03-19T18:45:01.857Z", "HostedZoneId": "ZNKXH85TT8WVW", "Engine": "docdb", "DBClusterMembers": [], "MultiAZ": false, "AvailabilityZones": [ "us-east-1a", "us-east-1c", "us-east-1f" ], "StorageEncrypted": false, "ReaderEndpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-ro-corcjozrlsfc.us-east-1.docdb.amazonaws.com", "Endpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-corcjozrlsfc.us-east-1.docdb.amazonaws.com", "Port": 27017, "PreferredBackupWindow": "00:00-00:30", "DBSubnetGroup": "default", "DBClusterIdentifier": "sample-cluster-2019-03-16-00-01-restored", "PreferredMaintenanceWindow": "sat:04:30-sat:05:00", "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster-2019-03-16-00-01-restored", "DBClusterParameterGroup": "default.docdb3.6", "DbClusterResourceId": "cluster-XOO46Q3RH4LWSYNH3NMZKXPISU", "MasterUsername": "master-user", "EngineVersion": "3.6.0", "BackupRetentionPeriod": 3, "AssociatedRoles": [], "Status": "creating", "VpcSecurityGroups": [ { "Status": "active", "VpcSecurityGroupId": "sg-77186e0d" } ] } } ``` Para obter mais informações, consulte [Interromper e iniciar um cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html) no *Guia do desenvolvedor do Amazon DocumentDB*. + Para ver detalhes da API, consulte [StopDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/stop-db-cluster.html) na *Referência de comandos da AWS CLI*. # Exemplos do DynamoDB usando o AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface 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 ### `batch-get-item` O código de exemplo a seguir mostra como usar `batch-get-item`. **AWS CLI** **Para recuperar vários itens de uma tabela** O exemplo de `batch-get-items` a seguir lê vários itens da tabela `MusicCollection` usando um lote de três solicitações `GetItem` e solicita o número de unidades de capacidade de leitura consumidas pela operação. O comando retorna somente o atributo `AlbumTitle`. ``` aws dynamodb batch-get-item \ --request-items file://request-items.json \ --return-consumed-capacity TOTAL ``` Conteúdo de `request-items.json`: ``` { "MusicCollection": { "Keys": [ { "Artist": {"S": "No One You Know"}, "SongTitle": {"S": "Call Me Today"} }, { "Artist": {"S": "Acme Band"}, "SongTitle": {"S": "Happy Day"} }, { "Artist": {"S": "No One You Know"}, "SongTitle": {"S": "Scared of My Shadow"} } ], "ProjectionExpression":"AlbumTitle" } } ``` Resultado: ``` { "Responses": { "MusicCollection": [ { "AlbumTitle": { "S": "Somewhat Famous" } }, { "AlbumTitle": { "S": "Blue Sky Blues" } }, { "AlbumTitle": { "S": "Louder Than Ever" } } ] }, "UnprocessedKeys": {}, "ConsumedCapacity": [ { "TableName": "MusicCollection", "CapacityUnits": 1.5 } ] } ``` Para obter mais informações, consulte [Operações em lote](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.BatchOperations) no *Guia do desenvolvedor do Amazon DynamoDB*. + Consulte detalhes da API em [BatchGetItem](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/batch-get-item.html) na *Referência de comandos da AWS CLI*. ### `batch-write-item` O código de exemplo a seguir mostra como usar `batch-write-item`. **AWS CLI** **Como adicionar vários itens a uma tabela** O exemplo de `batch-write-item` a seguir adiciona três novos itens à tabela `MusicCollection` usando um lote de três solicitações `PutItem`. Ele também solicita informações sobre o número de unidades de capacidade de gravação consumidas pela operação e quaisquer coleções de itens modificadas pela operação. ``` aws dynamodb batch-write-item \ --request-items file://request-items.json \ --return-consumed-capacity INDEXES \ --return-item-collection-metrics SIZE ``` Conteúdo de `request-items.json`: ``` { "MusicCollection": [ { "PutRequest": { "Item": { "Artist": {"S": "No One You Know"}, "SongTitle": {"S": "Call Me Today"}, "AlbumTitle": {"S": "Somewhat Famous"} } } }, { "PutRequest": { "Item": { "Artist": {"S": "Acme Band"}, "SongTitle": {"S": "Happy Day"}, "AlbumTitle": {"S": "Songs About Life"} } } }, { "PutRequest": { "Item": { "Artist": {"S": "No One You Know"}, "SongTitle": {"S": "Scared of My Shadow"}, "AlbumTitle": {"S": "Blue Sky Blues"} } } } ] } ``` Resultado: ``` { "UnprocessedItems": {}, "ItemCollectionMetrics": { "MusicCollection": [ { "ItemCollectionKey": { "Artist": { "S": "No One You Know" } }, "SizeEstimateRangeGB": [ 0.0, 1.0 ] }, { "ItemCollectionKey": { "Artist": { "S": "Acme Band" } }, "SizeEstimateRangeGB": [ 0.0, 1.0 ] } ] }, "ConsumedCapacity": [ { "TableName": "MusicCollection", "CapacityUnits": 6.0, "Table": { "CapacityUnits": 3.0 }, "LocalSecondaryIndexes": { "AlbumTitleIndex": { "CapacityUnits": 3.0 } } } ] } ``` Para obter mais informações, consulte [Operações em lote](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.BatchOperations) no *Guia do desenvolvedor do Amazon DynamoDB*. + Consulte detalhes da API em [BatchWriteItem](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/batch-write-item.html) na *Referência de comandos da AWS CLI*. ### `create-backup` O código de exemplo a seguir mostra como usar `create-backup`. **AWS CLI** **Para criar um backup de uma tabela do DynamoDB existente** O exemplo `create-backup` a seguir cria um backup da tabela `MusicCollection`. ``` aws dynamodb create-backup \ --table-name MusicCollection \ --backup-name MusicCollectionBackup ``` Resultado: ``` { "BackupDetails": { "BackupArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01576616366715-b4e58d3a", "BackupName": "MusicCollectionBackup", "BackupSizeBytes": 0, "BackupStatus": "CREATING", "BackupType": "USER", "BackupCreationDateTime": 1576616366.715 } } ``` Para obter mais informações, consulte [Backup e restauração do DynamoDB sob demanda](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/BackupRestore.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [CreateBackup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/create-backup.html) na *Referência de comandos da AWS CLI*. ### `create-global-table` O código de exemplo a seguir mostra como usar `create-global-table`. **AWS CLI** **Para criar uma tabela global** O exemplo `create-global-table` a seguir cria uma tabela global a partir de duas tabelas idênticas nas regiões da AWS separadas e especificadas. ``` aws dynamodb create-global-table \ --global-table-name MusicCollection \ --replication-group RegionName=us-east-2 RegionName=us-east-1 \ --region us-east-2 ``` Resultado: ``` { "GlobalTableDescription": { "ReplicationGroup": [ { "RegionName": "us-east-2" }, { "RegionName": "us-east-1" } ], "GlobalTableArn": "arn:aws:dynamodb::123456789012:global-table/MusicCollection", "CreationDateTime": 1576625818.532, "GlobalTableStatus": "CREATING", "GlobalTableName": "MusicCollection" } } ``` Para obter mais informações, consulte [Tabelas do globais do DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [CreateGlobalTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/create-global-table.html) na *Referência de comandos da AWS CLI*. ### `create-table` O código de exemplo a seguir mostra como usar `create-table`. **AWS CLI** **Exemplo 1: como criar uma tabela com tags** O exemplo de `create-table` a seguir usa os atributos especificados e o esquema de chaves para criar uma tabela chamada `MusicCollection`. Essa tabela usa um throughput provisionado e é criptografada em repouso usando a CMK de propriedade padrão da AWS. O comando também aplica uma tag à tabela, com uma chave `Owner` e valor de `blueTeam`. ``` aws dynamodb create-table \ --table-name MusicCollection \ --attribute-definitions AttributeName=Artist,AttributeType=S AttributeName=SongTitle,AttributeType=S \ --key-schema AttributeName=Artist,KeyType=HASH AttributeName=SongTitle,KeyType=RANGE \ --provisioned-throughput ReadCapacityUnits=5,WriteCapacityUnits=5 \ --tags Key=Owner,Value=blueTeam ``` Resultado: ``` { "TableDescription": { "AttributeDefinitions": [ { "AttributeName": "Artist", "AttributeType": "S" }, { "AttributeName": "SongTitle", "AttributeType": "S" } ], "ProvisionedThroughput": { "NumberOfDecreasesToday": 0, "WriteCapacityUnits": 5, "ReadCapacityUnits": 5 }, "TableSizeBytes": 0, "TableName": "MusicCollection", "TableStatus": "CREATING", "KeySchema": [ { "KeyType": "HASH", "AttributeName": "Artist" }, { "KeyType": "RANGE", "AttributeName": "SongTitle" } ], "ItemCount": 0, "CreationDateTime": "2020-05-26T16:04:41.627000-07:00", "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection", "TableId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } } ``` Para obter mais informações, consulte [Operações básicas nas tabelas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 2: como criar uma tabela no modo sob demanda** O exemplo a seguir cria uma tabela chamada `MusicCollection` usando o modo sob demanda, em vez do modo de throughput provisionado. Esse método é útil para tabelas com workloads imprevisíveis. ``` aws dynamodb create-table \ --table-name MusicCollection \ --attribute-definitions AttributeName=Artist,AttributeType=S AttributeName=SongTitle,AttributeType=S \ --key-schema AttributeName=Artist,KeyType=HASH AttributeName=SongTitle,KeyType=RANGE \ --billing-mode PAY_PER_REQUEST ``` Resultado: ``` { "TableDescription": { "AttributeDefinitions": [ { "AttributeName": "Artist", "AttributeType": "S" }, { "AttributeName": "SongTitle", "AttributeType": "S" } ], "TableName": "MusicCollection", "KeySchema": [ { "AttributeName": "Artist", "KeyType": "HASH" }, { "AttributeName": "SongTitle", "KeyType": "RANGE" } ], "TableStatus": "CREATING", "CreationDateTime": "2020-05-27T11:44:10.807000-07:00", "ProvisionedThroughput": { "NumberOfDecreasesToday": 0, "ReadCapacityUnits": 0, "WriteCapacityUnits": 0 }, "TableSizeBytes": 0, "ItemCount": 0, "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection", "TableId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "BillingModeSummary": { "BillingMode": "PAY_PER_REQUEST" } } } ``` Para obter mais informações, consulte [Operações básicas nas tabelas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 3: como criar uma tabela e criptografá-la com uma CMK gerenciada pelo cliente** O exemplo a seguir cria uma tabela chamada `MusicCollection` e a criptografa usando uma CMK gerenciada pelo cliente. ``` aws dynamodb create-table \ --table-name MusicCollection \ --attribute-definitions AttributeName=Artist,AttributeType=S AttributeName=SongTitle,AttributeType=S \ --key-schema AttributeName=Artist,KeyType=HASH AttributeName=SongTitle,KeyType=RANGE \ --provisioned-throughput ReadCapacityUnits=5,WriteCapacityUnits=5 \ --sse-specification Enabled=true,SSEType=KMS,KMSMasterKeyId=abcd1234-abcd-1234-a123-ab1234a1b234 ``` Resultado: ``` { "TableDescription": { "AttributeDefinitions": [ { "AttributeName": "Artist", "AttributeType": "S" }, { "AttributeName": "SongTitle", "AttributeType": "S" } ], "TableName": "MusicCollection", "KeySchema": [ { "AttributeName": "Artist", "KeyType": "HASH" }, { "AttributeName": "SongTitle", "KeyType": "RANGE" } ], "TableStatus": "CREATING", "CreationDateTime": "2020-05-27T11:12:16.431000-07:00", "ProvisionedThroughput": { "NumberOfDecreasesToday": 0, "ReadCapacityUnits": 5, "WriteCapacityUnits": 5 }, "TableSizeBytes": 0, "ItemCount": 0, "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection", "TableId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "SSEDescription": { "Status": "ENABLED", "SSEType": "KMS", "KMSMasterKeyArn": "arn:aws:kms:us-west-2:123456789012:key/abcd1234-abcd-1234-a123-ab1234a1b234" } } } ``` Para obter mais informações, consulte [Operações básicas nas tabelas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 4: como criar uma tabela com um índice secundário local** O exemplo a seguir usa os atributos especificados e o esquema de chaves para criar uma tabela chamada `MusicCollection` com um índice secundário local chamado `AlbumTitleIndex`. ``` aws dynamodb create-table \ --table-name MusicCollection \ --attribute-definitions AttributeName=Artist,AttributeType=S AttributeName=SongTitle,AttributeType=S AttributeName=AlbumTitle,AttributeType=S \ --key-schema AttributeName=Artist,KeyType=HASH AttributeName=SongTitle,KeyType=RANGE \ --provisioned-throughput ReadCapacityUnits=10,WriteCapacityUnits=5 \ --local-secondary-indexes \ "[ { \"IndexName\": \"AlbumTitleIndex\", \"KeySchema\": [ {\"AttributeName\": \"Artist\",\"KeyType\":\"HASH\"}, {\"AttributeName\": \"AlbumTitle\",\"KeyType\":\"RANGE\"} ], \"Projection\": { \"ProjectionType\": \"INCLUDE\", \"NonKeyAttributes\": [\"Genre\", \"Year\"] } } ]" ``` Resultado: ``` { "TableDescription": { "AttributeDefinitions": [ { "AttributeName": "AlbumTitle", "AttributeType": "S" }, { "AttributeName": "Artist", "AttributeType": "S" }, { "AttributeName": "SongTitle", "AttributeType": "S" } ], "TableName": "MusicCollection", "KeySchema": [ { "AttributeName": "Artist", "KeyType": "HASH" }, { "AttributeName": "SongTitle", "KeyType": "RANGE" } ], "TableStatus": "CREATING", "CreationDateTime": "2020-05-26T15:59:49.473000-07:00", "ProvisionedThroughput": { "NumberOfDecreasesToday": 0, "ReadCapacityUnits": 10, "WriteCapacityUnits": 5 }, "TableSizeBytes": 0, "ItemCount": 0, "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection", "TableId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "LocalSecondaryIndexes": [ { "IndexName": "AlbumTitleIndex", "KeySchema": [ { "AttributeName": "Artist", "KeyType": "HASH" }, { "AttributeName": "AlbumTitle", "KeyType": "RANGE" } ], "Projection": { "ProjectionType": "INCLUDE", "NonKeyAttributes": [ "Genre", "Year" ] }, "IndexSizeBytes": 0, "ItemCount": 0, "IndexArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/index/AlbumTitleIndex" } ] } } ``` Para obter mais informações, consulte [Operações básicas nas tabelas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 5: como criar uma tabela com um índice secundário global** O exemplo a seguir cria uma tabela chamada `GameScores` com um índice secundário global chamado `GameTitleIndex`. A tabela-base tem uma chave de partição `UserId` e uma chave de classificação `GameTitle`, permitindo que você encontre a melhor pontuação de um usuário individual para um jogo específico de forma eficiente, enquanto o GSI tem uma chave de partição `GameTitle` e uma chave de classificação `TopScore`, permitindo que você encontre rapidamente a pontuação mais alta geral para um jogo específico. ``` aws dynamodb create-table \ --table-name GameScores \ --attribute-definitions AttributeName=UserId,AttributeType=S AttributeName=GameTitle,AttributeType=S AttributeName=TopScore,AttributeType=N \ --key-schema AttributeName=UserId,KeyType=HASH \ AttributeName=GameTitle,KeyType=RANGE \ --provisioned-throughput ReadCapacityUnits=10,WriteCapacityUnits=5 \ --global-secondary-indexes \ "[ { \"IndexName\": \"GameTitleIndex\", \"KeySchema\": [ {\"AttributeName\":\"GameTitle\",\"KeyType\":\"HASH\"}, {\"AttributeName\":\"TopScore\",\"KeyType\":\"RANGE\"} ], \"Projection\": { \"ProjectionType\":\"INCLUDE\", \"NonKeyAttributes\":[\"UserId\"] }, \"ProvisionedThroughput\": { \"ReadCapacityUnits\": 10, \"WriteCapacityUnits\": 5 } } ]" ``` Resultado: ``` { "TableDescription": { "AttributeDefinitions": [ { "AttributeName": "GameTitle", "AttributeType": "S" }, { "AttributeName": "TopScore", "AttributeType": "N" }, { "AttributeName": "UserId", "AttributeType": "S" } ], "TableName": "GameScores", "KeySchema": [ { "AttributeName": "UserId", "KeyType": "HASH" }, { "AttributeName": "GameTitle", "KeyType": "RANGE" } ], "TableStatus": "CREATING", "CreationDateTime": "2020-05-26T17:28:15.602000-07:00", "ProvisionedThroughput": { "NumberOfDecreasesToday": 0, "ReadCapacityUnits": 10, "WriteCapacityUnits": 5 }, "TableSizeBytes": 0, "ItemCount": 0, "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/GameScores", "TableId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "GlobalSecondaryIndexes": [ { "IndexName": "GameTitleIndex", "KeySchema": [ { "AttributeName": "GameTitle", "KeyType": "HASH" }, { "AttributeName": "TopScore", "KeyType": "RANGE" } ], "Projection": { "ProjectionType": "INCLUDE", "NonKeyAttributes": [ "UserId" ] }, "IndexStatus": "CREATING", "ProvisionedThroughput": { "NumberOfDecreasesToday": 0, "ReadCapacityUnits": 10, "WriteCapacityUnits": 5 }, "IndexSizeBytes": 0, "ItemCount": 0, "IndexArn": "arn:aws:dynamodb:us-west-2:123456789012:table/GameScores/index/GameTitleIndex" } ] } } ``` Para obter mais informações, consulte [Operações básicas nas tabelas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 6: como criar uma tabela com vários índices secundários globais ao mesmo tempo** O exemplo a seguir cria uma tabela chamada `GameScores` com dos índices secundários globais. Os esquemas do GSI são passados por meio de um arquivo, e não pela linha de comando. ``` aws dynamodb create-table \ --table-name GameScores \ --attribute-definitions AttributeName=UserId,AttributeType=S AttributeName=GameTitle,AttributeType=S AttributeName=TopScore,AttributeType=N AttributeName=Date,AttributeType=S \ --key-schema AttributeName=UserId,KeyType=HASH AttributeName=GameTitle,KeyType=RANGE \ --provisioned-throughput ReadCapacityUnits=10,WriteCapacityUnits=5 \ --global-secondary-indexes file://gsi.json ``` Conteúdo de `gsi.json`: ``` [ { "IndexName": "GameTitleIndex", "KeySchema": [ { "AttributeName": "GameTitle", "KeyType": "HASH" }, { "AttributeName": "TopScore", "KeyType": "RANGE" } ], "Projection": { "ProjectionType": "ALL" }, "ProvisionedThroughput": { "ReadCapacityUnits": 10, "WriteCapacityUnits": 5 } }, { "IndexName": "GameDateIndex", "KeySchema": [ { "AttributeName": "GameTitle", "KeyType": "HASH" }, { "AttributeName": "Date", "KeyType": "RANGE" } ], "Projection": { "ProjectionType": "ALL" }, "ProvisionedThroughput": { "ReadCapacityUnits": 5, "WriteCapacityUnits": 5 } } ] ``` Resultado: ``` { "TableDescription": { "AttributeDefinitions": [ { "AttributeName": "Date", "AttributeType": "S" }, { "AttributeName": "GameTitle", "AttributeType": "S" }, { "AttributeName": "TopScore", "AttributeType": "N" }, { "AttributeName": "UserId", "AttributeType": "S" } ], "TableName": "GameScores", "KeySchema": [ { "AttributeName": "UserId", "KeyType": "HASH" }, { "AttributeName": "GameTitle", "KeyType": "RANGE" } ], "TableStatus": "CREATING", "CreationDateTime": "2020-08-04T16:40:55.524000-07:00", "ProvisionedThroughput": { "NumberOfDecreasesToday": 0, "ReadCapacityUnits": 10, "WriteCapacityUnits": 5 }, "TableSizeBytes": 0, "ItemCount": 0, "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/GameScores", "TableId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "GlobalSecondaryIndexes": [ { "IndexName": "GameTitleIndex", "KeySchema": [ { "AttributeName": "GameTitle", "KeyType": "HASH" }, { "AttributeName": "TopScore", "KeyType": "RANGE" } ], "Projection": { "ProjectionType": "ALL" }, "IndexStatus": "CREATING", "ProvisionedThroughput": { "NumberOfDecreasesToday": 0, "ReadCapacityUnits": 10, "WriteCapacityUnits": 5 }, "IndexSizeBytes": 0, "ItemCount": 0, "IndexArn": "arn:aws:dynamodb:us-west-2:123456789012:table/GameScores/index/GameTitleIndex" }, { "IndexName": "GameDateIndex", "KeySchema": [ { "AttributeName": "GameTitle", "KeyType": "HASH" }, { "AttributeName": "Date", "KeyType": "RANGE" } ], "Projection": { "ProjectionType": "ALL" }, "IndexStatus": "CREATING", "ProvisionedThroughput": { "NumberOfDecreasesToday": 0, "ReadCapacityUnits": 5, "WriteCapacityUnits": 5 }, "IndexSizeBytes": 0, "ItemCount": 0, "IndexArn": "arn:aws:dynamodb:us-west-2:123456789012:table/GameScores/index/GameDateIndex" } ] } } ``` Para obter mais informações, consulte [Operações básicas nas tabelas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 7: como criar uma tabela com o Streams habilitado** O exemplo a seguir cria uma tabela chamada `GameScores` com o DynamoDB Streams habilitado. Imagens novas e antigas de cada item serão gravadas no fluxo. ``` aws dynamodb create-table \ --table-name GameScores \ --attribute-definitions AttributeName=UserId,AttributeType=S AttributeName=GameTitle,AttributeType=S \ --key-schema AttributeName=UserId,KeyType=HASH AttributeName=GameTitle,KeyType=RANGE \ --provisioned-throughput ReadCapacityUnits=10,WriteCapacityUnits=5 \ --stream-specification StreamEnabled=TRUE,StreamViewType=NEW_AND_OLD_IMAGES ``` Resultado: ``` { "TableDescription": { "AttributeDefinitions": [ { "AttributeName": "GameTitle", "AttributeType": "S" }, { "AttributeName": "UserId", "AttributeType": "S" } ], "TableName": "GameScores", "KeySchema": [ { "AttributeName": "UserId", "KeyType": "HASH" }, { "AttributeName": "GameTitle", "KeyType": "RANGE" } ], "TableStatus": "CREATING", "CreationDateTime": "2020-05-27T10:49:34.056000-07:00", "ProvisionedThroughput": { "NumberOfDecreasesToday": 0, "ReadCapacityUnits": 10, "WriteCapacityUnits": 5 }, "TableSizeBytes": 0, "ItemCount": 0, "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/GameScores", "TableId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "StreamSpecification": { "StreamEnabled": true, "StreamViewType": "NEW_AND_OLD_IMAGES" }, "LatestStreamLabel": "2020-05-27T17:49:34.056", "LatestStreamArn": "arn:aws:dynamodb:us-west-2:123456789012:table/GameScores/stream/2020-05-27T17:49:34.056" } } ``` Para obter mais informações, consulte [Operações básicas nas tabelas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 8: como criar uma tabela com o fluxo somente de chaves habilitado** O exemplo a seguir cria uma tabela chamada `GameScores` com o DynamoDB Streams habilitado. Somente os atributos-chave dos itens modificados são gravados no fluxo. ``` aws dynamodb create-table \ --table-name GameScores \ --attribute-definitions AttributeName=UserId,AttributeType=S AttributeName=GameTitle,AttributeType=S \ --key-schema AttributeName=UserId,KeyType=HASH AttributeName=GameTitle,KeyType=RANGE \ --provisioned-throughput ReadCapacityUnits=10,WriteCapacityUnits=5 \ --stream-specification StreamEnabled=TRUE,StreamViewType=KEYS_ONLY ``` Resultado: ``` { "TableDescription": { "AttributeDefinitions": [ { "AttributeName": "GameTitle", "AttributeType": "S" }, { "AttributeName": "UserId", "AttributeType": "S" } ], "TableName": "GameScores", "KeySchema": [ { "AttributeName": "UserId", "KeyType": "HASH" }, { "AttributeName": "GameTitle", "KeyType": "RANGE" } ], "TableStatus": "CREATING", "CreationDateTime": "2023-05-25T18:45:34.140000+00:00", "ProvisionedThroughput": { "NumberOfDecreasesToday": 0, "ReadCapacityUnits": 10, "WriteCapacityUnits": 5 }, "TableSizeBytes": 0, "ItemCount": 0, "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/GameScores", "TableId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "StreamSpecification": { "StreamEnabled": true, "StreamViewType": "KEYS_ONLY" }, "LatestStreamLabel": "2023-05-25T18:45:34.140", "LatestStreamArn": "arn:aws:dynamodb:us-west-2:123456789012:table/GameScores/stream/2023-05-25T18:45:34.140", "DeletionProtectionEnabled": false } } ``` Para obter mais informações, consulte [Captura de dados de alterações com o Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 9: como criar uma tabela com a classe Standard-Infrequent Access** O exemplo a seguir cria uma tabela chamada `GameScores` e atribui a classe de tabela Standard-Infrequent Access (DynamoDB Standard-IA). Essa classe de tabela é otimizada para que o armazenamento seja o custo dominante. ``` aws dynamodb create-table \ --table-name GameScores \ --attribute-definitions AttributeName=UserId,AttributeType=S AttributeName=GameTitle,AttributeType=S \ --key-schema AttributeName=UserId,KeyType=HASH AttributeName=GameTitle,KeyType=RANGE \ --provisioned-throughput ReadCapacityUnits=10,WriteCapacityUnits=5 \ --table-class STANDARD_INFREQUENT_ACCESS ``` Resultado: ``` { "TableDescription": { "AttributeDefinitions": [ { "AttributeName": "GameTitle", "AttributeType": "S" }, { "AttributeName": "UserId", "AttributeType": "S" } ], "TableName": "GameScores", "KeySchema": [ { "AttributeName": "UserId", "KeyType": "HASH" }, { "AttributeName": "GameTitle", "KeyType": "RANGE" } ], "TableStatus": "CREATING", "CreationDateTime": "2023-05-25T18:33:07.581000+00:00", "ProvisionedThroughput": { "NumberOfDecreasesToday": 0, "ReadCapacityUnits": 10, "WriteCapacityUnits": 5 }, "TableSizeBytes": 0, "ItemCount": 0, "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/GameScores", "TableId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "TableClassSummary": { "TableClass": "STANDARD_INFREQUENT_ACCESS" }, "DeletionProtectionEnabled": false } } ``` Para obter mais informações, consulte [Classes de tabela](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.TableClasses.html) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 10: como criar uma tabela com a proteção contra exclusão habilitada** O exemplo a seguir cria uma tabela chamada `GameScores` e habilita a proteção contra exclusão. ``` aws dynamodb create-table \ --table-name GameScores \ --attribute-definitions AttributeName=UserId,AttributeType=S AttributeName=GameTitle,AttributeType=S \ --key-schema AttributeName=UserId,KeyType=HASH AttributeName=GameTitle,KeyType=RANGE \ --provisioned-throughput ReadCapacityUnits=10,WriteCapacityUnits=5 \ --deletion-protection-enabled ``` Resultado: ``` { "TableDescription": { "AttributeDefinitions": [ { "AttributeName": "GameTitle", "AttributeType": "S" }, { "AttributeName": "UserId", "AttributeType": "S" } ], "TableName": "GameScores", "KeySchema": [ { "AttributeName": "UserId", "KeyType": "HASH" }, { "AttributeName": "GameTitle", "KeyType": "RANGE" } ], "TableStatus": "CREATING", "CreationDateTime": "2023-05-25T23:02:17.093000+00:00", "ProvisionedThroughput": { "NumberOfDecreasesToday": 0, "ReadCapacityUnits": 10, "WriteCapacityUnits": 5 }, "TableSizeBytes": 0, "ItemCount": 0, "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/GameScores", "TableId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeletionProtectionEnabled": true } } ``` Para obter mais informações, consulte [Usar a proteção contra exclusão](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeletionProtection) no *Guia do desenvolvedor do Amazon DynamoDB*. + Consulte detalhes da API em [CreateTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/create-table.html) na *Referência de comandos da AWS CLI*. ### `delete-backup` O código de exemplo a seguir mostra como usar `delete-backup`. **AWS CLI** **Para excluir um backup existente do DynamoDB** O exemplo `delete-backup` a seguir exclui o backup existente especificado. ``` aws dynamodb delete-backup \ --backup-arn arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01576616366715-b4e58d3a ``` Resultado: ``` { "BackupDescription": { "BackupDetails": { "BackupArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01576616366715-b4e58d3a", "BackupName": "MusicCollectionBackup", "BackupSizeBytes": 0, "BackupStatus": "DELETED", "BackupType": "USER", "BackupCreationDateTime": 1576616366.715 }, "SourceTableDetails": { "TableName": "MusicCollection", "TableId": "b0c04bcc-309b-4352-b2ae-9088af169fe2", "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection", "TableSizeBytes": 0, "KeySchema": [ { "AttributeName": "Artist", "KeyType": "HASH" }, { "AttributeName": "SongTitle", "KeyType": "RANGE" } ], "TableCreationDateTime": 1576615228.571, "ProvisionedThroughput": { "ReadCapacityUnits": 5, "WriteCapacityUnits": 5 }, "ItemCount": 0, "BillingMode": "PROVISIONED" }, "SourceTableFeatureDetails": {} } } ``` Para obter mais informações, consulte [Backup e restauração do DynamoDB sob demanda](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/BackupRestore.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [DeleteBackup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/delete-backup.html) na *Referência de comandos da AWS CLI*. ### `delete-item` O código de exemplo a seguir mostra como usar `delete-item`. **AWS CLI** **Exemplo 1: como excluir um item** O exemplo de `delete-item` a seguir exclui um item da tabela `MusicCollection` e solicita detalhes sobre o item excluído e a capacidade usada pela solicitação. ``` aws dynamodb delete-item \ --table-name MusicCollection \ --key file://key.json \ --return-values ALL_OLD \ --return-consumed-capacity TOTAL \ --return-item-collection-metrics SIZE ``` Conteúdo de `key.json`: ``` { "Artist": {"S": "No One You Know"}, "SongTitle": {"S": "Scared of My Shadow"} } ``` Resultado: ``` { "Attributes": { "AlbumTitle": { "S": "Blue Sky Blues" }, "Artist": { "S": "No One You Know" }, "SongTitle": { "S": "Scared of My Shadow" } }, "ConsumedCapacity": { "TableName": "MusicCollection", "CapacityUnits": 2.0 }, "ItemCollectionMetrics": { "ItemCollectionKey": { "Artist": { "S": "No One You Know" } }, "SizeEstimateRangeGB": [ 0.0, 1.0 ] } } ``` Para obter mais informações, consulte [Gravar um item](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.WritingData) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 2: como excluir um item de forma condicional** O exemplo a seguir exclui um item da tabela `ProductCatalog` somente se a `ProductCategory` for `Sporting Goods` ou `Gardening Supplies` e o preço estiver entre 500 e 600. Ele retorna detalhes sobre o item que foi excluído. ``` aws dynamodb delete-item \ --table-name ProductCatalog \ --key '{"Id":{"N":"456"}}' \ --condition-expression "(ProductCategory IN (:cat1, :cat2)) and (#P between :lo and :hi)" \ --expression-attribute-names file://names.json \ --expression-attribute-values file://values.json \ --return-values ALL_OLD ``` Conteúdo de `names.json`: ``` { "#P": "Price" } ``` Conteúdo de `values.json`: ``` { ":cat1": {"S": "Sporting Goods"}, ":cat2": {"S": "Gardening Supplies"}, ":lo": {"N": "500"}, ":hi": {"N": "600"} } ``` Resultado: ``` { "Attributes": { "Id": { "N": "456" }, "Price": { "N": "550" }, "ProductCategory": { "S": "Sporting Goods" } } } ``` Para obter mais informações, consulte [Gravar um item](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.WritingData) no *Guia do desenvolvedor do Amazon DynamoDB*. + Consulte detalhes da API em [DeleteItem](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/delete-item.html) na *Referência de comandos da AWS CLI*. ### `delete-table` O código de exemplo a seguir mostra como usar `delete-table`. **AWS CLI** **Como excluir uma tabela** O exemplo de `delete-table` a seguir exclui a tabela `MusicCollection`. ``` aws dynamodb delete-table \ --table-name MusicCollection ``` Resultado: ``` { "TableDescription": { "TableStatus": "DELETING", "TableSizeBytes": 0, "ItemCount": 0, "TableName": "MusicCollection", "ProvisionedThroughput": { "NumberOfDecreasesToday": 0, "WriteCapacityUnits": 5, "ReadCapacityUnits": 5 } } } ``` Para obter mais informações, consulte [Excluir uma tabela](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeleteTable) no *Guia do desenvolvedor do Amazon DynamoDB*. + Consulte detalhes da API em [DeleteTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/delete-table.html) na *Referência de comandos da AWS CLI*. ### `describe-backup` O código de exemplo a seguir mostra como usar `describe-backup`. **AWS CLI** **Para obter informações sobre um backup existente de uma tabela** O exemplo `describe-backup` a seguir mostra as informações do backup existente especificado. ``` aws dynamodb describe-backup \ --backup-arn arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01576616366715-b4e58d3a ``` Resultado: ``` { "BackupDescription": { "BackupDetails": { "BackupArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01576616366715-b4e58d3a", "BackupName": "MusicCollectionBackup", "BackupSizeBytes": 0, "BackupStatus": "AVAILABLE", "BackupType": "USER", "BackupCreationDateTime": 1576616366.715 }, "SourceTableDetails": { "TableName": "MusicCollection", "TableId": "b0c04bcc-309b-4352-b2ae-9088af169fe2", "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection", "TableSizeBytes": 0, "KeySchema": [ { "AttributeName": "Artist", "KeyType": "HASH" }, { "AttributeName": "SongTitle", "KeyType": "RANGE" } ], "TableCreationDateTime": 1576615228.571, "ProvisionedThroughput": { "ReadCapacityUnits": 5, "WriteCapacityUnits": 5 }, "ItemCount": 0, "BillingMode": "PROVISIONED" }, "SourceTableFeatureDetails": {} } } ``` Para obter mais informações, consulte [Backup e restauração do DynamoDB sob demanda](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/BackupRestore.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [DescribeBackup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/describe-backup.html) na *Referência de comandos da AWS CLI*. ### `describe-continuous-backups` O código de exemplo a seguir mostra como usar `describe-continuous-backups`. **AWS CLI** **Para obter informações sobre backups contínuos em uma tabela do DynamoDB** O exemplo `describe-continuous-backups` a seguir exibe detalhes sobre as configurações de backup contínuo da tabela `MusicCollection`. ``` aws dynamodb describe-continuous-backups \ --table-name MusicCollection ``` Resultado: ``` { "ContinuousBackupsDescription": { "ContinuousBackupsStatus": "ENABLED", "PointInTimeRecoveryDescription": { "PointInTimeRecoveryStatus": "DISABLED" } } } ``` Para obter mais informações, consulte [Recuperação para um ponto no tempo para o DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/PointInTimeRecovery.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [DescribeContinuousBackups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/describe-continuous-backups.html) na *Referência de comandos da AWS CLI*. ### `describe-contributor-insights` O código de exemplo a seguir mostra como usar `describe-contributor-insights`. **AWS CLI** **Como visualizar as configurações do Contributor Insights em uma tabela do DynamoDB** O exemplo `describe-contributor-insights` a seguir exibe as configurações do Contributor Insights para a tabela `MusicCollection` e o índice secundário global `AlbumTitle-index`. ``` aws dynamodb describe-contributor-insights \ --table-name MusicCollection \ --index-name AlbumTitle-index ``` Resultado: ``` { "TableName": "MusicCollection", "IndexName": "AlbumTitle-index", "ContributorInsightsRuleList": [ "DynamoDBContributorInsights-PKC-MusicCollection-1576629651520", "DynamoDBContributorInsights-SKC-MusicCollection-1576629651520", "DynamoDBContributorInsights-PKT-MusicCollection-1576629651520", "DynamoDBContributorInsights-SKT-MusicCollection-1576629651520" ], "ContributorInsightsStatus": "ENABLED", "LastUpdateDateTime": 1576629654.78 } ``` Para obter mais informações, consulte [Analisar acesso a dados usando o CloudWatch Contributor Insights para DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/contributorinsights.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [DescribeContributorInsights](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/describe-contributor-insights.html) na *Referência de comandos da AWS CLI*. ### `describe-endpoints` O código de exemplo a seguir mostra como usar `describe-endpoints`. **AWS CLI** **Como visualizar informações de endpoints regionais** O exemplo `describe-endpoints` a seguir exibe detalhes sobre os endpoints da região da AWS atual. ``` aws dynamodb describe-endpoints ``` Resultado: ``` { "Endpoints": [ { "Address": "dynamodb.us-west-2.amazonaws.com", "CachePeriodInMinutes": 1440 } ] } ``` Para obter mais informações, consulte [Endpoints e cotas do Amazon DynamoDB](https://docs.aws.amazon.com/general/latest/gr/ddb.html) na *Referência geral da AWS*. + Para ver detalhes da API, consulte [DescribeEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/describe-endpoints.html) na *Referência de comandos da AWS CLI*. ### `describe-global-table-settings` O código de exemplo a seguir mostra como usar `describe-global-table-settings`. **AWS CLI** **Para obter informações sobre as configurações de uma tabela global do DynamoDB** O exemplo `describe-global-table-settings` a seguir exibe as configurações da tabela global `MusicCollection`. ``` aws dynamodb describe-global-table-settings \ --global-table-name MusicCollection ``` Resultado: ``` { "GlobalTableName": "MusicCollection", "ReplicaSettings": [ { "RegionName": "us-east-1", "ReplicaStatus": "ACTIVE", "ReplicaProvisionedReadCapacityUnits": 10, "ReplicaProvisionedReadCapacityAutoScalingSettings": { "AutoScalingDisabled": true }, "ReplicaProvisionedWriteCapacityUnits": 5, "ReplicaProvisionedWriteCapacityAutoScalingSettings": { "AutoScalingDisabled": true } }, { "RegionName": "us-east-2", "ReplicaStatus": "ACTIVE", "ReplicaProvisionedReadCapacityUnits": 10, "ReplicaProvisionedReadCapacityAutoScalingSettings": { "AutoScalingDisabled": true }, "ReplicaProvisionedWriteCapacityUnits": 5, "ReplicaProvisionedWriteCapacityAutoScalingSettings": { "AutoScalingDisabled": true } } ] } ``` Para obter mais informações, consulte [Tabelas do globais do DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [DescribeGlobalTableSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/describe-global-table-settings.html) na *Referência de comandos da AWS CLI*. ### `describe-global-table` O código de exemplo a seguir mostra como usar `describe-global-table`. **AWS CLI** **Como exibir informações sobre uma tabela global do DynamoDB** O exemplo `describe-global-table` a seguir exibe detalhes sobre a tabela global `MusicCollection`. ``` aws dynamodb describe-global-table \ --global-table-name MusicCollection ``` Resultado: ``` { "GlobalTableDescription": { "ReplicationGroup": [ { "RegionName": "us-east-2" }, { "RegionName": "us-east-1" } ], "GlobalTableArn": "arn:aws:dynamodb::123456789012:global-table/MusicCollection", "CreationDateTime": 1576625818.532, "GlobalTableStatus": "ACTIVE", "GlobalTableName": "MusicCollection" } } ``` Para obter mais informações, consulte [Tabelas do globais do DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [DescribeGlobalTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/describe-global-table.html) na *Referência de comandos da AWS CLI*. ### `describe-limits` O código de exemplo a seguir mostra como usar `describe-limits`. **AWS CLI** **Como ver os limites da capacidade provisionada** O exemplo `describe-limits` a seguir mostra os limites de capacidade provisionada para sua conta na região da AWS atual. ``` aws dynamodb describe-limits ``` Resultado: ``` { "AccountMaxReadCapacityUnits": 80000, "AccountMaxWriteCapacityUnits": 80000, "TableMaxReadCapacityUnits": 40000, "TableMaxWriteCapacityUnits": 40000 } ``` Para obter mais informações, consulte [Limites do DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) no *Guia do desenvolvedor Amazon DynamoDB*. + Para ver detalhes da API, consulte [DescribeLimits](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/describe-limits.html) na *Referência de comandos da AWS CLI*. ### `describe-table-replica-auto-scaling` O código de exemplo a seguir mostra como usar `describe-table-replica-auto-scaling`. **AWS CLI** **Como visualizar as configurações de ajuste de escala automático em réplicas de uma tabela global** O exemplo `describe-table-replica-auto-scaling` a seguir exibe as configurações de ajuste de escala automático nas réplicas da tabela global `MusicCollection`. ``` aws dynamodb describe-table-replica-auto-scaling \ --table-name MusicCollection ``` Resultado: ``` { "TableAutoScalingDescription": { "TableName": "MusicCollection", "TableStatus": "ACTIVE", "Replicas": [ { "RegionName": "us-east-1", "GlobalSecondaryIndexes": [], "ReplicaProvisionedReadCapacityAutoScalingSettings": { "MinimumUnits": 5, "MaximumUnits": 40000, "AutoScalingRoleArn": "arn:aws:iam::123456789012:role/aws-service-role/dynamodb.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_DynamoDBTable", "ScalingPolicies": [ { "PolicyName": "DynamoDBReadCapacityUtilization:table/MusicCollection", "TargetTrackingScalingPolicyConfiguration": { "TargetValue": 70.0 } } ] }, "ReplicaProvisionedWriteCapacityAutoScalingSettings": { "MinimumUnits": 5, "MaximumUnits": 40000, "AutoScalingRoleArn": "arn:aws:iam::123456789012:role/aws-service-role/dynamodb.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_DynamoDBTable", "ScalingPolicies": [ { "PolicyName": "DynamoDBWriteCapacityUtilization:table/MusicCollection", "TargetTrackingScalingPolicyConfiguration": { "TargetValue": 70.0 } } ] }, "ReplicaStatus": "ACTIVE" }, { "RegionName": "us-east-2", "GlobalSecondaryIndexes": [], "ReplicaProvisionedReadCapacityAutoScalingSettings": { "MinimumUnits": 5, "MaximumUnits": 40000, "AutoScalingRoleArn": "arn:aws:iam::123456789012:role/aws-service-role/dynamodb.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_DynamoDBTable", "ScalingPolicies": [ { "PolicyName": "DynamoDBReadCapacityUtilization:table/MusicCollection", "TargetTrackingScalingPolicyConfiguration": { "TargetValue": 70.0 } } ] }, "ReplicaProvisionedWriteCapacityAutoScalingSettings": { "MinimumUnits": 5, "MaximumUnits": 40000, "AutoScalingRoleArn": "arn:aws:iam::123456789012:role/aws-service-role/dynamodb.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_DynamoDBTable", "ScalingPolicies": [ { "PolicyName": "DynamoDBWriteCapacityUtilization:table/MusicCollection", "TargetTrackingScalingPolicyConfiguration": { "TargetValue": 70.0 } } ] }, "ReplicaStatus": "ACTIVE" } ] } } ``` Para obter mais informações, consulte [Tabelas do globais do DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [DescribeTableReplicaAutoScaling](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/describe-table-replica-auto-scaling.html) na *Referência de comandos da AWS CLI*. ### `describe-table` O código de exemplo a seguir mostra como usar `describe-table`. **AWS CLI** **Como descrever uma tabela** O exemplo a seguir de `describe-table` descreve a tabela `MusicCollection`. ``` aws dynamodb describe-table \ --table-name MusicCollection ``` Resultado: ``` { "Table": { "AttributeDefinitions": [ { "AttributeName": "Artist", "AttributeType": "S" }, { "AttributeName": "SongTitle", "AttributeType": "S" } ], "ProvisionedThroughput": { "NumberOfDecreasesToday": 0, "WriteCapacityUnits": 5, "ReadCapacityUnits": 5 }, "TableSizeBytes": 0, "TableName": "MusicCollection", "TableStatus": "ACTIVE", "KeySchema": [ { "KeyType": "HASH", "AttributeName": "Artist" }, { "KeyType": "RANGE", "AttributeName": "SongTitle" } ], "ItemCount": 0, "CreationDateTime": 1421866952.062 } } ``` Para obter mais informações, consulte [Descrever uma tabela](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DescribeTable) no *Guia do desenvolvedor do Amazon DynamoDB*. + Consulte detalhes da API em [DescribeTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/describe-table.html) na *Referência de comandos da AWS CLI*. ### `describe-time-to-live` O código de exemplo a seguir mostra como usar `describe-time-to-live`. **AWS CLI** **Como ver as configurações de vida útil de uma tabela** O exemplo `describe-time-to-live` a seguir exibe as configurações de vida útil da tabela `MusicCollection`. ``` aws dynamodb describe-time-to-live \ --table-name MusicCollection ``` Resultado: ``` { "TimeToLiveDescription": { "TimeToLiveStatus": "ENABLED", "AttributeName": "ttl" } } ``` Para obter mais informações, consulte [Vida útil](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Consulte detalhes da API em [DescribeTimeToLive](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/describe-time-to-live.html) na *Referência de comandos da AWS CLI*. ### `get-item` O código de exemplo a seguir mostra como usar `get-item`. **AWS CLI** **Exemplo 1: como ler um item em uma tabela** O exemplo de `get-item` a seguir recupera um item da tabela `MusicCollection`. A tabela tem uma chave primária de hash e intervalo (`Artist` e `SongTitle`), portanto, você deve especificar esses dois atributos. O comando também solicita informações sobre a capacidade de leitura consumida pela operação. ``` aws dynamodb get-item \ --table-name MusicCollection \ --key file://key.json \ --return-consumed-capacity TOTAL ``` Conteúdo de `key.json`: ``` { "Artist": {"S": "Acme Band"}, "SongTitle": {"S": "Happy Day"} } ``` Resultado: ``` { "Item": { "AlbumTitle": { "S": "Songs About Life" }, "SongTitle": { "S": "Happy Day" }, "Artist": { "S": "Acme Band" } }, "ConsumedCapacity": { "TableName": "MusicCollection", "CapacityUnits": 0.5 } } ``` Para obter mais informações, consulte [Ler um item](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.ReadingData) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 2: como ler um item usando uma leitura consistente** O exemplo a seguir recupera um item da tabela `MusicCollection` usando leituras altamente consistentes. ``` aws dynamodb get-item \ --table-name MusicCollection \ --key file://key.json \ --consistent-read \ --return-consumed-capacity TOTAL ``` Conteúdo de `key.json`: ``` { "Artist": {"S": "Acme Band"}, "SongTitle": {"S": "Happy Day"} } ``` Resultado: ``` { "Item": { "AlbumTitle": { "S": "Songs About Life" }, "SongTitle": { "S": "Happy Day" }, "Artist": { "S": "Acme Band" } }, "ConsumedCapacity": { "TableName": "MusicCollection", "CapacityUnits": 1.0 } } ``` Para obter mais informações, consulte [Ler um item](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.ReadingData) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 3: como recuperar atributos específicos de um item** O exemplo a seguir usa uma expressão de projeção para recuperar apenas três atributos do item desejado. ``` aws dynamodb get-item \ --table-name ProductCatalog \ --key '{"Id": {"N": "102"}}' \ --projection-expression "#T, #C, #P" \ --expression-attribute-names file://names.json ``` Conteúdo de `names.json`: ``` { "#T": "Title", "#C": "ProductCategory", "#P": "Price" } ``` Resultado: ``` { "Item": { "Price": { "N": "20" }, "Title": { "S": "Book 102 Title" }, "ProductCategory": { "S": "Book" } } } ``` Para obter mais informações, consulte [Ler um item](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.ReadingData) no *Guia do desenvolvedor do Amazon DynamoDB*. + Consulte detalhes da API em [GetItem](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/get-item.html) na *Referência de comandos da AWS CLI*. ### `list-backups` O código de exemplo a seguir mostra como usar `list-backups`. **AWS CLI** **Exemplo 1: listar todos os backups existentes do DynamoDB** O exemplo `list-backups` a seguir lista todos os seus backups existentes. ``` aws dynamodb list-backups ``` Resultado: ``` { "BackupSummaries": [ { "TableName": "MusicCollection", "TableId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection", "BackupArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01234567890123-a1bcd234", "BackupName": "MusicCollectionBackup1", "BackupCreationDateTime": "2020-02-12T14:41:51.617000-08:00", "BackupStatus": "AVAILABLE", "BackupType": "USER", "BackupSizeBytes": 170 }, { "TableName": "MusicCollection", "TableId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection", "BackupArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01234567890123-b2abc345", "BackupName": "MusicCollectionBackup2", "BackupCreationDateTime": "2020-06-26T11:08:35.431000-07:00", "BackupStatus": "AVAILABLE", "BackupType": "USER", "BackupSizeBytes": 400 } ] } ``` Para obter mais informações, consulte [Backup e restauração do DynamoDB sob demanda](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/BackupRestore.html) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 2: listar backups criados pelo usuário em um intervalo de tempo específico** O exemplo a seguir lista somente os backups da tabela `MusicCollection` que foram criados pelo usuário (não aqueles criados automaticamente pelo DynamoDB) com uma data de criação entre 1º de janeiro de 2020 e 1º de março de 2020. ``` aws dynamodb list-backups \ --table-name MusicCollection \ --time-range-lower-bound 1577836800 \ --time-range-upper-bound 1583020800 \ --backup-type USER ``` Resultado: ``` { "BackupSummaries": [ { "TableName": "MusicCollection", "TableId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection", "BackupArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01234567890123-a1bcd234", "BackupName": "MusicCollectionBackup1", "BackupCreationDateTime": "2020-02-12T14:41:51.617000-08:00", "BackupStatus": "AVAILABLE", "BackupType": "USER", "BackupSizeBytes": 170 } ] } ``` Para obter mais informações, consulte [Backup e restauração do DynamoDB sob demanda](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/BackupRestore.html) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 3: limitar o tamanho da página** O exemplo a seguir retorna uma lista de todos os backups existentes, mas recupera apenas um item em cada chamada. Pode ser necessário realizar várias chamadas para obter a lista completa. Limitar o tamanho da página é útil ao executar os comandos da lista em um grande número de recursos, o que pode resultar em um erro de “tempo limite” ao usar o tamanho de página padrão de 1.000. ``` aws dynamodb list-backups \ --page-size 1 ``` Resultado: ``` { "BackupSummaries": [ { "TableName": "MusicCollection", "TableId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection", "BackupArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01234567890123-a1bcd234", "BackupName": "MusicCollectionBackup1", "BackupCreationDateTime": "2020-02-12T14:41:51.617000-08:00", "BackupStatus": "AVAILABLE", "BackupType": "USER", "BackupSizeBytes": 170 }, { "TableName": "MusicCollection", "TableId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection", "BackupArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01234567890123-b2abc345", "BackupName": "MusicCollectionBackup2", "BackupCreationDateTime": "2020-06-26T11:08:35.431000-07:00", "BackupStatus": "AVAILABLE", "BackupType": "USER", "BackupSizeBytes": 400 } ] } ``` Para obter mais informações, consulte [Backup e restauração do DynamoDB sob demanda](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/BackupRestore.html) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 4: limitar o número de itens retornados** O exemplo a seguir limita o número de itens retornados para um. A resposta inclui um valor `NextToken` a ser usado para recuperar a próxima página de resultados. ``` aws dynamodb list-backups \ --max-items 1 ``` Resultado: ``` { "BackupSummaries": [ { "TableName": "MusicCollection", "TableId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection", "BackupArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01234567890123-a1bcd234", "BackupName": "MusicCollectionBackup1", "BackupCreationDateTime": "2020-02-12T14:41:51.617000-08:00", "BackupStatus": "AVAILABLE", "BackupType": "USER", "BackupSizeBytes": 170 } ], "NextToken": "abCDeFGhiJKlmnOPqrSTuvwxYZ1aBCdEFghijK7LM51nOpqRSTuv3WxY3ZabC5dEFGhI2Jk3LmnoPQ6RST9" } ``` Para obter mais informações, consulte [Backup e restauração do DynamoDB sob demanda](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/BackupRestore.html) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 5: recuperar a próxima página de resultados** O comando a seguir usa o valor `NextToken` de uma chamada anterior feita ao comando `list-backups` para recuperar outra página de resultados. Como a resposta nesse caso não inclui um valor para `NextToken`, sabemos que chegamos ao final dos resultados. ``` aws dynamodb list-backups \ --starting-token abCDeFGhiJKlmnOPqrSTuvwxYZ1aBCdEFghijK7LM51nOpqRSTuv3WxY3ZabC5dEFGhI2Jk3LmnoPQ6RST9 ``` Output ``` { "BackupSummaries": [ { "TableName": "MusicCollection", "TableId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection", "BackupArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01234567890123-b2abc345", "BackupName": "MusicCollectionBackup2", "BackupCreationDateTime": "2020-06-26T11:08:35.431000-07:00", "BackupStatus": "AVAILABLE", "BackupType": "USER", "BackupSizeBytes": 400 } ] } ``` Para obter mais informações, consulte [Backup e restauração do DynamoDB sob demanda](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/BackupRestore.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [ListBackups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/list-backups.html) na *Referência de comandos da AWS CLI*. ### `list-contributor-insights` O código de exemplo a seguir mostra como usar `list-contributor-insights`. **AWS CLI** **Exemplo 1: visualizar uma lista de resumos do Contributor Insights** O exemplo `list-contributor-insights` a seguir exibe uma lista de resumos do Contributor Insights. ``` aws dynamodb list-contributor-insights ``` Resultado: ``` { "ContributorInsightsSummaries": [ { "TableName": "MusicCollection", "IndexName": "AlbumTitle-index", "ContributorInsightsStatus": "ENABLED" }, { "TableName": "ProductCatalog", "ContributorInsightsStatus": "ENABLED" }, { "TableName": "Forum", "ContributorInsightsStatus": "ENABLED" }, { "TableName": "Reply", "ContributorInsightsStatus": "ENABLED" }, { "TableName": "Thread", "ContributorInsightsStatus": "ENABLED" } ] } ``` Para obter mais informações, consulte [Analisar acesso a dados usando o CloudWatch Contributor Insights para DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/contributorinsights.html) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 2: limitar o número de itens retornados** O exemplo a seguir limita o número de itens retornados para quatro. A resposta inclui um valor `NextToken` a ser usado para recuperar a próxima página de resultados. ``` aws dynamodb list-contributor-insights \ --max-results 4 ``` Resultado: ``` { "ContributorInsightsSummaries": [ { "TableName": "MusicCollection", "IndexName": "AlbumTitle-index", "ContributorInsightsStatus": "ENABLED" }, { "TableName": "ProductCatalog", "ContributorInsightsStatus": "ENABLED" }, { "TableName": "Forum", "ContributorInsightsStatus": "ENABLED" } ], "NextToken": "abCDeFGhiJKlmnOPqrSTuvwxYZ1aBCdEFghijK7LM51nOpqRSTuv3WxY3ZabC5dEFGhI2Jk3LmnoPQ6RST9" } ``` Para obter mais informações, consulte [Analisar acesso a dados usando o CloudWatch Contributor Insights para DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/contributorinsights.html) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 3: recuperar a próxima página de resultados** O comando a seguir usa o valor `NextToken` de uma chamada anterior feita ao comando `list-contributor-insights` para recuperar outra página de resultados. Como a resposta nesse caso não inclui um valor para `NextToken`, sabemos que chegamos ao final dos resultados. ``` aws dynamodb list-contributor-insights \ --max-results 4 \ --next-token abCDeFGhiJKlmnOPqrSTuvwxYZ1aBCdEFghijK7LM51nOpqRSTuv3WxY3ZabC5dEFGhI2Jk3LmnoPQ6RST9 ``` Resultado: ``` { "ContributorInsightsSummaries": [ { "TableName": "Reply", "ContributorInsightsStatus": "ENABLED" }, { "TableName": "Thread", "ContributorInsightsStatus": "ENABLED" } ] } ``` Para obter mais informações, consulte [Analisar acesso a dados usando o CloudWatch Contributor Insights para DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/contributorinsights.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [ListContributorInsights](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/list-contributor-insights.html) na *Referência de comandos da AWS CLI*. ### `list-global-tables` O código de exemplo a seguir mostra como usar `list-global-tables`. **AWS CLI** **Para listar tabelas globais do DynamoDB existentes** O exemplo `list-global-tables` a seguir lista todas as suas tabelas globais existentes. ``` aws dynamodb list-global-tables ``` Resultado: ``` { "GlobalTables": [ { "GlobalTableName": "MusicCollection", "ReplicationGroup": [ { "RegionName": "us-east-2" }, { "RegionName": "us-east-1" } ] } ] } ``` Para obter mais informações, consulte [Tabelas do globais do DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [ListGlobalTables](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/list-global-tables.html) na *Referência de comandos da AWS CLI*. ### `list-tables` O código de exemplo a seguir mostra como usar `list-tables`. **AWS CLI** **Exemplo 1: listar tabelas** O exemplo de `list-tables` a seguir lista todas as tabelas associadas à conta e região atuais da AWS. ``` aws dynamodb list-tables ``` Resultado: ``` { "TableNames": [ "Forum", "ProductCatalog", "Reply", "Thread" ] } ``` Para obter mais informações, consulte [Listar nomes de tabela](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.ListTables) no *Guia do desenvolvedor Amazon DynamoDB*. **Exemplo 2: como limitar o tamanho da página** O exemplo a seguir retorna uma lista de todas as tabelas existentes, mas recupera apenas um item em cada chamada. Pode ser necessário realizar várias chamadas para obter a lista completa. Limitar o tamanho da página é útil ao executar os comandos da lista em um grande número de recursos, o que pode resultar em um erro de “tempo limite” ao usar o tamanho de página padrão de 1.000. ``` aws dynamodb list-tables \ --page-size 1 ``` Resultado: ``` { "TableNames": [ "Forum", "ProductCatalog", "Reply", "Thread" ] } ``` Para obter mais informações, consulte [Listar nomes de tabela](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.ListTables) no *Guia do desenvolvedor Amazon DynamoDB*. **Exemplo 3: como limitar o número de itens retornados** O exemplo a seguir limita o número de itens retornados para dois. A resposta inclui um valor `NextToken` a ser usado para recuperar a próxima página de resultados. ``` aws dynamodb list-tables \ --max-items 2 ``` Resultado: ``` { "TableNames": [ "Forum", "ProductCatalog" ], "NextToken": "abCDeFGhiJKlmnOPqrSTuvwxYZ1aBCdEFghijK7LM51nOpqRSTuv3WxY3ZabC5dEFGhI2Jk3LmnoPQ6RST9" } ``` Para obter mais informações, consulte [Listar nomes de tabela](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.ListTables) no *Guia do desenvolvedor Amazon DynamoDB*. **Exemplo 4: como recuperar a próxima página de resultados** O comando a seguir usa o valor `NextToken` de uma chamada anterior feita ao comando `list-tables` para recuperar outra página de resultados. Como a resposta nesse caso não inclui um valor para `NextToken`, sabemos que chegamos ao final dos resultados. ``` aws dynamodb list-tables \ --starting-token abCDeFGhiJKlmnOPqrSTuvwxYZ1aBCdEFghijK7LM51nOpqRSTuv3WxY3ZabC5dEFGhI2Jk3LmnoPQ6RST9 ``` Resultado: ``` { "TableNames": [ "Reply", "Thread" ] } ``` Para obter mais informações, consulte [Listar nomes de tabela](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.ListTables) no *Guia do desenvolvedor Amazon DynamoDB*. + Consulte detalhes da API em [ListTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/list-tables.html) na *Referência de comandos da AWS CLI*. ### `list-tags-of-resource` O código de exemplo a seguir mostra como usar `list-tags-of-resource`. **AWS CLI** **Exemplo 1: listar as tags de um recurso do DynamoDB** O exemplo `list-tags-of-resource` a seguir exibe tags para a tabela `MusicCollection`. ``` aws dynamodb list-tags-of-resource \ --resource-arn arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection ``` Resultado: ``` { "Tags": [ { "Key": "Owner", "Value": "blueTeam" }, { "Key": "Environment", "Value": "Production" } ] } ``` Para obter mais informações, consulte [Marcação no DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) no *Guia do desenvolvedor Amazon DynamoDB*. **Exemplo 2: limitar o número de tags retornadas** O exemplo a seguir limita o número de tags retornadas para um. A resposta inclui um valor `NextToken` a ser usado para recuperar a próxima página de resultados. ``` aws dynamodb list-tags-of-resource \ --resource-arn arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection \ --max-items 1 ``` Resultado: ``` { "Tags": [ { "Key": "Owner", "Value": "blueTeam" } ], "NextToken": "abCDeFGhiJKlmnOPqrSTuvwxYZ1aBCdEFghijK7LM51nOpqRSTuv3WxY3ZabC5dEFGhI2Jk3LmnoPQ6RST9" } ``` Para obter mais informações, consulte [Marcação no DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) no *Guia do desenvolvedor Amazon DynamoDB*. **Exemplo 3: recuperar a próxima página de resultados** O comando a seguir usa o valor `NextToken` de uma chamada anterior feita ao comando `list-tags-of-resource` para recuperar outra página de resultados. Como a resposta nesse caso não inclui um valor para `NextToken`, sabemos que chegamos ao final dos resultados. ``` aws dynamodb list-tags-of-resource \ --resource-arn arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection \ --starting-token abCDeFGhiJKlmnOPqrSTuvwxYZ1aBCdEFghijK7LM51nOpqRSTuv3WxY3ZabC5dEFGhI2Jk3LmnoPQ6RST9 ``` Resultado: ``` { "Tags": [ { "Key": "Environment", "Value": "Production" } ] } ``` Para obter mais informações, consulte [Marcação no DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) no *Guia do desenvolvedor Amazon DynamoDB*. + Para ver detalhes da API, consulte [ListTagsOfResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/list-tags-of-resource.html) na *Referência de comandos da AWS CLI*. ### `put-item` O código de exemplo a seguir mostra como usar `put-item`. **AWS CLI** **Exemplo 1: como adicionar um item a uma tabela** O exemplo de `put-item` a seguir adiciona um novo item à tabela *MusicCollection*. ``` aws dynamodb put-item \ --table-name MusicCollection \ --item file://item.json \ --return-consumed-capacity TOTAL \ --return-item-collection-metrics SIZE ``` Conteúdo de `item.json`: ``` { "Artist": {"S": "No One You Know"}, "SongTitle": {"S": "Call Me Today"}, "AlbumTitle": {"S": "Greatest Hits"} } ``` Resultado: ``` { "ConsumedCapacity": { "TableName": "MusicCollection", "CapacityUnits": 1.0 }, "ItemCollectionMetrics": { "ItemCollectionKey": { "Artist": { "S": "No One You Know" } }, "SizeEstimateRangeGB": [ 0.0, 1.0 ] } } ``` Para obter mais informações, consulte [Gravar um item](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.WritingData) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 2: como substituir condicionalmente um item em uma tabela** O exemplo de `put-item` a seguir substitui um item existente na tabela `MusicCollection` somente se o item existente tiver um atributo `AlbumTitle` com o valor `Greatest Hits`. O comando retorna o valor anterior do item. ``` aws dynamodb put-item \ --table-name MusicCollection \ --item file://item.json \ --condition-expression "#A = :A" \ --expression-attribute-names file://names.json \ --expression-attribute-values file://values.json \ --return-values ALL_OLD ``` Conteúdo de `item.json`: ``` { "Artist": {"S": "No One You Know"}, "SongTitle": {"S": "Call Me Today"}, "AlbumTitle": {"S": "Somewhat Famous"} } ``` Conteúdo de `names.json`: ``` { "#A": "AlbumTitle" } ``` Conteúdo de `values.json`: ``` { ":A": {"S": "Greatest Hits"} } ``` Resultado: ``` { "Attributes": { "AlbumTitle": { "S": "Greatest Hits" }, "Artist": { "S": "No One You Know" }, "SongTitle": { "S": "Call Me Today" } } } ``` Se a chave já existir, você verá a seguinte saída: ``` A client error (ConditionalCheckFailedException) occurred when calling the PutItem operation: The conditional request failed. ``` Para obter mais informações, consulte [Gravar um item](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.WritingData) no *Guia do desenvolvedor do Amazon DynamoDB*. + Consulte detalhes da API em [PutItem](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/put-item.html) na *Referência de comandos da AWS CLI*. ### `query` O código de exemplo a seguir mostra como usar `query`. **AWS CLI** **Exemplo 1: como consultar uma tabela** O exemplo da `query` a seguir consulta itens da tabela `MusicCollection`. A tabela tem uma chave primária de hash e intervalo (`Artist` e `SongTitle`), mas essa consulta especifica apenas o valor da chave de hash. Ela retorna nomes de músicas do artista “No One You Know”. ``` aws dynamodb query \ --table-name MusicCollection \ --projection-expression "SongTitle" \ --key-condition-expression "Artist = :v1" \ --expression-attribute-values file://expression-attributes.json \ --return-consumed-capacity TOTAL ``` Conteúdo de `expression-attributes.json`: ``` { ":v1": {"S": "No One You Know"} } ``` Resultado: ``` { "Items": [ { "SongTitle": { "S": "Call Me Today" }, "SongTitle": { "S": "Scared of My Shadow" } } ], "Count": 2, "ScannedCount": 2, "ConsumedCapacity": { "TableName": "MusicCollection", "CapacityUnits": 0.5 } } ``` Para obter mais informações, consulte [Operações de consulta no DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 2: como consultar uma tabela usando leituras altamente consistentes e percorrer o índice em ordem decrescente** O exemplo a seguir executa a mesma consulta do primeiro exemplo, mas retorna os resultados na ordem inversa e usa leituras altamente consistentes. ``` aws dynamodb query \ --table-name MusicCollection \ --projection-expression "SongTitle" \ --key-condition-expression "Artist = :v1" \ --expression-attribute-values file://expression-attributes.json \ --consistent-read \ --no-scan-index-forward \ --return-consumed-capacity TOTAL ``` Conteúdo de `expression-attributes.json`: ``` { ":v1": {"S": "No One You Know"} } ``` Resultado: ``` { "Items": [ { "SongTitle": { "S": "Scared of My Shadow" } }, { "SongTitle": { "S": "Call Me Today" } } ], "Count": 2, "ScannedCount": 2, "ConsumedCapacity": { "TableName": "MusicCollection", "CapacityUnits": 1.0 } } ``` Para obter mais informações, consulte [Operações de consulta no DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 3: como filtrar resultados específicos** O exemplo a seguir consulta o `MusicCollection`, mas exclui os resultados com valores específicos no atributo `AlbumTitle`. Observe que isso não afeta `ScannedCount` ou `ConsumedCapacity` já que o filtro é aplicado após a leitura dos itens. ``` aws dynamodb query \ --table-name MusicCollection \ --key-condition-expression "#n1 = :v1" \ --filter-expression "NOT (#n2 IN (:v2, :v3))" \ --expression-attribute-names file://names.json \ --expression-attribute-values file://values.json \ --return-consumed-capacity TOTAL ``` Conteúdo de `values.json`: ``` { ":v1": {"S": "No One You Know"}, ":v2": {"S": "Blue Sky Blues"}, ":v3": {"S": "Greatest Hits"} } ``` Conteúdo de `names.json`: ``` { "#n1": "Artist", "#n2": "AlbumTitle" } ``` Resultado: ``` { "Items": [ { "AlbumTitle": { "S": "Somewhat Famous" }, "Artist": { "S": "No One You Know" }, "SongTitle": { "S": "Call Me Today" } } ], "Count": 1, "ScannedCount": 2, "ConsumedCapacity": { "TableName": "MusicCollection", "CapacityUnits": 0.5 } } ``` Para obter mais informações, consulte [Operações de consulta no DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 4: como recuperar somente uma contagem de itens** O exemplo a seguir recupera uma contagem de itens que correspondem à consulta, mas não recupera os itens em si. ``` aws dynamodb query \ --table-name MusicCollection \ --select COUNT \ --key-condition-expression "Artist = :v1" \ --expression-attribute-values file://expression-attributes.json ``` Conteúdo de `expression-attributes.json`: ``` { ":v1": {"S": "No One You Know"} } ``` Resultado: ``` { "Count": 2, "ScannedCount": 2, "ConsumedCapacity": null } ``` Para obter mais informações, consulte [Operações de consulta no DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 5: como consultar um índice** O exemplo a seguir consulta o índice secundário local `AlbumTitleIndex`. A consulta retorna todos os atributos da tabela base projetados no índice secundário local. Ao consultar um índice secundário local ou global, você deve fornecer o nome da tabela base usando o parâmetro `table-name`. ``` aws dynamodb query \ --table-name MusicCollection \ --index-name AlbumTitleIndex \ --key-condition-expression "Artist = :v1" \ --expression-attribute-values file://expression-attributes.json \ --select ALL_PROJECTED_ATTRIBUTES \ --return-consumed-capacity INDEXES ``` Conteúdo de `expression-attributes.json`: ``` { ":v1": {"S": "No One You Know"} } ``` Resultado: ``` { "Items": [ { "AlbumTitle": { "S": "Blue Sky Blues" }, "Artist": { "S": "No One You Know" }, "SongTitle": { "S": "Scared of My Shadow" } }, { "AlbumTitle": { "S": "Somewhat Famous" }, "Artist": { "S": "No One You Know" }, "SongTitle": { "S": "Call Me Today" } } ], "Count": 2, "ScannedCount": 2, "ConsumedCapacity": { "TableName": "MusicCollection", "CapacityUnits": 0.5, "Table": { "CapacityUnits": 0.0 }, "LocalSecondaryIndexes": { "AlbumTitleIndex": { "CapacityUnits": 0.5 } } } } ``` Para obter mais informações, consulte [Operações de consulta no DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Consulte detalhes da API em [Query](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/query.html) na *Referência de comandos da AWS CLI*. ### `restore-table-from-backup` O código de exemplo a seguir mostra como usar `restore-table-from-backup`. **AWS CLI** **Como restaurar uma tabela do DynamoDB de um backup existente** O exemplo `restore-table-from-backup` a seguir restaura a tabela especificada de um backup existente. ``` aws dynamodb restore-table-from-backup \ --target-table-name MusicCollection \ --backup-arnarn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01576616366715-b4e58d3a ``` Resultado: ``` { "TableDescription": { "AttributeDefinitions": [ { "AttributeName": "Artist", "AttributeType": "S" }, { "AttributeName": "SongTitle", "AttributeType": "S" } ], "TableName": "MusicCollection2", "KeySchema": [ { "AttributeName": "Artist", "KeyType": "HASH" }, { "AttributeName": "SongTitle", "KeyType": "RANGE" } ], "TableStatus": "CREATING", "CreationDateTime": 1576618274.326, "ProvisionedThroughput": { "NumberOfDecreasesToday": 0, "ReadCapacityUnits": 5, "WriteCapacityUnits": 5 }, "TableSizeBytes": 0, "ItemCount": 0, "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection2", "TableId": "114865c9-5ef3-496c-b4d1-c4cbdd2d44fb", "BillingModeSummary": { "BillingMode": "PROVISIONED" }, "RestoreSummary": { "SourceBackupArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01576616366715-b4e58d3a", "SourceTableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection", "RestoreDateTime": 1576616366.715, "RestoreInProgress": true } } } ``` Para obter mais informações, consulte [Backup e restauração do DynamoDB sob demanda](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/BackupRestore.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [RestoreTableFromBackup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/restore-table-from-backup.html) na *Referência de comandos da AWS CLI*. ### `restore-table-to-point-in-time` O código de exemplo a seguir mostra como usar `restore-table-to-point-in-time`. **AWS CLI** **Como restaurar uma tabela do DynamoDB para um ponto no tempo** O exemplo `restore-table-to-point-in-time` a seguir restaura a tabela `MusicCollection` no momento especificado. ``` aws dynamodb restore-table-to-point-in-time \ --source-table-name MusicCollection \ --target-table-name MusicCollectionRestore \ --restore-date-time 1576622404.0 ``` Resultado: ``` { "TableDescription": { "AttributeDefinitions": [ { "AttributeName": "Artist", "AttributeType": "S" }, { "AttributeName": "SongTitle", "AttributeType": "S" } ], "TableName": "MusicCollectionRestore", "KeySchema": [ { "AttributeName": "Artist", "KeyType": "HASH" }, { "AttributeName": "SongTitle", "KeyType": "RANGE" } ], "TableStatus": "CREATING", "CreationDateTime": 1576623311.86, "ProvisionedThroughput": { "NumberOfDecreasesToday": 0, "ReadCapacityUnits": 5, "WriteCapacityUnits": 5 }, "TableSizeBytes": 0, "ItemCount": 0, "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollectionRestore", "TableId": "befd9e0e-1843-4dc6-a147-d6d00e85cb1f", "BillingModeSummary": { "BillingMode": "PROVISIONED" }, "RestoreSummary": { "SourceTableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection", "RestoreDateTime": 1576622404.0, "RestoreInProgress": true } } } ``` Para obter mais informações, consulte [Recuperação para um ponto no tempo para o DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/PointInTimeRecovery.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [RestoreTableToPointInTime](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/restore-table-to-point-in-time.html) na *Referência de comandos da AWS CLI*. ### `scan` O código de exemplo a seguir mostra como usar `scan`. **AWS CLI** **Como verificar uma tabela** O exemplo de `scan` faz uma varredura da tabela `MusicCollection` e restringe os resultados a músicas do artista “No One You Know”. Em cada item, somente o nome do álbum e da música são retornados. ``` aws dynamodb scan \ --table-name MusicCollection \ --filter-expression "Artist = :a" \ --projection-expression "#ST, #AT" \ --expression-attribute-names file://expression-attribute-names.json \ --expression-attribute-values file://expression-attribute-values.json ``` Conteúdo de `expression-attribute-names.json`: ``` { "#ST": "SongTitle", "#AT":"AlbumTitle" } ``` Conteúdo de `expression-attribute-values.json`: ``` { ":a": {"S": "No One You Know"} } ``` Resultado: ``` { "Count": 2, "Items": [ { "SongTitle": { "S": "Call Me Today" }, "AlbumTitle": { "S": "Somewhat Famous" } }, { "SongTitle": { "S": "Scared of My Shadow" }, "AlbumTitle": { "S": "Blue Sky Blues" } } ], "ScannedCount": 3, "ConsumedCapacity": null } ``` Para obter mais informações, consulte [Trabalhar com verificações no DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Consulte detalhes da API em [Scan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/scan.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Para adicionar tags a um recurso do DynamoDB** O exemplo `tag-resource` a seguir adiciona uma tag com o par de chave-valor à tabela `MusicCollection`. ``` aws dynamodb tag-resource \ --resource-arn arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection \ --tags Key=Owner,Value=blueTeam ``` Este comando não produz saída. Para obter mais informações, consulte [Marcação no DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) no *Guia do desenvolvedor Amazon DynamoDB*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `transact-get-items` O código de exemplo a seguir mostra como usar `transact-get-items`. **AWS CLI** **Para recuperar vários itens atomicamente de uma ou mais tabelas** O exemplo `transact-get-items` a seguir recupera vários itens atomicamente. ``` aws dynamodb transact-get-items \ --transact-items file://transact-items.json \ --return-consumed-capacity TOTAL ``` Conteúdo de `transact-items.json`: ``` [ { "Get": { "Key": { "Artist": {"S": "Acme Band"}, "SongTitle": {"S": "Happy Day"} }, "TableName": "MusicCollection" } }, { "Get": { "Key": { "Artist": {"S": "No One You Know"}, "SongTitle": {"S": "Call Me Today"} }, "TableName": "MusicCollection" } } ] ``` Resultado: ``` { "ConsumedCapacity": [ { "TableName": "MusicCollection", "CapacityUnits": 4.0, "ReadCapacityUnits": 4.0 } ], "Responses": [ { "Item": { "AlbumTitle": { "S": "Songs About Life" }, "Artist": { "S": "Acme Band" }, "SongTitle": { "S": "Happy Day" } } }, { "Item": { "AlbumTitle": { "S": "Somewhat Famous" }, "Artist": { "S": "No One You Know" }, "SongTitle": { "S": "Call Me Today" } } } ] } ``` Para obter mais informações, consulte [Gerenciamento de fluxos de trabalho complexos com transações do DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/transactions.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [TransactGetItems](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/transact-get-items.html) na *Referência de comandos da AWS CLI*. ### `transact-write-items` O código de exemplo a seguir mostra como usar `transact-write-items`. **AWS CLI** **Exemplo 1: gravar itens atomicamente em uma ou mais tabelas** O exemplo `transact-write-items` a seguir atualiza um item e exclui outro. A operação falhará se uma das operações falhar ou se um dos itens contiver um atributo `Rating`. ``` aws dynamodb transact-write-items \ --transact-items file://transact-items.json \ --return-consumed-capacity TOTAL \ --return-item-collection-metrics SIZE ``` Conteúdo do arquivo `transact-items.json`: ``` [ { "Update": { "Key": { "Artist": {"S": "Acme Band"}, "SongTitle": {"S": "Happy Day"} }, "UpdateExpression": "SET AlbumTitle = :newval", "ExpressionAttributeValues": { ":newval": {"S": "Updated Album Title"} }, "TableName": "MusicCollection", "ConditionExpression": "attribute_not_exists(Rating)" } }, { "Delete": { "Key": { "Artist": {"S": "No One You Know"}, "SongTitle": {"S": "Call Me Today"} }, "TableName": "MusicCollection", "ConditionExpression": "attribute_not_exists(Rating)" } } ] ``` Resultado: ``` { "ConsumedCapacity": [ { "TableName": "MusicCollection", "CapacityUnits": 10.0, "WriteCapacityUnits": 10.0 } ], "ItemCollectionMetrics": { "MusicCollection": [ { "ItemCollectionKey": { "Artist": { "S": "No One You Know" } }, "SizeEstimateRangeGB": [ 0.0, 1.0 ] }, { "ItemCollectionKey": { "Artist": { "S": "Acme Band" } }, "SizeEstimateRangeGB": [ 0.0, 1.0 ] } ] } } ``` Para obter mais informações, consulte [Gerenciamento de fluxos de trabalho complexos com transações do DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/transactions.html) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 2: escrever itens atomicamente usando um token de solicitação do cliente** O comando a seguir usa um token de solicitação do cliente para fazer a chamada para `transact-write-items` idempotente, o que significa que várias chamadas têm o mesmo efeito de uma única chamada. ``` aws dynamodb transact-write-items \ --transact-items file://transact-items.json \ --client-request-token abc123 ``` Conteúdo do arquivo `transact-items.json`: ``` [ { "Update": { "Key": { "Artist": {"S": "Acme Band"}, "SongTitle": {"S": "Happy Day"} }, "UpdateExpression": "SET AlbumTitle = :newval", "ExpressionAttributeValues": { ":newval": {"S": "Updated Album Title"} }, "TableName": "MusicCollection", "ConditionExpression": "attribute_not_exists(Rating)" } }, { "Delete": { "Key": { "Artist": {"S": "No One You Know"}, "SongTitle": {"S": "Call Me Today"} }, "TableName": "MusicCollection", "ConditionExpression": "attribute_not_exists(Rating)" } } ] ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciamento de fluxos de trabalho complexos com transações do DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/transactions.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [TransactWriteItems](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/transact-write-items.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover uma tag de um recurso do DynamoDB** O exemplo `untag-resource` a seguir remove a tag com a chave `Owner` da tabela `MusicCollection`. ``` aws dynamodb untag-resource \ --resource-arn arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection \ --tag-keys Owner ``` Este comando não produz saída. Para obter mais informações, consulte [Marcação no DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) no *Guia do desenvolvedor Amazon DynamoDB*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-continuous-backups` O código de exemplo a seguir mostra como usar `update-continuous-backups`. **AWS CLI** **Para atualizar as configurações de backup contínuo para uma tabela do DynamoDB** O exemplo `update-continuous-backups` a seguir permite a recuperação de ponto no tempo para a tabela `MusicCollection`. ``` aws dynamodb update-continuous-backups \ --table-name MusicCollection \ --point-in-time-recovery-specification PointInTimeRecoveryEnabled=true ``` Resultado: ``` { "ContinuousBackupsDescription": { "ContinuousBackupsStatus": "ENABLED", "PointInTimeRecoveryDescription": { "PointInTimeRecoveryStatus": "ENABLED", "EarliestRestorableDateTime": 1576622404.0, "LatestRestorableDateTime": 1576622404.0 } } } ``` Para obter mais informações, consulte [Recuperação para um ponto no tempo para o DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/PointInTimeRecovery.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [UpdateContinuousBackups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/update-continuous-backups.html) na *Referência de comandos da AWS CLI*. ### `update-contributor-insights` O código de exemplo a seguir mostra como usar `update-contributor-insights`. **AWS CLI** **Para habilitar o Contributor Insights em uma tabela** O exemplo `update-contributor-insights` a seguir ativa o Contributor Insights na tabela `MusicCollection` e no índice secundário global `AlbumTitle-index`. ``` aws dynamodb update-contributor-insights \ --table-name MusicCollection \ --index-name AlbumTitle-index \ --contributor-insights-action ENABLE ``` Resultado: ``` { "TableName": "MusicCollection", "IndexName": "AlbumTitle-index", "ContributorInsightsStatus": "ENABLING" } ``` Para obter mais informações, consulte [Analisar acesso a dados usando o CloudWatch Contributor Insights para DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/contributorinsights.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [UpdateContributorInsights](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/update-contributor-insights.html) na *Referência de comandos da AWS CLI*. ### `update-global-table-settings` O código de exemplo a seguir mostra como usar `update-global-table-settings`. **AWS CLI** **Para atualizar as configurações de capacidade de gravação provisionada em uma tabela global do DynamoDB** O exemplo `update-global-table-settings` a seguir define a capacidade de gravação provisionada da tabela global `MusicCollection` como 15. ``` aws dynamodb update-global-table-settings \ --global-table-name MusicCollection \ --global-table-provisioned-write-capacity-units 15 ``` Resultado: ``` { "GlobalTableName": "MusicCollection", "ReplicaSettings": [ { "RegionName": "eu-west-1", "ReplicaStatus": "UPDATING", "ReplicaProvisionedReadCapacityUnits": 10, "ReplicaProvisionedReadCapacityAutoScalingSettings": { "AutoScalingDisabled": true }, "ReplicaProvisionedWriteCapacityUnits": 10, "ReplicaProvisionedWriteCapacityAutoScalingSettings": { "AutoScalingDisabled": true } }, { "RegionName": "us-east-1", "ReplicaStatus": "UPDATING", "ReplicaProvisionedReadCapacityUnits": 10, "ReplicaProvisionedReadCapacityAutoScalingSettings": { "AutoScalingDisabled": true }, "ReplicaProvisionedWriteCapacityUnits": 10, "ReplicaProvisionedWriteCapacityAutoScalingSettings": { "AutoScalingDisabled": true } }, { "RegionName": "us-east-2", "ReplicaStatus": "UPDATING", "ReplicaProvisionedReadCapacityUnits": 10, "ReplicaProvisionedReadCapacityAutoScalingSettings": { "AutoScalingDisabled": true }, "ReplicaProvisionedWriteCapacityUnits": 10, "ReplicaProvisionedWriteCapacityAutoScalingSettings": { "AutoScalingDisabled": true } } ] } ``` Para obter mais informações, consulte [Tabelas do globais do DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [UpdateGlobalTableSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/update-global-table-settings.html) na *Referência de comandos da AWS CLI*. ### `update-global-table` O código de exemplo a seguir mostra como usar `update-global-table`. **AWS CLI** **Para atualizar uma tabela global do DynamoDB** O exemplo `update-global-table` a seguir adiciona uma réplica na região especificada à tabela global `MusicCollection`. ``` aws dynamodb update-global-table \ --global-table-name MusicCollection \ --replica-updates Create={RegionName=eu-west-1} ``` Resultado: ``` { "GlobalTableDescription": { "ReplicationGroup": [ { "RegionName": "eu-west-1" }, { "RegionName": "us-east-2" }, { "RegionName": "us-east-1" } ], "GlobalTableArn": "arn:aws:dynamodb::123456789012:global-table/MusicCollection", "CreationDateTime": 1576625818.532, "GlobalTableStatus": "ACTIVE", "GlobalTableName": "MusicCollection" } } ``` Para obter mais informações, consulte [Tabelas do globais do DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [UpdateGlobalTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/update-global-table.html) na *Referência de comandos da AWS CLI*. ### `update-item` O código de exemplo a seguir mostra como usar `update-item`. **AWS CLI** **Exemplo 1: como atualizar um item em uma tabela** O exemplo da `update-item` a seguir atualiza um item da tabela `MusicCollection`. Ele adiciona um novo atributo (`Year`) e modifica o atributo `AlbumTitle`. Todos os atributos no item, conforme aparecem após a atualização, são retornados na resposta. ``` aws dynamodb update-item \ --table-name MusicCollection \ --key file://key.json \ --update-expression "SET #Y = :y, #AT = :t" \ --expression-attribute-names file://expression-attribute-names.json \ --expression-attribute-values file://expression-attribute-values.json \ --return-values ALL_NEW \ --return-consumed-capacity TOTAL \ --return-item-collection-metrics SIZE ``` Conteúdo de `key.json`: ``` { "Artist": {"S": "Acme Band"}, "SongTitle": {"S": "Happy Day"} } ``` Conteúdo de `expression-attribute-names.json`: ``` { "#Y":"Year", "#AT":"AlbumTitle" } ``` Conteúdo de `expression-attribute-values.json`: ``` { ":y":{"N": "2015"}, ":t":{"S": "Louder Than Ever"} } ``` Resultado: ``` { "Attributes": { "AlbumTitle": { "S": "Louder Than Ever" }, "Awards": { "N": "10" }, "Artist": { "S": "Acme Band" }, "Year": { "N": "2015" }, "SongTitle": { "S": "Happy Day" } }, "ConsumedCapacity": { "TableName": "MusicCollection", "CapacityUnits": 3.0 }, "ItemCollectionMetrics": { "ItemCollectionKey": { "Artist": { "S": "Acme Band" } }, "SizeEstimateRangeGB": [ 0.0, 1.0 ] } } ``` Para obter mais informações, consulte [Gravar um item](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.WritingData) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 2: como atualizar um item de forma condicional** O exemplo a seguir atualiza um item na tabela `MusicCollection`, mas somente se o item existente ainda não tiver um atributo `Year`. ``` aws dynamodb update-item \ --table-name MusicCollection \ --key file://key.json \ --update-expression "SET #Y = :y, #AT = :t" \ --expression-attribute-names file://expression-attribute-names.json \ --expression-attribute-values file://expression-attribute-values.json \ --condition-expression "attribute_not_exists(#Y)" ``` Conteúdo de `key.json`: ``` { "Artist": {"S": "Acme Band"}, "SongTitle": {"S": "Happy Day"} } ``` Conteúdo de `expression-attribute-names.json`: ``` { "#Y":"Year", "#AT":"AlbumTitle" } ``` Conteúdo de `expression-attribute-values.json`: ``` { ":y":{"N": "2015"}, ":t":{"S": "Louder Than Ever"} } ``` Se o item já tiver um atributo `Year`, o DynamoDB retornará saída a seguir. ``` An error occurred (ConditionalCheckFailedException) when calling the UpdateItem operation: The conditional request failed ``` Para obter mais informações, consulte [Gravar um item](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.WritingData) no *Guia do desenvolvedor do Amazon DynamoDB*. + Consulte detalhes da API em [UpdateItem](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/update-item.html) na *Referência de comandos da AWS CLI*. ### `update-table-replica-auto-scaling` O código de exemplo a seguir mostra como usar `update-table-replica-auto-scaling`. **AWS CLI** **Para atualizar as configurações de ajuste de escala automático em réplicas de uma tabela global** O exemplo `update-table-replica-auto-scaling` a seguir atualiza as configurações de ajuste de escala automático da capacidade de gravação em réplicas da tabela global especificada. ``` aws dynamodb update-table-replica-auto-scaling \ --table-name MusicCollection \ --provisioned-write-capacity-auto-scaling-update file://auto-scaling-policy.json ``` Conteúdo de `auto-scaling-policy.json`: ``` { "MinimumUnits": 10, "MaximumUnits": 100, "AutoScalingDisabled": false, "ScalingPolicyUpdate": { "PolicyName": "DynamoDBWriteCapacityUtilization:table/MusicCollection", "TargetTrackingScalingPolicyConfiguration": { "TargetValue": 80 } } } ``` Resultado: ``` { "TableAutoScalingDescription": { "TableName": "MusicCollection", "TableStatus": "ACTIVE", "Replicas": [ { "RegionName": "eu-central-1", "GlobalSecondaryIndexes": [], "ReplicaProvisionedReadCapacityAutoScalingSettings": { "MinimumUnits": 5, "MaximumUnits": 40000, "AutoScalingRoleArn": "arn:aws:iam::123456789012:role/aws-service-role/dynamodb.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_DynamoDBTable", "ScalingPolicies": [ { "PolicyName": "DynamoDBReadCapacityUtilization:table/MusicCollection", "TargetTrackingScalingPolicyConfiguration": { "TargetValue": 70.0 } } ] }, "ReplicaProvisionedWriteCapacityAutoScalingSettings": { "MinimumUnits": 10, "MaximumUnits": 100, "AutoScalingRoleArn": "arn:aws:iam::123456789012:role/aws-service-role/dynamodb.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_DynamoDBTable", "ScalingPolicies": [ { "PolicyName": "DynamoDBWriteCapacityUtilization:table/MusicCollection", "TargetTrackingScalingPolicyConfiguration": { "TargetValue": 80.0 } } ] }, "ReplicaStatus": "ACTIVE" }, { "RegionName": "us-east-1", "GlobalSecondaryIndexes": [], "ReplicaProvisionedReadCapacityAutoScalingSettings": { "MinimumUnits": 5, "MaximumUnits": 40000, "AutoScalingRoleArn": "arn:aws:iam::123456789012:role/aws-service-role/dynamodb.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_DynamoDBTable", "ScalingPolicies": [ { "PolicyName": "DynamoDBReadCapacityUtilization:table/MusicCollection", "TargetTrackingScalingPolicyConfiguration": { "TargetValue": 70.0 } } ] }, "ReplicaProvisionedWriteCapacityAutoScalingSettings": { "MinimumUnits": 10, "MaximumUnits": 100, "AutoScalingRoleArn": "arn:aws:iam::123456789012:role/aws-service-role/dynamodb.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_DynamoDBTable", "ScalingPolicies": [ { "PolicyName": "DynamoDBWriteCapacityUtilization:table/MusicCollection", "TargetTrackingScalingPolicyConfiguration": { "TargetValue": 80.0 } } ] }, "ReplicaStatus": "ACTIVE" }, { "RegionName": "us-east-2", "GlobalSecondaryIndexes": [], "ReplicaProvisionedReadCapacityAutoScalingSettings": { "MinimumUnits": 5, "MaximumUnits": 40000, "AutoScalingRoleArn": "arn:aws:iam::123456789012:role/aws-service-role/dynamodb.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_DynamoDBTable", "ScalingPolicies": [ { "PolicyName": "DynamoDBReadCapacityUtilization:table/MusicCollection", "TargetTrackingScalingPolicyConfiguration": { "TargetValue": 70.0 } } ] }, "ReplicaProvisionedWriteCapacityAutoScalingSettings": { "MinimumUnits": 10, "MaximumUnits": 100, "AutoScalingRoleArn": "arn:aws:iam::123456789012:role/aws-service-role/dynamodb.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_DynamoDBTable", "ScalingPolicies": [ { "PolicyName": "DynamoDBWriteCapacityUtilization:table/MusicCollection", "TargetTrackingScalingPolicyConfiguration": { "TargetValue": 80.0 } } ] }, "ReplicaStatus": "ACTIVE" } ] } } ``` Para obter mais informações, consulte [Tabelas do globais do DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [UpdateTableReplicaAutoScaling](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/update-table-replica-auto-scaling.html) na *Referência de comandos da AWS CLI*. ### `update-table` O código de exemplo a seguir mostra como usar `update-table`. **AWS CLI** **Exemplo 1: como modificar o modo de faturamento de uma tabela** O exemplo `update-table` a seguir aumenta a capacidade de leitura e gravação provisionada na tabela `MusicCollection`. ``` aws dynamodb update-table \ --table-name MusicCollection \ --billing-mode PROVISIONED \ --provisioned-throughput ReadCapacityUnits=15,WriteCapacityUnits=10 ``` Resultado: ``` { "TableDescription": { "AttributeDefinitions": [ { "AttributeName": "AlbumTitle", "AttributeType": "S" }, { "AttributeName": "Artist", "AttributeType": "S" }, { "AttributeName": "SongTitle", "AttributeType": "S" } ], "TableName": "MusicCollection", "KeySchema": [ { "AttributeName": "Artist", "KeyType": "HASH" }, { "AttributeName": "SongTitle", "KeyType": "RANGE" } ], "TableStatus": "UPDATING", "CreationDateTime": "2020-05-26T15:59:49.473000-07:00", "ProvisionedThroughput": { "LastIncreaseDateTime": "2020-07-28T13:18:18.921000-07:00", "NumberOfDecreasesToday": 0, "ReadCapacityUnits": 15, "WriteCapacityUnits": 10 }, "TableSizeBytes": 182, "ItemCount": 2, "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection", "TableId": "abcd0123-01ab-23cd-0123-abcdef123456", "BillingModeSummary": { "BillingMode": "PROVISIONED", "LastUpdateToPayPerRequestDateTime": "2020-07-28T13:14:48.366000-07:00" } } } ``` Para ter mais informações, consulte [Updating a Table](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.UpdateTable) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 2: como criar um índice secundário global** O exemplo a seguir adiciona um índice secundário global à tabela `MusicCollection`. ``` aws dynamodb update-table \ --table-name MusicCollection \ --attribute-definitions AttributeName=AlbumTitle,AttributeType=S \ --global-secondary-index-updates file://gsi-updates.json ``` Conteúdo de `gsi-updates.json`: ``` [ { "Create": { "IndexName": "AlbumTitle-index", "KeySchema": [ { "AttributeName": "AlbumTitle", "KeyType": "HASH" } ], "ProvisionedThroughput": { "ReadCapacityUnits": 10, "WriteCapacityUnits": 10 }, "Projection": { "ProjectionType": "ALL" } } } ] ``` Resultado: ``` { "TableDescription": { "AttributeDefinitions": [ { "AttributeName": "AlbumTitle", "AttributeType": "S" }, { "AttributeName": "Artist", "AttributeType": "S" }, { "AttributeName": "SongTitle", "AttributeType": "S" } ], "TableName": "MusicCollection", "KeySchema": [ { "AttributeName": "Artist", "KeyType": "HASH" }, { "AttributeName": "SongTitle", "KeyType": "RANGE" } ], "TableStatus": "UPDATING", "CreationDateTime": "2020-05-26T15:59:49.473000-07:00", "ProvisionedThroughput": { "LastIncreaseDateTime": "2020-07-28T12:59:17.537000-07:00", "NumberOfDecreasesToday": 0, "ReadCapacityUnits": 15, "WriteCapacityUnits": 10 }, "TableSizeBytes": 182, "ItemCount": 2, "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection", "TableId": "abcd0123-01ab-23cd-0123-abcdef123456", "BillingModeSummary": { "BillingMode": "PROVISIONED", "LastUpdateToPayPerRequestDateTime": "2020-07-28T13:14:48.366000-07:00" }, "GlobalSecondaryIndexes": [ { "IndexName": "AlbumTitle-index", "KeySchema": [ { "AttributeName": "AlbumTitle", "KeyType": "HASH" } ], "Projection": { "ProjectionType": "ALL" }, "IndexStatus": "CREATING", "Backfilling": false, "ProvisionedThroughput": { "NumberOfDecreasesToday": 0, "ReadCapacityUnits": 10, "WriteCapacityUnits": 10 }, "IndexSizeBytes": 0, "ItemCount": 0, "IndexArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/index/AlbumTitle-index" } ] } } ``` Para ter mais informações, consulte [Updating a Table](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.UpdateTable) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 3: como habilitar o DynamoDB Streams em uma tabela** O comando a seguir habilita o DynamoDB Streams na tabela `MusicCollection`. ``` aws dynamodb update-table \ --table-name MusicCollection \ --stream-specification StreamEnabled=true,StreamViewType=NEW_IMAGE ``` Resultado: ``` { "TableDescription": { "AttributeDefinitions": [ { "AttributeName": "AlbumTitle", "AttributeType": "S" }, { "AttributeName": "Artist", "AttributeType": "S" }, { "AttributeName": "SongTitle", "AttributeType": "S" } ], "TableName": "MusicCollection", "KeySchema": [ { "AttributeName": "Artist", "KeyType": "HASH" }, { "AttributeName": "SongTitle", "KeyType": "RANGE" } ], "TableStatus": "UPDATING", "CreationDateTime": "2020-05-26T15:59:49.473000-07:00", "ProvisionedThroughput": { "LastIncreaseDateTime": "2020-07-28T12:59:17.537000-07:00", "NumberOfDecreasesToday": 0, "ReadCapacityUnits": 15, "WriteCapacityUnits": 10 }, "TableSizeBytes": 182, "ItemCount": 2, "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection", "TableId": "abcd0123-01ab-23cd-0123-abcdef123456", "BillingModeSummary": { "BillingMode": "PROVISIONED", "LastUpdateToPayPerRequestDateTime": "2020-07-28T13:14:48.366000-07:00" }, "LocalSecondaryIndexes": [ { "IndexName": "AlbumTitleIndex", "KeySchema": [ { "AttributeName": "Artist", "KeyType": "HASH" }, { "AttributeName": "AlbumTitle", "KeyType": "RANGE" } ], "Projection": { "ProjectionType": "INCLUDE", "NonKeyAttributes": [ "Year", "Genre" ] }, "IndexSizeBytes": 139, "ItemCount": 2, "IndexArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/index/AlbumTitleIndex" } ], "GlobalSecondaryIndexes": [ { "IndexName": "AlbumTitle-index", "KeySchema": [ { "AttributeName": "AlbumTitle", "KeyType": "HASH" } ], "Projection": { "ProjectionType": "ALL" }, "IndexStatus": "ACTIVE", "ProvisionedThroughput": { "NumberOfDecreasesToday": 0, "ReadCapacityUnits": 10, "WriteCapacityUnits": 10 }, "IndexSizeBytes": 0, "ItemCount": 0, "IndexArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/index/AlbumTitle-index" } ], "StreamSpecification": { "StreamEnabled": true, "StreamViewType": "NEW_IMAGE" }, "LatestStreamLabel": "2020-07-28T21:53:39.112", "LatestStreamArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/stream/2020-07-28T21:53:39.112" } } ``` Para ter mais informações, consulte [Updating a Table](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.UpdateTable) no *Guia do desenvolvedor do Amazon DynamoDB*. **Exemplo 4: como habilitar a criptografia do lado do servidor** O exemplo a seguir habilita a criptografia do lado do servidor na tabela `MusicCollection`. ``` aws dynamodb update-table \ --table-name MusicCollection \ --sse-specification Enabled=true,SSEType=KMS ``` Resultado: ``` { "TableDescription": { "AttributeDefinitions": [ { "AttributeName": "AlbumTitle", "AttributeType": "S" }, { "AttributeName": "Artist", "AttributeType": "S" }, { "AttributeName": "SongTitle", "AttributeType": "S" } ], "TableName": "MusicCollection", "KeySchema": [ { "AttributeName": "Artist", "KeyType": "HASH" }, { "AttributeName": "SongTitle", "KeyType": "RANGE" } ], "TableStatus": "ACTIVE", "CreationDateTime": "2020-05-26T15:59:49.473000-07:00", "ProvisionedThroughput": { "LastIncreaseDateTime": "2020-07-28T12:59:17.537000-07:00", "NumberOfDecreasesToday": 0, "ReadCapacityUnits": 15, "WriteCapacityUnits": 10 }, "TableSizeBytes": 182, "ItemCount": 2, "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection", "TableId": "abcd0123-01ab-23cd-0123-abcdef123456", "BillingModeSummary": { "BillingMode": "PROVISIONED", "LastUpdateToPayPerRequestDateTime": "2020-07-28T13:14:48.366000-07:00" }, "LocalSecondaryIndexes": [ { "IndexName": "AlbumTitleIndex", "KeySchema": [ { "AttributeName": "Artist", "KeyType": "HASH" }, { "AttributeName": "AlbumTitle", "KeyType": "RANGE" } ], "Projection": { "ProjectionType": "INCLUDE", "NonKeyAttributes": [ "Year", "Genre" ] }, "IndexSizeBytes": 139, "ItemCount": 2, "IndexArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/index/AlbumTitleIndex" } ], "GlobalSecondaryIndexes": [ { "IndexName": "AlbumTitle-index", "KeySchema": [ { "AttributeName": "AlbumTitle", "KeyType": "HASH" } ], "Projection": { "ProjectionType": "ALL" }, "IndexStatus": "ACTIVE", "ProvisionedThroughput": { "NumberOfDecreasesToday": 0, "ReadCapacityUnits": 10, "WriteCapacityUnits": 10 }, "IndexSizeBytes": 0, "ItemCount": 0, "IndexArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/index/AlbumTitle-index" } ], "StreamSpecification": { "StreamEnabled": true, "StreamViewType": "NEW_IMAGE" }, "LatestStreamLabel": "2020-07-28T21:53:39.112", "LatestStreamArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/stream/2020-07-28T21:53:39.112", "SSEDescription": { "Status": "UPDATING" } } } ``` Para ter mais informações, consulte [Updating a Table](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.UpdateTable) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ter detalhes da API, consulte [UpdateTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/update-table.html) na *Referência de comandos da AWS CLI*. ### `update-time-to-live` O código de exemplo a seguir mostra como usar `update-time-to-live`. **AWS CLI** **Como atualizar as configurações de vida útil de uma tabela** O exemplo `update-time-to-live` a seguir habilita a vida útil na tabela especificada. ``` aws dynamodb update-time-to-live \ --table-name MusicCollection \ --time-to-live-specification Enabled=true,AttributeName=ttl ``` Resultado: ``` { "TimeToLiveSpecification": { "Enabled": true, "AttributeName": "ttl" } } ``` Para obter mais informações, consulte [Vida útil](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Consulte detalhes da API em [UpdateTimeToLive](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/update-time-to-live.html) na *Referência de comandos da AWS CLI*. # Exemplos do DynamoDB Streams usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o DynamoDB Streams. *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 ### `describe-stream` O código de exemplo a seguir mostra como usar `describe-stream`. **AWS CLI** **Para obter informações sobre um fluxo do DynamoDB** O comando `describe-stream` a seguir exibe informações sobre o fluxo do DynamoDB específico. ``` aws dynamodbstreams describe-stream \ --stream-arn arn:aws:dynamodb:us-west-1:123456789012:table/Music/stream/2019-10-22T18:02:01.576 ``` Resultado: ``` { "StreamDescription": { "StreamArn": "arn:aws:dynamodb:us-west-1:123456789012:table/Music/stream/2019-10-22T18:02:01.576", "StreamLabel": "2019-10-22T18:02:01.576", "StreamStatus": "ENABLED", "StreamViewType": "NEW_AND_OLD_IMAGES", "CreationRequestDateTime": 1571767321.571, "TableName": "Music", "KeySchema": [ { "AttributeName": "Artist", "KeyType": "HASH" }, { "AttributeName": "SongTitle", "KeyType": "RANGE" } ], "Shards": [ { "ShardId": "shardId-00000001571767321804-697ce3d2", "SequenceNumberRange": { "StartingSequenceNumber": "4000000000000642977831", "EndingSequenceNumber": "4000000000000642977831" } }, { "ShardId": "shardId-00000001571780995058-40810d86", "SequenceNumberRange": { "StartingSequenceNumber": "757400000000005655171150" }, "ParentShardId": "shardId-00000001571767321804-697ce3d2" } ] } } ``` Para obter mais informações, consulte [Capturar atividades de tabela com o DynamoDB Streams](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Consulte detalhes da API em [DescribeStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodbstreams/describe-stream.html) na *Referência de comandos da AWS CLI*. ### `get-records` O código de exemplo a seguir mostra como usar `get-records`. **AWS CLI** **Para obter registros de um fluxo do Dynamodb** O comando `get-records` a seguir recupera registros usando o iterador de fragmento especificado do Amazon DynamoDB. ``` aws dynamodbstreams get-records \ --shard-iterator "arn:aws:dynamodb:us-west-1:123456789012:table/Music/stream/2019-10-22T18:02:01.576|1|AAAAAAAAAAGgM3YZ89vLZZxjmoQeo33r9M4x3+zmmTLsiL86MfrF4+B4EbsByi52InVmiONmy6xVW4IRcIIbs1zO7MNIlqZfx8WQzMwVDyINtGG2hCLg78JKbYxFasXeePGlApTyf3rJxR765uyOVaBvBHAJuwF2TXIuxhaAlOupNGHr52qAC3a49ZOmf+CjNPlqQjnyRSAnfOwWmKhL1/KNParWSfz2odf780oOObIDIWRRMkt7+Hyzh9SD+hFxFAWR5C7QIlOXPc8mRBfNIazfrVCjJK8/jsjCzsqNyXKzJbhh+GXCoxYN+Kpmg4nyj1EAsYhbGL35muvHFoHjcyuynbsczbWaXNfThDwRAyvoTmc8XhHKtAWUbJiaVd8ZPtQwDsThCrmDRPIdmTRGWllGfUr5ezN5LscvkQezzgpaU5p8BgCqRzjv5Vl8LB6wHgQWNG+w/lEGS05ha1qNP+Vl4+tuhz2TRnhnJo/pny9GI/yGpce97mWvSPr5KPwy+Dtcm5BHayBs+PVYHITaTliInFlT+LCwvaz1QH3MY3b8A05Z800wjpktm60iQqtMeDwN4NX6FrcxR34JoFKGsgR8XkHVJzz2xr1xqSJ12ycpNTyHnndusw==" ``` Resultado: ``` { "Records": [ { "eventID": "c3b5d798eef6215d42f8137b19a88e50", "eventName": "INSERT", "eventVersion": "1.1", "eventSource": "aws:dynamodb", "awsRegion": "us-west-1", "dynamodb": { "ApproximateCreationDateTime": 1571849028.0, "Keys": { "Artist": { "S": "No One You Know" }, "SongTitle": { "S": "Call Me Today" } }, "NewImage": { "AlbumTitle": { "S": "Somewhat Famous" }, "Artist": { "S": "No One You Know" }, "Awards": { "N": "1" }, "SongTitle": { "S": "Call Me Today" } }, "SequenceNumber": "700000000013256296913", "SizeBytes": 119, "StreamViewType": "NEW_AND_OLD_IMAGES" } }, { "eventID": "878960a6967867e2da16b27380a27328", "eventName": "INSERT", "eventVersion": "1.1", "eventSource": "aws:dynamodb", "awsRegion": "us-west-1", "dynamodb": { "ApproximateCreationDateTime": 1571849029.0, "Keys": { "Artist": { "S": "Acme Band" }, "SongTitle": { "S": "Happy Day" } }, "NewImage": { "AlbumTitle": { "S": "Songs About Life" }, "Artist": { "S": "Acme Band" }, "Awards": { "N": "10" }, "SongTitle": { "S": "Happy Day" } }, "SequenceNumber": "800000000013256297217", "SizeBytes": 100, "StreamViewType": "NEW_AND_OLD_IMAGES" } }, { "eventID": "520fabde080e159fc3710b15ee1d4daa", "eventName": "MODIFY", "eventVersion": "1.1", "eventSource": "aws:dynamodb", "awsRegion": "us-west-1", "dynamodb": { "ApproximateCreationDateTime": 1571849734.0, "Keys": { "Artist": { "S": "Acme Band" }, "SongTitle": { "S": "Happy Day" } }, "NewImage": { "AlbumTitle": { "S": "Updated Album Title" }, "Artist": { "S": "Acme Band" }, "Awards": { "N": "10" }, "SongTitle": { "S": "Happy Day" } }, "OldImage": { "AlbumTitle": { "S": "Songs About Life" }, "Artist": { "S": "Acme Band" }, "Awards": { "N": "10" }, "SongTitle": { "S": "Happy Day" } }, "SequenceNumber": "900000000013256687845", "SizeBytes": 170, "StreamViewType": "NEW_AND_OLD_IMAGES" } } ], "NextShardIterator": "arn:aws:dynamodb:us-west-1:123456789012:table/Music/stream/2019-10-23T16:41:08.740|1|AAAAAAAAAAEhEI04jkFLW+LKOwivjT8d/IHEh3iExV2xK00aTxEzVy1C1C7Kbb5+ZOW6bT9VQ2n1/mrs7+PRiaOZCHJu7JHJVW7zlsqOi/ges3fw8GYEymyL+piEk35cx67rQqwKKyq+Q6w9JyjreIOj4F2lWLV26lBwRTrIYC4IB7C3BZZK4715QwYdDxNdVHiSBRZX8UqoS6WOt0F87xZLNB9F/NhYBLXi/wcGvAcBcC0TNIOH+N0NqwtoB/FGCkNrf8YZ0xRoNN6RgGuVWHF3pxOhxEJeFZoSoJTIKeG9YcYxzi5Ci/mhdtm7tBXnbw5c6xmsGsBqTirNjlDyJLcWl8Cl0UOLX63Ufo/5QliztcjEbKsQe28x8LM8o7VH1Is0fF/ITt8awSA4igyJS0P87GN8Qri8kj8iaE35805jBHWF2wvwT6Iy2xGrR2r2HzYps9dwGOarVdEITaJfWzNoL4HajMhmREZLYfM7Pb0PvRMO7JkENyPIU6e2w16W1CvJO2EGFIxtNk+V04i1YIeHMXJfcwetNRuIbdQXfJht2NQZa4PVV6iknY6d19MrdbSTMKoqAuvp6g3Q2jH4t7GKCLWgodcPAn8g5+43DaNkh4Z5zKOfNw==" } ``` Para obter mais informações, consulte [Capturar atividades de tabela com o DynamoDB Streams](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [GetRecords](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodbstreams/get-records.html) na *Referência de comandos da AWS CLI*. ### `get-shard-iterator` O código de exemplo a seguir mostra como usar `get-shard-iterator`. **AWS CLI** **Para obter um iterador de fragmentos** O comando `get-shard-iterator` a seguir recupera um iterador de fragmentos para o fragmento especificado. ``` aws dynamodbstreams get-shard-iterator \ --stream-arn arn:aws:dynamodb:us-west-1:12356789012:table/Music/stream/2019-10-22T18:02:01.576 \ --shard-id shardId-00000001571780995058-40810d86 \ --shard-iterator-type LATEST ``` Resultado: ``` { "ShardIterator": "arn:aws:dynamodb:us-west-1:123456789012:table/Music/stream/2019-10-22T18:02:01.576|1|AAAAAAAAAAGgM3YZ89vLZZxjmoQeo33r9M4x3+zmmTLsiL86MfrF4+B4EbsByi52InVmiONmy6xVW4IRcIIbs1zO7MNIlqZfx8WQzMwVDyINtGG2hCLg78JKbYxFasXeePGlApTyf3rJxR765uyOVaBvBHAJuwF2TXIuxhaAlOupNGHr52qAC3a49ZOmf+CjNPlqQjnyRSAnfOwWmKhL1/KNParWSfz2odf780oOObIDIWRRMkt7+Hyzh9SD+hFxFAWR5C7QIlOXPc8mRBfNIazfrVCjJK8/jsjCzsqNyXKzJbhh+GXCoxYN+Kpmg4nyj1EAsYhbGL35muvHFoHjcyuynbsczbWaXNfThDwRAyvoTmc8XhHKtAWUbJiaVd8ZPtQwDsThCrmDRPIdmTRGWllGfUr5ezN5LscvkQezzgpaU5p8BgCqRzjv5Vl8LB6wHgQWNG+w/lEGS05ha1qNP+Vl4+tuhz2TRnhnJo/pny9GI/yGpce97mWvSPr5KPwy+Dtcm5BHayBs+PVYHITaTliInFlT+LCwvaz1QH3MY3b8A05Z800wjpktm60iQqtMeDwN4NX6FrcxR34JoFKGsgR8XkHVJzz2xr1xqSJ12ycpNTyHnndusw==" } ``` Para obter mais informações, consulte [Capturar atividades de tabela com o DynamoDB Streams](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Para ver detalhes da API, consulte [GetShardIterator](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodbstreams/get-shard-iterator.html) na *Referência de comandos da AWS CLI*. ### `list-streams` O código de exemplo a seguir mostra como usar `list-streams`. **AWS CLI** **Para listar fluxos do DynamoDB** O comando `list-streams` a seguir lista todos os fluxos existentes do Amazon DynamoDB dentro da região da AWS padrão. ``` aws dynamodbstreams list-streams ``` Resultado: ``` { "Streams": [ { "StreamArn": "arn:aws:dynamodb:us-west-1:123456789012:table/Music/stream/2019-10-22T18:02:01.576", "TableName": "Music", "StreamLabel": "2019-10-22T18:02:01.576" } ] } ``` Para obter mais informações, consulte [Capturar atividades de tabela com o DynamoDB Streams](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html) no *Guia do desenvolvedor do Amazon DynamoDB*. + Consulte detalhes da API em [ListStreams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodbstreams/list-streams.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon EC2 usando o AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o 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 ### `accept-address-transfer` O código de exemplo a seguir mostra como usar `accept-address-transfer`. **AWS CLI** **Aceitar um endereço IP elástico transferido para sua conta** O exemplo `accept-address-transfer` a seguir aceita a transferência do endereço IP elástico especificado para sua conta. ``` aws ec2 accept-address-transfer \ --address 100.21.184.216 ``` Resultado: ``` { "AddressTransfer": { "PublicIp": "100.21.184.216", "AllocationId": "eipalloc-09ad461b0d03f6aaf", "TransferAccountId": "123456789012", "TransferOfferExpirationTimestamp": "2023-02-22T20:51:10.000Z", "TransferOfferAcceptedTimestamp": "2023-02-22T22:52:54.000Z", "AddressTransferStatus": "accepted" } } ``` Para obter mais informações, consulte [Transferir endereços IP elásticos](https://docs.aws.amazon.com/vpc/latest/userguide/WorkWithEIPs.html#transfer-EIPs-intro) no *Guia do usuário do Amazon VPC*. + Para ver detalhes da API, consulte [AcceptAddressTransfer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/accept-address-transfer.html) na *Referência de comandos da AWS CLI*. ### `accept-reserved-instances-exchange-quote` O código de exemplo a seguir mostra como usar `accept-reserved-instances-exchange-quote`. **AWS CLI** **Para realizar uma troca de Instância Reservada Conversível** Este exemplo realiza uma troca das Instâncias Reservadas Conversíveis especificadas. Comando: ``` aws ec2 accept-reserved-instances-exchange-quote --reserved-instance-ids 7b8750c3-397e-4da4-bbcb-a45ebexample --target-configurations OfferingId=b747b472-423c-48f3-8cee-679bcexample ``` Resultado: ``` { "ExchangeId": "riex-e68ed3c1-8bc8-4c17-af77-811afexample" } ``` + Para ver detalhes da API, consulte [AcceptReservedInstancesExchangeQuote](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/accept-reserved-instances-exchange-quote.html) na *Referência de comandos da AWS CLI*. ### `accept-transit-gateway-peering-attachment` O código de exemplo a seguir mostra como usar `accept-transit-gateway-peering-attachment`. **AWS CLI** **Aceitar um anexo de emparelhamento do gateway de trânsito** O exemplo `accept-transit-gateway-peering-attachment` a seguia aceite o anexo de emparelhamento do gateway de trânsito especificado. O parâmetro `--region` especifica a região na qual o gateway de trânsito do aceitante está localizado. ``` aws ec2 accept-transit-gateway-peering-attachment \ --transit-gateway-attachment-id tgw-attach-4455667788aabbccd \ --region us-east-2 ``` Resultado: ``` { "TransitGatewayPeeringAttachment": { "TransitGatewayAttachmentId": "tgw-attach-4455667788aabbccd", "RequesterTgwInfo": { "TransitGatewayId": "tgw-123abc05e04123abc", "OwnerId": "123456789012", "Region": "us-west-2" }, "AccepterTgwInfo": { "TransitGatewayId": "tgw-11223344aabbcc112", "OwnerId": "123456789012", "Region": "us-east-2" }, "State": "pending", "CreationTime": "2019-12-09T11:38:31.000Z" } } ``` Para obter mais informações, consulte [Anexos de pareamento do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-peering.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [AcceptTransitGatewayPeeringAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/accept-transit-gateway-peering-attachment.html) na *Referência de comandos da AWS CLI*. ### `accept-transit-gateway-vpc-attachment` O código de exemplo a seguir mostra como usar `accept-transit-gateway-vpc-attachment`. **AWS CLI** **Aceitar uma solicitação para anexar uma VPC a um gateway de trânsito.** O exemplo `accept-transit-gateway-vpc-attachment` a seguir aceita a solicitação para um anexo especificado. ``` aws ec2 accept-transit-gateway-vpc-attachment \ --transit-gateway-attachment-id tgw-attach-0a34fe6b4fEXAMPLE ``` Resultado: ``` { "TransitGatewayVpcAttachment": { "TransitGatewayAttachmentId": "tgw-attach-0a34fe6b4fEXAMPLE", "TransitGatewayId": "tgw-0262a0e521EXAMPLE", "VpcId": "vpc-07e8ffd50fEXAMPLE", "VpcOwnerId": "123456789012", "State": "pending", "SubnetIds": [ "subnet-0752213d59EXAMPLE" ], "CreationTime": "2019-07-10T17:33:46.000Z", "Options": { "DnsSupport": "enable", "Ipv6Support": "disable" } } } ``` Para obter mais informações, consulte [Anexos do gateway de trânsito para uma VPC](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-vpc-attachments.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [AcceptTransitGatewayVpcAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/accept-transit-gateway-vpc-attachment.html) na *Referência de comandos da AWS CLI*. ### `accept-vpc-endpoint-connections` O código de exemplo a seguir mostra como usar `accept-vpc-endpoint-connections`. **AWS CLI** **Aceitar uma solicitação de conexão de interface de endpoint** Este exemplo aceita a solicitação de conexão de endpoint especificada para o serviço de endpoint especificado. Comando: ``` aws ec2 accept-vpc-endpoint-connections --service-id vpce-svc-03d5ebb7d9579a2b3 --vpc-endpoint-ids vpce-0c1308d7312217abc ``` Resultado: ``` { "Unsuccessful": [] } ``` + Para ver detalhes da API, consulte [AcceptVpcEndpointConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/accept-vpc-endpoint-connections.html) na *Referência de comandos da AWS CLI*. ### `accept-vpc-peering-connection` O código de exemplo a seguir mostra como usar `accept-vpc-peering-connection`. **AWS CLI** **Aceitar uma conexão de emparelhamento da VPC** Este exemplo aceita a solicitação de conexão de emparelhamento da VPC especificada. Comando: ``` aws ec2 accept-vpc-peering-connection --vpc-peering-connection-id pcx-1a2b3c4d ``` Resultado: ``` { "VpcPeeringConnection": { "Status": { "Message": "Provisioning", "Code": "provisioning" }, "Tags": [], "AccepterVpcInfo": { "OwnerId": "444455556666", "VpcId": "vpc-44455566", "CidrBlock": "10.0.1.0/28" }, "VpcPeeringConnectionId": "pcx-1a2b3c4d", "RequesterVpcInfo": { "OwnerId": "444455556666", "VpcId": "vpc-111abc45", "CidrBlock": "10.0.0.0/28" } } } ``` + Para ver detalhes da API, consulte [AcceptVpcPeeringConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/accept-vpc-peering-connection.html) na *Referência de comandos da AWS CLI*. ### `advertise-byoip-cidr` O código de exemplo a seguir mostra como usar `advertise-byoip-cidr`. **AWS CLI** **Anunciar um intervalo de endereços** O exemplo `advertise-byoip-cidr` a seguir anuncia o intervalo de endereços IPv4 público especificado. ``` aws ec2 advertise-byoip-cidr \ --cidr 203.0.113.25/24 ``` Resultado: ``` { "ByoipCidr": { "Cidr": "203.0.113.25/24", "StatusMessage": "ipv4pool-ec2-1234567890abcdef0", "State": "provisioned" } } ``` + Para ver detalhes da API, consulte [AdvertiseByoipCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/advertise-byoip-cidr.html) na *Referência de comandos da AWS CLI*. ### `allocate-address` O código de exemplo a seguir mostra como usar `allocate-address`. **AWS CLI** **Exemplo 1: alocar um endereço IP elástico do conjunto de endereços da Amazon** O exemplo `allocate-address` a seguir aloca um endereço IP elástico. O Amazon EC2 seleciona o endereço do conjunto de endereços da Amazon. ``` aws ec2 allocate-address ``` Resultado: ``` { "PublicIp": "70.224.234.241", "AllocationId": "eipalloc-01435ba59eEXAMPLE", "PublicIpv4Pool": "amazon", "NetworkBorderGroup": "us-west-2", "Domain": "vpc" } ``` Para obter mais informações, consulte [Endereços IP elásticos](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) no *Guia do usuário do Amazon EC2*. **Exemplo 2: alocar um endereço IP elástico e associá-lo a um grupo de borda de rede** O exemplo `allocate-address` a seguir aloca um endereço IP elástico e o associa ao grupo de borda de rede especificado. ``` aws ec2 allocate-address \ --network-border-group us-west-2-lax-1 ``` Resultado: ``` { "PublicIp": "70.224.234.241", "AllocationId": "eipalloc-e03dd489ceEXAMPLE", "PublicIpv4Pool": "amazon", "NetworkBorderGroup": "us-west-2-lax-1", "Domain": "vpc" } ``` Para obter mais informações, consulte [Endereços IP elásticos](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) no *Guia do usuário do Amazon EC2*. **Exemplo 3: alocar um endereço IP elástico de um conjunto de endereços de sua propriedade** O exemplo `allocate-address` a seguir aloca um endereço IP elástico de um conjunto de endereços que você trouxe para a conta da Amazon Web Services. O Amazon EC2 seleciona o endereço do conjunto de endereços. ``` aws ec2 allocate-address \ --public-ipv4-pool ipv4pool-ec2-1234567890abcdef0 ``` Resultado: ``` { "AllocationId": "eipalloc-02463d08ceEXAMPLE", "NetworkBorderGroup": "us-west-2", "CustomerOwnedIp": "18.218.95.81", "CustomerOwnedIpv4Pool": "ipv4pool-ec2-1234567890abcdef0", "Domain": "vpc" "NetworkBorderGroup": "us-west-2", } ``` Para obter mais informações, consulte [Endereços IP elásticos](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) no *Guia do usuário do Amazon EC2*. **Exemplo 4: alocar um endereço IP elástico de um grupo de IPAM** O exemplo de `allocate-address` a seguir aloca um endereço IP elástico /32 específico de um grupo do Gerenciador de endereços IP (IPAM) da Amazon VPC. ``` aws ec2 allocate-address \ --region us-east-1 \ --ipam-pool-id ipam-pool-1234567890abcdef0 \ --address 192.0.2.0 ``` Resultado: ``` { "PublicIp": "192.0.2.0", "AllocationId": "eipalloc-abcdef01234567890", "PublicIpv4Pool": "ipam-pool-1234567890abcdef0", "NetworkBorderGroup": "us-east-1", "Domain": "vpc" } ``` Para obter mais informações, consulte [Allocate sequential Elastic IP addresses from an IPAM pool](https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-eip-pool.html) no *Guia do usuário do IPAM da Amazon VPC*. + Consulte detalhes da API em [AllocateAddress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/allocate-address.html) na *Referência de comandos da AWS CLI*. ### `allocate-hosts` O código de exemplo a seguir mostra como usar `allocate-hosts`. **AWS CLI** **Exemplo 1: alocar um Host Dedicado** O exemplo `allocate-hosts` a seguir aloca um único Host Dedicado na Zona de Disponibilidade `eu-west-1a`, no qual você pode executar instâncias `m5.large`. Por padrão, o Host Dedicado aceita somente a execução da instância de destino e não oferece suporte à recuperação do host. ``` aws ec2 allocate-hosts \ --instance-type m5.large \ --availability-zone eu-west-1a \ --quantity 1 ``` Resultado: ``` { "HostIds": [ "h-07879acf49EXAMPLE" ] } ``` **Exemplo 2: alocar um Host Dedicado com posicionamento automático e recuperação de host ativados** O exemplo `allocate-hosts` a seguir aloca um único Host Dedicado na Zona de Disponibilidade `eu-west-1a` com posicionamento automático e recuperação de host ativados. ``` aws ec2 allocate-hosts \ --instance-type m5.large \ --availability-zone eu-west-1a \ --auto-placement on \ --host-recovery on \ --quantity 1 ``` Resultado: ``` { "HostIds": [ "h-07879acf49EXAMPLE" ] } ``` **Exemplo 3: alocar um Host Dedicado com tags** O exemplo `allocate-hosts` a seguir aloca um único Host Dedicado e aplica uma tag com uma chave chamada `purpose` e um valor de `production`. ``` aws ec2 allocate-hosts \ --instance-type m5.large \ --availability-zone eu-west-1a \ --quantity 1 \ --tag-specifications 'ResourceType=dedicated-host,Tags={Key=purpose,Value=production}' ``` Resultado: ``` { "HostIds": [ "h-07879acf49EXAMPLE" ] } ``` Para obter mais informações, consulte [Alocar um host dedicado](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-allocating.html) no *Manual do Usuário do Amazon EC2*. + Para ver detalhes da API, consulte [AllocateHosts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/allocate-hosts.html) na *Referência de comandos da AWS CLI*. ### `allocate-ipam-pool-cidr` O código de exemplo a seguir mostra como usar `allocate-ipam-pool-cidr`. **AWS CLI** **Alocar um CIDR de um pool IPAM** O exemplo `allocate-ipam-pool-cidr` a seguir aloca um CIDR de um pool do IPAM. (Linux): ``` aws ec2 allocate-ipam-pool-cidr \ --ipam-pool-id ipam-pool-0533048da7d823723 \ --netmask-length 24 ``` (Windows): ``` aws ec2 allocate-ipam-pool-cidr ^ --ipam-pool-id ipam-pool-0533048da7d823723 ^ --netmask-length 24 ``` Resultado: ``` { "IpamPoolAllocation": { "Cidr": "10.0.0.0/24", "IpamPoolAllocationId": "ipam-pool-alloc-018ecc28043b54ba38e2cd99943cebfbd", "ResourceType": "custom", "ResourceOwner": "123456789012" } } ``` Para obter mais informações, consulte [Alocar manualmente um CIDR a um pool para reservar espaço de endereço IP](https://docs.aws.amazon.com/vpc/latest/ipam/manually-allocate-ipam.html) no *Guia do usuário IPAM da Amazon VPC*. + Para ver detalhes da API, consulte [AllocateIpamPoolCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/allocate-ipam-pool-cidr.html) na *Referência de comandos da AWS CLI*. ### `apply-security-groups-to-client-vpn-target-network` O código de exemplo a seguir mostra como usar `apply-security-groups-to-client-vpn-target-network`. **AWS CLI** **Aplicar grupos de segurança a uma rede de destino para um endpoint de Cliente VPN** O exemplo `apply-security-groups-to-client-vpn-target-network` a seguir aplica um grupo de segurança `sg-01f6e627a89f4db32` à associação entre a rede de destino e o endpoint do Cliente VPN. ``` aws ec2 apply-security-groups-to-client-vpn-target-network \ --security-group-ids sg-01f6e627a89f4db32 \ --vpc-id vpc-0e2110c2f324332e0 \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde ``` Resultado: ``` { "SecurityGroupIds": [ "sg-01f6e627a89f4db32" ] } ``` Para obter mais informações, consulte [Redes de destino](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-target.html) no *Guia do administrador da AWS*. + Para ver detalhes da API, consulte [ApplySecurityGroupsToClientVpnTargetNetwork](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/apply-security-groups-to-client-vpn-target-network.html) na *Referência de comandos da AWS CLI*. ### `assign-ipv6-addresses` O código de exemplo a seguir mostra como usar `assign-ipv6-addresses`. **AWS CLI** **Atribuir vários endereços IPv6 a uma interface de rede** Este exemplo atribui os endereços IPv6 especificados à interface de rede especificada. Comando: ``` aws ec2 assign-ipv6-addresses --network-interface-id eni-38664473 --ipv6-addresses 2001:db8:1234:1a00:3304:8879:34cf:4071 2001:db8:1234:1a00:9691:9503:25ad:1761 ``` Resultado: ``` { "AssignedIpv6Addresses": [ "2001:db8:1234:1a00:3304:8879:34cf:4071", "2001:db8:1234:1a00:9691:9503:25ad:1761" ], "NetworkInterfaceId": "eni-38664473" } ``` **Atribuir endereços IPv6 que a Amazon seleciona a uma interface de rede** Este exemplo atribui dois endereços IPv6 especificados à interface de rede especificada. A Amazon atribui automaticamente esses endereços IPv6 a partir dos endereços IPv6 disponíveis na faixa do bloco CIDR IPv6 da sub-rede. Comando: ``` aws ec2 assign-ipv6-addresses --network-interface-id eni-38664473 --ipv6-address-count 2 ``` Resultado: ``` { "AssignedIpv6Addresses": [ "2001:db8:1234:1a00:3304:8879:34cf:4071", "2001:db8:1234:1a00:9691:9503:25ad:1761" ], "NetworkInterfaceId": "eni-38664473" } ``` + Para ver detalhes da API, consulte [AssignIpv6Addresses](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/assign-ipv6-addresses.html) na *Referência de comandos da AWS CLI*. ### `assign-private-ip-addresses` O código de exemplo a seguir mostra como usar `assign-private-ip-addresses`. **AWS CLI** **Atribuir um endereço IP privado secundário a uma interface de rede** Este exemplo atribui os endereços IP privados secundários especificados à interface de rede especificada. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 assign-private-ip-addresses --network-interface-id eni-e5aa89a3 --private-ip-addresses 10.0.0.82 ``` **Atribuir endereços IP privados secundários que o Amazon EC2 seleciona a uma interface de rede** Este exemplo atribui dois endereços IP privados secundários à interface de rede especificada. O Amazon EC2 atribui automaticamente esses endereços IP a partir dos endereços IP disponíveis no intervalo de blocos CIDR da sub-rede à qual a interface de rede está associada. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 assign-private-ip-addresses --network-interface-id eni-e5aa89a3 --secondary-private-ip-address-count 2 ``` + Para ver detalhes da API, consulte [AssignPrivateIpAddresses](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/assign-private-ip-addresses.html) na *Referência de comandos da AWS CLI*. ### `assign-private-nat-gateway-address` O código de exemplo a seguir mostra como usar `assign-private-nat-gateway-address`. **AWS CLI** **Atribuir endereços IP privados ao seu gateway NAT privado** O exemplo `assign-private-nat-gateway-address` a seguir atribui dois endereços IP privados ao gateway NAT privado especificado. ``` aws ec2 assign-private-nat-gateway-address \ --nat-gateway-id nat-1234567890abcdef0 \ --private-ip-address-count 2 ``` Resultado: ``` { "NatGatewayId": "nat-1234567890abcdef0", "NatGatewayAddresses": [ { "NetworkInterfaceId": "eni-0065a61b324d1897a", "IsPrimary": false, "Status": "assigning" }, { "NetworkInterfaceId": "eni-0065a61b324d1897a", "IsPrimary": false, "Status": "assigning" } ] } ``` Para obter mais informações, consulte [Gateways NAT](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) no *Guia do usuário da Amazon VPC*. + Para ver detalhes da API, consulte [AssignPrivateNatGatewayAddress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/assign-private-nat-gateway-address.html) na *Referência de comandos da AWS CLI*. ### `associate-address` O código de exemplo a seguir mostra como usar `associate-address`. **AWS CLI** **Exemplo 1: associar um endereço IP elástico a uma instância** O exemplo de `associate-address` a seguir associa um endereço IP elástico à instância do EC2 especificada. ``` aws ec2 associate-address \ --instance-id i-0b263919b6498b123 \ --allocation-id eipalloc-64d5890a ``` Resultado: ``` { "AssociationId": "eipassoc-2bebb745" } ``` **Exemplo 2: associar um endereço IP elástico a uma interface de rede** O exemplo de `associate-address` a seguir associa o endereço IP elástico especificado à interface de rede determinada. ``` aws ec2 associate-address --allocation-id eipalloc-64d5890a \ --network-interface-id eni-1a2b3c4d ``` Resultado: ``` { "AssociationId": "eipassoc-2bebb745" } ``` **Exemplo 3: associar um endereço IP elástico a um endereço IP privado** O exemplo de `associate-address` a seguir associa o endereço IP elástico especificado ao endereço IP privado determinado na interface de rede indicada. ``` aws ec2 associate-address \ --allocation-id eipalloc-64d5890a \ --network-interface-id eni-1a2b3c4d \ --private-ip-address 10.0.0.85 ``` Resultado: ``` { "AssociationId": "eipassoc-2bebb745" } ``` Para obter mais informações, consulte [Endereços IP elásticos](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) no *Guia do usuário do Amazon EC2*. + Consulte detalhes da API em [AssociateAddress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-address.html) na *Referência de comandos da AWS CLI*. ### `associate-client-vpn-target-network` O código de exemplo a seguir mostra como usar `associate-client-vpn-target-network`. **AWS CLI** **Associar uma rede de destino a um endpoint do Cliente VPN** O exemplo `associate-client-vpn-target-network` a seguir associa uma sub-rede a um endpoint especificado do Cliente VPN. ``` aws ec2 associate-client-vpn-target-network \ --subnet-id subnet-0123456789abcabca \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde ``` Resultado: ``` { "AssociationId": "cvpn-assoc-12312312312312312", "Status": { "Code": "associating" } } ``` Para obter mais informações, consulte [Redes de destino](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-target.html) no *Guia do administrador da AWS*. + Para ver detalhes da API, consulte [AssociateClientVpnTargetNetwork](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-client-vpn-target-network.html) na *Referência de comandos da AWS CLI*. ### `associate-dhcp-options` O código de exemplo a seguir mostra como usar `associate-dhcp-options`. **AWS CLI** **Associar um conjunto de opções DHCP a uma VPC** Este exemplo associa o conjunto de opções de DHCP especificado à VPC especificada. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 associate-dhcp-options --dhcp-options-id dopt-d9070ebb --vpc-id vpc-a01106c2 ``` **Associar o conjunto de opções DHCP padrão associado a uma VPC** Este exemplo associa o conjunto padrão de opções de DHCP à VPC especificada. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 associate-dhcp-options --dhcp-options-id default --vpc-id vpc-a01106c2 ``` + Para ver detalhes da API, consulte [AssociateDhcpOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-dhcp-options.html) na *Referência de comandos da AWS CLI*. ### `associate-iam-instance-profile` O código de exemplo a seguir mostra como usar `associate-iam-instance-profile`. **AWS CLI** **Associar um perfil de instância do IAM a uma instância** Este exemplo associa um perfil de instância do IAM chamado `admin-role` à instância `i-123456789abcde123`. Comando: ``` aws ec2 associate-iam-instance-profile --instance-id i-123456789abcde123 --iam-instance-profile Name=admin-role ``` Resultado: ``` { "IamInstanceProfileAssociation": { "InstanceId": "i-123456789abcde123", "State": "associating", "AssociationId": "iip-assoc-0e7736511a163c209", "IamInstanceProfile": { "Id": "AIPAJBLK7RKJKWDXVHIEC", "Arn": "arn:aws:iam::123456789012:instance-profile/admin-role" } } } ``` + Para ver detalhes da API, consulte [AssociateIamInstanceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-iam-instance-profile.html) na *Referência de comandos da AWS CLI*. ### `associate-instance-event-window` O código de exemplo a seguir mostra como usar `associate-instance-event-window`. **AWS CLI** **Exemplo 1: associar uma ou mais instâncias a uma janela de eventos** O exemplo `associate-instance-event-window` a seguir associa uma ou mais instâncias a uma janela de eventos. ``` aws ec2 associate-instance-event-window \ --region us-east-1 \ --instance-event-window-id iew-0abcdef1234567890 \ --association-target "InstanceIds=i-1234567890abcdef0,i-0598c7d356eba48d7" ``` Resultado: ``` { "InstanceEventWindow": { "InstanceEventWindowId": "iew-0abcdef1234567890", "Name": "myEventWindowName", "CronExpression": "* 21-23 * * 2,3", "AssociationTarget": { "InstanceIds": [ "i-1234567890abcdef0", "i-0598c7d356eba48d7" ], "Tags": [], "DedicatedHostIds": [] }, "State": "creating" } } ``` Para restrições da janela de eventos, consulte [Considerações](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations) na seção Eventos Programados do *Guia do usuário do Amazon EC2*. **Exemplo 2: associar tags de instância a uma janela de eventos** O exemplo `associate-instance-event-window` a seguir associa tags de instância a uma janela de eventos. Insira um parâmetro `instance-event-window-id` para especificar a janela do evento. Para associar tags de instância, especifique o parâmetro `association-target` e, para os valores de parâmetro, especifique uma ou mais tags. ``` aws ec2 associate-instance-event-window \ --region us-east-1 \ --instance-event-window-id iew-0abcdef1234567890 \ --association-target "InstanceTags=[{Key=k2,Value=v2},{Key=k1,Value=v1}]" ``` Resultado: ``` { "InstanceEventWindow": { "InstanceEventWindowId": "iew-0abcdef1234567890", "Name": "myEventWindowName", "CronExpression": "* 21-23 * * 2,3", "AssociationTarget": { "InstanceIds": [], "Tags": [ { "Key": "k2", "Value": "v2" }, { "Key": "k1", "Value": "v1" } ], "DedicatedHostIds": [] }, "State": "creating" } } ``` Para restrições da janela de eventos, consulte [Considerações](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations) na seção Eventos Programados do *Guia do usuário do Amazon EC2*. **Exemplo 3: associar um Host Dedicado a uma janela de eventos** O exemplo `associate-instance-event-window` a seguir associa um Host Dedicado a uma janela de eventos. Insira um parâmetro `instance-event-window-id` para especificar a janela do evento. Para associar um Host Dedicado, especifique o parâmetro `--association-target` e, para os valores de parâmetro, especifique um ou mais IDs de Host Dedicado. ``` aws ec2 associate-instance-event-window \ --region us-east-1 \ --instance-event-window-id iew-0abcdef1234567890 \ --association-target "DedicatedHostIds=h-029fa35a02b99801d" ``` Resultado: ``` { "InstanceEventWindow": { "InstanceEventWindowId": "iew-0abcdef1234567890", "Name": "myEventWindowName", "CronExpression": "* 21-23 * * 2,3", "AssociationTarget": { "InstanceIds": [], "Tags": [], "DedicatedHostIds": [ "h-029fa35a02b99801d" ] }, "State": "creating" } } ``` Para restrições da janela de eventos, consulte [Considerações](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations) na seção Eventos Programados do *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [AssociateInstanceEventWindow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-instance-event-window.html) na *Referência de comandos da AWS CLI*. ### `associate-ipam-resource-discovery` O código de exemplo a seguir mostra como usar `associate-ipam-resource-discovery`. **AWS CLI** **Associar uma descoberta de recursos a um IPAM** Neste exemplo, você é um administrador delegado do IPAM e uma descoberta de recursos foi criada e compartilhada com você por outra conta AWS para que você possa usar o IPAM para gerenciar e monitorar CIDRs de recursos pertencentes à outra conta. Observação Para concluir essa solicitação, você precisará do ID de descoberta de recursos, que pode ser obtido com [describe-ipam-resource-discoveries](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-ipam-resource-discoveries.html), e do ID do IPAM, que pode ser obtido com [describe-ipams](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-ipams.html). A descoberta de recursos que você está associando deve ter sido compartilhada primeiro com sua conta usando o AWS RAM. O `--region` inserido deve corresponder à região de origem do IPAM à qual você está associando. O exemplo `associate-ipam-resource-discovery` a seguir associa uma descoberta de recurso a um IPAM. ``` aws ec2 associate-ipam-resource-discovery \ --ipam-id ipam-005f921c17ebd5107 \ --ipam-resource-discovery-id ipam-res-disco-03e0406de76a044ee \ --tag-specifications 'ResourceType=ipam-resource-discovery,Tags=[{Key=cost-center,Value=cc123}]' \ --region us-east-1 ``` Resultado: ``` { { "IpamResourceDiscoveryAssociation": { "OwnerId": "320805250157", "IpamResourceDiscoveryAssociationId": "ipam-res-disco-assoc-04382a6346357cf82", "IpamResourceDiscoveryAssociationArn": "arn:aws:ec2::320805250157:ipam-resource-discovery-association/ipam-res-disco-assoc-04382a6346357cf82", "IpamResourceDiscoveryId": "ipam-res-disco-0365d2977fc1672fe", "IpamId": "ipam-005f921c17ebd5107", "IpamArn": "arn:aws:ec2::320805250157:ipam/ipam-005f921c17ebd5107", "IpamRegion": "us-east-1", "IsDefault": false, "ResourceDiscoveryStatus": "active", "State": "associate-in-progress", "Tags": [] } } } ``` Depois de associar uma descoberta de recursos, você pode monitorar e/ou gerenciar os endereços IP dos recursos criados pelas outras contas. Para obter mais informações, consulte [Integrar o IPAM com contas fora da sua organização](https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam-outside-org.html) no *Guia do usuário do IPAM da Amazon VPC*. + Para ver detalhes da API, consulte [AssociateIpamResourceDiscovery](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-ipam-resource-discovery.html) na *Referência de comandos da AWS CLI*. ### `associate-nat-gateway-address` O código de exemplo a seguir mostra como usar `associate-nat-gateway-address`. **AWS CLI** **Associar um endereço IP elástico a um gateway NAT público** O exemplo `associate-nat-gateway-address` a seguir associa o endereço IP elástico especificado ao gateway NAT público especificado. O AWS atribui automaticamente um endereço IPv4 privado secundário. ``` aws ec2 associate-nat-gateway-address \ --nat-gateway-id nat-1234567890abcdef0 \ --allocation-ids eipalloc-0be6ecac95EXAMPLE ``` Resultado: ``` { "NatGatewayId": "nat-1234567890abcdef0", "NatGatewayAddresses": [ { "AllocationId": "eipalloc-0be6ecac95EXAMPLE", "NetworkInterfaceId": "eni-09cc4b2558794f7f9", "IsPrimary": false, "Status": "associating" } ] } ``` Para obter mais informações, consulte [Gateways NAT](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) no *Guia do usuário da Amazon VPC*. + Para ver detalhes da API, consulte [AssociateNatGatewayAddress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-nat-gateway-address.html) na *Referência de comandos da AWS CLI*. ### `associate-route-table` O código de exemplo a seguir mostra como usar `associate-route-table`. **AWS CLI** **Associar uma tabela de rotas a uma sub-rede** Este exemplo associa a tabela de rotas especificada à sub-rede especificada. Comando: ``` aws ec2 associate-route-table --route-table-id rtb-22574640 --subnet-id subnet-9d4a7b6c ``` Resultado: ``` { "AssociationId": "rtbassoc-781d0d1a" } ``` + Para ver detalhes da API, consulte [AssociateRouteTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-route-table.html) na *Referência de comandos da AWS CLI*. ### `associate-security-group-vpc` O código de exemplo a seguir mostra como usar `associate-security-group-vpc`. **AWS CLI** **Como associar um grupo de segurança a outra VPC** O exemplo de `associate-security-group-vpc` a seguir associa o grupo de segurança especificado à VPC especificada. ``` aws ec2 associate-security-group-vpc \ --group-id sg-04dbb43907d3f8a78 \ --vpc-id vpc-0bf4c2739bc05a694 ``` Resultado: ``` { "State": "associating" } ``` Consulte mais informações em [Associate security groups with multiple VPCs](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-assoc.html) no *Guia do usuário da Amazon VPC*. + Consulte detalhes da API em [AssociateSecurityGroupVpc](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-security-group-vpc.html) na *Referência de comandos da AWS CLI*. ### `associate-subnet-cidr-block` O código de exemplo a seguir mostra como usar `associate-subnet-cidr-block`. **AWS CLI** **Associar um bloco CIDR IPv6 a uma sub-rede** Este exemplo associa um bloco CIDR IPv6 à sub-rede especificada. Comando: ``` aws ec2 associate-subnet-cidr-block --subnet-id subnet-5f46ec3b --ipv6-cidr-block 2001:db8:1234:1a00::/64 ``` Resultado: ``` { "SubnetId": "subnet-5f46ec3b", "Ipv6CidrBlockAssociation": { "Ipv6CidrBlock": "2001:db8:1234:1a00::/64", "AssociationId": "subnet-cidr-assoc-3aa54053", "Ipv6CidrBlockState": { "State": "associating" } } } ``` + Para ver detalhes da API, consulte [AssociateSubnetCidrBlock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-subnet-cidr-block.html) na *Referência de comandos da AWS CLI*. ### `associate-transit-gateway-multicast-domain` O código de exemplo a seguir mostra como usar `associate-transit-gateway-multicast-domain`. **AWS CLI** **Associar um gateway de trânsito a um domínio multicast** O exemplo `associate-transit-gateway-multicast-domain` a seguir associa a sub-rede e o anexo especificados ao domínio multicast especificado. ``` aws ec2 associate-transit-gateway-multicast-domain \ --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef79d6e597 \ --transit-gateway-attachment-id tgw-attach-028c1dd0f8f5cbe8e \ --subnet-ids subnet-000de86e3b49c932a \ --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef7EXAMPLE ``` Resultado: ``` { "Associations": { "TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c4905cef79d6e597", "TransitGatewayAttachmentId": "tgw-attach-028c1dd0f8f5cbe8e", "ResourceId": "vpc-01128d2c240c09bd5", "ResourceType": "vpc", "Subnets": [ { "SubnetId": "subnet-000de86e3b49c932a", "State": "associating" } ] } } ``` Consulte mais informações em [Multicast domains](https://docs.aws.amazon.com/vpc/latest/tgw/multicast-domains-about.html) no *Guia do Transit Gateway*. + Para ver detalhes da API, consulte [AssociateTransitGatewayMulticastDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-transit-gateway-multicast-domain.html) na *Referência de comandos da AWS CLI*. ### `associate-transit-gateway-route-table` O código de exemplo a seguir mostra como usar `associate-transit-gateway-route-table`. **AWS CLI** **Associar uma tabela de rotas do gateway de trânsito a um anexo do gateway de trânsito** O exemplo a seguir associa a tabela de rotas do gateway de trânsito especificado ao anexo VPC especificado. ``` aws ec2 associate-transit-gateway-route-table \ --transit-gateway-route-table-id tgw-rtb-002573ed1eEXAMPLE \ --transit-gateway-attachment-id tgw-attach-0b5968d3b6EXAMPLE ``` Resultado: ``` { "Association": { "TransitGatewayRouteTableId": "tgw-rtb-002573ed1eEXAMPLE", "TransitGatewayAttachmentId": "tgw-attach-0b5968d3b6EXAMPLE", "ResourceId": "vpc-0065acced4EXAMPLE", "ResourceType": "vpc", "State": "associating" } } ``` Para obter mais informações, consulte [Associar uma tabelas de rota de gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html#associate-tgw-route-table) no *Guia de gateway de trânsito AWS*. + Para ver detalhes da API, consulte [AssociateTransitGatewayRouteTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-transit-gateway-route-table.html) na *Referência de comandos da AWS CLI*. ### `associate-vpc-cidr-block` O código de exemplo a seguir mostra como usar `associate-vpc-cidr-block`. **AWS CLI** **Exemplo 1: associar um bloco CIDR IPv6 fornecido pela Amazon a uma VPC** O exemplo `associate-vpc-cidr-block` a seguir associa um bloco CIDR IPv6 com a VPC especificada: ``` aws ec2 associate-vpc-cidr-block \ --amazon-provided-ipv6-cidr-block \ --ipv6-cidr-block-network-border-group us-west-2-lax-1 \ --vpc-id vpc-8EXAMPLE ``` Resultado: ``` { "Ipv6CidrBlockAssociation": { "AssociationId": "vpc-cidr-assoc-0838ce7d9dEXAMPLE", "Ipv6CidrBlockState": { "State": "associating" }, "NetworkBorderGroup": "us-west-2-lax-1" }, "VpcId": "vpc-8EXAMPLE" } ``` **Exemplo 2: associar um bloco CIDR IPv4 adicional a uma VPC** O exemplo `associate-vpc-cidr-block` a seguir associa o bloco CIDR IPv4 `10.2.0.0/16` à VPC especificada. ``` aws ec2 associate-vpc-cidr-block \ --vpc-id vpc-1EXAMPLE \ --cidr-block 10.2.0.0/16 ``` Resultado: ``` { "CidrBlockAssociation": { "AssociationId": "vpc-cidr-assoc-2EXAMPLE", "CidrBlock": "10.2.0.0/16", "CidrBlockState": { "State": "associating" } }, "VpcId": "vpc-1EXAMPLE" } ``` + Para ver detalhes da API, consulte [AssociateVpcCidrBlock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-vpc-cidr-block.html) na *Referência de comandos da AWS CLI*. ### `attach-classic-link-vpc` O código de exemplo a seguir mostra como usar `attach-classic-link-vpc`. **AWS CLI** **Vincular (anexar) uma instância do EC2-Classic a uma VPC** Este exemplo vincula a instância i-1234567890abcdef0 à VPC vpc-88888888 por meio do grupo de segurança da VPC sg-12312312. Comando: ``` aws ec2 attach-classic-link-vpc --instance-id i-1234567890abcdef0 --vpc-id vpc-88888888 --groups sg-12312312 ``` Resultado: ``` { "Return": true } ``` + Para ver detalhes da API, consulte [AttachClassicLinkVpc](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/attach-classic-link-vpc.html) na *Referência de Comandos da AWS CLI*. ### `attach-internet-gateway` O código de exemplo a seguir mostra como usar `attach-internet-gateway`. **AWS CLI** **Anexar um gateway da internet à VPC** O exemplo `attach-internet-gateway` a seguir anexa o gateway da internet especificado à VPC específica. ``` aws ec2 attach-internet-gateway \ --internet-gateway-id igw-0d0fb496b3EXAMPLE \ --vpc-id vpc-0a60eb65b4EXAMPLE ``` Este comando não produz saída. Para obter mais informações, consulte [Gateways da Internet](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html) no *Guia do usuário da Amazon VPC*. + Para ver detalhes da API, consulte [AttachInternetGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/attach-internet-gateway.html) na *Referência de comandos da AWS CLI*. ### `attach-network-interface` O código de exemplo a seguir mostra como usar `attach-network-interface`. **AWS CLI** **Exemplo 1: anexar uma interface de rede a uma instância** O exemplo `attach-network-interface` a seguir anexa a interface de rede especificada à instância especificada. ``` aws ec2 attach-network-interface \ --network-interface-id eni-0dc56a8d4640ad10a \ --instance-id i-1234567890abcdef0 \ --device-index 1 ``` Resultado: ``` { "AttachmentId": "eni-attach-01a8fc87363f07cf9" } ``` Para obter mais informações, consulte [Interfaces de rede elástica](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html) no *Guia do usuário do Amazon EC2*. **Exemplo 2: associar uma interface de rede a uma instância com vários cartões de rede** O exemplo `attach-network-interface` a seguir anexa a interface de rede especificada à instância e ao cartão de rede especificados. ``` aws ec2 attach-network-interface \ --network-interface-id eni-07483b1897541ad83 \ --instance-id i-01234567890abcdef \ --network-card-index 1 \ --device-index 1 ``` Resultado: ``` { "AttachmentId": "eni-attach-0fbd7ee87a88cd06c" } ``` Para obter mais informações, consulte [Interfaces de rede elástica](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [AttachNetworkInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/attach-network-interface.html) na *Referência de comandos da AWS CLI*. ### `attach-verified-access-trust-provider` O código de exemplo a seguir mostra como usar `attach-verified-access-trust-provider`. **AWS CLI** **Anexar um provedor de confiança a uma instância** O exemplo `attach-verified-access-trust-provider` a seguir anexa o provedor confiável de acesso verificado especificado à instância de acesso verificado especificada. ``` aws ec2 attach-verified-access-trust-provider \ --verified-access-instance-id vai-0ce000c0b7643abea \ --verified-access-trust-provider-id vatp-0bb32de759a3e19e7 ``` Resultado: ``` { "VerifiedAccessTrustProvider": { "VerifiedAccessTrustProviderId": "vatp-0bb32de759a3e19e7", "Description": "", "TrustProviderType": "user", "UserTrustProviderType": "iam-identity-center", "PolicyReferenceName": "idc", "CreationTime": "2023-08-25T19:00:38", "LastUpdatedTime": "2023-08-25T19:00:38" }, "VerifiedAccessInstance": { "VerifiedAccessInstanceId": "vai-0ce000c0b7643abea", "Description": "", "VerifiedAccessTrustProviders": [ { "VerifiedAccessTrustProviderId": "vatp-0bb32de759a3e19e7", "TrustProviderType": "user", "UserTrustProviderType": "iam-identity-center" } ], "CreationTime": "2023-08-25T18:27:56", "LastUpdatedTime": "2023-08-25T18:27:56" } } ``` Para obter mais informações, consulte [Instâncias de acesso verificado](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-instances.html) no *Guia do usuário do acesso verificado da AWS*. + Para ver detalhes da API, consulte [AttachVerifiedAccessTrustProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/attach-verified-access-trust-provider.html) na *Referência de comandos da AWS CLI*. ### `attach-volume` O código de exemplo a seguir mostra como usar `attach-volume`. **AWS CLI** **Anexar um volume a uma instância** Este exemplo de comando anexa um volume (`vol-1234567890abcdef0`) a uma instância (`i-01474ef662b89480`) como `/dev/sdf`. Comando: ``` aws ec2 attach-volume --volume-id vol-1234567890abcdef0 --instance-id i-01474ef662b89480 --device /dev/sdf ``` Resultado: ``` { "AttachTime": "YYYY-MM-DDTHH:MM:SS.000Z", "InstanceId": "i-01474ef662b89480", "VolumeId": "vol-1234567890abcdef0", "State": "attaching", "Device": "/dev/sdf" } ``` + Para ver detalhes da API, consulte [AttachVolume](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/attach-volume.html) na *Referência de comandos da AWS CLI*. ### `attach-vpn-gateway` O código de exemplo a seguir mostra como usar `attach-vpn-gateway`. **AWS CLI** **Anexar um gateway privado virtual à VPC** O exemplo `attach-vpn-gateway` a seguir anexa o gateway privado virtual especificado à VPC especificada. ``` aws ec2 attach-vpn-gateway \ --vpn-gateway-id vgw-9a4cacf3 \ --vpc-id vpc-a01106c2 ``` Resultado: ``` { "VpcAttachment": { "State": "attaching", "VpcId": "vpc-a01106c2" } } ``` + Para ver detalhes da API, consulte [AttachVpnGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/attach-vpn-gateway.html) na *Referência de comandos da AWS CLI*. ### `authorize-client-vpn-ingress` O código de exemplo a seguir mostra como usar `authorize-client-vpn-ingress`. **AWS CLI** **Adicionar uma regra de autorização a um endpoint do Cliente VPN** O exemplo `authorize-client-vpn-ingress` a seguir adiciona uma regra de autorização de entrada que permite que todos os clientes acessem a internet (`0.0.0.0/0`). ``` aws ec2 authorize-client-vpn-ingress \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ --target-network-cidr 0.0.0.0/0 \ --authorize-all-groups ``` Resultado: ``` { "Status": { "Code": "authorizing" } } ``` Para obter mais informações, consulte [Regras de autorização](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-rules.html) no *Guia do administrador do Cliente VPN da AWS*. + Para ver detalhes da API, consulte [AuthorizeClientVpnIngress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/authorize-client-vpn-ingress.html) na *Referência de comandos da AWS CLI*. ### `authorize-security-group-egress` O código de exemplo a seguir mostra como usar `authorize-security-group-egress`. **AWS CLI** **Exemplo 1: adicionar uma regra que permita tráfego de saída para um intervalo de endereços específico** O exemplo de `authorize-security-group-egress` a seguir adiciona uma regra que concede acesso aos intervalos de endereços especificados na porta TCP 80. ``` aws ec2 authorize-security-group-egress \ --group-id sg-1234567890abcdef0 \ --ip-permissions 'IpProtocol=tcp,FromPort=80,ToPort=80,IpRanges=[{CidrIp=10.0.0.0/16}]' ``` Resultado: ``` { "Return": true, "SecurityGroupRules": [ { "SecurityGroupRuleId": "sgr-0b15794cdb17bf29c", "GroupId": "sg-1234567890abcdef0", "GroupOwnerId": "123456789012", "IsEgress": true, "IpProtocol": "tcp", "FromPort": 80, "ToPort": 80, "CidrIpv4": "10.0.0.0/16" } ] } ``` **Exemplo 2: adicionar uma regra que permita tráfego de saída a um grupo de segurança específico** O exemplo de `authorize-security-group-egress` a seguir adiciona uma regra que concede acesso ao grupo de segurança especificado na porta TCP 80. ``` aws ec2 authorize-security-group-egress \ --group-id sg-1234567890abcdef0 \ --ip-permissions 'IpProtocol=tcp,FromPort=80,ToPort=80,UserIdGroupPairs=[{GroupId=sg-0aad1c26bbeec5c22}]' ``` Resultado: ``` { "Return": true, "SecurityGroupRules": [ { "SecurityGroupRuleId": "sgr-0b5dd815afcea9cc3", "GroupId": "sg-1234567890abcdef0", "GroupOwnerId": "123456789012", "IsEgress": true, "IpProtocol": "tcp", "FromPort": 80, "ToPort": 80, "ReferencedGroupInfo": { "GroupId": "sg-0aad1c26bbeec5c22", "UserId": "123456789012" } } ] } ``` Para obter mais informações, consulte [Grupos de segurança](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-security-groups.html) no *Manual do usuário da Amazon VPC*. + Para ver detalhes da API, consulte [AuthorizeSecurityGroupEgress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/authorize-security-group-egress.html) na *Referência de comandos da AWS CLI*. ### `authorize-security-group-ingress` O código de exemplo a seguir mostra como usar `authorize-security-group-ingress`. **AWS CLI** **Exemplo 1: adicionar uma regra que permita tráfego SSH de entrada** O exemplo `authorize-security-group-ingress` a seguir adiciona uma regra que permite o tráfego de entrada na porta TCP 22 (SSH). ``` aws ec2 authorize-security-group-ingress \ --group-id sg-1234567890abcdef0 \ --protocol tcp \ --port 22 \ --cidr 203.0.113.0/24 ``` Resultado: ``` { "Return": true, "SecurityGroupRules": [ { "SecurityGroupRuleId": "sgr-01afa97ef3e1bedfc", "GroupId": "sg-1234567890abcdef0", "GroupOwnerId": "123456789012", "IsEgress": false, "IpProtocol": "tcp", "FromPort": 22, "ToPort": 22, "CidrIpv4": "203.0.113.0/24" } ] } ``` **Exemplo 2: adicionar uma regra que permita tráfego HTTP de entrada de outro grupo de segurança** O exemplo `authorize-security-group-ingress` a seguir adiciona uma regra que permite o acesso de entrada na porta TCP 80 do grupo de segurança de origem `sg-1a2b3c4d`. O grupo de origem deve estar na mesma VPC ou em uma VPC de par (requer uma conexão de emparelhamento da VPC). O tráfego de entrada é permitido com base nos endereços IP privados das instâncias associadas ao grupo de segurança de origem (e não ao endereço IP público ou ao endereço IP elástico). ``` aws ec2 authorize-security-group-ingress \ --group-id sg-1234567890abcdef0 \ --protocol tcp \ --port 80 \ --source-group sg-1a2b3c4d ``` Resultado: ``` { "Return": true, "SecurityGroupRules": [ { "SecurityGroupRuleId": "sgr-01f4be99110f638a7", "GroupId": "sg-1234567890abcdef0", "GroupOwnerId": "123456789012", "IsEgress": false, "IpProtocol": "tcp", "FromPort": 80, "ToPort": 80, "ReferencedGroupInfo": { "GroupId": "sg-1a2b3c4d", "UserId": "123456789012" } } ] } ``` **Exemplo 3: adicionar várias regras na mesma chamada** O exemplo `authorize-security-group-ingress` a seguir usa o parâmetro `ip-permissions` para adicionar duas regras de entrada, uma que habilita o acesso de entrada na porta TCP 3389 (RDP) e a outra que habilita o ping e ICMP. ``` aws ec2 authorize-security-group-ingress \ --group-id sg-1234567890abcdef0 \ --ip-permissions 'IpProtocol=tcp,FromPort=3389,ToPort=3389,IpRanges=[{CidrIp=172.31.0.0/16}]' 'IpProtocol=icmp,FromPort=-1,ToPort=-1,IpRanges=[{CidrIp=172.31.0.0/16}]' ``` Resultado: ``` { "Return": true, "SecurityGroupRules": [ { "SecurityGroupRuleId": "sgr-00e06e5d3690f29f3", "GroupId": "sg-1234567890abcdef0", "GroupOwnerId": "123456789012", "IsEgress": false, "IpProtocol": "tcp", "FromPort": 3389, "ToPort": 3389, "CidrIpv4": "172.31.0.0/16" }, { "SecurityGroupRuleId": "sgr-0a133dd4493944b87", "GroupId": "sg-1234567890abcdef0", "GroupOwnerId": "123456789012", "IsEgress": false, "IpProtocol": "tcp", "FromPort": -1, "ToPort": -1, "CidrIpv4": "172.31.0.0/16" } ] } ``` **Exemplo 4: adicionar uma regra para o tráfego ICMP** O exemplo `authorize-security-group-ingress` a seguir usa o parâmetro `ip-permissions` para adicionar uma regra de entrada que permite a mensagem do ICMP `Destination Unreachable: Fragmentation Needed and Don't Fragment was Set` (Tipo 3, Código 4) de qualquer lugar. ``` aws ec2 authorize-security-group-ingress \ --group-id sg-1234567890abcdef0 \ --ip-permissions 'IpProtocol=icmp,FromPort=3,ToPort=4,IpRanges=[{CidrIp=0.0.0.0/0}]' ``` Resultado: ``` { "Return": true, "SecurityGroupRules": [ { "SecurityGroupRuleId": "sgr-0de3811019069b787", "GroupId": "sg-1234567890abcdef0", "GroupOwnerId": "123456789012", "IsEgress": false, "IpProtocol": "icmp", "FromPort": 3, "ToPort": 4, "CidrIpv4": "0.0.0.0/0" } ] } ``` **Exemplo 5: adicionar uma regra para o tráfego IPv** O exemplo `authorize-security-group-ingress` a seguir usa o parâmetro `ip-permissions` para adicionar uma regra de entrada que permite o acesso SSH (porta 22) do intervalo IPv6 `2001:db8:1234:1a00::/64`. ``` aws ec2 authorize-security-group-ingress \ --group-id sg-1234567890abcdef0 \ --ip-permissions 'IpProtocol=tcp,FromPort=22,ToPort=22,Ipv6Ranges=[{CidrIpv6=2001:db8:1234:1a00::/64}]' ``` Resultado: ``` { "Return": true, "SecurityGroupRules": [ { "SecurityGroupRuleId": "sgr-0455bc68b60805563", "GroupId": "sg-1234567890abcdef0", "GroupOwnerId": "123456789012", "IsEgress": false, "IpProtocol": "tcp", "FromPort": 22, "ToPort": 22, "CidrIpv6": "2001:db8:1234:1a00::/64" } ] } ``` **Exemplo 6: adicionar uma regra para o tráfego ICMPv** O exemplo `authorize-security-group-ingress` a seguir usa o parâmetro `ip-permissions` para adicionar uma regra de entrada que permite o tráfego ICMPv6 de qualquer lugar. ``` aws ec2 authorize-security-group-ingress \ --group-id sg-1234567890abcdef0 \ --ip-permissions 'IpProtocol=icmpv6,Ipv6Ranges=[{CidrIpv6=::/0}]' ``` Resultado: ``` { "Return": true, "SecurityGroupRules": [ { "SecurityGroupRuleId": "sgr-04b612d9363ab6327", "GroupId": "sg-1234567890abcdef0", "GroupOwnerId": "123456789012", "IsEgress": false, "IpProtocol": "icmpv6", "FromPort": -1, "ToPort": -1, "CidrIpv6": "::/0" } ] } ``` **Exemplo 7: adicionar uma regra com uma descrição** O exemplo `authorize-security-group-ingress` a seguir usa o parâmetro `ip-permissions` para adicionar uma regra de entrada que permite o tráfego RDP do intervalo de endereços IPv4 especificado. A regra inclui uma descrição para ajudar a identificá-lo posteriormente. ``` aws ec2 authorize-security-group-ingress \ --group-id sg-1234567890abcdef0 \ --ip-permissions 'IpProtocol=tcp,FromPort=3389,ToPort=3389,IpRanges=[{CidrIp=203.0.113.0/24,Description='RDP access from NY office'}]' ``` Resultado: ``` { "Return": true, "SecurityGroupRules": [ { "SecurityGroupRuleId": "sgr-0397bbcc01e974db3", "GroupId": "sg-1234567890abcdef0", "GroupOwnerId": "123456789012", "IsEgress": false, "IpProtocol": "tcp", "FromPort": 3389, "ToPort": 3389, "CidrIpv4": "203.0.113.0/24", "Description": "RDP access from NY office" } ] } ``` **Exemplo 8: adicionar uma regra de entrada que use uma lista de prefixos** O exemplo `authorize-security-group-ingress` a seguir usa o parâmetro `ip-permissions` para adicionar uma regra de entrada que permite todo o tráfego para os intervalos CIDR na lista de prefixos especificada. ``` aws ec2 authorize-security-group-ingress \ --group-id sg-04a351bfe432d4e71 \ --ip-permissions 'IpProtocol=all,PrefixListIds=[{PrefixListId=pl-002dc3ec097de1514}]' ``` Resultado: ``` { "Return": true, "SecurityGroupRules": [ { "SecurityGroupRuleId": "sgr-09c74b32f677c6c7c", "GroupId": "sg-1234567890abcdef0", "GroupOwnerId": "123456789012", "IsEgress": false, "IpProtocol": "-1", "FromPort": -1, "ToPort": -1, "PrefixListId": "pl-0721453c7ac4ec009" } ] } ``` Para obter mais informações, consulte [Grupos de segurança](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-security-groups.html) no *Manual do usuário da Amazon VPC*. + Consulte detalhes da API em [AuthorizeSecurityGroupIngress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/authorize-security-group-ingress.html) na *Referência de comandos da AWS CLI*. ### `bundle-instance` O código de exemplo a seguir mostra como usar `bundle-instance`. **AWS CLI** **Empacotar uma instância** Este exemplo empacota a instância `i-1234567890abcdef0` em um bucket chamado `bundletasks`. Antes de especificar valores para seus IDs da chave de acesso, revise e siga as orientações em Melhores práticas para gerenciar chaves de acesso AWS. Comando: ``` aws ec2 bundle-instance --instance-id i-1234567890abcdef0 --bucket bundletasks --prefix winami --owner-akid AK12AJEXAMPLE --owner-sak example123example ``` Resultado: ``` { "BundleTask": { "UpdateTime": "2015-09-15T13:30:35.000Z", "InstanceId": "i-1234567890abcdef0", "Storage": { "S3": { "Prefix": "winami", "Bucket": "bundletasks" } }, "State": "pending", "StartTime": "2015-09-15T13:30:35.000Z", "BundleId": "bun-294e041f" } } ``` + Para ver detalhes da API, consulte [BundleInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/bundle-instance.html) na *Referência de comandos da AWS CLI*. ### `cancel-bundle-task` O código de exemplo a seguir mostra como usar `cancel-bundle-task`. **AWS CLI** **Cancelar uma tarefa de empacotamento** Este exemplo cancela a tarefa de empacotamento `bun-2a4e041c`. Comando: ``` aws ec2 cancel-bundle-task --bundle-id bun-2a4e041c ``` Resultado: ``` { "BundleTask": { "UpdateTime": "2015-09-15T13:27:40.000Z", "InstanceId": "i-1234567890abcdef0", "Storage": { "S3": { "Prefix": "winami", "Bucket": "bundletasks" } }, "State": "cancelling", "StartTime": "2015-09-15T13:24:35.000Z", "BundleId": "bun-2a4e041c" } } ``` + Para ver detalhes da API, consulte [CancelBundleTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/cancel-bundle-task.html) na *Referência de comandos da AWS CLI*. ### `cancel-capacity-reservation-fleets` O código de exemplo a seguir mostra como usar `cancel-capacity-reservation-fleets`. **AWS CLI** **Cancelar uma frota de reserva de capacidade** O exemplo `cancel-capacity-reservation-fleets` a seguir cancela a frota de reserva de capacidade especificada e a capacidade que ela reserva. Quando você cancela uma frota, o status muda para `cancelled` e ela não poderá mais criar novas reservas de capacidade. Além disso, todas as reservas de capacidade individuais na frota são canceladas e as instâncias que estavam em execução anteriormente na capacidade reservada continuam a ser executadas normalmente com capacidade compartilhada. ``` aws ec2 cancel-capacity-reservation-fleets \ --capacity-reservation-fleet-ids crf-abcdef01234567890 ``` Resultado: ``` { "SuccessfulFleetCancellations": [ { "CurrentFleetState": "cancelling", "PreviousFleetState": "active", "CapacityReservationFleetId": "crf-abcdef01234567890" } ], "FailedFleetCancellations": [] } ``` Para obter mais informações sobre as Frotas de Reserva de Capacidade, consulte [Frotas de reserva de capacidade](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-fleets.html) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [CancelCapacityReservationFleets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/cancel-capacity-reservation-fleets.html) na *Referência de comandos da AWS CLI*. ### `cancel-capacity-reservation` O código de exemplo a seguir mostra como usar `cancel-capacity-reservation`. **AWS CLI** **Cancelar uma reserva de capacidade** O exemplo `cancel-capacity-reservation` a seguir cancela a reserva de capacidade especificada. ``` aws ec2 cancel-capacity-reservation \ --capacity-reservation-id cr-1234abcd56EXAMPLE ``` Resultado: ``` { "Return": true } ``` Consulte mais informações em [Cancelar uma Reserva de capacidade](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-release.html) no *Manual do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [CancelCapacityReservation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/cancel-capacity-reservation.html) na *Referência de comandos da AWS CLI*. ### `cancel-conversion-task` O código de exemplo a seguir mostra como usar `cancel-conversion-task`. **AWS CLI** **Cancelar uma conversão ativa de uma instância ou volume** Este exemplo cancela o envio associado à ID da tarefa import-i-fh95npoc. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 cancel-conversion-task --conversion-task-id import-i-fh95npoc ``` + Para ver detalhes da API, consulte [CancelConversionTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/cancel-conversion-task.html) na *Referência de comandos da AWS CLI*. ### `cancel-export-task` O código de exemplo a seguir mostra como usar `cancel-export-task`. **AWS CLI** **Cancelar uma tarefa de exportação ativa** Este exemplo cancela uma tarefa de exportação ativa com o ID da tarefa export-i-fgelt0i7. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 cancel-export-task --export-task-id export-i-fgelt0i7 ``` + Para ver detalhes da API, consulte [CancelExportTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/cancel-export-task.html) na *Referência de comandos da AWS CLI*. ### `cancel-image-launch-permission` O código de exemplo a seguir mostra como usar `cancel-image-launch-permission`. **AWS CLI** **Cancelar o compartilhamento de uma AMI com sua conta da Amazon Web Services** O exemplo `cancel-image-launch-permission` a seguir remove sua conta das permissões de execução para a AMI especificada. ``` aws ec2 cancel-image-launch-permission \ --image-id ami-0123456789example \ --region us-east-1 ``` Resultado: ``` { "Return": true } ``` Para obter mais informações, consulte [Cancelar o compartilhamento de uma AMI com sua conta da Amazon Web Services](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cancel-sharing-an-AMI.html#cancel-image-launch-permission) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [CancelImageLaunchPermission](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/cancel-image-launch-permission.html) na *Referência de comandos da AWS CLI*. ### `cancel-import-task` O código de exemplo a seguir mostra como usar `cancel-import-task`. **AWS CLI** **Cancelar uma tarefa de importação** O exemplo `cancel-import-task` a seguir cancela a tarefa de importação de imagem especificada. ``` aws ec2 cancel-import-task \ --import-task-id import-ami-1234567890abcdef0 ``` Resultado: ``` { "ImportTaskId": "import-ami-1234567890abcdef0", "PreviousState": "active", "State": "deleting" } ``` + Para ver detalhes da API, consulte [CancelImportTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/cancel-import-task.html) na *Referência de comandos da AWS CLI*. ### `cancel-reserved-instances-listing` O código de exemplo a seguir mostra como usar `cancel-reserved-instances-listing`. **AWS CLI** **Cancelar uma listagem de Instâncias Reservadas** O exemplo `cancel-reserved-instances-listing` a seguir cancela a listagem de instâncias reservadas especificada. ``` aws ec2 cancel-reserved-instances-listing \ --reserved-instances-listing-id 5ec28771-05ff-4b9b-aa31-9e57dexample ``` + Para ver detalhes da API, consulte [CancelReservedInstancesListing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/cancel-reserved-instances-listing.html) na *Referência de comandos da AWS CLI*. ### `cancel-spot-fleet-requests` O código de exemplo a seguir mostra como usar `cancel-spot-fleet-requests`. **AWS CLI** **Exemplo 1: cancelar uma solicitação de frota Spot e encerrar as instâncias associadas** O exemplo `cancel-spot-fleet-requests` a seguir cancela uma solicitação de Frota Spot e encerra as Instâncias Sob Demanda e Instâncias Spot associadas. ``` aws ec2 cancel-spot-fleet-requests \ --spot-fleet-request-ids sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE \ --terminate-instances ``` Resultado: ``` { "SuccessfulFleetRequests": [ { "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", "CurrentSpotFleetRequestState": "cancelled_terminating", "PreviousSpotFleetRequestState": "active" } ], "UnsuccessfulFleetRequests": [] } ``` **Exemplo 2: cancelar uma solicitação de frota Spot sem encerrar as instâncias associadas** O exemplo `cancel-spot-fleet-requests` a seguir cancela uma solicitação de Frota Spot sem encerrar as Instâncias Sob Demanda e Instâncias Spot associadas. ``` aws ec2 cancel-spot-fleet-requests \ --spot-fleet-request-ids sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE \ --no-terminate-instances ``` Resultado: ``` { "SuccessfulFleetRequests": [ { "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", "CurrentSpotFleetRequestState": "cancelled_running", "PreviousSpotFleetRequestState": "active" } ], "UnsuccessfulFleetRequests": [] } ``` Consulte mais informações em [Cancelar uma solicitação de frota spot](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cancel-spot-fleet.html) no *Manual do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [CancelSpotFleetRequests](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/cancel-spot-fleet-requests.html) na *Referência de comandos da AWS CLI*. ### `cancel-spot-instance-requests` O código de exemplo a seguir mostra como usar `cancel-spot-instance-requests`. **AWS CLI** **Cancelar solicitações de Instância Spot** Este exemplo de comando cancela uma solicitação de Instância Spot. Comando: ``` aws ec2 cancel-spot-instance-requests --spot-instance-request-ids sir-08b93456 ``` Resultado: ``` { "CancelledSpotInstanceRequests": [ { "State": "cancelled", "SpotInstanceRequestId": "sir-08b93456" } ] } ``` + Para ver detalhes da API, consulte [CancelSpotInstanceRequests](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/cancel-spot-instance-requests.html) na *Referência de comandos da AWS CLI*. ### `confirm-product-instance` O código de exemplo a seguir mostra como usar `confirm-product-instance`. **AWS CLI** **Confirmar a instância do produto** Esse exemplo determina se o código do produto especificado está associado à instância especificada. Comando: ``` aws ec2 confirm-product-instance --product-code 774F4FF8 --instance-id i-1234567890abcdef0 ``` Resultado: ``` { "OwnerId": "123456789012" } ``` + Para ver detalhes da API, consulte [ConfirmProductInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/confirm-product-instance.html) na *Referência de comandos da AWS CLI*. ### `copy-fpga-image` O código de exemplo a seguir mostra como usar `copy-fpga-image`. **AWS CLI** **Copiar uma imagem FPGA da Amazon** Este exemplo copia o AFI especificado da região `us-east-1` para a região atual (`eu-west-1`). Comando: ``` aws ec2 copy-fpga-image --name copy-afi --source-fpga-image-id afi-0d123e123bfc85abc --source-region us-east-1 --region eu-west-1 ``` Resultado: ``` { "FpgaImageId": "afi-06b12350a123fbabc" } ``` + Para ver detalhes da API, consulte [CopyFpgaImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/copy-fpga-image.html) na *Referência de comandos da AWS CLI*. ### `copy-image` O código de exemplo a seguir mostra como usar `copy-image`. **AWS CLI** **Exemplo 1: copiar uma AMI para outra região** O comando de exemplo `copy-image` a seguir copia a AMI especificada da região `us-west-2` para a região `us-east-1` e adiciona uma breve descrição. ``` aws ec2 copy-image \ --region us-east-1 \ --name ami-name \ --source-region us-west-2 \ --source-image-id ami-066877671789bd71b \ --description "This is my copied image." ``` Resultado: ``` { "ImageId": "ami-0123456789abcdefg" } ``` Para obter mais informações, consulte [Copiar uma AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html) no *Guia do usuário do Amazon EC2*. **Exemplo 2: copiar uma AMI para outra região e criptografar o snapshot de apoio** O comando `copy-image` a seguir copia a AMI especificada da região `us-west-2` para a região atual e criptografa o snapshot de backup usando a chave KMS especificada. ``` aws ec2 copy-image \ --source-region us-west-2 \ --name ami-name \ --source-image-id ami-066877671789bd71b \ --encrypted \ --kms-key-id alias/my-kms-key ``` Resultado: ``` { "ImageId": "ami-0123456789abcdefg" } ``` Para obter mais informações, consulte [Copiar uma AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html) no *Guia do usuário do Amazon EC2*. **Exemplo 3: incluir as tags de AMI definidas pelo usuário ao copiar uma AMI** O comando `copy-image` a seguir usa o parâmetro `--copy-image-tags` para copiar as tags de AMI definidas pelo usuário ao copiar a AMI. ``` aws ec2 copy-image \ --region us-east-1 \ --name ami-name \ --source-region us-west-2 \ --source-image-id ami-066877671789bd71b \ --description "This is my copied image." --copy-image-tags ``` Resultado: ``` { "ImageId": "ami-0123456789abcdefg" } ``` Para obter mais informações, consulte [Copiar uma AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [CopyImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/copy-image.html) na *Referência de comandos da AWS CLI*. ### `copy-snapshot` O código de exemplo a seguir mostra como usar `copy-snapshot`. **AWS CLI** **Exemplo 1: copiar um snapshot para outra região** O comando de exemplo `copy-snapshot` a seguir copia o snapshot especificado da região `us-west-2` para a região `us-east-1` e adiciona uma breve descrição. ``` aws ec2 copy-snapshot \ --region us-east-1 \ --source-region us-west-2 \ --source-snapshot-id snap-066877671789bd71b \ --description 'This is my copied snapshot.' ``` Resultado: ``` { "SnapshotId": "snap-066877671789bd71b" } ``` **Exemplo 2: copiar um snapshot não criptografado e criptografar o novo snapshot** O comando `copy-snapshot` a seguir copia o snapshot não criptografado especificado da região `us-west-2` para a região atual e criptografa o novo snapshot usando a chave KMS especificada. ``` aws ec2 copy-snapshot \ --source-region us-west-2 \ --source-snapshot-id snap-066877671789bd71b \ --encrypted \ --kms-key-id alias/my-kms-key ``` Resultado: ``` { "SnapshotId": "snap-066877671789bd71b" } ``` Consulte mais informações em [Copy an Amazon EBS snapshot](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-copy-snapshot.html) no *Guia do usuário do Amazon EBS*. + Para ver detalhes da API, consulte [CopySnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/copy-snapshot.html) na *Referência de comandos da AWS CLI*. ### `create-capacity-reservation-fleet` O código de exemplo a seguir mostra como usar `create-capacity-reservation-fleet`. **AWS CLI** **Criar uma Frota de Reserva de Capacidade** O exemplo `create-capacity-reservation-fleet` a seguir cria uma frota de reserva de capacidade para o tipo de instância especificado na solicitação, até a capacidade total de destino especificada. O número de instâncias para as quais a frota de reserva de capacidade reserva capacidade depende da capacidade total de destino e dos pesos de tipo de instância que você especifica na solicitação. Especifique os tipos de instância a serem usados e uma prioridade para cada um dos tipos de instância designados. ``` aws ec2 create-capacity-reservation-fleet \ --total-target-capacity 24 \ --allocation-strategy prioritized \ --instance-match-criteria open \ --tenancy default \ --end-date 2022-12-31T23:59:59.000Z \ --instance-type-specifications file://instanceTypeSpecification.json ``` Conteúdo de `instanceTypeSpecification.json`: ``` [ { "InstanceType": "m5.xlarge", "InstancePlatform": "Linux/UNIX", "Weight": 3.0, "AvailabilityZone":"us-east-1a", "EbsOptimized": true, "Priority" : 1 } ] ``` Resultado: ``` { "Status": "submitted", "TotalFulfilledCapacity": 0.0, "CapacityReservationFleetId": "crf-abcdef01234567890", "TotalTargetCapacity": 24 } ``` Para obter mais informações sobre as Frotas de Reserva de Capacidade, consulte [Frotas de reserva de capacidade](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-fleets.html) no *Guia do usuário do Amazon EC2*. Para obter mais informações sobre o peso do tipo de instância e a capacidade total alvo, consulte [Peso do tipo de instância](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#instance-weight) e [Capacidade total alvo](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity) no *Guia do usuário do Amazon EC2*. Para obter mais informações sobre a designação de prioridade para tipos de instância específicos, consulte [Estratégia de alocação](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#allocation-strategy) e [Prioridade do tipo de instância](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#instance-priority) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [CreateCapacityReservationFleet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-capacity-reservation-fleet.html) na *Referência de comandos da AWS CLI*. ### `create-capacity-reservation` O código de exemplo a seguir mostra como usar `create-capacity-reservation`. **AWS CLI** **Exemplo 1: criar uma reserva de capacidade** O exemplo `create-capacity-reservation` a seguir cria uma reserva de capacidade na Zona de Disponibilidade `eu-west-1a`, na qual você pode executar três instâncias `t2.medium` executando um sistema operacional Linux/Unix. Por padrão, a reserva de capacidade é criada com critérios de correspondência de instâncias abertas e sem suporte para armazenamento temporário, e permanece ativa até que você a cancele manualmente. ``` aws ec2 create-capacity-reservation \ --availability-zone eu-west-1a \ --instance-type t2.medium \ --instance-platform Linux/UNIX \ --instance-count 3 ``` Resultado: ``` { "CapacityReservation": { "CapacityReservationId": "cr-1234abcd56EXAMPLE ", "EndDateType": "unlimited", "AvailabilityZone": "eu-west-1a", "InstanceMatchCriteria": "open", "EphemeralStorage": false, "CreateDate": "2019-08-16T09:27:35.000Z", "AvailableInstanceCount": 3, "InstancePlatform": "Linux/UNIX", "TotalInstanceCount": 3, "State": "active", "Tenancy": "default", "EbsOptimized": false, "InstanceType": "t2.medium" } } ``` **Exemplo 2: criar uma reserva de capacidade que termine automaticamente em uma data/hora especificada** O exemplo `create-capacity-reservation` a seguir cria uma reserva de capacidade na Zona de Disponibilidade `eu-west-1a`, na qual você pode executar três instâncias `m5.large` executando um sistema operacional Linux/Unix. Essa reserva de capacidade termina automaticamente em 31/08/2019 às 23:59:59. ``` aws ec2 create-capacity-reservation \ --availability-zone eu-west-1a \ --instance-type m5.large \ --instance-platform Linux/UNIX \ --instance-count 3 \ --end-date-type limited \ --end-date 2019-08-31T23:59:59Z ``` Resultado: ``` { "CapacityReservation": { "CapacityReservationId": "cr-1234abcd56EXAMPLE ", "EndDateType": "limited", "AvailabilityZone": "eu-west-1a", "EndDate": "2019-08-31T23:59:59.000Z", "InstanceMatchCriteria": "open", "EphemeralStorage": false, "CreateDate": "2019-08-16T10:15:53.000Z", "AvailableInstanceCount": 3, "InstancePlatform": "Linux/UNIX", "TotalInstanceCount": 3, "State": "active", "Tenancy": "default", "EbsOptimized": false, "InstanceType": "m5.large" } } ``` **Exemplo 3: criar uma reserva de capacidade que aceite somente execuções direcionadas de instância** O exemplo `create-capacity-reservation` a seguir cria uma reserva de capacidade que aceita somente lançamentos de instâncias direcionadas. ``` aws ec2 create-capacity-reservation \ --availability-zone eu-west-1a \ --instance-type m5.large \ --instance-platform Linux/UNIX \ --instance-count 3 \ --instance-match-criteria targeted ``` Resultado: ``` { "CapacityReservation": { "CapacityReservationId": "cr-1234abcd56EXAMPLE ", "EndDateType": "unlimited", "AvailabilityZone": "eu-west-1a", "InstanceMatchCriteria": "targeted", "EphemeralStorage": false, "CreateDate": "2019-08-16T10:21:57.000Z", "AvailableInstanceCount": 3, "InstancePlatform": "Linux/UNIX", "TotalInstanceCount": 3, "State": "active", "Tenancy": "default", "EbsOptimized": false, "InstanceType": "m5.large" } } ``` Consulte mais informações em [Criar uma Reserva de capacidade](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-using.html) no *Manual do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [CreateCapacityReservation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-capacity-reservation.html) na *Referência de comandos da AWS CLI*. ### `create-carrier-gateway` O código de exemplo a seguir mostra como usar `create-carrier-gateway`. **AWS CLI** **Criar um gateway de operadora** O exemplo `create-carrier-gateway` a seguir cria um gateway de operadora para a VPC especificada. ``` aws ec2 create-carrier-gateway \ --vpc-id vpc-0c529aEXAMPLE1111 ``` Resultado: ``` { "CarrierGateway": { "CarrierGatewayId": "cagw-0465cdEXAMPLE1111", "VpcId": "vpc-0c529aEXAMPLE1111", "State": "pending", "OwnerId": "123456789012" } } ``` Para obter mais informações, consulte [Gateways de operadoras](https://docs.aws.amazon.com/wavelength/latest/developerguide/carrier-gateways.html) no *Guia do usuário do AWS Wavelength*. + Para ver detalhes da API, consulte [CreateCarrierGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-carrier-gateway.html) na *Referência de comandos da AWS CLI*. ### `create-client-vpn-endpoint` O código de exemplo a seguir mostra como usar `create-client-vpn-endpoint`. **AWS CLI** **Criar um endpoint da cliente VPN** O exemplo `create-client-vpn-endpoint` a seguir cria um endpoint do Cliente VPN usando autenticação mútua e especificando um valor para o bloco do CIDR do cliente. ``` aws ec2 create-client-vpn-endpoint \ --client-cidr-block "172.31.0.0/16" \ --server-certificate-arn arn:aws:acm:ap-south-1:123456789012:certificate/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --authentication-options Type=certificate-authentication,MutualAuthentication={ClientRootCertificateChainArn=arn:aws:acm:ap-south-1:123456789012:certificate/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE} \ --connection-log-options Enabled=false ``` Resultado: ``` { "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", "Status": { "Code": "pending-associate" }, "DnsName": "cvpn-endpoint-123456789123abcde.prod.clientvpn.ap-south-1.amazonaws.com" } ``` Para obter mais informações, consulte [Endpoints de Client VPN](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-endpoints.html) no *Guia do administrador do Cliente VPN da AWS*. + Para ver detalhes da API, consulte [CreateClientVpnEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-client-vpn-endpoint.html) na *Referência de comandos da AWS CLI*. ### `create-client-vpn-route` O código de exemplo a seguir mostra como usar `create-client-vpn-route`. **AWS CLI** **Criar uma rota para um endpoint do Cliente VPN** O exemplo `create-client-vpn-route` a seguir adiciona uma rota à internet (`0.0.0.0/0`) para a sub-rede especificada do endpoint de Cliente VPN. ``` aws ec2 create-client-vpn-route \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ --destination-cidr-block 0.0.0.0/0 \ --target-vpc-subnet-id subnet-0123456789abcabca ``` Resultado: ``` { "Status": { "Code": "creating" } } ``` Para obter mais informações, consulte [Rotas](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-routes.html) no *Guia do administrador de cliente VPN da AWS*. + Para ver detalhes da API, consulte [CreateClientVpnRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-client-vpn-route.html) na *Referência de comandos da AWS CLI*. ### `create-coip-cidr` O código de exemplo a seguir mostra como usar `create-coip-cidr`. **AWS CLI** **Criar um intervalo de endereços IP de propriedade do cliente (CoIP** O exemplo `create-coip-cidr` a seguir cria o intervalo especificado de endereços de CoIP no pool de CoIP especificado. ``` aws ec2 create-coip-cidr \ --cidr 15.0.0.0/24 \ --coip-pool-id ipv4pool-coip-1234567890abcdefg ``` Resultado: ``` { "CoipCidr": { "Cidr": "15.0.0.0/24", "CoipPoolId": "ipv4pool-coip-1234567890abcdefg", "LocalGatewayRouteTableId": "lgw-rtb-abcdefg1234567890" } } ``` Para obter mais informações, consulte [Endereços IP pertencentes ao cliente](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) no *Guia do usuário do AWS Outposts*. + Para ver detalhes da API, consulte [CreateCoipCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-coip-cidr.html) na *Referência de comandos da AWS CLI*. ### `create-coip-pool` O código de exemplo a seguir mostra como usar `create-coip-pool`. **AWS CLI** **Criar um pool de endereços IP de propriedade do cliente (CoIP** O exemplo `create-coip-pool` a seguir cria um pool de CoIP para endereços de CoIP na tabela de rotas do gateway local especificada. ``` aws ec2 create-coip-pool \ --local-gateway-route-table-id lgw-rtb-abcdefg1234567890 ``` Resultado: ``` { "CoipPool": { "PoolId": "ipv4pool-coip-1234567890abcdefg", "LocalGatewayRouteTableId": "lgw-rtb-abcdefg1234567890", "PoolArn": "arn:aws:ec2:us-west-2:123456789012:coip-pool/ipv4pool-coip-1234567890abcdefg" } } ``` Para obter mais informações, consulte [Endereços IP pertencentes ao cliente](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) no *Guia do usuário do AWS Outposts*. + Para ver detalhes da API, consulte [CreateCoipPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-coip-pool.html) na *Referência de comandos da AWS CLI*. ### `create-customer-gateway` O código de exemplo a seguir mostra como usar `create-customer-gateway`. **AWS CLI** **Criar um gateway do cliente** Este exemplo cria um gateway do cliente com o endereço IP especificado para sua interface externa. Comando: ``` aws ec2 create-customer-gateway --type ipsec.1 --public-ip 12.1.2.3 --bgp-asn 65534 ``` Resultado: ``` { "CustomerGateway": { "CustomerGatewayId": "cgw-0e11f167", "IpAddress": "12.1.2.3", "State": "available", "Type": "ipsec.1", "BgpAsn": "65534" } } ``` + Para ver detalhes da API, consulte [CreateCustomerGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-customer-gateway.html) na *Referência de comandos da AWS CLI*. ### `create-default-subnet` O código de exemplo a seguir mostra como usar `create-default-subnet`. **AWS CLI** **Criar uma sub-rede padrão** Este exemplo cria uma sub-rede padrão na Zona de Disponibilidade `us-east-2a`. Comando: ``` aws ec2 create-default-subnet --availability-zone us-east-2a { "Subnet": { "AvailabilityZone": "us-east-2a", "Tags": [], "AvailableIpAddressCount": 4091, "DefaultForAz": true, "Ipv6CidrBlockAssociationSet": [], "VpcId": "vpc-1a2b3c4d", "State": "available", "MapPublicIpOnLaunch": true, "SubnetId": "subnet-1122aabb", "CidrBlock": "172.31.32.0/20", "AssignIpv6AddressOnCreation": false } } ``` + Para ver detalhes da API, consulte [CreateDefaultSubnet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-default-subnet.html) na *Referência de comandos da AWS CLI*. ### `create-default-vpc` O código de exemplo a seguir mostra como usar `create-default-vpc`. **AWS CLI** **Criar uma VPC padrão** Este exemplo cria uma VPC padrão. Comando: ``` aws ec2 create-default-vpc ``` Resultado: ``` { "Vpc": { "VpcId": "vpc-8eaae5ea", "InstanceTenancy": "default", "Tags": [], "Ipv6CidrBlockAssociationSet": [], "State": "pending", "DhcpOptionsId": "dopt-af0c32c6", "CidrBlock": "172.31.0.0/16", "IsDefault": true } } ``` + Para ver detalhes da API, consulte [CreateDefaultVpc](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-default-vpc.html) na *Referência de comandos da AWS CLI*. ### `create-dhcp-options` O código de exemplo a seguir mostra como usar `create-dhcp-options`. **AWS CLI** **Criar um conjunto de opções DHCP** O exemplo `create-dhcp-options` a seguir cria um conjunto de opções DHCP que especifica o nome do domínio, os servidores de nomes de domínio e o tipo de nó NetBIOS. ``` aws ec2 create-dhcp-options \ --dhcp-configuration \ "Key=domain-name-servers,Values=10.2.5.1,10.2.5.2" \ "Key=domain-name,Values=example.com" \ "Key=netbios-node-type,Values=2" ``` Resultado: ``` { "DhcpOptions": { "DhcpConfigurations": [ { "Key": "domain-name", "Values": [ { "Value": "example.com" } ] }, { "Key": "domain-name-servers", "Values": [ { "Value": "10.2.5.1" }, { "Value": "10.2.5.2" } ] }, { "Key": "netbios-node-type", "Values": [ { "Value": "2" } ] } ], "DhcpOptionsId": "dopt-06d52773eff4c55f3" } } ``` + Para ver detalhes da API, consulte [CreateDhcpOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-dhcp-options.html) na *Referência de comandos da AWS CLI*. ### `create-egress-only-internet-gateway` O código de exemplo a seguir mostra como usar `create-egress-only-internet-gateway`. **AWS CLI** **Criar um gateway da Internet somente de saída** Este exemplo cria um gateway da Internet somente de saída para a VPC especificada. Comando: ``` aws ec2 create-egress-only-internet-gateway --vpc-id vpc-0c62a468 ``` Resultado: ``` { "EgressOnlyInternetGateway": { "EgressOnlyInternetGatewayId": "eigw-015e0e244e24dfe8a", "Attachments": [ { "State": "attached", "VpcId": "vpc-0c62a468" } ] } } ``` + Para ver detalhes da API, consulte [CreateEgressOnlyInternetGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-egress-only-internet-gateway.html) na *Referência de comandos da AWS CLI*. ### `create-fleet` O código de exemplo a seguir mostra como usar `create-fleet`. **AWS CLI** **Exemplo 1: criar uma frota EC2 que lança instâncias spot como modelo de compra padrão** O exemplo `create-fleet` a seguir cria uma Frota EC2 usando os parâmetros mínimos necessários para lançar uma frota: um modelo de execução, a capacidade de destino e o modelo de compra padrão. O modelo de execução é identificado pelo ID do seu modelo de execução e o número da versão. A capacidade de destino da frota é de 2 instâncias, e o modelo de compra padrão é `spot`. Isso faz com que a frota execute duas Instâncias spot. Quando você cria um Frota do EC2, use um arquivo JSON para especificar informações sobre as instâncias a serem executadas. ``` aws ec2 create-fleet \ --cli-input-json file://file_name.json ``` Conteúdo do file\$1name.json: ``` { "LaunchTemplateConfigs": [ { "LaunchTemplateSpecification": { "LaunchTemplateId": "lt-0e8c754449b27161c", "Version": "1" } } ], "TargetCapacitySpecification": { "TotalTargetCapacity": 2, "DefaultTargetCapacityType": "spot" } } ``` Resultado: ``` { "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" } ``` **Exemplo 2: criar uma Frota EC2 que lança instâncias sob demanda como modelo de compra padrão** O exemplo `create-fleet` a seguir cria uma Frota EC2 usando os parâmetros mínimos necessários para lançar uma frota: um modelo de execução, a capacidade de destino e o modelo de compra padrão. O modelo de execução é identificado pelo ID do seu modelo de execução e o número da versão. A capacidade de destino da frota é de duas instâncias, e o modelo de compra padrão é `on-demand`. Isso faz com que a frota execute duas Instâncias sob demanda. Quando você cria um Frota do EC2, use um arquivo JSON para especificar informações sobre as instâncias a serem executadas. ``` aws ec2 create-fleet \ --cli-input-json file://file_name.json ``` Conteúdo do file\$1name.json: ``` { "LaunchTemplateConfigs": [ { "LaunchTemplateSpecification": { "LaunchTemplateId": "lt-0e8c754449b27161c", "Version": "1" } } ], "TargetCapacitySpecification": { "TotalTargetCapacity": 2, "DefaultTargetCapacityType": "on-demand" } } ``` Resultado: ``` { "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" } ``` **Exemplo 3: criar uma Frota EC2 que lança Instâncias sob demanda como a capacidade principal** O exemplo `create-fleet` a seguir cria uma Frota EC2 que especifica a capacidade total de destino de duas instâncias para a frota e uma capacidade de destino de uma instância sob demanda. O modelo de compra padrão é `spot`. A frota executa uma instância sob demanda, conforme especificado, mas precisa executar mais uma instância para atender à capacidade total desejada. O modelo de compra para a diferença é calculado como `TotalTargetCapacity` - `OnDemandTargetCapacity` = `DefaultTargetCapacityType`, o que resulta na frota executando uma instância spot. Quando você cria um Frota do EC2, use um arquivo JSON para especificar informações sobre as instâncias a serem executadas. ``` aws ec2 create-fleet \ --cli-input-json file://file_name.json ``` Conteúdo do file\$1name.json: ``` { "LaunchTemplateConfigs": [ { "LaunchTemplateSpecification": { "LaunchTemplateId": "lt-0e8c754449b27161c", "Version": "1" } } ], "TargetCapacitySpecification": { "TotalTargetCapacity": 2, "OnDemandTargetCapacity":1, "DefaultTargetCapacityType": "spot" } } ``` Resultado: ``` { "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" } ``` **Exemplo 4: criar uma frota EC2 que lança instâncias spot usando a estratégia de alocação de menor preço** Se a estratégia de alocação para Instâncias spot não for especificada, a estratégia de alocação padrão, `lowest-price`, será usada. O exemplo `create-fleet` a seguir cria uma frota EC2 usando a estratégia de alocação `lowest-price`. As três especificações de execução, que substituem o modelo de execução, têm tipos de instância diferentes, mas a mesma capacidade ponderada e sub-rede. A capacidade de destino total é de duas instâncias, e o modelo de compra padrão é `spot`. A Frota do EC2 executa duas Instâncias spot usando o tipo de instância da especificação de execução com o menor preço. Quando você cria um Frota do EC2, use um arquivo JSON para especificar informações sobre as instâncias a serem executadas. ``` aws ec2 create-fleet \ --cli-input-json file://file_name.jsonContents of file_name.json:: { "LaunchTemplateConfigs": [ { "LaunchTemplateSpecification": { "LaunchTemplateId": "lt-0e8c754449b27161c", "Version": "1" }, "Overrides": [ { "InstanceType": "c4.large", "WeightedCapacity": 1, "SubnetId": "subnet-a4f6c5d3" }, { "InstanceType": "c3.large", "WeightedCapacity": 1, "SubnetId": "subnet-a4f6c5d3" }, { "InstanceType": "c5.large", "WeightedCapacity": 1, "SubnetId": "subnet-a4f6c5d3" } ] } ], "TargetCapacitySpecification": { "TotalTargetCapacity": 2, "DefaultTargetCapacityType": "spot" } } ``` Resultado: ``` { "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" } ``` + Para ver detalhes da API, consulte [CreateFleet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-fleet.html) na *Referência de comandos da AWS CLI*. ### `create-flow-logs` O código de exemplo a seguir mostra como usar `create-flow-logs`. **AWS CLI** **Exemplo 1: criar um log de fluxo** O exemplo `create-flow-logs` a seguir cria um log de fluxo que captura todo o tráfego rejeitado para a interface de rede especificada. Os logs de fluxo são entregues a um grupo de logs no CloudWatch Logs usando as permissões no perfil do IAM especificado. ``` aws ec2 create-flow-logs \ --resource-type NetworkInterface \ --resource-ids eni-11223344556677889 \ --traffic-type REJECT \ --log-group-name my-flow-logs \ --deliver-logs-permission-arn arn:aws:iam::123456789101:role/publishFlowLogs ``` Resultado: ``` { "ClientToken": "so0eNA2uSHUNlHI0S2cJ305GuIX1CezaRdGtexample", "FlowLogIds": [ "fl-12345678901234567" ], "Unsuccessful": [] } ``` Para obter mais informações, consulte [Logs de fluxo da VPC](https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html) no *Guia do usuário do Amazon Virtual Private Cloud*. **Exemplo 2: criar um log de fluxo com um formato personalizado** O exemplo `create-flow-logs` a seguir cria um log de fluxo que captura todo o tráfego da VPC especificada e fornece os logs de fluxo a um bucket do Amazon S3. O parâmetro `--log-format` especifica um formato personalizado para os registros de log de fluxo. Para executar esse comando no Windows, altere as aspas simples (') para aspas duplas ("). ``` aws ec2 create-flow-logs \ --resource-type VPC \ --resource-ids vpc-00112233344556677 \ --traffic-type ALL \ --log-destination-type s3 \ --log-destination arn:aws:s3:::flow-log-bucket/my-custom-flow-logs/ \ --log-format '${version} ${vpc-id} ${subnet-id} ${instance-id} ${srcaddr} ${dstaddr} ${srcport} ${dstport} ${protocol} ${tcp-flags} ${type} ${pkt-srcaddr} ${pkt-dstaddr}' ``` Para obter mais informações, consulte [Logs de fluxo da VPC](https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html) no *Guia do usuário do Amazon Virtual Private Cloud*. **Exemplo 3: criar um log de fluxo com um intervalo máximo de agregação de um minuto** O exemplo `create-flow-logs` a seguir cria um log de fluxo que captura todo o tráfego da VPC especificada e fornece os logs de fluxo a um bucket do Amazon S3. O parâmetro `--max-aggregation-interval` especifica um intervalo de agregação máximo de 60 segundos (um minuto). ``` aws ec2 create-flow-logs \ --resource-type VPC \ --resource-ids vpc-00112233344556677 \ --traffic-type ALL \ --log-destination-type s3 \ --log-destination arn:aws:s3:::flow-log-bucket/my-custom-flow-logs/ \ --max-aggregation-interval 60 ``` Para obter mais informações, consulte [Logs de fluxo da VPC](https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html) no *Guia do usuário do Amazon Virtual Private Cloud*. + Para ver detalhes da API, consulte [CreateFlowLogs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-flow-logs.html) na *Referência de comandos da AWS CLI*. ### `create-fpga-image` O código de exemplo a seguir mostra como usar `create-fpga-image`. **AWS CLI** **Criar uma imagem Amazon FPGA** Este exemplo cria uma AFI do tarball especificado no bucket especificado. Comando: ``` aws ec2 create-fpga-image --name my-afi --description test-afi --input-storage-location Bucket=my-fpga-bucket,Key=dcp/17_12_22-103226.Developer_CL.tar --logs-storage-location Bucket=my-fpga-bucket,Key=logs ``` Resultado: ``` { "FpgaImageId": "afi-0d123e123bfc85abc", "FpgaImageGlobalId": "agfi-123cb27b5e84a0abc" } ``` + Para ver detalhes da API, consulte [CreateFpgaImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-fpga-image.html) na *Referência de comandos da AWS CLI*. ### `create-image` O código de exemplo a seguir mostra como usar `create-image`. **AWS CLI** **Exemplo 1: criar uma AMI de uma instância com Amazon EBS** O exemplo `create-image` a seguir cria uma AMI da instância especificada. ``` aws ec2 create-image \ --instance-id i-1234567890abcdef0 \ --name "My server" \ --description "An AMI for my server" ``` Resultado: ``` { "ImageId": "ami-abcdef01234567890" } ``` Para obter mais informações sobre especificar um mapeamento de dispositivos de blocos para sua AMI, consulte [Especificar um mapeamento de dispositivos de blocos para AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html#create-ami-bdm) no *Guia do usuário do Amazon EC2*. **Exemplo 2: criar uma AMI de uma instância baseada no Amazon EBS sem reinicializar** O exemplo `create-image` a seguir cria uma AMI e define o parâmetro --no-reboot, para que a instância não seja reinicializada antes da criação da imagem. ``` aws ec2 create-image \ --instance-id i-1234567890abcdef0 \ --name "My server" \ --no-reboot ``` Resultado: ``` { "ImageId": "ami-abcdef01234567890" } ``` Para obter mais informações sobre especificar um mapeamento de dispositivos de blocos para sua AMI, consulte [Especificar um mapeamento de dispositivos de blocos para AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html#create-ami-bdm) no *Guia do usuário do Amazon EC2*. **Exemplo 3: aplicar tag em uma AMI e snapshots na criação** O exemplo `create-image` a seguir cria uma AMI e aplica uma tag na AMI e nos snapshots com a mesma tag `cost-center=cc123` ``` aws ec2 create-image \ --instance-id i-1234567890abcdef0 \ --name "My server" \ --tag-specifications "ResourceType=image,Tags=[{Key=cost-center,Value=cc123}]" "ResourceType=snapshot,Tags=[{Key=cost-center,Value=cc123}]" ``` Resultado: ``` { "ImageId": "ami-abcdef01234567890" } ``` Para obter mais informações sobre como aplicar tags em seus recursos na criação, consulte [Adicionar tags na criação de recursos](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-on-create-examples) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [CreateImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-image.html) na *Referência de comandos da AWS CLI*. ### `create-instance-connect-endpoint` O código de exemplo a seguir mostra como usar `create-instance-connect-endpoint`. **AWS CLI** **Criar um endpoint de conexão da instância EC** O exemplo `create-instance-connect-endpoint` a seguir cria um Endpoint de Conexão da Instância EC2 na sub-rede especificada. ``` aws ec2 create-instance-connect-endpoint \ --region us-east-1 \ --subnet-id subnet-0123456789example ``` Resultado: ``` { "VpcId": "vpc-0123abcd", "InstanceConnectEndpointArn": "arn:aws:ec2:us-east-1:111111111111:instance-connect-endpoint/eice-0123456789example", "AvailabilityZone": "us-east-1a", "NetworkInterfaceIds": [ "eni-0123abcd" ], "PreserveClientIp": true, "Tags": [], "FipsDnsName": "eice-0123456789example.0123abcd.fips.ec2-instance-connect-endpoint.us-east-1.amazonaws.com", "StateMessage": "", "State": "create-complete", "DnsName": "eice-0123456789example.0123abcd.ec2-instance-connect-endpoint.us-east-1.amazonaws.com", "SubnetId": "subnet-0123abcd", "OwnerId": "111111111111", "SecurityGroupIds": [ "sg-0123abcd" ], "InstanceConnectEndpointId": "eice-0123456789example", "CreatedAt": "2023-04-07T15:43:53.000Z" } ``` Para obter mais informações, consulte [Criar um endpoint de conexão de instância EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-ec2-instance-connect-endpoints.html) no *Guiado usuário do Amazon EC2*. + Para ver detalhes da API, consulte [CreateInstanceConnectEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-instance-connect-endpoint.html) na *Referência de comandos da AWS CLI*. ### `create-instance-event-window` O código de exemplo a seguir mostra como usar `create-instance-event-window`. **AWS CLI** **Exemplo 1: criar uma janela de eventos com um intervalo de tempo** O exemplo `create-instance-event-window` a seguir cria uma janela de eventos com um intervalo de tempo. Você também deve especificar o parâmetro `cron-expression`. ``` aws ec2 create-instance-event-window \ --region us-east-1 \ --time-range StartWeekDay=monday,StartHour=2,EndWeekDay=wednesday,EndHour=8 \ --tag-specifications "ResourceType=instance-event-window,Tags=[{Key=K1,Value=V1}]" \ --name myEventWindowName ``` Resultado: ``` { "InstanceEventWindow": { "InstanceEventWindowId": "iew-0abcdef1234567890", "TimeRanges": [ { "StartWeekDay": "monday", "StartHour": 2, "EndWeekDay": "wednesday", "EndHour": 8 } ], "Name": "myEventWindowName", "State": "creating", "Tags": [ { "Key": "K1", "Value": "V1" } ] } } ``` Para restrições da janela de eventos, consulte [Considerações](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations) na seção Eventos Programados do *Guia do usuário do Amazon EC2*. **Exemplo 2: criar uma janela de eventos com uma expressão cron** O exemplo `create-instance-event-window` a seguir cria uma janela de eventos com uma expressão cron. Você também deve especificar o parâmetro `time-range`. ``` aws ec2 create-instance-event-window \ --region us-east-1 \ --cron-expression "* 21-23 * * 2,3" \ --tag-specifications "ResourceType=instance-event-window,Tags=[{Key=K1,Value=V1}]" \ --name myEventWindowName ``` Resultado: ``` { "InstanceEventWindow": { "InstanceEventWindowId": "iew-0abcdef1234567890", "Name": "myEventWindowName", "CronExpression": "* 21-23 * * 2,3", "State": "creating", "Tags": [ { "Key": "K1", "Value": "V1" } ] } } ``` Para restrições da janela de eventos, consulte [Considerações](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations) na seção Eventos Programados do *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [CreateInstanceEventWindow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-instance-event-window.html) na *Referência de comandos da AWS CLI*. ### `create-instance-export-task` O código de exemplo a seguir mostra como usar `create-instance-export-task`. **AWS CLI** **Exportar uma instância** Esse comando de exemplo cria uma tarefa para exportar a instância i-1234567890abcdef0 para o bucket myexportbucket do Amazon S3. Comando: ``` aws ec2 create-instance-export-task --description "RHEL5 instance" --instance-id i-1234567890abcdef0 --target-environment vmware --export-to-s3-task DiskImageFormat=vmdk,ContainerFormat=ova,S3Bucket=myexportbucket,S3Prefix=RHEL5 ``` Resultado: ``` { "ExportTask": { "State": "active", "InstanceExportDetails": { "InstanceId": "i-1234567890abcdef0", "TargetEnvironment": "vmware" }, "ExportToS3Task": { "S3Bucket": "myexportbucket", "S3Key": "RHEL5export-i-fh8sjjsq.ova", "DiskImageFormat": "vmdk", "ContainerFormat": "ova" }, "Description": "RHEL5 instance", "ExportTaskId": "export-i-fh8sjjsq" } } ``` + Para ver detalhes da API, consulte [CreateInstanceExportTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-instance-export-task.html) na *Referência de comandos da AWS CLI*. ### `create-internet-gateway` O código de exemplo a seguir mostra como usar `create-internet-gateway`. **AWS CLI** **Criar um gateway da Internet** O exemplo `create-internet-gateway` a seguir cria um gateway da Internet com a tag `Name=my-igw`. ``` aws ec2 create-internet-gateway \ --tag-specifications ResourceType=internet-gateway,Tags=[{Key=Name,Value=my-igw}] ``` Resultado: ``` { "InternetGateway": { "Attachments": [], "InternetGatewayId": "igw-0d0fb496b3994d755", "OwnerId": "123456789012", "Tags": [ { "Key": "Name", "Value": "my-igw" } ] } } ``` Para obter mais informações, consulte [Gateways da Internet](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html) no *Guia do usuário da Amazon VPC*. + Para ver detalhes da API, consulte [CreateInternetGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-internet-gateway.html) na *Referência de comandos da AWS CLI*. ### `create-ipam-pool` O código de exemplo a seguir mostra como usar `create-ipam-pool`. **AWS CLI** **Criar um pool IPAM** O exemplo `create-ipam-pool` a seguir cria um pool IPAM. (Linux): ``` aws ec2 create-ipam-pool \ --ipam-scope-id ipam-scope-02fc38cd4c48e7d38 \ --address-family ipv4 \ --auto-import \ --allocation-min-netmask-length 16 \ --allocation-max-netmask-length 26 \ --allocation-default-netmask-length 24 \ --allocation-resource-tags "Key=Environment,Value=Preprod" \ --tag-specifications 'ResourceType=ipam-pool,Tags=[{Key=Name,Value="Preprod pool"}]' ``` (Windows): ``` aws ec2 create-ipam-pool ^ --ipam-scope-id ipam-scope-02fc38cd4c48e7d38 ^ --address-family ipv4 ^ --auto-import ^ --allocation-min-netmask-length 16 ^ --allocation-max-netmask-length 26 ^ --allocation-default-netmask-length 24 ^ --allocation-resource-tags "Key=Environment,Value=Preprod" ^ --tag-specifications ResourceType=ipam-pool,Tags=[{Key=Name,Value="Preprod pool"}] ``` Resultado: ``` { "IpamPool": { "OwnerId": "123456789012", "IpamPoolId": "ipam-pool-0533048da7d823723", "IpamPoolArn": "arn:aws:ec2::123456789012:ipam-pool/ipam-pool-0533048da7d823723", "IpamScopeArn": "arn:aws:ec2::123456789012:ipam-scope/ipam-scope-02fc38cd4c48e7d38", "IpamScopeType": "private", "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-08440e7a3acde3908", "IpamRegion": "us-east-1", "Locale": "None", "PoolDepth": 1, "State": "create-in-progress", "AutoImport": true, "AddressFamily": "ipv4", "AllocationMinNetmaskLength": 16, "AllocationMaxNetmaskLength": 26, "AllocationDefaultNetmaskLength": 24, "AllocationResourceTags": [ { "Key": "Environment", "Value": "Preprod" } ], "Tags": [ { "Key": "Name", "Value": "Preprod pool" } ] } } ``` Para obter mais informações, consulte [Planos para provisionamento de endereços IP](https://docs.aws.amazon.com/vpc/latest/ipam/planning-ipam.html), no *Guia do usuário da Amazon VPC IPAM*. + Para ver detalhes da API, consulte [CreateIpamPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-ipam-pool.html) na *Referência de comandos da AWS CLI*. ### `create-ipam-resource-discovery` O código de exemplo a seguir mostra como usar `create-ipam-resource-discovery`. **AWS CLI** **Criar uma descoberta de recursos** Neste exemplo, você é um administrador delegado do IPAM que deseja criar e compartilhar uma descoberta de recursos com o administrador do IPAM em outra AWS Organization para que o administrador da outra organização possa gerenciar e monitorar os endereços IP dos recursos em sua organização. Importante Este exemplo inclui as opções `--region` e `--operating-regions` porque, embora sejam opcionais, elas devem ser configuradas de uma maneira específica para integrar com êxito uma descoberta de recursos a um IPAM. \$1 `--operating-regions` deve corresponder às regiões em que você tem recursos que deseja que o IPAM descubra. Se houver regiões nas quais você não deseja que o IPAM gerencie os endereços IP (por exemplo, por motivos de conformidade), não as inclua. \$1 `--region` deve corresponder à região de origem do IPAM ao qual você deseja associá-lo. Você deve criar a descoberta de recurso na mesma região em que o IPAM foi criado. Por exemplo, se o IPAM ao qual você está se associando foi criado em us-east-1, inclua `--region us-east-1` na solicitação. As opções `--region` e `--operating-regions` assumem como padrão a região em que você está executando o comando, caso você não as especifique. Neste exemplo, as regiões operacionais do IPAM com as quais estamos integrando incluem `us-west-1`, `us-west-2` e `ap-south-1`. Quando criamos a descoberta de recursos, queremos que o IPAM descubra os endereços IP dos recursos em `us-west-1` e `us-west-2`, mas não em `ap-south-1`. Portanto, estamos incluindo apenas `--operating-regions RegionName='us-west-1' RegionName='us-west-2'` na solicitação. O exemplo `create-ipam-resource-discovery` a seguir cria uma descoberta de recurso IPAM. ``` aws ec2 create-ipam-resource-discovery \ --description 'Example-resource-discovery' \ --tag-specifications 'ResourceType=ipam-resource-discovery,Tags=[{Key=cost-center,Value=cc123}]' \ --operating-regions RegionName='us-west-1' RegionName='us-west-2' \ --region us-east-1 ``` Resultado: ``` { "IpamResourceDiscovery":{ "OwnerId": "149977607591", "IpamResourceDiscoveryId": "ipam-res-disco-0257046d8aa78b8bc", "IpamResourceDiscoveryArn": "arn:aws:ec2::149977607591:ipam-resource-discovery/ipam-res-disco-0257046d8aa78b8bc", "IpamResourceDiscoveryRegion": "us-east-1", "Description": "'Example-resource-discovery'", "OperatingRegions":[ {"RegionName": "us-west-1"}, {"RegionName": "us-west-2"}, {"RegionName": "us-east-1"} ], "IsDefault": false, "State": "create-in-progress", "Tags": [ { "Key": "cost-center", "Value": "cc123" } ] } ``` Depois de criar uma descoberta de recursos, talvez você queira compartilhá-la com outro administrador delegado do IPAM, o que pode ser feito com [create-resource-share](https://docs.aws.amazon.com/cli/latest/reference/ram/create-resource-share.html). Para obter mais informações, consulte [Integrar o IPAM com contas fora da sua organização](https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam-outside-org.html) no *Guia do usuário do IPAM da Amazon VPC*. + Para ver detalhes da API, consulte [CreateIpamResourceDiscovery](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-ipam-resource-discovery.html) na *Referência de comandos da AWS CLI*. ### `create-ipam-scope` O código de exemplo a seguir mostra como usar `create-ipam-scope`. **AWS CLI** **Criar um escopo IPAM** O exemplo `create-ipam-scope` a seguir cria um escopo IPAM. (Linux): ``` aws ec2 create-ipam-scope \ --ipam-id ipam-08440e7a3acde3908 \ --description "Example description" \ --tag-specifications 'ResourceType=ipam-scope,Tags=[{Key=Name,Value="Example name value"}]' ``` (Windows): ``` aws ec2 create-ipam-scope ^ --ipam-id ipam-08440e7a3acde3908 ^ --description "Example description" ^ --tag-specifications ResourceType=ipam-scope,Tags=[{Key=Name,Value="Example name value"}] ``` Resultado: ``` { "IpamScope": { "OwnerId": "123456789012", "IpamScopeId": "ipam-scope-01c1ebab2b63bd7e4", "IpamScopeArn": "arn:aws:ec2::123456789012:ipam-scope/ipam-scope-01c1ebab2b63bd7e4", "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-08440e7a3acde3908", "IpamRegion": "us-east-1", "IpamScopeType": "private", "IsDefault": false, "Description": "Example description", "PoolCount": 0, "State": "create-in-progress", "Tags": [ { "Key": "Name", "Value": "Example name value" } ] } } ``` Para obter mais informações, consulte [Criar escopos adicionais](https://docs.aws.amazon.com/vpc/latest/ipam/add-scope-ipam.html) no *Guia do usuário do IPAM da Amazon VPC*. + Para ver detalhes da API, consulte [CreateIpamScope](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-ipam-scope.html) na *Referência de comandos da AWS CLI*. ### `create-ipam` O código de exemplo a seguir mostra como usar `create-ipam`. **AWS CLI** **Criar um IPAM** O exemplo `create-ipam` a seguir cria um IPAM. (Linux): ``` aws ec2 create-ipam \ --description "Example description" \ --operating-regions "RegionName=us-east-2" "RegionName=us-west-1" \ --tag-specifications 'ResourceType=ipam,Tags=[{Key=Name,Value=ExampleIPAM}]' ``` (Windows): ``` aws ec2 create-ipam ^ --description "Example description" ^ --operating-regions "RegionName=us-east-2" "RegionName=us-west-1" ^ --tag-specifications ResourceType=ipam,Tags=[{Key=Name,Value=ExampleIPAM}] ``` Resultado: ``` { "Ipam": { "OwnerId": "123456789012", "IpamId": "ipam-036486dfa6af58ee0", "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-036486dfa6af58ee0", "IpamRegion": "us-east-1", "PublicDefaultScopeId": "ipam-scope-071b8042b0195c183", "PrivateDefaultScopeId": "ipam-scope-0807405dece705a30", "ScopeCount": 2, "OperatingRegions": [ { "RegionName": "us-east-2" }, { "RegionName": "us-west-1" }, { "RegionName": "us-east-1" } ], "State": "create-in-progress", "Tags": [ { "Key": "Name", "Value": "ExampleIPAM" } ] } } ``` Para obter mais informações, consulte [Criar um IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html) no *Guia do usuário do IPAM da Amazon VPC*. + Para ver detalhes da API, consulte [CreateIpam](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-ipam.html) na *Referência de comandos da AWS CLI*. ### `create-key-pair` O código de exemplo a seguir mostra como usar `create-key-pair`. **AWS CLI** **Para criar um par de chaves** Este exemplo cria um par de chaves denominado `MyKeyPair`. Comando: ``` aws ec2 create-key-pair --key-name MyKeyPair ``` A saída é uma versão ASCII da chave privada e da impressão digital da chave. Você precisa salvar a chave em um arquivo. Para obter mais informações, consulte Using Key Pairs no *Guia do usuário da AWS Command Line Interface*. + Consulte detalhes da API em [CreateKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-key-pair.html) na *Referência de comandos da AWS CLI*. ### `create-launch-template-version` O código de exemplo a seguir mostra como usar `create-launch-template-version`. **AWS CLI** **Criar uma versão de modelo de inicialização** Este exemplo cria uma nova versão do modelo de lançamento com base na versão 1 do modelo de execução e especifica um ID de AMI diferente. Comando: ``` aws ec2 create-launch-template-version --launch-template-id lt-0abcd290751193123 --version-description WebVersion2 --source-version 1 --launch-template-data '{"ImageId":"ami-c998b6b2"}' ``` Resultado: ``` { "LaunchTemplateVersion": { "VersionDescription": "WebVersion2", "LaunchTemplateId": "lt-0abcd290751193123", "LaunchTemplateName": "WebServers", "VersionNumber": 2, "CreatedBy": "arn:aws:iam::123456789012:root", "LaunchTemplateData": { "ImageId": "ami-c998b6b2", "InstanceType": "t2.micro", "NetworkInterfaces": [ { "Ipv6Addresses": [ { "Ipv6Address": "2001:db8:1234:1a00::123" } ], "DeviceIndex": 0, "SubnetId": "subnet-7b16de0c", "AssociatePublicIpAddress": true } ] }, "DefaultVersion": false, "CreateTime": "2017-12-01T13:35:46.000Z" } } ``` + Para ver detalhes da API, consulte [CreateLaunchTemplateVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-launch-template-version.html) na *Referência de comandos da AWS CLI*. ### `create-launch-template` O código de exemplo a seguir mostra como usar `create-launch-template`. **AWS CLI** **Exemplo 1: criar um modelo de lançamento** O exemplo `create-launch-template` a seguir cria um modelo de execução que especifica a sub-rede na qual executar a instância, atribui um endereço IP público e um endereço IPv6 à instância e cria uma tag para a instância. ``` aws ec2 create-launch-template \ --launch-template-name TemplateForWebServer \ --version-description WebVersion1 \ --launch-template-data '{"NetworkInterfaces":[{"AssociatePublicIpAddress":true,"DeviceIndex":0,"Ipv6AddressCount":1,"SubnetId":"subnet-7b16de0c"}],"ImageId":"ami-8c1be5f6","InstanceType":"t2.small","TagSpecifications":[{"ResourceType":"instance","Tags":[{"Key":"purpose","Value":"webserver"}]}]}' ``` Resultado: ``` { "LaunchTemplate": { "LatestVersionNumber": 1, "LaunchTemplateId": "lt-01238c059e3466abc", "LaunchTemplateName": "TemplateForWebServer", "DefaultVersionNumber": 1, "CreatedBy": "arn:aws:iam::123456789012:user/Bob", "CreateTime": "2019-01-27T09:13:24.000Z" } } ``` Para obter mais informações, consulte Execução de uma instância em um modelo de execução no *Guia do usuário do Amazon Elastic Compute Cloud*. Para obter informações sobre como citar parâmetros formatados em JSON, consulte Uso de aspas com strings no *Guia do usuário da AWS Command Line Interface*. **Exemplo 2: para criar um modelo de execução para o Amazon EC2 Auto Scaling** O exemplo `create-launch-template` a seguir cria um modelo de execução com várias tags e um mapeamento de dispositivos de blocos para especificar um volume adicional do EBS quando uma instância é executada. Especifique um valor para `Groups` que corresponda aos grupos de segurança da VPC na qual o seu grupo do Auto Scaling executará as instâncias. Especifique a VPC e as sub-redes como propriedades do grupo do Auto Scaling. ``` aws ec2 create-launch-template \ --launch-template-name TemplateForAutoScaling \ --version-description AutoScalingVersion1 \ --launch-template-data '{"NetworkInterfaces":[{"DeviceIndex":0,"AssociatePublicIpAddress":true,"Groups":["sg-7c227019,sg-903004f8"],"DeleteOnTermination":true}],"ImageId":"ami-b42209de","InstanceType":"m4.large","TagSpecifications":[{"ResourceType":"instance","Tags":[{"Key":"environment","Value":"production"},{"Key":"purpose","Value":"webserver"}]},{"ResourceType":"volume","Tags":[{"Key":"environment","Value":"production"},{"Key":"cost-center","Value":"cc123"}]}],"BlockDeviceMappings":[{"DeviceName":"/dev/sda1","Ebs":{"VolumeSize":100}}]}' --region us-east-1 ``` Resultado: ``` { "LaunchTemplate": { "LatestVersionNumber": 1, "LaunchTemplateId": "lt-0123c79c33a54e0abc", "LaunchTemplateName": "TemplateForAutoScaling", "DefaultVersionNumber": 1, "CreatedBy": "arn:aws:iam::123456789012:user/Bob", "CreateTime": "2019-04-30T18:16:06.000Z" } } ``` Para obter mais informações, consulte Como criar um modelo de execução para um grupo do Auto Scaling no *Guia do usuário do Amazon EC2 Auto Scaling*. Para obter informações sobre como citar parâmetros formatados em JSON, consulte Uso de aspas com strings no *Guia do usuário da AWS Command Line Interface*. **Exemplo 3: criar um modelo de execução que especifique a criptografia dos volumes do EBS** O exemplo `create-launch-template` a seguir cria um modelo de execução que inclui volumes criptografados do EBS criados de um snapshot não criptografado. Ele também coloca tags nos volumes durante a criação. Se a criptografia por padrão estiver desabilitada, você deve especificar a opção `"Encrypted"` conforme mostrado no exemplo a seguir. Se você usar a opção `"KmsKeyId"` para especificar uma CMK gerenciada pelo cliente, também deverá especificar a opção `"Encrypted"` mesmo que a criptografia por padrão esteja habilitada. ``` aws ec2 create-launch-template \ --launch-template-name TemplateForEncryption \ --launch-template-data file://config.json ``` Conteúdo de `config.json`: ``` { "BlockDeviceMappings":[ { "DeviceName":"/dev/sda1", "Ebs":{ "VolumeType":"gp2", "DeleteOnTermination":true, "SnapshotId":"snap-066877671789bd71b", "Encrypted":true, "KmsKeyId":"arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef" } } ], "ImageId":"ami-00068cd7555f543d5", "InstanceType":"c5.large", "TagSpecifications":[ { "ResourceType":"volume", "Tags":[ { "Key":"encrypted", "Value":"yes" } ] } ] } ``` Resultado: ``` { "LaunchTemplate": { "LatestVersionNumber": 1, "LaunchTemplateId": "lt-0d5bd51bcf8530abc", "LaunchTemplateName": "TemplateForEncryption", "DefaultVersionNumber": 1, "CreatedBy": "arn:aws:iam::123456789012:user/Bob", "CreateTime": "2020-01-07T19:08:36.000Z" } } ``` Para obter mais informações, consulte Restoring an Amazon EBS Volume from a Snapshot and Encryption by Default no *Guia do usuário do Amazon Elastic Compute Cloud*. + Consulte detalhes da API em [CreateLaunchTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-launch-template.html) na *Referência de comandos da AWS CLI*. ### `create-local-gateway-route-table-virtual-interface-group-association` O código de exemplo a seguir mostra como usar `create-local-gateway-route-table-virtual-interface-group-association`. **AWS CLI** **Associar uma tabela de rotas de gateway local a um grupo de interfaces virtuais (VIFs** O exemplo `create-local-gateway-route-table-virtual-interface-group-association` a seguir cria uma associação entre a tabela de rotas do gateway local especificada e o grupo VIF. ``` aws ec2 create-local-gateway-route-table-virtual-interface-group-association \ --local-gateway-route-table-id lgw-rtb-exampleidabcd1234 \ --local-gateway-virtual-interface-group-id lgw-vif-grp-exampleid0123abcd ``` Resultado: ``` { "LocalGatewayRouteTableVirtualInterfaceGroupAssociation": { "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId": "lgw-vif-grp-assoc-exampleid12345678", "LocalGatewayVirtualInterfaceGroupId": "lgw-vif-grp-exampleid0123abcd", "LocalGatewayId": "lgw-exampleid11223344", "LocalGatewayRouteTableId": "lgw-rtb-exampleidabcd1234", "LocalGatewayRouteTableArn": "arn:aws:ec2:us-west-2:111122223333:local-gateway-route-table/lgw-rtb-exampleidabcd1234", "OwnerId": "111122223333", "State": "pending", "Tags": [] } } ``` Para obter mais informações, consulte [Associações de grupo VIF](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#vif-group-associations) no *Guia do usuário do AWS Outposts*. + Para ver detalhes da API, consulte [CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-local-gateway-route-table-virtual-interface-group-association.html) na *Referência de comandos da AWS CLI*. ### `create-local-gateway-route-table-vpc-association` O código de exemplo a seguir mostra como usar `create-local-gateway-route-table-vpc-association`. **AWS CLI** **Associar uma VPC a uma tabela de rotas** O exemplo `create-local-gateway-route-table-vpc-association` a seguir associa a VPC especificada à tabela de rotas do gateway local especificada. ``` aws ec2 create-local-gateway-route-table-vpc-association \ --local-gateway-route-table-id lgw-rtb-059615ef7dEXAMPLE \ --vpc-id vpc-07ef66ac71EXAMPLE ``` Resultado: ``` { "LocalGatewayRouteTableVpcAssociation": { "LocalGatewayRouteTableVpcAssociationId": "lgw-vpc-assoc-0ee765bcc8EXAMPLE", "LocalGatewayRouteTableId": "lgw-rtb-059615ef7dEXAMPLE", "LocalGatewayId": "lgw-09b493aa7cEXAMPLE", "VpcId": "vpc-07ef66ac71EXAMPLE", "State": "associated" } } ``` + Para ver detalhes da API, consulte [CreateLocalGatewayRouteTableVpcAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-local-gateway-route-table-vpc-association.html) na *Referência de comandos da AWS CLI*. ### `create-local-gateway-route-table` O código de exemplo a seguir mostra como usar `create-local-gateway-route-table`. **AWS CLI** **Criar uma rota da tabela de rotas de gateway local** O exemplo `create-local-gateway-route-table` a seguir cria uma tabela de rotas de gateway local com o modo de roteamento VPC direto com o modo de roteamento direto da VPC. ``` aws ec2 create-local-gateway-route-table \ --local-gateway-id lgw-1a2b3c4d5e6f7g8h9 \ --mode direct-vpc-routing ``` Resultado: ``` { "LocalGatewayRouteTable": { "LocalGatewayRouteTableId": "lgw-rtb-abcdefg1234567890", "LocalGatewayRouteTableArn": "arn:aws:ec2:us-west-2:111122223333:local-gateway-route-table/lgw-rtb-abcdefg1234567890", "LocalGatewayId": "lgw-1a2b3c4d5e6f7g8h9", "OutpostArn": "arn:aws:outposts:us-west-2:111122223333:outpost/op-021345abcdef67890", "OwnerId": "111122223333", "State": "pending", "Tags": [], "Mode": "direct-vpc-routing" } } ``` [Para obter mais informações, consulte Tabelas de rotas do gateway local](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html) no *Guia do usuário do AWS Outposts*. + Para ver detalhes da API, consulte [CreateLocalGatewayRouteTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-local-gateway-route-table.html) na *Referência de comandos da AWS CLI*. ### `create-local-gateway-route` O código de exemplo a seguir mostra como usar `create-local-gateway-route`. **AWS CLI** **Criar uma rota estática para uma tabela de rotas do gateway local** O exemplo `create-local-gateway-route` a seguir cria a rota especificada na tabela de rotas do gateway local especificada. ``` aws ec2 create-local-gateway-route \ --destination-cidr-block 0.0.0.0/0 \ --local-gateway-route-table-id lgw-rtb-059615ef7dEXAMPLE ``` Resultado: ``` { "Route": { "DestinationCidrBlock": "0.0.0.0/0", "LocalGatewayVirtualInterfaceGroupId": "lgw-vif-grp-07145b276bEXAMPLE", "Type": "static", "State": "deleted", "LocalGatewayRouteTableId": "lgw-rtb-059615ef7dEXAMPLE" } } ``` + Para ver detalhes da API, consulte [CreateLocalGatewayRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-local-gateway-route.html) na *Referência de comandos da AWS CLI*. ### `create-managed-prefix-list` O código de exemplo a seguir mostra como usar `create-managed-prefix-list`. **AWS CLI** **Criar uma lista de prefixos** O exemplo `create-managed-prefix-list` a seguir cria uma lista de prefixos IPv4 com um máximo de 10 entradas e cria duas entradas na lista de prefixos. ``` aws ec2 create-managed-prefix-list \ --address-family IPv4 \ --max-entries 10 \ --entries Cidr=10.0.0.0/16,Description=vpc-a Cidr=10.2.0.0/16,Description=vpc-b \ --prefix-list-name vpc-cidrs ``` Resultado: ``` { "PrefixList": { "PrefixListId": "pl-0123456abcabcabc1", "AddressFamily": "IPv4", "State": "create-in-progress", "PrefixListArn": "arn:aws:ec2:us-west-2:123456789012:prefix-list/pl-0123456abcabcabc1", "PrefixListName": "vpc-cidrs", "MaxEntries": 10, "Version": 1, "Tags": [], "OwnerId": "123456789012" } } ``` Para obter mais informações, consulte [Listas de prefixos gerenciados](https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html) no *Guia do usuário da Amazon VPC*. + Para ver detalhes da API, consulte [CreateManagedPrefixList](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-managed-prefix-list.html) na *Referência de comandos da AWS CLI*. ### `create-nat-gateway` O código de exemplo a seguir mostra como usar `create-nat-gateway`. **AWS CLI** **Exemplo 1: criar um gateway NAT público** O exemplo `create-nat-gateway` a seguir cria um gateway NAT público na sub-rede especificada e associa o endereço IP elástico ao ID de alocação especificado. Ao criar um gateway de NAT público, será necessário associar um endereço IP elástico. ``` aws ec2 create-nat-gateway \ --subnet-id subnet-0250c25a1fEXAMPLE \ --allocation-id eipalloc-09ad461b0dEXAMPLE ``` Resultado: ``` { "NatGateway": { "CreateTime": "2021-12-01T22:22:38.000Z", "NatGatewayAddresses": [ { "AllocationId": "eipalloc-09ad461b0dEXAMPLE" } ], "NatGatewayId": "nat-0c61bf8a12EXAMPLE", "State": "pending", "SubnetId": "subnet-0250c25a1fEXAMPLE", "VpcId": "vpc-0a60eb65b4EXAMPLE", "ConnectivityType": "public" } } ``` Para obter mais informações, consulte [Gateways NAT](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) no *Guia do usuário da Amazon VPC*. **Exemplo 2: criar um gateway NAT privado** O exemplo `create-nat-gateway` a seguir cria um gateway NAT privado na sub-rede especificada. Um gateway NAT privado não tem um endereço IP elástico associado. ``` aws ec2 create-nat-gateway \ --subnet-id subnet-0250c25a1fEXAMPLE \ --connectivity-type private ``` Resultado: ``` { "NatGateway": { "CreateTime": "2021-12-01T22:26:00.000Z", "NatGatewayAddresses": [ {} ], "NatGatewayId": "nat-011b568379EXAMPLE", "State": "pending", "SubnetId": "subnet-0250c25a1fEXAMPLE", "VpcId": "vpc-0a60eb65b4EXAMPLE", "ConnectivityType": "private" } } ``` Para obter mais informações, consulte [Gateways NAT](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) no *Guia do usuário da Amazon VPC*. + Para ver detalhes da API, consulte [CreateNatGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-nat-gateway.html) na *Referência de comandos da AWS CLI*. ### `create-network-acl-entry` O código de exemplo a seguir mostra como usar `create-network-acl-entry`. **AWS CLI** **Criar uma entrada de ACL de rede** Este exemplo cria uma entrada para a rede ACL especificada. A regra permite o tráfego de entrada de qualquer endereço IPv4 (0.0.0.0/0) na porta UDP 53 (DNS) para qualquer sub-rede associada. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 create-network-acl-entry --network-acl-id acl-5fb85d36 --ingress --rule-number 100 --protocol udp --port-range From=53,To=53 --cidr-block 0.0.0.0/0 --rule-action allow ``` Este exemplo cria uma regra para a rede ACL especificada que permite o tráfego de entrada de qualquer endereço IPv6 (:: /0) na porta TCP 80 (HTTP). Comando: ``` aws ec2 create-network-acl-entry --network-acl-id acl-5fb85d36 --ingress --rule-number 120 --protocol tcp --port-range From=80,To=80 --ipv6-cidr-block ::/0 --rule-action allow ``` + Para ver detalhes da API, consulte [CreateNetworkAclEntry](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-network-acl-entry.html) na *Referência de comandos da AWS CLI*. ### `create-network-acl` O código de exemplo a seguir mostra como usar `create-network-acl`. **AWS CLI** **Criar uma ACL de rede** Este exemplo cria uma rede ACL para a VPC especificada. Comando: ``` aws ec2 create-network-acl --vpc-id vpc-a01106c2 ``` Resultado: ``` { "NetworkAcl": { "Associations": [], "NetworkAclId": "acl-5fb85d36", "VpcId": "vpc-a01106c2", "Tags": [], "Entries": [ { "CidrBlock": "0.0.0.0/0", "RuleNumber": 32767, "Protocol": "-1", "Egress": true, "RuleAction": "deny" }, { "CidrBlock": "0.0.0.0/0", "RuleNumber": 32767, "Protocol": "-1", "Egress": false, "RuleAction": "deny" } ], "IsDefault": false } } ``` + Para ver detalhes da API, consulte [CreateNetworkAcl](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-network-acl.html) na *Referência de comandos da AWS CLI*. ### `create-network-insights-access-scope` O código de exemplo a seguir mostra como usar `create-network-insights-access-scope`. **AWS CLI** **Criar um escopo de acesso à rede** O exemplo `create-network-insights-access-scope` a seguir cria um Escopo de Acesso à Rede. ``` aws ec2 create-network-insights-access-scope \ --cli-input-json file://access-scope-file.json ``` Conteúdo de `access-scope-file.json`: ``` { "MatchPaths": [ { "Source": { "ResourceStatement": { "Resources": [ "vpc-abcd12e3" ] } } } ], "ExcludePaths": [ { "Source": { "ResourceStatement": { "ResourceTypes": [ "AWS::EC2::InternetGateway" ] } } } ] } ``` Resultado: ``` { "NetworkInsightsAccessScope": { "NetworkInsightsAccessScopeId": "nis-123456789abc01234", "NetworkInsightsAccessScopeArn": "arn:aws:ec2:us-east-1:123456789012:network-insights-access-scope/nis-123456789abc01234", "CreatedDate": "2022-01-25T19:20:28.796000+00:00", "UpdatedDate": "2022-01-25T19:20:28.797000+00:00" }, "NetworkInsightsAccessScopeContent": { "NetworkInsightsAccessScopeId": "nis-123456789abc01234", "MatchPaths": [ { "Source": { "ResourceStatement": { "Resources": [ "vpc-abcd12e3" ] } } } ], "ExcludePaths": [ { "Source": { "ResourceStatement": { "ResourceTypes": [ "AWS::EC2::InternetGateway" ] } } } ] } } ``` Para obter mais informações, consulte [Introdução ao Analisador de Acesso à Rede usando AWS CLI](https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/getting-started-cli.html) no *Guia do Analisador de Acesso à Rede*. + Para ver detalhes da API, consulte [CreateNetworkInsightsAccessScope](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-network-insights-access-scope.html) na *Referência de comandos da AWS CLI*. ### `create-network-insights-path` O código de exemplo a seguir mostra como usar `create-network-insights-path`. **AWS CLI** **Criar um caminho** O exemplo `create-network-insights-path` a seguir cria um caminho. A origem é o gateway da internet especificado e o destino é a instância EC2 especificada. Para determinar se o destino pode ser acessado usando o protocolo e a porta especificados, analise o caminho usando o comando `start-network-insights-analysis`. ``` aws ec2 create-network-insights-path \ --source igw-0797cccdc9d73b0e5 \ --destination i-0495d385ad28331c7 \ --destination-port 22 \ --protocol TCP ``` Resultado: ``` { "NetworkInsightsPaths": { "NetworkInsightsPathId": "nip-0b26f224f1d131fa8", "NetworkInsightsPathArn": "arn:aws:ec2:us-east-1:123456789012:network-insights-path/nip-0b26f224f1d131fa8", "CreatedDate": "2021-01-20T22:43:46.933Z", "Source": "igw-0797cccdc9d73b0e5", "Destination": "i-0495d385ad28331c7", "Protocol": "tcp" } } ``` Para obter mais informações, consulte [Introdução ao uso da AWS CLI](https://docs.aws.amazon.com/vpc/latest/reachability/getting-started-cli.html) no *Guia do Reachability Analyzer*. + Para ver detalhes da API, consulte [CreateNetworkInsightsPath](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-network-insights-path.html) na *Referência de comandos da AWS CLI*. ### `create-network-interface-permission` O código de exemplo a seguir mostra como usar `create-network-interface-permission`. **AWS CLI** **Criar permissão de interface de rede** Este exemplo concede permissão à conta `123456789012` para anexar uma interface de rede `eni-1a2b3c4d` a uma instância. Comando: ``` aws ec2 create-network-interface-permission --network-interface-id eni-1a2b3c4d --aws-account-id 123456789012 --permission INSTANCE-ATTACH ``` Resultado: ``` { "InterfacePermission": { "PermissionState": { "State": "GRANTED" }, "NetworkInterfacePermissionId": "eni-perm-06fd19020ede149ea", "NetworkInterfaceId": "eni-1a2b3c4d", "Permission": "INSTANCE-ATTACH", "AwsAccountId": "123456789012" } } ``` + Para ver detalhes da API, consulte [CreateNetworkInterfacePermission](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-network-interface-permission.html) na *AWS CLI Referência de comando*. ### `create-network-interface` O código de exemplo a seguir mostra como usar `create-network-interface`. **AWS CLI** **Exemplo 1: especificar um endereço IPv4 para uma interface de rede** O exemplo `create-network-interface` a seguir cria uma interface de rede para a sub-rede especificada com o endereço IPv4 primário especificado. ``` aws ec2 create-network-interface \ --subnet-id subnet-00a24d0d67acf6333 \ --description "my network interface" \ --groups sg-09dfba7ed20cda78b \ --private-ip-address 10.0.8.17 ``` Resultado: ``` { "NetworkInterface": { "AvailabilityZone": "us-west-2a", "Description": "my network interface", "Groups": [ { "GroupName": "my-security-group", "GroupId": "sg-09dfba7ed20cda78b" } ], "InterfaceType": "interface", "Ipv6Addresses": [], "MacAddress": "06:6a:0f:9a:49:37", "NetworkInterfaceId": "eni-0492b355f0cf3b3f8", "OwnerId": "123456789012", "PrivateDnsName": "ip-10-0-8-18.us-west-2.compute.internal", "PrivateIpAddress": "10.0.8.17", "PrivateIpAddresses": [ { "Primary": true, "PrivateDnsName": "ip-10-0-8-17.us-west-2.compute.internal", "PrivateIpAddress": "10.0.8.17" } ], "RequesterId": "AIDA4Z3Y7GSXTMEXAMPLE", "RequesterManaged": false, "SourceDestCheck": true, "Status": "pending", "SubnetId": "subnet-00a24d0d67acf6333", "TagSet": [], "VpcId": "vpc-02723a0feeeb9d57b" } } ``` **Exemplo 2: criar uma interface de rede com um endereço IPv4 e um endereço IPv** O exemplo `create-network-interface` a seguir cria uma interface de rede para a sub-rede especificada com um endereço IPv4 e um endereço IPv6 selecionados pelo Amazon EC2. ``` aws ec2 create-network-interface \ --subnet-id subnet-00a24d0d67acf6333 \ --description "my dual stack network interface" \ --ipv6-address-count 1 \ --groups sg-09dfba7ed20cda78b ``` Resultado: ``` { "NetworkInterface": { "AvailabilityZone": "us-west-2a", "Description": "my dual stack network interface", "Groups": [ { "GroupName": "my-security-group", "GroupId": "sg-09dfba7ed20cda78b" } ], "InterfaceType": "interface", "Ipv6Addresses": [ { "Ipv6Address": "2600:1f13:cfe:3650:a1dc:237c:393a:4ba7", "IsPrimaryIpv6": false } ], "MacAddress": "06:b8:68:d2:b2:2d", "NetworkInterfaceId": "eni-05da417453f9a84bf", "OwnerId": "123456789012", "PrivateDnsName": "ip-10-0-8-18.us-west-2.compute.internal", "PrivateIpAddress": "10.0.8.18", "PrivateIpAddresses": [ { "Primary": true, "PrivateDnsName": "ip-10-0-8-18.us-west-2.compute.internal", "PrivateIpAddress": "10.0.8.18" } ], "RequesterId": "AIDA4Z3Y7GSXTMEXAMPLE", "RequesterManaged": false, "SourceDestCheck": true, "Status": "pending", "SubnetId": "subnet-00a24d0d67acf6333", "TagSet": [], "VpcId": "vpc-02723a0feeeb9d57b", "Ipv6Address": "2600:1f13:cfe:3650:a1dc:237c:393a:4ba7" } } ``` **Exemplo 3: criar uma interface de rede com opções de configuração de rastreamento de conexão** O exemplo `create-network-interface` a seguir cria uma interface de rede e configura os tempos limite de rastreamento de conexão ociosa. ``` aws ec2 create-network-interface \ --subnet-id subnet-00a24d0d67acf6333 \ --groups sg-02e57dbcfe0331c1b \ --connection-tracking-specification TcpEstablishedTimeout=86400,UdpTimeout=60 ``` Resultado: ``` { "NetworkInterface": { "AvailabilityZone": "us-west-2a", "ConnectionTrackingConfiguration": { "TcpEstablishedTimeout": 86400, "UdpTimeout": 60 }, "Description": "", "Groups": [ { "GroupName": "my-security-group", "GroupId": "sg-02e57dbcfe0331c1b" } ], "InterfaceType": "interface", "Ipv6Addresses": [], "MacAddress": "06:4c:53:de:6d:91", "NetworkInterfaceId": "eni-0c133586e08903d0b", "OwnerId": "123456789012", "PrivateDnsName": "ip-10-0-8-94.us-west-2.compute.internal", "PrivateIpAddress": "10.0.8.94", "PrivateIpAddresses": [ { "Primary": true, "PrivateDnsName": "ip-10-0-8-94.us-west-2.compute.internal", "PrivateIpAddress": "10.0.8.94" } ], "RequesterId": "AIDA4Z3Y7GSXTMEXAMPLE", "RequesterManaged": false, "SourceDestCheck": true, "Status": "pending", "SubnetId": "subnet-00a24d0d67acf6333", "TagSet": [], "VpcId": "vpc-02723a0feeeb9d57b" } } ``` **Exemplo 4: criar um adaptador Fabric elástico** O exemplo `create-network-interface` a seguir cria um EFA: ``` aws ec2 create-network-interface \ --interface-type efa \ --subnet-id subnet-00a24d0d67acf6333 \ --description "my efa" \ --groups sg-02e57dbcfe0331c1b ``` Resultado: ``` { "NetworkInterface": { "AvailabilityZone": "us-west-2a", "Description": "my efa", "Groups": [ { "GroupName": "my-efa-sg", "GroupId": "sg-02e57dbcfe0331c1b" } ], "InterfaceType": "efa", "Ipv6Addresses": [], "MacAddress": "06:d7:a4:f7:4d:57", "NetworkInterfaceId": "eni-034acc2885e862b65", "OwnerId": "123456789012", "PrivateDnsName": "ip-10-0-8-180.us-west-2.compute.internal", "PrivateIpAddress": "10.0.8.180", "PrivateIpAddresses": [ { "Primary": true, "PrivateDnsName": "ip-10-0-8-180.us-west-2.compute.internal", "PrivateIpAddress": "10.0.8.180" } ], "RequesterId": "AIDA4Z3Y7GSXTMEXAMPLE", "RequesterManaged": false, "SourceDestCheck": true, "Status": "pending", "SubnetId": "subnet-00a24d0d67acf6333", "TagSet": [], "VpcId": "vpc-02723a0feeeb9d57b" } } ``` Para obter mais informações, consulte [Interfaces de rede elástica](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [CreateNetworkInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-network-interface.html) na *Referência de comandos da AWS CLI*. ### `create-placement-group` O código de exemplo a seguir mostra como usar `create-placement-group`. **AWS CLI** **Criar um grupo de posicionamento** Esse exemplo de comando cria um grupo de posicionamento com o nome especificado. Comando: ``` aws ec2 create-placement-group --group-name my-cluster --strategy cluster ``` **Criar um grupo com posicionamento em partições** Esse exemplo de comando cria um grupo com posicionamento em partições chamado `HDFS-Group-A` com cinco partições. Comando: ``` aws ec2 create-placement-group --group-name HDFS-Group-A --strategy partition --partition-count 5 ``` + Para ver detalhes da API, consulte [CreatePlacementGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-placement-group.html) na *Referência de comandos da AWS CLI*. ### `create-replace-root-volume-task` O código de exemplo a seguir mostra como usar `create-replace-root-volume-task`. **AWS CLI** **Exemplo 1: restaurar um volume raiz ao estado inicial de inicialização** O exemplo `create-replace-root-volume-task` a seguir restaura o volume raiz da instância i-0123456789abcdefa para seu estado inicial de inicialização. ``` aws ec2 create-replace-root-volume-task \ --instance-id i-0123456789abcdefa ``` Resultado: ``` { "ReplaceRootVolumeTask": { "InstanceId": "i-0123456789abcdefa", "ReplaceRootVolumeTaskId": "replacevol-0111122223333abcd", "TaskState": "pending", "StartTime": "2022-03-14T15:06:38Z", "Tags": [] } } ``` **Exemplo 2: restaurar um volume raiz para um snapshot específico** O exemplo `create-replace-root-volume-task` a seguir restaura o volume raiz da instância i-0123456789abcdefa para o snapshot snap-0abcdef1234567890. ``` aws ec2 create-replace-root-volume-task \ --instance-id i-0123456789abcdefa \ --snapshot-id snap-0abcdef1234567890 ``` Resultado: ``` { "ReplaceRootVolumeTask": { "InstanceId": "i-0123456789abcdefa", "ReplaceRootVolumeTaskId": "replacevol-0555566667777abcd", "TaskState": "pending", "StartTime": "2022-03-14T15:16:28Z", "Tags": [] } } ``` Consulte mais informações em [Substituir um volume raiz](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/replace-root.html) no *Manual do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [CreateReplaceRootVolumeTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-replace-root-volume-task.html) na *Referência de comandos da AWS CLI*. ### `create-reserved-instances-listing` O código de exemplo a seguir mostra como usar `create-reserved-instances-listing`. **AWS CLI** **Listar uma instância reservada no Marketplace de instâncias reservadas usando** O exemplo `create-reserved-instances-listing` a seguir cria uma listagem da Instância Reservada especificada no Marketplace de Instâncias Reservadas. ``` aws ec2 create-reserved-instances-listing \ --reserved-instances-id 5ec28771-05ff-4b9b-aa31-9e57dexample \ --instance-count 3 \ --price-schedules CurrencyCode=USD,Price=25.50 \ --client-token 550e8400-e29b-41d4-a716-446655440000 ``` + Para ver detalhes da API, consulte [CreateReservedInstancesListing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-reserved-instances-listing.html) na *Referência de comandos da AWS CLI*. ### `create-restore-image-task` O código de exemplo a seguir mostra como usar `create-restore-image-task`. **AWS CLI** **Restaurar uma AMI de um bucket do S** O exemplo `create-restore-image-task` a seguir restaura uma AMI de um bucket do S3. Use os valores de `S3ObjectKey `` and ``Bucket` da saída `describe-store-image-tasks`, especifique a chave de objeto da AMI e o nome do bucket do S3 para o qual a AMI foi copiada e especifique o nome da AMI restaurada. O nome deve ser exclusivo para AMIs na região dessa conta. A AMI restaurada receberá uma nova ID AMI. ``` aws ec2 create-restore-image-task \ --object-key ami-1234567890abcdef0.bin \ --bucket my-ami-bucket \ --name 'New AMI Name' ``` Resultado: ``` { "ImageId": "ami-0eab20fe36f83e1a8" } ``` Para obter mais informações, consulte [Armazenar e restaurar uma AMI usando o S3](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html) no *Guia de usuário do Amazon EC2*. + Para ver detalhes da API, consulte [CreateRestoreImageTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-restore-image-task.html) na *Referência de comandos da AWS CLI*. ### `create-route-table` O código de exemplo a seguir mostra como usar `create-route-table`. **AWS CLI** **Para criar uma tabela de rotas** Este exemplo cria uma tabela de rotas para a VPC especificada. Comando: ``` aws ec2 create-route-table --vpc-id vpc-a01106c2 ``` Resultado: ``` { "RouteTable": { "Associations": [], "RouteTableId": "rtb-22574640", "VpcId": "vpc-a01106c2", "PropagatingVgws": [], "Tags": [], "Routes": [ { "GatewayId": "local", "DestinationCidrBlock": "10.0.0.0/16", "State": "active" } ] } } ``` + Consulte detalhes da API em [CreateRouteTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-route-table.html) na *Referência de comandos da AWS CLI*. ### `create-route` O código de exemplo a seguir mostra como usar `create-route`. **AWS CLI** **Criar uma rota** Este exemplo cria uma rota para a tabela de rotas especificada. A rota faz a correspondência de todo o tráfego IPv4 (`0.0.0.0/0`) e o encaminha para o gateway da internet especificado. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 create-route --route-table-id rtb-22574640 --destination-cidr-block 0.0.0.0/0 --gateway-id igw-c0a643a9 ``` Este exemplo de comando cria uma rota na tabela de rotas rtb-g8ff4ea2. A rota corresponde ao tráfego do bloco CIDR IPv4 10.0.0.0/16 e o encaminha para a conexão de emparelhamento da VPC, pcx-111aaa22. Essa rota permite que o tráfego seja direcionado para a VPC de mesmo nível na conexão de emparelhamento da VPC. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 create-route --route-table-id rtb-g8ff4ea2 --destination-cidr-block 10.0.0.0/16 --vpc-peering-connection-id pcx-1a2b3c4d ``` Este exemplo cria uma rota na tabela de rotas especificada que corresponde a todo tráfego IPv6 (`::/0`) e a roteia para o Gateway da Internet apenas de saída especificado. Comando: ``` aws ec2 create-route --route-table-id rtb-dce620b8 --destination-ipv6-cidr-block ::/0 --egress-only-internet-gateway-id eigw-01eadbd45ecd7943f ``` + Para ver detalhes da API, consulte [CreateRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-route.html) na *Referência de comandos da AWS CLI*. ### `create-security-group` O código de exemplo a seguir mostra como usar `create-security-group`. **AWS CLI** **Para criar um grupo de segurança do EC2-Classic** Este exemplo cria um grupo de segurança chamado `MySecurityGroup`. Comando: ``` aws ec2 create-security-group --group-name MySecurityGroup --description "My security group" ``` Resultado: ``` { "GroupId": "sg-903004f8" } ``` **Para criar um grupo de segurança do EC2-VPC** Este exemplo cria um grupo de segurança chamado `MySecurityGroup` para a VPC especificada. Comando: ``` aws ec2 create-security-group --group-name MySecurityGroup --description "My security group" --vpc-id vpc-1a2b3c4d ``` Resultado: ``` { "GroupId": "sg-903004f8" } ``` Para obter mais informações, consulte Using Security Groups no *Guia do usuário da AWS Command Line Interface*. + Consulte detalhes da API em [CreateSecurityGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-security-group.html) na *Referência de comandos da AWS CLI*. ### `create-snapshot` O código de exemplo a seguir mostra como usar `create-snapshot`. **AWS CLI** **Para criar um snapshot** Esse exemplo de comando cria um snapshot do volume com um ID do volume `vol-1234567890abcdef0` e uma breve descrição para identificar o snapshot. Comando: ``` aws ec2 create-snapshot --volume-id vol-1234567890abcdef0 --description "This is my root volume snapshot" ``` Resultado: ``` { "Description": "This is my root volume snapshot", "Tags": [], "Encrypted": false, "VolumeId": "vol-1234567890abcdef0", "State": "pending", "VolumeSize": 8, "StartTime": "2018-02-28T21:06:01.000Z", "Progress": "", "OwnerId": "012345678910", "SnapshotId": "snap-066877671789bd71b" } ``` **Para criar um snapshot com tags** Esse exemplo de comando cria um snapshot e aplica duas tags: purpose=prod e costcenter=123. Comando: ``` aws ec2 create-snapshot --volume-id vol-1234567890abcdef0 --description 'Prod backup' --tag-specifications 'ResourceType=snapshot,Tags=[{Key=purpose,Value=prod},{Key=costcenter,Value=123}]' ``` Resultado: ``` { "Description": "Prod backup", "Tags": [ { "Value": "prod", "Key": "purpose" }, { "Value": "123", "Key": "costcenter" } ], "Encrypted": false, "VolumeId": "vol-1234567890abcdef0", "State": "pending", "VolumeSize": 8, "StartTime": "2018-02-28T21:06:06.000Z", "Progress": "", "OwnerId": "012345678910", "SnapshotId": "snap-09ed24a70bc19bbe4" } ``` + Para ver detalhes da API, consulte [CreateSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-snapshot.html) na *Referência de comandos da AWS CLI*. ### `create-snapshots` O código de exemplo a seguir mostra como usar `create-snapshots`. **AWS CLI** **Exemplo 1: criar um snapshot de vários volumes** O exemplo `create-snapshots` a seguir cria snapshots de todos os volumes anexados à instância especificada. ``` aws ec2 create-snapshots \ --instance-specification InstanceId=i-1234567890abcdef0 \ --description "This is snapshot of a volume from my-instance" ``` Resultado: ``` { "Snapshots": [ { "Description": "This is a snapshot of a volume from my-instance", "Tags": [], "Encrypted": false, "VolumeId": "vol-0a01d2d5a34697479", "State": "pending", "VolumeSize": 16, "StartTime": "2019-08-05T16:58:19.000Z", "Progress": "", "OwnerId": "123456789012", "SnapshotId": "snap-07f30e3909aa0045e" }, { "Description": "This is a snapshot of a volume from my-instance", "Tags": [], "Encrypted": false, "VolumeId": "vol-02d0d4947008cb1a2", "State": "pending", "VolumeSize": 20, "StartTime": "2019-08-05T16:58:19.000Z", "Progress": "", "OwnerId": "123456789012", "SnapshotId": "snap-0ec20b602264aad48" }, ... ] } ``` **Exemplo 2: criar um snapshot de vários volumes com tags do volume de origem** O exemplo `create-snapshots` a seguir cria snapshots de todos os volumes anexados à instância especificada e copia as tags de cada volume para o snapshot correspondente. ``` aws ec2 create-snapshots \ --instance-specification InstanceId=i-1234567890abcdef0 \ --copy-tags-from-source volume \ --description "This is snapshot of a volume from my-instance" ``` Resultado: ``` { "Snapshots": [ { "Description": "This is a snapshot of a volume from my-instance", "Tags": [ { "Key": "Name", "Value": "my-volume" } ], "Encrypted": false, "VolumeId": "vol-02d0d4947008cb1a2", "State": "pending", "VolumeSize": 20, "StartTime": "2019-08-05T16:53:04.000Z", "Progress": "", "OwnerId": "123456789012", "SnapshotId": "snap-053bfaeb821a458dd" } ... ] } ``` **Exemplo 3: criar um snapshot de vários volumes que não inclua o volume raiz** O exemplo `create-snapshots` a seguir cria um snapshot de todos os volumes anexados à instância especificada, exceto o volume raiz. ``` aws ec2 create-snapshots \ --instance-specification InstanceId=i-1234567890abcdef0,ExcludeBootVolume=true ``` Consulte a amostra de saída no exemplo 1. **Exemplo 4: criar um snapshot de vários volumes e adicionar tags** O exemplo `create-snapshots` a seguir cria snapshots de todos os volumes anexados à instância especificada e adiciona duas tags a cada snapshot. ``` aws ec2 create-snapshots \ --instance-specification InstanceId=i-1234567890abcdef0 \ --tag-specifications 'ResourceType=snapshot,Tags=[{Key=Name,Value=backup},{Key=costcenter,Value=123}]' ``` Consulte uma amostra de saída no exemplo 1. + Para ver detalhes da API, consulte [CreateSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-snapshots.html) na *Referência de comandos da AWS CLI*. ### `create-spot-datafeed-subscription` O código de exemplo a seguir mostra como usar `create-spot-datafeed-subscription`. **AWS CLI** **Criar um feed de dados da instância spot** O exemplo `create-spot-datafeed-subscription` a seguir cria um feed de dados da Instância Spot. ``` aws ec2 create-spot-datafeed-subscription \ --bucket amzn-s3-demo-bucket \ --prefix spot-data-feed ``` Resultado: ``` { "SpotDatafeedSubscription": { "Bucket": "amzn-s3-demo-bucket", "OwnerId": "123456789012", "Prefix": "spot-data-feed", "State": "Active" } } ``` O feed de dados é armazenado no bucket do Amazon S3 que você especificar. Os nomes de arquivo desse feed de dados têm o formato a seguir. ``` amzn-s3-demo-bucket.s3.amazonaws.com/spot-data-feed/123456789012.YYYY-MM-DD-HH.n.abcd1234.gz ``` Consulte mais informações em [Feed de dados da instância spot](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html) no *Manual do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [CreateSpotDatafeedSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-spot-datafeed-subscription.html) na *Referência de comandos da AWS CLI*. ### `create-store-image-task` O código de exemplo a seguir mostra como usar `create-store-image-task`. **AWS CLI** **Armazenar uma AMI em um bucket do S** O exemplo `create-store-image-task` a seguir armazena uma AMI em um bucket do S3. Especifique o ID da AMI e o nome do bucket do S3 no qual a AMI será armazenada. ``` aws ec2 create-store-image-task \ --image-id ami-1234567890abcdef0 \ --bucket my-ami-bucket ``` Resultado: ``` { "ObjectKey": "ami-1234567890abcdef0.bin" } ``` Para obter mais informações, consulte [Armazenar e restaurar uma AMI usando o S3](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html) no *Guia de usuário do Amazon EC2*. + Para ver detalhes da API, consulte [CreateStoreImageTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-store-image-task.html) na *Referência de comandos da AWS CLI*. ### `create-subnet-cidr-reservation` O código de exemplo a seguir mostra como usar `create-subnet-cidr-reservation`. **AWS CLI** **Criar uma reserva CIDR de sub-rede** O exemplo `create-subnet-cidr-reservation` a seguir cria uma reserva CIDR de sub-rede para a sub-rede e o intervalo CIDR especificados. ``` aws ec2 create-subnet-cidr-reservation \ --subnet-id subnet-03c51e2eEXAMPLE \ --reservation-type prefix \ --cidr 10.1.0.20/26 ``` Resultado: ``` { "SubnetCidrReservation": { "SubnetCidrReservationId": "scr-044f977c4eEXAMPLE", "SubnetId": "subnet-03c51e2e6cEXAMPLE", "Cidr": "10.1.0.16/28", "ReservationType": "prefix", "OwnerId": "123456789012" } } ``` Para obter mais informações, consulte [Comportamento do endereçamento IP para sua sub-rede](https://docs.aws.amazon.com/vpc/latest/userguide/subnet-cidr-reservation.html) no *Guia do usuário da Amazon VPC*. + Para ver detalhes da API, consulte [CreateSubnetCidrReservation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-subnet-cidr-reservation.html) na *Referência de comandos da AWS CLI*. ### `create-subnet` O código de exemplo a seguir mostra como usar `create-subnet`. **AWS CLI** **Exemplo 1: criar uma sub-rede somente com um bloco CIDR IPv** O exemplo `create-subnet` a seguir cria uma sub-rede na VPC especificada com o bloco CIDR IPv4 especificado. ``` aws ec2 create-subnet \ --vpc-id vpc-081ec835f3EXAMPLE \ --cidr-block 10.0.0.0/24 \ --tag-specifications ResourceType=subnet,Tags=[{Key=Name,Value=my-ipv4-only-subnet}] ``` Resultado: ``` { "Subnet": { "AvailabilityZone": "us-west-2a", "AvailabilityZoneId": "usw2-az2", "AvailableIpAddressCount": 251, "CidrBlock": "10.0.0.0/24", "DefaultForAz": false, "MapPublicIpOnLaunch": false, "State": "available", "SubnetId": "subnet-0e99b93155EXAMPLE", "VpcId": "vpc-081ec835f3EXAMPLE", "OwnerId": "123456789012", "AssignIpv6AddressOnCreation": false, "Ipv6CidrBlockAssociationSet": [], "Tags": [ { "Key": "Name", "Value": "my-ipv4-only-subnet" } ], "SubnetArn": "arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0e99b93155EXAMPLE" } } ``` **Exemplo 2: para criar uma sub-rede com blocos CIDR IPv4 e IPv** O exemplo `create-subnet` a seguir cria uma sub-rede na VPC especificada com os blocos CIDR IPv4 e IPv6 especificados. ``` aws ec2 create-subnet \ --vpc-id vpc-081ec835f3EXAMPLE \ --cidr-block 10.0.0.0/24 \ --ipv6-cidr-block 2600:1f16:cfe:3660::/64 \ --tag-specifications ResourceType=subnet,Tags=[{Key=Name,Value=my-ipv4-ipv6-subnet}] ``` Resultado: ``` { "Subnet": { "AvailabilityZone": "us-west-2a", "AvailabilityZoneId": "usw2-az2", "AvailableIpAddressCount": 251, "CidrBlock": "10.0.0.0/24", "DefaultForAz": false, "MapPublicIpOnLaunch": false, "State": "available", "SubnetId": "subnet-0736441d38EXAMPLE", "VpcId": "vpc-081ec835f3EXAMPLE", "OwnerId": "123456789012", "AssignIpv6AddressOnCreation": false, "Ipv6CidrBlockAssociationSet": [ { "AssociationId": "subnet-cidr-assoc-06c5f904499fcc623", "Ipv6CidrBlock": "2600:1f13:cfe:3660::/64", "Ipv6CidrBlockState": { "State": "associating" } } ], "Tags": [ { "Key": "Name", "Value": "my-ipv4-ipv6-subnet" } ], "SubnetArn": "arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0736441d38EXAMPLE" } } ``` **Exemplo 3: criar uma sub-rede somente com um bloco CIDR IPv** O exemplo `create-subnet` a seguir cria uma sub-rede na VPC especificada com o bloco CIDR IPv6 especificado. ``` aws ec2 create-subnet \ --vpc-id vpc-081ec835f3EXAMPLE \ --ipv6-native \ --ipv6-cidr-block 2600:1f16:115:200::/64 \ --tag-specifications ResourceType=subnet,Tags=[{Key=Name,Value=my-ipv6-only-subnet}] ``` Resultado: ``` { "Subnet": { "AvailabilityZone": "us-west-2a", "AvailabilityZoneId": "usw2-az2", "AvailableIpAddressCount": 0, "DefaultForAz": false, "MapPublicIpOnLaunch": false, "State": "available", "SubnetId": "subnet-03f720e7deEXAMPLE", "VpcId": "vpc-081ec835f3EXAMPLE", "OwnerId": "123456789012", "AssignIpv6AddressOnCreation": true, "Ipv6CidrBlockAssociationSet": [ { "AssociationId": "subnet-cidr-assoc-01ef639edde556709", "Ipv6CidrBlock": "2600:1f13:cfe:3660::/64", "Ipv6CidrBlockState": { "State": "associating" } } ], "Tags": [ { "Key": "Name", "Value": "my-ipv6-only-subnet" } ], "SubnetArn": "arn:aws:ec2:us-west-2:123456789012:subnet/subnet-03f720e7deEXAMPLE" } } ``` Para obter mais informações, consulte [VPCs e sub-redes](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) no *Manual do usuário da Amazon VPC*. + Consulte detalhes da API em [CreateSubnet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-subnet.html) na *Referência de comandos da AWS CLI*. ### `create-tags` O código de exemplo a seguir mostra como usar `create-tags`. **AWS CLI** **Exemplo 1: adicionar uma tag a um recurso** O exemplo `create-tags` a seguir adiciona a tag `Stack=production` à imagem especificada ou substitui uma tag existente para a AMI na qual a chave de tag é `Stack`. ``` aws ec2 create-tags \ --resources ami-1234567890abcdef0 \ --tags Key=Stack,Value=production ``` Este comando não produz saída **Exemplo 2: adicionar tags a vários recursos** O exemplo `create-tags` a seguir adiciona (ou substitui) duas tags para uma AMI e uma instância. Uma das tags tem uma chave (`webserver`), mas nenhum valor (o valor é definido como uma string vazia). A outra tag tem uma chave (`stack`) e um valor (`Production`). ``` aws ec2 create-tags \ --resources ami-1a2b3c4d i-1234567890abcdef0 \ --tags Key=webserver,Value= Key=stack,Value=Production ``` Este comando não produz saída **Exemplo 3: adicionar tags contendo caracteres especiais** Os exemplos de `create-tags` a seguir adicionam a tag `[Group]=test` a uma instância. Os colchetes ([ e ]) são caracteres especiais e devem ser recuados. Os exemplos a seguir também usam o caractere de continuação de linha apropriado para cada ambiente. Se você estiver usando o Windows, coloque o elemento com caracteres especiais entre aspas duplas (“) e preceda cada caractere de aspas duplas com uma barra invertida (\$1) da maneira a seguir. ``` aws ec2 create-tags ^ --resources i-1234567890abcdef0 ^ --tags Key=\"[Group]\",Value=test ``` Se você estiver usando o Windows PowerShell, coloque o elemento com caracteres especiais entre aspas duplas (“), preceda cada caractere de aspas duplas com uma barra invertida (\$1) e coloque toda a estrutura de chave e valor entre aspas simples (‘) da maneira a seguir. ``` aws ec2 create-tags ` --resources i-1234567890abcdef0 ` --tags 'Key=\"[Group]\",Value=test' ``` Se você estiver usando Linux ou OS X, coloque o elemento com caracteres especiais entre aspas duplas (“) e toda a estrutura de chave e valor entre aspas simples (‘) da maneira a seguir. ``` aws ec2 create-tags \ --resources i-1234567890abcdef0 \ --tags 'Key="[Group]",Value=test' ``` Para ter mais informações, consulte [Marcar com tag os recursos do Amazon EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) no *Guia do usuário do Amazon EC2*. + Consulte detalhes da API em [CreateTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-tags.html) na *Referência de comandos da AWS CLI*. ### `create-traffic-mirror-filter-rule` O código de exemplo a seguir mostra como usar `create-traffic-mirror-filter-rule`. **AWS CLI** **Criar uma regra de filtro para o tráfego TCP de entrada** O exemplo `create-traffic-mirror-filter-rule` a seguir cria uma regra que você pode usar para espelhar todo o tráfego TCP de entrada. Antes de executar esse comando, use `create-traffic-mirror-filter` para criar o filtro de espelhamento de tráfego. ``` aws ec2 create-traffic-mirror-filter-rule \ --description 'TCP Rule' \ --destination-cidr-block 0.0.0.0/0 \ --protocol 6 \ --rule-action accept \ --rule-number 1 \ --source-cidr-block 0.0.0.0/0 \ --traffic-direction ingress \ --traffic-mirror-filter-id tmf-04812ff784b25ae67 ``` Resultado: ``` { "TrafficMirrorFilterRule": { "DestinationCidrBlock": "0.0.0.0/0", "TrafficMirrorFilterId": "tmf-04812ff784b25ae67", "TrafficMirrorFilterRuleId": "tmfr-02d20d996673f3732", "SourceCidrBlock": "0.0.0.0/0", "TrafficDirection": "ingress", "Description": "TCP Rule", "RuleNumber": 1, "RuleAction": "accept", "Protocol": 6 }, "ClientToken": "4752b573-40a6-4eac-a8a4-a72058761219" } ``` Consulte mais informações em [Create a traffic mirror filter](https://docs.aws.amazon.com/vpc/latest/mirroring/create-traffic-mirroring-filter.html) no *Guia de espelhamento de tráfego*. + Para ver detalhes da API, consulte [CreateTrafficMirrorFilterRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-traffic-mirror-filter-rule.html) na *Referência de comandos da AWS CLI*. ### `create-traffic-mirror-filter` O código de exemplo a seguir mostra como usar `create-traffic-mirror-filter`. **AWS CLI** **Como criar um filtro de espelhamento de tráfego** O exemplo de `create-traffic-mirror-filter` a seguir cria um filtro de espelhamento de tráfego. Depois de criar o filtro, use `create-traffic-mirror-filter-rule` para adicionar regras. ``` aws ec2 create-traffic-mirror-filter \ --description 'TCP Filter' ``` Resultado: ``` { "ClientToken": "28908518-100b-4987-8233-8c744EXAMPLE", "TrafficMirrorFilter": { "TrafficMirrorFilterId": "tmf-04812ff784EXAMPLE", "Description": "TCP Filter", "EgressFilterRules": [], "IngressFilterRules": [], "Tags": [], "NetworkServices": [] } } ``` Consulte mais informações em [Create a traffic mirror filter](https://docs.aws.amazon.com/vpc/latest/mirroring/create-traffic-mirroring-filter.html) no *Guia de espelhamento de tráfego*. + Para ver detalhes da API, consulte [CreateTrafficMirrorFilter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-traffic-mirror-filter.html) na *Referência de comandos da AWS CLI*. ### `create-traffic-mirror-session` O código de exemplo a seguir mostra como usar `create-traffic-mirror-session`. **AWS CLI** **Como criar uma sessão de espelhamento de tráfego** O comando de `create-traffic-mirror-session` a seguir cria uma sessão de espelhamento de tráfego de 25 bytes do pacote para a origem e o destino especificados. ``` aws ec2 create-traffic-mirror-session \ --description 'example session' \ --traffic-mirror-target-id tmt-07f75d8feeEXAMPLE \ --network-interface-id eni-070203f901EXAMPLE \ --session-number 1 \ --packet-length 25 \ --traffic-mirror-filter-id tmf-04812ff784EXAMPLE ``` Resultado: ``` { "TrafficMirrorSession": { "TrafficMirrorSessionId": "tms-08a33b1214EXAMPLE", "TrafficMirrorTargetId": "tmt-07f75d8feeEXAMPLE", "TrafficMirrorFilterId": "tmf-04812ff784EXAMPLE", "NetworkInterfaceId": "eni-070203f901EXAMPLE", "OwnerId": "111122223333", "PacketLength": 25, "SessionNumber": 1, "VirtualNetworkId": 7159709, "Description": "example session", "Tags": [] }, "ClientToken": "5236cffc-ee13-4a32-bb5b-388d9da09d96" } ``` Consulte mais informações em [Create a traffic mirror session](https://docs.aws.amazon.com/vpc/latest/mirroring/create-traffic-mirroring-session.html) no *Guia de espelhamento de tráfego*. + Para ver detalhes da API, consulte [CreateTrafficMirrorSession](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-traffic-mirror-session.html) na *Referência de comandos da AWS CLI*. ### `create-traffic-mirror-target` O código de exemplo a seguir mostra como usar `create-traffic-mirror-target`. **AWS CLI** **Como criar um destino de espelho de tráfego no Network Load Balancer** O exemplo de `create-traffic-mirror-target` a seguir cria um destino de espelho de tráfego no Network Load Balancer. ``` aws ec2 create-traffic-mirror-target \ --description 'Example Network Load Balancer Target' \ --network-load-balancer-arn arn:aws:elasticloadbalancing:us-east-1:111122223333:loadbalancer/net/NLB/7cdec873EXAMPLE ``` Resultado: ``` { "TrafficMirrorTarget": { "Type": "network-load-balancer", "Tags": [], "Description": "Example Network Load Balancer Target", "OwnerId": "111122223333", "NetworkLoadBalancerArn": "arn:aws:elasticloadbalancing:us-east-1:724145273726:loadbalancer/net/NLB/7cdec873EXAMPLE", "TrafficMirrorTargetId": "tmt-0dabe9b0a6EXAMPLE" }, "ClientToken": "d5c090f5-8a0f-49c7-8281-72c796a21f72" } ``` **Como criar um destino de espelhamento de tráfego de rede** O exemplo `create-traffic-mirror-target` a seguir cria um destino de espelho de tráfego na interface de rede. ``` aws ec2 create-traffic-mirror-target \ --description 'Network interface target' \ --network-interface-id eni-eni-01f6f631eEXAMPLE ``` Resultado: ``` { "ClientToken": "5289a345-0358-4e62-93d5-47ef3061d65e", "TrafficMirrorTarget": { "Description": "Network interface target", "NetworkInterfaceId": "eni-01f6f631eEXAMPLE", "TrafficMirrorTargetId": "tmt-02dcdbe2abEXAMPLE", "OwnerId": "111122223333", "Type": "network-interface", "Tags": [] } } ``` Consulte mais informações em [Create a traffic mirror target](https://docs.aws.amazon.com/vpc/latest/mirroring/create-traffic-mirroring-target.html) no *Guia de espelhamento de tráfego*. + Para ver detalhes da API, consulte [CreateTrafficMirrorTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-traffic-mirror-target.html) na *Referência de comandos da AWS CLI*. ### `create-transit-gateway-connect-peer` O código de exemplo a seguir mostra como usar `create-transit-gateway-connect-peer`. **AWS CLI** **Criar um par de conexão de gateway de trânsito** O exemplo `create-transit-gateway-connect-peer` a seguir cria um par de conexão. ``` aws ec2 create-transit-gateway-connect-peer \ --transit-gateway-attachment-id tgw-attach-0f0927767cEXAMPLE \ --peer-address 172.31.1.11 \ --inside-cidr-blocks 169.254.6.0/29 ``` Resultado: ``` { "TransitGatewayConnectPeer": { "TransitGatewayAttachmentId": "tgw-attach-0f0927767cEXAMPLE", "TransitGatewayConnectPeerId": "tgw-connect-peer-0666adbac4EXAMPLE", "State": "pending", "CreationTime": "2021-10-13T03:35:17.000Z", "ConnectPeerConfiguration": { "TransitGatewayAddress": "10.0.0.234", "PeerAddress": "172.31.1.11", "InsideCidrBlocks": [ "169.254.6.0/29" ], "Protocol": "gre", "BgpConfigurations": [ { "TransitGatewayAsn": 64512, "PeerAsn": 64512, "TransitGatewayAddress": "169.254.6.2", "PeerAddress": "169.254.6.1", "BgpStatus": "down" }, { "TransitGatewayAsn": 64512, "PeerAsn": 64512, "TransitGatewayAddress": "169.254.6.3", "PeerAddress": "169.254.6.1", "BgpStatus": "down" } ] } } } ``` Para obter mais informações, consulte [Anexos de conexão do gateway de trânsito e pares de conexão do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [CreateTransitGatewayConnectPeer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-transit-gateway-connect-peer.html) na *Referência de comandos da AWS CLI*. ### `create-transit-gateway-connect` O código de exemplo a seguir mostra como usar `create-transit-gateway-connect`. **AWS CLI** **Criar um anexo de conexão do gateway de trânsito** O exemplo `create-transit-gateway-connect` a seguir cria um anexo de conexão, com o protocolo “gre”, para o anexo especificado. ``` aws ec2 create-transit-gateway-connect \ --transport-transit-gateway-attachment-id tgw-attach-0a89069f57EXAMPLE \ --options "Protocol=gre" ``` Resultado: ``` { "TransitGatewayConnect": { "TransitGatewayAttachmentId": "tgw-attach-037012e5dcEXAMPLE", "TransportTransitGatewayAttachmentId": "tgw-attach-0a89069f57EXAMPLE", "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", "State": "pending", "CreationTime": "2021-03-09T19:59:17+00:00", "Options": { "Protocol": "gre" } } } ``` Para obter mais informações, consulte [Anexos de conexão do gateway de trânsito e pares de conexão do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [CreateTransitGatewayConnect](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-transit-gateway-connect.html) na *Referência de comandos da AWS CLI*. ### `create-transit-gateway-multicast-domain` O código de exemplo a seguir mostra como usar `create-transit-gateway-multicast-domain`. **AWS CLI** **Exemplo 1: um domínio multicast do IGMP** O exemplo `create-transit-gateway-multicast-domain` a seguir cria um domínio multicast para o gateway de trânsito especificado. Com as fontes estáticas desabilitadas, todas as instâncias nas sub-redes associadas ao domínio multicast podem enviar tráfego multicast. Se pelo menos um membro usar o protocolo IGMP, você deverá habilitar o suporte a IGMPv2. ``` aws ec2 create-transit-gateway-multicast-domain \ --transit-gateway-id tgw-0bf0bffefaEXAMPLE \ --options StaticSourcesSupport=disable,Igmpv2Support=enable ``` Resultado: ``` { "TransitGatewayMulticastDomain": { "TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c9e29e2a7EXAMPLE", "TransitGatewayId": "tgw-0bf0bffefaEXAMPLE", "TransitGatewayMulticastDomainArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-multicast-domain/tgw-mcast-domain-0c9e29e2a7EXAMPLE", "OwnerId": "123456789012", "Options": { "Igmpv2Support": "enable", "StaticSourcesSupport": "disable", "AutoAcceptSharedAssociations": "disable" }, "State": "pending", "CreationTime": "2021-09-29T22:17:13.000Z" } } ``` **Exemplo 2: criar um domínio multicast estático** O exemplo `create-transit-gateway-multicast-domain` a seguir cria um domínio multicast para o gateway de trânsito especificado. Com as fontes estáticas ativadas, você deve adicionar fontes estaticamente. ``` aws ec2 create-transit-gateway-multicast-domain \ --transit-gateway-id tgw-0bf0bffefaEXAMPLE \ --options StaticSourcesSupport=enable,Igmpv2Support=disable ``` Resultado: ``` { "TransitGatewayMulticastDomain": { "TransitGatewayMulticastDomainId": "tgw-mcast-domain-000fb24d04EXAMPLE", "TransitGatewayId": "tgw-0bf0bffefaEXAMPLE", "TransitGatewayMulticastDomainArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-multicast-domain/tgw-mcast-domain-000fb24d04EXAMPLE", "OwnerId": "123456789012", "Options": { "Igmpv2Support": "disable", "StaticSourcesSupport": "enable", "AutoAcceptSharedAssociations": "disable" }, "State": "pending", "CreationTime": "2021-09-29T22:20:19.000Z" } } ``` Para obter mais informações, consulte [Como gerenciar domínios multicast](https://docs.aws.amazon.com/vpc/latest/tgw/manage-domain.html) no *Guia de gateway de trânsito*. + Para ver detalhes da API, consulte [CreateTransitGatewayMulticastDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-transit-gateway-multicast-domain.html) na *Referência de comandos da AWS CLI*. ### `create-transit-gateway-peering-attachment` O código de exemplo a seguir mostra como usar `create-transit-gateway-peering-attachment`. **AWS CLI** **Criar um anexo de emparelhamento do gateway de trânsito** O exemplo `create-transit-gateway-peering-attachment` a seguir cria uma solicitação de anexo de emparelhamento entre os dois gateways de trânsito especificados. ``` aws ec2 create-transit-gateway-peering-attachment \ --transit-gateway-id tgw-123abc05e04123abc \ --peer-transit-gateway-id tgw-11223344aabbcc112 \ --peer-account-id 123456789012 \ --peer-region us-east-2 ``` Resultado: ``` { "TransitGatewayPeeringAttachment": { "TransitGatewayAttachmentId": "tgw-attach-4455667788aabbccd", "RequesterTgwInfo": { "TransitGatewayId": "tgw-123abc05e04123abc", "OwnerId": "123456789012", "Region": "us-west-2" }, "AccepterTgwInfo": { "TransitGatewayId": "tgw-11223344aabbcc112", "OwnerId": "123456789012", "Region": "us-east-2" }, "State": "initiatingRequest", "CreationTime": "2019-12-09T11:38:05.000Z" } } ``` Para obter mais informações, consulte [Anexos de pareamento do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-peering.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [CreateTransitGatewayPeeringAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-transit-gateway-peering-attachment.html) na *Referência de comandos da AWS CLI*. ### `create-transit-gateway-policy-table` O código de exemplo a seguir mostra como usar `create-transit-gateway-policy-table`. **AWS CLI** **Criar uma tabela de políticas de gateway de trânsito** O exemplo `create-transit-gateway-policy-table` a seguir cria uma tabela de políticas de gateway de trânsito para o gateway de trânsito especificado. ``` aws ec2 create-transit-gateway-policy-table \ --transit-gateway-id tgw-067f8505c18f0bd6e ``` Resultado: ``` { "TransitGatewayPolicyTable": { "TransitGatewayPolicyTableId": "tgw-ptb-0a16f134b78668a81", "TransitGatewayId": "tgw-067f8505c18f0bd6e", "State": "pending", "CreationTime": "2023-11-28T16:36:43+00:00" } } ``` Para obter mais informações, consulte [Tabelas de política do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-policy-tables.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [CreateTransitGatewayPolicyTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-transit-gateway-policy-table.html) na *Referência de comandos da AWS CLI*. ### `create-transit-gateway-prefix-list-reference` O código de exemplo a seguir mostra como usar `create-transit-gateway-prefix-list-reference`. **AWS CLI** **Criar uma referência de lista de prefixos** O exemplo `create-transit-gateway-prefix-list-reference` a seguir cria uma referência à lista de prefixos especificada na tabela de rotas do gateway de trânsito especificada. ``` aws ec2 create-transit-gateway-prefix-list-reference \ --transit-gateway-route-table-id tgw-rtb-0123456789abcd123 \ --prefix-list-id pl-11111122222222333 \ --transit-gateway-attachment-id tgw-attach-aaaaaabbbbbb11111 ``` Resultado: ``` { "TransitGatewayPrefixListReference": { "TransitGatewayRouteTableId": "tgw-rtb-0123456789abcd123", "PrefixListId": "pl-11111122222222333", "PrefixListOwnerId": "123456789012", "State": "pending", "Blackhole": false, "TransitGatewayAttachment": { "TransitGatewayAttachmentId": "tgw-attach-aaaaaabbbbbb11111", "ResourceType": "vpc", "ResourceId": "vpc-112233445566aabbc" } } } ``` Consulte mais informações em [Create a prefix list reference](https://docs.aws.amazon.com/vpc/latest/tgw/create-prefix-list-reference.html) no *Guia do Transit Gateway*. + Para ver detalhes da API, consulte [CreateTransitGatewayPrefixListReference](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-transit-gateway-prefix-list-reference.html) na *Referência de comandos da AWS CLI*. ### `create-transit-gateway-route-table` O código de exemplo a seguir mostra como usar `create-transit-gateway-route-table`. **AWS CLI** **Criar uma tabela de rotas do gateway de trânsito** O exemplo `create-transit-gateway-route-table` a seguir cria uma tabela de rotas para o gateway de trânsito especificado. ``` aws ec2 create-transit-gateway-route-table \ --transit-gateway-id tgw-0262a0e521EXAMPLE ``` Resultado: ``` { "TransitGatewayRouteTable": { "TransitGatewayRouteTableId": "tgw-rtb-0960981be7EXAMPLE", "TransitGatewayId": "tgw-0262a0e521EXAMPLE", "State": "pending", "DefaultAssociationRouteTable": false, "DefaultPropagationRouteTable": false, "CreationTime": "2019-07-10T19:01:46.000Z" } } ``` Para obter mais informações, consulte [Criar uma tabelas de rotas do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html#create-tgw-route-table) no *Guia de gateway de trânsito*. + Para ver detalhes da API, consulte [CreateTransitGatewayRouteTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-transit-gateway-route-table.html) na *Referência de comandos da AWS CLI*. ### `create-transit-gateway-route` O código de exemplo a seguir mostra como usar `create-transit-gateway-route`. **AWS CLI** **Criar uma rota do gateway de trânsito** O exemplo `create-transit-gateway-route` a seguir cria uma rota, com o destino especificado, para a tabela de rotas especificada. ``` aws ec2 create-transit-gateway-route \ --destination-cidr-block 10.0.2.0/24 \ --transit-gateway-route-table-id tgw-rtb-0b6f6aaa01EXAMPLE \ --transit-gateway-attachment-id tgw-attach-0b5968d3b6EXAMPLE ``` Resultado: ``` { "Route": { "DestinationCidrBlock": "10.0.2.0/24", "TransitGatewayAttachments": [ { "ResourceId": "vpc-0065acced4EXAMPLE", "TransitGatewayAttachmentId": "tgw-attach-0b5968d3b6EXAMPLE", "ResourceType": "vpc" } ], "Type": "static", "State": "active" } } ``` Para obter mais informações, consulte [Tabelas de rota do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [CreateTransitGatewayRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-transit-gateway-route.html) na *Referência de comandos da AWS CLI*. ### `create-transit-gateway-vpc-attachment` O código de exemplo a seguir mostra como usar `create-transit-gateway-vpc-attachment`. **AWS CLI** **Exemplo 1: associar um gateway de trânsito a uma VPC** O exemplo `create-transit-gateway-vpc-attachment` a seguir cria um anexo do gateway de trânsito à VPC especificada. ``` aws ec2 create-transit-gateway-vpc-attachment \ --transit-gateway-id tgw-0262a0e521EXAMPLE \ --vpc-id vpc-07e8ffd50f49335df \ --subnet-id subnet-0752213d59EXAMPLE ``` Resultado: ``` { "TransitGatewayVpcAttachment": { "TransitGatewayAttachmentId": "tgw-attach-0a34fe6b4fEXAMPLE", "TransitGatewayId": "tgw-0262a0e521EXAMPLE", "VpcId": "vpc-07e8ffd50fEXAMPLE", "VpcOwnerId": "111122223333", "State": "pending", "SubnetIds": [ "subnet-0752213d59EXAMPLE" ], "CreationTime": "2019-07-10T17:33:46.000Z", "Options": { "DnsSupport": "enable", "Ipv6Support": "disable" } } } ``` Para obter mais informações, consulte [Criar um anexo do gateway de trânsito para uma VPC](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-vpc-attachments.html#create-vpc-attachment) no *Guia do gateway de trânsito*. **Exemplo 2: associar um gateway de trânsito a várias sub-redes em uma VPC** O exemplo `create-transit-gateway-vpc-attachment` a seguir cria um anexo do gateway de trânsito à VPC e às sub-redes especificadas. ``` aws ec2 create-transit-gateway-vpc-attachment \ --transit-gateway-id tgw-02f776b1a7EXAMPLE \ --vpc-id vpc-3EXAMPLE \ --subnet-ids "subnet-dEXAMPLE" "subnet-6EXAMPLE" ``` Resultado: ``` { "TransitGatewayVpcAttachment": { "TransitGatewayAttachmentId": "tgw-attach-0e141e0bebEXAMPLE", "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", "VpcId": "vpc-3EXAMPLE", "VpcOwnerId": "111122223333", "State": "pending", "SubnetIds": [ "subnet-6EXAMPLE", "subnet-dEXAMPLE" ], "CreationTime": "2019-12-17T20:07:52.000Z", "Options": { "DnsSupport": "enable", "Ipv6Support": "disable" } } } ``` Para obter mais informações, consulte [Criar um anexo do gateway de trânsito para uma VPC](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-vpc-attachments.html#create-vpc-attachment) no *Guia do gateway de trânsito*. + Para ver detalhes da API, consulte [CreateTransitGatewayVpcAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-transit-gateway-vpc-attachment.html) na *AWS CLI Referência de comando*. ### `create-transit-gateway` O código de exemplo a seguir mostra como usar `create-transit-gateway`. **AWS CLI** **Criar um gateway de trânsito** O exemplo `create-transit-gateway` a seguir cria um gateway de trânsito. ``` aws ec2 create-transit-gateway \ --description MyTGW \ --options AmazonSideAsn=64516,AutoAcceptSharedAttachments=enable,DefaultRouteTableAssociation=enable,DefaultRouteTablePropagation=enable,VpnEcmpSupport=enable,DnsSupport=enable ``` Resultado: ``` { "TransitGateway": { "TransitGatewayId": "tgw-0262a0e521EXAMPLE", "TransitGatewayArn": "arn:aws:ec2:us-east-2:111122223333:transit-gateway/tgw-0262a0e521EXAMPLE", "State": "pending", "OwnerId": "111122223333", "Description": "MyTGW", "CreationTime": "2019-07-10T14:02:12.000Z", "Options": { "AmazonSideAsn": 64516, "AutoAcceptSharedAttachments": "enable", "DefaultRouteTableAssociation": "enable", "AssociationDefaultRouteTableId": "tgw-rtb-018774adf3EXAMPLE", "DefaultRouteTablePropagation": "enable", "PropagationDefaultRouteTableId": "tgw-rtb-018774adf3EXAMPLE", "VpnEcmpSupport": "enable", "DnsSupport": "enable" } } } ``` Para obter mais informações, consulte [Criar um gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-transit-gateways.html#create-tgw) no *Guia de gateway de trânsito*. + Para ver detalhes da API, consulte [CreateTransitGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-transit-gateway.html) na *Referência de comandos da AWS CLI*. ### `create-verified-access-endpoint` O código de exemplo a seguir mostra como usar `create-verified-access-endpoint`. **AWS CLI** **Criar um endpoint do acesso verificado** O exemplo `create-verified-access-endpoint` a seguir cria um endpoint de acesso verificado para o grupo de acesso verificado especificado. A interface de rede e o grupo de segurança especificados devem pertencem à mesma VPC. ``` aws ec2 create-verified-access-endpoint \ --verified-access-group-id vagr-0dbe967baf14b7235 \ --endpoint-type network-interface \ --attachment-type vpc \ --domain-certificate-arn arn:aws:acm:us-east-2:123456789012:certificate/eb065ea0-26f9-4e75-a6ce-0a1a7EXAMPLE \ --application-domain example.com \ --endpoint-domain-prefix my-ava-app \ --security-group-ids sg-004915970c4c8f13a \ --network-interface-options NetworkInterfaceId=eni-0aec70418c8d87a0f,Protocol=https,Port=443 \ --tag-specifications ResourceType=verified-access-endpoint,Tags=[{Key=Name,Value=my-va-endpoint}] ``` Resultado: ``` { "VerifiedAccessEndpoint": { "VerifiedAccessInstanceId": "vai-0ce000c0b7643abea", "VerifiedAccessGroupId": "vagr-0dbe967baf14b7235", "VerifiedAccessEndpointId": "vae-066fac616d4d546f2", "ApplicationDomain": "example.com", "EndpointType": "network-interface", "AttachmentType": "vpc", "DomainCertificateArn": "arn:aws:acm:us-east-2:123456789012:certificate/eb065ea0-26f9-4e75-a6ce-0a1a7EXAMPLE", "EndpointDomain": "my-ava-app.edge-00c3372d53b1540bb.vai-0ce000c0b7643abea.prod.verified-access.us-east-2.amazonaws.com", "SecurityGroupIds": [ "sg-004915970c4c8f13a" ], "NetworkInterfaceOptions": { "NetworkInterfaceId": "eni-0aec70418c8d87a0f", "Protocol": "https", "Port": 443 }, "Status": { "Code": "pending" }, "Description": "", "CreationTime": "2023-08-25T20:54:43", "LastUpdatedTime": "2023-08-25T20:54:43", "Tags": [ { "Key": "Name", "Value": "my-va-endpoint" } ] } } ``` Para obter mais informações, consulte [Endpoints de acesso verificado](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-endpoints.html) no *Guia do usuário do acesso verificado da AWS*. + Para ver detalhes da API, consulte [CreateVerifiedAccessEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-verified-access-endpoint.html) na *Referência de comandos da AWS CLI*. ### `create-verified-access-group` O código de exemplo a seguir mostra como usar `create-verified-access-group`. **AWS CLI** **Criar um grupo do acesso verificado** O exemplo `create-verified-access-group` a seguir cria um grupo de acesso verificado para a instância especificada do acesso verificado. ``` aws ec2 create-verified-access-group \ --verified-access-instance-id vai-0ce000c0b7643abea \ --tag-specifications ResourceType=verified-access-group,Tags=[{Key=Name,Value=my-va-group}] ``` Resultado: ``` { "VerifiedAccessGroup": { "VerifiedAccessGroupId": "vagr-0dbe967baf14b7235", "VerifiedAccessInstanceId": "vai-0ce000c0b7643abea", "Description": "", "Owner": "123456789012", "VerifiedAccessGroupArn": "arn:aws:ec2:us-east-2:123456789012:verified-access-group/vagr-0dbe967baf14b7235", "CreationTime": "2023-08-25T19:55:19", "LastUpdatedTime": "2023-08-25T19:55:19", "Tags": [ { "Key": "Name", "Value": "my-va-group" } ] } } ``` Para obter mais informações, consulte [Grupos de acesso verificado](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-groups.html) no *Guia do usuário do acesso verificado da AWS*. + Para ver detalhes da API, consulte [CreateVerifiedAccessGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-verified-access-group.html) na *Referência de comandos da AWS CLI*. ### `create-verified-access-instance` O código de exemplo a seguir mostra como usar `create-verified-access-instance`. **AWS CLI** **Criar uma instância do acesso verificado** O exemplo `create-verified-access-instance` a seguir cria uma instância de acesso verificado com uma tag de Nome. ``` aws ec2 create-verified-access-instance \ --tag-specifications ResourceType=verified-access-instance,Tags=[{Key=Name,Value=my-va-instance}] ``` Resultado: ``` { "VerifiedAccessInstance": { "VerifiedAccessInstanceId": "vai-0ce000c0b7643abea", "Description": "", "VerifiedAccessTrustProviders": [], "CreationTime": "2023-08-25T18:27:56", "LastUpdatedTime": "2023-08-25T18:27:56", "Tags": [ { "Key": "Name", "Value": "my-va-instance" } ] } } ``` Para obter mais informações, consulte [Instâncias de acesso verificado](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-instances.html) no *Guia do usuário do acesso verificado da AWS*. + Para ver detalhes da API, consulte [CreateVerifiedAccessInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-verified-access-instance.html) na *Referência de comandos da AWS CLI*. ### `create-verified-access-trust-provider` O código de exemplo a seguir mostra como usar `create-verified-access-trust-provider`. **AWS CLI** **Criar um provedor confiável de acesso verificado** O exemplo `create-verified-access-trust-provider` a seguir configura um provedor confiável de acesso verificado usando a Central de Identidade AWS. ``` aws ec2 create-verified-access-trust-provider \ --trust-provider-type user \ --user-trust-provider-type iam-identity-center \ --policy-reference-name idc \ --tag-specifications ResourceType=verified-access-trust-provider,Tags=[{Key=Name,Value=my-va-trust-provider}] ``` Resultado: ``` { "VerifiedAccessTrustProvider": { "VerifiedAccessTrustProviderId": "vatp-0bb32de759a3e19e7", "Description": "", "TrustProviderType": "user", "UserTrustProviderType": "iam-identity-center", "PolicyReferenceName": "idc", "CreationTime": "2023-08-25T18:40:36", "LastUpdatedTime": "2023-08-25T18:40:36", "Tags": [ { "Key": "Name", "Value": "my-va-trust-provider" } ] } } ``` Para obter mais informações, consulte [Provedores confiáveis para acesso verificado](https://docs.aws.amazon.com/verified-access/latest/ug/trust-providers.html) no *Guia do usuário de acesso verificado da AWS*. + Para ver detalhes da API, consulte [CreateVerifiedAccessTrustProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-verified-access-trust-provider.html) na *AWS CLI Referência de comando*. ### `create-volume` O código de exemplo a seguir mostra como usar `create-volume`. **AWS CLI** **Criar um volume SSD de uso geral (gp2) vazio** O exemplo `create-volume` a seguir cria um volume SSD de uso geral (gp2) de 80 GiB na zona de disponibilidade especificada. Observe que a região atual deve ser `us-east-1`, ou você pode adicionar o parâmetro `--region` para especificar a região para o comando. ``` aws ec2 create-volume \ --volume-type gp2 \ --size 80 \ --availability-zone us-east-1a ``` Resultado: ``` { "AvailabilityZone": "us-east-1a", "Tags": [], "Encrypted": false, "VolumeType": "gp2", "VolumeId": "vol-1234567890abcdef0", "State": "creating", "Iops": 240, "SnapshotId": "", "CreateTime": "YYYY-MM-DDTHH:MM:SS.000Z", "Size": 80 } ``` Se você não especificar um tipo de volume, o tipo de volume padrão será `gp2`. ``` aws ec2 create-volume \ --size 80 \ --availability-zone us-east-1a ``` **Exemplo 2: criar um volume SSD (io1) de IOPS provisionadas de um snapshot** O exemplo `create-volume` a seguir cria um volume SSD de IOPS provisionadas (io1) com 1.000 IOPS provisionadas na Zona de Disponibilidade especificada usando o snapshot especificado. ``` aws ec2 create-volume \ --volume-type io1 \ --iops 1000 \ --snapshot-id snap-066877671789bd71b \ --availability-zone us-east-1a ``` Resultado: ``` { "AvailabilityZone": "us-east-1a", "Tags": [], "Encrypted": false, "VolumeType": "io1", "VolumeId": "vol-1234567890abcdef0", "State": "creating", "Iops": 1000, "SnapshotId": "snap-066877671789bd71b", "CreateTime": "YYYY-MM-DDTHH:MM:SS.000Z", "Size": 500 } ``` **Exemplo 3: criar um volume criptografado** O exemplo `create-volume` a seguir cria um volume criptografado usando a CMK padrão para criptografia do EBS. Se a criptografia por padrão estiver desabilitada, você deve especificar o parâmetro `--encrypted` da seguinte maneira. ``` aws ec2 create-volume \ --size 80 \ --encrypted \ --availability-zone us-east-1a ``` Resultado: ``` { "AvailabilityZone": "us-east-1a", "Tags": [], "Encrypted": true, "VolumeType": "gp2", "VolumeId": "vol-1234567890abcdef0", "State": "creating", "Iops": 240, "SnapshotId": "", "CreateTime": "YYYY-MM-DDTHH:MM:SS.000Z", "Size": 80 } ``` Se a criptografia estiver habilitada por padrão, o comando de exemplo a seguir criará um volume criptografado, mesmo sem o parâmetro `--encrypted`. ``` aws ec2 create-volume \ --size 80 \ --availability-zone us-east-1a ``` Se você usar o parâmetro `--kms-key-id` para especificar uma CMK gerenciada pelo cliente, você deverá especificar o parâmetro `--encrypted` mesmo que a criptografia por padrão esteja habilitada. ``` aws ec2 create-volume \ --volume-type gp2 \ --size 80 \ --encrypted \ --kms-key-id 0ea3fef3-80a7-4778-9d8c-1c0c6EXAMPLE \ --availability-zone us-east-1a ``` **Exemplo 4: criar um volume com tags** O exemplo `create-volume` a seguir cria um volume e adiciona duas tags. ``` aws ec2 create-volume \ --availability-zone us-east-1a \ --volume-type gp2 \ --size 80 \ --tag-specifications 'ResourceType=volume,Tags=[{Key=purpose,Value=production},{Key=cost-center,Value=cc123}]' ``` + Para ver detalhes da API, consulte [CreateVolume](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-volume.html) na *Referência de comandos da AWS CLI*. ### `create-vpc-endpoint-connection-notification` O código de exemplo a seguir mostra como usar `create-vpc-endpoint-connection-notification`. **AWS CLI** **Criar uma notificação de conexão endpoint** Este exemplo cria uma notificação para um serviço de endpoint específico que alerta você quando os endpoints da interface se conectam ao seu serviço e quando os endpoints são aceitos para o seu serviço. Comando: ``` aws ec2 create-vpc-endpoint-connection-notification --connection-notification-arn arn:aws:sns:us-east-2:123456789012:VpceNotification --connection-events Connect Accept --service-id vpce-svc-1237881c0d25a3abc ``` Resultado: ``` { "ConnectionNotification": { "ConnectionNotificationState": "Enabled", "ConnectionNotificationType": "Topic", "ServiceId": "vpce-svc-1237881c0d25a3abc", "ConnectionEvents": [ "Accept", "Connect" ], "ConnectionNotificationId": "vpce-nfn-008776de7e03f5abc", "ConnectionNotificationArn": "arn:aws:sns:us-east-2:123456789012:VpceNotification" } } ``` + Para ver detalhes da API, consulte [CreateVpcEndpointConnectionNotification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-vpc-endpoint-connection-notification.html) na *Referência de comandos da AWS CLI*. ### `create-vpc-endpoint-service-configuration` O código de exemplo a seguir mostra como usar `create-vpc-endpoint-service-configuration`. **AWS CLI** **Exemplo 1: criar uma configuração de serviço de endpoint para um endpoint de interface** O exemplo `create-vpc-endpoint-service-configuration` a seguir cria uma configuração de serviço de endpoint da VPC usando o Network Load Balancer `nlb-vpce`. Esse exemplo também especifica que as solicitações para se conectar ao serviço por meio de um endpoint de interface devem ser aceitas. ``` aws ec2 create-vpc-endpoint-service-configuration \ --network-load-balancer-arns arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/nlb-vpce/e94221227f1ba532 \ --acceptance-required ``` Resultado: ``` { "ServiceConfiguration": { "ServiceType": [ { "ServiceType": "Interface" } ], "NetworkLoadBalancerArns": [ "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/nlb-vpce/e94221227f1ba532" ], "ServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-03d5ebb7d9579a2b3", "ServiceState": "Available", "ServiceId": "vpce-svc-03d5ebb7d9579a2b3", "AcceptanceRequired": true, "AvailabilityZones": [ "us-east-1d" ], "BaseEndpointDnsNames": [ "vpce-svc-03d5ebb7d9579a2b3.us-east-1.vpce.amazonaws.com" ] } } ``` Consulte mais informações em [Create an endpoint service](https://docs.aws.amazon.com/vpc/latest/privatelink/create-endpoint-service.html) no *Guia do usuário do AWS PrivateLink*. **Exemplo 2: criar uma configuração de serviço de endpoint para endpoints do balanceador de carga de gateway** O exemplo `create-vpc-endpoint-service-configuration` a seguir cria uma configuração de serviço de endpoint da VPC usando o Balanceador de Carga de Gateway `GWLBService`. Solicitações para se conectar ao serviço por meio de um endpoint do Balanceador de Carga de Gateway são aceitas automaticamente. ``` aws ec2 create-vpc-endpoint-service-configuration \ --gateway-load-balancer-arns arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/gwy/GWLBService/123123123123abcc \ --no-acceptance-required ``` Resultado: ``` { "ServiceConfiguration": { "ServiceType": [ { "ServiceType": "GatewayLoadBalancer" } ], "ServiceId": "vpce-svc-123123a1c43abc123", "ServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-123123a1c43abc123", "ServiceState": "Available", "AvailabilityZones": [ "us-east-1d" ], "AcceptanceRequired": false, "ManagesVpcEndpoints": false, "GatewayLoadBalancerArns": [ "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/gwy/GWLBService/123123123123abcc" ] } } ``` Consulte mais informações em [Create a Gateway Load Balancer endpoint service](https://docs.aws.amazon.com/vpc/latest/privatelink/create-gateway-load-balancer-endpoint-service.html) no *Guia do usuário do AWS PrivateLink*. + Para ver detalhes da API, consulte [CreateVpcEndpointServiceConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-vpc-endpoint-service-configuration.html) na *Referência de comandos da AWS CLI*. ### `create-vpc-endpoint` O código de exemplo a seguir mostra como usar `create-vpc-endpoint`. **AWS CLI** **Exemplo 1: criar um endpoint de gateway** O exemplo `create-vpc-endpoint` a seguir cria um endpoint da VPC de gateway entre a VPC `vpc-1a2b3c4d` e o Amazon S3 na região `us-east-1` e associa a tabela de rotas `rtb-11aa22bb` ao endpoint. ``` aws ec2 create-vpc-endpoint \ --vpc-id vpc-1a2b3c4d \ --service-name com.amazonaws.us-east-1.s3 \ --route-table-ids rtb-11aa22bb ``` Resultado: ``` { "VpcEndpoint": { "PolicyDocument": "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Sid\":\"\",\"Effect\":\"Allow\",\"Principal\":\"\*\",\"Action\":\"\*\",\"Resource\":\"\*\"}]}", "VpcId": "vpc-1a2b3c4d", "State": "available", "ServiceName": "com.amazonaws.us-east-1.s3", "RouteTableIds": [ "rtb-11aa22bb" ], "VpcEndpointId": "vpc-1a2b3c4d", "CreationTimestamp": "2015-05-15T09:40:50Z" } } ``` Consulte mais informações em [Create a gateway endpoint](https://docs.aws.amazon.com/vpc/latest/privatelink/vpc-endpoints-s3.html#create-gateway-endpoint-s3) no *Guia do usuário do AWS PrivateLink*. **Exemplo 2: criar um endpoint de interface** O exemplo `create-vpc-endpoint` a seguir cria uma interface de endpoint da VPC entre a VPC `vpc-1a2b3c4d` e o Amazon S3 na região `us-east-1`. O comando cria o endpoint na sub-rede `subnet-1a2b3c4d`, o associa ao grupo de segurança `sg-1a2b3c4d` e adiciona uma tag com uma chave de “Serviço” e um valor de “S3". ``` aws ec2 create-vpc-endpoint \ --vpc-id vpc-1a2b3c4d \ --vpc-endpoint-type Interface \ --service-name com.amazonaws.us-east-1.s3 \ --subnet-ids subnet-7b16de0c \ --security-group-id sg-1a2b3c4d \ --tag-specifications ResourceType=vpc-endpoint,Tags=[{Key=service,Value=S3}] ``` Resultado: ``` { "VpcEndpoint": { "VpcEndpointId": "vpce-1a2b3c4d5e6f1a2b3", "VpcEndpointType": "Interface", "VpcId": "vpc-1a2b3c4d", "ServiceName": "com.amazonaws.us-east-1.s3", "State": "pending", "RouteTableIds": [], "SubnetIds": [ "subnet-1a2b3c4d" ], "Groups": [ { "GroupId": "sg-1a2b3c4d", "GroupName": "default" } ], "PrivateDnsEnabled": false, "RequesterManaged": false, "NetworkInterfaceIds": [ "eni-0b16f0581c8ac6877" ], "DnsEntries": [ { "DnsName": "*.vpce-1a2b3c4d5e6f1a2b3-9hnenorg.s3.us-east-1.vpce.amazonaws.com", "HostedZoneId": "Z7HUB22UULQXV" }, { "DnsName": "*.vpce-1a2b3c4d5e6f1a2b3-9hnenorg-us-east-1c.s3.us-east-1.vpce.amazonaws.com", "HostedZoneId": "Z7HUB22UULQXV" } ], "CreationTimestamp": "2021-03-05T14:46:16.030000+00:00", "Tags": [ { "Key": "service", "Value": "S3" } ], "OwnerId": "123456789012" } } ``` Consulte mais informações em [Create an interface VPC endpoint](https://docs.aws.amazon.com/vpc/latest/privatelink/create-interface-endpoint.html) no *Guia do usuário do AWS PrivateLink*. **Exemplo 3: criar um endpoint do balanceador de carga de gateway** O exemplo `create-vpc-endpoint` a seguir cria um endpoint do balanceador de carga de Gateway entre a VPC `vpc-111122223333aabbc` e um serviço configurado usando o balanceador de carga de Gateway. ``` aws ec2 create-vpc-endpoint \ --service-name com.amazonaws.vpce.us-east-1.vpce-svc-123123a1c43abc123 \ --vpc-endpoint-type GatewayLoadBalancer \ --vpc-id vpc-111122223333aabbc \ --subnet-ids subnet-0011aabbcc2233445 ``` Resultado: ``` { "VpcEndpoint": { "VpcEndpointId": "vpce-aabbaabbaabbaabba", "VpcEndpointType": "GatewayLoadBalancer", "VpcId": "vpc-111122223333aabbc", "ServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-123123a1c43abc123", "State": "pending", "SubnetIds": [ "subnet-0011aabbcc2233445" ], "RequesterManaged": false, "NetworkInterfaceIds": [ "eni-01010120203030405" ], "CreationTimestamp": "2020-11-11T08:06:03.522Z", "OwnerId": "123456789012" } } ``` Consulte mais informações em [Gateway Load Balancer endpoints](https://docs.aws.amazon.com/vpc/latest/privatelink/gateway-load-balancer-endpoints.html) no *Guia do Usuário do AWS PrivateLink*. **Exemplo 4: como criar um endpoint de recurso** O exemplo de `create-vpc-endpoint` a seguir cria um endpoint de recurso. ``` aws ec2 create-vpc-endpoint \ --vpc-endpoint-type Resource \ --vpc-id vpc-111122223333aabbc \ --subnet-ids subnet-0011aabbcc2233445 \ --resource-configuration-arn arn:aws:vpc-lattice-us-east-1:123456789012:resourceconfiguration/rcfg-0123abcde98765432 ``` Resultado: ``` { "VpcEndpoint": { "VpcEndpointId": "vpce-00939a7ed9EXAMPLE", "VpcEndpointType": "Resource", "VpcId": "vpc-111122223333aabbc", "State": "Pending", "SubnetIds": [ "subnet-0011aabbcc2233445" ], "Groups": [ { "GroupId": "sg-03e2f15fbfc09b000", "GroupName": "default" } ], "IpAddressType": "IPV4", "PrivateDnsEnabled": false, "CreationTimestamp": "2025-02-06T23:38:49.525000+00:00", "Tags": [], "OwnerId": "123456789012", "ResourceConfigurationArn": "arn:aws:vpc-lattice:us-east-1:123456789012:resourceconfiguration/rcfg-0123abcde98765432" } } ``` Consulte mais informações em [Resource endpoints](https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-access-resources.html) no *Guia do usuário do AWS PrivateLink*. **Exemplo 5: como criar um endpoint de rede de serviço** O exemplo de `create-vpc-endpoint` a seguir cria um endpoint de rede de serviço. ``` aws ec2 create-vpc-endpoint \ --vpc-endpoint-type ServiceNetwork \ --vpc-id vpc-111122223333aabbc \ --subnet-ids subnet-0011aabbcc2233445 \ --service-network-arn arn:aws:vpc-lattice:us-east-1:123456789012:servicenetwork/sn-0101abcd5432abcd0 \ --security-group-ids sg-0123456789012abcd ``` Resultado: ``` { "VpcEndpoint": { "VpcEndpointId": "vpce-0f00567fa8EXAMPLE", "VpcEndpointType": "ServiceNetwork", "VpcId": "vpc-111122223333aabbc", "State": "Pending", "SubnetIds": [ "subnet-0011aabbcc2233445" ], "Groups": [ { "GroupId": "sg-0123456789012abcd", "GroupName": "my-security-group" } ], "IpAddressType": "IPV4", "PrivateDnsEnabled": false, "CreationTimestamp": "2025-02-06T23:44:20.449000+00:00", "Tags": [], "OwnerId": "123456789012", "ServiceNetworkArn": "arn:aws:vpc-lattice:us-east-1:123456789012:servicenetwork/sn-0101abcd5432abcd0" } } ``` Consulte mais informações em [Service network endpoints](https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-access-service-networks.html) no *Guia do usuário do AWS PrivateLink*. + Para ver detalhes da API, consulte [CreateVpcEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-vpc-endpoint.html) na *Referência de comandos da AWS CLI*. ### `create-vpc-peering-connection` O código de exemplo a seguir mostra como usar `create-vpc-peering-connection`. **AWS CLI** **Criar uma conexão de emparelhamento da VPC entre as VPCs** Este exemplo solicita uma conexão de emparelhamento entre suas VPCs vpc-1a2b3c4d e vpc-11122233. Comando: ``` aws ec2 create-vpc-peering-connection --vpc-id vpc-1a2b3c4d --peer-vpc-id vpc-11122233 ``` Resultado: ``` { "VpcPeeringConnection": { "Status": { "Message": "Initiating Request to 444455556666", "Code": "initiating-request" }, "Tags": [], "RequesterVpcInfo": { "OwnerId": "444455556666", "VpcId": "vpc-1a2b3c4d", "CidrBlock": "10.0.0.0/28" }, "VpcPeeringConnectionId": "pcx-111aaa111", "ExpirationTime": "2014-04-02T16:13:36.000Z", "AccepterVpcInfo": { "OwnerId": "444455556666", "VpcId": "vpc-11122233" } } } ``` **Criar uma conexão de emparelhamento da VPC com uma VPC em outra conta** Este exemplo solicita uma conexão de emparelhamento entre sua VPC (vpc-1a2b3c4d) e uma VPC (vpc-11122233) que pertence à conta AWS 123456789012. Comando: ``` aws ec2 create-vpc-peering-connection --vpc-id vpc-1a2b3c4d --peer-vpc-id vpc-11122233 --peer-owner-id 123456789012 ``` **Criar uma conexão de emparelhamento da VPC com uma VPC em uma região diferente** Este exemplo solicita uma conexão de emparelhamento entre sua VPC na região atual (vpc-1a2b3c4d) e uma VPC (vpc-11122233) em sua conta na região `us-west-2`. Comando: ``` aws ec2 create-vpc-peering-connection --vpc-id vpc-1a2b3c4d --peer-vpc-id vpc-11122233 --peer-region us-west-2 ``` Este exemplo solicita uma conexão de emparelhamento entre sua VPC na região atual (vpc-1a2b3c4d) e uma VPC (vpc-11122233) que pertence à conta AWS 123456789012 que está na região `us-west-2`. Comando: ``` aws ec2 create-vpc-peering-connection --vpc-id vpc-1a2b3c4d --peer-vpc-id vpc-11122233 --peer-owner-id 123456789012 --peer-region us-west-2 ``` + Para ver detalhes da API, consulte [CreateVpcPeeringConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-vpc-peering-connection.html) na *Referência de comandos da AWS CLI*. ### `create-vpc` O código de exemplo a seguir mostra como usar `create-vpc`. **AWS CLI** **Exemplo 1: criar uma VPC** O exemplo `create-vpc` a seguir cria uma VPC com o bloco CIDR IPv4 especificado e uma tag de nome. ``` aws ec2 create-vpc \ --cidr-block 10.0.0.0/16 \ --tag-specifications ResourceType=vpc,Tags=[{Key=Name,Value=MyVpc}] ``` Resultado: ``` { "Vpc": { "CidrBlock": "10.0.0.0/16", "DhcpOptionsId": "dopt-5EXAMPLE", "State": "pending", "VpcId": "vpc-0a60eb65b4EXAMPLE", "OwnerId": "123456789012", "InstanceTenancy": "default", "Ipv6CidrBlockAssociationSet": [], "CidrBlockAssociationSet": [ { "AssociationId": "vpc-cidr-assoc-07501b79ecEXAMPLE", "CidrBlock": "10.0.0.0/16", "CidrBlockState": { "State": "associated" } } ], "IsDefault": false, "Tags": [ { "Key": "Name", "Value": MyVpc" } ] } } ``` **Exemplo 2: para criar uma VPC com locação dedicada** O exemplo `create-vpc` a seguir cria uma VPC com o bloco CIDR IPv4 especificado e locação dedicada. ``` aws ec2 create-vpc \ --cidr-block 10.0.0.0/16 \ --instance-tenancy dedicated ``` Resultado: ``` { "Vpc": { "CidrBlock": "10.0.0.0/16", "DhcpOptionsId": "dopt-19edf471", "State": "pending", "VpcId": "vpc-0a53287fa4EXAMPLE", "OwnerId": "111122223333", "InstanceTenancy": "dedicated", "Ipv6CidrBlockAssociationSet": [], "CidrBlockAssociationSet": [ { "AssociationId": "vpc-cidr-assoc-00b24cc1c2EXAMPLE", "CidrBlock": "10.0.0.0/16", "CidrBlockState": { "State": "associated" } } ], "IsDefault": false } } ``` **Exemplo 3: criar uma VPC com um bloco CIDR IPv** O exemplo `create-vpc` a seguir cria uma VPC com um bloco CIDR IPv6 fornecido pela Amazon. ``` aws ec2 create-vpc \ --cidr-block 10.0.0.0/16 \ --amazon-provided-ipv6-cidr-block ``` Resultado: ``` { "Vpc": { "CidrBlock": "10.0.0.0/16", "DhcpOptionsId": "dopt-dEXAMPLE", "State": "pending", "VpcId": "vpc-0fc5e3406bEXAMPLE", "OwnerId": "123456789012", "InstanceTenancy": "default", "Ipv6CidrBlockAssociationSet": [ { "AssociationId": "vpc-cidr-assoc-068432c60bEXAMPLE", "Ipv6CidrBlock": "", "Ipv6CidrBlockState": { "State": "associating" }, "Ipv6Pool": "Amazon", "NetworkBorderGroup": "us-west-2" } ], "CidrBlockAssociationSet": [ { "AssociationId": "vpc-cidr-assoc-0669f8f9f5EXAMPLE", "CidrBlock": "10.0.0.0/16", "CidrBlockState": { "State": "associated" } } ], "IsDefault": false } } ``` **Exemplo 4: criar uma VPC com um CIDR de um grupo do IPAM** O exemplo `create-vpc` a seguir cria uma VPC com um CIDR de um conjunto do gerenciador de endereços IP (IPAM) da Amazon VPC. Linux e macOS: ``` aws ec2 create-vpc \ --ipv4-ipam-pool-id ipam-pool-0533048da7d823723 \ --tag-specifications ResourceType=vpc,Tags='[{Key=Environment,Value="Preprod"},{Key=Owner,Value="Build Team"}]' ``` Windows: ``` aws ec2 create-vpc ^ --ipv4-ipam-pool-id ipam-pool-0533048da7d823723 ^ --tag-specifications ResourceType=vpc,Tags=[{Key=Environment,Value="Preprod"},{Key=Owner,Value="Build Team"}] ``` Resultado: ``` { "Vpc": { "CidrBlock": "10.0.1.0/24", "DhcpOptionsId": "dopt-2afccf50", "State": "pending", "VpcId": "vpc-010e1791024eb0af9", "OwnerId": "123456789012", "InstanceTenancy": "default", "Ipv6CidrBlockAssociationSet": [], "CidrBlockAssociationSet": [ { "AssociationId": "vpc-cidr-assoc-0a77de1d803226d4b", "CidrBlock": "10.0.1.0/24", "CidrBlockState": { "State": "associated" } } ], "IsDefault": false, "Tags": [ { "Key": "Environment", "Value": "Preprod" }, { "Key": "Owner", "Value": "Build Team" } ] } } ``` Para obter mais informações, consulte [Criar uma VPC que usa um CIDR de um conjunto do IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/create-vpc-ipam.html) no *Guia do usuário do IPAM da Amazon VPC*. + Consulte detalhes da API em [CreateVpc](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-vpc.html) na *Referência de comandos da AWS CLI*. ### `create-vpn-connection-route` O código de exemplo a seguir mostra como usar `create-vpn-connection-route`. **AWS CLI** **Criar uma rota estática para uma conexão VPN** Este exemplo cria uma rota estática para a VPN especificada. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 create-vpn-connection-route --vpn-connection-id vpn-40f41529 --destination-cidr-block 11.12.0.0/16 ``` + Para ver detalhes da API, consulte [CreateVpnConnectionRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-vpn-connection-route.html) na *Referência de comandos da AWS CLI*. ### `create-vpn-connection` O código de exemplo a seguir mostra como usar `create-vpn-connection`. **AWS CLI** **Exemplo 1: criar uma conexão VPN com roteamento dinâmico** O exemplo `create-vpn-connection` a seguir cria uma conexão VPN entre o gateway privado virtual especificado e o gateway do cliente especificado e aplica tags à conexão VPN. A saída inclui as informações de configuração do dispositivo de gateway do cliente, no formato XML. ``` aws ec2 create-vpn-connection \ --type ipsec.1 \ --customer-gateway-id cgw-001122334455aabbc \ --vpn-gateway-id vgw-1a1a1a1a1a1a2b2b2 \ --tag-specification 'ResourceType=vpn-connection,Tags=[{Key=Name,Value=BGP-VPN}]' ``` Resultado: ``` { "VpnConnection": { "CustomerGatewayConfiguration": "...configuration information...", "CustomerGatewayId": "cgw-001122334455aabbc", "Category": "VPN", "State": "pending", "VpnConnectionId": "vpn-123123123123abcab", "VpnGatewayId": "vgw-1a1a1a1a1a1a2b2b2", "Options": { "EnableAcceleration": false, "StaticRoutesOnly": false, "LocalIpv4NetworkCidr": "0.0.0.0/0", "RemoteIpv4NetworkCidr": "0.0.0.0/0", "TunnelInsideIpVersion": "ipv4", "TunnelOptions": [ {}, {} ] }, "Routes": [], "Tags": [ { "Key": "Name", "Value": "BGP-VPN" } ] } } ``` Para obter mais informações, consulte [Funcionamento do AWS Site-to-Site VPN](https://docs.aws.amazon.com/vpn/latest/s2svpn/how_it_works.html) no *Guia do usuário do AWS Site-to-Site VPN*. **Exemplo 2: criar uma conexão VPN com roteamento estático** O exemplo `create-vpn-connection` a seguir cria uma conexão VPN entre o gateway privado virtual especificado e o gateway do cliente especificado. As opções especificam o roteamento estático. A saída inclui as informações de configuração do dispositivo de gateway do cliente, no formato XML. ``` aws ec2 create-vpn-connection \ --type ipsec.1 \ --customer-gateway-id cgw-001122334455aabbc \ --vpn-gateway-id vgw-1a1a1a1a1a1a2b2b2 \ --options "{\"StaticRoutesOnly\":true}" ``` Resultado: ``` { "VpnConnection": { "CustomerGatewayConfiguration": "..configuration information...", "CustomerGatewayId": "cgw-001122334455aabbc", "Category": "VPN", "State": "pending", "VpnConnectionId": "vpn-123123123123abcab", "VpnGatewayId": "vgw-1a1a1a1a1a1a2b2b2", "Options": { "EnableAcceleration": false, "StaticRoutesOnly": true, "LocalIpv4NetworkCidr": "0.0.0.0/0", "RemoteIpv4NetworkCidr": "0.0.0.0/0", "TunnelInsideIpVersion": "ipv4", "TunnelOptions": [ {}, {} ] }, "Routes": [], "Tags": [] } } ``` Para obter mais informações, consulte [Funcionamento do AWS Site-to-Site VPN](https://docs.aws.amazon.com/vpn/latest/s2svpn/how_it_works.html) no *Guia do usuário do AWS Site-to-Site VPN*. **Exemplo 3: criar uma conexão VPN e especificar sua própria chave interna CIDR e pré-compartilhada** O exemplo `create-vpn-connection` a seguir cria uma conexão VPN e especifica o bloco CIDR do endereço IP interno e uma chave personalizada pré-compartilhada para cada túnel. Os valores especificados são retornados nas informações `CustomerGatewayConfiguration`. ``` aws ec2 create-vpn-connection \ --type ipsec.1 \ --customer-gateway-id cgw-001122334455aabbc \ --vpn-gateway-id vgw-1a1a1a1a1a1a2b2b2 \ --options TunnelOptions='[{TunnelInsideCidr=169.254.12.0/30,PreSharedKey=ExamplePreSharedKey1},{TunnelInsideCidr=169.254.13.0/30,PreSharedKey=ExamplePreSharedKey2}]' ``` Resultado: ``` { "VpnConnection": { "CustomerGatewayConfiguration": "..configuration information...", "CustomerGatewayId": "cgw-001122334455aabbc", "Category": "VPN", "State": "pending", "VpnConnectionId": "vpn-123123123123abcab", "VpnGatewayId": "vgw-1a1a1a1a1a1a2b2b2", "Options": { "EnableAcceleration": false, "StaticRoutesOnly": false, "LocalIpv4NetworkCidr": "0.0.0.0/0", "RemoteIpv4NetworkCidr": "0.0.0.0/0", "TunnelInsideIpVersion": "ipv4", "TunnelOptions": [ { "OutsideIpAddress": "203.0.113.3", "TunnelInsideCidr": "169.254.12.0/30", "PreSharedKey": "ExamplePreSharedKey1" }, { "OutsideIpAddress": "203.0.113.5", "TunnelInsideCidr": "169.254.13.0/30", "PreSharedKey": "ExamplePreSharedKey2" } ] }, "Routes": [], "Tags": [] } } ``` Para obter mais informações, consulte [Funcionamento do AWS Site-to-Site VPN](https://docs.aws.amazon.com/vpn/latest/s2svpn/how_it_works.html) no *Guia do usuário do AWS Site-to-Site VPN*. **Exemplo 4: criar uma conexão VPN que ofereça suporte ao tráfego IPv** O exemplo `create-vpn-connection` a seguir cria uma conexão VPN que oferece suporte ao tráfego IPv6 entre o gateway de trânsito especificado e o gateway do cliente especificado. As opções de túnel para ambos os túneis especificam que AWS deve iniciar a negociação IKE. ``` aws ec2 create-vpn-connection \ --type ipsec.1 \ --transit-gateway-id tgw-12312312312312312 \ --customer-gateway-id cgw-001122334455aabbc \ --options TunnelInsideIpVersion=ipv6,TunnelOptions=[{StartupAction=start},{StartupAction=start}] ``` Resultado: ``` { "VpnConnection": { "CustomerGatewayConfiguration": "..configuration information...", "CustomerGatewayId": "cgw-001122334455aabbc", "Category": "VPN", "State": "pending", "VpnConnectionId": "vpn-11111111122222222", "TransitGatewayId": "tgw-12312312312312312", "Options": { "EnableAcceleration": false, "StaticRoutesOnly": false, "LocalIpv6NetworkCidr": "::/0", "RemoteIpv6NetworkCidr": "::/0", "TunnelInsideIpVersion": "ipv6", "TunnelOptions": [ { "OutsideIpAddress": "203.0.113.3", "StartupAction": "start" }, { "OutsideIpAddress": "203.0.113.5", "StartupAction": "start" } ] }, "Routes": [], "Tags": [] } } ``` Para obter mais informações, consulte [Funcionamento do AWS Site-to-Site VPN](https://docs.aws.amazon.com/vpn/latest/s2svpn/how_it_works.html) no *Guia do usuário do AWS Site-to-Site VPN*. + Para ver detalhes da API, consulte [CreateVpnConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-vpn-connection.html) na *Referência de comandos da AWS CLI*. ### `create-vpn-gateway` O código de exemplo a seguir mostra como usar `create-vpn-gateway`. **AWS CLI** **Criar um gateway privado virtual** Este exemplo cria um gateway privado virtual. Comando: ``` aws ec2 create-vpn-gateway --type ipsec.1 ``` Resultado: ``` { "VpnGateway": { "AmazonSideAsn": 64512, "State": "available", "Type": "ipsec.1", "VpnGatewayId": "vgw-9a4cacf3", "VpcAttachments": [] } } ``` **Criar um gateway privado virtual com um ASN específico do lado da Amazon** Esse exemplo cria um gateway privado virtual e especifica o Número de sistema autônomo (ASN) para o lado da Amazon da sessão BGP. Comando: ``` aws ec2 create-vpn-gateway --type ipsec.1 --amazon-side-asn 65001 ``` Resultado: ``` { "VpnGateway": { "AmazonSideAsn": 65001, "State": "available", "Type": "ipsec.1", "VpnGatewayId": "vgw-9a4cacf3", "VpcAttachments": [] } } ``` + Para ver detalhes da API, consulte [CreateVpnGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-vpn-gateway.html) na *Referência de comandos da AWS CLI*. ### `delete-carrier-gateway` O código de exemplo a seguir mostra como usar `delete-carrier-gateway`. **AWS CLI** **Excluir o gateway de operadora** O exemplo `delete-carrier-gateway` a seguir exclui o gateway de operadora especificado. ``` aws ec2 delete-carrier-gateway \ --carrier-gateway-id cagw-0465cdEXAMPLE1111 ``` Resultado: ``` { "CarrierGateway": { "CarrierGatewayId": "cagw-0465cdEXAMPLE1111", "VpcId": "vpc-0c529aEXAMPLE1111", "State": "deleting", "OwnerId": "123456789012" } } ``` Para obter mais informações, consulte [Gateways de operadoras](https://docs.aws.amazon.com/vpc/latest/userguide/Carrier_Gateway.html) no *Guia do usuário da Amazon Virtual Private Cloud*. + Para ver detalhes da API, consulte [DeleteCarrierGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-carrier-gateway.html) na *Referência de comandos da AWS CLI*. ### `delete-client-vpn-endpoint` O código de exemplo a seguir mostra como usar `delete-client-vpn-endpoint`. **AWS CLI** **Excluir um endpoint do Client VPN** O exemplo `delete-client-vpn-endpoint` a seguir exclui o endpoint de Client VPN especificado. ``` aws ec2 delete-client-vpn-endpoint \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde ``` Resultado: ``` { "Status": { "Code": "deleting" } } ``` Para obter mais informações, consulte [Endpoints de Client VPN](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-endpoints.html) no *Guia do administrador do Cliente VPN da AWS*. + Para ver detalhes da API, consulte [DeleteClientVpnEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-client-vpn-endpoint.html) na *Referência de comandos da AWS CLI*. ### `delete-client-vpn-route` O código de exemplo a seguir mostra como usar `delete-client-vpn-route`. **AWS CLI** **Excluir uma rota para o endpoint do Client VPN** O exemplo `delete-client-vpn-route` a seguir exclui a rota `0.0.0.0/0` para a sub-rede especificada de um endpoint Client VPN. ``` aws ec2 delete-client-vpn-route \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ --destination-cidr-block 0.0.0.0/0 \ --target-vpc-subnet-id subnet-0123456789abcabca ``` Resultado: ``` { "Status": { "Code": "deleting" } } ``` Para obter mais informações, consulte [Rotas](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-routes.html) no *Guia do administrador de cliente VPN da AWS*. + Para ver detalhes da API, consulte [DeleteClientVpnRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-client-vpn-route.html) na *Referência de comandos da AWS CLI*. ### `delete-coip-cidr` O código de exemplo a seguir mostra como usar `delete-coip-cidr`. **AWS CLI** **Excluir um intervalo de endereços IP de propriedade do cliente (CoIP** O exemplo `delete-coip-cidr` a seguir exclui o intervalo especificado de endereços de CoIP no pool de CoIP especificado. ``` aws ec2 delete-coip-cidr \ --cidr 14.0.0.0/24 \ --coip-pool-id ipv4pool-coip-1234567890abcdefg ``` Resultado: ``` { "CoipCidr": { "Cidr": "14.0.0.0/24", "CoipPoolId": "ipv4pool-coip-1234567890abcdefg", "LocalGatewayRouteTableId": "lgw-rtb-abcdefg1234567890" } } ``` Para obter mais informações, consulte [Endereços IP pertencentes ao cliente](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) no *Guia do usuário do AWS Outposts*. + Para ver detalhes da API, consulte [DeleteCoipCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-coip-cidr.html) na *Referência de comandos da AWS CLI*. ### `delete-coip-pool` O código de exemplo a seguir mostra como usar `delete-coip-pool`. **AWS CLI** **Excluir um pool de endereços IP de propriedade do cliente (CoIP** O exemplo `delete-coip-pool` a seguir exclui um pool CoIP de endereços CoIP. ``` aws ec2 delete-coip-pool \ --coip-pool-id ipv4pool-coip-1234567890abcdefg ``` Resultado: ``` { "CoipPool": { "PoolId": "ipv4pool-coip-1234567890abcdefg", "LocalGatewayRouteTableId": "lgw-rtb-abcdefg1234567890", "PoolArn": "arn:aws:ec2:us-west-2:123456789012:coip-pool/ipv4pool-coip-1234567890abcdefg" } } ``` Para obter mais informações, consulte [Endereços IP pertencentes ao cliente](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) no *Guia do usuário do AWS Outposts*. + Para ver detalhes da API, consulte [DeleteCoipPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-coip-pool.html) na *Referência de comandos da AWS CLI*. ### `delete-customer-gateway` O código de exemplo a seguir mostra como usar `delete-customer-gateway`. **AWS CLI** **Excluir um gateway do cliente** Este exemplo exclui o gateway do cliente especificado. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 delete-customer-gateway --customer-gateway-id cgw-0e11f167 ``` + Para ver detalhes da API, consulte [DeleteCustomerGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-customer-gateway.html) na *Referência de comandos da AWS CLI*. ### `delete-dhcp-options` O código de exemplo a seguir mostra como usar `delete-dhcp-options`. **AWS CLI** **Excluir um conjunto de opções DHCP** Este exemplo exclui o conjunto de opções DHCP especificado. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 delete-dhcp-options --dhcp-options-id dopt-d9070ebb ``` + Para ver detalhes da API, consulte [DeleteDhcpOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-dhcp-options.html) na *Referência de comandos da AWS CLI*. ### `delete-egress-only-internet-gateway` O código de exemplo a seguir mostra como usar `delete-egress-only-internet-gateway`. **AWS CLI** **Excluir um Gateway da Internet somente de saída** Este exemplo exclui o gateway da Internet de somente saída especificado. Comando: ``` aws ec2 delete-egress-only-internet-gateway --egress-only-internet-gateway-id eigw-01eadbd45ecd7943f ``` Resultado: ``` { "ReturnCode": true } ``` + Para ver detalhes da API, consulte [DeleteEgressOnlyInternetGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-egress-only-internet-gateway.html) na *Referência de comandos da AWS CLI*. ### `delete-fleets` O código de exemplo a seguir mostra como usar `delete-fleets`. **AWS CLI** **Exemplo 1: excluir uma frota do EC2 e encerrar as instâncias associadas** O exemplo `delete-fleets` a seguir cancela a Frota EC2 especificada e encerra as Instâncias Sob Demanda e Instâncias Spot associadas. ``` aws ec2 delete-fleets \ --fleet-ids fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE \ --terminate-instances ``` Resultado: ``` { "SuccessfulFleetDeletions": [ { "CurrentFleetState": "deleted_terminating", "PreviousFleetState": "active", "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" } ], "UnsuccessfulFleetDeletions": [] } ``` Para obter mais informações, consulte [Excluir uma Frota EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#delete-fleet) no *Guia do usuário do Amazon Elastic Compute Cloud para instâncias Linux*. **Exemplo 2: excluir uma frota EC2 sem encerrar as instâncias associadas** O exemplo `delete-fleets` a seguir cancela a Frota EC2 especificada sem encerrar as Instâncias Sob Demanda e Instâncias Spot associadas. ``` aws ec2 delete-fleets \ --fleet-ids fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE \ --no-terminate-instances ``` Resultado: ``` { "SuccessfulFleetDeletions": [ { "CurrentFleetState": "deleted_running", "PreviousFleetState": "active", "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" } ], "UnsuccessfulFleetDeletions": [] } ``` Para obter mais informações, consulte [Excluir uma Frota EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#delete-fleet) no *Guia do usuário do Amazon Elastic Compute Cloud para instâncias Linux*. + Para ver detalhes da API, consulte [DeleteFleets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-fleets.html) na *Referência de comandos da AWS CLI*. ### `delete-flow-logs` O código de exemplo a seguir mostra como usar `delete-flow-logs`. **AWS CLI** **Excluir um log de fluxo** O exemplo `delete-flow-logs` a seguir exclui o log de fluxo especificado. ``` aws ec2 delete-flow-logs --flow-log-id fl-11223344556677889 ``` Resultado: ``` { "Unsuccessful": [] } ``` + Para ver detalhes da API, consulte [DeleteFlowLogs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-flow-logs.html) na *Referência de comandos da AWS CLI*. ### `delete-fpga-image` O código de exemplo a seguir mostra como usar `delete-fpga-image`. **AWS CLI** **Excluir uma imagem FPGA da Amazon** Este exemplo exclui a AFI especificada. Comando: ``` aws ec2 delete-fpga-image --fpga-image-id afi-06b12350a123fbabc ``` Resultado: ``` { "Return": true } ``` + Para ver detalhes da API, consulte [DeleteFpgaImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-fpga-image.html) na *Referência de comandos da AWS CLI*. ### `delete-instance-connect-endpoint` O código de exemplo a seguir mostra como usar `delete-instance-connect-endpoint`. **AWS CLI** **Excluir um endpoint de conexão de instância EC** O exemplo `delete-instance-connect-endpoint` a seguir exclui o endpoint de conexão de instância EC2 especificado. ``` aws ec2 delete-instance-connect-endpoint \ --instance-connect-endpoint-id eice-03f5e49b83924bbc7 ``` Resultado: ``` { "InstanceConnectEndpoint": { "OwnerId": "111111111111", "InstanceConnectEndpointId": "eice-0123456789example", "InstanceConnectEndpointArn": "arn:aws:ec2:us-east-1:111111111111:instance-connect-endpoint/eice-0123456789example", "State": "delete-in-progress", "StateMessage": "", "NetworkInterfaceIds": [], "VpcId": "vpc-0123abcd", "AvailabilityZone": "us-east-1d", "CreatedAt": "2023-02-07T12:05:37+00:00", "SubnetId": "subnet-0123abcd" } } ``` Para obter mais informações, consulte [Remover um endpoint de conexão de instância EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/delete-ec2-instance-connect-endpoint.html) no *Guiado usuário do Amazon EC2*. + Para ver detalhes da API, consulte [DeleteInstanceConnectEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-instance-connect-endpoint.html) na *Referência de comandos da AWS CLI*. ### `delete-instance-event-window` O código de exemplo a seguir mostra como usar `delete-instance-event-window`. **AWS CLI** **Exemplo 1: excluir uma janela de eventos** O exemplo `delete-instance-event-window` a seguir exclui uma janela de evento. ``` aws ec2 delete-instance-event-window \ --region us-east-1 \ --instance-event-window-id iew-0abcdef1234567890 ``` Resultado: ``` { "InstanceEventWindowState": { "InstanceEventWindowId": "iew-0abcdef1234567890", "State": "deleting" } } ``` Para restrições da janela de eventos, consulte [Considerações](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations) na seção Eventos Programados do *Guia do usuário do Amazon EC2*. **Exemplo 2: forçar a exclusão de uma janela de eventos** O exemplo `delete-instance-event-window` a seguir força a exclusão de uma janela de evento se a janela de evento estiver atualmente associada a destinos. ``` aws ec2 delete-instance-event-window \ --region us-east-1 \ --instance-event-window-id iew-0abcdef1234567890 \ --force-delete ``` Resultado: ``` { "InstanceEventWindowState": { "InstanceEventWindowId": "iew-0abcdef1234567890", "State": "deleting" } } ``` Para restrições da janela de eventos, consulte [Considerações](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations) na seção Eventos Programados do *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [DeleteInstanceEventWindow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-instance-event-window.html) na *Referência de comandos da AWS CLI*. ### `delete-internet-gateway` O código de exemplo a seguir mostra como usar `delete-internet-gateway`. **AWS CLI** **Excluir um gateway da internet** O exemplo `delete-internet-gateway` a seguir exclui o gateway da internet especificado. ``` aws ec2 delete-internet-gateway \ --internet-gateway-id igw-0d0fb496b3EXAMPLE ``` Este comando não produz saída. Para obter mais informações, consulte [Gateways da Internet](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html) no *Guia do usuário da Amazon VPC*. + Para ver detalhes da API, consulte [DeleteInternetGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-internet-gateway.html) na *Referência de comandos da AWS CLI*. ### `delete-ipam-pool` O código de exemplo a seguir mostra como usar `delete-ipam-pool`. **AWS CLI** **Excluir um pool IPAM** Neste exemplo, você é um administrador delegado de IPAM que deseja excluir um pool de IPAM que não é mais necessário, mas o pool tem um CIDR provisionado para ele. Você não pode excluir um pool se ele tiver CIDRs provisionados, a menos que use a opção `--cascade`, então você usará `--cascade`. Para concluir essa solicitação: você precisará do ID do pool IPAM, que pode ser obtido com [describe-ipam-pools](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-ipam-pools.html). `--region` deve ser a região de origem do IPAM. O exemplo `delete-ipam-pool` a seguir exclui um pool IPAM em sua conta da AWS. ``` aws ec2 delete-ipam-pool \ --ipam-pool-id ipam-pool-050c886a3ca41cd5b \ --cascade \ --region us-east-1 ``` Resultado: ``` { "IpamPool": { "OwnerId": "320805250157", "IpamPoolId": "ipam-pool-050c886a3ca41cd5b", "IpamPoolArn": "arn:aws:ec2::320805250157:ipam-pool/ipam-pool-050c886a3ca41cd5b", "IpamScopeArn": "arn:aws:ec2::320805250157:ipam-scope/ipam-scope-0a158dde35c51107b", "IpamScopeType": "private", "IpamArn": "arn:aws:ec2::320805250157:ipam/ipam-005f921c17ebd5107", "IpamRegion": "us-east-1", "Locale": "None", "PoolDepth": 1, "State": "delete-in-progress", "Description": "example", "AutoImport": false, "AddressFamily": "ipv4", "AllocationMinNetmaskLength": 0, "AllocationMaxNetmaskLength": 32 } } ``` Para obter mais informações, consulte [Excluir um pool](https://docs.aws.amazon.com/vpc/latest/ipam/delete-pool-ipam.html) no *Guia do usuário do IPAM da Amazon VPC*. + Para ver detalhes da API, consulte [DeleteIpamPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-ipam-pool.html) na *Referência de comandos da AWS CLI*. ### `delete-ipam-resource-discovery` O código de exemplo a seguir mostra como usar `delete-ipam-resource-discovery`. **AWS CLI** **Excluir uma descoberta de recursos** Neste exemplo, você é um administrador delegado do IPAM que deseja excluir uma descoberta de recursos não padrão que você criou para compartilhar com outro administrador do IPAM durante o processo de integração do IPAM com contas fora da sua organização. Para concluir essa solicitação: `--region` deve ser a região em que você criou a descoberta do recurso. Você não pode excluir uma descoberta de recurso padrão se `"IsDefault": true`. Uma descoberta de recursos padrão é aquela criada automaticamente na conta que cria um IPAM. Para excluir uma descoberta de recursos padrão, você precisa excluir o IPAM. O exemplo `delete-ipam-resource-discovery` a seguir exclui uma descoberta de recursos. ``` aws ec2 delete-ipam-resource-discovery \ --ipam-resource-discovery-id ipam-res-disco-0e39761475298ee0f \ --region us-east-1 ``` Resultado: ``` { "IpamResourceDiscovery": { "OwnerId": "149977607591", "IpamResourceDiscoveryId": "ipam-res-disco-0e39761475298ee0f", "IpamResourceDiscoveryArn": "arn:aws:ec2::149977607591:ipam-resource-discovery/ipam-res-disco-0e39761475298ee0f", "IpamResourceDiscoveryRegion": "us-east-1", "OperatingRegions": [ { "RegionName": "us-east-1" } ], "IsDefault": false, "State": "delete-in-progress" } } ``` Para obter mais informações sobre as descobertas de recursos, consulte [Trabalhar com descobertas de recurso](https://docs.aws.amazon.com/vpc/latest/ipam/res-disc-work-with.html) no *Guia do usuário da Amazon VPC IPAM*. + Para ver detalhes da API, consulte [DeleteIpamResourceDiscovery](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-ipam-resource-discovery.html) na *Referência de comandos da AWS CLI*. ### `delete-ipam-scope` O código de exemplo a seguir mostra como usar `delete-ipam-scope`. **AWS CLI** **Excluir um escopo do IPAM** O exemplo `delete-ipam-scope` a seguir exclui um IPAM. ``` aws ec2 delete-ipam-scope \ --ipam-scope-id ipam-scope-01c1ebab2b63bd7e4 ``` Resultado: ``` { "IpamScope": { "OwnerId": "123456789012", "IpamScopeId": "ipam-scope-01c1ebab2b63bd7e4", "IpamScopeArn": "arn:aws:ec2::123456789012:ipam-scope/ipam-scope-01c1ebab2b63bd7e4", "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-08440e7a3acde3908", "IpamRegion": "us-east-1", "IpamScopeType": "private", "IsDefault": false, "Description": "Example description", "PoolCount": 0, "State": "delete-in-progress" } } ``` Para obter mais informações, consulte [Excluir um escopo](https://docs.aws.amazon.com/vpc/latest/ipam/delete-scope-ipam.html) no *Guia do usuário do IPAM da Amazon VPC*. + Para ver detalhes da API, consulte [DeleteIpamScope](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-ipam-scope.html) na *Referência de comandos da AWS CLI*. ### `delete-ipam` O código de exemplo a seguir mostra como usar `delete-ipam`. **AWS CLI** **Excluir um IPAM** O exemplo `delete-ipam` a seguir exclui um IPAM. ``` aws ec2 delete-ipam \ --ipam-id ipam-036486dfa6af58ee0 ``` Resultado: ``` { "Ipam": { "OwnerId": "123456789012", "IpamId": "ipam-036486dfa6af58ee0", "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-036486dfa6af58ee0", "IpamRegion": "us-east-1", "PublicDefaultScopeId": "ipam-scope-071b8042b0195c183", "PrivateDefaultScopeId": "ipam-scope-0807405dece705a30", "ScopeCount": 2, "OperatingRegions": [ { "RegionName": "us-east-1" }, { "RegionName": "us-east-2" }, { "RegionName": "us-west-1" } ], "State": "delete-in-progress" } } ``` Para obter mais informações, consulte [Excluir um IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/delete-ipam.html) no *Guia do usuário do IPAM da Amazon VPC*. + Para ver detalhes da API, consulte [DeleteIpam](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-ipam.html) na *Referência de comandos da AWS CLI*. ### `delete-key-pair` O código de exemplo a seguir mostra como usar `delete-key-pair`. **AWS CLI** **Para excluir um par de chaves** O exemplo `delete-key-pair` a seguir exclui o par de chaves especificado. ``` aws ec2 delete-key-pair \ --key-name my-key-pair ``` Resultado: ``` { "Return": true, "KeyPairId": "key-03c8d3aceb53b507" } ``` Para obter mais informações, consulte [Criar e excluir pares de chaves](https://docs.aws.amazon.com/cli/latest/userguide/cli-ec2-keypairs.html) no *Guia do usuário da interface da linha de comando AWS*. + Consulte detalhes da API em [DeleteKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-key-pair.html) na *Referência de comandos da AWS CLI*. ### `delete-launch-template-versions` O código de exemplo a seguir mostra como usar `delete-launch-template-versions`. **AWS CLI** **Excluir uma versão de modelo de inicialização** Este exemplo exclui a versão do modelo de lançamento especificado. Comando: ``` aws ec2 delete-launch-template-versions --launch-template-id lt-0abcd290751193123 --versions 1 ``` Resultado: ``` { "UnsuccessfullyDeletedLaunchTemplateVersions": [], "SuccessfullyDeletedLaunchTemplateVersions": [ { "LaunchTemplateName": "TestVersion", "VersionNumber": 1, "LaunchTemplateId": "lt-0abcd290751193123" } ] } ``` + Para ver detalhes da API, consulte [DeleteLaunchTemplateVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-launch-template-versions.html) na *Referência de comandos da AWS CLI*. ### `delete-launch-template` O código de exemplo a seguir mostra como usar `delete-launch-template`. **AWS CLI** **Para excluir um modelo de execução** Este exemplo exclui o modelo de execução especificado. Comando: ``` aws ec2 delete-launch-template --launch-template-id lt-0abcd290751193123 ``` Resultado: ``` { "LaunchTemplate": { "LatestVersionNumber": 2, "LaunchTemplateId": "lt-0abcd290751193123", "LaunchTemplateName": "TestTemplate", "DefaultVersionNumber": 2, "CreatedBy": "arn:aws:iam::123456789012:root", "CreateTime": "2017-11-23T16:46:25.000Z" } } ``` + Consulte detalhes da API em [DeleteLaunchTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-launch-template.html) na *Referência de comandos da AWS CLI*. ### `delete-local-gateway-route-table-virtual-interface-group-association` O código de exemplo a seguir mostra como usar `delete-local-gateway-route-table-virtual-interface-group-association`. **AWS CLI** **Desassociar uma tabela de rotas de gateway local de um grupo de interfaces virtuais (VIFs** O exemplo `delete-local-gateway-route-table-virtual-interface-group-association` a seguir exclui a associação entre a tabela de rotas do gateway local especificada e o grupo VIF. ``` aws ec2 delete-local-gateway-route-table-virtual-interface-group-association \ --local-gateway-route-table-virtual-interface-group-association-id lgw-vif-grp-assoc-exampleid12345678 ``` Resultado: ``` { "LocalGatewayRouteTableVirtualInterfaceGroupAssociation": { "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId": "lgw-vif-grp-assoc-exampleid12345678", "LocalGatewayVirtualInterfaceGroupId": "lgw-vif-grp-exampleid0123abcd", "LocalGatewayId": "lgw-exampleid11223344", "LocalGatewayRouteTableId": "lgw-rtb-exampleidabcd1234", "LocalGatewayRouteTableArn": "arn:aws:ec2:us-west-2:111122223333:local-gateway-route-table/lgw-rtb-exampleidabcd1234", "OwnerId": "111122223333", "State": "disassociating", "Tags": [] } } ``` Para obter mais informações, consulte [Associações de grupo VIF](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#vif-group-associations) no *Guia do usuário do AWS Outposts*. + Para ver detalhes da API, consulte [DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-local-gateway-route-table-virtual-interface-group-association.html) na *Referência de comandos da AWS CLI*. ### `delete-local-gateway-route-table-vpc-association` O código de exemplo a seguir mostra como usar `delete-local-gateway-route-table-vpc-association`. **AWS CLI** **Desassociar a tabela de rotas de um gateway local de uma VPC** O exemplo `delete-local-gateway-route-table-vpc-association` a seguir exclui a associação entre a tabela de rotas do gateway local especificada e a VPC. ``` aws ec2 delete-local-gateway-route-table-vpc-association \ --local-gateway-route-table-vpc-association-id vpc-example0123456789 ``` Resultado: ``` { "LocalGatewayRouteTableVpcAssociation": { "LocalGatewayRouteTableVpcAssociationId": "lgw-vpc-assoc-abcd1234wxyz56789", "LocalGatewayRouteTableId": "lgw-rtb-abcdefg1234567890", "LocalGatewayRouteTableArn": "arn:aws:ec2:us-west-2:555555555555:local-gateway-route-table/lgw-rtb-abcdefg1234567890", "LocalGatewayId": "lgw-exampleid01234567", "VpcId": "vpc-example0123456789", "OwnerId": "555555555555", "State": "disassociating" } } ``` Para obter mais informações, consulte [Associações de VPC](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#vpc-associations) no *Guia do usuário do AWS Outposts*. + Para ver detalhes da API, consulte [DeleteLocalGatewayRouteTableVpcAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-local-gateway-route-table-vpc-association.html) na *Referência de comandos da AWS CLI*. ### `delete-local-gateway-route-table` O código de exemplo a seguir mostra como usar `delete-local-gateway-route-table`. **AWS CLI** **Excluir uma rota da tabela de rotas de gateway local** O exemplo `delete-local-gateway-route-table` a seguir cria uma tabela de rotas de gateway local com o modo de roteamento VPC direto com o modo de roteamento direto da VPC. ``` aws ec2 delete-local-gateway-route-table \ --local-gateway-route-table-id lgw-rtb-abcdefg1234567890 ``` Resultado: ``` { "LocalGatewayRouteTable": { "LocalGatewayRouteTableId": "lgw-rtb-abcdefg1234567890", "LocalGatewayRouteTableArn": "arn:aws:ec2:us-west-2:111122223333:local-gateway-route-table/lgw-rtb-abcdefg1234567890", "LocalGatewayId": "lgw-1a2b3c4d5e6f7g8h9", "OutpostArn": "arn:aws:outposts:us-west-2:111122223333:outpost/op-021345abcdef67890", "OwnerId": "111122223333", "State": "deleting", "Tags": [], "Mode": "direct-vpc-routing" } } ``` [Para obter mais informações, consulte Tabelas de rotas do gateway local](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html) no *Guia do usuário do AWS Outposts*. + Para ver detalhes da API, consulte [DeleteLocalGatewayRouteTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-local-gateway-route-table.html) na *Referência de comandos da AWS CLI*. ### `delete-local-gateway-route` O código de exemplo a seguir mostra como usar `delete-local-gateway-route`. **AWS CLI** **Excluir uma rota de uma tabela de rotas de gateway local** O exemplo `delete-local-gateway-route` a seguir exclui a rota especificada da tabela de rotas do gateway local especificado. ``` aws ec2 delete-local-gateway-route \ --destination-cidr-block 0.0.0.0/0 \ --local-gateway-route-table-id lgw-rtb-059615ef7dEXAMPLE ``` Resultado: ``` { "Route": { "DestinationCidrBlock": "0.0.0.0/0", "LocalGatewayVirtualInterfaceGroupId": "lgw-vif-grp-07145b276bEXAMPLE", "Type": "static", "State": "deleted", "LocalGatewayRouteTableId": "lgw-rtb-059615ef7EXAMPLE" } } ``` + Para ver detalhes da API, consulte [DeleteLocalGatewayRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-local-gateway-route.html) na *Referência de comandos da AWS CLI*. ### `delete-managed-prefix-list` O código de exemplo a seguir mostra como usar `delete-managed-prefix-list`. **AWS CLI** **Excluir uma lista de prefixos** O exemplo `delete-managed-prefix-list` a seguir exclui a lista de prefixos especificada. ``` aws ec2 delete-managed-prefix-list \ --prefix-list-id pl-0123456abcabcabc1 ``` Resultado: ``` { "PrefixList": { "PrefixListId": "pl-0123456abcabcabc1", "AddressFamily": "IPv4", "State": "delete-in-progress", "PrefixListArn": "arn:aws:ec2:us-west-2:123456789012:prefix-list/pl-0123456abcabcabc1", "PrefixListName": "test", "MaxEntries": 10, "Version": 1, "OwnerId": "123456789012" } } ``` Para obter mais informações, consulte [Listas de prefixos gerenciados](https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html) no *Guia do usuário da Amazon VPC*. + Para ver detalhes da API, consulte [DeleteManagedPrefixList](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-managed-prefix-list.html) na *Referência de comandos da AWS CLI*. ### `delete-nat-gateway` O código de exemplo a seguir mostra como usar `delete-nat-gateway`. **AWS CLI** **Excluir um gateway NAT** Este exemplo exclui o gateway NAT `nat-04ae55e711cec5680`. Comando: ``` aws ec2 delete-nat-gateway --nat-gateway-id nat-04ae55e711cec5680 ``` Resultado: ``` { "NatGatewayId": "nat-04ae55e711cec5680" } ``` + Para ver detalhes da API, consulte [DeleteNatGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-nat-gateway.html) na *Referência de comandos da AWS CLI*. ### `delete-network-acl-entry` O código de exemplo a seguir mostra como usar `delete-network-acl-entry`. **AWS CLI** **Excluir uma entrada de ACL de rede** Este exemplo exclui a regra de entrada número 100 da ACL de rede especificada. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 delete-network-acl-entry --network-acl-id acl-5fb85d36 --ingress --rule-number 100 ``` + Para ver detalhes da API, consulte [DeleteNetworkAclEntry](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-network-acl-entry.html) na *Referência de comandos da AWS CLI*. ### `delete-network-acl` O código de exemplo a seguir mostra como usar `delete-network-acl`. **AWS CLI** **Excluir uma ACL de rede** Este exemplo exclui a rede ACL especificada. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 delete-network-acl --network-acl-id acl-5fb85d36 ``` + Para ver detalhes da API, consulte [DeleteNetworkAcl](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-network-acl.html) na *Referência de comandos da AWS CLI*. ### `delete-network-insights-access-scope-analysis` O código de exemplo a seguir mostra como usar `delete-network-insights-access-scope-analysis`. **AWS CLI** **Excluir uma análise do Escopo de Acesso à Rede** O exemplo `delete-network-insights-access-scope-analysis` a seguir exclui a análise de Escopo de Acesso à Rede especificada. ``` aws ec2 delete-network-insights-access-scope-analysis \ --network-insights-access-scope-analysis-id nisa-01234567891abcdef ``` Resultado: ``` { "NetworkInsightsAccessScopeAnalysisId": "nisa-01234567891abcdef } ``` Para obter mais informações, consulte [Introdução ao Analisador de Acesso à Rede usando AWS CLI](https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/getting-started-cli.html) no *Guia do Analisador de Acesso à Rede*. + Para ver detalhes da API, consulte [DeleteNetworkInsightsAccessScopeAnalysis](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-network-insights-access-scope-analysis.html) na *Referência de comandos da AWS CLI*. ### `delete-network-insights-access-scope` O código de exemplo a seguir mostra como usar `delete-network-insights-access-scope`. **AWS CLI** **Excluir um Escopo de Acesso à Rede** O exemplo `delete-network-insights-access-scope` a seguir exclui p Escopo de Acesso à Rede especificado. ``` aws ec2 delete-network-insights-access-scope \ --network-insights-access-scope-id nis-123456789abc01234 ``` Resultado: ``` { "NetworkInsightsAccessScopeId": "nis-123456789abc01234" } ``` Para obter mais informações, consulte [Introdução ao Analisador de Acesso à Rede usando AWS CLI](https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/getting-started-cli.html) no *Guia do Analisador de Acesso à Rede*. + Para ver detalhes da API, consulte [DeleteNetworkInsightsAccessScope](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-network-insights-access-scope.html) na *Referência de comandos da AWS CLI*. ### `delete-network-insights-analysis` O código de exemplo a seguir mostra como usar `delete-network-insights-analysis`. **AWS CLI** **Excluir uma análise de caminho** O exemplo `delete-network-insights-analysis` a seguir exclui a análise especificada. ``` aws ec2 delete-network-insights-analysis \ --network-insights-analysis-id nia-02207aa13eb480c7a ``` Resultado: ``` { "NetworkInsightsAnalysisId": "nia-02207aa13eb480c7a" } ``` Para obter mais informações, consulte [Introdução ao uso da AWS CLI](https://docs.aws.amazon.com/vpc/latest/reachability/getting-started-cli.html) no *Guia do Reachability Analyzer*. + Para ver detalhes da API, consulte [DeleteNetworkInsightsAnalysis](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-network-insights-analysis.html) na *Referência de comandos da AWS CLI*. ### `delete-network-insights-path` O código de exemplo a seguir mostra como usar `delete-network-insights-path`. **AWS CLI** **Excluir um caminho** O exemplo `delete-network-insights-path` a seguir exclui o caminho especificado. Para poder excluir um caminho, primeiro é necessário excluir todas as análises usando o comando `delete-network-insights-analysis`. ``` aws ec2 delete-network-insights-path \ --network-insights-path-id nip-0b26f224f1d131fa8 ``` Resultado: ``` { "NetworkInsightsPathId": "nip-0b26f224f1d131fa8" } ``` Para obter mais informações, consulte [Introdução ao uso da AWS CLI](https://docs.aws.amazon.com/vpc/latest/reachability/getting-started-cli.html) no *Guia do Reachability Analyzer*. + Para ver detalhes da API, consulte [DeleteNetworkInsightsPath](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-network-insights-path.html) na *Referência de comandos da AWS CLI*. ### `delete-network-interface-permission` O código de exemplo a seguir mostra como usar `delete-network-interface-permission`. **AWS CLI** **Excluir uma permissão de interface de rede** Este exemplo exclui a permissão de interface de rede especificada. Comando: ``` aws ec2 delete-network-interface-permission --network-interface-permission-id eni-perm-06fd19020ede149ea ``` Resultado: ``` { "Return": true } ``` + Para ver detalhes da API, consulte [DeleteNetworkInterfacePermission](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-network-interface-permission.html) na *Referência de comandos da AWS CLI*. ### `delete-network-interface` O código de exemplo a seguir mostra como usar `delete-network-interface`. **AWS CLI** **Excluir uma interface de rede** Este exemplo exclui a interface de rede especificada. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 delete-network-interface --network-interface-id eni-e5aa89a3 ``` + Para ver detalhes da API, consulte [DeleteNetworkInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-network-interface.html) na *Referência de comandos da AWS CLI*. ### `delete-placement-group` O código de exemplo a seguir mostra como usar `delete-placement-group`. **AWS CLI** **Excluir um grupo de posicionamento** Esse exemplo de comando exclui o grupo de posicionamento especificado. Comando: ``` aws ec2 delete-placement-group --group-name my-cluster ``` + Para ver detalhes da API, consulte [DeletePlacementGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-placement-group.html) na *Referência de comandos da AWS CLI*. ### `delete-queued-reserved-instances` O código de exemplo a seguir mostra como usar `delete-queued-reserved-instances`. **AWS CLI** **Excluir uma compra colocada na fila** O exemplo `delete-queued-reserved-instances` a seguir exclui a instância reservada especificada, que estava na fila para compra. ``` aws ec2 delete-queued-reserved-instances \ --reserved-instances-ids af9f760e-6f91-4559-85f7-4980eexample ``` Resultado: ``` { "SuccessfulQueuedPurchaseDeletions": [ { "ReservedInstancesId": "af9f760e-6f91-4559-85f7-4980eexample" } ], "FailedQueuedPurchaseDeletions": [] } ``` + Para ver detalhes da API, consulte [DeleteQueuedReservedInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-queued-reserved-instances.html) na *Referência de comandos da AWS CLI*. ### `delete-route-table` O código de exemplo a seguir mostra como usar `delete-route-table`. **AWS CLI** **Excluir uma tabela de rotas** Este exemplo exclui a tabela de rotas especificada. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 delete-route-table --route-table-id rtb-22574640 ``` + Para ver detalhes da API, consulte [DeleteRouteTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-route-table.html) na *Referência de comandos da AWS CLI*. ### `delete-route` O código de exemplo a seguir mostra como usar `delete-route`. **AWS CLI** **Para excluir uma rota** Este exemplo exclui a rota especificada da tabela de rotas especificada. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 delete-route --route-table-id rtb-22574640 --destination-cidr-block 0.0.0.0/0 ``` + Para ver detalhes da API, consulte [DeleteRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-route.html) na *Referência de comandos da AWS CLI*. ### `delete-security-group` O código de exemplo a seguir mostra como usar `delete-security-group`. **AWS CLI** **[EC2-Classic] Para excluir um grupo de segurança** Este exemplo exclui o grupo de segurança chamado `MySecurityGroup`. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 delete-security-group --group-name MySecurityGroup ``` **[EC2-VPC] Para excluir um grupo de segurança** Este exemplo exclui o grupo de segurança com o ID `sg-903004f8`. Não é possível fazer referência a um grupo de segurança do EC2-VPC por nome. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 delete-security-group --group-id sg-903004f8 ``` Para obter mais informações, consulte Using Security Groups no *Guia do usuário da AWS Command Line Interface*. + Consulte detalhes da API em [DeleteSecurityGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-security-group.html) na *Referência de comandos da AWS CLI*. ### `delete-snapshot` O código de exemplo a seguir mostra como usar `delete-snapshot`. **AWS CLI** **Para excluir um snapshot** Este exemplo de comando exclui um snapshot com o ID de snapshot de `snap-1234567890abcdef0`. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 delete-snapshot --snapshot-id snap-1234567890abcdef0 ``` + Consulte detalhes da API em [DeleteSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-snapshot.html) na *Referência de comandos da AWS CLI*. ### `delete-spot-datafeed-subscription` O código de exemplo a seguir mostra como usar `delete-spot-datafeed-subscription`. **AWS CLI** **Cancelar uma assinatura de feed de dados da Instância Spot** Este exemplo de comando exclui uma assinatura de feed de dados Spot para a conta. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 delete-spot-datafeed-subscription ``` + Para ver detalhes da API, consulte [DeleteSpotDatafeedSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-spot-datafeed-subscription.html) na *Referência de comandos da AWS CLI*. ### `delete-subnet-cidr-reservation` O código de exemplo a seguir mostra como usar `delete-subnet-cidr-reservation`. **AWS CLI** **Excluir uma reserva CIDR de sub-rede** O exemplo `delete-subnet-cidr-reservation` a seguir exclui a reserva CIDR de sub-rede especificada. ``` aws ec2 delete-subnet-cidr-reservation \ --subnet-cidr-reservation-id scr-044f977c4eEXAMPLE ``` Resultado: ``` { "DeletedSubnetCidrReservation": { "SubnetCidrReservationId": "scr-044f977c4eEXAMPLE", "SubnetId": "subnet-03c51e2e6cEXAMPLE", "Cidr": "10.1.0.16/28", "ReservationType": "prefix", "OwnerId": "123456789012" } } ``` Para obter mais informações, consulte [Comportamento do endereçamento IP para sua sub-rede](https://docs.aws.amazon.com/vpc/latest/userguide/subnet-cidr-reservation.html) no *Guia do usuário da Amazon VPC*. + Para ver detalhes da API, consulte [DeleteSubnetCidrReservation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-subnet-cidr-reservation.html) na *Referência de comandos da AWS CLI*. ### `delete-subnet` O código de exemplo a seguir mostra como usar `delete-subnet`. **AWS CLI** **Excluir uma sub-rede** Este exemplo exclui a sub-rede especificada. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 delete-subnet --subnet-id subnet-9d4a7b6c ``` + Para ver detalhes da API, consulte [DeleteSubnet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-subnet.html) na *Referência de comandos da AWS CLI*. ### `delete-tags` O código de exemplo a seguir mostra como usar `delete-tags`. **AWS CLI** **Exemplo 1: excluir uma tag de um recurso** O exemplo `delete-tags` a seguir exclui a tag `Stack=Test` da imagem especificada. Quando você especifica um valor e um nome de chave, a tag é excluída somente se o valor da tag corresponder ao valor especificado. ``` aws ec2 delete-tags \ --resources ami-1234567890abcdef0 \ --tags Key=Stack,Value=Test ``` É opcional especificar o valor de uma tag. O exemplo `delete-tags` a seguir exclui a tag com o nome de chave `purpose` da instância especificada, independentemente do valor da tag. ``` aws ec2 delete-tags \ --resources i-1234567890abcdef0 \ --tags Key=purpose ``` Se você especificar a string vazia como o valor da tag, a tag será excluída somente se o valor da tag for a string vazia. O exemplo `delete-tags` a seguir especifica a string vazia como o valor da tag a ser excluída. ``` aws ec2 delete-tags \ --resources i-1234567890abcdef0 \ --tags Key=Name,Value= ``` **Exemplo 2: excluir uma tag de vários recursos** O exemplo `delete-tags` a seguir exclui a tag ``Purpose=Test`` de uma instância e de uma AMI. Conforme mostrado no exemplo anterior, você pode omitir o valor da tag do comando. ``` aws ec2 delete-tags \ --resources i-1234567890abcdef0 ami-1234567890abcdef0 \ --tags Key=Purpose ``` + Para ver detalhes da API, consulte [DeleteTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-tags.html) na *Referência de comandos da AWS CLI*. ### `delete-traffic-mirror-filter-rule` O código de exemplo a seguir mostra como usar `delete-traffic-mirror-filter-rule`. **AWS CLI** **Excluir uma regra de filtro de espelhamento de tráfego** O exemplo `delete-traffic-mirror-filter-rule` a seguir exclui a regra de filtro de espelhos de tráfego especificada. ``` aws ec2 delete-traffic-mirror-filter-rule \ --traffic-mirror-filter-rule-id tmfr-081f71283bEXAMPLE ``` Resultado: ``` { "TrafficMirrorFilterRuleId": "tmfr-081f71283bEXAMPLE" } ``` Para obter mais informações, consulte [Modificar suas regras de filtro de espelhamento de tráfego](https://docs.aws.amazon.com/vpc/latest/mirroring/traffic-mirroring-filter.html#modify-traffic-mirroring-filter-rules) no *Guia de espelhamento de tráfego da AWS*. + Para ver detalhes da API, consulte [DeleteTrafficMirrorFilterRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-traffic-mirror-filter-rule.html) na *Referência de comandos da AWS CLI*. ### `delete-traffic-mirror-filter` O código de exemplo a seguir mostra como usar `delete-traffic-mirror-filter`. **AWS CLI** **Excluir um filtro de espelhamento de tráfego** O exemplo `delete-traffic-mirror-filter` a seguir exclui o filtro de espelhamento de tráfego especificado. ``` aws ec2 delete-traffic-mirror-filter \ --traffic-mirror-filter-id tmf-0be0b25fcdEXAMPLE ``` Resultado: ``` { "TrafficMirrorFilterId": "tmf-0be0b25fcdEXAMPLE" } ``` Para obter mais informações, consulte [Excluir um filtro de espelhamento de tráfego](https://docs.aws.amazon.com/vpc/latest/mirroring/traffic-mirroring-filter.html#delete-traffic-mirroring-filter) no *Guia de espelhamento de tráfego da AWS*. + Para ver detalhes da API, consulte [DeleteTrafficMirrorFilter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-traffic-mirror-filter.html) na *Referência de comandos da AWS CLI*. ### `delete-traffic-mirror-session` O código de exemplo a seguir mostra como usar `delete-traffic-mirror-session`. **AWS CLI** **Excluir uma sessão de espelhamento de tráfego** O exemplo `delete-traffic-mirror-session` a seguir exclui a sessão de espelhamento de tráfego especificada. ``` aws ec2 delete-traffic-mirror-session \ --traffic-mirror-session-id tms-0af3141ce5EXAMPLE ``` Resultado: ``` { "TrafficMirrorSessionId": "tms-0af3141ce5EXAMPLE" } ``` Para obter mais informações, consulte [Excluir uma sessão de espelhamento de tráfego](https://docs.aws.amazon.com/vpc/latest/mirroring/traffic-mirroring-session.html#delete-traffic-mirroring-session) no *Guia de espelhamento de tráfego da AWS*. + Para ver detalhes da API, consulte [DeleteTrafficMirrorSession](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-traffic-mirror-session.html) na *Referência de comandos da AWS CLI*. ### `delete-traffic-mirror-target` O código de exemplo a seguir mostra como usar `delete-traffic-mirror-target`. **AWS CLI** **Excluir um destino de espelhamento de tráfego** O exemplo `delete-traffic-mirror-target` a seguir exclui o destino de espelhamento de tráfego especificado. ``` aws ec2 delete-traffic-mirror-target \ --traffic-mirror-target-id tmt-060f48ce9EXAMPLE ``` Resultado: ``` { "TrafficMirrorTargetId": "tmt-060f48ce9EXAMPLE" } ``` Para obter mais informações, consulte [Excluir um destino de espelhamento de tráfego](https://docs.aws.amazon.com/vpc/latest/mirroring/traffic-mirroring-target.html#delete-traffic-mirroring-target) no *Guia de espelhamento de tráfego da AWS*. + Para ver detalhes da API, consulte [DeleteTrafficMirrorTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-traffic-mirror-target.html) na *Referência de comandos da AWS CLI*. ### `delete-transit-gateway-connect-peer` O código de exemplo a seguir mostra como usar `delete-transit-gateway-connect-peer`. **AWS CLI** **Excluir um par da conexão de Gateway de trânsito** O exemplo `delete-transit-gateway-connect-peer` a seguir exclui o par de conexão especificado. ``` aws ec2 delete-transit-gateway-connect-peer \ --transit-gateway-connect-peer-id tgw-connect-peer-0666adbac4EXAMPLE ``` Resultado: ``` { "TransitGatewayConnectPeer": { "TransitGatewayAttachmentId": "tgw-attach-0f0927767cEXAMPLE", "TransitGatewayConnectPeerId": "tgw-connect-peer-0666adbac4EXAMPLE", "State": "deleting", "CreationTime": "2021-10-13T03:35:17.000Z", "ConnectPeerConfiguration": { "TransitGatewayAddress": "10.0.0.234", "PeerAddress": "172.31.1.11", "InsideCidrBlocks": [ "169.254.6.0/29" ], "Protocol": "gre", "BgpConfigurations": [ { "TransitGatewayAsn": 64512, "PeerAsn": 64512, "TransitGatewayAddress": "169.254.6.2", "PeerAddress": "169.254.6.1", "BgpStatus": "down" }, { "TransitGatewayAsn": 64512, "PeerAsn": 64512, "TransitGatewayAddress": "169.254.6.3", "PeerAddress": "169.254.6.1", "BgpStatus": "down" } ] } } } ``` Para obter mais informações, consulte [Anexos de conexão do gateway de trânsito e pares de conexão do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [DeleteTransitGatewayConnectPeer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-transit-gateway-connect-peer.html) na *Referência de comandos da AWS CLI*. ### `delete-transit-gateway-connect` O código de exemplo a seguir mostra como usar `delete-transit-gateway-connect`. **AWS CLI** **Excluir um anexo da conexão do gateway de trânsito** O exemplo `delete-transit-gateway-connect` a seguir exclui o anexo de conexão especificado. ``` aws ec2 delete-transit-gateway-connect \ --transit-gateway-attachment-id tgw-attach-037012e5dcEXAMPLE ``` Resultado: ``` { "TransitGatewayConnect": { "TransitGatewayAttachmentId": "tgw-attach-037012e5dcEXAMPLE", "TransportTransitGatewayAttachmentId": "tgw-attach-0a89069f57EXAMPLE", "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", "State": "deleting", "CreationTime": "2021-03-09T19:59:17+00:00", "Options": { "Protocol": "gre" } } } ``` Para obter mais informações, consulte [Anexos de conexão do gateway de trânsito e pares de conexão do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [DeleteTransitGatewayConnect](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-transit-gateway-connect.html) na *Referência de comandos da AWS CLI*. ### `delete-transit-gateway-multicast-domain` O código de exemplo a seguir mostra como usar `delete-transit-gateway-multicast-domain`. **AWS CLI** **Excluir um domínio de multicast do gateway de trânsito** O exemplo `delete-transit-gateway-multicast-domain` a seguir exclui o domínio multicast especificado. ``` aws ec2 delete-transit-gateway-multicast-domain \ --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef7EXAMPLE ``` Resultado: ``` { "TransitGatewayMulticastDomain": { "TransitGatewayMulticastDomainId": "tgw-mcast-domain-02bb79002bEXAMPLE", "TransitGatewayId": "tgw-0d88d2d0d5EXAMPLE", "State": "deleting", "CreationTime": "2019-11-20T22:02:03.000Z" } } ``` Para obter mais informações, consulte [Como gerenciar domínios multicast](https://docs.aws.amazon.com/vpc/latest/tgw/manage-domain.html) no *Guia de gateway de trânsito*. + Para ver detalhes da API, consulte [DeleteTransitGatewayMulticastDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-transit-gateway-multicast-domain.html) na *Referência de comandos da AWS CLI*. ### `delete-transit-gateway-peering-attachment` O código de exemplo a seguir mostra como usar `delete-transit-gateway-peering-attachment`. **AWS CLI** **Excluir um anexo de emparelhamento do gateway de trânsito** O exemplo `delete-transit-gateway-peering-attachment` a seguir exclui o anexo de emparelhamento do gateway de trânsito especificado. ``` aws ec2 delete-transit-gateway-peering-attachment \ --transit-gateway-attachment-id tgw-attach-4455667788aabbccd ``` Resultado: ``` { "TransitGatewayPeeringAttachment": { "TransitGatewayAttachmentId": "tgw-attach-4455667788aabbccd", "RequesterTgwInfo": { "TransitGatewayId": "tgw-123abc05e04123abc", "OwnerId": "123456789012", "Region": "us-west-2" }, "AccepterTgwInfo": { "TransitGatewayId": "tgw-11223344aabbcc112", "OwnerId": "123456789012", "Region": "us-east-2" }, "State": "deleting", "CreationTime": "2019-12-09T11:38:31.000Z" } } ``` Para obter mais informações, consulte [Anexos de pareamento do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-peering.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [DeleteTransitGatewayPeeringAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-transit-gateway-peering-attachment.html) na *Referência de comandos da AWS CLI*. ### `delete-transit-gateway-policy-table` O código de exemplo a seguir mostra como usar `delete-transit-gateway-policy-table`. **AWS CLI** **Excluir uma tabela de políticas de gateway de trânsito** O exemplo `delete-transit-gateway-policy-table` a seguir exclui a tabela de política de gateway de trânsito especificada. ``` aws ec2 delete-transit-gateway-policy-table \ --transit-gateway-policy-table-id tgw-ptb-0a16f134b78668a81 ``` Resultado: ``` { "TransitGatewayPolicyTables": [ { "TransitGatewayPolicyTableId": "tgw-ptb-0a16f134b78668a81", "TransitGatewayId": "tgw-067f8505c18f0bd6e", "State": "deleting", "CreationTime": "2023-11-28T16:36:43+00:00", "Tags": [] } ] } ``` Para obter mais informações, consulte [Tabelas de política do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-policy-tables.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [DeleteTransitGatewayPolicyTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-transit-gateway-policy-table.html) na *Referência de comandos da AWS CLI*. ### `delete-transit-gateway-prefix-list-reference` O código de exemplo a seguir mostra como usar `delete-transit-gateway-prefix-list-reference`. **AWS CLI** **Excluir uma referência da lista de prefixos** O exemplo `delete-transit-gateway-prefix-list-reference` a seguir exclui a referência da lista de prefixos especificada. ``` aws ec2 delete-transit-gateway-prefix-list-reference \ --transit-gateway-route-table-id tgw-rtb-0123456789abcd123 \ --prefix-list-id pl-11111122222222333 ``` Resultado: ``` { "TransitGatewayPrefixListReference": { "TransitGatewayRouteTableId": "tgw-rtb-0123456789abcd123", "PrefixListId": "pl-11111122222222333", "PrefixListOwnerId": "123456789012", "State": "deleting", "Blackhole": false, "TransitGatewayAttachment": { "TransitGatewayAttachmentId": "tgw-attach-aabbccddaabbccaab", "ResourceType": "vpc", "ResourceId": "vpc-112233445566aabbc" } } } ``` Para obter mais informações, consulte [Referências de lista de prefixos](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-prefix-lists.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [DeleteTransitGatewayPrefixListReference](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-transit-gateway-prefix-list-reference.html) na *Referência de comandos da AWS CLI*. ### `delete-transit-gateway-route-table` O código de exemplo a seguir mostra como usar `delete-transit-gateway-route-table`. **AWS CLI** **Excluir uma tabela de rotas do gateway de trânsito** O exemplo `delete-transit-gateway-route-table` a seguir exclui a tabela de rotas de gateway de trânsito especificada. ``` aws ec2 delete-transit-gateway-route-table \ --transit-gateway-route-table-id tgw-rtb-0b6f6aaa01EXAMPLE ``` Resultado: ``` { "TransitGatewayRouteTable": { "TransitGatewayRouteTableId": "tgw-rtb-0b6f6aaa01EXAMPLE", "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", "State": "deleting", "DefaultAssociationRouteTable": false, "DefaultPropagationRouteTable": false, "CreationTime": "2019-07-17T20:27:26.000Z" } } ``` Para obter mais informações, consulte [Excluir uma tabelas de rotas do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html#delete-tgw-route-table) no *Guia de gateway de trânsito*. + Para ver detalhes da API, consulte [DeleteTransitGatewayRouteTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-transit-gateway-route-table.html) na *Referência de comandos da AWS CLI*. ### `delete-transit-gateway-route` O código de exemplo a seguir mostra como usar `delete-transit-gateway-route`. **AWS CLI** **Excluir um bloco CIDR de uma tabela de rotas** O exemplo `delete-transit-gateway-route` a seguir exclui o bloco CIDR da tabela de rotas do gateway de trânsito especificado. ``` aws ec2 delete-transit-gateway-route \ --transit-gateway-route-table-id tgw-rtb-0b6f6aaa01EXAMPLE \ --destination-cidr-block 10.0.2.0/24 ``` Resultado: ``` { "Route": { "DestinationCidrBlock": "10.0.2.0/24", "TransitGatewayAttachments": [ { "ResourceId": "vpc-0065acced4EXAMPLE", "TransitGatewayAttachmentId": "tgw-attach-0b5968d3b6EXAMPLE", "ResourceType": "vpc" } ], "Type": "static", "State": "deleted" } } ``` Para obter mais informações, consulte [Excluir uma rota estática](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html#tgw-delete-static-route) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [DeleteTransitGatewayRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-transit-gateway-route.html) na *Referência de comandos da AWS CLI*. ### `delete-transit-gateway-vpc-attachment` O código de exemplo a seguir mostra como usar `delete-transit-gateway-vpc-attachment`. **AWS CLI** **Excluir um anexo VPC do gateway de trânsito** O exemplo `delete-transit-gateway-vpc-attachment` a seguir exclui o anexo VPC especificado. ``` aws ec2 delete-transit-gateway-vpc-attachment \ --transit-gateway-attachment-id tgw-attach-0d2c54bdbEXAMPLE ``` Resultado: ``` { "TransitGatewayVpcAttachment": { "TransitGatewayAttachmentId": "tgw-attach-0d2c54bdb3EXAMPLE", "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", "VpcId": "vpc-0065acced4f61c651", "VpcOwnerId": "111122223333", "State": "deleting", "CreationTime": "2019-07-17T16:04:27.000Z" } } ``` Para obter mais informações, consulte [Excluir um anexo de VPC](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-vpc-attachments.html#delete-vpc-attachment) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [DeleteTransitGatewayVpcAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-transit-gateway-vpc-attachment.html) na *Referência de comandos da AWS CLI*. ### `delete-transit-gateway` O código de exemplo a seguir mostra como usar `delete-transit-gateway`. **AWS CLI** **Excluir um gateway de trânsito** O exemplo `delete-transit-gateway` a seguir exclui o gateway de trânsito especificado. ``` aws ec2 delete-transit-gateway \ --transit-gateway-id tgw-01f04542b2EXAMPLE ``` Resultado: ``` { "TransitGateway": { "TransitGatewayId": "tgw-01f04542b2EXAMPLE", "State": "deleting", "OwnerId": "123456789012", "Description": "Example Transit Gateway", "CreationTime": "2019-08-27T15:04:35.000Z", "Options": { "AmazonSideAsn": 64515, "AutoAcceptSharedAttachments": "disable", "DefaultRouteTableAssociation": "enable", "AssociationDefaultRouteTableId": "tgw-rtb-0ce7a6948fEXAMPLE", "DefaultRouteTablePropagation": "enable", "PropagationDefaultRouteTableId": "tgw-rtb-0ce7a6948fEXAMPLE", "VpnEcmpSupport": "enable", "DnsSupport": "enable" } } } ``` Para obter mais informações, consulte [Excluir um gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-transit-gateways.html#delete-tgw) no *Guia de gateway de trânsito*. + Para ver detalhes da API, consulte [DeleteTransitGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-transit-gateway.html) na *Referência de comandos da AWS CLI*. ### `delete-verified-access-endpoint` O código de exemplo a seguir mostra como usar `delete-verified-access-endpoint`. **AWS CLI** **Excluir um endpoint do acesso verificado** O exemplo `delete-verified-access-endpoint` a seguir exclui o endpoint especificado do acesso verificado. ``` aws ec2 delete-verified-access-endpoint \ --verified-access-endpoint-id vae-066fac616d4d546f2 ``` Resultado: ``` { "VerifiedAccessEndpoint": { "VerifiedAccessInstanceId": "vai-0ce000c0b7643abea", "VerifiedAccessGroupId": "vagr-0dbe967baf14b7235", "VerifiedAccessEndpointId": "vae-066fac616d4d546f2", "ApplicationDomain": "example.com", "EndpointType": "network-interface", "AttachmentType": "vpc", "DomainCertificateArn": "arn:aws:acm:us-east-2:123456789012:certificate/eb065ea0-26f9-4e75-a6ce-0a1a7EXAMPLE", "EndpointDomain": "my-ava-app.edge-00c3372d53b1540bb.vai-0ce000c0b7643abea.prod.verified-access.us-east-2.amazonaws.com", "SecurityGroupIds": [ "sg-004915970c4c8f13a" ], "NetworkInterfaceOptions": { "NetworkInterfaceId": "eni-0aec70418c8d87a0f", "Protocol": "https", "Port": 443 }, "Status": { "Code": "deleting" }, "Description": "Testing Verified Access", "CreationTime": "2023-08-25T20:54:43", "LastUpdatedTime": "2023-08-25T22:46:32" } } ``` Para obter mais informações, consulte [Endpoints de acesso verificado](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-endpoints.html) no *Guia do usuário do acesso verificado da AWS*. + Para ver detalhes da API, consulte [DeleteVerifiedAccessEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-verified-access-endpoint.html) na *Referência de comandos da AWS CLI*. ### `delete-verified-access-group` O código de exemplo a seguir mostra como usar `delete-verified-access-group`. **AWS CLI** **Excluir um grupo do acesso verificado** O exemplo `delete-verified-access-group` a seguir exclui o grupo especificado do acesso verificado. ``` aws ec2 delete-verified-access-group \ --verified-access-group-id vagr-0dbe967baf14b7235 ``` Resultado: ``` { "VerifiedAccessGroup": { "VerifiedAccessGroupId": "vagr-0dbe967baf14b7235", "VerifiedAccessInstanceId": "vai-0ce000c0b7643abea", "Description": "Testing Verified Access", "Owner": "123456789012", "VerifiedAccessGroupArn": "arn:aws:ec2:us-east-2:123456789012:verified-access-group/vagr-0dbe967baf14b7235", "CreationTime": "2023-08-25T19:55:19", "LastUpdatedTime": "2023-08-25T22:49:03", "DeletionTime": "2023-08-26T00:58:31" } } ``` Para obter mais informações, consulte [Grupos de acesso verificado](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-groups.html) no *Guia do usuário do acesso verificado da AWS*. + Para ver detalhes da API, consulte [DeleteVerifiedAccessGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-verified-access-group.html) na *Referência de comandos da AWS CLI*. ### `delete-verified-access-instance` O código de exemplo a seguir mostra como usar `delete-verified-access-instance`. **AWS CLI** **Excluir uma instância do acesso verificado** O exemplo `delete-verified-access-instance` a seguir exclui a instância especificada do acesso verificado. ``` aws ec2 delete-verified-access-instance \ --verified-access-instance-id vai-0ce000c0b7643abea ``` Resultado: ``` { "VerifiedAccessInstance": { "VerifiedAccessInstanceId": "vai-0ce000c0b7643abea", "Description": "Testing Verified Access", "VerifiedAccessTrustProviders": [], "CreationTime": "2023-08-25T18:27:56", "LastUpdatedTime": "2023-08-26T01:00:18" } } ``` Para obter mais informações, consulte [Instâncias de acesso verificado](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-instances.html) no *Guia do usuário do acesso verificado da AWS*. + Para ver detalhes da API, consulte [DeleteVerifiedAccessInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-verified-access-instance.html) na *Referência de comandos da AWS CLI*. ### `delete-verified-access-trust-provider` O código de exemplo a seguir mostra como usar `delete-verified-access-trust-provider`. **AWS CLI** **Excluir um provedor confiável de dispositivos de acesso verificado** O exemplo `delete-verified-access-trust-provider` a seguir exclui o provedor de confiança especificado do acesso verificado. ``` aws ec2 delete-verified-access-trust-provider \ --verified-access-trust-provider-id vatp-0bb32de759a3e19e7 ``` Resultado: ``` { "VerifiedAccessTrustProvider": { "VerifiedAccessTrustProviderId": "vatp-0bb32de759a3e19e7", "Description": "Testing Verified Access", "TrustProviderType": "user", "UserTrustProviderType": "iam-identity-center", "PolicyReferenceName": "idc", "CreationTime": "2023-08-25T18:40:36", "LastUpdatedTime": "2023-08-25T18:40:36" } } ``` Para obter mais informações, consulte [Provedores confiáveis para acesso verificado](https://docs.aws.amazon.com/verified-access/latest/ug/trust-providers.html) no *Guia do usuário de acesso verificado da AWS*. + Para ver detalhes da API, consulte [DeleteVerifiedAccessTrustProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-verified-access-trust-provider.html) na *Referência de comandos da AWS CLI*. ### `delete-volume` O código de exemplo a seguir mostra como usar `delete-volume`. **AWS CLI** **Excluir um volume** Este exemplo de comando exclui um volume disponível com o ID do volume de `vol-049df61146c4d7901`. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 delete-volume --volume-id vol-049df61146c4d7901 ``` + Para ver detalhes da API, consulte [DeleteVolume](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-volume.html) na *Referência de comandos da AWS CLI*. ### `delete-vpc-endpoint-connection-notifications` O código de exemplo a seguir mostra como usar `delete-vpc-endpoint-connection-notifications`. **AWS CLI** **Excluir uma notificação de conexão de endpoint** Este exemplo exclui a notificação de conexão de endpoint especificada. Comando: ``` aws ec2 delete-vpc-endpoint-connection-notifications --connection-notification-ids vpce-nfn-008776de7e03f5abc ``` Resultado: ``` { "Unsuccessful": [] } ``` + Para ver detalhes da API, consulte [DeleteVpcEndpointConnectionNotifications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-vpc-endpoint-connection-notifications.html) na *Referência de comandos da AWS CLI*. ### `delete-vpc-endpoint-service-configurations` O código de exemplo a seguir mostra como usar `delete-vpc-endpoint-service-configurations`. **AWS CLI** **Excluir uma configuração de serviço de endpoint** Este exemplo exclui a configuração especificada do serviço de endpoint. Comando: ``` aws ec2 delete-vpc-endpoint-service-configurations --service-ids vpce-svc-03d5ebb7d9579a2b3 ``` Resultado: ``` { "Unsuccessful": [] } ``` + Para ver detalhes da API, consulte [DeleteVpcEndpointServiceConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-vpc-endpoint-service-configurations.html) na *Referência de comandos da AWS CLI*. ### `delete-vpc-endpoints` O código de exemplo a seguir mostra como usar `delete-vpc-endpoints`. **AWS CLI** **Para excluir um endpoint** Este exemplo exclui os endpoints vpce-aa22bb33 e vpce-1a2b3c4d. Se o comando for parcialmente bem-sucedido ou malsucedido, uma lista de itens malsucedidos será retornada. Se houver sucesso, a lista retornada ficará vazia. Comando: ``` aws ec2 delete-vpc-endpoints --vpc-endpoint-ids vpce-aa22bb33 vpce-1a2b3c4d ``` Resultado: ``` { "Unsuccessful": [] } ``` + Para ver detalhes da API, consulte [DeleteVpcEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-vpc-endpoints.html) na *Referência de comandos da AWS CLI*. ### `delete-vpc-peering-connection` O código de exemplo a seguir mostra como usar `delete-vpc-peering-connection`. **AWS CLI** **Excluir uma conexão de emparelhamento da VPC** Este exemplo exclui a conexão de emparelhamento da VPC especificada. Comando: ``` aws ec2 delete-vpc-peering-connection --vpc-peering-connection-id pcx-1a2b3c4d ``` Resultado: ``` { "Return": true } ``` + Para ver detalhes da API, consulte [DeleteVpcPeeringConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-vpc-peering-connection.html) na *Referência de comandos da AWS CLI*. ### `delete-vpc` O código de exemplo a seguir mostra como usar `delete-vpc`. **AWS CLI** **Para excluir uma VPC** Este exemplo exclui a VPC especificada. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 delete-vpc --vpc-id vpc-a01106c2 ``` + Para ver detalhes da API, consulte [DeleteVpc](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-vpc.html) na *Referência de comandos da AWS CLI*. ### `delete-vpn-connection-route` O código de exemplo a seguir mostra como usar `delete-vpn-connection-route`. **AWS CLI** **Excluir uma rota estática de uma conexão VPN** Este exemplo exclui a rota estática especificada da conexão VPN especificada. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 delete-vpn-connection-route --vpn-connection-id vpn-40f41529 --destination-cidr-block 11.12.0.0/16 ``` + Para ver detalhes da API, consulte [DeleteVpnConnectionRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-vpn-connection-route.html) na *Referência de comandos da AWS CLI*. ### `delete-vpn-connection` O código de exemplo a seguir mostra como usar `delete-vpn-connection`. **AWS CLI** **Excluir uma conexão VPN** Este exemplo exclui a conexão VPN especificada. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 delete-vpn-connection --vpn-connection-id vpn-40f41529 ``` + Para ver detalhes da API, consulte [DeleteVpnConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-vpn-connection.html) na *Referência de comandos da AWS CLI*. ### `delete-vpn-gateway` O código de exemplo a seguir mostra como usar `delete-vpn-gateway`. **AWS CLI** **Excluir um gateway privado virtual** Este exemplo exclui o gateway privado virtual especificado. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 delete-vpn-gateway --vpn-gateway-id vgw-9a4cacf3 ``` + Para ver detalhes da API, consulte [DeleteVpnGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-vpn-gateway.html) na *Referência de comandos da AWS CLI*. ### `deprovision-byoip-cidr` O código de exemplo a seguir mostra como usar `deprovision-byoip-cidr`. **AWS CLI** **Remover um intervalo de endereços IP do uso** O exemplo a seguir remove o intervalo de endereços especificado do uso com AWS. ``` aws ec2 deprovision-byoip-cidr \ --cidr 203.0.113.25/24 ``` Resultado: ``` { "ByoipCidr": { "Cidr": "203.0.113.25/24", "State": "pending-deprovision" } } ``` + Para ver detalhes da API, consulte [DeprovisionByoipCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/deprovision-byoip-cidr.html) na *Referência de comandos da AWS CLI*. ### `deprovision-ipam-pool-cidr` O código de exemplo a seguir mostra como usar `deprovision-ipam-pool-cidr`. **AWS CLI** **Desprovisionar um CIDR do pool do IPAM** O exemplo `deprovision-ipam-pool-cidr` a seguir desprovisiona um CIDR provisionado para um grupo do IPAM. (Linux): ``` aws ec2 deprovision-ipam-pool-cidr \ --ipam-pool-id ipam-pool-02ec043a19bbe5d08 \ --cidr 11.0.0.0/16 ``` (Windows): ``` aws ec2 deprovision-ipam-pool-cidr ^ --ipam-pool-id ipam-pool-02ec043a19bbe5d08 ^ --cidr 11.0.0.0/16 ``` Resultado: ``` { "IpamPoolCidr": { "Cidr": "11.0.0.0/16", "State": "pending-deprovision" } } ``` Para obter mais informações, consulte [Desprovisionar CIDRs de pool](https://docs.aws.amazon.com/vpc/latest/ipam/depro-pool-cidr-ipam.html) no *Guia do usuário do IPAM da Amazon VPC*. + Para ver detalhes da API, consulte [DeprovisionIpamPoolCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/deprovision-ipam-pool-cidr.html) na *Referência de comandos da AWS CLI*. ### `deregister-image` O código de exemplo a seguir mostra como usar `deregister-image`. **AWS CLI** **Cancelar o registro de uma AMI** Este exemplo cancela o registro da AMI especificada. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 deregister-image --image-id ami-4fa54026 ``` + Para ver detalhes da API, consulte [DeregisterImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/deregister-image.html) na *Referência de comandos da AWS CLI*. ### `deregister-instance-event-notification-attributes` O código de exemplo a seguir mostra como usar `deregister-instance-event-notification-attributes`. **AWS CLI** **Exemplo 1: remover todas as tags das notificações de eventos** O exemplo `deregister-instance-event-notification-attributes` a seguir remove `IncludeAllTagsOfInstance=true`, o que tem o efeito de definir `IncludeAllTagsOfInstance` como `false`. ``` aws ec2 deregister-instance-event-notification-attributes \ --instance-tag-attribute IncludeAllTagsOfInstance=true ``` Resultado: ``` { "InstanceTagAttribute": { "InstanceTagKeys": [], "IncludeAllTagsOfInstance": true } } ``` Para obter mais informações, consulte [Eventos programados para suas instâncias](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html) no *Guia do usuário do Amazon Elastic Compute Cloud para Instâncias Linux*. **Exemplo 2: remover tags específicas de notificações de eventos** O exemplo `deregister-instance-event-notification-attributes` a seguir remove a tag especificada das tags incluídas nas notificações de eventos. Para descrever as tags restantes incluídas nas notificações de eventos, use `describe-instance-event-notification-attributes`. ``` aws ec2 deregister-instance-event-notification-attributes \ --instance-tag-attribute InstanceTagKeys="tag-key2" ``` Resultado: ``` { "InstanceTagAttribute": { "InstanceTagKeys": [ "tag-key2" ], "IncludeAllTagsOfInstance": false } } ``` Para obter mais informações, consulte [Eventos programados para suas instâncias](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html) no *Guia do usuário do Amazon Elastic Compute Cloud para Instâncias Linux*. + Para ver detalhes da API, consulte [DeregisterInstanceEventNotificationAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/deregister-instance-event-notification-attributes.html) na *Referência de comandos da AWS CLI*. ### `deregister-transit-gateway-multicast-group-members` O código de exemplo a seguir mostra como usar `deregister-transit-gateway-multicast-group-members`. **AWS CLI** **Cancelar o registro de membros de grupo de um grupo de multicast** Este exemplo cancela o registro do membro do grupo de interface de rede especificado do grupo multicast do gateway de trânsito. ``` aws ec2 deregister-transit-gateway-multicast-group-members \ --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef7EXAMPLE \ --group-ip-address 224.0.1.0 \ --network-interface-ids eni-0e246d3269EXAMPLE ``` Resultado: ``` { "DeregisteredMulticastGroupMembers": { "TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c4905cef7EXAMPLE", "RegisteredNetworkInterfaceIds": [ "eni-0e246d3269EXAMPLE" ], "GroupIpAddress": "224.0.1.0" } } ``` Para obter mais informações, consulte [Cancelar o registro de membros de um grupo multicast](https://docs.aws.amazon.com/vpc/latest/tgw/working-with-multicast.html#remove-members-multicast-group) no *Guia do usuário de Gateways de trânsito da AWS*. + Para ver detalhes da API, consulte [DeregisterTransitGatewayMulticastGroupMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/deregister-transit-gateway-multicast-group-members.html) na *Referência de comandos da AWS CLI*. ### `deregister-transit-gateway-multicast-group-source` O código de exemplo a seguir mostra como usar `deregister-transit-gateway-multicast-group-source`. **AWS CLI** **Cancelar o registro de uma origem do grupo de multicast do gateway de trânsito** Este exemplo cancela o registro da origem do grupo de interface de rede especificado do grupo multicast. ``` aws ec2 register-transit-gateway-multicast-group-sources \ --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef79d6e597 \ --group-ip-address 224.0.1.0 \ --network-interface-ids eni-07f290fc3c090cbae ``` Resultado: ``` { "DeregisteredMulticastGroupSources": { "TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c4905cef79d6e597", "DeregisteredNetworkInterfaceIds": [ "eni-07f290fc3c090cbae" ], "GroupIpAddress": "224.0.1.0" } } ``` Para obter mais informações, consulte [Cancelar o registro de fontes de um grupo multicast](https://docs.aws.amazon.com/vpc/latest/tgw/working-with-multicast.html#remove-source-multicast-group) no *Guia do usuário de Gateways de trânsito da AWS*. + Para ver detalhes da API, consulte [DeregisterTransitGatewayMulticastGroupSource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/deregister-transit-gateway-multicast-group-source.html) na *Referência de comandos da AWS CLI*. ### `describe-account-attributes` O código de exemplo a seguir mostra como usar `describe-account-attributes`. **AWS CLI** **Descrever todos os atributos da sua conta AWS** Este exemplo descreve os atributos da sua conta da AWS. Comando: ``` aws ec2 describe-account-attributes ``` Resultado: ``` { "AccountAttributes": [ { "AttributeName": "vpc-max-security-groups-per-interface", "AttributeValues": [ { "AttributeValue": "5" } ] }, { "AttributeName": "max-instances", "AttributeValues": [ { "AttributeValue": "20" } ] }, { "AttributeName": "supported-platforms", "AttributeValues": [ { "AttributeValue": "EC2" }, { "AttributeValue": "VPC" } ] }, { "AttributeName": "default-vpc", "AttributeValues": [ { "AttributeValue": "none" } ] }, { "AttributeName": "max-elastic-ips", "AttributeValues": [ { "AttributeValue": "5" } ] }, { "AttributeName": "vpc-max-elastic-ips", "AttributeValues": [ { "AttributeValue": "5" } ] } ] } ``` **Descrever um único atributo para sua conta AWS** Este exemplo descreve o atributo `supported-platforms` da sua conta da AWS. Comando: ``` aws ec2 describe-account-attributes --attribute-names supported-platforms ``` Resultado: ``` { "AccountAttributes": [ { "AttributeName": "supported-platforms", "AttributeValues": [ { "AttributeValue": "EC2" }, { "AttributeValue": "VPC" } ] } ] } ``` + Consulte detalhes da API em [DescribeAccountAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-account-attributes.html) na *Referência de comandos da AWS CLI*. ### `describe-address-transfers` O código de exemplo a seguir mostra como usar `describe-address-transfers`. **AWS CLI** **Descrever uma transferência de endereço IP elástico** O exemplo `describe-address-transfers` a seguir descreve a transferência do endereço IP Elástico para o endereço IP Elástico especificado. ``` aws ec2 describe-address-transfers \ --allocation-ids eipalloc-09ad461b0d03f6aaf ``` Resultado: ``` { "AddressTransfers": [ { "PublicIp": "100.21.184.216", "AllocationId": "eipalloc-09ad461b0d03f6aaf", "TransferAccountId": "123456789012", "TransferOfferExpirationTimestamp": "2023-02-22T22:51:01.000Z", "AddressTransferStatus": "pending" } ] } ``` Para obter mais informações, consulte [Transferir endereços IP elásticos](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) no *Guia do usuário do Amazon VPC*. + Para ver detalhes da API, consulte [DescribeAddressTransfers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-address-transfers.html) na *Referência de comandos da AWS CLI*. ### `describe-addresses-attribute` O código de exemplo a seguir mostra como usar `describe-addresses-attribute`. **AWS CLI** **Visualizar os atributos do nome de domínio associado a um endereço IP elástico** Os exemplos `describe-addresses-attribute` a seguir retornam os atributos do nome de domínio associado ao endereço IP elástico. Linux: ``` aws ec2 describe-addresses-attribute \ --allocation-ids eipalloc-abcdef01234567890 \ --attribute domain-name ``` Windows: ``` aws ec2 describe-addresses-attribute ^ --allocation-ids eipalloc-abcdef01234567890 ^ --attribute domain-name ``` Resultado: ``` { "Addresses": [ { "PublicIp": "192.0.2.0", "AllocationId": "eipalloc-abcdef01234567890", "PtrRecord": "example.com." } ] } ``` Para visualizar os atributos de um endereço IP elástico, você deve primeiro associar um nome de domínio ao endereço IP elástico. Para obter mais informações, consulte [Usar DNS reverso para aplicações de e-mail](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#Using_Elastic_Addressing_Reverse_DNS) no *Guia do usuário do Amazon EC2* ou [modify-address-attribute](https://docs.aws.amazon.com/cli/latest/reference/ec2/modify-address-attribute.html) na *Referência de Comandos da CLI da AWS*. + Para ver detalhes da API, consulte [DescribeAddressesAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-addresses-attribute.html) na *Referência de comandos da AWS CLI*. ### `describe-addresses` O código de exemplo a seguir mostra como usar `describe-addresses`. **AWS CLI** **Exemplo 1: recuperar detalhes de todos os seus endereços IP elásticos** O exemplo `describe addresses` a seguir mostra os detalhes dos seus endereços IP elásticos. ``` aws ec2 describe-addresses ``` Resultado: ``` { "Addresses": [ { "InstanceId": "i-1234567890abcdef0", "PublicIp": "198.51.100.0", "PublicIpv4Pool": "amazon", "Domain": "standard" }, { "Domain": "vpc", "PublicIpv4Pool": "amazon", "InstanceId": "i-1234567890abcdef0", "NetworkInterfaceId": "eni-12345678", "AssociationId": "eipassoc-12345678", "NetworkInterfaceOwnerId": "123456789012", "PublicIp": "203.0.113.0", "AllocationId": "eipalloc-12345678", "PrivateIpAddress": "10.0.1.241" } ] } ``` **Exemplo 2: recuperar detalhes dos seus endereços IP elásticos para EC2-VPC** O exemplo `describe-addresses` a seguir mostra os detalhes dos seus endereços IP elásticos para usar com instâncias em uma VPC. ``` aws ec2 describe-addresses \ --filters "Name=domain,Values=vpc" ``` Resultado: ``` { "Addresses": [ { "Domain": "vpc", "PublicIpv4Pool": "amazon", "InstanceId": "i-1234567890abcdef0", "NetworkInterfaceId": "eni-12345678", "AssociationId": "eipassoc-12345678", "NetworkInterfaceOwnerId": "123456789012", "PublicIp": "203.0.113.0", "AllocationId": "eipalloc-12345678", "PrivateIpAddress": "10.0.1.241" } ] } ``` **Exemplo 3: recuperar detalhes sobre um endereço IP elástico especificado pelo ID de alocação** O exemplo `describe-addresses` a seguir exibe os detalhes do endereço IP elástico com o ID de alocação especificado, que está associado a uma instância no EC2-VPC. ``` aws ec2 describe-addresses \ --allocation-ids eipalloc-282d9641 ``` Resultado: ``` { "Addresses": [ { "Domain": "vpc", "PublicIpv4Pool": "amazon", "InstanceId": "i-1234567890abcdef0", "NetworkInterfaceId": "eni-1a2b3c4d", "AssociationId": "eipassoc-123abc12", "NetworkInterfaceOwnerId": "1234567891012", "PublicIp": "203.0.113.25", "AllocationId": "eipalloc-282d9641", "PrivateIpAddress": "10.251.50.12" } ] } ``` **Exemplo 4: recuperar detalhes sobre um endereço IP elástico especificado pelo endereço IP privado de VPC** O exemplo `describe-addresses` a seguir mostra os detalhes do endereço IP elástico associado a um determinado endereço IP privado no EC2-VPC. ``` aws ec2 describe-addresses \ --filters "Name=private-ip-address,Values=10.251.50.12" ``` **Exemplo 5: recuperar detalhes sobre endereços IP elásticos no EC2-Classic** O exemplo `describe-addresses` a seguir mostra os detalhes dos seus endereços IP elásticos para usar no EC2-Classic. ``` aws ec2 describe-addresses \ --filters "Name=domain,Values=standard" ``` Resultado: ``` { "Addresses": [ { "InstanceId": "i-1234567890abcdef0", "PublicIp": "203.0.110.25", "PublicIpv4Pool": "amazon", "Domain": "standard" } ] } ``` **Exemplo 6: recuperar detalhes sobre um endereço IP elástico especificado pelo endereço IP público** O exemplo `describe-addresses` a seguir mostra os detalhes do endereço IP elástico com o valor`203.0.110.25`, que está associado a uma instância no EC2-Classic. ``` aws ec2 describe-addresses \ --public-ips 203.0.110.25 ``` Resultado: ``` { "Addresses": [ { "InstanceId": "i-1234567890abcdef0", "PublicIp": "203.0.110.25", "PublicIpv4Pool": "amazon", "Domain": "standard" } ] } ``` + Consulte detalhes da API em [DescribeAddresses](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-addresses.html) na *Referência de comandos da AWS CLI*. ### `describe-aggregate-id-format` O código de exemplo a seguir mostra como usar `describe-aggregate-id-format`. **AWS CLI** **Descrever as configurações do formato de ID mais longo para todos os tipos de recurso em uma região** O exemplo `describe-aggregate-id-format` a seguir descreve o status geral do formato de ID longo para a região atual. O valor `Deadline` indica que os prazos para que esses recursos mudassem permanentemente do formato de ID curto para o formato de ID longo expiraram. O valor `UseLongIdsAggregated` indica que todos os usuários do IAM e perfis do IAM estão configurados para usar o formato de ID longo para todos os tipos de recursos. ``` aws ec2 describe-aggregate-id-format ``` Resultado: ``` { "UseLongIdsAggregated": true, "Statuses": [ { "Deadline": "2018-08-13T02:00:00.000Z", "Resource": "network-interface-attachment", "UseLongIds": true }, { "Deadline": "2016-12-13T02:00:00.000Z", "Resource": "instance", "UseLongIds": true }, { "Deadline": "2018-08-13T02:00:00.000Z", "Resource": "elastic-ip-association", "UseLongIds": true }, ... ] } ``` + Para ver detalhes da API, consulte [DescribeAggregateIdFormat](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-aggregate-id-format.html) na *Referência de comandos da AWS CLI*. ### `describe-availability-zones` O código de exemplo a seguir mostra como usar `describe-availability-zones`. **AWS CLI** **Para descrever suas zonas de disponibilidade** O exemplo `describe-availability-zones` a seguir exibe detalhes das zonas de disponibilidade disponíveis para você. A resposta inclui zonas de disponibilidade somente para a região atual. Neste exemplo, ela usa a região padrão dos perfis do `us-west-2` (Oregon). ``` aws ec2 describe-availability-zones ``` Resultado: ``` { "AvailabilityZones": [ { "State": "available", "OptInStatus": "opt-in-not-required", "Messages": [], "RegionName": "us-west-2", "ZoneName": "us-west-2a", "ZoneId": "usw2-az1", "GroupName": "us-west-2", "NetworkBorderGroup": "us-west-2" }, { "State": "available", "OptInStatus": "opt-in-not-required", "Messages": [], "RegionName": "us-west-2", "ZoneName": "us-west-2b", "ZoneId": "usw2-az2", "GroupName": "us-west-2", "NetworkBorderGroup": "us-west-2" }, { "State": "available", "OptInStatus": "opt-in-not-required", "Messages": [], "RegionName": "us-west-2", "ZoneName": "us-west-2c", "ZoneId": "usw2-az3", "GroupName": "us-west-2", "NetworkBorderGroup": "us-west-2" }, { "State": "available", "OptInStatus": "opt-in-not-required", "Messages": [], "RegionName": "us-west-2", "ZoneName": "us-west-2d", "ZoneId": "usw2-az4", "GroupName": "us-west-2", "NetworkBorderGroup": "us-west-2" }, { "State": "available", "OptInStatus": "opted-in", "Messages": [], "RegionName": "us-west-2", "ZoneName": "us-west-2-lax-1a", "ZoneId": "usw2-lax1-az1", "GroupName": "us-west-2-lax-1", "NetworkBorderGroup": "us-west-2-lax-1" } ] } ``` + Consulte detalhes da API em [DescribeAvailabilityZones](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-availability-zones.html) na *Referência de comandos da AWS CLI*. ### `describe-aws-network-performance-metric-subscription` O código de exemplo a seguir mostra como usar `describe-aws-network-performance-metric-subscription`. **AWS CLI** **Descrever suas assinaturas métricas** O exemplo `describe-aws-network-performance-metric-subscriptions` a seguir descreve suas assinaturas métricas. ``` aws ec2 describe-aws-network-performance-metric-subscriptions ``` Resultado: ``` { "Subscriptions": [ { "Source": "us-east-1", "Destination": "eu-west-1", "Metric": "aggregate-latency", "Statistic": "p50", "Period": "five-minutes" } ] } ``` Para obter mais informações, consulte [Gerenciar assinaturas](https://docs.aws.amazon.com/network-manager/latest/infrastructure-performance/nmip-subscriptions-cw.html) no *Guia do usuário de desempenho da infraestrutura*. + Para ver detalhes da API, consulte [DescribeAwsNetworkPerformanceMetricSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-aws-network-performance-metric-subscription.html) na *Referência de comandos da AWS CLI*. ### `describe-aws-network-performance-metric-subscriptions` O código de exemplo a seguir mostra como usar `describe-aws-network-performance-metric-subscriptions`. **AWS CLI** **Descrever suas assinaturas métricas** O exemplo `describe-aws-network-performance-metric-subscriptions` a seguir descreve suas assinaturas métricas. ``` aws ec2 describe-aws-network-performance-metric-subscriptions ``` Resultado: ``` { "Subscriptions": [ { "Source": "us-east-1", "Destination": "eu-west-1", "Metric": "aggregate-latency", "Statistic": "p50", "Period": "five-minutes" } ] } ``` Para obter mais informações, consulte [Gerenciar assinaturas](https://docs.aws.amazon.com/network-manager/latest/infrastructure-performance/nmip-subscriptions-cw.html) no *Guia do usuário de desempenho da infraestrutura*. + Para ver detalhes da API, consulte [DescribeAwsNetworkPerformanceMetricSubscriptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-aws-network-performance-metric-subscriptions.html) na *Referência de comandos da AWS CLI*. ### `describe-bundle-tasks` O código de exemplo a seguir mostra como usar `describe-bundle-tasks`. **AWS CLI** **Descrever suas tarefas de empacotamento** Este exemplo descreve todas as tarefas de empacotamento. Comando: ``` aws ec2 describe-bundle-tasks ``` Resultado: ``` { "BundleTasks": [ { "UpdateTime": "2015-09-15T13:26:54.000Z", "InstanceId": "i-1234567890abcdef0", "Storage": { "S3": { "Prefix": "winami", "Bucket": "bundletasks" } }, "State": "bundling", "StartTime": "2015-09-15T13:24:35.000Z", "Progress": "3%", "BundleId": "bun-2a4e041c" } ] } ``` + Para ver detalhes da API, consulte [DescribeBundleTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-bundle-tasks.html) na *Referência de comandos da AWS CLI*. ### `describe-byoip-cidrs` O código de exemplo a seguir mostra como usar `describe-byoip-cidrs`. **AWS CLI** **Descrever seus intervalos de endereços provisionados** O exemplo `describe-byoip-cidrs` a seguir exibe detalhes sobre os intervalos de endereços IPv4 públicos que você provisionou para uso pela AWS. ``` aws ec2 describe-byoip-cidrs ``` Resultado: ``` { "ByoipCidrs": [ { "Cidr": "203.0.113.25/24", "StatusMessage": "ipv4pool-ec2-1234567890abcdef0", "State": "provisioned" } ] } ``` + Para ver detalhes da API, consulte [DescribeByoipCidrs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-byoip-cidrs.html) na *Referência de comandos da AWS CLI*. ### `describe-capacity-reservation-fleets` O código de exemplo a seguir mostra como usar `describe-capacity-reservation-fleets`. **AWS CLI** **Visualizar uma frota de reserva de capacidade** O exemplo `describe-capacity-reservation-fleets` a seguir lista as informações de configuração e capacidade da frota de reserva de capacidade especificada. Ele também lista detalhes sobre as reservas de capacidade individuais que estão na frota. ``` aws ec2 describe-capacity-reservation-fleets \ --capacity-reservation-fleet-ids crf-abcdef01234567890 ``` Resultado: ``` { "CapacityReservationFleets": [ { "State": "active", "EndDate": "2022-12-31T23:59:59.000Z", "InstanceMatchCriteria": "open", "Tags": [], "CapacityReservationFleetId": "crf-abcdef01234567890", "Tenancy": "default", "InstanceTypeSpecifications": [ { "CapacityReservationId": "cr-1234567890abcdef0", "AvailabilityZone": "us-east-1a", "FulfilledCapacity": 5.0, "Weight": 1.0, "CreateDate": "2022-07-02T08:34:33.398Z", "InstancePlatform": "Linux/UNIX", "TotalInstanceCount": 5, "Priority": 1, "EbsOptimized": true, "InstanceType": "m5.xlarge" } ], "TotalTargetCapacity": 5, "TotalFulfilledCapacity": 5.0, "CreateTime": "2022-07-02T08:34:33.397Z", "AllocationStrategy": "prioritized" } ] } ``` Para obter mais informações sobre as Frotas de Reserva de Capacidade, consulte [Frotas de reserva de capacidade](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-fleets.html) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [DescribeCapacityReservationFleets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-capacity-reservation-fleets.html) na *Referência de comandos da AWS CLI*. ### `describe-capacity-reservations` O código de exemplo a seguir mostra como usar `describe-capacity-reservations`. **AWS CLI** **Exemplo 1: descrever uma ou mais de suas reservas de capacidade** O exemplo `describe-capacity-reservations` a seguir exibe detalhes sobre todas as suas reservas de capacidade na região da AWS atual. ``` aws ec2 describe-capacity-reservations ``` Resultado: ``` { "CapacityReservations": [ { "CapacityReservationId": "cr-1234abcd56EXAMPLE ", "OwnerId": "123456789111", "CapacityReservationArn": "arn:aws:ec2:us-east-1:123456789111:capacity-reservation/cr-1234abcd56EXAMPLE", "AvailabilityZoneId": "use1-az2", "InstanceType": "c5.large", "InstancePlatform": "Linux/UNIX", "AvailabilityZone": "us-east-1a", "Tenancy": "default", "TotalInstanceCount": 1, "AvailableInstanceCount": 1, "EbsOptimized": true, "EphemeralStorage": false, "State": "active", "StartDate": "2024-10-23T15:00:24+00:00", "EndDateType": "unlimited", "InstanceMatchCriteria": "open", "CreateDate": "2024-10-23T15:00:24+00:00", "Tags": [], "CapacityAllocations": [] }, { "CapacityReservationId": "cr-abcdEXAMPLE9876ef ", "OwnerId": "123456789111", "CapacityReservationArn": "arn:aws:ec2:us-east-1:123456789111:capacity-reservation/cr-abcdEXAMPLE9876ef", "AvailabilityZoneId": "use1-az2", "InstanceType": "c4.large", "InstancePlatform": "Linux/UNIX", "AvailabilityZone": "us-east-1a", "Tenancy": "default", "TotalInstanceCount": 1, "AvailableInstanceCount": 1, "EbsOptimized": true, "EphemeralStorage": false, "State": "cancelled", "StartDate": "2024-10-23T15:01:03+00:00", "EndDateType": "unlimited", "InstanceMatchCriteria": "open", "CreateDate": "2024-10-23T15:01:02+00:00", "Tags": [], "CapacityAllocations": [] } ] } ``` **Exemplo 2: descrever uma ou mais de suas reservas de capacidade** O exemplo `describe-capacity-reservations` a seguir exibe os detalhes da reserva de capacidade especificada. ``` aws ec2 describe-capacity-reservations \ --capacity-reservation-ids cr-1234abcd56EXAMPLE ``` Resultado: ``` { "CapacityReservations": [ { "CapacityReservationId": "cr-abcdEXAMPLE9876ef ", "OwnerId": "123456789111", "CapacityReservationArn": "arn:aws:ec2:us-east-1:123456789111:capacity-reservation/cr-abcdEXAMPLE9876ef", "AvailabilityZoneId": "use1-az2", "InstanceType": "c4.large", "InstancePlatform": "Linux/UNIX", "AvailabilityZone": "us-east-1a", "Tenancy": "default", "TotalInstanceCount": 1, "AvailableInstanceCount": 1, "EbsOptimized": true, "EphemeralStorage": false, "State": "active", "StartDate": "2024-10-23T15:01:03+00:00", "EndDateType": "unlimited", "InstanceMatchCriteria": "open", "CreateDate": "2024-10-23T15:01:02+00:00", "Tags": [], "CapacityAllocations": [] } ] } ``` Para obter mais informações, consulte [Visualizar uma reserva de capacidade](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-using.html#capacity-reservations-view) no *Guia do usuário do Amazon Elastic Compute Cloud para instâncias Linux*. + Para ver detalhes da API, consulte [DescribeCapacityReservations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-capacity-reservations.html) na *Referência de comandos da AWS CLI*. ### `describe-carrier-gateways` O código de exemplo a seguir mostra como usar `describe-carrier-gateways`. **AWS CLI** **Descrever todos os gateways da operadora** O exemplo `describe-carrier-gateways` a seguir lista todos os gateways da operadora. ``` aws ec2 describe-carrier-gateways ``` Resultado: ``` { "CarrierGateways": [ { "CarrierGatewayId": "cagw-0465cdEXAMPLE1111", "VpcId": "vpc-0c529aEXAMPLE", "State": "available", "OwnerId": "123456789012", "Tags": [ { "Key": "example", "Value": "tag" } ] } ] } ``` Para obter mais informações, consulte Gateways de operadoras no *Guia do usuário da Amazon Virtual Private Cloud*. + Para ver detalhes da API, consulte [DescribeCarrierGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-carrier-gateways.html) na *Referência de comandos da AWS CLI*. ### `describe-classic-link-instances` O código de exemplo a seguir mostra como usar `describe-classic-link-instances`. **AWS CLI** **Descrever instâncias vinculadas do EC2-Classic** Este exemplo lista todas as suas instâncias vinculadas do EC2-Classic. Comando: ``` aws ec2 describe-classic-link-instances ``` Resultado: ``` { "Instances": [ { "InstanceId": "i-1234567890abcdef0", "VpcId": "vpc-88888888", "Groups": [ { "GroupId": "sg-11122233" } ], "Tags": [ { "Value": "ClassicInstance", "Key": "Name" } ] }, { "InstanceId": "i-0598c7d356eba48d7", "VpcId": "vpc-12312312", "Groups": [ { "GroupId": "sg-aabbccdd" } ], "Tags": [ { "Value": "ClassicInstance2", "Key": "Name" } ] } ] } ``` Este exemplo lista todas as suas instâncias do EC2-Classic vinculadas e filtra a resposta para incluir somente instâncias vinculadas à VPC vpc-88888888. Comando: ``` aws ec2 describe-classic-link-instances --filter "Name=vpc-id,Values=vpc-88888888" ``` Resultado: ``` { "Instances": [ { "InstanceId": "i-1234567890abcdef0", "VpcId": "vpc-88888888", "Groups": [ { "GroupId": "sg-11122233" } ], "Tags": [ { "Value": "ClassicInstance", "Key": "Name" } ] } ] } ``` + Para ver detalhes da API, consulte [DescribeClassicLinkInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-classic-link-instances.html) na *Referência de comandos da AWS CLI*. ### `describe-client-vpn-authorization-rules` O código de exemplo a seguir mostra como usar `describe-client-vpn-authorization-rules`. **AWS CLI** **Descrever as regras de autorização de um endpoint de Client VPN** O exemplo `describe-client-vpn-authorization-rules` a seguir exibe detalhes sobre as regras de autorização para o endpoint Client VPN especificado. ``` aws ec2 describe-client-vpn-authorization-rules \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde ``` Resultado: ``` { "AuthorizationRules": [ { "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", "GroupId": "", "AccessAll": true, "DestinationCidr": "0.0.0.0/0", "Status": { "Code": "active" } } ] } ``` Para obter mais informações, consulte [Regras de autorização](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-rules.html) no *Guia do administrador do Cliente VPN da AWS*. + Para ver detalhes da API, consulte [DescribeClientVpnAuthorizationRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-client-vpn-authorization-rules.html) na *Referência de comandos da AWS CLI*. ### `describe-client-vpn-connections` O código de exemplo a seguir mostra como usar `describe-client-vpn-connections`. **AWS CLI** **Descrever as conexões com um endpoint do Client VPN** O exemplo `describe-client-vpn-connections` a seguir exibe detalhes sobre as conexões do cliente com o endpoint do Client VPN especificado. ``` aws ec2 describe-client-vpn-connections \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde ``` Resultado: ``` { "Connections": [ { "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", "Timestamp": "2019-08-12 07:58:34", "ConnectionId": "cvpn-connection-0e03eb24267165acd", "ConnectionEstablishedTime": "2019-08-12 07:57:14", "IngressBytes": "32302", "EgressBytes": "5696", "IngressPackets": "332", "EgressPackets": "67", "ClientIp": "172.31.0.225", "CommonName": "client1.domain.tld", "Status": { "Code": "terminated" }, "ConnectionEndTime": "2019-08-12 07:58:34" }, { "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", "Timestamp": "2019-08-12 08:02:54", "ConnectionId": "cvpn-connection-00668867a40f18253", "ConnectionEstablishedTime": "2019-08-12 08:02:53", "IngressBytes": "2951", "EgressBytes": "2611", "IngressPackets": "9", "EgressPackets": "6", "ClientIp": "172.31.0.226", "CommonName": "client1.domain.tld", "Status": { "Code": "active" }, "ConnectionEndTime": "-" } ] } ``` Para obter mais informações, consulte [Conexões do cliente](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-connections.html) no *Guia do administrador do AWS Client VPN*. + Para ver detalhes da API, consulte [DescribeClientVpnConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-client-vpn-connections.html) na *Referência de comandos da AWS CLI*. ### `describe-client-vpn-endpoints` O código de exemplo a seguir mostra como usar `describe-client-vpn-endpoints`. **AWS CLI** **Descrever seus endpoints do Client VPN** O exemplo `describe-client-vpn-endpoints` a seguir exibe detalhes sobre todos os seus endpoints do Client VPN. ``` aws ec2 describe-client-vpn-endpoints ``` Resultado: ``` { "ClientVpnEndpoints": [ { "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", "Description": "Endpoint for Admin access", "Status": { "Code": "available" }, "CreationTime": "2020-11-13T11:37:27", "DnsName": "*.cvpn-endpoint-123456789123abcde.prod.clientvpn.ap-south-1.amazonaws.com", "ClientCidrBlock": "172.31.0.0/16", "DnsServers": [ "8.8.8.8" ], "SplitTunnel": false, "VpnProtocol": "openvpn", "TransportProtocol": "udp", "VpnPort": 443, "ServerCertificateArn": "arn:aws:acm:ap-south-1:123456789012:certificate/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "AuthenticationOptions": [ { "Type": "certificate-authentication", "MutualAuthentication": { "ClientRootCertificateChain": "arn:aws:acm:ap-south-1:123456789012:certificate/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" } } ], "ConnectionLogOptions": { "Enabled": true, "CloudwatchLogGroup": "Client-vpn-connection-logs", "CloudwatchLogStream": "cvpn-endpoint-123456789123abcde-ap-south-1-2020/11/13-FCD8HEMVaCcw" }, "Tags": [ { "Key": "Name", "Value": "Client VPN" } ], "SecurityGroupIds": [ "sg-aabbcc11223344567" ], "VpcId": "vpc-a87f92c1", "SelfServicePortalUrl": "https://self-service.clientvpn.amazonaws.com/endpoints/cvpn-endpoint-123456789123abcde", "ClientConnectOptions": { "Enabled": false } } ] } ``` Para obter mais informações, consulte [Endpoints de Client VPN](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-endpoints.html) no *Guia do administrador do Cliente VPN da AWS*. + Para ver detalhes da API, consulte [DescribeClientVpnEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-client-vpn-endpoints.html) na *Referência de comandos da AWS CLI*. ### `describe-client-vpn-routes` O código de exemplo a seguir mostra como usar `describe-client-vpn-routes`. **AWS CLI** **Descrever as rotas de um endpoint de Client VPN** O exemplo `describe-client-vpn-routes` a seguir exibe detalhes sobre as rotas para o endpoint de Client VPN especificado. ``` aws ec2 describe-client-vpn-routes \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde ``` Resultado: ``` { "Routes": [ { "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", "DestinationCidr": "10.0.0.0/16", "TargetSubnet": "subnet-0123456789abcabca", "Type": "Nat", "Origin": "associate", "Status": { "Code": "active" }, "Description": "Default Route" }, { "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", "DestinationCidr": "0.0.0.0/0", "TargetSubnet": "subnet-0123456789abcabca", "Type": "Nat", "Origin": "add-route", "Status": { "Code": "active" } } ] } ``` Para obter mais informações, consulte [Rotas](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-routes.html) no *Guia do administrador de cliente VPN da AWS*. + Para ver detalhes da API, consulte [DescribeClientVpnRoutes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-client-vpn-routes.html) na *Referência de comandos da AWS CLI*. ### `describe-client-vpn-target-networks` O código de exemplo a seguir mostra como usar `describe-client-vpn-target-networks`. **AWS CLI** **Descrever as redes de destino de um endpoint de Client VPN** O exemplo `describe-client-vpn-target-networks` a seguir exibe detalhes sobre as redes de destino para o endpoint de Client VPN especificado. ``` aws ec2 describe-client-vpn-target-networks \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde ``` Resultado: ``` { "ClientVpnTargetNetworks": [ { "AssociationId": "cvpn-assoc-012e837060753dc3d", "VpcId": "vpc-11111222222333333", "TargetNetworkId": "subnet-0123456789abcabca", "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", "Status": { "Code": "associating" }, "SecurityGroups": [ "sg-012345678910abcab" ] } ] } ``` Para obter mais informações, consulte [Redes de destino](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-target.html) no *Guia do administrador da AWS*. + Para ver detalhes da API, consulte [DescribeClientVpnTargetNetworks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-client-vpn-target-networks.html) na *Referência de comandos da AWS CLI*. ### `describe-coip-pools` O código de exemplo a seguir mostra como usar `describe-coip-pools`. **AWS CLI** **Descrever os grupos de endereços IP pertencentes ao cliente** O exemplo `describe-coip-pools` a seguir descreve os grupos de endereços IP pertencentes ao cliente na sua conta da AWS. ``` aws ec2 describe-coip-pools ``` Resultado: ``` { "CoipPools": [ { "PoolId": "ipv4pool-coip-123a45678bEXAMPLE", "PoolCidrs": [ "0.0.0.0/0" ], "LocalGatewayRouteTableId": "lgw-rtb-059615ef7dEXAMPLE", "PoolArn": "arn:aws:ec2:us-west-2:123456789012:coip-pool/ipv4pool-coip-123a45678bEXAMPLE" } ] } ``` Para obter mais informações, consulte [Endereços IP pertencentes ao cliente](https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing) no *Guia do usuário do AWS Outposts*. + Para ver detalhes da API, consulte [DescribeCoipPools](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-coip-pools.html) na *Referência de comandos da AWS CLI*. ### `describe-conversion-tasks` O código de exemplo a seguir mostra como usar `describe-conversion-tasks`. **AWS CLI** **Visualizar o status de uma tarefa de conversão** Este exemplo retorna o status de uma tarefa de conversão com o ID import-i-ffvko9js. Comando: ``` aws ec2 describe-conversion-tasks --conversion-task-ids import-i-ffvko9js ``` Resultado: ``` { "ConversionTasks": [ { "ConversionTaskId": "import-i-ffvko9js", "ImportInstance": { "InstanceId": "i-1234567890abcdef0", "Volumes": [ { "Volume": { "Id": "vol-049df61146c4d7901", "Size": 16 }, "Status": "completed", "Image": { "Size": 1300687360, "ImportManifestUrl": "https://s3.amazonaws.com/myimportbucket/411443cd-d620-4f1c-9d66-13144EXAMPLE/RHEL5.vmdkmanifest.xml?AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE&Expires=140EXAMPLE&Signature=XYNhznHNgCqsjDxL9wRL%2FJvEXAMPLE", "Format": "VMDK" }, "BytesConverted": 1300682960, "AvailabilityZone": "us-east-1d" } ] }, "ExpirationTime": "2014-05-14T22:06:23Z", "State": "completed" } ] } ``` + Para ver detalhes da API, consulte [DescribeConversionTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-conversion-tasks.html) na *Referência de comandos da AWS CLI*. ### `describe-customer-gateways` O código de exemplo a seguir mostra como usar `describe-customer-gateways`. **AWS CLI** **Descrever os gateways do cliente** Este exemplo descreve os gateways do cliente. Comando: ``` aws ec2 describe-customer-gateways ``` Resultado: ``` { "CustomerGateways": [ { "CustomerGatewayId": "cgw-b4dc3961", "IpAddress": "203.0.113.12", "State": "available", "Type": "ipsec.1", "BgpAsn": "65000" }, { "CustomerGatewayId": "cgw-0e11f167", "IpAddress": "12.1.2.3", "State": "available", "Type": "ipsec.1", "BgpAsn": "65534" } ] } ``` **Descrever um gateway do cliente específico** Este exemplo descreve o gateway do cliente especificado. Comando: ``` aws ec2 describe-customer-gateways --customer-gateway-ids cgw-0e11f167 ``` Resultado: ``` { "CustomerGateways": [ { "CustomerGatewayId": "cgw-0e11f167", "IpAddress": "12.1.2.3", "State": "available", "Type": "ipsec.1", "BgpAsn": "65534" } ] } ``` + Para ver detalhes da API, consulte [DescribeCustomerGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-customer-gateways.html) na *Referência de comandos da AWS CLI*. ### `describe-dhcp-options` O código de exemplo a seguir mostra como usar `describe-dhcp-options`. **AWS CLI** **Exemplo 1: descrever as opções de DHCP** O exemplo `describe-dhcp-options` a seguir recupera detalhes das suas opções DHCP. ``` aws ec2 describe-dhcp-options ``` Resultado: ``` { "DhcpOptions": [ { "DhcpConfigurations": [ { "Key": "domain-name", "Values": [ { "Value": "us-east-2.compute.internal" } ] }, { "Key": "domain-name-servers", "Values": [ { "Value": "AmazonProvidedDNS" } ] } ], "DhcpOptionsId": "dopt-19edf471", "OwnerId": "111122223333" }, { "DhcpConfigurations": [ { "Key": "domain-name", "Values": [ { "Value": "us-east-2.compute.internal" } ] }, { "Key": "domain-name-servers", "Values": [ { "Value": "AmazonProvidedDNS" } ] } ], "DhcpOptionsId": "dopt-fEXAMPLE", "OwnerId": "111122223333" } ] } ``` Para obter mais informações, consulte [Trabalhar com conjuntos de opções DHCP](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html#DHCPOptionSet) no *Guia do usuário da AWS VPC*. **Exemplo 2: descrever suas opções de DHCP e filtrar o resultado** O exemplo `describe-dhcp-options` a seguir descreve as opções de DHCP e usa um filtro para retornar somente as opções de DHCP que têm `example.com` como o servidor de nomes de domínio. O exemplo usa o parâmetro `--query` para exibir somente as informações de configuração e o ID no resultado. ``` aws ec2 describe-dhcp-options \ --filters Name=key,Values=domain-name-servers Name=value,Values=example.com \ --query "DhcpOptions[*].[DhcpConfigurations,DhcpOptionsId]" ``` Resultado: ``` [ [ [ { "Key": "domain-name", "Values": [ { "Value": "example.com" } ] }, { "Key": "domain-name-servers", "Values": [ { "Value": "172.16.16.16" } ] } ], "dopt-001122334455667ab" ] ] ``` Para obter mais informações, consulte [Trabalhar com conjuntos de opções DHCP](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html#DHCPOptionSet) no *Guia do usuário da AWS VPC*. + Para ver detalhes da API, consulte [DescribeDhcpOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-dhcp-options.html) na *Referência de comandos da AWS CLI*. ### `describe-egress-only-internet-gateways` O código de exemplo a seguir mostra como usar `describe-egress-only-internet-gateways`. **AWS CLI** **Descrever um gateway da Internet somente de saída** Este exemplo descreve seus gateways da Internet somente de saída. Comando: ``` aws ec2 describe-egress-only-internet-gateways ``` Resultado: ``` { "EgressOnlyInternetGateways": [ { "EgressOnlyInternetGatewayId": "eigw-015e0e244e24dfe8a", "Attachments": [ { "State": "attached", "VpcId": "vpc-0c62a468" } ] } ] } ``` + Para ver detalhes da API, consulte [DescribeEgressOnlyInternetGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-egress-only-internet-gateways.html) na *Referência de comandos da AWS CLI*. ### `describe-elastic-gpus` O código de exemplo a seguir mostra como usar `describe-elastic-gpus`. **AWS CLI** **Descrever uma GPU Elastic** Comando: ``` aws ec2 describe-elastic-gpus --elastic-gpu-ids egpu-12345678901234567890abcdefghijkl ``` + Para ver detalhes da API, consulte [DescribeElasticGpus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-elastic-gpus.html) na *Referência de comandos da AWS CLI*. ### `describe-export-image-tasks` O código de exemplo a seguir mostra como usar `describe-export-image-tasks`. **AWS CLI** **Monitorar uma tarefa de exportação de imagem** O exemplo `describe-export-image-tasks` a seguir verifica o status da tarefa de exportação de imagem especificada. O arquivo de imagem resultante no Amazon S3 é `my-export-bucket/exports/export-ami-1234567890abcdef0.vmdk`. ``` aws ec2 describe-export-image-tasks \ --export-image-task-ids export-ami-1234567890abcdef0 ``` Saída para uma tarefa de exportação de imagem que está em andamento. ``` { "ExportImageTasks": [ { "ExportImageTaskId": "export-ami-1234567890abcdef0" "Progress": "21", "S3ExportLocation": { "S3Bucket": "my-export-bucket", "S3Prefix": "exports/" }, "Status": "active", "StatusMessage": "updating" } ] } ``` Saída para uma tarefa de exportação de imagem concluída. ``` { "ExportImageTasks": [ { "ExportImageTaskId": "export-ami-1234567890abcdef0" "S3ExportLocation": { "S3Bucket": "my-export-bucket", "S3Prefix": "exports/" }, "Status": "completed" } ] } ``` Para obter mais informações, consulte [Exportar uma VM de uma AMI](https://docs.aws.amazon.com/vm-import/latest/userguide/vmexport_image.html) no *Guia do usuário de VM Import/Export*. + Para ver detalhes da API, consulte [DescribeExportImageTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-export-image-tasks.html) na *Referência de comandos da AWS CLI*. ### `describe-export-tasks` O código de exemplo a seguir mostra como usar `describe-export-tasks`. **AWS CLI** **Listar detalhes sobre uma tarefa de exportação de instância** Este exemplo descreve a tarefa de exportação com o ID export-i-fh8sjjsq. Comando: ``` aws ec2 describe-export-tasks --export-task-ids export-i-fh8sjjsq ``` Resultado: ``` { "ExportTasks": [ { "State": "active", "InstanceExportDetails": { "InstanceId": "i-1234567890abcdef0", "TargetEnvironment": "vmware" }, "ExportToS3Task": { "S3Bucket": "myexportbucket", "S3Key": "RHEL5export-i-fh8sjjsq.ova", "DiskImageFormat": "vmdk", "ContainerFormat": "ova" }, "Description": "RHEL5 instance", "ExportTaskId": "export-i-fh8sjjsq" } ] } ``` + Para ver detalhes da API, consulte [DescribeExportTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-export-tasks.html) na *Referência de comandos da AWS CLI*. ### `describe-fast-launch-images` O código de exemplo a seguir mostra como usar `describe-fast-launch-images`. **AWS CLI** **Descrever os detalhes das AMIs do Windows configuradas para início mais rápido** O exemplo `describe-fast-launch-images` a seguir descreve os detalhes de cada uma das AMIs em sua conta que estão configuradas para lançamento mais rápido, incluindo o tipo de recurso, a configuração do snapshot, os detalhes do modelo de execução, o número máximo de inicializações paralelas, o ID do proprietário da AMI, o estado da configuração de inicialização rápida, o motivo pelo qual o estado foi alterado e a hora em que a mudança de estado ocorreu. ``` aws ec2 describe-fast-launch-images ``` Resultado: ``` { "FastLaunchImages": [ { "ImageId": "ami-01234567890abcedf", "ResourceType": "snapshot", "SnapshotConfiguration": {}, "LaunchTemplate": { "LaunchTemplateId": "lt-01234567890abcedf", "LaunchTemplateName": "EC2FastLaunchDefaultResourceCreation-a8c6215d-94e6-441b-9272-dbd1f87b07e2", "Version": "1" }, "MaxParallelLaunches": 6, "OwnerId": "0123456789123", "State": "enabled", "StateTransitionReason": "Client.UserInitiated", "StateTransitionTime": "2022-01-27T22:20:06.552000+00:00" } ] } ``` Para obter mais informações sobre como configurar uma AMI do Windows para uma inicialização mais rápida, consulte [Configurar AMI para uma execução mais rápida](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/windows-ami-version-history.html#win-ami-config-fast-launch) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [DescribeFastLaunchImages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-fast-launch-images.html) na *Referência de comandos da AWS CLI*. ### `describe-fast-snapshot-restores` O código de exemplo a seguir mostra como usar `describe-fast-snapshot-restores`. **AWS CLI** **Descrever restaurações rápidas de snapshot** O exemplo `describe-fast-snapshot-restores` a seguir exibe detalhes de todas as restaurações rápidas de snapshots com um estado `disabled`. ``` aws ec2 describe-fast-snapshot-restores \ --filters Name=state,Values=disabled ``` Resultado: ``` { "FastSnapshotRestores": [ { "SnapshotId": "snap-1234567890abcdef0", "AvailabilityZone": "us-west-2c", "State": "disabled", "StateTransitionReason": "Client.UserInitiated - Lifecycle state transition", "OwnerId": "123456789012", "EnablingTime": "2020-01-25T23:57:49.596Z", "OptimizingTime": "2020-01-25T23:58:25.573Z", "EnabledTime": "2020-01-25T23:59:29.852Z", "DisablingTime": "2020-01-26T00:40:56.069Z", "DisabledTime": "2020-01-26T00:41:27.390Z" } ] } ``` O exemplo `describe-fast-snapshot-restores` a seguir descreve todas as restaurações rápidas de snapshots. ``` aws ec2 describe-fast-snapshot-restores ``` + Para ver detalhes da API, consulte [DescribeFastSnapshotRestores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-fast-snapshot-restores.html) na *Referência de comandos da AWS CLI*. ### `describe-fleet-history` O código de exemplo a seguir mostra como usar `describe-fleet-history`. **AWS CLI** **Descrever a história da frota EC** O exemplo `describe-fleet-history` a seguir retorna o histórico da Frota do EC2 especificada a partir da hora determinada. O resultado é para uma frota do EC2 com duas instâncias em execução. ``` aws ec2 describe-fleet-history \ --fleet-id fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE \ --start-time 2020-09-01T00:00:00Z ``` Resultado: ``` { "HistoryRecords": [ { "EventInformation": { "EventSubType": "submitted" }, "EventType": "fleetRequestChange", "Timestamp": "2020-09-01T18:26:05.000Z" }, { "EventInformation": { "EventSubType": "active" }, "EventType": "fleetRequestChange", "Timestamp": "2020-09-01T18:26:15.000Z" }, { "EventInformation": { "EventDescription": "t2.small, ami-07c8bc5c1ce9598c3, ...", "EventSubType": "progress" }, "EventType": "fleetRequestChange", "Timestamp": "2020-09-01T18:26:17.000Z" }, { "EventInformation": { "EventDescription": "{\"instanceType\":\"t2.small\", ...}", "EventSubType": "launched", "InstanceId": "i-083a1c446e66085d2" }, "EventType": "instanceChange", "Timestamp": "2020-09-01T18:26:17.000Z" }, { "EventInformation": { "EventDescription": "{\"instanceType\":\"t2.small\", ...}", "EventSubType": "launched", "InstanceId": "i-090db02406cc3c2d6" }, "EventType": "instanceChange", "Timestamp": "2020-09-01T18:26:17.000Z" } ], "LastEvaluatedTime": "2020-09-01T19:10:19.000Z", "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE", "StartTime": "2020-08-31T23:53:20.000Z" } ``` Para obter mais informações, consulte [Gerenciar uma Frota EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html) no *Guia do usuário do Amazon Elastic Compute Cloud para instâncias Linux*. + Para ver detalhes da API, consulte [DescribeFleetHistory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-fleet-history.html) na *Referência de comandos da AWS CLI*. ### `describe-fleet-instances` O código de exemplo a seguir mostra como usar `describe-fleet-instances`. **AWS CLI** **Descrever as instâncias em execução de uma frota do EC** O exemplo `describe-fleet-instances` a seguir descreve as instâncias em execução da Frota do EC2 especificada. ``` aws ec2 describe-fleet-instances \ --fleet-id 12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE ``` Resultado: ``` { "ActiveInstances": [ { "InstanceId": "i-090db02406cc3c2d6", "InstanceType": "t2.small", "SpotInstanceRequestId": "sir-a43gtpfk", "InstanceHealth": "healthy" }, { "InstanceId": "i-083a1c446e66085d2", "InstanceType": "t2.small", "SpotInstanceRequestId": "sir-iwcit2nj", "InstanceHealth": "healthy" } ], "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" } ``` Para obter mais informações, consulte [Gerenciar uma Frota EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html) no *Guia do usuário do Amazon Elastic Compute Cloud para instâncias Linux*. + Para ver detalhes da API, consulte [DescribeFleetInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-fleet-instances.html) na *Referência de comandos da AWS CLI*. ### `describe-fleets` O código de exemplo a seguir mostra como usar `describe-fleets`. **AWS CLI** **Descrever uma frota EC** O exemplo `describe-fleets` a seguir descreve a Frota EC2 especificada. ``` aws ec2 describe-fleets \ --fleet-ids fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE ``` Resultado: ``` { "Fleets": [ { "ActivityStatus": "pending_fulfillment", "CreateTime": "2020-09-01T18:26:05.000Z", "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE", "FleetState": "active", "ExcessCapacityTerminationPolicy": "termination", "FulfilledCapacity": 0.0, "FulfilledOnDemandCapacity": 0.0, "LaunchTemplateConfigs": [ { "LaunchTemplateSpecification": { "LaunchTemplateId": "lt-0e632f2855a979cd5", "Version": "1" } } ], "TargetCapacitySpecification": { "TotalTargetCapacity": 2, "OnDemandTargetCapacity": 0, "SpotTargetCapacity": 2, "DefaultTargetCapacityType": "spot" }, "TerminateInstancesWithExpiration": false, "Type": "maintain", "ReplaceUnhealthyInstances": false, "SpotOptions": { "AllocationStrategy": "lowestPrice", "InstanceInterruptionBehavior": "terminate", "InstancePoolsToUseCount": 1 }, "OnDemandOptions": { "AllocationStrategy": "lowestPrice" } } ] } ``` Para obter mais informações, consulte [Gerenciar uma Frota EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html) no *Guia do usuário do Amazon Elastic Compute Cloud para instâncias Linux*. + Para ver detalhes da API, consulte [DescribeFleets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-fleets.html) na *Referência de comandos da AWS CLI*. ### `describe-flow-logs` O código de exemplo a seguir mostra como usar `describe-flow-logs`. **AWS CLI** **Exemplo 1: descrever todos os seus logs de fluxo** O exemplo `describe-flow-logs` a seguir exibe detalhes de todos os logs de fluxo. ``` aws ec2 describe-flow-logs ``` Resultado: ``` { "FlowLogs": [ { "CreationTime": "2018-02-21T13:22:12.644Z", "DeliverLogsPermissionArn": "arn:aws:iam::123456789012:role/flow-logs-role", "DeliverLogsStatus": "SUCCESS", "FlowLogId": "fl-aabbccdd112233445", "MaxAggregationInterval": 600, "FlowLogStatus": "ACTIVE", "LogGroupName": "FlowLogGroup", "ResourceId": "subnet-12345678901234567", "TrafficType": "ALL", "LogDestinationType": "cloud-watch-logs", "LogFormat": "${version} ${account-id} ${interface-id} ${srcaddr} ${dstaddr} ${srcport} ${dstport} ${protocol} ${packets} ${bytes} ${start} ${end} ${action} ${log-status}" }, { "CreationTime": "2020-02-04T15:22:29.986Z", "DeliverLogsStatus": "SUCCESS", "FlowLogId": "fl-01234567890123456", "MaxAggregationInterval": 60, "FlowLogStatus": "ACTIVE", "ResourceId": "vpc-00112233445566778", "TrafficType": "ACCEPT", "LogDestinationType": "s3", "LogDestination": "arn:aws:s3:::my-flow-log-bucket/custom", "LogFormat": "${version} ${vpc-id} ${subnet-id} ${instance-id} ${interface-id} ${account-id} ${type} ${srcaddr} ${dstaddr} ${srcport} ${dstport} ${pkt-srcaddr} ${pkt-dstaddr} ${protocol} ${bytes} ${packets} ${start} ${end} ${action} ${tcp-flags} ${log-status}" } ] } ``` **Exemplo 2: descrever um subconjunto dos seus logs de fluxo** O exemplo `describe-flow-logs` a seguir usa um filtro para exibir detalhes somente dos logs de fluxo que estão no grupo de logs especificado no Amazon CloudWatch Logs. ``` aws ec2 describe-flow-logs \ --filter "Name=log-group-name,Values=MyFlowLogs" ``` + Para ver detalhes da API, consulte [DescribeFlowLogs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-flow-logs.html) na *Referência de comandos da AWS CLI*. ### `describe-fpga-image-attribute` O código de exemplo a seguir mostra como usar `describe-fpga-image-attribute`. **AWS CLI** **Descrever os atributos de uma imagem do Amazon FPGA** Este exemplo descreve as permissões de carga para a AFI especificada. Comando: ``` aws ec2 describe-fpga-image-attribute --fpga-image-id afi-0d123e123bfc85abc --attribute loadPermission ``` Resultado: ``` { "FpgaImageAttribute": { "FpgaImageId": "afi-0d123e123bfc85abc", "LoadPermissions": [ { "UserId": "123456789012" } ] } } ``` + Para ver detalhes da API, consulte [DescribeFpgaImageAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-fpga-image-attribute.html) na *Referência de comandos da AWS CLI*. ### `describe-fpga-images` O código de exemplo a seguir mostra como usar `describe-fpga-images`. **AWS CLI** **Descrever imagens do Amazon FPGA** Este exemplo descreve as AFIs pertencentes à conta `123456789012`. Comando: ``` aws ec2 describe-fpga-images --filters Name=owner-id,Values=123456789012 ``` Resultado: ``` { "FpgaImages": [ { "UpdateTime": "2017-12-22T12:09:14.000Z", "Name": "my-afi", "PciId": { "SubsystemVendorId": "0xfedd", "VendorId": "0x1d0f", "DeviceId": "0xf000", "SubsystemId": "0x1d51" }, "FpgaImageGlobalId": "agfi-123cb27b5e84a0abc", "Public": false, "State": { "Code": "available" }, "ShellVersion": "0x071417d3", "OwnerId": "123456789012", "FpgaImageId": "afi-0d123e123bfc85abc", "CreateTime": "2017-12-22T11:43:33.000Z", "Description": "my-afi" } ] } ``` + Para ver detalhes da API, consulte [DescribeFpgaImages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-fpga-images.html) na *Referência de comandos da AWS CLI*. ### `describe-host-reservation-offerings` O código de exemplo a seguir mostra como usar `describe-host-reservation-offerings`. **AWS CLI** **Descrever as ofertas de reserva de host dedicado** Este exemplo descreve as Reservas de Host Dedicado para a família de instâncias M4 que estão disponíveis para compra. Comando: ``` aws ec2 describe-host-reservation-offerings --filter Name=instance-family,Values=m4 ``` Resultado: ``` { "OfferingSet": [ { "HourlyPrice": "1.499", "OfferingId": "hro-03f707bf363b6b324", "InstanceFamily": "m4", "PaymentOption": "NoUpfront", "UpfrontPrice": "0.000", "Duration": 31536000 }, { "HourlyPrice": "1.045", "OfferingId": "hro-0ef9181cabdef7a02", "InstanceFamily": "m4", "PaymentOption": "NoUpfront", "UpfrontPrice": "0.000", "Duration": 94608000 }, { "HourlyPrice": "0.714", "OfferingId": "hro-04567a15500b92a51", "InstanceFamily": "m4", "PaymentOption": "PartialUpfront", "UpfrontPrice": "6254.000", "Duration": 31536000 }, { "HourlyPrice": "0.484", "OfferingId": "hro-0d5d7a9d23ed7fbfe", "InstanceFamily": "m4", "PaymentOption": "PartialUpfront", "UpfrontPrice": "12720.000", "Duration": 94608000 }, { "HourlyPrice": "0.000", "OfferingId": "hro-05da4108ca998c2e5", "InstanceFamily": "m4", "PaymentOption": "AllUpfront", "UpfrontPrice": "23913.000", "Duration": 94608000 }, { "HourlyPrice": "0.000", "OfferingId": "hro-0a9f9be3b95a3dc8f", "InstanceFamily": "m4", "PaymentOption": "AllUpfront", "UpfrontPrice": "12257.000", "Duration": 31536000 } ] } ``` + Para ver detalhes da API, consulte [DescribeHostReservationOfferings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-host-reservation-offerings.html) na *Referência de comandos da AWS CLI*. ### `describe-host-reservations` O código de exemplo a seguir mostra como usar `describe-host-reservations`. **AWS CLI** **Descrever as reservas de host dedicado em sua conta** Este exemplo descreve as Reservas de Host Dedicado em sua conta. Comando: ``` aws ec2 describe-host-reservations ``` Resultado: ``` { "HostReservationSet": [ { "Count": 1, "End": "2019-01-10T12:14:09Z", "HourlyPrice": "1.499", "InstanceFamily": "m4", "OfferingId": "hro-03f707bf363b6b324", "PaymentOption": "NoUpfront", "State": "active", "HostIdSet": [ "h-013abcd2a00cbd123" ], "Start": "2018-01-10T12:14:09Z", "HostReservationId": "hr-0d418a3a4ffc669ae", "UpfrontPrice": "0.000", "Duration": 31536000 } ] } ``` + Para ver detalhes da API, consulte [DescribeHostReservations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-host-reservations.html) na *Referência de comandos da AWS CLI*. ### `describe-hosts` O código de exemplo a seguir mostra como usar `describe-hosts`. **AWS CLI** **Visualizar os detalhes de um Host dedicado** O exemplo `describe-hosts` a seguir exibe detalhes dos Hosts Dedicados `available` em sua conta da AWS. ``` aws ec2 describe-hosts --filter "Name=state,Values=available" ``` Resultado: ``` { "Hosts": [ { "HostId": "h-07879acf49EXAMPLE", "Tags": [ { "Value": "production", "Key": "purpose" } ], "HostProperties": { "Cores": 48, "TotalVCpus": 96, "InstanceType": "m5.large", "Sockets": 2 }, "Instances": [], "State": "available", "AvailabilityZone": "eu-west-1a", "AvailableCapacity": { "AvailableInstanceCapacity": [ { "AvailableCapacity": 48, "InstanceType": "m5.large", "TotalCapacity": 48 } ], "AvailableVCpus": 96 }, "HostRecovery": "on", "AllocationTime": "2019-08-19T08:57:44.000Z", "AutoPlacement": "off" } ] } ``` Para obter mais informações, consulte [Visualizar Hosts Dedicados](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-managing) no *Guia do usuário do Amazon Elastic Compute Cloud para instâncias do Linux*. + Para ver detalhes da API, consulte [DescribeHosts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-hosts.html) na *Referência de comandos da AWS CLI*. ### `describe-iam-instance-profile-associations` O código de exemplo a seguir mostra como usar `describe-iam-instance-profile-associations`. **AWS CLI** **Para descrever as associações do perfil de instância do IAM** Este exemplo descreve todas as suas associações de perfil de instância do IAM. Comando: ``` aws ec2 describe-iam-instance-profile-associations ``` Resultado: ``` { "IamInstanceProfileAssociations": [ { "InstanceId": "i-09eb09efa73ec1dee", "State": "associated", "AssociationId": "iip-assoc-0db249b1f25fa24b8", "IamInstanceProfile": { "Id": "AIPAJVQN4F5WVLGCJDRGM", "Arn": "arn:aws:iam::123456789012:instance-profile/admin-role" } }, { "InstanceId": "i-0402909a2f4dffd14", "State": "associating", "AssociationId": "iip-assoc-0d1ec06278d29f44a", "IamInstanceProfile": { "Id": "AGJAJVQN4F5WVLGCJABCM", "Arn": "arn:aws:iam::123456789012:instance-profile/user1-role" } } ] } ``` + Consulte detalhes da API em [DescribeIamInstanceProfileAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-iam-instance-profile-associations.html) na *Referência de comandos da AWS CLI*. ### `describe-id-format` O código de exemplo a seguir mostra como usar `describe-id-format`. **AWS CLI** **Exemplo 1: descrever o formato de ID de um recurso** O exemplo `describe-id-format` a seguir descreve o formato de ID para grupos de segurança. ``` aws ec2 describe-id-format \ --resource security-group ``` No exemplo de saída a seguir, o valor `Deadline` indica que o prazo para esse tipo de recurso mudar permanentemente do formato de ID curto para o formato de ID longo expirou às 00:00 UTC de 15 de agosto de 2018. ``` { "Statuses": [ { "Deadline": "2018-08-15T00:00:00.000Z", "Resource": "security-group", "UseLongIds": true } ] } ``` **Exemplo 2: descrever o formato de ID de todos os recursos** O exemplo `describe-id-format` a seguir descreve o formato de ID para todos os tipos de recursos. Todos os tipos de recursos compatíveis com o formato de ID curto foram alterados para o formato de ID longo. ``` aws ec2 describe-id-format ``` + Para ver detalhes da API, consulte [DescribeIdFormat](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-id-format.html) na *Referência de comandos da AWS CLI*. ### `describe-identity-id-format` O código de exemplo a seguir mostra como usar `describe-identity-id-format`. **AWS CLI** **Descrever o formato de ID de um perfil do IAM** O exemplo `describe-identity-id-format` a seguir descreve o formato de ID recebido pelas instâncias criadas pelo perfil do IAM `EC2Role` em sua conta da AWS. ``` aws ec2 describe-identity-id-format \ --principal-arn arn:aws:iam::123456789012:role/my-iam-role \ --resource instance ``` O resultado a seguir indica que as instâncias criadas por essa função recebem IDs no formato de ID longo. ``` { "Statuses": [ { "Deadline": "2016-12-15T00:00:00Z", "Resource": "instance", "UseLongIds": true } ] } ``` **Descrever o formato de ID de um usuário do IAM** O exemplo `describe-identity-id-format` a seguir descreve o formato de ID recebido pelos snapshots criados pelo usuário do IAM `AdminUser` em sua conta da AWS. ``` aws ec2 describe-identity-id-format \ --principal-arn arn:aws:iam::123456789012:user/AdminUser \ --resource snapshot ``` O resultado indica que os snapshots criados por esse usuário recebem IDs no formato de ID longo. ``` { "Statuses": [ { "Deadline": "2016-12-15T00:00:00Z", "Resource": "snapshot", "UseLongIds": true } ] } ``` + Para ver detalhes da API, consulte [DescribeIdentityIdFormat](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-identity-id-format.html) na *Referência de comandos da AWS CLI*. ### `describe-image-attribute` O código de exemplo a seguir mostra como usar `describe-image-attribute`. **AWS CLI** **Descrever as permissões de lançamento de uma AMI** Este exemplo descreve as permissões de lançamento da AMI especificada. Comando: ``` aws ec2 describe-image-attribute --image-id ami-5731123e --attribute launchPermission ``` Resultado: ``` { "LaunchPermissions": [ { "UserId": "123456789012" } ], "ImageId": "ami-5731123e", } ``` **Descrever os códigos de produto de uma AMI** Este exemplo descreve os códigos de produto para a AMI especificada. Observe que essa AMI não tem códigos de produto. Comando: ``` aws ec2 describe-image-attribute --image-id ami-5731123e --attribute productCodes ``` Resultado: ``` { "ProductCodes": [], "ImageId": "ami-5731123e", } ``` + Para ver detalhes da API, consulte [DescribeImageAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-image-attribute.html) na *Referência de comandos da AWS CLI*. ### `describe-images` O código de exemplo a seguir mostra como usar `describe-images`. **AWS CLI** **Exemplo 1: descrever uma AMI** O exemplo `describe-images` a seguir descreve a AMI especificada na região especificada. ``` aws ec2 describe-images \ --region us-east-1 \ --image-ids ami-1234567890EXAMPLE ``` Resultado: ``` { "Images": [ { "VirtualizationType": "hvm", "Description": "Provided by Red Hat, Inc.", "PlatformDetails": "Red Hat Enterprise Linux", "EnaSupport": true, "Hypervisor": "xen", "State": "available", "SriovNetSupport": "simple", "ImageId": "ami-1234567890EXAMPLE", "UsageOperation": "RunInstances:0010", "BlockDeviceMappings": [ { "DeviceName": "/dev/sda1", "Ebs": { "SnapshotId": "snap-111222333444aaabb", "DeleteOnTermination": true, "VolumeType": "gp2", "VolumeSize": 10, "Encrypted": false } } ], "Architecture": "x86_64", "ImageLocation": "123456789012/RHEL-8.0.0_HVM-20190618-x86_64-1-Hourly2-GP2", "RootDeviceType": "ebs", "OwnerId": "123456789012", "RootDeviceName": "/dev/sda1", "CreationDate": "2019-05-10T13:17:12.000Z", "Public": true, "ImageType": "machine", "Name": "RHEL-8.0.0_HVM-20190618-x86_64-1-Hourly2-GP2" } ] } ``` Para obter mais informações, consulte [Imagens de máquina da Amazon (AMIs)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html) no *Guia do usuário do Amazon EC2*. **Exemplo 2: descrever AMIs com base em filtros** O exemplo `describe-images` a seguir descreve as AMIs do Windows fornecidas pela Amazon com o Amazon EBS. ``` aws ec2 describe-images \ --owners amazon \ --filters "Name=platform,Values=windows" "Name=root-device-type,Values=ebs" ``` Para obter um exemplo da saída de `describe-images`, consulte o Exemplo 1. Para obter mais exemplos do uso de filtros, consulte [Listar e filtrar seus recursos](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html#Filtering_Resources_CLI) no *Guia do usuário do Amazon EC2*. **Exemplo 3: descrever AMIs com base em tags** O exemplo `describe-images` a seguir descreve todas as AMIs que têm a tag `Type=Custom`. O exemplo usa o parâmetro `--query` para exibir somente os IDs da AMI. ``` aws ec2 describe-images \ --filters "Name=tag:Type,Values=Custom" \ --query 'Images[*].[ImageId]' \ --output text ``` Resultado: ``` ami-1234567890EXAMPLE ami-0abcdef1234567890 ``` Para obter mais exemplos do uso de filtros de tags, consulte [Trabalhando com tags](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#Using_Tags_CLI) no *Guia do usuário do Amazon EC2*. + Consulte detalhes da API em [DescribeImages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-images.html) na *Referência de comandos da AWS CLI*. ### `describe-import-image-tasks` O código de exemplo a seguir mostra como usar `describe-import-image-tasks`. **AWS CLI** **Monitorar uma tarefa de importação de imagem** O exemplo `describe-import-image-tasks` a seguir verifica o status da tarefa de importação de imagem especificada. ``` aws ec2 describe-import-image-tasks \ --import-task-ids import-ami-1234567890abcdef0 ``` Resultado para uma tarefa de importação de imagem que está em andamento. ``` { "ImportImageTasks": [ { "ImportTaskId": "import-ami-1234567890abcdef0", "Progress": "28", "SnapshotDetails": [ { "DiskImageSize": 705638400.0, "Format": "ova", "Status": "completed", "UserBucket": { "S3Bucket": "my-import-bucket", "S3Key": "vms/my-server-vm.ova" } } ], "Status": "active", "StatusMessage": "converting" } ] } ``` Resultado para uma tarefa de importação de imagem concluída. O ID da AMI resultante é fornecido por `ImageId`. ``` { "ImportImageTasks": [ { "ImportTaskId": "import-ami-1234567890abcdef0", "ImageId": "ami-1234567890abcdef0", "SnapshotDetails": [ { "DiskImageSize": 705638400.0, "Format": "ova", "SnapshotId": "snap-1234567890abcdef0" "Status": "completed", "UserBucket": { "S3Bucket": "my-import-bucket", "S3Key": "vms/my-server-vm.ova" } } ], "Status": "completed" } ] } ``` + Para ver detalhes da API, consulte [DescribeImportImageTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-import-image-tasks.html) na *Referência de comandos da AWS CLI*. ### `describe-import-snapshot-tasks` O código de exemplo a seguir mostra como usar `describe-import-snapshot-tasks`. **AWS CLI** **Monitorar uma tarefa de importação de snapshots** O exemplo `describe-import-snapshot-tasks` a seguir verifica o status da tarefa de importação instantânea especificada. ``` aws ec2 describe-import-snapshot-tasks \ --import-task-ids import-snap-1234567890abcdef0 ``` Resultado de uma tarefa de captura de snapshot de importação que está em andamento: ``` { "ImportSnapshotTasks": [ { "Description": "My server VMDK", "ImportTaskId": "import-snap-1234567890abcdef0", "SnapshotTaskDetail": { "Description": "My server VMDK", "DiskImageSize": "705638400.0", "Format": "VMDK", "Progress": "42", "Status": "active", "StatusMessage": "downloading/converting", "UserBucket": { "S3Bucket": "my-import-bucket", "S3Key": "vms/my-server-vm.vmdk" } } } ] } ``` Resultado para uma tarefa de importação de snapshot concluída. O ID do snapshot resultante é fornecido por `SnapshotId`. ``` { "ImportSnapshotTasks": [ { "Description": "My server VMDK", "ImportTaskId": "import-snap-1234567890abcdef0", "SnapshotTaskDetail": { "Description": "My server VMDK", "DiskImageSize": "705638400.0", "Format": "VMDK", "SnapshotId": "snap-1234567890abcdef0" "Status": "completed", "UserBucket": { "S3Bucket": "my-import-bucket", "S3Key": "vms/my-server-vm.vmdk" } } } ] } ``` + Para ver detalhes da API, consulte [DescribeImportSnapshotTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-import-snapshot-tasks.html) na *Referência de comandos da AWS CLI*. ### `describe-instance-attribute` O código de exemplo a seguir mostra como usar `describe-instance-attribute`. **AWS CLI** **Descrever o tipo de instância** Este exemplo descreve o tipo de instância da instância especificada. Comando: ``` aws ec2 describe-instance-attribute --instance-id i-1234567890abcdef0 --attribute instanceType ``` Resultado: ``` { "InstanceId": "i-1234567890abcdef0" "InstanceType": { "Value": "t1.micro" } } ``` **Descrever o atributo disableApiTermination** Este exemplo descreve o atributo `disableApiTermination` da instância especificada. Comando: ``` aws ec2 describe-instance-attribute --instance-id i-1234567890abcdef0 --attribute disableApiTermination ``` Resultado: ``` { "InstanceId": "i-1234567890abcdef0" "DisableApiTermination": { "Value": "false" } } ``` **Descrever um mapeamento de dispositivos de blocos para uma instância** Este exemplo descreve o atributo `blockDeviceMapping` da instância especificada. Comando: ``` aws ec2 describe-instance-attribute --instance-id i-1234567890abcdef0 --attribute blockDeviceMapping ``` Resultado: ``` { "InstanceId": "i-1234567890abcdef0" "BlockDeviceMappings": [ { "DeviceName": "/dev/sda1", "Ebs": { "Status": "attached", "DeleteOnTermination": true, "VolumeId": "vol-049df61146c4d7901", "AttachTime": "2013-05-17T22:42:34.000Z" } }, { "DeviceName": "/dev/sdf", "Ebs": { "Status": "attached", "DeleteOnTermination": false, "VolumeId": "vol-049df61146c4d7901", "AttachTime": "2013-09-10T23:07:00.000Z" } } ], } ``` + Para ver detalhes da API, consulte [DescribeInstanceAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-instance-attribute.html) na *Referência de comandos da AWS CLI*. ### `describe-instance-connect-endpoints` O código de exemplo a seguir mostra como usar `describe-instance-connect-endpoints`. **AWS CLI** **Descrever um endpoint de conexão de instância EC** O exemplo `describe-instance-connect-endpoints` a seguir descreve o endpoint de conexão de instância EC2 especificado. ``` aws ec2 describe-instance-connect-endpoints \ --region us-east-1 \ --instance-connect-endpoint-ids eice-0123456789example ``` Resultado: ``` { "InstanceConnectEndpoints": [ { "OwnerId": "111111111111", "InstanceConnectEndpointId": "eice-0123456789example", "InstanceConnectEndpointArn": "arn:aws:ec2:us-east-1:111111111111:instance-connect-endpoint/eice-0123456789example", "State": "create-complete", "StateMessage": "", "DnsName": "eice-0123456789example.b67b86ba.ec2-instance-connect-endpoint.us-east-1.amazonaws.com", "NetworkInterfaceIds": [ "eni-0123456789example" ], "VpcId": "vpc-0123abcd", "AvailabilityZone": "us-east-1d", "CreatedAt": "2023-02-07T12:05:37+00:00", "SubnetId": "subnet-0123abcd", "Tags": [] } ] } ``` Para obter mais informações, consulte [Criar um endpoint de conexão de instância EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-ec2-instance-connect-endpoints.html) no *Guiado usuário do Amazon EC2*. + Para ver detalhes da API, consulte [DescribeInstanceConnectEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-instance-connect-endpoints.html) na *Referência de comandos da AWS CLI*. ### `describe-instance-credit-specifications` O código de exemplo a seguir mostra como usar `describe-instance-credit-specifications`. **AWS CLI** **Descrever a opção de crédito para uso de CPU de uma ou mais instâncias** O exemplo `describe-instance-credit-specifications` a seguir descreve a opção de crédito de CPU para a instância especificada. ``` aws ec2 describe-instance-credit-specifications \ --instance-ids i-1234567890abcdef0 ``` Resultado: ``` { "InstanceCreditSpecifications": [ { "InstanceId": "i-1234567890abcdef0", "CpuCredits": "unlimited" } ] } ``` Para obter mais informações, consulte [Trabalhar com instâncias de desempenho expansível](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-how-to.html) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [DescribeInstanceCreditSpecifications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-instance-credit-specifications.html) na *Referência de comandos da AWS CLI*. ### `describe-instance-event-notification-attributes` O código de exemplo a seguir mostra como usar `describe-instance-event-notification-attributes`. **AWS CLI** **Descrever as tags para notificações de eventos agendados** O exemplo `describe-instance-event-notification-attributes` a seguir descreve as tags que aparecerão nas notificações de eventos programados. ``` aws ec2 describe-instance-event-notification-attributes ``` Resultado: ``` { "InstanceTagAttribute": { "InstanceTagKeys": [], "IncludeAllTagsOfInstance": true } } ``` Para obter mais informações, consulte [Eventos programados para suas instâncias](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html) no *Guia do usuário do Amazon Elastic Compute Cloud para Instâncias Linux*. + Para ver detalhes da API, consulte [DescribeInstanceEventNotificationAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-instance-event-notification-attributes.html) na *Referência de comandos da AWS CLI*. ### `describe-instance-event-windows` O código de exemplo a seguir mostra como usar `describe-instance-event-windows`. **AWS CLI** **Exemplo 1: descrever todas as janelas de eventos** O exemplo `describe-instance-event-windows` a seguir descreve todas as janelas de eventos na região especificada. ``` aws ec2 describe-instance-event-windows \ --region us-east-1 ``` Resultado: ``` { "InstanceEventWindows": [ { "InstanceEventWindowId": "iew-0abcdef1234567890", "Name": "myEventWindowName", "CronExpression": "* 21-23 * * 2,3", "AssociationTarget": { "InstanceIds": [ "i-1234567890abcdef0", "i-0598c7d356eba48d7" ], "Tags": [], "DedicatedHostIds": [] }, "State": "active", "Tags": [] } ... ], "NextToken": "9d624e0c-388b-4862-a31e-a85c64fc1d4a" } ``` **Exemplo 2: descrever uma janela de eventos específica** O exemplo `describe-instance-event-windows` a seguir descreve um evento específico usando o parâmetro `instance-event-window` para descrever uma janela de evento específica. ``` aws ec2 describe-instance-event-windows \ --region us-east-1 \ --instance-event-window-ids iew-0abcdef1234567890 ``` Resultado: ``` { "InstanceEventWindows": [ { "InstanceEventWindowId": "iew-0abcdef1234567890", "Name": "myEventWindowName", "CronExpression": "* 21-23 * * 2,3", "AssociationTarget": { "InstanceIds": [ "i-1234567890abcdef0", "i-0598c7d356eba48d7" ], "Tags": [], "DedicatedHostIds": [] }, "State": "active", "Tags": [] } } ``` **Exemplo 3: descrever janelas de eventos que correspondam a um ou mais filtros** O exemplo `describe-instance-event-windows` a seguir descreve janelas de eventos que correspondam a um ou mais filtros usando o parâmetro `filter`. O filtro `instance-id` é usado para descrever todas as janelas de eventos que estão associadas à instância especificada. Quando um filtro é usado, ele executa uma correspondência direta. No entanto, o`instance-id`é diferente. Se não houver correspondência direta com o ID da instância, ele voltará para associações indiretas com a janela de eventos, como tags da instância ou ID de host dedicado (se a instância estiver em um host dedicado). ``` aws ec2 describe-instance-event-windows \ --region us-east-1 \ --filters Name=instance-id,Values=i-1234567890abcdef0 \ --max-results 100 \ --next-token ``` Resultado: ``` { "InstanceEventWindows": [ { "InstanceEventWindowId": "iew-0dbc0adb66f235982", "TimeRanges": [ { "StartWeekDay": "sunday", "StartHour": 2, "EndWeekDay": "sunday", "EndHour": 8 } ], "Name": "myEventWindowName", "AssociationTarget": { "InstanceIds": [], "Tags": [], "DedicatedHostIds": [ "h-0140d9a7ecbd102dd" ] }, "State": "active", "Tags": [] } ] } ``` No exemplo de saída, a instância está em um Host Dedicado, que está associado à janela de evento. Para restrições da janela de eventos, consulte [Considerações](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [DescribeInstanceEventWindows](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-instance-event-windows.html) na *Referência de comandos da AWS CLI*. ### `describe-instance-image-metadata` O código de exemplo a seguir mostra como usar `describe-instance-image-metadata`. **AWS CLI** **Exemplo 1: como descrever os metadados de AMI de todas as instâncias** O exemplo de `describe-instance-image-metadata` a seguir descreve os metadados de AMI de todas as instâncias em sua conta da AWS na região especificada. ``` aws ec2 describe-instance-image-metadata \ --region us-east-1 ``` Resultado: ``` { "InstanceImageMetadata": [ { "InstanceId": "i-1234567890EXAMPLE", "InstanceType": "t2.micro", "LaunchTime": "2024-08-28T11:25:45+00:00", "AvailabilityZone": "us-east-1a", "State": { "Code": 16, "Name": "running" }, "OwnerId": "123412341234", "Tags": [ { "Key": "MyTagName", "Value": "my-tag-value" } ], "ImageMetadata": { "ImageId": "ami-0b752bf1df193a6c4", "Name": "al2023-ami-2023.5.20240819.0-kernel-6.1-x86_64", "OwnerId": "137112412989", "State": "available", "ImageOwnerAlias": "amazon", "CreationDate": "2023-01-25T17:20:40Z", "DeprecationTime": "2025-01-25T17:20:40Z", "IsPublic": true } } ], "NextToken": "...EXAMPLEwIAABAA2JHaFxLnEXAMPLE..." } ``` Consulte mais informações em [Imagens de máquina da Amazon no Amazon EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html) no *Manual do usuário do Amazon EC2*. **Exemplo 2: como descrever os metadados de AMI das instâncias especificadas** O exemplo de `describe-instance-image-metadata` a seguir descreve os metadados de AMI das instâncias especificadas. ``` aws ec2 describe-instance-image-metadata \ --region us-east-1 \ --instance-ids i-1234567890EXAMPLE i-0987654321EXAMPLE ``` Resultado: ``` { "InstanceImageMetadata": [ { "InstanceId": "i-1234567890EXAMPLE", "InstanceType": "t2.micro", "LaunchTime": "2024-08-28T11:25:45+00:00", "AvailabilityZone": "us-east-1a", "State": { "Code": 16, "Name": "running" }, "OwnerId": "123412341234", "Tags": [ { "Key": "MyTagName", "Value": "my-tag-value" } ], "ImageMetadata": { "ImageId": "ami-0b752bf1df193a6c4", "Name": "al2023-ami-2023.5.20240819.0-kernel-6.1-x86_64", "OwnerId": "137112412989", "State": "available", "ImageOwnerAlias": "amazon", "CreationDate": "2023-01-25T17:20:40Z", "DeprecationTime": "2025-01-25T17:20:40Z", "IsPublic": true } }, { "InstanceId": "i-0987654321EXAMPLE", "InstanceType": "t2.micro", "LaunchTime": "2024-08-28T11:25:45+00:00", "AvailabilityZone": "us-east-1a", "State": { "Code": 16, "Name": "running" }, "OwnerId": "123412341234", "Tags": [ { "Key": "MyTagName", "Value": "my-tag-value" } ], "ImageMetadata": { "ImageId": "ami-0b752bf1df193a6c4", "Name": "al2023-ami-2023.5.20240819.0-kernel-6.1-x86_64", "OwnerId": "137112412989", "State": "available", "ImageOwnerAlias": "amazon", "CreationDate": "2023-01-25T17:20:40Z", "DeprecationTime": "2025-01-25T17:20:40Z", "IsPublic": true } } ] } ``` Consulte mais informações em [Imagens de máquina da Amazon no Amazon EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html) no *Manual do usuário do Amazon EC2*. **Exemplo 3: como descrever os metadados de AMI das instâncias com base em filtros** O exemplo de `describe-instance-image-metadata` a seguir descreve os metadados de AMI das instâncias `t2.nano` e `t2.micro` na zona de disponibilidade `us-east-1a`. ``` aws ec2 describe-instance-image-metadata \ --region us-east-1 \ --filters Name=availability-zone,Values=us-east-1a Name=instance-type,Values=t2.nano,t2.micro ``` Resultado: ``` { "InstanceImageMetadata": [ { "InstanceId": "i-1234567890EXAMPLE", "InstanceType": "t2.micro", "LaunchTime": "2024-08-28T11:25:45+00:00", "AvailabilityZone": "us-east-1a", "State": { "Code": 16, "Name": "running" }, "OwnerId": "123412341234", "Tags": [ { "Key": "MyTagName", "Value": "my-tag-value" } ], "ImageMetadata": { "ImageId": "ami-0b752bf1df193a6c4", "Name": "al2023-ami-2023.5.20240819.0-kernel-6.1-x86_64", "OwnerId": "137112412989", "State": "available", "ImageOwnerAlias": "amazon", "CreationDate": "2023-01-25T17:20:40Z", "DeprecationTime": "2025-01-25T17:20:40Z", "IsPublic": true } }, { "InstanceId": "i-0987654321EXAMPLE", "InstanceType": "t2.micro", "LaunchTime": "2024-08-28T11:25:45+00:00", "AvailabilityZone": "us-east-1a", "State": { "Code": 16, "Name": "running" }, "OwnerId": "123412341234", "Tags": [ { "Key": "MyTagName", "Value": "my-tag-value" } ], "ImageMetadata": { "ImageId": "ami-0b752bf1df193a6c4", "Name": "al2023-ami-2023.5.20240819.0-kernel-6.1-x86_64", "OwnerId": "137112412989", "State": "available", "ImageOwnerAlias": "amazon", "CreationDate": "2023-01-25T17:20:40Z", "DeprecationTime": "2025-01-25T17:20:40Z", "IsPublic": true } } ], "NextToken": "...EXAMPLEV7ixRYHwIAABAA2JHaFxLnDAzpatfEXAMPLE..." } ``` Consulte mais informações em [Imagens de máquina da Amazon no Amazon EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html) no *Manual do usuário do Amazon EC2*. + Consulte detalhes da API em [DescribeInstanceImageMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-instance-image-metadata.html) na *Referência de comandos da AWS CLI*. ### `describe-instance-status` O código de exemplo a seguir mostra como usar `describe-instance-status`. **AWS CLI** **Para descrever o status de uma instância** O exemplo `describe-instance-status` a seguir descreve o status atual da instância especificada. ``` aws ec2 describe-instance-status \ --instance-ids i-1234567890abcdef0 ``` Resultado: ``` { "InstanceStatuses": [ { "InstanceId": "i-1234567890abcdef0", "InstanceState": { "Code": 16, "Name": "running" }, "AvailabilityZone": "us-east-1d", "SystemStatus": { "Status": "ok", "Details": [ { "Status": "passed", "Name": "reachability" } ] }, "InstanceStatus": { "Status": "ok", "Details": [ { "Status": "passed", "Name": "reachability" } ] } } ] } ``` Para obter mais informações, consulte [Monitorar o status das instâncias](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check.html) no *Guia do usuário do Amazon EC2*. + Consulte detalhes da API em [DescribeInstanceStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-instance-status.html) na *Referência de comandos da AWS CLI*. ### `describe-instance-topology` O código de exemplo a seguir mostra como usar `describe-instance-topology`. **AWS CLI** **Descrever a topologia da instância de todas as suas instâncias** O exemplo `describe-instance-topology` a seguir descreve a topologia de todas as instâncias que correspondem aos tipos de instância compatíveis com esse comando. ``` aws ec2 describe-instance-topology \ --region us-west-2 ``` Resultado: ``` { "Instances": [ { "InstanceId": "i-1111111111example", "InstanceType": "p4d.24xlarge", "GroupName": "my-ml-cpg", "NetworkNodes": [ "nn-1111111111example", "nn-2222222222example", "nn-3333333333example" ], "ZoneId": "usw2-az2", "AvailabilityZone": "us-west-2a" }, { "InstanceId": "i-2222222222example", "InstanceType": "p4d.24xlarge", "NetworkNodes": [ "nn-1111111111example", "nn-2222222222example", "nn-3333333333example" ], "ZoneId": "usw2-az2", "AvailabilityZone": "us-west-2a" }, { "InstanceId": "i-3333333333example", "InstanceType": "trn1.32xlarge", "NetworkNodes": [ "nn-1212121212example", "nn-1211122211example", "nn-1311133311example" ], "ZoneId": "usw2-az4", "AvailabilityZone": "us-west-2d" }, { "InstanceId": "i-444444444example", "InstanceType": "trn1.2xlarge", "NetworkNodes": [ "nn-1111111111example", "nn-5434334334example", "nn-1235301234example" ], "ZoneId": "usw2-az2", "AvailabilityZone": "us-west-2a" } ], "NextToken": "SomeEncryptedToken" } ``` Para obter mais informações, incluindo mais exemplos, consulte a [Topologia de instâncias do Amazon EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-topology.html) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [DescribeInstanceTopology](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-instance-topology.html) na *Referência de comandos da AWS CLI*. ### `describe-instance-type-offerings` O código de exemplo a seguir mostra como usar `describe-instance-type-offerings`. **AWS CLI** **Exemplo 1: listar os tipos de instância oferecidos em uma região** O exemplo `describe-instance-type-offerings` a seguir lista os tipos de instância oferecidos na região configurada como a região padrão para a AWS CLI. ``` aws ec2 describe-instance-type-offerings ``` Para oferecer os tipos de instância oferecidos em uma região diferente, especifique a região usando o parâmetro `--region`. ``` aws ec2 describe-instance-type-offerings \ --region us-east-2 ``` Resultado: ``` { "InstanceTypeOfferings": [ { "InstanceType": "m5.2xlarge", "LocationType": "region", "Location": "us-east-2" }, { "InstanceType": "t3.micro", "LocationType": "region", "Location": "us-east-2" }, ... ] } ``` **Exemplo 2: listar os tipos de instância oferecidos em uma zona de disponibilidade** O exemplo `describe-instance-type-offerings` a seguir lista os tipos de instância oferecidos na Zona de Disponibilidade especificada. A Zona de Disponibilidade deve estar na região especificada. ``` aws ec2 describe-instance-type-offerings \ --location-type availability-zone \ --filters Name=location,Values=us-east-2a \ --region us-east-2 ``` **Exemplo 3: verificar se um tipo de instância é compatível** O comando `describe-instance-type-offerings` a seguir indica se o tipo de instância `c5.xlarge` é compatível com a região especificada. ``` aws ec2 describe-instance-type-offerings \ --filters Name=instance-type,Values=c5.xlarge \ --region us-east-2 ``` O exemplo `describe-instance-type-offerings` a seguir lista todos os tipos de instância C5 que são compatíveis com a região especificada. ``` aws ec2 describe-instance-type-offerings \ --filters Name=instance-type,Values=c5* \ --query "InstanceTypeOfferings[].InstanceType" \ --region us-east-2 ``` Resultado: ``` [ "c5d.12xlarge", "c5d.9xlarge", "c5n.xlarge", "c5.xlarge", "c5d.metal", "c5n.metal", "c5.large", "c5d.2xlarge", "c5n.4xlarge", "c5.2xlarge", "c5n.large", "c5n.9xlarge", "c5d.large", "c5.18xlarge", "c5d.18xlarge", "c5.12xlarge", "c5n.18xlarge", "c5.metal", "c5d.4xlarge", "c5.24xlarge", "c5d.xlarge", "c5n.2xlarge", "c5d.24xlarge", "c5.9xlarge", "c5.4xlarge" ] ``` + Para ver detalhes da API, consulte [DescribeInstanceTypeOfferings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-instance-type-offerings.html) na *Referência de comandos da AWS CLI*. ### `describe-instance-types` O código de exemplo a seguir mostra como usar `describe-instance-types`. **AWS CLI** **Exemplo 1: descrever um tipo de instância** O exemplo `describe-instance-types` a seguir exibe os detalhes do tipo da instância especificado. ``` aws ec2 describe-instance-types \ --instance-types t2.micro ``` Resultado: ``` { "InstanceTypes": [ { "InstanceType": "t2.micro", "CurrentGeneration": true, "FreeTierEligible": true, "SupportedUsageClasses": [ "on-demand", "spot" ], "SupportedRootDeviceTypes": [ "ebs" ], "BareMetal": false, "Hypervisor": "xen", "ProcessorInfo": { "SupportedArchitectures": [ "i386", "x86_64" ], "SustainedClockSpeedInGhz": 2.5 }, "VCpuInfo": { "DefaultVCpus": 1, "DefaultCores": 1, "DefaultThreadsPerCore": 1, "ValidCores": [ 1 ], "ValidThreadsPerCore": [ 1 ] }, "MemoryInfo": { "SizeInMiB": 1024 }, "InstanceStorageSupported": false, "EbsInfo": { "EbsOptimizedSupport": "unsupported", "EncryptionSupport": "supported" }, "NetworkInfo": { "NetworkPerformance": "Low to Moderate", "MaximumNetworkInterfaces": 2, "Ipv4AddressesPerInterface": 2, "Ipv6AddressesPerInterface": 2, "Ipv6Supported": true, "EnaSupport": "unsupported" }, "PlacementGroupInfo": { "SupportedStrategies": [ "partition", "spread" ] }, "HibernationSupported": false, "BurstablePerformanceSupported": true, "DedicatedHostsSupported": false, "AutoRecoverySupported": true } ] } ``` Para obter mais informações, consulte [Tipos de instância](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) no *Guia do usuário do Amazon Elastic Compute Cloud para Instâncias Linux*. **Exemplo 2: filtrar os tipos de instância disponíveis** Você pode especificar um filtro para definir o escopo dos resultados para os tipos de instância que tenham uma característica específica. O exemplo `describe-instance-types` a seguir lista os tipos de instância compatíveis com hibernação. ``` aws ec2 describe-instance-types \ --filters Name=hibernation-supported,Values=true --query 'InstanceTypes[*].InstanceType' ``` Resultado: ``` [ "m5.8xlarge", "r3.large", "c3.8xlarge", "r5.large", "m4.4xlarge", "c4.large", "m5.xlarge", "m4.xlarge", "c3.large", "c4.8xlarge", "c4.4xlarge", "c5.xlarge", "c5.12xlarge", "r5.4xlarge", "c5.4xlarge" ] ``` Para obter mais informações, consulte [Tipos de instância](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) no *Guia do usuário do Amazon Elastic Compute Cloud para Instâncias Linux*. + Consulte detalhes da API em [DescribeInstanceTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-instance-types.html) na *Referência de comandos da AWS CLI*. ### `describe-instances` O código de exemplo a seguir mostra como usar `describe-instances`. **AWS CLI** **Exemplo 1: descrever uma instância** O exemplo `describe-instances` a seguir descreve a instância especificada. ``` aws ec2 describe-instances \ --instance-ids i-1234567890abcdef0 ``` Resultado: ``` { "Reservations": [ { "Groups": [], "Instances": [ { "AmiLaunchIndex": 0, "ImageId": "ami-0abcdef1234567890", "InstanceId": "i-1234567890abcdef0", "InstanceType": "t3.nano", "KeyName": "my-key-pair", "LaunchTime": "2022-11-15T10:48:59+00:00", "Monitoring": { "State": "disabled" }, "Placement": { "AvailabilityZone": "us-east-2a", "GroupName": "", "Tenancy": "default" }, "PrivateDnsName": "ip-10-0-0-157.us-east-2.compute.internal", "PrivateIpAddress": "10-0-0-157", "ProductCodes": [], "PublicDnsName": "ec2-34-253-223-13.us-east-2.compute.amazonaws.com", "PublicIpAddress": "34.253.223.13", "State": { "Code": 16, "Name": "running" }, "StateTransitionReason": "", "SubnetId": "subnet-04a636d18e83cfacb", "VpcId": "vpc-1234567890abcdef0", "Architecture": "x86_64", "BlockDeviceMappings": [ { "DeviceName": "/dev/xvda", "Ebs": { "AttachTime": "2022-11-15T10:49:00+00:00", "DeleteOnTermination": true, "Status": "attached", "VolumeId": "vol-02e6ccdca7de29cf2" } } ], "ClientToken": "1234abcd-1234-abcd-1234-d46a8903e9bc", "EbsOptimized": true, "EnaSupport": true, "Hypervisor": "xen", "IamInstanceProfile": { "Arn": "arn:aws:iam::111111111111:instance-profile/AmazonSSMRoleForInstancesQuickSetup", "Id": "111111111111111111111" }, "NetworkInterfaces": [ { "Association": { "IpOwnerId": "amazon", "PublicDnsName": "ec2-34-253-223-13.us-east-2.compute.amazonaws.com", "PublicIp": "34.253.223.13" }, "Attachment": { "AttachTime": "2022-11-15T10:48:59+00:00", "AttachmentId": "eni-attach-1234567890abcdefg", "DeleteOnTermination": true, "DeviceIndex": 0, "Status": "attached", "NetworkCardIndex": 0 }, "Description": "", "Groups": [ { "GroupName": "launch-wizard-146", "GroupId": "sg-1234567890abcdefg" } ], "Ipv6Addresses": [], "MacAddress": "00:11:22:33:44:55", "NetworkInterfaceId": "eni-1234567890abcdefg", "OwnerId": "104024344472", "PrivateDnsName": "ip-10-0-0-157.us-east-2.compute.internal", "PrivateIpAddress": "10-0-0-157", "PrivateIpAddresses": [ { "Association": { "IpOwnerId": "amazon", "PublicDnsName": "ec2-34-253-223-13.us-east-2.compute.amazonaws.com", "PublicIp": "34.253.223.13" }, "Primary": true, "PrivateDnsName": "ip-10-0-0-157.us-east-2.compute.internal", "PrivateIpAddress": "10-0-0-157" } ], "SourceDestCheck": true, "Status": "in-use", "SubnetId": "subnet-1234567890abcdefg", "VpcId": "vpc-1234567890abcdefg", "InterfaceType": "interface" } ], "RootDeviceName": "/dev/xvda", "RootDeviceType": "ebs", "SecurityGroups": [ { "GroupName": "launch-wizard-146", "GroupId": "sg-1234567890abcdefg" } ], "SourceDestCheck": true, "Tags": [ { "Key": "Name", "Value": "my-instance" } ], "VirtualizationType": "hvm", "CpuOptions": { "CoreCount": 1, "ThreadsPerCore": 2 }, "CapacityReservationSpecification": { "CapacityReservationPreference": "open" }, "HibernationOptions": { "Configured": false }, "MetadataOptions": { "State": "applied", "HttpTokens": "optional", "HttpPutResponseHopLimit": 1, "HttpEndpoint": "enabled", "HttpProtocolIpv6": "disabled", "InstanceMetadataTags": "enabled" }, "EnclaveOptions": { "Enabled": false }, "PlatformDetails": "Linux/UNIX", "UsageOperation": "RunInstances", "UsageOperationUpdateTime": "2022-11-15T10:48:59+00:00", "PrivateDnsNameOptions": { "HostnameType": "ip-name", "EnableResourceNameDnsARecord": true, "EnableResourceNameDnsAAAARecord": false }, "MaintenanceOptions": { "AutoRecovery": "default" } } ], "OwnerId": "111111111111", "ReservationId": "r-1234567890abcdefg" } ] } ``` **Exemplo 2: para filtrar instâncias com o tipo especificado** O exemplo `describe-instances` a seguir usa filtros para definir o escopo dos resultados para instâncias do tipo especificado. ``` aws ec2 describe-instances \ --filters Name=instance-type,Values=m5.large ``` Para obter um exemplo da saída, consulte o Exemplo 1. Para obter mais informações, consulte [Listar e filtrar usando a CLI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html#Filtering_Resources_CLI) no *Guia do usuário do Amazon EC2*. **Exemplo 3: filtrar instâncias com o tipo e a zona de disponibilidade especificados** O exemplo `describe-instances` a seguir usa vários filtros para definir o escopo dos resultados para instâncias com o tipo especificado que também estão na zona de disponibilidade especificada. ``` aws ec2 describe-instances \ --filters Name=instance-type,Values=t2.micro,t3.micro Name=availability-zone,Values=us-east-2c ``` Para obter um exemplo da saída, consulte o Exemplo 1. **Exemplo 4: filtrar instâncias com o tipo e a zona de disponibilidade especificados usando um arquivo JSON** O exemplo `describe-instances` a seguir usa um arquivo de entrada JSON para realizar a mesma filtragem do exemplo anterior. Quando os filtros ficam mais complicados, pode ser mais fácil especificá-los em um arquivo JSON. ``` aws ec2 describe-instances \ --filters file://filters.json ``` Conteúdo de `filters.json`: ``` [ { "Name": "instance-type", "Values": ["t2.micro", "t3.micro"] }, { "Name": "availability-zone", "Values": ["us-east-2c"] } ] ``` Para obter um exemplo da saída, consulte o Exemplo 1. **Exemplo 5: filtrar instâncias com a tag Proprietário especificada** O exemplo `describe-instances` a seguir usa filtros de tag para definir o escopo dos resultados para instâncias que têm uma tag com a chave de tag especificada (Proprietário), independentemente do valor da tag. ``` aws ec2 describe-instances \ --filters "Name=tag-key,Values=Owner" ``` Para obter um exemplo da saída, consulte o Exemplo 1. **Exemplo 6: filtrar instâncias com o valor especificado my-team da tag** O exemplo `describe-instances` a seguir usa filtros de tag para definir o escopo dos resultados para instâncias que têm uma tag com o valor especificado da tag (my-team), independentemente da chave da tag. ``` aws ec2 describe-instances \ --filters "Name=tag-value,Values=my-team" ``` Para obter um exemplo da saída, consulte o Exemplo 1. **Exemplo 7: filtrar instâncias com a tag Proprietário e o valor my-team especificados** O exemplo `describe-instances` a seguir usa filtros de tag para definir o escopo dos resultados para instâncias que têm a tag especificada (Owner=my-team). ``` aws ec2 describe-instances \ --filters "Name=tag:Owner,Values=my-team" ``` Para obter um exemplo da saída, consulte o Exemplo 1. **Exemplo 8: exibir somente IDs de instância e sub-rede de todas as instâncias** Os exemplos `describe-instances` a seguir usam o parâmetro `--query` para exibir somente os IDs de instância e sub-rede de todas as instâncias, no formato JSON. Linux e macOS: ``` aws ec2 describe-instances \ --query 'Reservations[*].Instances[*].{Instance:InstanceId,Subnet:SubnetId}' \ --output json ``` Windows: ``` aws ec2 describe-instances ^ --query "Reservations[*].Instances[*].{Instance:InstanceId,Subnet:SubnetId}" ^ --output json ``` Resultado: ``` [ { "Instance": "i-057750d42936e468a", "Subnet": "subnet-069beee9b12030077" }, { "Instance": "i-001efd250faaa6ffa", "Subnet": "subnet-0b715c6b7db68927a" }, { "Instance": "i-027552a73f021f3bd", "Subnet": "subnet-0250c25a1f4e15235" } ... ] ``` **Exemplo 9: filtrar instâncias do tipo especificado e exibir somente os IDs de instância** O exemplo `describe-instances` a seguir usa filtros para definir o escopo dos resultados para instâncias do tipo especificado e o parâmetro `--query` para exibir somente os IDs da instância. ``` aws ec2 describe-instances \ --filters "Name=instance-type,Values=t2.micro" \ --query "Reservations[*].Instances[*].[InstanceId]" \ --output text ``` Resultado: ``` i-031c0dc19de2fb70c i-00d8bff789a736b75 i-0b715c6b7db68927a i-0626d4edd54f1286d i-00b8ae04f9f99908e i-0fc71c25d2374130c ``` **Exemplo 10: filtrar instâncias do tipo especificado e exibir somente os IDs de instância, a zona de disponibilidade e o valor especificado da tag** Os exemplos `describe-instances` a seguir exibem o ID da instância, a zona de disponibilidade e o valor da tag `Name` para instâncias que têm uma tag com o nome `tag-key`, em formato de tabela. Linux e macOS: ``` aws ec2 describe-instances \ --filters Name=tag-key,Values=Name \ --query 'Reservations[*].Instances[*].{Instance:InstanceId,AZ:Placement.AvailabilityZone,Name:Tags[?Key==`Name`]|[0].Value}' \ --output table ``` Windows: ``` aws ec2 describe-instances ^ --filters Name=tag-key,Values=Name ^ --query "Reservations[*].Instances[*].{Instance:InstanceId,AZ:Placement.AvailabilityZone,Name:Tags[?Key=='Name']|[0].Value}" ^ --output table ``` Resultado: ``` ------------------------------------------------------------- | DescribeInstances | +--------------+-----------------------+--------------------+ | AZ | Instance | Name | +--------------+-----------------------+--------------------+ | us-east-2b | i-057750d42936e468a | my-prod-server | | us-east-2a | i-001efd250faaa6ffa | test-server-1 | | us-east-2a | i-027552a73f021f3bd | test-server-2 | +--------------+-----------------------+--------------------+ ``` **Exemplo 11: descrever instâncias em um grupo com posicionamento em partições** O exemplo `describe-instances` a seguir descreve a instância especificada. A saída inclui as informações de posicionamento da instância, o que contém o nome do grupo de posicionamento e o número da partição da instância. ``` aws ec2 describe-instances \ --instance-ids i-0123a456700123456 \ --query "Reservations[*].Instances[*].Placement" ``` Resultado: ``` [ [ { "AvailabilityZone": "us-east-1c", "GroupName": "HDFS-Group-A", "PartitionNumber": 3, "Tenancy": "default" } ] ] ``` Para obter mais informações, consulte [Descrever instâncias em um grupo de posicionamento](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html#describe-instance-placement) no *Guia do usuário do Amazon EC2*. **Exemplo 12: filtrar instâncias com o grupo de posicionamento e o número de partição especificados** O exemplo `describe-instances` a seguir filtra os resultados somente para as instâncias com o grupo de posicionamento e o número de partição especificados. ``` aws ec2 describe-instances \ --filters "Name=placement-group-name,Values=HDFS-Group-A" "Name=placement-partition-number,Values=7" ``` A seguir, são mostradas somente as informações relevantes da saída. ``` "Instances": [ { "InstanceId": "i-0123a456700123456", "InstanceType": "r4.large", "Placement": { "AvailabilityZone": "us-east-1c", "GroupName": "HDFS-Group-A", "PartitionNumber": 7, "Tenancy": "default" } }, { "InstanceId": "i-9876a543210987654", "InstanceType": "r4.large", "Placement": { "AvailabilityZone": "us-east-1c", "GroupName": "HDFS-Group-A", "PartitionNumber": 7, "Tenancy": "default" } ], ``` Para obter mais informações, consulte [Descrever instâncias em um grupo de posicionamento](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html#describe-instance-placement) no *Guia do usuário do Amazon EC2*. **Exemplo 13: filtrar instâncias configuradas para permitir o acesso às tags dos metadados da instância** O exemplo `describe-instances` a seguir filtra os resultados somente para as instâncias que estão configuradas para permitir o acesso às tags de instância nos metadados da instância. ``` aws ec2 describe-instances \ --filters "Name=metadata-options.instance-metadata-tags,Values=enabled" \ --query "Reservations[*].Instances[*].InstanceId" \ --output text ``` A saída esperada é mostrada a seguir. ``` i-1234567890abcdefg i-abcdefg1234567890 i-11111111aaaaaaaaa i-aaaaaaaa111111111 ``` Para obter mais informações, consulte [Work with instance tags in instance metadata](https://docs.aws.amazon.com/en_us/AWSEC2/latest/UserGuide/Using_Tags.html#view-access-to-tags-in-IMDS) no *Guia do usuário do Amazon EC2*. + Consulte detalhes da API em [DescribeInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-instances.html) na *Referência de comandos da AWS CLI*. ### `describe-internet-gateways` O código de exemplo a seguir mostra como usar `describe-internet-gateways`. **AWS CLI** **Descrever um gateway da internet** O exemplo `describe-internet-gateways` a seguir descreve o gateway da internet especificado. ``` aws ec2 describe-internet-gateways \ --internet-gateway-ids igw-0d0fb496b3EXAMPLE ``` Resultado: ``` { "InternetGateways": [ { "Attachments": [ { "State": "available", "VpcId": "vpc-0a60eb65b4EXAMPLE" } ], "InternetGatewayId": "igw-0d0fb496b3EXAMPLE", "OwnerId": "123456789012", "Tags": [ { "Key": "Name", "Value": "my-igw" } ] } ] } ``` Para obter mais informações, consulte [Gateways da Internet](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html) no *Guia do usuário da Amazon VPC*. + Para ver detalhes da API, consulte [DescribeInternetGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-internet-gateways.html) na *Referência de comandos da AWS CLI*. ### `describe-ipam-pools` O código de exemplo a seguir mostra como usar `describe-ipam-pools`. **AWS CLI** **Visualizar os detalhes de um pool IPAM** O exemplo `describe-ipam-pools` a seguir mostra os detalhes de pools. (Linux): ``` aws ec2 describe-ipam-pools \ --filters Name=owner-id,Values=123456789012 Name=ipam-scope-id,Values=ipam-scope-02fc38cd4c48e7d38 ``` (Windows): ``` aws ec2 describe-ipam-pools ^ --filters Name=owner-id,Values=123456789012 Name=ipam-scope-id,Values=ipam-scope-02fc38cd4c48e7d38 ``` Resultado: ``` { "IpamPools": [ { "OwnerId": "123456789012", "IpamPoolId": "ipam-pool-02ec043a19bbe5d08", "IpamPoolArn": "arn:aws:ec2::123456789012:ipam-pool/ipam-pool-02ec043a19bbe5d08", "IpamScopeArn": "arn:aws:ec2::123456789012:ipam-scope/ipam-scope-02fc38cd4c48e7d38", "IpamScopeType": "private", "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-08440e7a3acde3908", "IpamRegion": "us-east-1", "Locale": "None", "PoolDepth": 1, "State": "create-complete", "AutoImport": true, "AddressFamily": "ipv4", "AllocationMinNetmaskLength": 16, "AllocationMaxNetmaskLength": 26, "AllocationDefaultNetmaskLength": 24, "AllocationResourceTags": [ { "Key": "Environment", "Value": "Preprod" } ], "Tags": [ { "Key": "Name", "Value": "Preprod pool" } ] } ] } ``` + Para ver detalhes da API, consulte [DescribeIpamPools](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-ipam-pools.html) na *Referência de comandos da AWS CLI*. ### `describe-ipam-resource-discoveries` O código de exemplo a seguir mostra como usar `describe-ipam-resource-discoveries`. **AWS CLI** **Exemplo 1: visualizar detalhes completos das descobertas de recursos** Neste exemplo, você é um administrador delegado do IPAM que deseja criar e compartilhar uma descoberta de recursos com o administrador do IPAM em outra AWS Organization para que o administrador possa gerenciar e monitorar os endereços IP dos recursos em sua organização. Esse exemplo pode ser útil se: Você tentou criar uma descoberta de recursos, mas recebeu um erro informando que atingiu o limite de 1. Você percebeu que talvez já tenha criado uma descoberta de recursos e deseja visualizá-la em sua conta. Você tem recursos em uma Região que não estão sendo descobertos pelo IPAM. Você quer ver o `--operating-regions` definido para o recurso e garantir que você tenha adicionado a região certa como uma região operacional para que os recursos lá possam ser descobertos. O exemplo `describe-ipam-resource-discoveries` a seguir lista os detalhes da descoberta de recursos em sua conta da AWS. Você pode ter uma descoberta de recursos por região da AWS. ``` aws ec2 describe-ipam-resource-discoveries \ --region us-east-1 ``` Resultado: ``` { "IpamResourceDiscoveries": [ { "OwnerId": "149977607591", "IpamResourceDiscoveryId": "ipam-res-disco-0f8bdee9067137c0d", "IpamResourceDiscoveryArn": "arn:aws:ec2::149977607591:ipam-resource-discovery/ipam-res-disco-0f8bdee9067137c0d", "IpamResourceDiscoveryRegion": "us-east-1", "OperatingRegions": [ { "RegionName": "us-east-1" } ], "IsDefault": false, "State": "create-complete", "Tags": [] } ] } ``` Para obter mais informações, consulte [Integrar o IPAM com contas fora da sua organização](https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam-outside-org.html) no *Guia do usuário do IPAM da Amazon VPC*. **Exemplo 2: visualizar somente IDs de descoberta de recursos** O exemplo `describe-ipam-resource-discoveries` a seguir lista o ID da descoberta do recurso em sua conta da AWS. Você pode ter uma descoberta de recursos por região da AWS. ``` aws ec2 describe-ipam-resource-discoveries \ --query "IpamResourceDiscoveries[*].IpamResourceDiscoveryId" \ --output text ``` Resultado: ``` ipam-res-disco-0481e39b242860333 ``` Para obter mais informações, consulte [Integrar o IPAM com contas fora da sua organização](https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam-outside-org.html) no *Guia do usuário do IPAM da Amazon VPC*. + Para ver detalhes da API, consulte [DescribeIpamResourceDiscoveries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-ipam-resource-discoveries.html) na *Referência de comandos da AWS CLI*. ### `describe-ipam-resource-discovery-associations` O código de exemplo a seguir mostra como usar `describe-ipam-resource-discovery-associations`. **AWS CLI** **Visualizar todas as associações de descoberta de recursos com seu IPAM** Neste exemplo, você é um administrador delegado do IPAM que associou descobertas de recursos ao seu IPAM para integrar outras contas ao seu IPAM. Você notou que seu IPAM não está descobrindo os recursos nas regiões operacionais da descoberta de recursos conforme o esperado. Você deseja verificar o status e o estado da descoberta de recursos para garantir que a conta que a criou ainda esteja ativa e que a descoberta de recursos ainda esteja sendo compartilhada. `--region` deve ser a região de origem do IPAM. O exemplo `describe-ipam-resource-discovery-associations` a seguir lista as associações de descoberta de recursos em sua conta da AWS. ``` aws ec2 describe-ipam-resource-discovery-associations \ --region us-east-1 ``` Resultado: ``` { "IpamResourceDiscoveryAssociations": [ { "OwnerId": "320805250157", "IpamResourceDiscoveryAssociationId": "ipam-res-disco-assoc-05e6b45eca5bf5cf7", "IpamResourceDiscoveryAssociationArn": "arn:aws:ec2::320805250157:ipam-resource-discovery-association/ipam-res-disco-assoc-05e6b45eca5bf5cf7", "IpamResourceDiscoveryId": "ipam-res-disco-0f4ef577a9f37a162", "IpamId": "ipam-005f921c17ebd5107", "IpamArn": "arn:aws:ec2::320805250157:ipam/ipam-005f921c17ebd5107", "IpamRegion": "us-east-1", "IsDefault": true, "ResourceDiscoveryStatus": "active", "State": "associate-complete", "Tags": [] }, { "OwnerId": "149977607591", "IpamResourceDiscoveryAssociationId": "ipam-res-disco-assoc-0dfd21ae189ab5f62", "IpamResourceDiscoveryAssociationArn": "arn:aws:ec2::149977607591:ipam-resource-discovery-association/ipam-res-disco-assoc-0dfd21ae189ab5f62", "IpamResourceDiscoveryId": "ipam-res-disco-0365d2977fc1672fe", "IpamId": "ipam-005f921c17ebd5107", "IpamArn": "arn:aws:ec2::149977607591:ipam/ipam-005f921c17ebd5107", "IpamRegion": "us-east-1", "IsDefault": false, "ResourceDiscoveryStatus": "active", "State": "create-complete", "Tags": [] } ] } ``` Neste exemplo, depois de executar esse comando, você percebe que tem uma descoberta de recurso não padrão (`"IsDefault": false ``) that is ``"ResourceDiscoveryStatus": "not-found"` e `"State": "create-complete"`. A conta do proprietário da descoberta de recursos foi encerrada. Se, em outro caso, você perceber que é `"ResourceDiscoveryStatus": "not-found"` e `"State": "associate-complete"`, isso indica que uma das seguintes coisas aconteceu: A descoberta do recurso foi excluída pelo proprietário da descoberta do recurso. O proprietário da descoberta do recurso cancelou o compartilhamento da descoberta do recurso. Para obter mais informações, consulte [Integrar o IPAM com contas fora da sua organização](https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam-outside-org.html) no *Guia do usuário do IPAM da Amazon VPC*. + Para ver detalhes da API, consulte [DescribeIpamResourceDiscoveryAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-ipam-resource-discovery-associations.html) na *Referência de comandos da AWS CLI*. ### `describe-ipam-scopes` O código de exemplo a seguir mostra como usar `describe-ipam-scopes`. **AWS CLI** **Visualizar os detalhes de um escopo IPAM** O exemplo `describe-ipam-scopes` a seguir mostra os detalhes dos escopos. ``` aws ec2 describe-ipam-scopes \ --filters Name=owner-id,Values=123456789012 Name=ipam-id,Values=ipam-08440e7a3acde3908 ``` Resultado: ``` { "IpamScopes": [ { "OwnerId": "123456789012", "IpamScopeId": "ipam-scope-02fc38cd4c48e7d38", "IpamScopeArn": "arn:aws:ec2::123456789012:ipam-scope/ipam-scope-02fc38cd4c48e7d38", "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-08440e7a3acde3908", "IpamRegion": "us-east-1", "IpamScopeType": "private", "IsDefault": true, "PoolCount": 2, "State": "create-complete", "Tags": [] }, { "OwnerId": "123456789012", "IpamScopeId": "ipam-scope-0b9eed026396dbc16", "IpamScopeArn": "arn:aws:ec2::123456789012:ipam-scope/ipam-scope-0b9eed026396dbc16", "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-08440e7a3acde3908", "IpamRegion": "us-east-1", "IpamScopeType": "public", "IsDefault": true, "PoolCount": 0, "State": "create-complete", "Tags": [] }, { "OwnerId": "123456789012", "IpamScopeId": "ipam-scope-0f1aff29486355c22", "IpamScopeArn": "arn:aws:ec2::123456789012:ipam-scope/ipam-scope-0f1aff29486355c22", "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-08440e7a3acde3908", "IpamRegion": "us-east-1", "IpamScopeType": "private", "IsDefault": false, "Description": "Example description", "PoolCount": 0, "State": "create-complete", "Tags": [ { "Key": "Name", "Value": "Example name value" } ] } ] } ``` + Para ver detalhes da API, consulte [DescribeIpamScopes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-ipam-scopes.html) na *Referência de comandos da AWS CLI*. ### `describe-ipams` O código de exemplo a seguir mostra como usar `describe-ipams`. **AWS CLI** **Visualizar os detalhes de um IPAM** O exemplo `describe-ipams` a seguir mostra os detalhes de um IPAM. ``` aws ec2 describe-ipams \ --filters Name=owner-id,Values=123456789012 ``` Resultado: ``` { "Ipams": [ { "OwnerId": "123456789012", "IpamId": "ipam-08440e7a3acde3908", "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-08440e7a3acde3908", "IpamRegion": "us-east-1", "PublicDefaultScopeId": "ipam-scope-0b9eed026396dbc16", "PrivateDefaultScopeId": "ipam-scope-02fc38cd4c48e7d38", "ScopeCount": 3, "OperatingRegions": [ { "RegionName": "us-east-1" }, { "RegionName": "us-east-2" }, { "RegionName": "us-west-1" } ], "State": "create-complete", "Tags": [ { "Key": "Name", "Value": "ExampleIPAM" } ] } ] } ``` + Para ver detalhes da API, consulte [DescribeIpams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-ipams.html) na *Referência de comandos da AWS CLI*. ### `describe-ipv6-pools` O código de exemplo a seguir mostra como usar `describe-ipv6-pools`. **AWS CLI** **Descrever seus pools de endereços IPv** O exemplo `describe-ipv6-pools` a seguir exibe detalhes de todos os seus pools de endereços IPv6. ``` aws ec2 describe-ipv6-pools ``` Resultado: ``` { "Ipv6Pools": [ { "PoolId": "ipv6pool-ec2-012345abc12345abc", "PoolCidrBlocks": [ { "Cidr": "2001:db8:123::/48" } ], "Tags": [ { "Key": "pool-1", "Value": "public" } ] } ] } ``` + Para ver detalhes da API, consulte [DescribeIpv6Pools](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-ipv6-pools.html) na *Referência de comandos da AWS CLI*. ### `describe-key-pairs` O código de exemplo a seguir mostra como usar `describe-key-pairs`. **AWS CLI** **Exibir um par de chaves** O exemplo `describe-key-pairs` a seguir mostra as informações do par de chaves especificado. ``` aws ec2 describe-key-pairs \ --key-names my-key-pair ``` Resultado: ``` { "KeyPairs": [ { "KeyPairId": "key-0b94643da6EXAMPLE", "KeyFingerprint": "1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f", "KeyName": "my-key-pair", "KeyType": "rsa", "Tags": [], "CreateTime": "2022-05-27T21:51:16.000Z" } ] } ``` Para obter mais informações, consulte [Descrever chaves públicas](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/describe-keys.html) no *Guia do usuário do Amazon EC2*. + Consulte detalhes da API em [DescribeKeyPairs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-key-pairs.html) na *Referência de comandos da AWS CLI*. ### `describe-launch-template-versions` O código de exemplo a seguir mostra como usar `describe-launch-template-versions`. **AWS CLI** **Descrever uma versão de modelo de lançamento** Este exemplo descreve as versões do modelo de lançamento especificado. Comando: ``` aws ec2 describe-launch-template-versions --launch-template-id lt-068f72b72934aff71 ``` Resultado: ``` { "LaunchTemplateVersions": [ { "LaunchTemplateId": "lt-068f72b72934aff71", "LaunchTemplateName": "Webservers", "VersionNumber": 3, "CreatedBy": "arn:aws:iam::123456789102:root", "LaunchTemplateData": { "KeyName": "kp-us-east", "ImageId": "ami-6057e21a", "InstanceType": "t2.small", "NetworkInterfaces": [ { "SubnetId": "subnet-7b16de0c", "DeviceIndex": 0, "Groups": [ "sg-7c227019" ] } ] }, "DefaultVersion": false, "CreateTime": "2017-11-20T13:19:54.000Z" }, { "LaunchTemplateId": "lt-068f72b72934aff71", "LaunchTemplateName": "Webservers", "VersionNumber": 2, "CreatedBy": "arn:aws:iam::123456789102:root", "LaunchTemplateData": { "KeyName": "kp-us-east", "ImageId": "ami-6057e21a", "InstanceType": "t2.medium", "NetworkInterfaces": [ { "SubnetId": "subnet-1a2b3c4d", "DeviceIndex": 0, "Groups": [ "sg-7c227019" ] } ] }, "DefaultVersion": false, "CreateTime": "2017-11-20T13:12:32.000Z" }, { "LaunchTemplateId": "lt-068f72b72934aff71", "LaunchTemplateName": "Webservers", "VersionNumber": 1, "CreatedBy": "arn:aws:iam::123456789102:root", "LaunchTemplateData": { "UserData": "", "KeyName": "kp-us-east", "ImageId": "ami-aabbcc11", "InstanceType": "t2.medium", "NetworkInterfaces": [ { "SubnetId": "subnet-7b16de0c", "DeviceIndex": 0, "DeleteOnTermination": false, "Groups": [ "sg-7c227019" ], "AssociatePublicIpAddress": true } ] }, "DefaultVersion": true, "CreateTime": "2017-11-20T12:52:33.000Z" } ] } ``` + Para ver detalhes da API, consulte [DescribeLaunchTemplateVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-launch-template-versions.html) na *Referência de comandos da AWS CLI*. ### `describe-launch-templates` O código de exemplo a seguir mostra como usar `describe-launch-templates`. **AWS CLI** **Descrever os modelos de lançamento** Este exemplo descreve os modelos de lançamento. Comando: ``` aws ec2 describe-launch-templates ``` Resultado: ``` { "LaunchTemplates": [ { "LatestVersionNumber": 2, "LaunchTemplateId": "lt-0e06d290751193123", "LaunchTemplateName": "TemplateForWebServer", "DefaultVersionNumber": 2, "CreatedBy": "arn:aws:iam::123456789012:root", "CreateTime": "2017-11-27T09:30:23.000Z" }, { "LatestVersionNumber": 6, "LaunchTemplateId": "lt-0c45b5e061ec98456", "LaunchTemplateName": "DBServersTemplate", "DefaultVersionNumber": 1, "CreatedBy": "arn:aws:iam::123456789012:root", "CreateTime": "2017-11-20T09:25:22.000Z" }, { "LatestVersionNumber": 1, "LaunchTemplateId": "lt-0d47d774e8e52dabc", "LaunchTemplateName": "MyLaunchTemplate2", "DefaultVersionNumber": 1, "CreatedBy": "arn:aws:iam::123456789012:root", "CreateTime": "2017-11-02T12:06:21.000Z" }, { "LatestVersionNumber": 3, "LaunchTemplateId": "lt-01e5f948eb4f589d6", "LaunchTemplateName": "testingtemplate2", "DefaultVersionNumber": 1, "CreatedBy": "arn:aws:sts::123456789012:assumed-role/AdminRole/i-03ee35176e2e5aabc", "CreateTime": "2017-12-01T08:19:48.000Z" }, ] } ``` + Para ver detalhes da API, consulte [DescribeLaunchTemplates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-launch-templates.html) na *Referência de comandos da AWS CLI*. ### `describe-local-gateway-route-table-virtual-interface-group-associations` O código de exemplo a seguir mostra como usar `describe-local-gateway-route-table-virtual-interface-group-associations`. **AWS CLI** **Descrever as associações entre grupos de interface virtual e tabelas de rotas de gateway local** O exemplo `describe-local-gateway-route-table-virtual-interface-group-associations` a seguir descreve as associações entre os grupos de interface virtual e as tabelas de rotas do gateway local na sua conta da AWS. ``` aws ec2 describe-local-gateway-route-table-virtual-interface-group-associations ``` Resultado: ``` { "LocalGatewayRouteTableVirtualInterfaceGroupAssociations": [ { "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId": "lgw-vif-grp-assoc-07145b276bEXAMPLE", "LocalGatewayVirtualInterfaceGroupId": "lgw-vif-grp-07145b276bEXAMPLE", "LocalGatewayId": "lgw-0ab1c23d4eEXAMPLE", "LocalGatewayRouteTableId": "lgw-rtb-059615ef7dEXAMPLE", "LocalGatewayRouteTableArn": "arn:aws:ec2:us-west-2:123456789012:local-gateway-route-table/lgw-rtb-059615ef7dEXAMPLE", "OwnerId": "123456789012", "State": "associated", "Tags": [] } ] } ``` Para obter mais informações, consulte [Trabalhar com gateways locais](https://docs.aws.amazon.com/outposts/latest/userguide/outposts-local-gateways.html) no *Guia do usuário do AWS Outposts*. + Para ver detalhes da API, consulte [DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-local-gateway-route-table-virtual-interface-group-associations.html) na *Referência de comandos da AWS CLI*. ### `describe-local-gateway-route-table-vpc-associations` O código de exemplo a seguir mostra como usar `describe-local-gateway-route-table-vpc-associations`. **AWS CLI** **Descrever as associações entre VPCs e tabelas de rotas de gateway local** O exemplo `describe-local-gateway-route-table-vpc-associations` a seguir exibe informações sobre a associação especificada entre VPCs e tabelas de rotas de gateway local. ``` aws ec2 describe-local-gateway-route-table-vpc-associations \ --local-gateway-route-table-vpc-association-ids lgw-vpc-assoc-0e0f27af15EXAMPLE ``` Resultado: ``` { "LocalGatewayRouteTableVpcAssociation": { "LocalGatewayRouteTableVpcAssociationId": "lgw-vpc-assoc-0e0f27af1EXAMPLE", "LocalGatewayRouteTableId": "lgw-rtb-059615ef7dEXAMPLE", "LocalGatewayId": "lgw-09b493aa7cEXAMPLE", "VpcId": "vpc-0efe9bde08EXAMPLE", "State": "associated" } } ``` Para ter mais informações, consulte [Tabelas de rotas do gateway local](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html) no *Guia do usuário do Outposts*. + Para ver detalhes da API, consulte [DescribeLocalGatewayRouteTableVpcAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-local-gateway-route-table-vpc-associations.html) na *Referência de comandos da AWS CLI*. ### `describe-local-gateway-route-tables` O código de exemplo a seguir mostra como usar `describe-local-gateway-route-tables`. **AWS CLI** **Descrever suas tabelas de rotas de gateway local** O exemplo `describe-local-gateway-route-tables` a seguir exibe detalhes sobre as tabelas de rotas do gateway local. ``` aws ec2 describe-local-gateway-route-tables ``` Resultado: ``` { "LocalGatewayRouteTables": [ { "LocalGatewayRouteTableId": "lgw-rtb-059615ef7deEXAMPLE", "LocalGatewayId": "lgw-09b493aa7cEXAMPLE", "OutpostArn": "arn:aws:outposts:us-west-2:111122223333:outpost/op-0dc11b66edEXAMPLE", "State": "available" } ] } ``` + Para ver detalhes da API, consulte [DescribeLocalGatewayRouteTables](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-local-gateway-route-tables.html) na *Referência de comandos da AWS CLI*. ### `describe-local-gateway-virtual-interface-groups` O código de exemplo a seguir mostra como usar `describe-local-gateway-virtual-interface-groups`. **AWS CLI** **Descrever grupos de interface virtual de gateway local** O exemplo `describe-local-gateway-virtual-interface-groups` a seguir descreve os grupos de interface virtual do gateway local em sua conta da AWS. ``` aws ec2 describe-local-gateway-virtual-interface-groups ``` Resultado: ``` { "LocalGatewayVirtualInterfaceGroups": [ { "LocalGatewayVirtualInterfaceGroupId": "lgw-vif-grp-07145b276bEXAMPLE", "LocalGatewayVirtualInterfaceIds": [ "lgw-vif-01a23bc4d5EXAMPLE", "lgw-vif-543ab21012EXAMPLE" ], "LocalGatewayId": "lgw-0ab1c23d4eEXAMPLE", "OwnerId": "123456789012", "Tags": [] } ] } ``` Para obter mais informações, consulte [Trabalhar com gateways locais](https://docs.aws.amazon.com/outposts/latest/userguide/outposts-local-gateways.html) no *Guia do usuário do AWS Outposts*. + Para ver detalhes da API, consulte [DescribeLocalGatewayVirtualInterfaceGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-local-gateway-virtual-interface-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-local-gateway-virtual-interfaces` O código de exemplo a seguir mostra como usar `describe-local-gateway-virtual-interfaces`. **AWS CLI** **Descrever interfaces virtuais de gateway local** O exemplo `describe-local-gateway-virtual-interfaces` a seguir descreve as interfaces virtuais do gateway local em sua conta da AWS. ``` aws ec2 describe-local-gateway-virtual-interfaces ``` Resultado: ``` { "LocalGatewayVirtualInterfaces": [ { "LocalGatewayVirtualInterfaceId": "lgw-vif-01a23bc4d5EXAMPLE", "LocalGatewayId": "lgw-0ab1c23d4eEXAMPLE", "Vlan": 2410, "LocalAddress": "0.0.0.0/0", "PeerAddress": "0.0.0.0/0", "LocalBgpAsn": 65010, "PeerBgpAsn": 65000, "OwnerId": "123456789012", "Tags": [] }, { "LocalGatewayVirtualInterfaceId": "lgw-vif-543ab21012EXAMPLE", "LocalGatewayId": "lgw-0ab1c23d4eEXAMPLE", "Vlan": 2410, "LocalAddress": "0.0.0.0/0", "PeerAddress": "0.0.0.0/0", "LocalBgpAsn": 65010, "PeerBgpAsn": 65000, "OwnerId": "123456789012", "Tags": [] } ] } ``` Para obter mais informações, consulte [Trabalhar com gateways locais](https://docs.aws.amazon.com/outposts/latest/userguide/outposts-local-gateways.html) no *Guia do usuário do AWS Outposts*. + Para ver detalhes da API, consulte [DescribeLocalGatewayVirtualInterfaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-local-gateway-virtual-interfaces.html) na *Referência de comandos da AWS CLI*. ### `describe-local-gateways` O código de exemplo a seguir mostra como usar `describe-local-gateways`. **AWS CLI** **Descrever seus gateways locais** O exemplo `describe-local-gateways` a seguir exibe detalhes dos gateways locais disponíveis para você. ``` aws ec2 describe-local-gateways ``` Resultado: ``` { "LocalGateways": [ { "LocalGatewayId": "lgw-09b493aa7cEXAMPLE", "OutpostArn": "arn:aws:outposts:us-west-2:123456789012:outpost/op-0dc11b66ed59f995a", "OwnerId": "123456789012", "State": "available" } ] } ``` + Para ver detalhes da API, consulte [DescribeLocalGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-local-gateways.html) na *Referência de comandos da AWS CLI*. ### `describe-locked-snapshots` O código de exemplo a seguir mostra como usar `describe-locked-snapshots`. **AWS CLI** **Descrever o status de bloqueio de um snapshot** O exemplo `describe-locked-snapshots` a seguir descreve o status de bloqueio do snapshot especificado. ``` aws ec2 describe-locked-snapshots \ --snapshot-ids snap-0b5e733b4a8df6e0d ``` Resultado: ``` { "Snapshots": [ { "OwnerId": "123456789012", "SnapshotId": "snap-0b5e733b4a8df6e0d", "LockState": "governance", "LockDuration": 365, "LockCreatedOn": "2024-05-05T00:56:06.208000+00:00", "LockDurationStartTime": "2024-05-05T00:56:06.208000+00:00", "LockExpiresOn": "2025-05-05T00:56:06.208000+00:00" } ] } ``` Para obter mais informações, consulte [Bloqueio de snapshots](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-snapshot-lock.html) no *Guia do usuário do Amazon EBS*. + Para ver detalhes da API, consulte [DescribeLockedSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-locked-snapshots.html) na *Referência de comandos da AWS CLI*. ### `describe-managed-prefix-lists` O código de exemplo a seguir mostra como usar `describe-managed-prefix-lists`. **AWS CLI** **Descrever listas de prefixos gerenciadas** O exemplo `describe-managed-prefix-lists` a seguir descreve as listas de prefixos de propriedade da conta da AWS `123456789012`. ``` aws ec2 describe-managed-prefix-lists \ --filters Name=owner-id,Values=123456789012 ``` Resultado: ``` { "PrefixLists": [ { "PrefixListId": "pl-11223344556677aab", "AddressFamily": "IPv6", "State": "create-complete", "PrefixListArn": "arn:aws:ec2:us-west-2:123456789012:prefix-list/pl-11223344556677aab", "PrefixListName": "vpc-ipv6-cidrs", "MaxEntries": 25, "Version": 1, "Tags": [], "OwnerId": "123456789012" }, { "PrefixListId": "pl-0123456abcabcabc1", "AddressFamily": "IPv4", "State": "active", "PrefixListArn": "arn:aws:ec2:us-west-2:123456789012:prefix-list/pl-0123456abcabcabc1", "PrefixListName": "vpc-cidrs", "MaxEntries": 10, "Version": 1, "Tags": [], "OwnerId": "123456789012" } ] } ``` Para obter mais informações, consulte [Listas de prefixos gerenciados](https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html) no *Guia do usuário da Amazon VPC*. + Para ver detalhes da API, consulte [DescribeManagedPrefixLists](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-managed-prefix-lists.html) na *Referência de comandos da AWS CLI*. ### `describe-moving-addresses` O código de exemplo a seguir mostra como usar `describe-moving-addresses`. **AWS CLI** **Descrever seus endereços em movimento** Este exemplo descreve todos os seus endereços IP Elastic em movimento. Comando: ``` aws ec2 describe-moving-addresses ``` Resultado: ``` { "MovingAddressStatuses": [ { "PublicIp": "198.51.100.0", "MoveStatus": "MovingToVpc" } ] } ``` Este exemplo descreve todos os endereços que estão sendo movidos para a plataforma EC2-VPC. Comando: ``` aws ec2 describe-moving-addresses --filters Name=moving-status,Values=MovingToVpc ``` + Para ver detalhes da API, consulte [DescribeMovingAddresses](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-moving-addresses.html) na *Referência de comandos da AWS CLI*. ### `describe-nat-gateways` O código de exemplo a seguir mostra como usar `describe-nat-gateways`. **AWS CLI** **Exemplo 1: descrever um gateway NAT público** O exemplo `describe-nat-gateways` a seguir descreve o gateway NAT público especificado. ``` aws ec2 describe-nat-gateways \ --nat-gateway-id nat-01234567890abcdef ``` Resultado: ``` { "NatGateways": [ { "CreateTime": "2023-08-25T01:56:51.000Z", "NatGatewayAddresses": [ { "AllocationId": "eipalloc-0790180cd2EXAMPLE", "NetworkInterfaceId": "eni-09cc4b2558794f7f9", "PrivateIp": "10.0.0.211", "PublicIp": "54.85.121.213", "AssociationId": "eipassoc-04d295cc9b8815b24", "IsPrimary": true, "Status": "succeeded" }, { "AllocationId": "eipalloc-0be6ecac95EXAMPLE", "NetworkInterfaceId": "eni-09cc4b2558794f7f9", "PrivateIp": "10.0.0.74", "PublicIp": "3.211.231.218", "AssociationId": "eipassoc-0f96bdca17EXAMPLE", "IsPrimary": false, "Status": "succeeded" } ], "NatGatewayId": "nat-01234567890abcdef", "State": "available", "SubnetId": "subnet-655eab5f08EXAMPLE", "VpcId": "vpc-098eb5ef58EXAMPLE", "Tags": [ { "Key": "Name", "Value": "public-nat" } ], "ConnectivityType": "public" } ] } ``` **Exemplo 2: descrever um gateway NAT privado** O exemplo `describe-nat-gateways` a seguir descreve o gateway NAT privado especificado. ``` aws ec2 describe-nat-gateways \ --nat-gateway-id nat-1234567890abcdef0 ``` Resultado: ``` { "NatGateways": [ { "CreateTime": "2023-08-25T00:50:05.000Z", "NatGatewayAddresses": [ { "NetworkInterfaceId": "eni-0065a61b324d1897a", "PrivateIp": "10.0.20.240", "IsPrimary": true, "Status": "succeeded" }, { "NetworkInterfaceId": "eni-0065a61b324d1897a", "PrivateIp": "10.0.20.33", "IsPrimary": false, "Status": "succeeded" }, { "NetworkInterfaceId": "eni-0065a61b324d1897a", "PrivateIp": "10.0.20.197", "IsPrimary": false, "Status": "succeeded" } ], "NatGatewayId": "nat-1234567890abcdef0", "State": "available", "SubnetId": "subnet-08fc749671EXAMPLE", "VpcId": "vpc-098eb5ef58EXAMPLE", "Tags": [ { "Key": "Name", "Value": "private-nat" } ], "ConnectivityType": "private" } ] } ``` Para obter mais informações, consulte [Gateways NAT](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) no *Guia do usuário da Amazon VPC*. + Para ver detalhes da API, consulte [DescribeNatGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-nat-gateways.html) na *Referência de comandos da AWS CLI*. ### `describe-network-acls` O código de exemplo a seguir mostra como usar `describe-network-acls`. **AWS CLI** **Descrever suas ACLs de rede** O exemplo `describe-network-acls` a seguir recupera detalhes das suas ACLs de rede. ``` aws ec2 describe-network-acls ``` Resultado: ``` { "NetworkAcls": [ { "Associations": [ { "NetworkAclAssociationId": "aclassoc-0c1679dc41EXAMPLE", "NetworkAclId": "acl-0ea1f54ca7EXAMPLE", "SubnetId": "subnet-0931fc2fa5EXAMPLE" } ], "Entries": [ { "CidrBlock": "0.0.0.0/0", "Egress": true, "Protocol": "-1", "RuleAction": "allow", "RuleNumber": 100 }, { "CidrBlock": "0.0.0.0/0", "Egress": true, "Protocol": "-1", "RuleAction": "deny", "RuleNumber": 32767 }, { "CidrBlock": "0.0.0.0/0", "Egress": false, "Protocol": "-1", "RuleAction": "allow", "RuleNumber": 100 }, { "CidrBlock": "0.0.0.0/0", "Egress": false, "Protocol": "-1", "RuleAction": "deny", "RuleNumber": 32767 } ], "IsDefault": true, "NetworkAclId": "acl-0ea1f54ca7EXAMPLE", "Tags": [], "VpcId": "vpc-06e4ab6c6cEXAMPLE", "OwnerId": "111122223333" }, { "Associations": [], "Entries": [ { "CidrBlock": "0.0.0.0/0", "Egress": true, "Protocol": "-1", "RuleAction": "allow", "RuleNumber": 100 }, { "Egress": true, "Ipv6CidrBlock": "::/0", "Protocol": "-1", "RuleAction": "allow", "RuleNumber": 101 }, { "CidrBlock": "0.0.0.0/0", "Egress": true, "Protocol": "-1", "RuleAction": "deny", "RuleNumber": 32767 }, { "Egress": true, "Ipv6CidrBlock": "::/0", "Protocol": "-1", "RuleAction": "deny", "RuleNumber": 32768 }, { "CidrBlock": "0.0.0.0/0", "Egress": false, "Protocol": "-1", "RuleAction": "allow", "RuleNumber": 100 }, { "Egress": false, "Ipv6CidrBlock": "::/0", "Protocol": "-1", "RuleAction": "allow", "RuleNumber": 101 }, { "CidrBlock": "0.0.0.0/0", "Egress": false, "Protocol": "-1", "RuleAction": "deny", "RuleNumber": 32767 }, { "Egress": false, "Ipv6CidrBlock": "::/0", "Protocol": "-1", "RuleAction": "deny", "RuleNumber": 32768 } ], "IsDefault": true, "NetworkAclId": "acl-0e2a78e4e2EXAMPLE", "Tags": [], "VpcId": "vpc-03914afb3eEXAMPLE", "OwnerId": "111122223333" } ] } ``` Para obter mais informações, consulte [ACLs da rede](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html) no *Guia do usuário da AWS VPC*. + Para ver detalhes da API, consulte [DescribeNetworkAcls](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-network-acls.html) na *Referência de comandos da AWS CLI*. ### `describe-network-insights-access-scope-analyses` O código de exemplo a seguir mostra como usar `describe-network-insights-access-scope-analyses`. **AWS CLI** **Descrever as análises do escopo de acesso do Network Insights** O exemplo `describe-network-insights-access-scope-analyses` a seguir descreve a análise do escopo de acesso em sua conta da AWS. ``` aws ec2 describe-network-insights-access-scope-analyses \ --region us-east-1 ``` Resultado: ``` { "NetworkInsightsAccessScopeAnalyses": [ { "NetworkInsightsAccessScopeAnalysisId": "nisa-123456789111", "NetworkInsightsAccessScopeAnalysisArn": "arn:aws:ec2:us-east-1:123456789012:network-insights-access-scope-analysis/nisa-123456789111", "NetworkInsightsAccessScopeId": "nis-123456789222", "Status": "succeeded", "StartDate": "2022-01-25T19:45:36.842000+00:00", "FindingsFound": "true", "Tags": [] } ] } ``` Para obter mais informações, consulte [Introdução ao Analisador de Acesso à Rede usando AWS CLI](https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/getting-started-cli-naa.html) no *Guia do Analisador de Acesso à Rede*. + Para ver detalhes da API, consulte [DescribeNetworkInsightsAccessScopeAnalyses](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-network-insights-access-scope-analyses.html) na *Referência de comandos da AWS CLI*. ### `describe-network-insights-access-scopes` O código de exemplo a seguir mostra como usar `describe-network-insights-access-scopes`. **AWS CLI** **Descrever os escopos de acesso do Network Insights** O exemplo `describe-network-insights-access-scopes` a seguir descreve as análises do escopo de acesso em sua conta da AWS. ``` aws ec2 describe-network-insights-access-scopes \ --region us-east-1 ``` Resultado: ``` { "NetworkInsightsAccessScopes": [ { "NetworkInsightsAccessScopeId": "nis-123456789111", "NetworkInsightsAccessScopeArn": "arn:aws:ec2:us-east-1:123456789012:network-insights-access-scope/nis-123456789111", "CreatedDate": "2021-11-29T21:12:41.416000+00:00", "UpdatedDate": "2021-11-29T21:12:41.416000+00:00", "Tags": [] } ] } ``` Para obter mais informações, consulte [Introdução ao Analisador de Acesso à Rede usando AWS CLI](https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/getting-started-cli-naa.html) no *Guia do Analisador de Acesso à Rede*. + Para ver detalhes da API, consulte [DescribeNetworkInsightsAccessScopes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-network-insights-access-scopes.html) na *Referência de comandos da AWS CLI*. ### `describe-network-insights-analyses` O código de exemplo a seguir mostra como usar `describe-network-insights-analyses`. **AWS CLI** **Visualizar os resultados de uma análise de caminho** O exemplo `describe-network-insights-analyses` a seguir descreve a análise especificada. Neste exemplo, a origem é um gateway da Internet, o destino é uma instância do EC2 e o protocolo é TCP. A análise foi bem-sucedida (`Status` é `succeeded`) e o caminho não é alcançável (`NetworkPathFound` é `false`). O código de explicação `ENI_SG_RULES_MISMATCH` indica que o grupo de segurança da instância não contém uma regra que permita tráfego na porta de destino. ``` aws ec2 describe-network-insights-analyses \ --network-insights-analysis-ids nia-02207aa13eb480c7a ``` Resultado: ``` { "NetworkInsightsAnalyses": [ { "NetworkInsightsAnalysisId": "nia-02207aa13eb480c7a", "NetworkInsightsAnalysisArn": "arn:aws:ec2:us-east-1:123456789012:network-insights-analysis/nia-02207aa13eb480c7a", "NetworkInsightsPathId": "nip-0b26f224f1d131fa8", "StartDate": "2021-01-20T22:58:37.495Z", "Status": "succeeded", "NetworkPathFound": false, "Explanations": [ { "Direction": "ingress", "ExplanationCode": "ENI_SG_RULES_MISMATCH", "NetworkInterface": { "Id": "eni-0a25edef15a6cc08c", "Arn": "arn:aws:ec2:us-east-1:123456789012:network-interface/eni-0a25edef15a6cc08c" }, "SecurityGroups": [ { "Id": "sg-02f0d35a850ba727f", "Arn": "arn:aws:ec2:us-east-1:123456789012:security-group/sg-02f0d35a850ba727f" } ], "Subnet": { "Id": "subnet-004ff41eccb4d1194", "Arn": "arn:aws:ec2:us-east-1:123456789012:subnet/subnet-004ff41eccb4d1194" }, "Vpc": { "Id": "vpc-f1663d98ad28331c7", "Arn": "arn:aws:ec2:us-east-1:123456789012:vpc/vpc-f1663d98ad28331c7" } } ], "Tags": [] } ] } ``` Para obter mais informações, consulte [Introdução ao uso da AWS CLI](https://docs.aws.amazon.com/vpc/latest/reachability/getting-started-cli.html) no *Guia do Reachability Analyzer*. + Para ver detalhes da API, consulte [DescribeNetworkInsightsAnalyses](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-network-insights-analyses.html) na *Referência de comandos da AWS CLI*. ### `describe-network-insights-paths` O código de exemplo a seguir mostra como usar `describe-network-insights-paths`. **AWS CLI** **Descrever um caminho** O exemplo `describe-network-insights-paths` a seguir descreve o caminho especificado. ``` aws ec2 describe-network-insights-paths \ --network-insights-path-ids nip-0b26f224f1d131fa8 ``` Resultado: ``` { "NetworkInsightsPaths": [ { "NetworkInsightsPathId": "nip-0b26f224f1d131fa8", "NetworkInsightsPathArn": "arn:aws:ec2:us-east-1:123456789012:network-insights-path/nip-0b26f224f1d131fa8", "CreatedDate": "2021-01-20T22:43:46.933Z", "Source": "igw-0797cccdc9d73b0e5", "Destination": "i-0495d385ad28331c7", "Protocol": "tcp" } ] } ``` Para obter mais informações, consulte [Introdução ao uso da AWS CLI](https://docs.aws.amazon.com/vpc/latest/reachability/getting-started-cli.html) no *Guia do Reachability Analyzer*. + Para ver detalhes da API, consulte [DescribeNetworkInsightsPaths](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-network-insights-paths.html) na *Referência de comandos da AWS CLI*. ### `describe-network-interface-attribute` O código de exemplo a seguir mostra como usar `describe-network-interface-attribute`. **AWS CLI** **Descrever o atributo de anexo de uma interface de rede** Este exemplo de comando descreve o atributo `attachment` da interface de rede especificada. Comando: ``` aws ec2 describe-network-interface-attribute --network-interface-id eni-686ea200 --attribute attachment ``` Resultado: ``` { "NetworkInterfaceId": "eni-686ea200", "Attachment": { "Status": "attached", "DeviceIndex": 0, "AttachTime": "2015-05-21T20:02:20.000Z", "InstanceId": "i-1234567890abcdef0", "DeleteOnTermination": true, "AttachmentId": "eni-attach-43348162", "InstanceOwnerId": "123456789012" } } ``` **Descrever o atributo de descrição de uma interface de rede** Este exemplo de comando descreve o atributo `description` da interface de rede especificada. Comando: ``` aws ec2 describe-network-interface-attribute --network-interface-id eni-686ea200 --attribute description ``` Resultado: ``` { "NetworkInterfaceId": "eni-686ea200", "Description": { "Value": "My description" } } ``` **Descrever o atributo groupSet de uma interface de rede** Este exemplo de comando descreve o atributo `groupSet` da interface de rede especificada. Comando: ``` aws ec2 describe-network-interface-attribute --network-interface-id eni-686ea200 --attribute groupSet ``` Resultado: ``` { "NetworkInterfaceId": "eni-686ea200", "Groups": [ { "GroupName": "my-security-group", "GroupId": "sg-903004f8" } ] } ``` **Descrever o atributo sourceDestCheck de uma interface de rede** Este exemplo de comando descreve o atributo `sourceDestCheck` da interface de rede especificada. Comando: ``` aws ec2 describe-network-interface-attribute --network-interface-id eni-686ea200 --attribute sourceDestCheck ``` Resultado: ``` { "NetworkInterfaceId": "eni-686ea200", "SourceDestCheck": { "Value": true } } ``` + Para ver detalhes da API, consulte [DescribeNetworkInterfaceAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-network-interface-attribute.html) na *Referência de comandos da AWS CLI*. ### `describe-network-interface-permissions` O código de exemplo a seguir mostra como usar `describe-network-interface-permissions`. **AWS CLI** **Descrever suas permissões de interface de rede** Este exemplo descreve todas as permissões da interface de rede. Comando: ``` aws ec2 describe-network-interface-permissions ``` Resultado: ``` { "NetworkInterfacePermissions": [ { "PermissionState": { "State": "GRANTED" }, "NetworkInterfacePermissionId": "eni-perm-06fd19020ede149ea", "NetworkInterfaceId": "eni-b909511a", "Permission": "INSTANCE-ATTACH", "AwsAccountId": "123456789012" } ] } ``` + Para ver detalhes da API, consulte [DescribeNetworkInterfacePermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-network-interface-permissions.html) na *Referência de comandos da AWS CLI*. ### `describe-network-interfaces` O código de exemplo a seguir mostra como usar `describe-network-interfaces`. **AWS CLI** **Descrever suas interfaces de rede** Este exemplo descreve todas as interfaces de rede. Comando: ``` aws ec2 describe-network-interfaces ``` Resultado: ``` { "NetworkInterfaces": [ { "Status": "in-use", "MacAddress": "02:2f:8f:b0:cf:75", "SourceDestCheck": true, "VpcId": "vpc-a01106c2", "Description": "my network interface", "Association": { "PublicIp": "203.0.113.12", "AssociationId": "eipassoc-0fbb766a", "PublicDnsName": "ec2-203-0-113-12.compute-1.amazonaws.com", "IpOwnerId": "123456789012" }, "NetworkInterfaceId": "eni-e5aa89a3", "PrivateIpAddresses": [ { "PrivateDnsName": "ip-10-0-1-17.ec2.internal", "Association": { "PublicIp": "203.0.113.12", "AssociationId": "eipassoc-0fbb766a", "PublicDnsName": "ec2-203-0-113-12.compute-1.amazonaws.com", "IpOwnerId": "123456789012" }, "Primary": true, "PrivateIpAddress": "10.0.1.17" } ], "RequesterManaged": false, "Ipv6Addresses": [], "PrivateDnsName": "ip-10-0-1-17.ec2.internal", "AvailabilityZone": "us-east-1d", "Attachment": { "Status": "attached", "DeviceIndex": 1, "AttachTime": "2013-11-30T23:36:42.000Z", "InstanceId": "i-1234567890abcdef0", "DeleteOnTermination": false, "AttachmentId": "eni-attach-66c4350a", "InstanceOwnerId": "123456789012" }, "Groups": [ { "GroupName": "default", "GroupId": "sg-8637d3e3" } ], "SubnetId": "subnet-b61f49f0", "OwnerId": "123456789012", "TagSet": [], "PrivateIpAddress": "10.0.1.17" }, { "Status": "in-use", "MacAddress": "02:58:f5:ef:4b:06", "SourceDestCheck": true, "VpcId": "vpc-a01106c2", "Description": "Primary network interface", "Association": { "PublicIp": "198.51.100.0", "IpOwnerId": "amazon" }, "NetworkInterfaceId": "eni-f9ba99bf", "PrivateIpAddresses": [ { "Association": { "PublicIp": "198.51.100.0", "IpOwnerId": "amazon" }, "Primary": true, "PrivateIpAddress": "10.0.1.149" } ], "RequesterManaged": false, "Ipv6Addresses": [], "AvailabilityZone": "us-east-1d", "Attachment": { "Status": "attached", "DeviceIndex": 0, "AttachTime": "2013-11-30T23:35:33.000Z", "InstanceId": "i-0598c7d356eba48d7", "DeleteOnTermination": true, "AttachmentId": "eni-attach-1b9db777", "InstanceOwnerId": "123456789012" }, "Groups": [ { "GroupName": "default", "GroupId": "sg-8637d3e3" } ], "SubnetId": "subnet-b61f49f0", "OwnerId": "123456789012", "TagSet": [], "PrivateIpAddress": "10.0.1.149" } ] } ``` Este exemplo descreve interfaces de rede que têm uma tag com a chave `Purpose` e o valor `Prod`. Comando: ``` aws ec2 describe-network-interfaces --filters Name=tag:Purpose,Values=Prod ``` Resultado: ``` { "NetworkInterfaces": [ { "Status": "available", "MacAddress": "12:2c:bd:f9:bf:17", "SourceDestCheck": true, "VpcId": "vpc-8941ebec", "Description": "ProdENI", "NetworkInterfaceId": "eni-b9a5ac93", "PrivateIpAddresses": [ { "PrivateDnsName": "ip-10-0-1-55.ec2.internal", "Primary": true, "PrivateIpAddress": "10.0.1.55" }, { "PrivateDnsName": "ip-10-0-1-117.ec2.internal", "Primary": false, "PrivateIpAddress": "10.0.1.117" } ], "RequesterManaged": false, "PrivateDnsName": "ip-10-0-1-55.ec2.internal", "AvailabilityZone": "us-east-1d", "Ipv6Addresses": [], "Groups": [ { "GroupName": "MySG", "GroupId": "sg-905002f5" } ], "SubnetId": "subnet-31d6c219", "OwnerId": "123456789012", "TagSet": [ { "Value": "Prod", "Key": "Purpose" } ], "PrivateIpAddress": "10.0.1.55" } ] } ``` + Para ver detalhes da API, consulte [DescribeNetworkInterfaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-network-interfaces.html) na *Referência de comandos da AWS CLI*. ### `describe-placement-groups` O código de exemplo a seguir mostra como usar `describe-placement-groups`. **AWS CLI** **Descrever todos os seus grupos de posicionamento** Este exemplo de comando descreve todos os grupos de posicionamento. Comando: ``` aws ec2 describe-placement-groups ``` Resultado: ``` { "PlacementGroups": [ { "GroupName": "my-cluster", "State": "available", "Strategy": "cluster" }, ... ] } ``` + Para ver detalhes da API, consulte [DescribePlacementGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-placement-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-prefix-lists` O código de exemplo a seguir mostra como usar `describe-prefix-lists`. **AWS CLI** **Descrever listas de prefixo** Este exemplo lista todas as listas de prefixos disponíveis para a região. Comando: ``` aws ec2 describe-prefix-lists ``` Resultado: ``` { "PrefixLists": [ { "PrefixListName": "com.amazonaws.us-east-1.s3", "Cidrs": [ "54.231.0.0/17" ], "PrefixListId": "pl-63a5400a" } ] } ``` + Para ver detalhes da API, consulte [DescribePrefixLists](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-prefix-lists.html) na *Referência de comandos da AWS CLI*. ### `describe-principal-id-format` O código de exemplo a seguir mostra como usar `describe-principal-id-format`. **AWS CLI** **Descrever o formato de ID para usuários e perfis do IAM com o formato de ID longo ativado** O exemplo `describe-principal-id-format` a seguir descreve o formato de ID para o usuário-raiz, todos os perfis do IAM e todos os usuários do IAM com o formato de ID longo ativado. ``` aws ec2 describe-principal-id-format \ --resource instance ``` Resultado: ``` { "Principals": [ { "Arn": "arn:aws:iam::123456789012:root", "Statuses": [ { "Deadline": "2016-12-15T00:00:00.000Z", "Resource": "reservation", "UseLongIds": true }, { "Deadline": "2016-12-15T00:00:00.000Z", "Resource": "instance", "UseLongIds": true }, { "Deadline": "2016-12-15T00:00:00.000Z", "Resource": "volume", "UseLongIds": true }, ] }, ... ] } ``` + Para ver detalhes da API, consulte [DescribePrincipalIdFormat](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-principal-id-format.html) na *Referência de comandos da AWS CLI*. ### `describe-public-ipv4-pools` O código de exemplo a seguir mostra como usar `describe-public-ipv4-pools`. **AWS CLI** **Descrever seus pools de endereços IPv4 públicos** O exemplo `describe-public-ipv4-pools` a seguir exibe detalhes sobre os grupos de endereços que foram criados quando você provisionou intervalos de endereços IPv4 públicos usando o Traga Seu Próprio Endereço IP (Bring Your Own IP Addresses, BYOIP). ``` aws ec2 describe-public-ipv4-pools ``` Resultado: ``` { "PublicIpv4Pools": [ { "PoolId": "ipv4pool-ec2-1234567890abcdef0", "PoolAddressRanges": [ { "FirstAddress": "203.0.113.0", "LastAddress": "203.0.113.255", "AddressCount": 256, "AvailableAddressCount": 256 } ], "TotalAddressCount": 256, "TotalAvailableAddressCount": 256 } ] } ``` + Para ver detalhes da API, consulte [DescribePublicIpv4Pools](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-public-ipv4-pools.html) na *Referência de comandos da AWS CLI*. ### `describe-regions` O código de exemplo a seguir mostra como usar `describe-regions`. **AWS CLI** **Exemplo 1: descrever todas as suas regiões habilitadas** O exemplo `describe-regions` a seguir descreve todas as regiões habilitadas para a sua conta. ``` aws ec2 describe-regions ``` Resultado: ``` { "Regions": [ { "Endpoint": "ec2.eu-north-1.amazonaws.com", "RegionName": "eu-north-1", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.ap-south-1.amazonaws.com", "RegionName": "ap-south-1", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.eu-west-3.amazonaws.com", "RegionName": "eu-west-3", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.eu-west-2.amazonaws.com", "RegionName": "eu-west-2", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.eu-west-1.amazonaws.com", "RegionName": "eu-west-1", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.ap-northeast-3.amazonaws.com", "RegionName": "ap-northeast-3", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.ap-northeast-2.amazonaws.com", "RegionName": "ap-northeast-2", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.ap-northeast-1.amazonaws.com", "RegionName": "ap-northeast-1", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.sa-east-1.amazonaws.com", "RegionName": "sa-east-1", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.ca-central-1.amazonaws.com", "RegionName": "ca-central-1", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.ap-southeast-1.amazonaws.com", "RegionName": "ap-southeast-1", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.ap-southeast-2.amazonaws.com", "RegionName": "ap-southeast-2", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.eu-central-1.amazonaws.com", "RegionName": "eu-central-1", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.us-east-1.amazonaws.com", "RegionName": "us-east-1", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.us-east-2.amazonaws.com", "RegionName": "us-east-2", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.us-west-1.amazonaws.com", "RegionName": "us-west-1", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.us-west-2.amazonaws.com", "RegionName": "us-west-2", "OptInStatus": "opt-in-not-required" } ] } ``` Para obter mais informações, consulte [Regiões e zonas](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html) no *Guia do usuário do Amazon EC2*. **Exemplo 2: para descrever as regiões habilitadas com um endpoint cujo nome contém uma string específica** O exemplo `describe-regions` a seguir descreve todas as regiões que você habilitou e que têm a string “us” no endpoint. ``` aws ec2 describe-regions \ --filters "Name=endpoint,Values=*us*" ``` Resultado: ``` { "Regions": [ { "Endpoint": "ec2.us-east-1.amazonaws.com", "RegionName": "us-east-1" }, { "Endpoint": "ec2.us-east-2.amazonaws.com", "RegionName": "us-east-2" }, { "Endpoint": "ec2.us-west-1.amazonaws.com", "RegionName": "us-west-1" }, { "Endpoint": "ec2.us-west-2.amazonaws.com", "RegionName": "us-west-2" } ] } ``` Para obter mais informações, consulte [Regiões e zonas](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html) no *Guia do usuário do Amazon EC2*. **Exemplo 3: descrever todas as regiões** O exemplo `describe-regions` a seguir descreve todas as regiões disponíveis, incluindo as que estão desabilitadas. ``` aws ec2 describe-regions \ --all-regions ``` Resultado: ``` { "Regions": [ { "Endpoint": "ec2.eu-north-1.amazonaws.com", "RegionName": "eu-north-1", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.ap-south-1.amazonaws.com", "RegionName": "ap-south-1", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.eu-west-3.amazonaws.com", "RegionName": "eu-west-3", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.eu-west-2.amazonaws.com", "RegionName": "eu-west-2", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.eu-west-1.amazonaws.com", "RegionName": "eu-west-1", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.ap-northeast-3.amazonaws.com", "RegionName": "ap-northeast-3", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.me-south-1.amazonaws.com", "RegionName": "me-south-1", "OptInStatus": "not-opted-in" }, { "Endpoint": "ec2.ap-northeast-2.amazonaws.com", "RegionName": "ap-northeast-2", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.ap-northeast-1.amazonaws.com", "RegionName": "ap-northeast-1", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.sa-east-1.amazonaws.com", "RegionName": "sa-east-1", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.ca-central-1.amazonaws.com", "RegionName": "ca-central-1", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.ap-east-1.amazonaws.com", "RegionName": "ap-east-1", "OptInStatus": "not-opted-in" }, { "Endpoint": "ec2.ap-southeast-1.amazonaws.com", "RegionName": "ap-southeast-1", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.ap-southeast-2.amazonaws.com", "RegionName": "ap-southeast-2", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.eu-central-1.amazonaws.com", "RegionName": "eu-central-1", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.us-east-1.amazonaws.com", "RegionName": "us-east-1", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.us-east-2.amazonaws.com", "RegionName": "us-east-2", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.us-west-1.amazonaws.com", "RegionName": "us-west-1", "OptInStatus": "opt-in-not-required" }, { "Endpoint": "ec2.us-west-2.amazonaws.com", "RegionName": "us-west-2", "OptInStatus": "opt-in-not-required" } ] } ``` Para obter mais informações, consulte [Regiões e zonas](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html) no *Guia do usuário do Amazon EC2*. **Exemplo 4: listar somente os nomes das regiões** O exemplo `describe-regions` a seguir usa o parâmetro `--query` para filtrar a saída e retornar somente os nomes das regiões como texto. ``` aws ec2 describe-regions \ --all-regions \ --query "Regions[].{Name:RegionName}" \ --output text ``` Resultado: ``` eu-north-1 ap-south-1 eu-west-3 eu-west-2 eu-west-1 ap-northeast-3 ap-northeast-2 me-south-1 ap-northeast-1 sa-east-1 ca-central-1 ap-east-1 ap-southeast-1 ap-southeast-2 eu-central-1 us-east-1 us-east-2 us-west-1 us-west-2 ``` Para obter mais informações, consulte [Regiões e zonas](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html) no *Guia do usuário do Amazon EC2*. + Consulte detalhes da API em [DescribeRegions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-regions.html) na *Referência de comandos da AWS CLI*. ### `describe-replace-root-volume-tasks` O código de exemplo a seguir mostra como usar `describe-replace-root-volume-tasks`. **AWS CLI** **Exemplo 1: visualizar informações sobre uma tarefa específica de substituição do volume raiz** O exemplo `describe-replace-root-volume-tasks` a seguir descreve a tarefa de substituição do volume raiz replacevol-0111122223333abcd. ``` aws ec2 describe-replace-root-volume-tasks \ --replace-root-volume-task-ids replacevol-0111122223333abcd ``` Resultado: ``` { "ReplaceRootVolumeTasks": [ { "ReplaceRootVolumeTaskId": "replacevol-0111122223333abcd", "Tags": [], "InstanceId": "i-0123456789abcdefa", "TaskState": "succeeded", "StartTime": "2022-03-14T15:16:28Z", "CompleteTime": "2022-03-14T15:16:52Z" } ] } ``` Para obter mais informações, consulte [Substituir um volume raiz](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-restoring-volume.html#replace-root) no *Guia do usuário do Amazon Elastic Compute Cloud*. **Exemplo 2: visualizar informações sobre todas as tarefas de substituição do volume raiz de uma instância específica** O exemplo `describe-replace-root-volume-tasks` a seguir descreve todas as tarefas de substituição do volume raiz para a instância i-0123456789abcdefa. ``` aws ec2 describe-replace-root-volume-tasks \ --filters Name=instance-id,Values=i-0123456789abcdefa ``` Resultado: ``` { "ReplaceRootVolumeTasks": [ { "ReplaceRootVolumeTaskId": "replacevol-0111122223333abcd", "Tags": [], "InstanceId": "i-0123456789abcdefa", "TaskState": "succeeded", "StartTime": "2022-03-14T15:06:38Z", "CompleteTime": "2022-03-14T15:07:03Z" }, { "ReplaceRootVolumeTaskId": "replacevol-0444455555555abcd", "Tags": [], "InstanceId": "i-0123456789abcdefa", "TaskState": "succeeded", "StartTime": "2022-03-14T15:16:28Z", "CompleteTime": "2022-03-14T15:16:52Z" } ] } ``` Para obter mais informações, consulte [Substituir um volume raiz](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-restoring-volume.html#replace-root) no *Guia do usuário do Amazon Elastic Compute Cloud*. + Para ver detalhes da API, consulte [DescribeReplaceRootVolumeTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-replace-root-volume-tasks.html) na *Referência de comandos da AWS CLI*. ### `describe-reserved-instances-listings` O código de exemplo a seguir mostra como usar `describe-reserved-instances-listings`. **AWS CLI** **Descrever uma lista de instâncias reservadas** O exemplo `describe-reserved-instances-listings` a seguir retorna informações sobre a Instância Reservada especificada. ``` aws ec2 describe-reserved-instances-listings \ --reserved-instances-listing-id 5ec28771-05ff-4b9b-aa31-9e57dexample ``` Este comando não produz saída. + Para ver detalhes da API, consulte [DescribeReservedInstancesListings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-reserved-instances-listings.html) na *Referência de comandos da AWS CLI*. ### `describe-reserved-instances-modifications` O código de exemplo a seguir mostra como usar `describe-reserved-instances-modifications`. **AWS CLI** **Descrever modificações de Instâncias Reservadas** Este exemplo de comando descreve todas as solicitações de modificação de Instâncias Reservadas que foram enviadas para sua conta. Comando: ``` aws ec2 describe-reserved-instances-modifications ``` Resultado: ``` { "ReservedInstancesModifications": [ { "Status": "fulfilled", "ModificationResults": [ { "ReservedInstancesId": "93bbbca2-62f1-4d9d-b225-16bada29e6c7", "TargetConfiguration": { "AvailabilityZone": "us-east-1b", "InstanceType": "m1.large", "InstanceCount": 3 } }, { "ReservedInstancesId": "1ba8e2e3-aabb-46c3-bcf5-3fe2fda922e6", "TargetConfiguration": { "AvailabilityZone": "us-east-1d", "InstanceType": "m1.xlarge", "InstanceCount": 1 } } ], "EffectiveDate": "2015-08-12T17:00:00.000Z", "CreateDate": "2015-08-12T17:52:52.630Z", "UpdateDate": "2015-08-12T18:08:06.698Z", "ClientToken": "c9adb218-3222-4889-8216-0cf0e52dc37e: "ReservedInstancesModificationId": "rimod-d3ed4335-b1d3-4de6-ab31-0f13aaf46687", "ReservedInstancesIds": [ { "ReservedInstancesId": "b847fa93-e282-4f55-b59a-1342f5bd7c02" } ] } ] } ``` + Para ver detalhes da API, consulte [DescribeReservedInstancesModifications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-reserved-instances-modifications.html) na *Referência de comandos da AWS CLI*. ### `describe-reserved-instances-offerings` O código de exemplo a seguir mostra como usar `describe-reserved-instances-offerings`. **AWS CLI** **Descrever ofertas de Instâncias Reservadas** Este exemplo de comando descreve todas as instâncias reservadas disponíveis para compra na região. Comando: ``` aws ec2 describe-reserved-instances-offerings ``` Resultado: ``` { "ReservedInstancesOfferings": [ { "OfferingType": "Partial Upfront", "AvailabilityZone": "us-east-1b", "InstanceTenancy": "default", "PricingDetails": [], "ProductDescription": "Red Hat Enterprise Linux", "UsagePrice": 0.0, "RecurringCharges": [ { "Amount": 0.088, "Frequency": "Hourly" } ], "Marketplace": false, "CurrencyCode": "USD", "FixedPrice": 631.0, "Duration": 94608000, "ReservedInstancesOfferingId": "9a06095a-bdc6-47fe-a94a-2a382f016040", "InstanceType": "c1.medium" }, { "OfferingType": "PartialUpfront", "AvailabilityZone": "us-east-1b", "InstanceTenancy": "default", "PricingDetails": [], "ProductDescription": "Linux/UNIX", "UsagePrice": 0.0, "RecurringCharges": [ { "Amount": 0.028, "Frequency": "Hourly" } ], "Marketplace": false, "CurrencyCode": "USD", "FixedPrice": 631.0, "Duration": 94608000, "ReservedInstancesOfferingId": "bfbefc6c-0d10-418d-b144-7258578d329d", "InstanceType": "c1.medium" }, ... } ``` **Descrever suas ofertas de instâncias reservadas usando opções** Este exemplo lista as instâncias reservadas oferecidas pela AWS com as seguintes especificações: tipos de instância t1.micro, produtos Windows (Amazon VPC) e ofertas de Utilização Pesada. Comando: ``` aws ec2 describe-reserved-instances-offerings --no-include-marketplace --instance-type "t1.micro" --product-description "Windows (Amazon VPC)" --offering-type "no upfront" ``` Resultado: ``` { "ReservedInstancesOfferings": [ { "OfferingType": "No Upfront", "AvailabilityZone": "us-east-1b", "InstanceTenancy": "default", "PricingDetails": [], "ProductDescription": "Windows", "UsagePrice": 0.0, "RecurringCharges": [ { "Amount": 0.015, "Frequency": "Hourly" } ], "Marketplace": false, "CurrencyCode": "USD", "FixedPrice": 0.0, "Duration": 31536000, "ReservedInstancesOfferingId": "c48ab04c-fe69-4f94-8e39-a23842292823", "InstanceType": "t1.micro" }, ... { "OfferingType": "No Upfront", "AvailabilityZone": "us-east-1d", "InstanceTenancy": "default", "PricingDetails": [], "ProductDescription": "Windows (Amazon VPC)", "UsagePrice": 0.0, "RecurringCharges": [ { "Amount": 0.015, "Frequency": "Hourly" } ], "Marketplace": false, "CurrencyCode": "USD", "FixedPrice": 0.0, "Duration": 31536000, "ReservedInstancesOfferingId": "3a98bf7d-2123-42d4-b4f5-8dbec4b06dc6", "InstanceType": "t1.micro" } ] } ``` + Para ver detalhes da API, consulte [DescribeReservedInstancesOfferings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-reserved-instances-offerings.html) na *Referência de comandos da AWS CLI*. ### `describe-reserved-instances` O código de exemplo a seguir mostra como usar `describe-reserved-instances`. **AWS CLI** **Descrever suas instâncias reservadas** Este exemplo de comando descreve as instâncias reservadas que você possui. Comando: ``` aws ec2 describe-reserved-instances ``` Resultado: ``` { "ReservedInstances": [ { "ReservedInstancesId": "b847fa93-e282-4f55-b59a-1342fexample", "OfferingType": "No Upfront", "AvailabilityZone": "us-west-1c", "End": "2016-08-14T21:34:34.000Z", "ProductDescription": "Linux/UNIX", "UsagePrice": 0.00, "RecurringCharges": [ { "Amount": 0.104, "Frequency": "Hourly" } ], "Start": "2015-08-15T21:34:35.086Z", "State": "active", "FixedPrice": 0.0, "CurrencyCode": "USD", "Duration": 31536000, "InstanceTenancy": "default", "InstanceType": "m3.medium", "InstanceCount": 2 }, ... ] } ``` **Descrever suas instâncias reservadas usando filtros** Este exemplo filtra a resposta para incluir somente instâncias reservadas t2.micro Linux/UNIX de três anos em us-west-1c. Comando: ``` aws ec2 describe-reserved-instances --filters Name=duration,Values=94608000 Name=instance-type,Values=t2.micro Name=product-description,Values=Linux/UNIX Name=availability-zone,Values=us-east-1e ``` Resultado: ``` { "ReservedInstances": [ { "ReservedInstancesId": "f127bd27-edb7-44c9-a0eb-0d7e09259af0", "OfferingType": "All Upfront", "AvailabilityZone": "us-east-1e", "End": "2018-03-26T21:34:34.000Z", "ProductDescription": "Linux/UNIX", "UsagePrice": 0.00, "RecurringCharges": [], "Start": "2015-03-27T21:34:35.848Z", "State": "active", "FixedPrice": 151.0, "CurrencyCode": "USD", "Duration": 94608000, "InstanceTenancy": "default", "InstanceType": "t2.micro", "InstanceCount": 1 } ] } ``` Para obter mais informações, consulte Using Amazon EC2 Instances no *Guia do usuário da AWS Command Line Interface*. + Para ver detalhes da API, consulte [DescribeReservedInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-reserved-instances.html) na *Referência de comandos da AWS CLI*. ### `describe-route-tables` O código de exemplo a seguir mostra como usar `describe-route-tables`. **AWS CLI** **Descrever suas tabelas de rotas** O exemplo `describe-route-tables` a seguir recupera detalhes das tabelas de rotas ``` aws ec2 describe-route-tables ``` Resultado: ``` { "RouteTables": [ { "Associations": [ { "Main": true, "RouteTableAssociationId": "rtbassoc-0df3f54e06EXAMPLE", "RouteTableId": "rtb-09ba434c1bEXAMPLE" } ], "PropagatingVgws": [], "RouteTableId": "rtb-09ba434c1bEXAMPLE", "Routes": [ { "DestinationCidrBlock": "10.0.0.0/16", "GatewayId": "local", "Origin": "CreateRouteTable", "State": "active" }, { "DestinationCidrBlock": "0.0.0.0/0", "NatGatewayId": "nat-06c018cbd8EXAMPLE", "Origin": "CreateRoute", "State": "blackhole" } ], "Tags": [], "VpcId": "vpc-0065acced4EXAMPLE", "OwnerId": "111122223333" }, { "Associations": [ { "Main": true, "RouteTableAssociationId": "rtbassoc-9EXAMPLE", "RouteTableId": "rtb-a1eec7de" } ], "PropagatingVgws": [], "RouteTableId": "rtb-a1eec7de", "Routes": [ { "DestinationCidrBlock": "172.31.0.0/16", "GatewayId": "local", "Origin": "CreateRouteTable", "State": "active" }, { "DestinationCidrBlock": "0.0.0.0/0", "GatewayId": "igw-fEXAMPLE", "Origin": "CreateRoute", "State": "active" } ], "Tags": [], "VpcId": "vpc-3EXAMPLE", "OwnerId": "111122223333" }, { "Associations": [ { "Main": false, "RouteTableAssociationId": "rtbassoc-0b100c28b2EXAMPLE", "RouteTableId": "rtb-07a98f76e5EXAMPLE", "SubnetId": "subnet-0d3d002af8EXAMPLE" } ], "PropagatingVgws": [], "RouteTableId": "rtb-07a98f76e5EXAMPLE", "Routes": [ { "DestinationCidrBlock": "10.0.0.0/16", "GatewayId": "local", "Origin": "CreateRouteTable", "State": "active" }, { "DestinationCidrBlock": "0.0.0.0/0", "GatewayId": "igw-06cf664d80EXAMPLE", "Origin": "CreateRoute", "State": "active" } ], "Tags": [], "VpcId": "vpc-0065acced4EXAMPLE", "OwnerId": "111122223333" } ] } ``` Para obter mais informações, consulte [Trabalhar com tabelas de rotas](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html#WorkWithRouteTables) no *Guia do usuário da AWS VPC*. + Para ver detalhes da API, consulte [DescribeRouteTables](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-route-tables.html) na *Referência de comandos da AWS CLI*. ### `describe-scheduled-instance-availability` O código de exemplo a seguir mostra como usar `describe-scheduled-instance-availability`. **AWS CLI** **Descrever um cronograma disponível** Este exemplo descreve uma programação que ocorre toda semana no domingo, começando na data especificada. Comando: ``` aws ec2 describe-scheduled-instance-availability --recurrence Frequency=Weekly,Interval=1,OccurrenceDays=[1] --first-slot-start-time-range EarliestTime=2016-01-31T00:00:00Z,LatestTime=2016-01-31T04:00:00Z ``` Resultado: ``` { "ScheduledInstanceAvailabilitySet": [ { "AvailabilityZone": "us-west-2b", "TotalScheduledInstanceHours": 1219, "PurchaseToken": "eyJ2IjoiMSIsInMiOjEsImMiOi...", "MinTermDurationInDays": 366, "AvailableInstanceCount": 20, "Recurrence": { "OccurrenceDaySet": [ 1 ], "Interval": 1, "Frequency": "Weekly", "OccurrenceRelativeToEnd": false }, "Platform": "Linux/UNIX", "FirstSlotStartTime": "2016-01-31T00:00:00Z", "MaxTermDurationInDays": 366, "SlotDurationInHours": 23, "NetworkPlatform": "EC2-VPC", "InstanceType": "c4.large", "HourlyPrice": "0.095" }, ... ] } ``` Para restringir os resultados, você pode adicionar filtros que especificam o sistema operacional, a rede e o tipo de instância. Comando: --filters Name=platform,Values=Linux/UNIX Name=network-platform,Values=EC2-VPC Name=instance-type,Values=c4.large + Para ver detalhes da API, consulte [DescribeScheduledInstanceAvailability](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-scheduled-instance-availability.html) na *Referência de comandos da AWS CLI*. ### `describe-scheduled-instances` O código de exemplo a seguir mostra como usar `describe-scheduled-instances`. **AWS CLI** **Descrever suas instâncias agendadas** Este exemplo descreve a Instância Agendada especificada. Comando: ``` aws ec2 describe-scheduled-instances --scheduled-instance-ids sci-1234-1234-1234-1234-123456789012 ``` Resultado: ``` { "ScheduledInstanceSet": [ { "AvailabilityZone": "us-west-2b", "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012", "HourlyPrice": "0.095", "CreateDate": "2016-01-25T21:43:38.612Z", "Recurrence": { "OccurrenceDaySet": [ 1 ], "Interval": 1, "Frequency": "Weekly", "OccurrenceRelativeToEnd": false, "OccurrenceUnit": "" }, "Platform": "Linux/UNIX", "TermEndDate": "2017-01-31T09:00:00Z", "InstanceCount": 1, "SlotDurationInHours": 32, "TermStartDate": "2016-01-31T09:00:00Z", "NetworkPlatform": "EC2-VPC", "TotalScheduledInstanceHours": 1696, "NextSlotStartTime": "2016-01-31T09:00:00Z", "InstanceType": "c4.large" } ] } ``` Este exemplo descreve todas as suas instâncias agendadas. Comando: ``` aws ec2 describe-scheduled-instances ``` + Para ver detalhes da API, consulte [DescribeScheduledInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-scheduled-instances.html) na *Referência de comandos da AWS CLI*. ### `describe-security-group-references` O código de exemplo a seguir mostra como usar `describe-security-group-references`. **AWS CLI** **Descrever as referências do grupo de segurança** Este exemplo descreve as referências do grupo de segurança para `sg-bbbb2222`. A resposta indica que o grupo de segurança `sg-bbbb2222` está sendo referenciado por um grupo de segurança na VPC `vpc-aaaaaaaa`: Comando: ``` aws ec2 describe-security-group-references --group-id sg-bbbbb22222 ``` Resultado: ``` { "SecurityGroupsReferenceSet": [ { "ReferencingVpcId": "vpc-aaaaaaaa ", "GroupId": "sg-bbbbb22222", "VpcPeeringConnectionId": "pcx-b04deed9" } ] } ``` + Para ver detalhes da API, consulte [DescribeSecurityGroupReferences](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-security-group-references.html) na *Referência de comandos da AWS CLI*. ### `describe-security-group-rules` O código de exemplo a seguir mostra como usar `describe-security-group-rules`. **AWS CLI** **Exemplo 1: descrever as regras de grupo de segurança para um grupo de segurança** O exemplo `describe-security-group-rules` a seguir descreve as regras do grupo de segurança de um grupo de segurança especificado. Use a opção `filters` para definir o escopo dos resultados para um grupo de segurança específico. ``` aws ec2 describe-security-group-rules \ --filters Name="group-id",Values="sg-1234567890abcdef0" ``` Resultado: ``` { "SecurityGroupRules": [ { "SecurityGroupRuleId": "sgr-abcdef01234567890", "GroupId": "sg-1234567890abcdef0", "GroupOwnerId": "111122223333", "IsEgress": false, "IpProtocol": "-1", "FromPort": -1, "ToPort": -1, "ReferencedGroupInfo": { "GroupId": "sg-1234567890abcdef0", "UserId": "111122223333" }, "Tags": [] }, { "SecurityGroupRuleId": "sgr-bcdef01234567890a", "GroupId": "sg-1234567890abcdef0", "GroupOwnerId": "111122223333", "IsEgress": true, "IpProtocol": "-1", "FromPort": -1, "ToPort": -1, "CidrIpv6": "::/0", "Tags": [] }, { "SecurityGroupRuleId": "sgr-cdef01234567890ab", "GroupId": "sg-1234567890abcdef0", "GroupOwnerId": "111122223333", "IsEgress": true, "IpProtocol": "-1", "FromPort": -1, "ToPort": -1, "CidrIpv4": "0.0.0.0/0", "Tags": [] } ] } ``` **Exemplo 2: descrever uma regra do grupo de segurança** O exemplo `describe-security-group-rules` a seguir descreve a regra do grupo de segurança especificado. ``` aws ec2 describe-security-group-rules \ --security-group-rule-ids sgr-cdef01234567890ab ``` Resultado: ``` { "SecurityGroupRules": [ { "SecurityGroupRuleId": "sgr-cdef01234567890ab", "GroupId": "sg-1234567890abcdef0", "GroupOwnerId": "111122223333", "IsEgress": true, "IpProtocol": "-1", "FromPort": -1, "ToPort": -1, "CidrIpv4": "0.0.0.0/0", "Tags": [] } ] } ``` Para ter mais informações, consulte [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html) no *Guia do usuário da Amazon VPC*. + Para ver detalhes da API, consulte [DescribeSecurityGroupRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-security-group-rules.html) na *Referência de comandos da AWS CLI*. ### `describe-security-group-vpc-associations` O código de exemplo a seguir mostra como usar `describe-security-group-vpc-associations`. **AWS CLI** **Como descrever associações de VPC** O exemplo `describe-security-group-vpc-associations` a seguir descreve as associações de VPC do grupo de segurança especificado. ``` aws ec2 describe-security-group-vpc-associations \ --filters Name=group-id,Values=sg-04dbb43907d3f8a78 ``` Resultado: ``` { "SecurityGroupVpcAssociations": [ { "GroupId": "sg-04dbb43907d3f8a78", "VpcId": "vpc-0bf4c2739bc05a694", "VpcOwnerId": "123456789012", "State": "associated" } ] } ``` Consulte mais informações em [Associate security groups with multiple VPCs](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-assoc.html) no *Guia do usuário da Amazon VPC*. + Consulte detalhes da API em [DescribeSecurityGroupVpcAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-security-group-vpc-associations.html) na *Referência de comandos da AWS CLI*. ### `describe-security-groups` O código de exemplo a seguir mostra como usar `describe-security-groups`. **AWS CLI** **Exemplo 1: descrever um grupo de segurança** O exemplo `describe-security-groups` a seguir descreve o grupo de segurança especificado. ``` aws ec2 describe-security-groups \ --group-ids sg-903004f8 ``` Resultado: ``` { "SecurityGroups": [ { "IpPermissionsEgress": [ { "IpProtocol": "-1", "IpRanges": [ { "CidrIp": "0.0.0.0/0" } ], "UserIdGroupPairs": [], "PrefixListIds": [] } ], "Description": "My security group", "Tags": [ { "Value": "SG1", "Key": "Name" } ], "IpPermissions": [ { "IpProtocol": "-1", "IpRanges": [], "UserIdGroupPairs": [ { "UserId": "123456789012", "GroupId": "sg-903004f8" } ], "PrefixListIds": [] }, { "PrefixListIds": [], "FromPort": 22, "IpRanges": [ { "Description": "Access from NY office", "CidrIp": "203.0.113.0/24" } ], "ToPort": 22, "IpProtocol": "tcp", "UserIdGroupPairs": [] } ], "GroupName": "MySecurityGroup", "VpcId": "vpc-1a2b3c4d", "OwnerId": "123456789012", "GroupId": "sg-903004f8", } ] } ``` **Exemplo 2: descrever grupos de segurança com regras específicas** O exemplo `describe-security-groups` a seguir usa filtros para definir os resultados para grupos de segurança que tenham uma regra que permita tráfego SSH (porta 22) e uma regra que permita tráfego de todos os endereços (`0.0.0.0/0`). O exemplo usa o parâmetro `--query` para exibir somente os nomes dos grupos de segurança. Os grupos de segurança devem corresponder a todos os filtros para serem retornados nos resultados; no entanto, uma única regra não precisa corresponder a todos os filtros. Por exemplo, a saída retorna um grupo de segurança com uma regra que permite o tráfego SSH de um endereço IP específico e outra regra que permite o tráfego HTTP de todos os endereços. ``` aws ec2 describe-security-groups \ --filters Name=ip-permission.from-port,Values=22 Name=ip-permission.to-port,Values=22 Name=ip-permission.cidr,Values='0.0.0.0/0' \ --query "SecurityGroups[*].[GroupName]" \ --output text ``` Resultado: ``` default my-security-group web-servers launch-wizard-1 ``` **Exemplo 3: descrever grupos de segurança com base em tags** O exemplo a seguir `describe-security-groups` usa filtros para definir o escopo dos resultados para grupos de segurança que incluem `test` no nome do grupo de segurança e contêm a tag `Test=To-delete`. O exemplo usa o parâmetro `--query` para exibir somente os nomes e os IDs dos grupos de segurança. ``` aws ec2 describe-security-groups \ --filters Name=group-name,Values=*test* Name=tag:Test,Values=To-delete \ --query "SecurityGroups[*].{Name:GroupName,ID:GroupId}" ``` Resultado: ``` [ { "Name": "testfornewinstance", "ID": "sg-33bb22aa" }, { "Name": "newgrouptest", "ID": "sg-1a2b3c4d" } ] ``` Para obter mais exemplos do uso de filtros de tags, consulte [Trabalhando com tags](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#Using_Tags_CLI) no *Guia do usuário do Amazon EC2*. + Consulte detalhes da API em [DescribeSecurityGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-security-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-snapshot-attribute` O código de exemplo a seguir mostra como usar `describe-snapshot-attribute`. **AWS CLI** **Descrever os atributos de um snapshot** O exemplo `describe-snapshot-attribute` a seguir lista as contas com as quais um snapshot é compartilhado. ``` aws ec2 describe-snapshot-attribute \ --snapshot-id snap-01234567890abcedf \ --attribute createVolumePermission ``` Resultado: ``` { "SnapshotId": "snap-01234567890abcedf", "CreateVolumePermissions": [ { "UserId": "123456789012" } ] } ``` Para obter mais informações, consulte [Compartilhar um snapshot do Amazon EBS](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html#share-unencrypted-snapshot) no *Guia do usuário do Amazon Elastic Compute Cloud*. + Para ver detalhes da API, consulte [DescribeSnapshotAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-snapshot-attribute.html) na *Referência de comandos da AWS CLI*. ### `describe-snapshot-tier-status` O código de exemplo a seguir mostra como usar `describe-snapshot-tier-status`. **AWS CLI** **Para visualizar informações de arquivamento sobre um snapshot arquivado** O exemplo `describe-snapshot-tier-status` a seguir fornece informações de arquivamento sobre um snapshot arquivado. ``` aws ec2 describe-snapshot-tier-status \ --filters "Name=snapshot-id, Values=snap-01234567890abcedf" ``` Resultado: ``` { "SnapshotTierStatuses": [ { "Status": "completed", "ArchivalCompleteTime": "2021-09-15T17:33:16.147Z", "LastTieringProgress": 100, "Tags": [], "VolumeId": "vol-01234567890abcedf", "LastTieringOperationState": "archival-completed", "StorageTier": "archive", "OwnerId": "123456789012", "SnapshotId": "snap-01234567890abcedf", "LastTieringStartTime": "2021-09-15T16:44:37.574Z" } ] } ``` Para obter mais informações, consulte [View archived snapshots](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/working-with-snapshot-archiving.html#view-archived-snapshot) no *Guia do usuário do Amazon Elastic Compute Cloud*. + Para ver detalhes da API, consulte [DescribeSnapshotTierStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-snapshot-tier-status.html) na *Referência de comandos da AWS CLI*. ### `describe-snapshots` O código de exemplo a seguir mostra como usar `describe-snapshots`. **AWS CLI** **Exemplo 1: descrever um snapshot** O exemplo `describe-snapshots` a seguir descreve o snapshot especificado. ``` aws ec2 describe-snapshots \ --snapshot-ids snap-1234567890abcdef0 ``` Resultado: ``` { "Snapshots": [ { "Description": "This is my snapshot", "Encrypted": false, "VolumeId": "vol-049df61146c4d7901", "State": "completed", "VolumeSize": 8, "StartTime": "2019-02-28T21:28:32.000Z", "Progress": "100%", "OwnerId": "012345678910", "SnapshotId": "snap-01234567890abcdef", "Tags": [ { "Key": "Stack", "Value": "test" } ] } ] } ``` Para obter mais informações, consulte [Snapshots do Amazon EBS](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html) no *Guia do usuário do Amazon EC2*. **Exemplo 2: descrever snapshots com base em filtros** O exemplo `describe-snapshots` a seguir usa filtros para definir o escopo dos resultados para snapshots pertencentes à sua conta da AWS que estão no estado `pending`. O exemplo usa o parâmetro `--query` para exibir somente os IDs do snapshot e a hora em que o snapshot foi iniciado. ``` aws ec2 describe-snapshots \ --owner-ids self \ --filters Name=status,Values=pending \ --query "Snapshots[*].{ID:SnapshotId,Time:StartTime}" ``` Resultado: ``` [ { "ID": "snap-1234567890abcdef0", "Time": "2019-08-04T12:48:18.000Z" }, { "ID": "snap-066877671789bd71b", "Time": "2019-08-04T02:45:16.000Z }, ... ] ``` O exemplo `describe-snapshots` a seguir usa filtros para definir o escopo dos resultados para snapshots criados no volume especificado. O exemplo usa o parâmetro `--query` para exibir somente os IDs do snapshot. ``` aws ec2 describe-snapshots \ --filters Name=volume-id,Values=049df61146c4d7901 \ --query "Snapshots[*].[SnapshotId]" \ --output text ``` Resultado: ``` snap-1234567890abcdef0 snap-08637175a712c3fb9 ... ``` Para obter mais exemplos do uso de filtros, consulte [Listar e filtrar seus recursos](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html#Filtering_Resources_CLI) no *Guia do usuário do Amazon EC2*. **Exemplo 3: descrever snapshots com base em tags** O exemplo `describe-snapshots` a seguir usa filtros de tag para definir o escopo dos resultados para snapshots que tenham a tag `Stack=Prod`. ``` aws ec2 describe-snapshots \ --filters Name=tag:Stack,Values=prod ``` Para obter um exemplo da saída de `describe-snapshots`, consulte o Exemplo 1. Para obter mais exemplos do uso de filtros de tags, consulte [Trabalhando com tags](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#Using_Tags_CLI) no *Guia do usuário do Amazon EC2*. **Exemplo 4: descrever snapshots com base na idade** O exemplo `describe-snapshots` a seguir usa expressões JMESPath para descrever todos os snapshots criados pela sua conta da AWS antes da data especificada. Ele exibe somente os IDs do snapshot. ``` aws ec2 describe-snapshots \ --owner-ids 012345678910 \ --query "Snapshots[?(StartTime<='2020-03-31')].[SnapshotId]" ``` Para obter mais exemplos do uso de filtros, consulte [Listar e filtrar seus recursos](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html#Filtering_Resources_CLI) no *Guia do usuário do Amazon EC2*. **Exemplo 5: visualizar somente snapshots arquivados** O exemplo `describe-snapshots` a seguir lista apenas os snapshots armazenados no nível de arquivamento. ``` aws ec2 describe-snapshots \ --filters "Name=storage-tier,Values=archive" ``` Resultado: ``` { "Snapshots": [ { "Description": "Snap A", "Encrypted": false, "VolumeId": "vol-01234567890aaaaaa", "State": "completed", "VolumeSize": 8, "StartTime": "2021-09-07T21:00:00.000Z", "Progress": "100%", "OwnerId": "123456789012", "SnapshotId": "snap-01234567890aaaaaa", "StorageTier": "archive", "Tags": [] }, ] } ``` Para obter mais informações, consulte [View archived snapshots](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/working-with-snapshot-archiving.html#view-archived-snapshot) no *Guia do usuário do Amazon Elastic Compute Cloud*. + Consulte detalhes da API em [DescribeSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-snapshots.html) na *Referência de comandos da AWS CLI*. ### `describe-spot-datafeed-subscription` O código de exemplo a seguir mostra como usar `describe-spot-datafeed-subscription`. **AWS CLI** **Descrever a assinatura do feed de dados da Instância Spot para uma conta** Este exemplo de comando descreve o feed de dados da conta. Comando: ``` aws ec2 describe-spot-datafeed-subscription ``` Resultado: ``` { "SpotDatafeedSubscription": { "OwnerId": "123456789012", "Prefix": "spotdata", "Bucket": "amzn-s3-demo-bucket", "State": "Active" } } ``` + Para ver detalhes da API, consulte [DescribeSpotDatafeedSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-spot-datafeed-subscription.html) na *Referência de comandos da AWS CLI*. ### `describe-spot-fleet-instances` O código de exemplo a seguir mostra como usar `describe-spot-fleet-instances`. **AWS CLI** **Descrever as Instâncias Spot associadas a uma Frota Spot** Este exemplo de comando lista as Instâncias Spot associadas à Frota Spot especificada. Comando: ``` aws ec2 describe-spot-fleet-instances --spot-fleet-request-id sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE ``` Resultado: ``` { "ActiveInstances": [ { "InstanceId": "i-1234567890abcdef0", "InstanceType": "m3.medium", "SpotInstanceRequestId": "sir-08b93456" }, ... ], "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" } ``` + Para ver detalhes da API, consulte [DescribeSpotFleetInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-spot-fleet-instances.html) na *Referência de comandos da AWS CLI*. ### `describe-spot-fleet-request-history` O código de exemplo a seguir mostra como usar `describe-spot-fleet-request-history`. **AWS CLI** **Descrever o histórico da frota Spot** Este comando de exemplo retorna o histórico da frota Spot especificada a partir da hora especificada. Comando: ``` aws ec2 describe-spot-fleet-request-history --spot-fleet-request-id sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE --start-time 2015-05-26T00:00:00Z ``` O exemplo de saída a seguir mostra os lançamentos bem-sucedidos de duas Instâncias Spot para a frota Spot. Resultado: ``` { "HistoryRecords": [ { "Timestamp": "2015-05-26T23:17:20.697Z", "EventInformation": { "EventSubType": "submitted" }, "EventType": "fleetRequestChange" }, { "Timestamp": "2015-05-26T23:17:20.873Z", "EventInformation": { "EventSubType": "active" }, "EventType": "fleetRequestChange" }, { "Timestamp": "2015-05-26T23:21:21.712Z", "EventInformation": { "InstanceId": "i-1234567890abcdef0", "EventSubType": "launched" }, "EventType": "instanceChange" }, { "Timestamp": "2015-05-26T23:21:21.816Z", "EventInformation": { "InstanceId": "i-1234567890abcdef1", "EventSubType": "launched" }, "EventType": "instanceChange" } ], "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", "NextToken": "CpHNsscimcV5oH7bSbub03CI2Qms5+ypNpNm+53MNlR0YcXAkp0xFlfKf91yVxSExmbtma3awYxMFzNA663ZskT0AHtJ6TCb2Z8bQC2EnZgyELbymtWPfpZ1ZbauVg+P+TfGlWxWWB/Vr5dk5d4LfdgA/DRAHUrYgxzrEXAMPLE=", "StartTime": "2015-05-26T00:00:00Z" } ``` + Para ver detalhes da API, consulte [DescribeSpotFleetRequestHistory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-spot-fleet-request-history.html) na *Referência de comandos da AWS CLI*. ### `describe-spot-fleet-requests` O código de exemplo a seguir mostra como usar `describe-spot-fleet-requests`. **AWS CLI** **Descrever suas solicitações de frota Spot** Este exemplo descreve todas as suas solicitações de frota Spot. Comando: ``` aws ec2 describe-spot-fleet-requests ``` Resultado: ``` { "SpotFleetRequestConfigs": [ { "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", "SpotFleetRequestConfig": { "TargetCapacity": 20, "LaunchSpecifications": [ { "EbsOptimized": false, "NetworkInterfaces": [ { "SubnetId": "subnet-a61dafcf", "DeviceIndex": 0, "DeleteOnTermination": false, "AssociatePublicIpAddress": true, "SecondaryPrivateIpAddressCount": 0 } ], "InstanceType": "cc2.8xlarge", "ImageId": "ami-1a2b3c4d" }, { "EbsOptimized": false, "NetworkInterfaces": [ { "SubnetId": "subnet-a61dafcf", "DeviceIndex": 0, "DeleteOnTermination": false, "AssociatePublicIpAddress": true, "SecondaryPrivateIpAddressCount": 0 } ], "InstanceType": "r3.8xlarge", "ImageId": "ami-1a2b3c4d" } ], "SpotPrice": "0.05", "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role" }, "SpotFleetRequestState": "active" }, { "SpotFleetRequestId": "sfr-306341ed-9739-402e-881b-ce47bEXAMPLE", "SpotFleetRequestConfig": { "TargetCapacity": 20, "LaunchSpecifications": [ { "EbsOptimized": false, "NetworkInterfaces": [ { "SubnetId": "subnet-6e7f829e", "DeviceIndex": 0, "DeleteOnTermination": false, "AssociatePublicIpAddress": true, "SecondaryPrivateIpAddressCount": 0 } ], "InstanceType": "m3.medium", "ImageId": "ami-1a2b3c4d" } ], "SpotPrice": "0.05", "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role" }, "SpotFleetRequestState": "active" } ] } ``` **Descrever uma solicitação de frota spot** Este exemplo descreve a solicitação de frota Spot especificada. Comando: ``` aws ec2 describe-spot-fleet-requests --spot-fleet-request-ids sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE ``` Resultado: ``` { "SpotFleetRequestConfigs": [ { "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", "SpotFleetRequestConfig": { "TargetCapacity": 20, "LaunchSpecifications": [ { "EbsOptimized": false, "NetworkInterfaces": [ { "SubnetId": "subnet-a61dafcf", "DeviceIndex": 0, "DeleteOnTermination": false, "AssociatePublicIpAddress": true, "SecondaryPrivateIpAddressCount": 0 } ], "InstanceType": "cc2.8xlarge", "ImageId": "ami-1a2b3c4d" }, { "EbsOptimized": false, "NetworkInterfaces": [ { "SubnetId": "subnet-a61dafcf", "DeviceIndex": 0, "DeleteOnTermination": false, "AssociatePublicIpAddress": true, "SecondaryPrivateIpAddressCount": 0 } ], "InstanceType": "r3.8xlarge", "ImageId": "ami-1a2b3c4d" } ], "SpotPrice": "0.05", "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role" }, "SpotFleetRequestState": "active" } ] } ``` + Para ver detalhes da API, consulte [DescribeSpotFleetRequests](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-spot-fleet-requests.html) na * Referência do comando da AWS CLI*. ### `describe-spot-instance-requests` O código de exemplo a seguir mostra como usar `describe-spot-instance-requests`. **AWS CLI** **Exemplo 1: descrever uma solicitação de Instância Spot** O exemplo `describe-spot-instance-requests` a seguir descreve a Instância Spot especificada. ``` aws ec2 describe-spot-instance-requests \ --spot-instance-request-ids sir-08b93456 ``` Resultado: ``` { "SpotInstanceRequests": [ { "CreateTime": "2018-04-30T18:14:55.000Z", "InstanceId": "i-1234567890abcdef1", "LaunchSpecification": { "InstanceType": "t2.micro", "ImageId": "ami-003634241a8fcdec0", "KeyName": "my-key-pair", "SecurityGroups": [ { "GroupName": "default", "GroupId": "sg-e38f24a7" } ], "BlockDeviceMappings": [ { "DeviceName": "/dev/sda1", "Ebs": { "DeleteOnTermination": true, "SnapshotId": "snap-0e54a519c999adbbd", "VolumeSize": 8, "VolumeType": "standard", "Encrypted": false } } ], "NetworkInterfaces": [ { "DeleteOnTermination": true, "DeviceIndex": 0, "SubnetId": "subnet-049df61146c4d7901" } ], "Placement": { "AvailabilityZone": "us-east-2b", "Tenancy": "default" }, "Monitoring": { "Enabled": false } }, "LaunchedAvailabilityZone": "us-east-2b", "ProductDescription": "Linux/UNIX", "SpotInstanceRequestId": "sir-08b93456", "SpotPrice": "0.010000" "State": "active", "Status": { "Code": "fulfilled", "Message": "Your Spot request is fulfilled.", "UpdateTime": "2018-04-30T18:16:21.000Z" }, "Tags": [], "Type": "one-time", "InstanceInterruptionBehavior": "terminate" } ] } ``` **Exemplo 2: descrever solicitações de Instância Spot com base em filtros** O exemplo `describe-spot-instance-requests` a seguir usa filtros para definir o escopo dos resultados para solicitações de Instâncias Spot com o tipo de instância especificado que também estão na Zona de Disponibilidade especificada. O exemplo usa o parâmetro `--query` para exibir somente os IDs da instância. ``` aws ec2 describe-spot-instance-requests \ --filters Name=launch.instance-type,Values=m3.medium Name=launched-availability-zone,Values=us-east-2a \ --query "SpotInstanceRequests[*].[InstanceId]" \ --output text ``` Resultado: ``` i-057750d42936e468a i-001efd250faaa6ffa i-027552a73f021f3bd ... ``` Para obter mais exemplos do uso de filtros, consulte [Listar e filtrar seus recursos](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html#Filtering_Resources_CLI) no *Guia do usuário do Amazon Elastic Computer Cloud*. **Exemplo 3: descrever solicitações de Instância Spot com base em tags** O exemplo `describe-spot-instance-requests` a seguir usa filtros de tag para definir o escopo dos resultados das solicitações de Instância Spot que tenham a tag `cost-center=cc123`. ``` aws ec2 describe-spot-instance-requests \ --filters Name=tag:cost-center,Values=cc123 ``` Para obter um exemplo da saída de `describe-spot-instance-requests`, consulte o Exemplo 1. Para obter mais exemplos do uso de filtros de tags, consulte [Trabalhando com tags](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#Using_Tags_CLI) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [DescribeSpotInstanceRequests](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-spot-instance-requests.html) na *Referência de comandos da AWS CLI*. ### `describe-spot-price-history` O código de exemplo a seguir mostra como usar `describe-spot-price-history`. **AWS CLI** **Descrever o histórico de preço Spot** Esse exemplo de comando retorna o histórico de preços spot para instâncias m1.xlarge em um determinado dia de janeiro. Comando: ``` aws ec2 describe-spot-price-history --instance-types m1.xlarge --start-time 2014-01-06T07:08:09 --end-time 2014-01-06T08:09:10 ``` Resultado: ``` { "SpotPriceHistory": [ { "Timestamp": "2014-01-06T07:10:55.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.xlarge", "SpotPrice": "0.087000", "AvailabilityZone": "us-west-1b" }, { "Timestamp": "2014-01-06T07:10:55.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.xlarge", "SpotPrice": "0.087000", "AvailabilityZone": "us-west-1c" }, { "Timestamp": "2014-01-06T05:42:36.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.087000", "AvailabilityZone": "us-west-1a" }, ... } ``` **Descrever o histórico de preços spot para Linux/UNIX Amazon VPC** Esse exemplo de comando retorna o histórico de preços spot para instâncias m1.xlarge, instâncias Linux/UNIX Amazon VPC em um determinado dia de janeiro. Comando: ``` aws ec2 describe-spot-price-history --instance-types m1.xlarge --product-description "Linux/UNIX (Amazon VPC)" --start-time 2014-01-06T07:08:09 --end-time 2014-01-06T08:09:10 ``` Resultado: ``` { "SpotPriceHistory": [ { "Timestamp": "2014-01-06T04:32:53.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.080000", "AvailabilityZone": "us-west-1a" }, { "Timestamp": "2014-01-05T11:28:26.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.080000", "AvailabilityZone": "us-west-1c" } ] } ``` + Para ver detalhes da API, consulte [DescribeSpotPriceHistory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-spot-price-history.html) na *Referência de comandos da AWS CLI*. ### `describe-stale-security-groups` O código de exemplo a seguir mostra como usar `describe-stale-security-groups`. **AWS CLI** **Descrever grupos de segurança obsoletos** Este exemplo descreve regras de grupo de segurança obsoletos para `vpc-11223344`. A resposta mostra que sg-5fa68d3a em sua conta tem uma regra SSH de entrada obsoleta que faz referência a `sg-279ab042` na VPC de mesmo nível, e que `sg-fe6fba9a` em sua conta tem uma regra SSH de saída obsoleta que faz referência a `sg-ef6fba8b` na VPC de mesmo nível. Comando: ``` aws ec2 describe-stale-security-groups --vpc-id vpc-11223344 ``` Resultado: ``` { "StaleSecurityGroupSet": [ { "VpcId": "vpc-11223344", "StaleIpPermissionsEgress": [ { "ToPort": 22, "FromPort": 22, "UserIdGroupPairs": [ { "VpcId": "vpc-7a20e51f", "GroupId": "sg-ef6fba8b", "VpcPeeringConnectionId": "pcx-b04deed9", "PeeringStatus": "active" } ], "IpProtocol": "tcp" } ], "GroupName": "MySG1", "StaleIpPermissions": [], "GroupId": "sg-fe6fba9a", "Description": MySG1" }, { "VpcId": "vpc-11223344", "StaleIpPermissionsEgress": [], "GroupName": "MySG2", "StaleIpPermissions": [ { "ToPort": 22, "FromPort": 22, "UserIdGroupPairs": [ { "VpcId": "vpc-7a20e51f", "GroupId": "sg-279ab042", "Description": "Access from pcx-b04deed9", "VpcPeeringConnectionId": "pcx-b04deed9", "PeeringStatus": "active" } ], "IpProtocol": "tcp" } ], "GroupId": "sg-5fa68d3a", "Description": "MySG2" } ] } ``` + Para ver detalhes da API, consulte [DescribeStaleSecurityGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-stale-security-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-store-image-tasks` O código de exemplo a seguir mostra como usar `describe-store-image-tasks`. **AWS CLI** **Descrever o andamento de uma tarefa de armazenamento de AMI** O exemplo `describe-store-image-tasks` a seguir descreve o andamento de uma tarefa de armazenamento de AMI. ``` aws ec2 describe-store-image-tasks ``` Resultado: ``` { "StoreImageTaskResults": [ { "AmiId": "ami-1234567890abcdef0", "Bucket": "my-ami-bucket", "ProgressPercentage": 17, "S3objectKey": "ami-1234567890abcdef0.bin", "StoreTaskState": "InProgress", "StoreTaskFailureReason": null, "TaskStartTime": "2022-01-01T01:01:01.001Z" } ] } ``` Para obter mais informações sobre como armazenar e restaurar uma AMI usando o S3, consulte Armazenar e restaurar uma AMI usando o S3 no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [DescribeStoreImageTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-store-image-tasks.html) na *Referência de comandos da AWS CLI*. ### `describe-subnets` O código de exemplo a seguir mostra como usar `describe-subnets`. **AWS CLI** **Exemplo 1: descrever todas as suas sub-redes** O exemplo `describe-subnets` a seguir mostra os detalhes das suas sub-redes. ``` aws ec2 describe-subnets ``` Resultado: ``` { "Subnets": [ { "AvailabilityZone": "us-east-1d", "AvailabilityZoneId": "use1-az2", "AvailableIpAddressCount": 4089, "CidrBlock": "172.31.80.0/20", "DefaultForAz": true, "MapPublicIpOnLaunch": false, "MapCustomerOwnedIpOnLaunch": true, "State": "available", "SubnetId": "subnet-0bb1c79de3EXAMPLE", "VpcId": "vpc-0ee975135dEXAMPLE", "OwnerId": "111122223333", "AssignIpv6AddressOnCreation": false, "Ipv6CidrBlockAssociationSet": [], "CustomerOwnedIpv4Pool:": 'pool-2EXAMPLE', "SubnetArn": "arn:aws:ec2:us-east-2:111122223333:subnet/subnet-0bb1c79de3EXAMPLE", "EnableDns64": false, "Ipv6Native": false, "PrivateDnsNameOptionsOnLaunch": { "HostnameType": "ip-name", "EnableResourceNameDnsARecord": false, "EnableResourceNameDnsAAAARecord": false } }, { "AvailabilityZone": "us-east-1d", "AvailabilityZoneId": "use1-az2", "AvailableIpAddressCount": 4089, "CidrBlock": "172.31.80.0/20", "DefaultForAz": true, "MapPublicIpOnLaunch": true, "MapCustomerOwnedIpOnLaunch": false, "State": "available", "SubnetId": "subnet-8EXAMPLE", "VpcId": "vpc-3EXAMPLE", "OwnerId": "1111222233333", "AssignIpv6AddressOnCreation": false, "Ipv6CidrBlockAssociationSet": [], "Tags": [ { "Key": "Name", "Value": "MySubnet" } ], "SubnetArn": "arn:aws:ec2:us-east-1:111122223333:subnet/subnet-8EXAMPLE", "EnableDns64": false, "Ipv6Native": false, "PrivateDnsNameOptionsOnLaunch": { "HostnameType": "ip-name", "EnableResourceNameDnsARecord": false, "EnableResourceNameDnsAAAARecord": false } } ] } ``` Para obter mais informações, consulte [Working with VPCs and Subnets](https://docs.aws.amazon.com/vpc/latest/userguide/working-with-vpcs.html) no *Guia do usuário da VPC da AWS*. **Exemplo 2: descrever as sub-redes de uma VPC específica** O exemplo de `describe-subnets` a seguir usa um filtro para recuperar detalhes das sub-redes da VPC especificada. ``` aws ec2 describe-subnets \ --filters "Name=vpc-id,Values=vpc-3EXAMPLE" ``` Resultado: ``` { "Subnets": [ { "AvailabilityZone": "us-east-1d", "AvailabilityZoneId": "use1-az2", "AvailableIpAddressCount": 4089, "CidrBlock": "172.31.80.0/20", "DefaultForAz": true, "MapPublicIpOnLaunch": true, "MapCustomerOwnedIpOnLaunch": false, "State": "available", "SubnetId": "subnet-8EXAMPLE", "VpcId": "vpc-3EXAMPLE", "OwnerId": "1111222233333", "AssignIpv6AddressOnCreation": false, "Ipv6CidrBlockAssociationSet": [], "Tags": [ { "Key": "Name", "Value": "MySubnet" } ], "SubnetArn": "arn:aws:ec2:us-east-1:111122223333:subnet/subnet-8EXAMPLE", "EnableDns64": false, "Ipv6Native": false, "PrivateDnsNameOptionsOnLaunch": { "HostnameType": "ip-name", "EnableResourceNameDnsARecord": false, "EnableResourceNameDnsAAAARecord": false } } ] } ``` Para obter mais informações, consulte [Working with VPCs and Subnets](https://docs.aws.amazon.com/vpc/latest/userguide/working-with-vpcs.html) no *Guia do usuário da VPC da AWS*. **Exemplo 3: descrever as sub-redes com uma tag específica** O exemplo `describe-subnets` a seguir usa um filtro para recuperar os detalhes dessas sub-redes com a tag `CostCenter=123` e o parâmetro `--query` para exibir os IDs de sub-redes com essa tag. ``` aws ec2 describe-subnets \ --filters "Name=tag:CostCenter,Values=123" \ --query "Subnets[*].SubnetId" \ --output text ``` Resultado: ``` subnet-0987a87c8b37348ef subnet-02a95061c45f372ee subnet-03f720e7de2788d73 ``` Para obter mais informações, consulte [Working with VPCs and Subnets](https://docs.aws.amazon.com/vpc/latest/userguide/working-with-vpcs.html) no *Guia do usuário da Amazon VPC*. + Consulte detalhes da API em [DescribeSubnets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-subnets.html) na *Referência de comandos da AWS CLI*. ### `describe-tags` O código de exemplo a seguir mostra como usar `describe-tags`. **AWS CLI** **Exemplo 1: descrever todas as tags de um único recurso** O exemplo `describe-tags` a seguir descreve as tags da instância especificada. ``` aws ec2 describe-tags \ --filters "Name=resource-id,Values=i-1234567890abcdef8" ``` Resultado: ``` { "Tags": [ { "ResourceType": "instance", "ResourceId": "i-1234567890abcdef8", "Value": "Test", "Key": "Stack" }, { "ResourceType": "instance", "ResourceId": "i-1234567890abcdef8", "Value": "Beta Server", "Key": "Name" } ] } ``` **Exemplo 2: descrever todas as tags de um tipo de recurso** O exemplo `describe-tags` a seguir descreve as tags para os volumes. ``` aws ec2 describe-tags \ --filters "Name=resource-type,Values=volume" ``` Resultado: ``` { "Tags": [ { "ResourceType": "volume", "ResourceId": "vol-1234567890abcdef0", "Value": "Project1", "Key": "Purpose" }, { "ResourceType": "volume", "ResourceId": "vol-049df61146c4d7901", "Value": "Logs", "Key": "Purpose" } ] } ``` **Exemplo 3: descrever todas as tags** O exemplo `describe-tags` a seguir descreve as tags de todos os recursos. ``` aws ec2 describe-tags ``` **Exemplo 4: descrever as tags dos recursos com base em uma chave de tag** O exemplo `describe-tags` a seguir descreve as tags dos seus recursos que têm uma tag com a chave `Stack`. ``` aws ec2 describe-tags \ --filters Name=key,Values=Stack ``` Resultado: ``` { "Tags": [ { "ResourceType": "volume", "ResourceId": "vol-027552a73f021f3b", "Value": "Production", "Key": "Stack" }, { "ResourceType": "instance", "ResourceId": "i-1234567890abcdef8", "Value": "Test", "Key": "Stack" } ] } ``` **Exemplo 5: descrever as tags de seus recursos com base na chave e no valor da tag** O exemplo `describe-tags` a seguir descreve as tags dos seus recursos que têm a tag `Stack=Test`. ``` aws ec2 describe-tags \ --filters Name=key,Values=Stack Name=value,Values=Test ``` Resultado: ``` { "Tags": [ { "ResourceType": "image", "ResourceId": "ami-3ac336533f021f3bd", "Value": "Test", "Key": "Stack" }, { "ResourceType": "instance", "ResourceId": "i-1234567890abcdef8", "Value": "Test", "Key": "Stack" } ] } ``` O exemplo `describe-tags` a seguir usa uma sintaxe alternativa para descrever recursos com a tag `Stack=Test`. ``` aws ec2 describe-tags \ --filters "Name=tag:Stack,Values=Test" ``` O exemplo `describe-tags` a seguir descreve as tags de todas as suas instâncias que têm uma tag com a chave `Purpose` e sem valor. ``` aws ec2 describe-tags \ --filters "Name=resource-type,Values=instance" "Name=key,Values=Purpose" "Name=value,Values=" ``` Resultado: ``` { "Tags": [ { "ResourceType": "instance", "ResourceId": "i-1234567890abcdef5", "Value": null, "Key": "Purpose" } ] } ``` + Para ver detalhes da API, consulte [DescribeTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-tags.html) na *Referência de comandos da AWS CLI*. ### `describe-traffic-mirror-filters` O código de exemplo a seguir mostra como usar `describe-traffic-mirror-filters`. **AWS CLI** **Visualizar seus filtros de espelhamento de tráfego** O exemplo `describe-traffic-mirror-filters` a seguir exibe detalhes de todos os seus filtros de espelhamento de tráfego. ``` aws ec2 describe-traffic-mirror-filters ``` Resultado: ``` { "TrafficMirrorFilters": [ { "TrafficMirrorFilterId": "tmf-0293f26e86EXAMPLE", "IngressFilterRules": [ { "TrafficMirrorFilterRuleId": "tmfr-0ca76e0e08EXAMPLE", "TrafficMirrorFilterId": "tmf-0293f26e86EXAMPLE", "TrafficDirection": "ingress", "RuleNumber": 100, "RuleAction": "accept", "Protocol": 6, "DestinationCidrBlock": "10.0.0.0/24", "SourceCidrBlock": "10.0.0.0/24", "Description": "TCP Rule" } ], "EgressFilterRules": [], "NetworkServices": [], "Description": "Example filter", "Tags": [] } ] } ``` Para obter mais informações, consulte [Visualizar filtros de espelhamento de tráfego](https://docs.aws.amazon.com/vpc/latest/mirroring/traffic-mirroring-filter.html#view-traffic-mirroring-filter) no *Guia de espelhamento de tráfego*. + Para ver detalhes da API, consulte [DescribeTrafficMirrorFilters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-traffic-mirror-filters.html) na *Referência de comandos da AWS CLI*. ### `describe-traffic-mirror-sessions` O código de exemplo a seguir mostra como usar `describe-traffic-mirror-sessions`. **AWS CLI** **Descrever uma sessão de espelhamento de tráfego** O exemplo `describe-traffic-mirror-sessions` a seguir exibe detalhes das suas sessões de Espelhamento de Tráfego. ``` aws ec2 describe-traffic-mirror-sessions ``` Resultado: ``` { "TrafficMirrorSessions": [ { "Tags": [], "VirtualNetworkId": 42, "OwnerId": "111122223333", "Description": "TCP Session", "NetworkInterfaceId": "eni-0a471a5cf3EXAMPLE", "TrafficMirrorTargetId": "tmt-0dabe9b0a6EXAMPLE", "TrafficMirrorFilterId": "tmf-083e18f985EXAMPLE", "PacketLength": 20, "SessionNumber": 1, "TrafficMirrorSessionId": "tms-0567a4c684EXAMPLE" }, { "Tags": [ { "Key": "Name", "Value": "tag test" } ], "VirtualNetworkId": 13314501, "OwnerId": "111122223333", "Description": "TCP Session", "NetworkInterfaceId": "eni-0a471a5cf3EXAMPLE", "TrafficMirrorTargetId": "tmt-03665551cbEXAMPLE", "TrafficMirrorFilterId": "tmf-06c787846cEXAMPLE", "SessionNumber": 2, "TrafficMirrorSessionId": "tms-0060101cf8EXAMPLE" } ] } ``` Para obter mais informações, consulte [Visualizar detalhes de uma sessão de espelhamento de tráfego](https://docs.aws.amazon.com/vpc/latest/mirroring/traffic-mirroring-session.html#view-traffic-mirroring-session) no *Guia de espelhamento de tráfego da AWS*. + Para ver detalhes da API, consulte [DescribeTrafficMirrorSessions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-traffic-mirror-sessions.html) na *Referência de comandos da AWS CLI*. ### `describe-traffic-mirror-targets` O código de exemplo a seguir mostra como usar `describe-traffic-mirror-targets`. **AWS CLI** **Descrever um destino de espelhamento de tráfego** O exemplo `describe-traffic-mirror-targets` a seguir mostra as informações do destino de espelhamento de tráfego especificado. ``` aws ec2 describe-traffic-mirror-targets \ --traffic-mirror-target-ids tmt-0dabe9b0a6EXAMPLE ``` Resultado: ``` { "TrafficMirrorTargets": [ { "TrafficMirrorTargetId": "tmt-0dabe9b0a6EXAMPLE", "NetworkLoadBalancerArn": "arn:aws:elasticloadbalancing:us-east-1:111122223333:loadbalancer/net/NLB/7cdec873fEXAMPLE", "Type": "network-load-balancer", "Description": "Example Network Load Balancer target", "OwnerId": "111122223333", "Tags": [] } ] } ``` Para obter mais informações, consulte [Destinos de espelhamento de tráfego](https://docs.aws.amazon.com/vpc/latest/mirroring/traffic-mirroring-target.html) no *Guia do Amazon VPC Traffic Mirroring*. + Para ver detalhes da API, consulte [DescribeTrafficMirrorTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-traffic-mirror-targets.html) na *Referência de comandos da AWS CLI*. ### `describe-transit-gateway-attachments` O código de exemplo a seguir mostra como usar `describe-transit-gateway-attachments`. **AWS CLI** **Visualizar os anexos do gateway de trânsito** O exemplo `describe-transit-gateway-attachments` a seguir exibe detalhes de seus anexos do gateway de trânsito. ``` aws ec2 describe-transit-gateway-attachments ``` Resultado: ``` { "TransitGatewayAttachments": [ { "TransitGatewayAttachmentId": "tgw-attach-01f8100bc7EXAMPLE", "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", "TransitGatewayOwnerId": "123456789012", "ResourceOwnerId": "123456789012", "ResourceType": "vpc", "ResourceId": "vpc-3EXAMPLE", "State": "available", "Association": { "TransitGatewayRouteTableId": "tgw-rtb-002573ed1eEXAMPLE", "State": "associated" }, "CreationTime": "2019-08-26T14:59:25.000Z", "Tags": [ { "Key": "Name", "Value": "Example" } ] }, { "TransitGatewayAttachmentId": "tgw-attach-0b5968d3b6EXAMPLE", "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", "TransitGatewayOwnerId": "123456789012", "ResourceOwnerId": "123456789012", "ResourceType": "vpc", "ResourceId": "vpc-0065acced4EXAMPLE", "State": "available", "Association": { "TransitGatewayRouteTableId": "tgw-rtb-002573ed1eEXAMPLE", "State": "associated" }, "CreationTime": "2019-08-07T17:03:07.000Z", "Tags": [] }, { "TransitGatewayAttachmentId": "tgw-attach-08e0bc912cEXAMPLE", "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", "TransitGatewayOwnerId": "123456789012", "ResourceOwnerId": "123456789012", "ResourceType": "direct-connect-gateway", "ResourceId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE", "State": "available", "Association": { "TransitGatewayRouteTableId": "tgw-rtb-002573ed1eEXAMPLE", "State": "associated" }, "CreationTime": "2019-08-14T20:27:44.000Z", "Tags": [] }, { "TransitGatewayAttachmentId": "tgw-attach-0a89069f57EXAMPLE", "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", "TransitGatewayOwnerId": "123456789012", "ResourceOwnerId": "123456789012", "ResourceType": "direct-connect-gateway", "ResourceId": "8384da05-13ce-4a91-aada-5a1baEXAMPLE", "State": "available", "Association": { "TransitGatewayRouteTableId": "tgw-rtb-002573ed1eEXAMPLE", "State": "associated" }, "CreationTime": "2019-08-14T20:33:02.000Z", "Tags": [] } ] } ``` Para obter mais informações, consulte [Trabalhar com gateways de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/working-with-transit-gateways.html) no *Guia do usuário de gateways de trânsito*. + Para ver detalhes da API, consulte [DescribeTransitGatewayAttachments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-transit-gateway-attachments.html) na *Referência de comandos da AWS CLI*. ### `describe-transit-gateway-connect-peers` O código de exemplo a seguir mostra como usar `describe-transit-gateway-connect-peers`. **AWS CLI** **Descrever um emparelhamento de conexão de gateway de trânsito** O exemplo `describe-transit-gateway-connect-peers` a seguir descreve o emparelhamento de Conexão especificado. ``` aws ec2 describe-transit-gateway-connect-peers \ --transit-gateway-connect-peer-ids tgw-connect-peer-0666adbac4EXAMPLE ``` Resultado: ``` { "TransitGatewayConnectPeers": [ { "TransitGatewayAttachmentId": "tgw-attach-0f0927767cEXAMPLE", "TransitGatewayConnectPeerId": "tgw-connect-peer-0666adbac4EXAMPLE", "State": "available", "CreationTime": "2021-10-13T03:35:17.000Z", "ConnectPeerConfiguration": { "TransitGatewayAddress": "10.0.0.234", "PeerAddress": "172.31.1.11", "InsideCidrBlocks": [ "169.254.6.0/29" ], "Protocol": "gre", "BgpConfigurations": [ { "TransitGatewayAsn": 64512, "PeerAsn": 64512, "TransitGatewayAddress": "169.254.6.2", "PeerAddress": "169.254.6.1", "BgpStatus": "down" }, { "TransitGatewayAsn": 64512, "PeerAsn": 64512, "TransitGatewayAddress": "169.254.6.3", "PeerAddress": "169.254.6.1", "BgpStatus": "down" } ] }, "Tags": [] } ] } ``` Para obter mais informações, consulte [Anexos de conexão do gateway de trânsito e pares de conexão do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [DescribeTransitGatewayConnectPeers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-transit-gateway-connect-peers.html) na *Referência de comandos da AWS CLI*. ### `describe-transit-gateway-connects` O código de exemplo a seguir mostra como usar `describe-transit-gateway-connects`. **AWS CLI** **Descrever um anexo da conexão do gateway de trânsito** O exemplo `describe-transit-gateway-connects` a seguir descreve o anexo de Conexão especificado. ``` aws ec2 describe-transit-gateway-connects \ --transit-gateway-attachment-ids tgw-attach-037012e5dcEXAMPLE ``` Resultado: ``` { "TransitGatewayConnects": [ { "TransitGatewayAttachmentId": "tgw-attach-037012e5dcEXAMPLE", "TransportTransitGatewayAttachmentId": "tgw-attach-0a89069f57EXAMPLE", "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", "State": "available", "CreationTime": "2021-03-09T19:59:17+00:00", "Options": { "Protocol": "gre" }, "Tags": [] } ] } ``` Para obter mais informações, consulte [Anexos de conexão do gateway de trânsito e pares de conexão do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [DescribeTransitGatewayConnects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-transit-gateway-connects.html) na *Referência de comandos da AWS CLI*. ### `describe-transit-gateway-multicast-domains` O código de exemplo a seguir mostra como usar `describe-transit-gateway-multicast-domains`. **AWS CLI** **Descrever seus domínios de multicast do gateway de trânsito** O exemplo `describe-transit-gateway-multicast-domains` a seguir exibe detalhes de todos os seus domínios multicast do Gateway de Trânsito. ``` aws ec2 describe-transit-gateway-multicast-domains ``` Resultado: ``` { "TransitGatewayMulticastDomains": [ { "TransitGatewayMulticastDomainId": "tgw-mcast-domain-000fb24d04EXAMPLE", "TransitGatewayId": "tgw-0bf0bffefaEXAMPLE", "TransitGatewayMulticastDomainArn": "arn:aws:ec2:us-east-1:123456789012:transit-gateway-multicast-domain/tgw-mcast-domain-000fb24d04EXAMPLE", "OwnerId": "123456789012", "Options": { "Igmpv2Support": "disable", "StaticSourcesSupport": "enable", "AutoAcceptSharedAssociations": "disable" }, "State": "available", "CreationTime": "2019-12-10T18:32:50+00:00", "Tags": [ { "Key": "Name", "Value": "mc1" } ] } ] } ``` Para obter mais informações, consulte [Como gerenciar domínios multicast](https://docs.aws.amazon.com/vpc/latest/tgw/manage-domain.html) no *Guia de gateway de trânsito*. + Para ver detalhes da API, consulte [DescribeTransitGatewayMulticastDomains](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-transit-gateway-multicast-domains.html) na *Referência de comandos da AWS CLI*. ### `describe-transit-gateway-peering-attachments` O código de exemplo a seguir mostra como usar `describe-transit-gateway-peering-attachments`. **AWS CLI** **Descrever os anexos de emparelhamento do gateway de trânsito** O exemplo `describe-transit-gateway-peering-attachments` a seguir exibe detalhes de todos os anexos de emparelhamento do Gateway de trânsito. ``` aws ec2 describe-transit-gateway-peering-attachments ``` Resultado: ``` { "TransitGatewayPeeringAttachments": [ { "TransitGatewayAttachmentId": "tgw-attach-4455667788aabbccd", "RequesterTgwInfo": { "TransitGatewayId": "tgw-123abc05e04123abc", "OwnerId": "123456789012", "Region": "us-west-2" }, "AccepterTgwInfo": { "TransitGatewayId": "tgw-11223344aabbcc112", "OwnerId": "123456789012", "Region": "us-east-2" }, "State": "pendingAcceptance", "CreationTime": "2019-12-09T11:38:05.000Z", "Tags": [] } ] } ``` Para obter mais informações, consulte [Anexos de pareamento do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-peering.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [DescribeTransitGatewayPeeringAttachments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-transit-gateway-peering-attachments.html) na *Referência de comandos da AWS CLI*. ### `describe-transit-gateway-policy-tables` O código de exemplo a seguir mostra como usar `describe-transit-gateway-policy-tables`. **AWS CLI** **Descrever uma tabela de políticas de gateway de trânsito** O exemplo `describe-transit-gateway-policy-tables` a seguir descreve a tabela de políticas de gateway de trânsito especificada. ``` aws ec2 describe-transit-gateway-policy-tables \ --transit-gateway-policy-table-ids tgw-ptb-0a16f134b78668a81 ``` Resultado: ``` { "TransitGatewayPolicyTables": [ { "TransitGatewayPolicyTableId": "tgw-ptb-0a16f134b78668a81", "TransitGatewayId": "tgw-067f8505c18f0bd6e", "State": "available", "CreationTime": "2023-11-28T16:36:43+00:00", "Tags": [] } ] } ``` Para obter mais informações, consulte [Tabelas de política do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-policy-tables.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [DescribeTransitGatewayPolicyTables](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-transit-gateway-policy-tables.html) na *Referência de comandos da AWS CLI*. ### `describe-transit-gateway-route-tables` O código de exemplo a seguir mostra como usar `describe-transit-gateway-route-tables`. **AWS CLI** **Descrever as tabelas de rotas do gateway de trânsito** O exemplo `describe-transit-gateway-route-tables` a seguir exibe detalhes das tabelas de rotas do gateway de trânsito. ``` aws ec2 describe-transit-gateway-route-tables ``` Resultado: ``` { "TransitGatewayRouteTables": [ { "TransitGatewayRouteTableId": "tgw-rtb-0ca78a549EXAMPLE", "TransitGatewayId": "tgw-0bc994abffEXAMPLE", "State": "available", "DefaultAssociationRouteTable": true, "DefaultPropagationRouteTable": true, "CreationTime": "2018-11-28T14:24:49.000Z", "Tags": [] }, { "TransitGatewayRouteTableId": "tgw-rtb-0e8f48f148EXAMPLE", "TransitGatewayId": "tgw-0043d72bb4EXAMPLE", "State": "available", "DefaultAssociationRouteTable": true, "DefaultPropagationRouteTable": true, "CreationTime": "2018-11-28T14:24:00.000Z", "Tags": [] } ] } ``` Para obter mais informações, consulte [Visualizar tabelas de rota do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html#view-tgw-route-tables) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [DescribeTransitGatewayRouteTables](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-transit-gateway-route-tables.html) na *Referência de comandos da AWS CLI*. ### `describe-transit-gateway-vpc-attachments` O código de exemplo a seguir mostra como usar `describe-transit-gateway-vpc-attachments`. **AWS CLI** **Descrever os anexos da VPC do gateway de trânsito** O exemplo `describe-transit-gateway-vpc-attachments` a seguir exibe detalhes dos anexos da VPC do gateway de trânsito. ``` aws ec2 describe-transit-gateway-vpc-attachments ``` Resultado: ``` { "TransitGatewayVpcAttachments": [ { "TransitGatewayAttachmentId": "tgw-attach-0a08e88308EXAMPLE", "TransitGatewayId": "tgw-0043d72bb4EXAMPLE", "VpcId": "vpc-0f501f7ee8EXAMPLE", "VpcOwnerId": "111122223333", "State": "available", "SubnetIds": [ "subnet-045d586432EXAMPLE", "subnet-0a0ad478a6EXAMPLE" ], "CreationTime": "2019-02-13T11:04:02.000Z", "Options": { "DnsSupport": "enable", "Ipv6Support": "disable" }, "Tags": [ { "Key": "Name", "Value": "attachment name" } ] } ] } ``` Para obter mais informações, consulte [Visualizar anexos da VPC](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-vpc-attachments.html#view-vpc-attachment) no *Guia de Gateways de Trânsito*. + Para ver detalhes da API, consulte [DescribeTransitGatewayVpcAttachments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-transit-gateway-vpc-attachments.html) na *Referência de comandos da AWS CLI*. ### `describe-transit-gateways` O código de exemplo a seguir mostra como usar `describe-transit-gateways`. **AWS CLI** **Descrever os gateways de trânsito** O exemplo `describe-transit-gateways` a seguir recupera detalhes dos gateways de trânsito. ``` aws ec2 describe-transit-gateways ``` Resultado: ``` { "TransitGateways": [ { "TransitGatewayId": "tgw-0262a0e521EXAMPLE", "TransitGatewayArn": "arn:aws:ec2:us-east-2:111122223333:transit-gateway/tgw-0262a0e521EXAMPLE", "State": "available", "OwnerId": "111122223333", "Description": "MyTGW", "CreationTime": "2019-07-10T14:02:12.000Z", "Options": { "AmazonSideAsn": 64516, "AutoAcceptSharedAttachments": "enable", "DefaultRouteTableAssociation": "enable", "AssociationDefaultRouteTableId": "tgw-rtb-018774adf3EXAMPLE", "DefaultRouteTablePropagation": "enable", "PropagationDefaultRouteTableId": "tgw-rtb-018774adf3EXAMPLE", "VpnEcmpSupport": "enable", "DnsSupport": "enable" }, "Tags": [] }, { "TransitGatewayId": "tgw-0fb8421e2dEXAMPLE", "TransitGatewayArn": "arn:aws:ec2:us-east-2:111122223333:transit-gateway/tgw-0fb8421e2da853bf3", "State": "available", "OwnerId": "111122223333", "CreationTime": "2019-03-15T22:57:33.000Z", "Options": { "AmazonSideAsn": 65412, "AutoAcceptSharedAttachments": "disable", "DefaultRouteTableAssociation": "enable", "AssociationDefaultRouteTableId": "tgw-rtb-06a241a3d8EXAMPLE", "DefaultRouteTablePropagation": "enable", "PropagationDefaultRouteTableId": "tgw-rtb-06a241a3d8EXAMPLE", "VpnEcmpSupport": "enable", "DnsSupport": "enable" }, "Tags": [ { "Key": "Name", "Value": "TGW1" } ] } ] } ``` + Para ver detalhes da API, consulte [DescribeTransitGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-transit-gateways.html) na *Referência de comandos da AWS CLI*. ### `describe-verified-access-endpoints` O código de exemplo a seguir mostra como usar `describe-verified-access-endpoints`. **AWS CLI** **Descrever um endpoint do acesso verificado** O exemplo `describe-verified-access-endpoints` a seguir descreve o endpoint do acesso verificado especificado. ``` aws ec2 describe-verified-access-endpoints \ --verified-access-endpoint-ids vae-066fac616d4d546f2 ``` Resultado: ``` { "VerifiedAccessEndpoints": [ { "VerifiedAccessInstanceId": "vai-0ce000c0b7643abea", "VerifiedAccessGroupId": "vagr-0dbe967baf14b7235", "VerifiedAccessEndpointId": "vae-066fac616d4d546f2", "ApplicationDomain": "example.com", "EndpointType": "network-interface", "AttachmentType": "vpc", "DomainCertificateArn": "arn:aws:acm:us-east-2:123456789012:certificate/eb065ea0-26f9-4e75-a6ce-0a1a7EXAMPLE", "EndpointDomain": "my-ava-app.edge-00c3372d53b1540bb.vai-0ce000c0b7643abea.prod.verified-access.us-east-2.amazonaws.com", "SecurityGroupIds": [ "sg-004915970c4c8f13a" ], "NetworkInterfaceOptions": { "NetworkInterfaceId": "eni-0aec70418c8d87a0f", "Protocol": "https", "Port": 443 }, "Status": { "Code": "active" }, "Description": "", "CreationTime": "2023-08-25T20:54:43", "LastUpdatedTime": "2023-08-25T22:17:26", "Tags": [ { "Key": "Name", "Value": "my-va-endpoint" } ] } ] } ``` Para obter mais informações, consulte [Endpoints de acesso verificado](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-endpoints.html) no *Guia do usuário do acesso verificado da AWS*. + Para ver detalhes da API, consulte [DescribeVerifiedAccessEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-verified-access-endpoints.html) na *Referência de comandos da AWS CLI*. ### `describe-verified-access-groups` O código de exemplo a seguir mostra como usar `describe-verified-access-groups`. **AWS CLI** **Descrever um grupo do acesso verificado** O exemplo `describe-verified-access-groups` a seguir descreve o grupo especificado do acesso verificado. ``` aws ec2 describe-verified-access-groups \ --verified-access-group-ids vagr-0dbe967baf14b7235 ``` Resultado: ``` { "VerifiedAccessGroups": [ { "VerifiedAccessGroupId": "vagr-0dbe967baf14b7235", "VerifiedAccessInstanceId": "vai-0ce000c0b7643abea", "Description": "Testing Verified Access", "Owner": "123456789012", "VerifiedAccessGroupArn": "arn:aws:ec2:us-east-2:123456789012:verified-access-group/vagr-0dbe967baf14b7235", "CreationTime": "2023-08-25T19:55:19", "LastUpdatedTime": "2023-08-25T22:17:25", "Tags": [ { "Key": "Name", "Value": "my-va-group" } ] } ] } ``` Para obter mais informações, consulte [Grupos de acesso verificado](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-groups.html) no *Guia do usuário do acesso verificado da AWS*. + Para ver detalhes da API, consulte [DescribeVerifiedAccessGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-verified-access-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-verified-access-instance-logging-configurations` O código de exemplo a seguir mostra como usar `describe-verified-access-instance-logging-configurations`. **AWS CLI** **Descrever a configuração de log para uma instância do acesso verificado** O exemplo `describe-verified-access-instance-logging-configurations` a seguir descreve a configuração de log da instância especificada do acesso verificado. ``` aws ec2 describe-verified-access-instance-logging-configurations \ --verified-access-instance-ids vai-0ce000c0b7643abea ``` Resultado: ``` { "LoggingConfigurations": [ { "VerifiedAccessInstanceId": "vai-0ce000c0b7643abea", "AccessLogs": { "S3": { "Enabled": false }, "CloudWatchLogs": { "Enabled": true, "DeliveryStatus": { "Code": "success" }, "LogGroup": "my-log-group" }, "KinesisDataFirehose": { "Enabled": false }, "LogVersion": "ocsf-1.0.0-rc.2", "IncludeTrustContext": false } } ] } ``` Para obter mais informações, consulte [Logs do acesso verificado](https://docs.aws.amazon.com/verified-access/latest/ug/access-logs.html) no *Guia do usuário do acesso verificado da AWS*. + Para ver detalhes da API, consulte [DescribeVerifiedAccessInstanceLoggingConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-verified-access-instance-logging-configurations.html) na *Referência de comandos da AWS CLI*. ### `describe-verified-access-instances` O código de exemplo a seguir mostra como usar `describe-verified-access-instances`. **AWS CLI** **Descrever uma instância do acesso verificado** O exemplo `describe-verified-access-instances` a seguir descreve a instância especificada do acesso verificado. ``` aws ec2 describe-verified-access-instances \ --verified-access-instance-ids vai-0ce000c0b7643abea ``` Resultado: ``` { "VerifiedAccessInstances": [ { "VerifiedAccessInstanceId": "vai-0ce000c0b7643abea", "Description": "Testing Verified Access", "VerifiedAccessTrustProviders": [ { "VerifiedAccessTrustProviderId": "vatp-0bb32de759a3e19e7", "TrustProviderType": "user", "UserTrustProviderType": "iam-identity-center" } ], "CreationTime": "2023-08-25T18:27:56", "LastUpdatedTime": "2023-08-25T19:03:32", "Tags": [ { "Key": "Name", "Value": "my-ava-instance" } ] } ] } ``` Para obter mais informações, consulte [Instâncias de acesso verificado](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-instances.html) no *Guia do usuário do acesso verificado da AWS*. + Para ver detalhes da API, consulte [DescribeVerifiedAccessInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-verified-access-instances.html) na *Referência de comandos da AWS CLI*. ### `describe-verified-access-trust-providers` O código de exemplo a seguir mostra como usar `describe-verified-access-trust-providers`. **AWS CLI** **Descrever um provedor confiável de acesso verificado** O exemplo `describe-verified-access-trust-providers` a seguir descreve o provedor de confiança especificado do acesso verificado. ``` aws ec2 describe-verified-access-trust-providers \ --verified-access-trust-provider-ids vatp-0bb32de759a3e19e7 ``` Resultado: ``` { "VerifiedAccessTrustProviders": [ { "VerifiedAccessTrustProviderId": "vatp-0bb32de759a3e19e7", "Description": "Testing Verified Access", "TrustProviderType": "user", "UserTrustProviderType": "iam-identity-center", "PolicyReferenceName": "idc", "CreationTime": "2023-08-25T19:00:38", "LastUpdatedTime": "2023-08-25T19:03:32", "Tags": [ { "Key": "Name", "Value": "my-va-trust-provider" } ] } ] } ``` Para obter mais informações, consulte [Provedores confiáveis para acesso verificado](https://docs.aws.amazon.com/verified-access/latest/ug/trust-providers.html) no *Guia do usuário de acesso verificado da AWS*. + Para ver detalhes da API, consulte [DescribeVerifiedAccessTrustProviders](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-verified-access-trust-providers.html) na *Referência de comandos da AWS CLI*. ### `describe-volume-attribute` O código de exemplo a seguir mostra como usar `describe-volume-attribute`. **AWS CLI** **Descrever um atributo de volume** Este exemplo de comando descreve o atributo `autoEnableIo` do volume com o ID `vol-049df61146c4d7901`. Comando: ``` aws ec2 describe-volume-attribute --volume-id vol-049df61146c4d7901 --attribute autoEnableIO ``` Resultado: ``` { "AutoEnableIO": { "Value": false }, "VolumeId": "vol-049df61146c4d7901" } ``` + Para ver detalhes da API, consulte [DescribeVolumeAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-volume-attribute.html) na *Referência de comandos da AWS CLI*. ### `describe-volume-status` O código de exemplo a seguir mostra como usar `describe-volume-status`. **AWS CLI** **Descrever o status de um único volume** Este exemplo de comando descreve o status do volume `vol-1234567890abcdef0`. Comando: ``` aws ec2 describe-volume-status --volume-ids vol-1234567890abcdef0 ``` Resultado: ``` { "VolumeStatuses": [ { "VolumeStatus": { "Status": "ok", "Details": [ { "Status": "passed", "Name": "io-enabled" }, { "Status": "not-applicable", "Name": "io-performance" } ] }, "AvailabilityZone": "us-east-1a", "VolumeId": "vol-1234567890abcdef0", "Actions": [], "Events": [] } ] } ``` **Descrever o status dos volumes danificados** Este exemplo de comando descreve o status de todos os volumes que estão danificados. Neste exemplo de saída, não há volumes comprometidos. Comando: ``` aws ec2 describe-volume-status --filters Name=volume-status.status,Values=impaired ``` Resultado: ``` { "VolumeStatuses": [] } ``` Se você tiver um volume com um status de falha em uma verificação de status (o status é comprometido), consulte Trabalhar com um volume comprometido no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [DescribeVolumeStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-volume-status.html) na *Referência de comandos da AWS CLI*. ### `describe-volumes-modifications` O código de exemplo a seguir mostra como usar `describe-volumes-modifications`. **AWS CLI** **Descrever o status de modificação de um volume** O exemplo `describe-volumes-modifications` a seguir descreve o status de modificação do volume especificado. ``` aws ec2 describe-volumes-modifications \ --volume-ids vol-1234567890abcdef0 ``` Resultado: ``` { "VolumeModification": { "TargetSize": 150, "TargetVolumeType": "io1", "ModificationState": "optimizing", "VolumeId": " vol-1234567890abcdef0", "TargetIops": 100, "StartTime": "2019-05-17T11:27:19.000Z", "Progress": 70, "OriginalVolumeType": "io1", "OriginalIops": 100, "OriginalSize": 100 } } ``` + Para ver detalhes da API, consulte [DescribeVolumesModifications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-volumes-modifications.html) na *Referência de comandos da AWS CLI*. ### `describe-volumes` O código de exemplo a seguir mostra como usar `describe-volumes`. **AWS CLI** **Exemplo 1: descrever um volume** O exemplo `describe-volumes` a seguir descreve os volumes especificados na região atual. ``` aws ec2 describe-volumes \ --volume-ids vol-049df61146c4d7901 vol-1234567890abcdef0 ``` Resultado: ``` { "Volumes": [ { "AvailabilityZone": "us-east-1a", "Attachments": [ { "AttachTime": "2013-12-18T22:35:00.000Z", "InstanceId": "i-1234567890abcdef0", "VolumeId": "vol-049df61146c4d7901", "State": "attached", "DeleteOnTermination": true, "Device": "/dev/sda1" } ], "Encrypted": true, "KmsKeyId": "arn:aws:kms:us-east-2a:123456789012:key/8c5b2c63-b9bc-45a3-a87a-5513eEXAMPLE, "VolumeType": "gp2", "VolumeId": "vol-049df61146c4d7901", "State": "in-use", "Iops": 100, "SnapshotId": "snap-1234567890abcdef0", "CreateTime": "2019-12-18T22:35:00.084Z", "Size": 8 }, { "AvailabilityZone": "us-east-1a", "Attachments": [], "Encrypted": false, "VolumeType": "gp2", "VolumeId": "vol-1234567890abcdef0", "State": "available", "Iops": 300, "SnapshotId": "", "CreateTime": "2020-02-27T00:02:41.791Z", "Size": 100 } ] } ``` **Exemplo 2: descrever volumes anexados a uma instância específica** O exemplo `describe-volumes` a seguir descreve todos os volumes anexados à instância especificada e definidos para serem excluídos quando a instância for encerrada. ``` aws ec2 describe-volumes \ --region us-east-1 \ --filters Name=attachment.instance-id,Values=i-1234567890abcdef0 Name=attachment.delete-on-termination,Values=true ``` Para obter um exemplo da saída de `describe-volumes`, consulte o Exemplo 1. **Exemplo 3: descrever os volumes disponíveis em uma Zona de Disponibilidade específica** O exemplo `describe-volumes` a seguir descreve todos os volumes que têm um status `available` e estão na Zona de Disponibilidade especificada. ``` aws ec2 describe-volumes \ --filters Name=status,Values=available Name=availability-zone,Values=us-east-1a ``` Para obter um exemplo da saída de `describe-volumes`, consulte o Exemplo 1. **Exemplo 4: descrever volumes com base em tags** O exemplo `describe-volumes` a seguir descreve todos os volumes que têm a chave de tag `Name` e um valor que começa com `Test`. A saída é, então, filtrada com uma consulta que exibe somente as tags e IDs dos volumes. ``` aws ec2 describe-volumes \ --filters Name=tag:Name,Values=Test* \ --query "Volumes[*].{ID:VolumeId,Tag:Tags}" ``` Resultado: ``` [ { "Tag": [ { "Value": "Test2", "Key": "Name" } ], "ID": "vol-1234567890abcdef0" }, { "Tag": [ { "Value": "Test1", "Key": "Name" } ], "ID": "vol-049df61146c4d7901" } ] ``` Para obter mais exemplos do uso de filtros de tags, consulte [Trabalhando com tags](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#Using_Tags_CLI) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [DescribeVolumes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-volumes.html) na *Referência de comandos da AWS CLI*. ### `describe-vpc-attribute` O código de exemplo a seguir mostra como usar `describe-vpc-attribute`. **AWS CLI** **Descrever o atributo enableDnsSupport** Este exemplo descreve o atributo `enableDnsSupport`. Esse atributo indica se a VPC conta com resolução de DNS habilitada. Se este atributo é `true`, o servidor de DNS da Amazon resolve os nomes de hosts DNS de suas instâncias para os endereços IP correspondentes; caso contrário, ele não resolve. Comando: ``` aws ec2 describe-vpc-attribute --vpc-id vpc-a01106c2 --attribute enableDnsSupport ``` Resultado: ``` { "VpcId": "vpc-a01106c2", "EnableDnsSupport": { "Value": true } } ``` **Descrever o atributo enableDnsHostnames** Este exemplo descreve o atributo `enableDnsHostnames`. Esse atributo indica se as instâncias executadas na VPC obtêm nomes de host DNS. Se esse atributo é `true`, as instâncias na VPC obtêm os nomes de hosts DNS; caso contrário, isso não ocorrerá. Comando: ``` aws ec2 describe-vpc-attribute --vpc-id vpc-a01106c2 --attribute enableDnsHostnames ``` Resultado: ``` { "VpcId": "vpc-a01106c2", "EnableDnsHostnames": { "Value": true } } ``` + Para ver detalhes da API, consulte [DescribeVpcAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpc-attribute.html) na *Referência de comandos da AWS CLI*. ### `describe-vpc-classic-link-dns-support` O código de exemplo a seguir mostra como usar `describe-vpc-classic-link-dns-support`. **AWS CLI** **Descrever o suporte de DNS do ClassicLink para as VPCs** Este exemplo descreve o status de suporte de DNS do ClassicLink de todas as VPCs. Comando: ``` aws ec2 describe-vpc-classic-link-dns-support ``` Resultado: ``` { "Vpcs": [ { "VpcId": "vpc-88888888", "ClassicLinkDnsSupported": true }, { "VpcId": "vpc-1a2b3c4d", "ClassicLinkDnsSupported": false } ] } ``` + Para ver detalhes da API, consulte [DescribeVpcClassicLinkDnsSupport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpc-classic-link-dns-support.html) na *Referência de comandos da AWS CLI*. ### `describe-vpc-classic-link` O código de exemplo a seguir mostra como usar `describe-vpc-classic-link`. **AWS CLI** **Descrever o status do ClassicLink das VPCs** Este exemplo lista o status do ClassicLink de vpc-88888888. Comando: ``` aws ec2 describe-vpc-classic-link --vpc-id vpc-88888888 ``` Resultado: ``` { "Vpcs": [ { "ClassicLinkEnabled": true, "VpcId": "vpc-88888888", "Tags": [ { "Value": "classiclinkvpc", "Key": "Name" } ] } ] } ``` Este exemplo lista somente VPCs habilitadas para o Classiclink (o valor do filtro `is-classic-link-enabled` está definido como `true`). Comando: ``` aws ec2 describe-vpc-classic-link --filter "Name=is-classic-link-enabled,Values=true" ``` + Para ver detalhes da API, consulte [DescribeVpcClassicLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpc-classic-link.html) na *Referência de comandos da AWS CLI*. ### `describe-vpc-endpoint-associations` O código de exemplo a seguir mostra como usar `describe-vpc-endpoint-associations`. **AWS CLI** **Como descrever associações de endpoint da VPC** O exemplo de `describe-vpc-endpoint-associations` a seguir descreve as associações de endpoint da VPC. ``` aws ec2 describe-vpc-endpoint-associations ``` Resultado: ``` { "VpcEndpointAssociations": [ { "Id": "vpce-rsc-asc-0a810ca6ac8866bf9", "VpcEndpointId": "vpce-019b90d6f16d4f958", "AssociatedResourceAccessibility": "Accessible", "DnsEntry": { "DnsName": "vpce-019b90d6f16d4f958.rcfg-07129f3acded87625.4232ccc.vpc-lattice-rsc.us-east-2.on.aws", "HostedZoneId": "Z03265862FOUNWMZOKUF4" }, "AssociatedResourceArn": "arn:aws:vpc-lattice:us-east-1:123456789012:resourceconfiguration/rcfg-07129f3acded87625" } ] } ``` Consulte mais informações em [Manage VPC endpoint associations](https://docs.aws.amazon.com/vpc/latest/privatelink/resource-configuration-associations.html#resource-config-manage-ep-association) no *Guia do usuário do AWS PrivateLink*. + Consulte detalhes da API em [DescribeVpcEndpointAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpc-endpoint-associations.html) na *Referência de comandos da AWS CLI*. ### `describe-vpc-endpoint-connection-notifications` O código de exemplo a seguir mostra como usar `describe-vpc-endpoint-connection-notifications`. **AWS CLI** **Descrever as notificações de conexão do endpoint** O exemplo `describe-vpc-endpoint-connection-notifications` a seguir descreve todas as notificações de conexão de endpoint. ``` aws ec2 describe-vpc-endpoint-connection-notifications ``` Resultado: ``` { "ConnectionNotificationSet": [ { "ConnectionNotificationState": "Enabled", "ConnectionNotificationType": "Topic", "ConnectionEvents": [ "Accept", "Reject", "Delete", "Connect" ], "ConnectionNotificationId": "vpce-nfn-04bcb952bc8af7abc", "ConnectionNotificationArn": "arn:aws:sns:us-east-1:123456789012:VpceNotification", "VpcEndpointId": "vpce-0324151a02f327123" } ] } ``` + Para ver detalhes da API, consulte [DescribeVpcEndpointConnectionNotifications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpc-endpoint-connection-notifications.html) na *Referência de comandos da AWS CLI*. ### `describe-vpc-endpoint-connections` O código de exemplo a seguir mostra como usar `describe-vpc-endpoint-connections`. **AWS CLI** **Descrever as conexões de endpoint da VPC** Este exemplo descreve as conexões do endpoint da interface com seu serviço de endpoint e filtra os resultados para exibir os endpoints que estão `PendingAcceptance`. Comando: ``` aws ec2 describe-vpc-endpoint-connections --filters Name=vpc-endpoint-state,Values=pendingAcceptance ``` Resultado: ``` { "VpcEndpointConnections": [ { "VpcEndpointId": "vpce-0abed31004e618123", "ServiceId": "vpce-svc-0abced088d20def56", "CreationTimestamp": "2017-11-30T10:00:24.350Z", "VpcEndpointState": "pendingAcceptance", "VpcEndpointOwner": "123456789012" } ] } ``` + Para ver detalhes da API, consulte [DescribeVpcEndpointConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpc-endpoint-connections.html) na *Referência de comandos da AWS CLI*. ### `describe-vpc-endpoint-service-configurations` O código de exemplo a seguir mostra como usar `describe-vpc-endpoint-service-configurations`. **AWS CLI** **Descrever configurações de serviço de endpoint** O exemplo `describe-vpc-endpoint-service-configurations` a seguir descreve suas configurações de serviço de endpoint. ``` aws ec2 describe-vpc-endpoint-service-configurations ``` Resultado: ``` { "ServiceConfigurations": [ { "ServiceType": [ { "ServiceType": "GatewayLoadBalancer" } ], "ServiceId": "vpce-svc-012d33a1c4321cabc", "ServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-012d33a1c4321cabc", "ServiceState": "Available", "AvailabilityZones": [ "us-east-1d" ], "AcceptanceRequired": false, "ManagesVpcEndpoints": false, "GatewayLoadBalancerArns": [ "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/gwy/GWLBService/123210844e429123" ], "Tags": [] }, { "ServiceType": [ { "ServiceType": "Interface" } ], "ServiceId": "vpce-svc-123cabc125efa123", "ServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-123cabc125efa123", "ServiceState": "Available", "AvailabilityZones": [ "us-east-1a" ], "AcceptanceRequired": true, "ManagesVpcEndpoints": false, "NetworkLoadBalancerArns": [ "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/NLBforService/1238753950b25123" ], "BaseEndpointDnsNames": [ "vpce-svc-123cabc125efa123.us-east-1.vpce.amazonaws.com" ], "PrivateDnsName": "example.com", "PrivateDnsNameConfiguration": { "State": "failed", "Type": "TXT", "Value": "vpce:qUAth3FdeABCApUiXabc", "Name": "_1d367jvbg34znqvyefrj" }, "Tags": [] } ] } ``` Consulte mais informações em [Concepts](https://docs.aws.amazon.com/vpc/latest/privatelink/concepts.html) no *Guia do usuário do AWS PrivateLink*. + Para ver detalhes da API, consulte [DescribeVpcEndpointServiceConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpc-endpoint-service-configurations.html) na *Referência de comandos da AWS CLI*. ### `describe-vpc-endpoint-service-permissions` O código de exemplo a seguir mostra como usar `describe-vpc-endpoint-service-permissions`. **AWS CLI** **Descrever as permissões do serviço de endpoint** Este exemplo descreve as permissões para o serviço de endpoint especificado. Comando: ``` aws ec2 describe-vpc-endpoint-service-permissions --service-id vpce-svc-03d5ebb7d9579a2b3 ``` Resultado: ``` { "AllowedPrincipals": [ { "PrincipalType": "Account", "Principal": "arn:aws:iam::123456789012:root" } ] } ``` + Para ver detalhes da API, consulte [DescribeVpcEndpointServicePermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpc-endpoint-service-permissions.html) na *Referência de comandos da AWS CLI*. ### `describe-vpc-endpoint-services` O código de exemplo a seguir mostra como usar `describe-vpc-endpoint-services`. **AWS CLI** **Exemplo 1: descrever todos os serviços de endpoint da VPC** O exemplo de `describe-vpc-endpoint-services` a seguir lista todos os serviços de endpoint da VPC de uma região da AWS. ``` aws ec2 describe-vpc-endpoint-services ``` Resultado: ``` { "ServiceDetails": [ { "ServiceType": [ { "ServiceType": "Gateway" } ], "AcceptanceRequired": false, "ServiceName": "com.amazonaws.us-east-1.dynamodb", "VpcEndpointPolicySupported": true, "Owner": "amazon", "AvailabilityZones": [ "us-east-1a", "us-east-1b", "us-east-1c", "us-east-1d", "us-east-1e", "us-east-1f" ], "BaseEndpointDnsNames": [ "dynamodb.us-east-1.amazonaws.com" ] }, { "ServiceType": [ { "ServiceType": "Interface" } ], "PrivateDnsName": "ec2.us-east-1.amazonaws.com", "ServiceName": "com.amazonaws.us-east-1.ec2", "VpcEndpointPolicySupported": false, "Owner": "amazon", "AvailabilityZones": [ "us-east-1a", "us-east-1b", "us-east-1c", "us-east-1d", "us-east-1e", "us-east-1f" ], "AcceptanceRequired": false, "BaseEndpointDnsNames": [ "ec2.us-east-1.vpce.amazonaws.com" ] }, { "ServiceType": [ { "ServiceType": "Interface" } ], "PrivateDnsName": "ssm.us-east-1.amazonaws.com", "ServiceName": "com.amazonaws.us-east-1.ssm", "VpcEndpointPolicySupported": true, "Owner": "amazon", "AvailabilityZones": [ "us-east-1a", "us-east-1b", "us-east-1c", "us-east-1d", "us-east-1e" ], "AcceptanceRequired": false, "BaseEndpointDnsNames": [ "ssm.us-east-1.vpce.amazonaws.com" ] } ], "ServiceNames": [ "com.amazonaws.us-east-1.dynamodb", "com.amazonaws.us-east-1.ec2", "com.amazonaws.us-east-1.ec2messages", "com.amazonaws.us-east-1.elasticloadbalancing", "com.amazonaws.us-east-1.kinesis-streams", "com.amazonaws.us-east-1.s3", "com.amazonaws.us-east-1.ssm" ] } ``` **Exemplo 2: descrever os detalhes sobre um serviço de endpoint** O exemplo de `describe-vpc-endpoint-services` a seguir lista os detalhes do serviço de endpoint da interface do Amazon S3. ``` aws ec2 describe-vpc-endpoint-services \ --filter 'Name=service-type,Values=Interface' Name=service-name,Values=com.amazonaws.us-east-1.s3 ``` Resultado: ``` { "ServiceDetails": [ { "ServiceName": "com.amazonaws.us-east-1.s3", "ServiceId": "vpce-svc-081d84efcdEXAMPLE", "ServiceType": [ { "ServiceType": "Interface" } ], "AvailabilityZones": [ "us-east-1a", "us-east-1b", "us-east-1c", "us-east-1d", "us-east-1e", "us-east-1f" ], "Owner": "amazon", "BaseEndpointDnsNames": [ "s3.us-east-1.vpce.amazonaws.com" ], "VpcEndpointPolicySupported": true, "AcceptanceRequired": false, "ManagesVpcEndpoints": false, "Tags": [] } ], "ServiceNames": [ "com.amazonaws.us-east-1.s3" ] } ``` Consulte mais informações em [View available AWS service names](https://docs.aws.amazon.com/vpc/latest/privatelink/aws-services-privatelink-support.html#vpce-view-available-services) no *Guia do Usuário do AWS PrivateLink*. + Para ver detalhes da API, consulte [DescribeVpcEndpointServices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpc-endpoint-services.html) na *Referência de comandos da AWS CLI*. ### `describe-vpc-endpoints` O código de exemplo a seguir mostra como usar `describe-vpc-endpoints`. **AWS CLI** **Descrever seus endpoint da VPC** O exemplo `describe-vpc-endpoints` a seguir exibe detalhes de todos os seus endpoints da VPC. ``` aws ec2 describe-vpc-endpoints ``` Resultado: ``` { "VpcEndpoints": [ { "PolicyDocument": "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":\"*\",\"Action\":\"*\",\"Resource\":\"*\"}]}", "VpcId": "vpc-aabb1122", "NetworkInterfaceIds": [], "SubnetIds": [], "PrivateDnsEnabled": true, "State": "available", "ServiceName": "com.amazonaws.us-east-1.dynamodb", "RouteTableIds": [ "rtb-3d560345" ], "Groups": [], "VpcEndpointId": "vpce-032a826a", "VpcEndpointType": "Gateway", "CreationTimestamp": "2017-09-05T20:41:28Z", "DnsEntries": [], "OwnerId": "123456789012" }, { "PolicyDocument": "{\n \"Statement\": [\n {\n \"Action\": \"*\", \n \"Effect\": \"Allow\", \n \"Principal\": \"*\", \n \"Resource\": \"*\"\n }\n ]\n}", "VpcId": "vpc-1a2b3c4d", "NetworkInterfaceIds": [ "eni-2ec2b084", "eni-1b4a65cf" ], "SubnetIds": [ "subnet-d6fcaa8d", "subnet-7b16de0c" ], "PrivateDnsEnabled": false, "State": "available", "ServiceName": "com.amazonaws.us-east-1.elasticloadbalancing", "RouteTableIds": [], "Groups": [ { "GroupName": "default", "GroupId": "sg-54e8bf31" } ], "VpcEndpointId": "vpce-0f89a33420c1931d7", "VpcEndpointType": "Interface", "CreationTimestamp": "2017-09-05T17:55:27.583Z", "DnsEntries": [ { "HostedZoneId": "Z7HUB22UULQXV", "DnsName": "vpce-0f89a33420c1931d7-bluzidnv.elasticloadbalancing.us-east-1.vpce.amazonaws.com" }, { "HostedZoneId": "Z7HUB22UULQXV", "DnsName": "vpce-0f89a33420c1931d7-bluzidnv-us-east-1b.elasticloadbalancing.us-east-1.vpce.amazonaws.com" }, { "HostedZoneId": "Z7HUB22UULQXV", "DnsName": "vpce-0f89a33420c1931d7-bluzidnv-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com" } ], "OwnerId": "123456789012" }, { "VpcEndpointId": "vpce-aabbaabbaabbaabba", "VpcEndpointType": "GatewayLoadBalancer", "VpcId": "vpc-111122223333aabbc", "ServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-123123a1c43abc123", "State": "available", "SubnetIds": [ "subnet-0011aabbcc2233445" ], "RequesterManaged": false, "NetworkInterfaceIds": [ "eni-01010120203030405" ], "CreationTimestamp": "2020-11-11T08:06:03.522Z", "Tags": [], "OwnerId": "123456789012" } ] } ``` Consulte mais informações em [Concepts](https://docs.aws.amazon.com/vpc/latest/privatelink/concepts.html) no *Guia do usuário do AWS PrivateLink*. + Para ver detalhes da API, consulte [DescribeVpcEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpc-endpoints.html) na *Referência de comandos da AWS CLI*. ### `describe-vpc-peering-connections` O código de exemplo a seguir mostra como usar `describe-vpc-peering-connections`. **AWS CLI** **Descrever as conexões de emparelhamento da VPC** Este exemplo descreve todas as conexões de emparelhamento da VPC. Comando: ``` aws ec2 describe-vpc-peering-connections ``` Resultado: ``` { "VpcPeeringConnections": [ { "Status": { "Message": "Active", "Code": "active" }, "Tags": [ { "Value": "Peering-1", "Key": "Name" } ], "AccepterVpcInfo": { "OwnerId": "111122223333", "VpcId": "vpc-1a2b3c4d", "CidrBlock": "10.0.1.0/28" }, "VpcPeeringConnectionId": "pcx-11122233", "RequesterVpcInfo": { "PeeringOptions": { "AllowEgressFromLocalVpcToRemoteClassicLink": false, "AllowEgressFromLocalClassicLinkToRemoteVpc": false }, "OwnerId": "444455556666", "VpcId": "vpc-123abc45", "CidrBlock": "192.168.0.0/16" } }, { "Status": { "Message": "Pending Acceptance by 444455556666", "Code": "pending-acceptance" }, "Tags": [], "RequesterVpcInfo": { "PeeringOptions": { "AllowEgressFromLocalVpcToRemoteClassicLink": false, "AllowEgressFromLocalClassicLinkToRemoteVpc": false }, "OwnerId": "444455556666", "VpcId": "vpc-11aa22bb", "CidrBlock": "10.0.0.0/28" }, "VpcPeeringConnectionId": "pcx-abababab", "ExpirationTime": "2014-04-03T09:12:43.000Z", "AccepterVpcInfo": { "OwnerId": "444455556666", "VpcId": "vpc-33cc44dd" } } ] } ``` **Descrever conexões específicas de emparelhamento da VPC** Este exemplo descreve todas as conexões de emparelhamento da VPC que estão no estado de aceitação pendente. Comando: ``` aws ec2 describe-vpc-peering-connections --filters Name=status-code,Values=pending-acceptance ``` Este exemplo descreve todas as conexões de emparelhamento da VPC que têm a tag Owner=Finance. Comando: ``` aws ec2 describe-vpc-peering-connections --filters Name=tag:Owner,Values=Finance ``` Este exemplo descreve todas as conexões de emparelhamento da VPC que você solicitou para a VPC especificada, vpc-1a2b3c4d. Comando: ``` aws ec2 describe-vpc-peering-connections --filters Name=requester-vpc-info.vpc-id,Values=vpc-1a2b3c4d ``` + Para ver detalhes da API, consulte [DescribeVpcPeeringConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpc-peering-connections.html) na *Referência de comandos da AWS CLI*. ### `describe-vpcs` O código de exemplo a seguir mostra como usar `describe-vpcs`. **AWS CLI** **Exemplo 1: descrever todas as suas VPCs** O exemplo `describe-vpcs` a seguir recupera detalhes das suas VPCs. ``` aws ec2 describe-vpcs ``` Resultado: ``` { "Vpcs": [ { "CidrBlock": "30.1.0.0/16", "DhcpOptionsId": "dopt-19edf471", "State": "available", "VpcId": "vpc-0e9801d129EXAMPLE", "OwnerId": "111122223333", "InstanceTenancy": "default", "CidrBlockAssociationSet": [ { "AssociationId": "vpc-cidr-assoc-062c64cfafEXAMPLE", "CidrBlock": "30.1.0.0/16", "CidrBlockState": { "State": "associated" } } ], "IsDefault": false, "Tags": [ { "Key": "Name", "Value": "Not Shared" } ] }, { "CidrBlock": "10.0.0.0/16", "DhcpOptionsId": "dopt-19edf471", "State": "available", "VpcId": "vpc-06e4ab6c6cEXAMPLE", "OwnerId": "222222222222", "InstanceTenancy": "default", "CidrBlockAssociationSet": [ { "AssociationId": "vpc-cidr-assoc-00b17b4eddEXAMPLE", "CidrBlock": "10.0.0.0/16", "CidrBlockState": { "State": "associated" } } ], "IsDefault": false, "Tags": [ { "Key": "Name", "Value": "Shared VPC" } ] } ] } ``` **Exemplo 2: descrever uma VPC especificada** O exemplo de `describe-vpcs` a seguir recupera detalhes da VPC especificada. ``` aws ec2 describe-vpcs \ --vpc-ids vpc-06e4ab6c6cEXAMPLE ``` Resultado: ``` { "Vpcs": [ { "CidrBlock": "10.0.0.0/16", "DhcpOptionsId": "dopt-19edf471", "State": "available", "VpcId": "vpc-06e4ab6c6cEXAMPLE", "OwnerId": "111122223333", "InstanceTenancy": "default", "CidrBlockAssociationSet": [ { "AssociationId": "vpc-cidr-assoc-00b17b4eddEXAMPLE", "CidrBlock": "10.0.0.0/16", "CidrBlockState": { "State": "associated" } } ], "IsDefault": false, "Tags": [ { "Key": "Name", "Value": "Shared VPC" } ] } ] } ``` + Consulte detalhes da API em [DescribeVpcs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpcs.html) na *Referência de comandos da AWS CLI*. ### `describe-vpn-connections` O código de exemplo a seguir mostra como usar `describe-vpn-connections`. **AWS CLI** **Exemplo 1: descrever as conexões VPN** O exemplo `describe-vpn-connections` a seguir descreve todas as conexões da VPN Site-to-Site. ``` aws ec2 describe-vpn-connections ``` Resultado: ``` { "VpnConnections": [ { "CustomerGatewayConfiguration": "...configuration information...", "CustomerGatewayId": "cgw-01234567abcde1234", "Category": "VPN", "State": "available", "Type": "ipsec.1", "VpnConnectionId": "vpn-1122334455aabbccd", "TransitGatewayId": "tgw-00112233445566aab", "Options": { "EnableAcceleration": false, "StaticRoutesOnly": true, "LocalIpv4NetworkCidr": "0.0.0.0/0", "RemoteIpv4NetworkCidr": "0.0.0.0/0", "TunnelInsideIpVersion": "ipv4" }, "Routes": [], "Tags": [ { "Key": "Name", "Value": "CanadaVPN" } ], "VgwTelemetry": [ { "AcceptedRouteCount": 0, "LastStatusChange": "2020-07-29T10:35:11.000Z", "OutsideIpAddress": "203.0.113.3", "Status": "DOWN", "StatusMessage": "" }, { "AcceptedRouteCount": 0, "LastStatusChange": "2020-09-02T09:09:33.000Z", "OutsideIpAddress": "203.0.113.5", "Status": "UP", "StatusMessage": "" } ] } ] } ``` Para obter mais informações, consulte [Funcionamento do AWS Site-to-Site VPN](https://docs.aws.amazon.com/vpn/latest/s2svpn/how_it_works.html) no *Guia do usuário do AWS Site-to-Site VPN*. **Exemplo 2: descrever as conexões VPN disponíveis** O exemplo `describe-vpn-connections` a seguir descreve as conexões da VPN Site-to-Site com um estado `available`. ``` aws ec2 describe-vpn-connections \ --filters "Name=state,Values=available" ``` Para obter mais informações, consulte [Funcionamento do AWS Site-to-Site VPN](https://docs.aws.amazon.com/vpn/latest/s2svpn/how_it_works.html) no *Guia do usuário do AWS Site-to-Site VPN*. + Para ver detalhes da API, consulte [DescribeVpnConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpn-connections.html) na *Referência de comandos da AWS CLI*. ### `describe-vpn-gateways` O código de exemplo a seguir mostra como usar `describe-vpn-gateways`. **AWS CLI** **Descrever seus gateways privados virtuais** Este exemplo descreve seus gateways privados virtuais. Comando: ``` aws ec2 describe-vpn-gateways ``` Resultado: ``` { "VpnGateways": [ { "State": "available", "Type": "ipsec.1", "VpnGatewayId": "vgw-f211f09b", "VpcAttachments": [ { "State": "attached", "VpcId": "vpc-98eb5ef5" } ] }, { "State": "available", "Type": "ipsec.1", "VpnGatewayId": "vgw-9a4cacf3", "VpcAttachments": [ { "State": "attaching", "VpcId": "vpc-a01106c2" } ] } ] } ``` + Para ver detalhes da API, consulte [DescribeVpnGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpn-gateways.html) na *Referência de comandos da AWS CLI*. ### `detach-classic-link-vpc` O código de exemplo a seguir mostra como usar `detach-classic-link-vpc`. **AWS CLI** **Desvincular (desanexar) uma instância do EC2-Classic de uma VPC** Este exemplo desvincula a instância i-0598c7d356eba48d7 da VPC vpc-88888888. Comando: ``` aws ec2 detach-classic-link-vpc --instance-id i-0598c7d356eba48d7 --vpc-id vpc-88888888 ``` Resultado: ``` { "Return": true } ``` + Para ver detalhes da API, consulte [DetachClassicLinkVpc](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/detach-classic-link-vpc.html) na *Referência de comandos da AWS CLI*. ### `detach-internet-gateway` O código de exemplo a seguir mostra como usar `detach-internet-gateway`. **AWS CLI** **Separar um gateway da Internet da VPC** O exemplo `detach-internet-gateway` a seguir separa o gateway da internet especificado da VPC específica. ``` aws ec2 detach-internet-gateway \ --internet-gateway-id igw-0d0fb496b3EXAMPLE \ --vpc-id vpc-0a60eb65b4EXAMPLE ``` Este comando não produz saída. Para obter mais informações, consulte [Gateways da Internet](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html) no *Guia do usuário da Amazon VPC*. + Para ver detalhes da API, consulte [DetachInternetGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/detach-internet-gateway.html) na *Referência de comandos da AWS CLI*. ### `detach-network-interface` O código de exemplo a seguir mostra como usar `detach-network-interface`. **AWS CLI** **Desanexar uma interface de rede de uma instância** Este exemplo desvincula a interface de rede especificada da instância especificada. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 detach-network-interface --attachment-id eni-attach-66c4350a ``` + Para ver detalhes da API, consulte [DetachNetworkInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/detach-network-interface.html) na *Referência de comandos da AWS CLI*. ### `detach-verified-access-trust-provider` O código de exemplo a seguir mostra como usar `detach-verified-access-trust-provider`. **AWS CLI** **Desanexar um provedor de confiança de uma instância** O exemplo `detach-verified-access-trust-provider` a seguir desvincula o provedor confiável de acesso verificado especificado da instância de acesso verificado especificada. ``` aws ec2 detach-verified-access-trust-provider \ --verified-access-instance-id vai-0ce000c0b7643abea \ --verified-access-trust-provider-id vatp-0bb32de759a3e19e7 ``` Resultado: ``` { "VerifiedAccessTrustProvider": { "VerifiedAccessTrustProviderId": "vatp-0bb32de759a3e19e7", "Description": "Testing Verified Access", "TrustProviderType": "user", "UserTrustProviderType": "iam-identity-center", "PolicyReferenceName": "idc", "CreationTime": "2023-08-25T19:00:38", "LastUpdatedTime": "2023-08-25T19:00:38" }, "VerifiedAccessInstance": { "VerifiedAccessInstanceId": "vai-0ce000c0b7643abea", "Description": "Testing Verified Access", "VerifiedAccessTrustProviders": [], "CreationTime": "2023-08-25T18:27:56", "LastUpdatedTime": "2023-08-25T18:27:56" } } ``` Para obter mais informações, consulte [Instâncias de acesso verificado](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-instances.html) no *Guia do usuário do acesso verificado da AWS*. + Para ver detalhes da API, consulte [DetachVerifiedAccessTrustProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/detach-verified-access-trust-provider.html) na *Referência de comandos da AWS CLI*. ### `detach-volume` O código de exemplo a seguir mostra como usar `detach-volume`. **AWS CLI** **Desanexar um volume de uma instância** Este exemplo de comando separa o volume (`vol-049df61146c4d7901`) da instância à qual ele está conectado. Comando: ``` aws ec2 detach-volume --volume-id vol-1234567890abcdef0 ``` Resultado: ``` { "AttachTime": "2014-02-27T19:23:06.000Z", "InstanceId": "i-1234567890abcdef0", "VolumeId": "vol-049df61146c4d7901", "State": "detaching", "Device": "/dev/sdb" } ``` + Para ver detalhes da API, consulte [DetachVolume](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/detach-volume.html) na *Referência de comandos da AWS CLI*. ### `detach-vpn-gateway` O código de exemplo a seguir mostra como usar `detach-vpn-gateway`. **AWS CLI** **Desanexar um gateway privado virtual da VPC** Este exemplo desvincula o gateway privado virtual especificado da VPC especificada. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 detach-vpn-gateway --vpn-gateway-id vgw-9a4cacf3 --vpc-id vpc-a01106c2 ``` + Para ver detalhes da API, consulte [DetachVpnGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/detach-vpn-gateway.html) na *Referência de comandos da AWS CLI*. ### `disable-address-transfer` O código de exemplo a seguir mostra como usar `disable-address-transfer`. **AWS CLI** **Desabilitar uma transferência de endereço IP elástico** O exemplo `disable-address-transfer` a seguir desativa a transferência de endereço IP elástico para o endereço IP elástico especificado. ``` aws ec2 disable-address-transfer \ --allocation-id eipalloc-09ad461b0d03f6aaf ``` Resultado: ``` { "AddressTransfer": { "PublicIp": "100.21.184.216", "AllocationId": "eipalloc-09ad461b0d03f6aaf", "AddressTransferStatus": "disabled" } } ``` Para obter mais informações, consulte [Transferir endereços IP elásticos](https://docs.aws.amazon.com/vpc/latest/userguide/WorkWithEIPs.html#transfer-EIPs-intro) no *Guia do usuário do Amazon VPC*. + Para ver detalhes da API, consulte [DisableAddressTransfer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-address-transfer.html) na *Referência de comandos da AWS CLI*. ### `disable-aws-network-performance-metric-subscription` O código de exemplo a seguir mostra como usar `disable-aws-network-performance-metric-subscription`. **AWS CLI** **Desativar uma assinatura métrica** O exemplo `disable-aws-network-performance-metric-subscription` a seguir desativa o monitoramento da latência agregada da rede entre as regiões de origem e destino especificadas. ``` aws ec2 disable-aws-network-performance-metric-subscription \ --source us-east-1 \ --destination eu-west-1 \ --metric aggregate-latency \ --statistic p50 ``` Resultado: ``` { "Output": true } ``` Consulte mais informações em [Manage CloudWatch subscriptions using the CLI](https://docs.aws.amazon.com/network-manager/latest/infrastructure-performance/getting-started-nmip-cli.html) no *Guia do usuário de desempenho da infraestrutura*. + Para ver detalhes da API, consulte [DisableAwsNetworkPerformanceMetricSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-aws-network-performance-metric-subscription.html) na *Referência de comandos da AWS CLI*. ### `disable-ebs-encryption-by-default` O código de exemplo a seguir mostra como usar `disable-ebs-encryption-by-default`. **AWS CLI** **Desabilitar a criptografia do EBS por padrão** O exemplo `disable-ebs-encryption-by-default` a seguir desabilita a criptografia padrão EBS habilitada para sua conta AWS na Região atual. ``` aws ec2 disable-ebs-encryption-by-default ``` Resultado: ``` { "EbsEncryptionByDefault": false } ``` + Para ver detalhes da API, consulte [DisableEbsEncryptionByDefault](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-ebs-encryption-by-default.html) na *Referência de comandos da AWS CLI*. ### `disable-fast-launch` O código de exemplo a seguir mostra como usar `disable-fast-launch`. **AWS CLI** **Interromper o lançamento rápido de uma imagem** O exemplo de `disable-fast-launch` a seguir interrompe o Fast Launch na AMI especificada e apaga snapshots pré-provisionados. ``` aws ec2 disable-fast-launch \ --image-id ami-01234567890abcedf ``` Resultado: ``` { "ImageId": "ami-01234567890abcedf", "ResourceType": "snapshot", "SnapshotConfiguration": {}, "LaunchTemplate": { "LaunchTemplateId": "lt-01234567890abcedf", "LaunchTemplateName": "EC2FastLaunchDefaultResourceCreation-a8c6215d-94e6-441b-9272-dbd1f87b07e2", "Version": "1" }, "MaxParallelLaunches": 6, "OwnerId": "0123456789123", "State": "disabling", "StateTransitionReason": "Client.UserInitiated", "StateTransitionTime": "2022-01-27T22:47:29.265000+00:00" } ``` Consulte mais informações em [Configurar o EC2 Fast Launch para a AMI do Windows](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/win-fast-launch-configure.html) no *Manual do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [DisableFastLaunch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-fast-launch.html) na *Referência de comandos da AWS CLI*. ### `disable-fast-snapshot-restores` O código de exemplo a seguir mostra como usar `disable-fast-snapshot-restores`. **AWS CLI** **Desativar a restauração rápida de snapshot** O exemplo `disable-fast-snapshot-restores` a seguir desativa restaurações rápidas de snapshot para os snapshots especificados nas Zonas de Disponibilidade especificadas. ``` aws ec2 disable-fast-snapshot-restores \ --availability-zones us-east-2a \ --source-snapshot-ids snap-1234567890abcdef0 ``` Resultado: ``` { "Successful": [ { "SnapshotId": "snap-1234567890abcdef0" "AvailabilityZone": "us-east-2a", "State": "disabling", "StateTransitionReason": "Client.UserInitiated", "OwnerId": "123456789012", "EnablingTime": "2020-01-25T23:57:49.602Z" } ], "Unsuccessful": [] } ``` + Para ver detalhes da API, consulte [DisableFastSnapshotRestores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-fast-snapshot-restores.html) na *Referência de comandos da AWS CLI*. ### `disable-image-block-public-access` O código de exemplo a seguir mostra como usar `disable-image-block-public-access`. **AWS CLI** **Desabilitar o bloqueio de acesso público para AMIs na região especificada** O exemplo `disable-image-block-public-access` a seguir desabilita o bloqueio do acesso público para AMIs no nível da conta na região especificada. ``` aws ec2 disable-image-block-public-access \ --region us-east-1 ``` Resultado: ``` { "ImageBlockPublicAccessState": "unblocked" } ``` Para obter mais informações, consulte [Bloquear acesso público às AMIs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-public-access-to-amis.html) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [DisableImageBlockPublicAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-image-block-public-access.html) na *Referência de comandos da AWS CLI*. ### `disable-image-deprecation` O código de exemplo a seguir mostra como usar `disable-image-deprecation`. **AWS CLI** **Cancelar a descontinuação de uma AMI** O exemplo `disable-image-deprecation` a seguir cancela a depreciação de uma AMI, o que remove o campo `DeprecationTime` da saída `describe-images`. É necessário ser o proprietário da AMI para executar esse procedimento. ``` aws ec2 disable-image-deprecation \ --image-id ami-1234567890abcdef0 ``` Resultado: ``` { "RequestID": "11aabb229-4eac-35bd-99ed-be587EXAMPLE", "Return": "true" } ``` Consulte mais informações em [Descontinuar uma AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-deprecate.html) no *Manual do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [DisableImageDeprecation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-image-deprecation.html) na *Referência de comandos da AWS CLI*. ### `disable-image-deregistration-protection` O código de exemplo a seguir mostra como usar `disable-image-deregistration-protection`. **AWS CLI** **Como desabilitar a proteção contra cancelamento de registro** O exemplo de `disable-image-deregistration-protection` a seguir desabilita a proteção contra cancelamento de registro para a imagem especificada. ``` aws ec2 disable-image-deregistration-protection \ --image-id ami-0b1a928a144a74ec9 ``` Resultado: ``` { "Return": "disabled" } ``` Consulte mais informações em [Proteger uma AMI do Amazon EC2 de cancelamento de registro](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-deregistration-protection.html) no *Guia do usuário do Amazon EC2*. + Consulte detalhes da API em [DisableImageDeregistrationProtection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-image-deregistration-protection.html) na *Referência de comandos da AWS CLI*. ### `disable-image` O código de exemplo a seguir mostra como usar `disable-image`. **AWS CLI** **Desabilitar uma AMI** O exemplo `disable-image` a seguir desabilita a AMI especificada. ``` aws ec2 disable-image \ --image-id ami-1234567890abcdef0 ``` Resultado: ``` { "Return": "true" } ``` Para obter mais informações, consulte [Desativar uma AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/disable-an-ami.html) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [DisableImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-image.html) na *Referência de comandos da AWS CLI*. ### `disable-ipam-organization-admin-account` O código de exemplo a seguir mostra como usar `disable-ipam-organization-admin-account`. **AWS CLI** **Desativar o administrador IPAM delegado** Em determinados cenários, você integrará o IPAM com AWS Organizations. Quando você faz isso, a conta de gerenciamento da AWS Organization delega uma conta de membro da AWS Organization como administrador do IPAM. Neste exemplo, você é a conta de gerenciamento da AWS Organization que delegou a conta de administrador do IPAM e deseja desativar essa conta de ser o administrador do IPAM. Você pode usar qualquer região da AWS para `--region` ao fazer essa solicitação. Você não precisa usar a região na qual delegou originalmente o administrador, onde o IPAM foi criado ou uma região operacional do IPAM. Se você desativar a conta de administrador delegado, poderá reativá-la a qualquer momento ou delegar uma nova conta como administrador do IPAM. O exemplo `disable-ipam-organization-admin-account` a seguir desativa o administrador IPAM delegado em sua conta da AWS. ``` aws ec2 disable-ipam-organization-admin-account \ --delegated-admin-account-id 320805250157 \ --region ap-south-1 ``` Resultado: ``` { "Success": true } ``` Para obter mais informações, consulte [Integrar o IPAM a contas em uma organização da AWS Organizations](https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam.html) no *Guia do usuário do Amazon VPC IPAM*. + Para ver detalhes da API, consulte [DisableIpamOrganizationAdminAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-ipam-organization-admin-account.html) na *Referência de comandos da AWS CLI*. ### `disable-serial-console-access` O código de exemplo a seguir mostra como usar `disable-serial-console-access`. **AWS CLI** **Desativar o acesso ao console de série do EC2 da sua conta** O exemplo `disable-serial-console-access` a seguir desabilita o acesso da conta ao console de série. ``` aws ec2 disable-serial-console-access ``` Resultado: ``` { "SerialConsoleAccessEnabled": false } ``` Para obter mais informações, consulte [Console de Série do EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-serial-console.html) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [DisableSerialConsoleAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-serial-console-access.html) na *Referência de comandos da AWS CLI*. ### `disable-snapshot-block-public-access` O código de exemplo a seguir mostra como usar `disable-snapshot-block-public-access`. **AWS CLI** **Desabilitar o bloqueio do acesso público aos snapshots** O exemplo `disable-snapshot-block-public-access` a seguir desabilita o bloqueio do acesso público aos snapshots para permitir o compartilhamento público dos snapshots. ``` aws ec2 disable-snapshot-block-public-access ``` Resultado: ``` { "State": "unblocked" } ``` Para obter mais informações, consulte [Bloquear acesso público aos snapshots](https://docs.aws.amazon.com/ebs/latest/userguide/block-public-access-snapshots.html) no *Guia do usuário do Amazon EBS*. + Para ver detalhes da API, consulte [DisableSnapshotBlockPublicAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-snapshot-block-public-access.html) na *Referência de comandos da AWS CLI*. ### `disable-transit-gateway-route-table-propagation` O código de exemplo a seguir mostra como usar `disable-transit-gateway-route-table-propagation`. **AWS CLI** **Desabilitar um anexo do gateway de trânsito para propagar rotas para a tabela de rotas de propagação especificada** O exemplo `disable-transit-gateway-route-table-propagation` a seguir desativa o anexo especificado para propagar rotas para a tabela de rota de propagação especificada. ``` aws ec2 disable-transit-gateway-route-table-propagation \ --transit-gateway-route-table-id tgw-rtb-0a823edbdeEXAMPLE \ --transit-gateway-attachment-id tgw-attach-09b52ccdb5EXAMPLE ``` Resultado: ``` { "Propagation": { "TransitGatewayAttachmentId": "tgw-attach-09b52ccdb5EXAMPLE", "ResourceId": "vpc-4d7de228", "ResourceType": "vpc", "TransitGatewayRouteTableId": "tgw-rtb-0a823edbdeEXAMPLE", "State": "disabled" } } ``` Para obter mais informações, consulte [Tabelas de rota do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [DisableTransitGatewayRouteTablePropagation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-transit-gateway-route-table-propagation.html) na *Referência de comandos da AWS CLI*. ### `disable-vgw-route-propagation` O código de exemplo a seguir mostra como usar `disable-vgw-route-propagation`. **AWS CLI** **Desabilitar a propagação de rotas** Esse exemplo desabilita o gateway privado virtual especificado de propagar rotas estáticas para a tabela de rotas especificada. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 disable-vgw-route-propagation --route-table-id rtb-22574640 --gateway-id vgw-9a4cacf3 ``` + Para ver detalhes da API, consulte [DisableVgwRoutePropagation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-vgw-route-propagation.html) na *Referência de comandos da AWS CLI*. ### `disable-vpc-classic-link-dns-support` O código de exemplo a seguir mostra como usar `disable-vpc-classic-link-dns-support`. **AWS CLI** **Desabilitar o suporte do DNS ClassicLink em uma VPC** Este exemplo desabilita o suporte do DNS ClassicLink para `vpc-88888888`. Comando: ``` aws ec2 disable-vpc-classic-link-dns-support --vpc-id vpc-88888888 ``` Resultado: ``` { "Return": true } ``` + Para ver detalhes da API, consulte [DisableVpcClassicLinkDnsSupport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-vpc-classic-link-dns-support.html) na *Referência de comandos da AWS CLI*. ### `disable-vpc-classic-link` O código de exemplo a seguir mostra como usar `disable-vpc-classic-link`. **AWS CLI** **Desabilitar ClassicLink para uma VPC** Este exemplo desabilita o ClassicLink para vpc-8888888. Comando: ``` aws ec2 disable-vpc-classic-link --vpc-id vpc-88888888 ``` Resultado: ``` { "Return": true } ``` + Para ver detalhes da API, consulte [DisableVpcClassicLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-vpc-classic-link.html) na *Referência de comandos da AWS CLI*. ### `disassociate-address` O código de exemplo a seguir mostra como usar `disassociate-address`. **AWS CLI** **Para desassociar um endereço IP elástico no EC2-Classic** Este exemplo desassocia um endereço IP elástico de uma instância no EC2-Classic. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 disassociate-address --public-ip 198.51.100.0 ``` **Para desassociar um endereço IP elástico no EC2-VPC** Este exemplo desassocia um endereço IP elástico de uma instância em uma VPC. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 disassociate-address --association-id eipassoc-2bebb745 ``` + Consulte detalhes da API em [DisassociateAddress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disassociate-address.html) na *Referência de comandos da AWS CLI*. ### `disassociate-client-vpn-target-network` O código de exemplo a seguir mostra como usar `disassociate-client-vpn-target-network`. **AWS CLI** **Desassociar uma rede de destino de um endpoint do Client VPN** O exemplo `disassociate-client-vpn-target-network` a seguir desassocia a rede de destino associada ao ID de associação `cvpn-assoc-12312312312312312` do endpoint de Client VPN especificado. ``` aws ec2 disassociate-client-vpn-target-network \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ --association-id cvpn-assoc-12312312312312312 ``` Resultado: ``` { "AssociationId": "cvpn-assoc-12312312312312312", "Status": { "Code": "disassociating" } } ``` Para obter mais informações, consulte [Redes de destino](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-target.html) no *Guia do administrador da AWS*. + Para ver detalhes da API, consulte [DisassociateClientVpnTargetNetwork](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disassociate-client-vpn-target-network.html) na *Referência de comandos da AWS CLI*. ### `disassociate-iam-instance-profile` O código de exemplo a seguir mostra como usar `disassociate-iam-instance-profile`. **AWS CLI** **Desassociar um perfil de instância do IAM** Este exemplo desassocia um perfil de instância do IAM com o ID de associação `iip-assoc-05020b59952902f5f`. Comando: ``` aws ec2 disassociate-iam-instance-profile --association-id iip-assoc-05020b59952902f5f ``` Resultado: ``` { "IamInstanceProfileAssociation": { "InstanceId": "i-123456789abcde123", "State": "disassociating", "AssociationId": "iip-assoc-05020b59952902f5f", "IamInstanceProfile": { "Id": "AIPAI5IVIHMFFYY2DKV5Y", "Arn": "arn:aws:iam::123456789012:instance-profile/admin-role" } } } ``` + Para ver detalhes da API, consulte [DisassociateIamInstanceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disassociate-iam-instance-profile.html) na *Referência de comandos da AWS CLI*. ### `disassociate-instance-event-window` O código de exemplo a seguir mostra como usar `disassociate-instance-event-window`. **AWS CLI** **Exemplo 1: desassociar uma ou mais instâncias de uma janela de eventos** O exemplo `disassociate-instance-event-window` desassocia uma ou mais instâncias de uma janela de evento. Especifique o parâmetro `instance-event-window-id` para especificar a janela do evento. Para desassociar instâncias, especifique o`association-target`e para os valores de parâmetro, especifique um ou mais IDs de instância. ``` aws ec2 disassociate-instance-event-window \ --region us-east-1 \ --instance-event-window-id iew-0abcdef1234567890 \ --association-target "InstanceIds=i-1234567890abcdef0,i-0598c7d356eba48d7" ``` Resultado: ``` { "InstanceEventWindow": { "InstanceEventWindowId": "iew-0abcdef1234567890", "Name": "myEventWindowName", "CronExpression": "* 21-23 * * 2,3", "AssociationTarget": { "InstanceIds": [], "Tags": [], "DedicatedHostIds": [] }, "State": "creating" } } ``` Para restrições da janela de eventos, consulte [Considerações](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations) na seção Eventos Programados do *Guia do usuário do Amazon EC2*. **Exemplo 2: desassociar tags de instância de uma janela de eventos** O exemplo `disassociate-instance-event-window` a seguir desassocia tags de instância de uma janela de eventos. Especifique o parâmetro `instance-event-window-id` para especificar a janela do evento. Para desassociar tags de instância, especifique o`association-target`e para os valores de parâmetro, especifique uma ou mais tags. ``` aws ec2 disassociate-instance-event-window \ --region us-east-1 \ --instance-event-window-id iew-0abcdef1234567890 \ --association-target "InstanceTags=[{Key=k2,Value=v2},{Key=k1,Value=v1}]" ``` Resultado: ``` { "InstanceEventWindow": { "InstanceEventWindowId": "iew-0abcdef1234567890", "Name": "myEventWindowName", "CronExpression": "* 21-23 * * 2,3", "AssociationTarget": { "InstanceIds": [], "Tags": [], "DedicatedHostIds": [] }, "State": "creating" } } ``` Para restrições da janela de eventos, consulte [Considerações](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations) na seção Eventos Programados do *Guia do usuário do Amazon EC2*. **Exemplo 3: desassociar um host dedicado de uma janela de eventos** O exemplo `disassociate-instance-event-window` a seguir desassocia um Host Dedicado de uma janela de eventos. Especifique o parâmetro `instance-event-window-id` para especificar a janela do evento. Para desassociar um Host Dedicado, especifique o`association-target`e, para os valores de parâmetro, especifique um ou mais IDs de Host Dedicado. ``` aws ec2 disassociate-instance-event-window \ --region us-east-1 \ --instance-event-window-id iew-0abcdef1234567890 \ --association-target DedicatedHostIds=h-029fa35a02b99801d ``` Resultado: ``` { "InstanceEventWindow": { "InstanceEventWindowId": "iew-0abcdef1234567890", "Name": "myEventWindowName", "CronExpression": "* 21-23 * * 2,3", "AssociationTarget": { "InstanceIds": [], "Tags": [], "DedicatedHostIds": [] }, "State": "creating" } } ``` Para restrições da janela de eventos, consulte [Considerações](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations) na seção Eventos Programados do *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [DisassociateInstanceEventWindow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disassociate-instance-event-window.html) na *Referência de comandos da AWS CLI*. ### `disassociate-ipam-resource-discovery` O código de exemplo a seguir mostra como usar `disassociate-ipam-resource-discovery`. **AWS CLI** **Desassociar uma descoberta de recursos de um IPAM** Neste exemplo, você é uma conta de administrador delegado do IPAM e deseja desassociar uma descoberta de recursos do IPAM do seu IPAM. Você executou o comando de descrição e percebeu o `"ResourceDiscoveryStatus": "not-found"`, que você deseja desassociar do seu IPAM para abrir espaço para outras associações. O exemplo `disassociate-ipam-resource-discovery` a seguir desassocia uma descoberta de recursos IPAM em sua conta da AWS. ``` aws ec2 disassociate-ipam-resource-discovery \ --ipam-resource-discovery-association-id ipam-res-disco-assoc-04382a6346357cf82 \ --region us-east-1 ``` Resultado: ``` { "IpamResourceDiscoveryAssociation": { "OwnerId": "320805250157", "IpamResourceDiscoveryAssociationId": "ipam-res-disco-assoc-04382a6346357cf82", "IpamResourceDiscoveryAssociationArn": "arn:aws:ec2::320805250157:ipam-resource-discovery-association/ipam-res-disco-assoc-04382a6346357cf82", "IpamResourceDiscoveryId": "ipam-res-disco-0365d2977fc1672fe", "IpamId": "ipam-005f921c17ebd5107", "IpamArn": "arn:aws:ec2::320805250157:ipam/ipam-005f921c17ebd5107", "IpamRegion": "us-east-1", "IsDefault": false, "ResourceDiscoveryStatus": "not-found", "State": "disassociate-in-progress" } } ``` Para obter mais informações, consulte [Integrar o IPAM com contas fora da sua organização](https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam-outside-org.html) no *Guia do usuário do IPAM da Amazon VPC*. + Para ver detalhes da API, consulte [DisassociateIpamResourceDiscovery](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disassociate-ipam-resource-discovery.html) na *Referência de comandos da AWS CLI*. ### `disassociate-nat-gateway-address` O código de exemplo a seguir mostra como usar `disassociate-nat-gateway-address`. **AWS CLI** **Desassociar um endereço IP elástico a um gateway NAT público** O exemplo `disassociate-nat-gateway-address` a seguir desassocia o endereço IP elástico especificado do gateway NAT público especificado. ``` aws ec2 disassociate-nat-gateway-address \ --nat-gateway-id nat-1234567890abcdef0 \ --association-ids eipassoc-0f96bdca17EXAMPLE ``` Resultado: ``` { "NatGatewayId": "nat-1234567890abcdef0", "NatGatewayAddresses": [ { "AllocationId": "eipalloc-0be6ecac95EXAMPLE", "NetworkInterfaceId": "eni-09cc4b2558794f7f9", "PrivateIp": "10.0.0.74", "PublicIp": "3.211.231.218", "AssociationId": "eipassoc-0f96bdca17EXAMPLE", "IsPrimary": false, "Status": "disassociating" } ] } ``` Para obter mais informações, consulte [Gateways NAT](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) no *Guia do usuário da Amazon VPC*. + Para ver detalhes da API, consulte [DisassociateNatGatewayAddress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disassociate-nat-gateway-address.html) na *Referência de comandos da AWS CLI*. ### `disassociate-route-table` O código de exemplo a seguir mostra como usar `disassociate-route-table`. **AWS CLI** **Desassociar uma tabela de rotas** Este exemplo dissocia a tabela de rotas especificada da sub-rede especificada. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 disassociate-route-table --association-id rtbassoc-781d0d1a ``` + Para ver detalhes da API, consulte [DisassociateRouteTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disassociate-route-table.html) na *Referência de comandos da AWS CLI*. ### `disassociate-security-group-vpc` O código de exemplo a seguir mostra como usar `disassociate-security-group-vpc`. **AWS CLI** **Como desassociar um grupo de segurança de uma VPC** O exemplo de `disassociate-security-group-vpc` a seguir desassocia o grupo de segurança especificado da VPC especificada. ``` aws ec2 disassociate-security-group-vpc \ --group-id sg-04dbb43907d3f8a78 \ --vpc-id vpc-0bf4c2739bc05a694 ``` Resultado: ``` { "State": "disassociating" } ``` Consulte mais informações em [Associate security groups with multiple VPCs](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-assoc.html) no *Guia do usuário da Amazon VPC*. + Consulte detalhes da API em [DisassociateSecurityGroupVpc](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disassociate-security-group-vpc.html) na *Referência de comandos da AWS CLI*. ### `disassociate-subnet-cidr-block` O código de exemplo a seguir mostra como usar `disassociate-subnet-cidr-block`. **AWS CLI** **Desassociar um bloco CIDR IPv6 de uma sub-rede** Este exemplo desassocia um bloco CIDR IPv6 de uma sub-rede usando o ID de associação para o bloco CIDR. Comando: ``` aws ec2 disassociate-subnet-cidr-block --association-id subnet-cidr-assoc-3aa54053 ``` Resultado: ``` { "SubnetId": "subnet-5f46ec3b", "Ipv6CidrBlockAssociation": { "Ipv6CidrBlock": "2001:db8:1234:1a00::/64", "AssociationId": "subnet-cidr-assoc-3aa54053", "Ipv6CidrBlockState": { "State": "disassociating" } } } ``` + Para ver detalhes da API, consulte [DisassociateSubnetCidrBlock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disassociate-subnet-cidr-block.html) na *Referência de comandos da AWS CLI*. ### `disassociate-transit-gateway-multicast-domain` O código de exemplo a seguir mostra como usar `disassociate-transit-gateway-multicast-domain`. **AWS CLI** **Desassociar sub-redes de um domínio multicast** O exemplo `disassociate-transit-gateway-multicast-domain` a seguir desassocia uma sub-rede do domínio multicast especificado. ``` aws ec2 disassociate-transit-gateway-multicast-domain \ --transit-gateway-attachment-id tgw-attach-070e571cd1EXAMPLE \ --subnet-id subnet-000de86e3bEXAMPLE \ --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef7EXAMPLE ``` Resultado: ``` { "Associations": { "TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c4905cef7EXAMPLE", "TransitGatewayAttachmentId": "tgw-attach-070e571cd1EXAMPLE", "ResourceId": "vpc-7EXAMPLE", "ResourceType": "vpc", "Subnets": [ { "SubnetId": "subnet-000de86e3bEXAMPLE", "State": "disassociating" } ] } } ``` Consulte mais informações em [Multicast domains](https://docs.aws.amazon.com/vpc/latest/tgw/multicast-domains-about.html) no *Guia do Transit Gateway*. + Para ver detalhes da API, consulte [DisassociateTransitGatewayMulticastDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disassociate-transit-gateway-multicast-domain.html) na *Referência de comandos da AWS CLI*. ### `disassociate-transit-gateway-route-table` O código de exemplo a seguir mostra como usar `disassociate-transit-gateway-route-table`. **AWS CLI** **Desassociar uma tabela de rotas do gateway de trânsito de um anexo de recursos** O exemplo `disassociate-transit-gateway-route-table` a seguir desassocia o anexo especificado da tabela de rotas de gateway de trânsito. ``` aws ec2 disassociate-transit-gateway-route-table \ --transit-gateway-route-table-id tgw-rtb-002573ed1eEXAMPLE \ --transit-gateway-attachment-id tgw-attach-08e0bc912cEXAMPLE ``` Resultado: ``` { "Association": { "TransitGatewayRouteTableId": "tgw-rtb-002573ed1eEXAMPLE", "TransitGatewayAttachmentId": "tgw-attach-08e0bc912cEXAMPLE", "ResourceId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE", "ResourceType": "direct-connect-gateway", "State": "disassociating" } } ``` Para obter mais informações, consulte [Tabelas de rota do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [DisassociateTransitGatewayRouteTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disassociate-transit-gateway-route-table.html) na *Referência de comandos da AWS CLI*. ### `disassociate-vpc-cidr-block` O código de exemplo a seguir mostra como usar `disassociate-vpc-cidr-block`. **AWS CLI** **Desassociar um bloco CIDR IPv6 de uma VPC** Este exemplo desassocia um bloco CIDR IPv6 de uma VPC usando o ID de associação para o bloco CIDR. Comando: ``` aws ec2 disassociate-vpc-cidr-block --association-id vpc-cidr-assoc-eca54085 ``` Resultado: ``` { "Ipv6CidrBlockAssociation": { "Ipv6CidrBlock": "2001:db8:1234:1a00::/56", "AssociationId": "vpc-cidr-assoc-eca54085", "Ipv6CidrBlockState": { "State": "disassociating" } }, "VpcId": "vpc-a034d6c4" } ``` **Desassociar um bloco CIDR IPv4 de uma VPC** Este exemplo desassocia um bloco CIDR IPv4 de uma VPC. Comando: ``` aws ec2 disassociate-vpc-cidr-block --association-id vpc-cidr-assoc-0287ac6b ``` Resultado: ``` { "CidrBlockAssociation": { "AssociationId": "vpc-cidr-assoc-0287ac6b", "CidrBlock": "172.18.0.0/16", "CidrBlockState": { "State": "disassociating" } }, "VpcId": "vpc-27621243" } ``` + Para ver detalhes da API, consulte [DisassociateVpcCidrBlock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disassociate-vpc-cidr-block.html) na *Referência de comandos da AWS CLI*. ### `enable-address-transfer` O código de exemplo a seguir mostra como usar `enable-address-transfer`. **AWS CLI** **Habilitar a transferência de endereços IP elásticos** O exemplo `enable-address-transfer` a seguir permite a transferência do endereço IP elástico do endereço IP elástico especificado para a conta especificada. ``` aws ec2 enable-address-transfer \ --allocation-id eipalloc-09ad461b0d03f6aaf \ --transfer-account-id 123456789012 ``` Resultado: ``` { "AddressTransfer": { "PublicIp": "100.21.184.216", "AllocationId": "eipalloc-09ad461b0d03f6aaf", "TransferAccountId": "123456789012", "TransferOfferExpirationTimestamp": "2023-02-22T20:51:01.000Z", "AddressTransferStatus": "pending" } } ``` Para obter mais informações, consulte [Transferir endereços IP elásticos](https://docs.aws.amazon.com/vpc/latest/userguide/WorkWithEIPs.html#transfer-EIPs-intro) no *Guia do usuário do Amazon VPC*. + Para ver detalhes da API, consulte [EnableAddressTransfer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-address-transfer.html) na *Referência de comandos da AWS CLI*. ### `enable-aws-network-performance-metric-subscription` O código de exemplo a seguir mostra como usar `enable-aws-network-performance-metric-subscription`. **AWS CLI** **Habilitar uma assinatura métrica** O exemplo `enable-aws-network-performance-metric-subscription` a seguir permite o monitoramento da latência agregada da rede entre as regiões de origem e destino especificadas. ``` aws ec2 enable-aws-network-performance-metric-subscription \ --source us-east-1 \ --destination eu-west-1 \ --metric aggregate-latency \ --statistic p50 ``` Resultado: ``` { "Output": true } ``` Para obter mais informações, consulte [Gerenciar assinaturas](https://docs.aws.amazon.com/network-manager/latest/infrastructure-performance/nmip-subscriptions-cw.html) no *Guia do usuário de desempenho da infraestrutura*. + Para ver detalhes da API, consulte [EnableAwsNetworkPerformanceMetricSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-aws-network-performance-metric-subscription.html) na *Referência de comandos da AWS CLI*. ### `enable-ebs-encryption-by-default` O código de exemplo a seguir mostra como usar `enable-ebs-encryption-by-default`. **AWS CLI** **Habilitar a criptografia do EBS por padrão** O exemplo `enable-ebs-encryption-by-default` a seguir habilita a criptografia do EBS por padrão para sua conta AWS na Região atual. ``` aws ec2 enable-ebs-encryption-by-default ``` Resultado: ``` { "EbsEncryptionByDefault": true } ``` + Para ver detalhes da API, consulte [EnableEbsEncryptionByDefault](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-ebs-encryption-by-default.html) na *Referência de comandos da AWS CLI*. ### `enable-fast-launch` O código de exemplo a seguir mostra como usar `enable-fast-launch`. **AWS CLI** **Iniciar o lançamento rápido de uma imagem** O exemplo de `enable-fast-launch` a seguir configura a AMI especificada para Fast Launch e define o número máximo de instâncias paralelas a serem iniciadas como 6. O tipo de recurso a ser usado para pré-provisionar a AMI está definido como `snapshot`, que também é o valor padrão. ``` aws ec2 enable-fast-launch \ --image-id ami-01234567890abcedf \ --max-parallel-launches 6 \ --resource-type snapshot ``` Resultado: ``` { "ImageId": "ami-01234567890abcedf", "ResourceType": "snapshot", "SnapshotConfiguration": { "TargetResourceCount": 10 }, "LaunchTemplate": {}, "MaxParallelLaunches": 6, "OwnerId": "0123456789123", "State": "enabling", "StateTransitionReason": "Client.UserInitiated", "StateTransitionTime": "2022-01-27T22:16:03.199000+00:00" } ``` Consulte mais informações em [Configurar o EC2 Fast Launch para a AMI do Windows](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/win-fast-launch-configure.html) no *Manual do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [EnableFastLaunch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-fast-launch.html) na *Referência de comandos da AWS CLI*. ### `enable-fast-snapshot-restores` O código de exemplo a seguir mostra como usar `enable-fast-snapshot-restores`. **AWS CLI** **Habilitar a restauração rápida de snapshot** O exemplo `enable-fast-snapshot-restores` a seguir habilita restaurações rápidas de snapshot para os snapshots especificados nas Zonas de Disponibilidade especificadas. ``` aws ec2 enable-fast-snapshot-restores \ --availability-zones us-east-2a us-east-2b \ --source-snapshot-ids snap-1234567890abcdef0 ``` Resultado: ``` { "Successful": [ { "SnapshotId": "snap-1234567890abcdef0" "AvailabilityZone": "us-east-2a", "State": "enabling", "StateTransitionReason": "Client.UserInitiated", "OwnerId": "123456789012", "EnablingTime": "2020-01-25T23:57:49.602Z" }, { "SnapshotId": "snap-1234567890abcdef0" "AvailabilityZone": "us-east-2b", "State": "enabling", "StateTransitionReason": "Client.UserInitiated", "OwnerId": "123456789012", "EnablingTime": "2020-01-25T23:57:49.596Z" } ], "Unsuccessful": [] } ``` + Para ver detalhes da API, consulte [EnableFastSnapshotRestores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-fast-snapshot-restores.html) na *Referência de comandos da AWS CLI*. ### `enable-image-block-public-access` O código de exemplo a seguir mostra como usar `enable-image-block-public-access`. **AWS CLI** **Habilitar o bloqueio de acesso público para AMIs na região especificada** O exemplo `enable-image-block-public-access` a seguir habilita o bloqueio do acesso público para AMIs no nível da conta na região especificada. ``` aws ec2 enable-image-block-public-access \ --region us-east-1 \ --image-block-public-access-state block-new-sharing ``` Resultado: ``` { "ImageBlockPublicAccessState": "block-new-sharing" } ``` Para obter mais informações, consulte [Bloquear acesso público às AMIs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sharingamis-intro.html#block-public-access-to-amis) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [EnableImageBlockPublicAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-image-block-public-access.html) na *Referência de comandos da AWS CLI*. ### `enable-image-deprecation` O código de exemplo a seguir mostra como usar `enable-image-deprecation`. **AWS CLI** **Como descontinuar uma AMI** O exemplo `enable-image-deprecation` a seguir descontinua uma AMI em uma data e hora específicas. Se você especificar um valor para segundos, o Amazon EC2 arredondará os segundos para o minuto mais próximo. É necessário ser o proprietário da AMI para executar esse procedimento. ``` aws ec2 enable-image-deprecation \ --image-id ami-1234567890abcdef0 \ --deprecate-at '2022-10-15T13:17:12.000Z' ``` Resultado: ``` { "RequestID": "59dbff89-35bd-4eac-99ed-be587EXAMPLE", "Return": "true" } ``` Consulte mais informações em [Descontinuar uma AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-deprecate.html#deprecate-ami) no *Manual do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [EnableImageDeprecation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-image-deprecation.html) na *Referência de comandos da AWS CLI*. ### `enable-image-deregistration-protection` O código de exemplo a seguir mostra como usar `enable-image-deregistration-protection`. **AWS CLI** **Como habilitar a proteção contra cancelamento de registro** O exemplo de `enable-image-deregistration-protection` a seguir habilita a proteção contra cancelamento de registro para a imagem especificada. ``` aws ec2 enable-image-deregistration-protection \ --image-id ami-0b1a928a144a74ec9 ``` Resultado: ``` { "Return": "enabled-without-cooldown" } ``` Consulte mais informações em [Proteger uma AMI do Amazon EC2 de cancelamento de registro](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-deregistration-protection.html) no *Guia do usuário do Amazon EC2*. + Consulte detalhes da API em [EnableImageDeregistrationProtection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-image-deregistration-protection.html) na *Referência de comandos da AWS CLI*. ### `enable-image` O código de exemplo a seguir mostra como usar `enable-image`. **AWS CLI** **Habilitar uma AMI** O exemplo `enable-image` a seguir habilita a AMI especificada. ``` aws ec2 enable-image \ --image-id ami-1234567890abcdef0 ``` Resultado: ``` { "Return": "true" } ``` Para obter mais informações, consulte [Desativar uma AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/disable-an-ami.html) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [EnableImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-image.html) na *Referência de comandos da AWS CLI*. ### `enable-ipam-organization-admin-account` O código de exemplo a seguir mostra como usar `enable-ipam-organization-admin-account`. **AWS CLI** **Integrar-se ao AWS Organizations e delegar uma conta de membro como a conta do IPAM** O exemplo `enable-ipam-organization-admin-account` a seguir integra o IPAM à AWS Organization e delega uma conta de membro como a conta do IPAM. ``` aws ec2 enable-ipam-organization-admin-account \ --delegated-admin-account-id 320805250157 ``` Resultado: ``` { "Success": true } ``` Para obter mais informações, consulte [Integrar IPAM com o AWS Organizations](https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam.html) no *Guia do usuário do Amazon VPC IPAM*. + Para ver detalhes da API, consulte [EnableIpamOrganizationAdminAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-ipam-organization-admin-account.html) na *Referência de comandos da AWS CLI*. ### `enable-reachability-analyzer-organization-sharing` O código de exemplo a seguir mostra como usar `enable-reachability-analyzer-organization-sharing`. **AWS CLI** **Habilitar o acesso confiável com o Reachability Analyzer** O exemplo `enable-reachability-analyzer-organization-sharing` a seguir permite acesso confiável ao Reachability Analyzer. ``` aws ec2 enable-reachability-analyzer-organization-sharing ``` Este comando não produz saída. Para obter mais informações, consulte [Análise entre contas](https://docs.aws.amazon.com/vpc/latest/reachability/multi-account.html) no *Guia do usuário do Reachability Analyzer*. + Para ver detalhes da API, consulte [EnableReachabilityAnalyzerOrganizationSharing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-reachability-analyzer-organization-sharing.html) na *Referência de comandos da AWS CLI*. ### `enable-serial-console-access` O código de exemplo a seguir mostra como usar `enable-serial-console-access`. **AWS CLI** **Habilitar o acesso ao console de série para sua conta** O exemplo `enable-serial-console-access` a seguir habilita o acesso da conta ao console de série. ``` aws ec2 enable-serial-console-access ``` Resultado: ``` { "SerialConsoleAccessEnabled": true } ``` Para obter mais informações, consulte [Console de Série do EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-serial-console.html) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [EnableSerialConsoleAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-serial-console-access.html) na *Referência de comandos da AWS CLI*. ### `enable-snapshot-block-public-access` O código de exemplo a seguir mostra como usar `enable-snapshot-block-public-access`. **AWS CLI** **Habilitar o bloqueio do acesso público aos snapshots** O exemplo `enable-snapshot-block-public-access` a seguir bloqueia todos os compartilhamentos públicos dos snapshots. ``` aws ec2 enable-snapshot-block-public-access \ --state block-all-sharing ``` Resultado: ``` { "State": "block-all-sharing" } ``` Para obter mais informações, consulte [Bloquear acesso público aos snapshots](https://docs.aws.amazon.com/ebs/latest/userguide/block-public-access-snapshots.html) no *Guia do usuário do Amazon EBS*. + Para ver detalhes da API, consulte [EnableSnapshotBlockPublicAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-snapshot-block-public-access.html) na *Referência de comandos da AWS CLI*. ### `enable-transit-gateway-route-table-propagation` O código de exemplo a seguir mostra como usar `enable-transit-gateway-route-table-propagation`. **AWS CLI** **Habilitar um anexo do gateway de trânsito para propagar rotas para a tabela de rotas de propagação especificada** O exemplo `enable-transit-gateway-route-table-propagation` a seguir habilita o anexo especificado para propagar rotas para a tabela de rota de propagação especificada. ``` aws ec2 enable-transit-gateway-route-table-propagation \ --transit-gateway-route-table-id tgw-rtb-0a823edbdeEXAMPLE \ --transit-gateway-attachment-id tgw-attach-09b52ccdb5EXAMPLE ``` Resultado: ``` { "Propagation": { "TransitGatewayAttachmentId": "tgw-attach-09b52ccdb5EXAMPLE", "ResourceId": "vpc-4d7de228", "ResourceType": "vpc", "TransitGatewayRouteTableId": "tgw-rtb-0a823edbdeEXAMPLE", "State": "disabled" } } ``` Para obter mais informações, consulte [Tabelas de rota do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [EnableTransitGatewayRouteTablePropagation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-transit-gateway-route-table-propagation.html) na *Referência de comandos da AWS CLI*. ### `enable-vgw-route-propagation` O código de exemplo a seguir mostra como usar `enable-vgw-route-propagation`. **AWS CLI** **Habilitar a propagação de rotas** Esse exemplo habilita o gateway privado virtual especificado para propagar rotas estáticas para a tabela de rotas especificada. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 enable-vgw-route-propagation --route-table-id rtb-22574640 --gateway-id vgw-9a4cacf3 ``` + Para ver detalhes da API, consulte [EnableVgwRoutePropagation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-vgw-route-propagation.html) na *Referência de comandos da AWS CLI*. ### `enable-volume-io` O código de exemplo a seguir mostra como usar `enable-volume-io`. **AWS CLI** **Habilitar E/S para um volume** Este exemplo habilita a E/S no volume `vol-1234567890abcdef0`. Comando: ``` aws ec2 enable-volume-io --volume-id vol-1234567890abcdef0 ``` Resultado: ``` { "Return": true } ``` + Para ver detalhes da API, consulte [EnableVolumeIo](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-volume-io.html) na *Referência de comandos da AWS CLI*. ### `enable-vpc-classic-link-dns-support` O código de exemplo a seguir mostra como usar `enable-vpc-classic-link-dns-support`. **AWS CLI** **Habilitar o suporte a DNS do ClassicLink para uma VPC** Este exemplo habilita o suporte a DNS do ClassicLink para `vpc-88888888`. Comando: ``` aws ec2 enable-vpc-classic-link-dns-support --vpc-id vpc-88888888 ``` Resultado: ``` { "Return": true } ``` + Para ver detalhes da API, consulte [EnableVpcClassicLinkDnsSupport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-vpc-classic-link-dns-support.html) na *Referência de comandos da AWS CLI*. ### `enable-vpc-classic-link` O código de exemplo a seguir mostra como usar `enable-vpc-classic-link`. **AWS CLI** **Habilitar a VPC para ClassicLink** Este exemplo habilita vpc-8888888 para o ClassicLink. Comando: ``` aws ec2 enable-vpc-classic-link --vpc-id vpc-88888888 ``` Resultado: ``` { "Return": true } ``` + Para ver detalhes da API, consulte [EnableVpcClassicLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-vpc-classic-link.html) na *Referência de comandos da AWS CLI*. ### `export-client-vpn-client-certificate-revocation-list` O código de exemplo a seguir mostra como usar `export-client-vpn-client-certificate-revocation-list`. **AWS CLI** **Exportar uma lista de revogação de certificados de cliente** O exemplo `export-client-vpn-client-certificate-revocation-list` a seguir exporta a lista de revogação de certificados de cliente para o endpoint especificado do Client VPN. Neste exemplo, a saída é retornada em formato de texto para facilitar a leitura. ``` aws ec2 export-client-vpn-client-certificate-revocation-list \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ --output text ``` Resultado: ``` -----BEGIN X509 CRL----- MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= -----END X509 CRL----- STATUS pending ``` Para obter mais informações, consulte [Listas de revogação de certificados de cliente](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-certificates.html) no *Guia do administrador do AWS Client VPN*. + Para ver detalhes da API, consulte [ExportClientVpnClientCertificateRevocationList](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/export-client-vpn-client-certificate-revocation-list.html) na *Referência de comandos da AWS CLI*. ### `export-client-vpn-client-configuration` O código de exemplo a seguir mostra como usar `export-client-vpn-client-configuration`. **AWS CLI** **Exportar a configuração do cliente** O exemplo `export-client-vpn-client-configuration` a seguir exporta a configuração do cliente para o endpoint de Client VPN especificado. Neste exemplo, a saída é retornada em formato de texto para facilitar a leitura. ``` aws ec2 export-client-vpn-client-configuration \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ --output text ``` Resultado: ``` client dev tun proto udp remote cvpn-endpoint-123456789123abcde.prod.clientvpn.ap-south-1.amazonaws.com 443 remote-random-hostname resolv-retry infinite nobind persist-key persist-tun remote-cert-tls server cipher AES-256-GCM verb 3 -----BEGIN CERTIFICATE----- MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= -----END CERTIFICATE----- reneg-sec 0 ``` Consulte mais informações em [Client VPN endpoint configuration file export](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-endpoint-export.html) no *Guia do administrador do AWS Client VPN*. + Para ver detalhes da API, consulte [ExportClientVpnClientConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/export-client-vpn-client-configuration.html) na *Referência de comandos da AWS CLI*. ### `export-image` O código de exemplo a seguir mostra como usar `export-image`. **AWS CLI** **Exportar uma VM de uma AMI** O exemplo `export-image` a seguir exporta a AMI especificada para o bucket especificado no formato especificado. ``` aws ec2 export-image \ --image-id ami-1234567890abcdef0 \ --disk-image-format VMDK \ --s3-export-location S3Bucket=my-export-bucket,S3Prefix=exports/ ``` Resultado: ``` { "DiskImageFormat": "vmdk", "ExportImageTaskId": "export-ami-1234567890abcdef0" "ImageId": "ami-1234567890abcdef0", "RoleName": "vmimport", "Progress": "0", "S3ExportLocation": { "S3Bucket": "my-export-bucket", "S3Prefix": "exports/" }, "Status": "active", "StatusMessage": "validating" } ``` + Para ver detalhes da API, consulte [ExportImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/export-image.html) na *Referência de comandos da AWS CLI*. ### `get-associated-ipv6-pool-cidrs` O código de exemplo a seguir mostra como usar `get-associated-ipv6-pool-cidrs`. **AWS CLI** **Obter as associações para um pool de endereços IPv** O exemplo `get-associated-ipv6-pool-cidrs` a seguir obtém as associações para o pool de endereços IPv6 especificado. ``` aws ec2 get-associated-ipv6-pool-cidrs \ --pool-id ipv6pool-ec2-012345abc12345abc ``` Resultado: ``` { "Ipv6CidrAssociations": [ { "Ipv6Cidr": "2001:db8:1234:1a00::/56", "AssociatedResource": "vpc-111111222222333ab" } ] } ``` + Para ver detalhes da API, consulte [GetAssociatedIpv6PoolCidrs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-associated-ipv6-pool-cidrs.html) na *Referência de comandos da AWS CLI*. ### `get-aws-network-performance-data` O código de exemplo a seguir mostra como usar `get-aws-network-performance-data`. **AWS CLI** **Obter dados de desempenho da rede** O exemplo `get-aws-network-performance-data` a seguir recupera dados sobre o desempenho da rede entre as regiões especificadas no período de tempo especificado. ``` aws ec2 get-aws-network-performance-data \ --start-time 2022-10-26T12:00:00.000Z \ --end-time 2022-10-26T12:30:00.000Z \ --data-queries Id=my-query,Source=us-east-1,Destination=eu-west-1,Metric=aggregate-latency,Statistic=p50,Period=five-minutes ``` Resultado: ``` { "DataResponses": [ { "Id": "my-query", "Source": "us-east-1", "Destination": "eu-west-1", "Metric": "aggregate-latency", "Statistic": "p50", "Period": "five-minutes", "MetricPoints": [ { "StartDate": "2022-10-26T12:00:00+00:00", "EndDate": "2022-10-26T12:05:00+00:00", "Value": 62.44349, "Status": "OK" }, { "StartDate": "2022-10-26T12:05:00+00:00", "EndDate": "2022-10-26T12:10:00+00:00", "Value": 62.483498, "Status": "OK" }, { "StartDate": "2022-10-26T12:10:00+00:00", "EndDate": "2022-10-26T12:15:00+00:00", "Value": 62.51248, "Status": "OK" }, { "StartDate": "2022-10-26T12:15:00+00:00", "EndDate": "2022-10-26T12:20:00+00:00", "Value": 62.635475, "Status": "OK" }, { "StartDate": "2022-10-26T12:20:00+00:00", "EndDate": "2022-10-26T12:25:00+00:00", "Value": 62.733974, "Status": "OK" }, { "StartDate": "2022-10-26T12:25:00+00:00", "EndDate": "2022-10-26T12:30:00+00:00", "Value": 62.773975, "Status": "OK" }, { "StartDate": "2022-10-26T12:30:00+00:00", "EndDate": "2022-10-26T12:35:00+00:00", "Value": 62.75349, "Status": "OK" } ] } ] } ``` Para obter mais informações, consulte [Monitorar o desempenho da rede](https://docs.aws.amazon.com/network-manager/latest/infrastructure-performance/nmip-performance-cli.html) no *Guia do usuário de desempenho da infraestrutura*. + Para ver detalhes da API, consulte [GetAwsNetworkPerformanceData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-aws-network-performance-data.html) na *Referência de comandos da AWS CLI*. ### `get-capacity-reservation-usage` O código de exemplo a seguir mostra como usar `get-capacity-reservation-usage`. **AWS CLI** **Visualizar o uso da reserva de capacidade em todas as contas AWS** O exemplo `get-capacity-reservation-usage` a seguir exibe informações de uso para a reserva de capacidade especificada. ``` aws ec2 get-capacity-reservation-usage \ --capacity-reservation-id cr-1234abcd56EXAMPLE ``` Resultado: ``` { "CapacityReservationId": "cr-1234abcd56EXAMPLE ", "InstanceUsages": [ { "UsedInstanceCount": 1, "AccountId": "123456789012" } ], "AvailableInstanceCount": 4, "TotalInstanceCount": 5, "State": "active", "InstanceType": "t2.medium" } ``` Consulte mais informações em [Reservas de capacidade compartilhadas](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservation-sharing.html) no *Manual do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [GetCapacityReservationUsage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-capacity-reservation-usage.html) na *Referência de comandos da AWS CLI*. ### `get-coip-pool-usage` O código de exemplo a seguir mostra como usar `get-coip-pool-usage`. **AWS CLI** **Obter o uso do grupo de endereços IP pertencentes ao cliente** O exemplo `get-coip-pool-usage` a seguir obtém os detalhes de uso do grupo especificado de endereços IP pertencentes ao cliente. ``` aws ec2 get-coip-pool-usage \ --pool-id ipv4pool-coip-123a45678bEXAMPLE ``` Resultado: ``` { "CoipPoolId": "ipv4pool-coip-123a45678bEXAMPLE", "CoipAddressUsages": [ { "CoIp": "0.0.0.0" }, { "AllocationId": "eipalloc-123ab45c6dEXAMPLE", "AwsAccountId": "123456789012", "CoIp": "0.0.0.0" }, { "AllocationId": "eipalloc-123ab45c6dEXAMPLE", "AwsAccountId": "123456789111", "CoIp": "0.0.0.0" } ], "LocalGatewayRouteTableId": "lgw-rtb-059615ef7dEXAMPLE" } ``` Consulte mais informações em [Customer-owned IP addresses](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) no *Guia do usuário do AWS Outposts para racks do Outposts*. + Para ver detalhes da API, consulte [GetCoipPoolUsage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-coip-pool-usage.html) na *Referência de comandos da AWS CLI*. ### `get-console-output` O código de exemplo a seguir mostra como usar `get-console-output`. **AWS CLI** **Exemplo 1: obter a saída do console** O exemplo `get-console-output` a seguir obtém a saída do console para a instância Linux especificada. ``` aws ec2 get-console-output \ --instance-id i-1234567890abcdef0 ``` Resultado: ``` { "InstanceId": "i-1234567890abcdef0", "Timestamp": "2013-07-25T21:23:53.000Z", "Output": "..." } ``` Para obter mais informações, consulte [Saída de console da instância](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html#instance-console-console-output) no *Guia do usuário Amazon EC2*. **Exemplo 2: obter a saída mais recente do console** O exemplo `get-console-output` a seguir obtém a saída mais recente do console para a instância Linux especificada. ``` aws ec2 get-console-output \ --instance-id i-1234567890abcdef0 \ --latest \ --output text ``` Resultado: ``` i-1234567890abcdef0 [ 0.000000] Command line: root=LABEL=/ console=tty1 console=ttyS0 selinux=0 nvme_core.io_timeout=4294967295 [ 0.000000] x86/fpu: Supporting XSAVE feature 0x001: 'x87 floating point registers' [ 0.000000] x86/fpu: Supporting XSAVE feature 0x002: 'SSE registers' [ 0.000000] x86/fpu: Supporting XSAVE feature 0x004: 'AVX registers' ... Cloud-init v. 0.7.6 finished at Wed, 09 May 2018 19:01:13 +0000. Datasource DataSourceEc2. Up 21.50 seconds Amazon Linux AMI release 2018.03 Kernel 4.14.26-46.32.amzn1.x ``` Para obter mais informações, consulte [Saída de console da instância](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html#instance-console-console-output) no *Guia do usuário Amazon EC2*. + Para ver detalhes da API, consulte [GetConsoleOutput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-console-output.html) na *Referência de comandos da AWS CLI*. ### `get-console-screenshot` O código de exemplo a seguir mostra como usar `get-console-screenshot`. **AWS CLI** **Recuperar uma captura de tela de uma instância em execução** O exemplo `get-console-screenshot` a seguir recupera uma captura de tela da instância especificada no formato .jpg. A captura de tela é retornada como uma string codificada em Base64. ``` aws ec2 get-console-screenshot \ --instance-id i-1234567890abcdef0 ``` Resultado: ``` { "ImageData": "997987/8kgj49ikjhewkwwe0008084EXAMPLE", "InstanceId": "i-1234567890abcdef0" } ``` + Para ver detalhes da API, consulte [GetConsoleScreenshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-console-screenshot.html) na *Referência de comandos da AWS CLI*. ### `get-default-credit-specification` O código de exemplo a seguir mostra como usar `get-default-credit-specification`. **AWS CLI** **Descrever a opção de crédito padrão** O exemplo `get-default-credit-specification` a seguir descreve a opção de crédito padrão para instâncias T2. ``` aws ec2 get-default-credit-specification \ --instance-family t2 ``` Resultado: ``` { "InstanceFamilyCreditSpecification": { "InstanceFamily": "t2", "CpuCredits": "standard" } } ``` + Para ver detalhes da API, consulte [GetDefaultCreditSpecification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-default-credit-specification.html) na *Referência de comandos da AWS CLI*. ### `get-ebs-default-kms-key-id` O código de exemplo a seguir mostra como usar `get-ebs-default-kms-key-id`. **AWS CLI** **Descrever sua CMK padrão para criptografia EBS** O exemplo `get-ebs-default-kms-key-id` a seguir descreve a CMK padrão para criptografia EBS para sua conta da AWS. ``` aws ec2 get-ebs-default-kms-key-id ``` A saída mostra a CMK padrão para criptografia do EBS, que é uma CMK gerenciada por AWS com o alias `alias/aws/ebs`. ``` { "KmsKeyId": "alias/aws/ebs" } ``` A saída a seguir mostra uma CMK personalizada para criptografia do EBS. ``` { "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/0ea3fef3-80a7-4778-9d8c-1c0c6EXAMPLE" } ``` + Para ver detalhes da API, consulte [GetEbsDefaultKmsKeyId](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-ebs-default-kms-key-id.html) na *Referência de comandos da AWS CLI*. ### `get-ebs-encryption-by-default` O código de exemplo a seguir mostra como usar `get-ebs-encryption-by-default`. **AWS CLI** **Descrever se a criptografia EBS por padrão está habilitada** O exemplo `get-ebs-encryption-by-default` a seguir indica se a criptografia EBS por padrão está habilitada para sua conta AWS na Região atual. ``` aws ec2 get-ebs-encryption-by-default ``` A saída a seguir indica que a criptografia EBS por padrão está desativada. ``` { "EbsEncryptionByDefault": false } ``` A saída a seguir indica que a criptografia EBS por padrão está ativada. ``` { "EbsEncryptionByDefault": true } ``` + Para ver detalhes da API, consulte [GetEbsEncryptionByDefault](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-ebs-encryption-by-default.html) na *Referência de comandos da AWS CLI*. ### `get-flow-logs-integration-template` O código de exemplo a seguir mostra como usar `get-flow-logs-integration-template`. **AWS CLI** **Criar um modelo do CloudFormation para automatizar a integração dos logs de fluxo da VPC com o Amazon Athena** Os exemplos `get-flow-logs-integration-template` a seguir criam um modelo do CloudFormation para automatizar a integração dos logs de fluxo da VPC com o Amazon Athena. Linux: ``` aws ec2 get-flow-logs-integration-template \ --flow-log-id fl-1234567890abcdef0 \ --config-delivery-s3-destination-arn arn:aws:s3:::amzn-s3-demo-bucket \ --integrate-services AthenaIntegrations='[{IntegrationResultS3DestinationArn=arn:aws:s3:::amzn-s3-demo-bucket,PartitionLoadFrequency=none,PartitionStartDate=2021-07-21T00:40:00,PartitionEndDate=2021-07-21T00:42:00},{IntegrationResultS3DestinationArn=arn:aws:s3:::amzn-s3-demo-bucket,PartitionLoadFrequency=none,PartitionStartDate=2021-07-21T00:40:00,PartitionEndDate=2021-07-21T00:42:00}]' ``` Windows: ``` aws ec2 get-flow-logs-integration-template ^ --flow-log-id fl-1234567890abcdef0 ^ --config-delivery-s3-destination-arn arn:aws:s3:::amzn-s3-demo-bucket ^ --integrate-services AthenaIntegrations=[{IntegrationResultS3DestinationArn=arn:aws:s3:::amzn-s3-demo-bucket,PartitionLoadFrequency=none,PartitionStartDate=2021-07-21T00:40:00,PartitionEndDate=2021-07-21T00:42:00},{IntegrationResultS3DestinationArn=arn:aws:s3:::amzn-s3-demo-bucket,PartitionLoadFrequency=none,PartitionStartDate=2021-07-21T00:40:00,PartitionEndDate=2021-07-21T00:42:00}] ``` Resultado: ``` { "Result": "https://amzn-s3-demo-bucket.s3.us-east-2.amazonaws.com/VPCFlowLogsIntegrationTemplate_fl-1234567890abcdef0_Wed%20Jul%2021%2000%3A57%3A56%20UTC%202021.yml" } ``` Para informações sobre o uso de modelos do CloudFormation, consulte [Trabalhar com modelos do AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-guide.html) no *Guia do usuário do AWS CloudFormation*. Para obter informações sobre como usar o Amazon Athena e os logs de fluxo, consulte [Consultar logs de fluxo usando o Amazon Athena](https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs-athena.html) no *Guia do usuário da nuvem privada virtual*. + Para ver detalhes da API, consulte [GetFlowLogsIntegrationTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-flow-logs-integration-template.html) na *Referência de comandos da AWS CLI*. ### `get-groups-for-capacity-reservation` O código de exemplo a seguir mostra como usar `get-groups-for-capacity-reservation`. **AWS CLI** **Listar os grupos de recursos com uma reserva de capacidade** O exemplo `get-groups-for-capacity-reservation` a seguir lista os grupos de recursos aos quais a Reserva de Capacidade especificada foi adicionada. ``` aws ec2 get-groups-for-capacity-reservation \ --capacity-reservation-id cr-1234abcd56EXAMPLE ``` Resultado: ``` { "CapacityReservationsGroup": [ { "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/my-resource-group", "OwnerId": "123456789012" } ] } ``` Consulte mais informações em [Grupos de Reserva de capacidade](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-cr-group.html) no *Manual do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [GetGroupsForCapacityReservation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-groups-for-capacity-reservation.html) na *Referência de comandos da AWS CLI*. ### `get-host-reservation-purchase-preview` O código de exemplo a seguir mostra como usar `get-host-reservation-purchase-preview`. **AWS CLI** **Obter uma prévia da compra de uma reserva de host dedicado** Este exemplo fornece uma prévia dos custos de uma Reserva de Host Dedicado especificada para o Host Dedicado especificado em sua conta. Comando: ``` aws ec2 get-host-reservation-purchase-preview --offering-id hro-03f707bf363b6b324 --host-id-set h-013abcd2a00cbd123 ``` Resultado: ``` { "TotalHourlyPrice": "1.499", "Purchase": [ { "HourlyPrice": "1.499", "InstanceFamily": "m4", "PaymentOption": "NoUpfront", "HostIdSet": [ "h-013abcd2a00cbd123" ], "UpfrontPrice": "0.000", "Duration": 31536000 } ], "TotalUpfrontPrice": "0.000" } ``` + Para ver detalhes da API, consulte [GetHostReservationPurchasePreview](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-host-reservation-purchase-preview.html) na *Referência de comandos da AWS CLI*. ### `get-image-block-public-access-state` O código de exemplo a seguir mostra como usar `get-image-block-public-access-state`. **AWS CLI** **Obter o estado do bloqueio de acesso público para AMIs na região especificada** O exemplo `get-image-block-public-access-state` a seguir obtém o status do bloqueio do acesso público para AMIs no nível da conta na região especificada. ``` aws ec2 get-image-block-public-access-state \ --region us-east-1 ``` Resultado: ``` { "ImageBlockPublicAccessState": "block-new-sharing" } ``` Para obter mais informações, consulte [Bloquear acesso público às AMIs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sharingamis-intro.html#block-public-access-to-amis) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [GetImageBlockPublicAccessState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-image-block-public-access-state.html) na *Referência de comandos da AWS CLI*. ### `get-instance-types-from-instance-requirements` O código de exemplo a seguir mostra como usar `get-instance-types-from-instance-requirements`. **AWS CLI** **Pré-visualizar os tipos de instância que correspondem aos atributos especificados** O exemplo `get-instance-types-from-instance-requirements` a seguir primeiro gera uma lista de todos os atributos possíveis que podem ser especificados usando o parâmetro `--generate-cli-skeleton` e salva a lista em um arquivo JSON. Em seguida, o arquivo JSON é usado para personalizar os atributos para os quais visualizar os tipos de instância correspondentes. Para gerar todos os atributos possíveis e salvar a saída diretamente em um arquivo JSON, use o comando a seguir. ``` aws ec2 get-instance-types-from-instance-requirements \ --region us-east-1 \ --generate-cli-skeleton input > attributes.json ``` Resultado: ``` { "DryRun": true, "ArchitectureTypes": [ "x86_64_mac" ], "VirtualizationTypes": [ "paravirtual" ], "InstanceRequirements": { "VCpuCount": { "Min": 0, "Max": 0 }, "MemoryMiB": { "Min": 0, "Max": 0 }, "CpuManufacturers": [ "intel" ], "MemoryGiBPerVCpu": { "Min": 0.0, "Max": 0.0 }, "ExcludedInstanceTypes": [ "" ], "InstanceGenerations": [ "current" ], "SpotMaxPricePercentageOverLowestPrice": 0, "OnDemandMaxPricePercentageOverLowestPrice": 0, "BareMetal": "included", "BurstablePerformance": "excluded", "RequireHibernateSupport": true, "NetworkInterfaceCount": { "Min": 0, "Max": 0 }, "LocalStorage": "required", "LocalStorageTypes": [ "hdd" ], "TotalLocalStorageGB": { "Min": 0.0, "Max": 0.0 }, "BaselineEbsBandwidthMbps": { "Min": 0, "Max": 0 }, "AcceleratorTypes": [ "inference" ], "AcceleratorCount": { "Min": 0, "Max": 0 }, "AcceleratorManufacturers": [ "xilinx" ], "AcceleratorNames": [ "t4" ], "AcceleratorTotalMemoryMiB": { "Min": 0, "Max": 0 } }, "MaxResults": 0, "NextToken": "" } ``` Configurar o arquivo JSON. Você deve fornecer valores para `ArchitectureTypes`, `VirtualizationTypes`, `VCpuCount` e `MemoryMiB`. Você pode omitir os outros atributos. Quando omitidos, os valores padrão são usados. Para obter uma descrição de cada atributo e seus valores padrão, consulte get-instance-types-from-instance-requirements . Pré-visualizar os tipos de instância que têm os atributos especificados em `attributes.json`. Especifique o nome e o caminho para seu arquivo JSON usando o parâmetro `--cli-input-json`. Na solicitação a seguir, a saída é formatada como uma tabela. ``` aws ec2 get-instance-types-from-instance-requirements \ --cli-input-json file://attributes.json \ --output table ``` Conteúdo do arquivo `attributes.json`: ``` { "ArchitectureTypes": [ "x86_64" ], "VirtualizationTypes": [ "hvm" ], "InstanceRequirements": { "VCpuCount": { "Min": 4, "Max": 6 }, "MemoryMiB": { "Min": 2048 }, "InstanceGenerations": [ "current" ] } } ``` Resultado: ``` ------------------------------------------ |GetInstanceTypesFromInstanceRequirements| +----------------------------------------+ || InstanceTypes || |+--------------------------------------+| || InstanceType || |+--------------------------------------+| || c4.xlarge || || c5.xlarge || || c5a.xlarge || || c5ad.xlarge || || c5d.xlarge || || c5n.xlarge || || d2.xlarge || ... ``` Para obter mais informações sobre a seleção de tipo de instância baseada em atributos, consulte [Como funciona a seleção de tipo de instância baseada em atributos](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abs-how-it-works) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [GetInstanceTypesFromInstanceRequirements](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-instance-types-from-instance-requirements.html) na *Referência de comandos da AWS CLI*. ### `get-instance-uefi-data` O código de exemplo a seguir mostra como usar `get-instance-uefi-data`. **AWS CLI** **Recuperar dados UEFI de uma instância** O exemplo `get-instance-uefi-data` a seguir recupera dados UEFI de uma instância. Se a saída estiver vazia, a instância não conterá dados UEFI. ``` aws ec2 get-instance-uefi-data \ --instance-id i-0123456789example ``` Resultado: ``` { "InstanceId": "i-0123456789example", "UefiData": "QU1aTlVFRkkf+uLXAAAAAHj5a7fZ9+3dBzxXb/. AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD4L/J/AODshho=" } ``` Para obter mais informações, consulte [Inicialização segura UEFI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/uefi-secure-boot.html) no *Guia do usuário do Amazon EC2*. + Para receber detalhes da API, consulte [GetInstanceUefiData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-instance-uefi-data.html) na *Referência de comandos da AWS CLI*. ### `get-ipam-address-history` O código de exemplo a seguir mostra como usar `get-ipam-address-history`. **AWS CLI** **Obter o histórico de um CIDR** O exemplo `get-ipam-address-history` a seguir obtém o histórico de um CIDR. (Linux): ``` aws ec2 get-ipam-address-history \ --cidr 10.0.0.0/16 \ --ipam-scope-id ipam-scope-02fc38cd4c48e7d38 \ --start-time 2021-12-08T01:00:00.000Z \ --end-time 2021-12-10T01:00:00.000Z ``` (Windows): ``` aws ec2 get-ipam-address-history ^ --cidr 10.0.0.0/16 ^ --ipam-scope-id ipam-scope-02fc38cd4c48e7d38 ^ --start-time 2021-12-08T01:00:00.000Z ^ --end-time 2021-12-10T01:00:00.000Z ``` Resultado: ``` { "HistoryRecords": [ { "ResourceOwnerId": "123456789012", "ResourceRegion": "us-west-1", "ResourceType": "vpc", "ResourceId": "vpc-06cbefa9ee907e1c0", "ResourceCidr": "10.0.0.0/16", "ResourceName": "Demo", "ResourceComplianceStatus": "unmanaged", "ResourceOverlapStatus": "overlapping", "VpcId": "vpc-06cbefa9ee907e1c0", "SampledStartTime": "2021-12-08T19:54:57.675000+00:00" }, { "ResourceOwnerId": "123456789012", "ResourceRegion": "us-east-2", "ResourceType": "vpc", "ResourceId": "vpc-042702f474812c9ad", "ResourceCidr": "10.0.0.0/16", "ResourceName": "test", "ResourceComplianceStatus": "unmanaged", "ResourceOverlapStatus": "overlapping", "VpcId": "vpc-042702f474812c9ad", "SampledStartTime": "2021-12-08T19:54:59.019000+00:00" }, { "ResourceOwnerId": "123456789012", "ResourceRegion": "us-east-2", "ResourceType": "vpc", "ResourceId": "vpc-042b8a44f64267d67", "ResourceCidr": "10.0.0.0/16", "ResourceName": "tester", "ResourceComplianceStatus": "unmanaged", "ResourceOverlapStatus": "overlapping", "VpcId": "vpc-042b8a44f64267d67", "SampledStartTime": "2021-12-08T19:54:59.019000+00:00" } ] } ``` Para obter mais informações, consulte [Exibir o histórico de endereços IP](https://docs.aws.amazon.com/vpc/latest/ipam/view-history-cidr-ipam.html) no *Guia do usuário IPAM da Amazon VPC*. + Para ver detalhes da API, consulte [GetIpamAddressHistory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-ipam-address-history.html) na *Referência de comandos da AWS CLI*. ### `get-ipam-discovered-accounts` O código de exemplo a seguir mostra como usar `get-ipam-discovered-accounts`. **AWS CLI** **Visualizar as contas descobertas por um IPAM** Nesse cenário, você é um administrador delegado do IPAM que deseja visualizar as contas AWS que possuem recursos que o IPAM está descobrindo. `--discovery-region` é a região operacional do IPAM na qual você deseja visualizar os status da conta monitorada. Por exemplo, se você tiver três regiões operacionais do IPAM, talvez queira fazer essa solicitação três vezes para ver as marcações de hora específicas para a descoberta em cada uma dessas regiões específicas. O exemplo `get-ipam-discovered-accounts` a seguir lista as contas AWS que possuem recursos que o IPAM está descobrindo. ``` aws ec2 get-ipam-discovered-accounts \ --ipam-resource-discovery-id ipam-res-disco-0365d2977fc1672fe \ --discovery-region us-east-1 ``` Resultado: ``` { "IpamDiscoveredAccounts": [ { "AccountId": "149977607591", "DiscoveryRegion": "us-east-1", "LastAttemptedDiscoveryTime": "2024-02-09T19:04:31.379000+00:00", "LastSuccessfulDiscoveryTime": "2024-02-09T19:04:31.379000+00:00" } ] } ``` Para obter mais informações, consulte [Integrar o IPAM com contas fora da sua organização](https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam-outside-org.html) no *Guia do usuário do IPAM da Amazon VPC*. + Para ver detalhes da API, consulte [GetIpamDiscoveredAccounts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-ipam-discovered-accounts.html) na *Referência de comandos da AWS CLI*. ### `get-ipam-discovered-public-addresses` O código de exemplo a seguir mostra como usar `get-ipam-discovered-public-addresses`. **AWS CLI** **Visualizar endereços IP públicos descobertos** Neste exemplo, você é um administrador delegado do IPAM e deseja visualizar os endereços IP dos recursos descobertos pelo IPAM. Você pode obter o ID de descoberta do recurso com [describe-ipam-resource-discoveries](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-ipam-resource-discoveries.html). O exemplo `get-ipam-discovered-public-addresses` a seguir mostra os endereços IP públicos descobertos para uma descoberta de recursos. ``` aws ec2 get-ipam-discovered-public-addresses \ --ipam-resource-discovery-id ipam-res-disco-0f4ef577a9f37a162 \ --address-region us-east-1 \ --region us-east-1 ``` Resultado: ``` { "IpamDiscoveredPublicAddresses": [ { "IpamResourceDiscoveryId": "ipam-res-disco-0f4ef577a9f37a162", "AddressRegion": "us-east-1", "Address": "54.208.155.7", "AddressOwnerId": "320805250157", "AssociationStatus": "associated", "AddressType": "ec2-public-ip", "VpcId": "vpc-073b294916198ce49", "SubnetId": "subnet-0b6c8a8839e9a4f15", "NetworkInterfaceId": "eni-081c446b5284a5e06", "NetworkInterfaceDescription": "", "InstanceId": "i-07459a6fca5b35823", "Tags": {}, "NetworkBorderGroup": "us-east-1c", "SecurityGroups": [ { "GroupName": "launch-wizard-2", "GroupId": "sg-0a489dd6a65c244ce" } ], "SampleTime": "2024-04-05T15:13:59.228000+00:00" }, { "IpamResourceDiscoveryId": "ipam-res-disco-0f4ef577a9f37a162", "AddressRegion": "us-east-1", "Address": "44.201.251.218", "AddressOwnerId": "470889052923", "AssociationStatus": "associated", "AddressType": "ec2-public-ip", "VpcId": "vpc-6c31a611", "SubnetId": "subnet-062f47608b99834b1", "NetworkInterfaceId": "eni-024845359c2c3ae9b", "NetworkInterfaceDescription": "", "InstanceId": "i-04ef786d9c4e03f41", "Tags": {}, "NetworkBorderGroup": "us-east-1a", "SecurityGroups": [ { "GroupName": "launch-wizard-32", "GroupId": "sg-0ed1a426e96a68374" } ], "SampleTime": "2024-04-05T15:13:59.145000+00:00" } } ``` Para obter mais informações, consulte [Visualizar Insights de IP público](https://docs.aws.amazon.com/vpc/latest/ipam/view-public-ip-insights.html), no *Guia do usuário IPAM da Amazon VPC*. + Para ver detalhes da API, consulte [GetIpamDiscoveredPublicAddresses](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-ipam-discovered-public-addresses.html) na *Referência de comandos da AWS CLI*. ### `get-ipam-discovered-resource-cidrs` O código de exemplo a seguir mostra como usar `get-ipam-discovered-resource-cidrs`. **AWS CLI** **Visualizar os CIDRs do endereço IP descobertos por um IPAM** Neste exemplo, você é um administrador delegado do IPAM que deseja visualizar detalhes relacionados aos CIDRs do endereço IP dos recursos que o IPAM está descobrindo. Para concluir essa solicitação: A descoberta de recursos que você escolher deve estar associada ao IPAM. `--resource-region` é a região da AWS em que o recurso foi criado. O exemplo `get-ipam-discovered-resource-cidrs` a seguir lista os endereços IP dos recursos que o IPAM está descobrindo. ``` aws ec2 get-ipam-discovered-resource-cidrs \ --ipam-resource-discovery-id ipam-res-disco-0365d2977fc1672fe \ --resource-region us-east-1 ``` Resultado: ``` { { "IpamDiscoveredResourceCidrs": [ { "IpamResourceDiscoveryId": "ipam-res-disco-0365d2977fc1672fe", "ResourceRegion": "us-east-1", "ResourceId": "vpc-0c974c95ca7ceef4a", "ResourceOwnerId": "149977607591", "ResourceCidr": "172.31.0.0/16", "ResourceType": "vpc", "ResourceTags": [], "IpUsage": 0.375, "VpcId": "vpc-0c974c95ca7ceef4a", "SampleTime": "2024-02-09T19:15:16.529000+00:00" }, { "IpamResourceDiscoveryId": "ipam-res-disco-0365d2977fc1672fe", "ResourceRegion": "us-east-1", "ResourceId": "subnet-07fe028119082a8c1", "ResourceOwnerId": "149977607591", "ResourceCidr": "172.31.0.0/20", "ResourceType": "subnet", "ResourceTags": [], "IpUsage": 0.0012, "VpcId": "vpc-0c974c95ca7ceef4a", "SampleTime": "2024-02-09T19:15:16.529000+00:00" }, { "IpamResourceDiscoveryId": "ipam-res-disco-0365d2977fc1672fe", "ResourceRegion": "us-east-1", "ResourceId": "subnet-0a96893763984cc4e", "ResourceOwnerId": "149977607591", "ResourceCidr": "172.31.64.0/20", "ResourceType": "subnet", "ResourceTags": [], "IpUsage": 0.0012, "VpcId": "vpc-0c974c95ca7ceef4a", "SampleTime": "2024-02-09T19:15:16.529000+00:00" } } } ``` Para obter mais informações, consulte [Monitorar o uso CIDR por recurso](https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html) no *Guia do usuário IPAM da Amazon VPC*. + Para ver detalhes da API, consulte [GetIpamDiscoveredResourceCidrs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-ipam-discovered-resource-cidrs.html) na *Referência de comandos da AWS CLI*. ### `get-ipam-pool-allocations` O código de exemplo a seguir mostra como usar `get-ipam-pool-allocations`. **AWS CLI** **Obter os CIDRs alocados de um grupo do IPAM** O exemplo `get-ipam-pool-allocations` a seguir obtém os CIDRs alocados de um grupo do IPAM. (Linux): ``` aws ec2 get-ipam-pool-allocations \ --ipam-pool-id ipam-pool-0533048da7d823723 \ --filters Name=ipam-pool-allocation-id,Values=ipam-pool-alloc-0e6186d73999e47389266a5d6991e6220 ``` (Windows): ``` aws ec2 get-ipam-pool-allocations ^ --ipam-pool-id ipam-pool-0533048da7d823723 ^ --filters Name=ipam-pool-allocation-id,Values=ipam-pool-alloc-0e6186d73999e47389266a5d6991e6220 ``` Resultado: ``` { "IpamPoolAllocations": [ { "Cidr": "10.0.0.0/16", "IpamPoolAllocationId": "ipam-pool-alloc-0e6186d73999e47389266a5d6991e6220", "ResourceType": "custom", "ResourceOwner": "123456789012" } ] } ``` + Para ver detalhes da API, consulte [GetIpamPoolAllocations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-ipam-pool-allocations.html) na *Referência de comandos da AWS CLI*. ### `get-ipam-pool-cidrs` O código de exemplo a seguir mostra como usar `get-ipam-pool-cidrs`. **AWS CLI** **Colocar os CIDRs provisionados em um pool do IPAM** O exemplo `get-ipam-pool-cidrs` a seguir coloca os CIDRs provisionados em um pool do IPAM. (Linux): ``` aws ec2 get-ipam-pool-cidrs \ --ipam-pool-id ipam-pool-0533048da7d823723 \ --filters 'Name=cidr,Values=10.*' ``` (Windows): ``` aws ec2 get-ipam-pool-cidrs ^ --ipam-pool-id ipam-pool-0533048da7d823723 ^ --filters Name=cidr,Values=10.* ``` Resultado: ``` { "IpamPoolCidr": { "Cidr": "10.0.0.0/24", "State": "provisioned" } } ``` + Para ver detalhes da API, consulte [GetIpamPoolCidrs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-ipam-pool-cidrs.html) na *Referência de comandos da AWS CLI*. ### `get-ipam-resource-cidrs` O código de exemplo a seguir mostra como usar `get-ipam-resource-cidrs`. **AWS CLI** **Colocar os CIDRs alocados em um recurso** O exemplo `get-ipam-resource-cidrs` a seguir coloca os CIDRs alocados em um recurso. (Linux): ``` aws ec2 get-ipam-resource-cidrs \ --ipam-scope-id ipam-scope-02fc38cd4c48e7d38 \ --filters Name=management-state,Values=unmanaged ``` (Windows): ``` aws ec2 get-ipam-resource-cidrs ^ --ipam-scope-id ipam-scope-02fc38cd4c48e7d38 ^ --filters Name=management-state,Values=unmanaged ``` Resultado: ``` { "IpamResourceCidrs": [ { "IpamId": "ipam-08440e7a3acde3908", "IpamScopeId": "ipam-scope-02fc38cd4c48e7d38", "ResourceRegion": "us-east-2", "ResourceOwnerId": "123456789012", "ResourceId": "vpc-621b8709", "ResourceName": "Default AWS VPC", "ResourceCidr": "172.33.0.0/16", "ResourceType": "vpc", "ResourceTags": [ { "Key": "Environment", "Value": "Test" }, { "Key": "Name", "Value": "Default AWS VPC" } ], "IpUsage": 0.0039, "ComplianceStatus": "unmanaged", "ManagementState": "unmanaged", "OverlapStatus": "nonoverlapping", "VpcId": "vpc-621b8709" } ] } ``` Para obter mais informações, consulte [Monitorar o uso CIDR por recurso](https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html) no *Guia do usuário IPAM da Amazon VPC*. + Para ver detalhes da API, consulte [GetIpamResourceCidrs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-ipam-resource-cidrs.html) na *Referência de comandos da AWS CLI*. ### `get-launch-template-data` O código de exemplo a seguir mostra como usar `get-launch-template-data`. **AWS CLI** **Obter dados da instância de um modelo de execução** Este exemplo obtém dados sobre a instância especificada e usa a opção `--query` para retornar o conteúdo `LaunchTemplateData`. É possível usar o resultado como base para criar um novo modelo de execução ou uma versão de modelo de execução. Comando: ``` aws ec2 get-launch-template-data --instance-id i-0123d646e8048babc --query 'LaunchTemplateData' ``` Resultado: ``` { "Monitoring": {}, "ImageId": "ami-8c1be5f6", "BlockDeviceMappings": [ { "DeviceName": "/dev/xvda", "Ebs": { "DeleteOnTermination": true } } ], "EbsOptimized": false, "Placement": { "Tenancy": "default", "GroupName": "", "AvailabilityZone": "us-east-1a" }, "InstanceType": "t2.micro", "NetworkInterfaces": [ { "Description": "", "NetworkInterfaceId": "eni-35306abc", "PrivateIpAddresses": [ { "Primary": true, "PrivateIpAddress": "10.0.0.72" } ], "SubnetId": "subnet-7b16de0c", "Groups": [ "sg-7c227019" ], "Ipv6Addresses": [ { "Ipv6Address": "2001:db8:1234:1a00::123" } ], "PrivateIpAddress": "10.0.0.72" } ] } ``` + Para ver detalhes da API, consulte [GetLaunchTemplateData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-launch-template-data.html) na *Referência de comandos da AWS CLI*. ### `get-managed-prefix-list-associations` O código de exemplo a seguir mostra como usar `get-managed-prefix-list-associations`. **AWS CLI** **Obter associações de listas de prefixos** O exemplo `get-managed-prefix-list-associations` a seguir obtém os recursos associados à lista de prefixos especificada. ``` aws ec2 get-managed-prefix-list-associations \ --prefix-list-id pl-0123456abcabcabc1 ``` Resultado: ``` { "PrefixListAssociations": [ { "ResourceId": "sg-0abc123456abc12345", "ResourceOwner": "123456789012" } ] } ``` Para obter mais informações, consulte [Listas de prefixos gerenciados](https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html) no *Guia do usuário da Amazon VPC*. + Para ver detalhes da API, consulte [GetManagedPrefixListAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-managed-prefix-list-associations.html) na *Referência de comandos da AWS CLI*. ### `get-managed-prefix-list-entries` O código de exemplo a seguir mostra como usar `get-managed-prefix-list-entries`. **AWS CLI** **Obter as entradas da lista de prefixos** O `get-managed-prefix-list-entries` a seguir obtém as entradas para a lista de prefixos especificada. ``` aws ec2 get-managed-prefix-list-entries \ --prefix-list-id pl-0123456abcabcabc1 ``` Resultado: ``` { "Entries": [ { "Cidr": "10.0.0.0/16", "Description": "vpc-a" }, { "Cidr": "10.2.0.0/16", "Description": "vpc-b" } ] } ``` Para obter mais informações, consulte [Listas de prefixos gerenciados](https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html) no *Guia do usuário da Amazon VPC*. + Para ver detalhes da API, consulte [GetManagedPrefixListEntries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-managed-prefix-list-entries.html) na *Referência de comandos da AWS CLI*. ### `get-network-insights-access-scope-analysis-findings` O código de exemplo a seguir mostra como usar `get-network-insights-access-scope-analysis-findings`. **AWS CLI** **Obter as descobertas da análise do escopo de acesso do Network Insights** O exemplo `get-network-insights-access-scope-analysis-findings` a seguir obtém as descobertas da análise de escopo selecionada em sua conta da AWS. ``` aws ec2 get-network-insights-access-scope-analysis-findings \ --region us-east-1 \ --network-insights-access-scope-analysis-id nis \ --nis-123456789111 ``` Resultado: ``` { "NetworkInsightsAccessScopeAnalysisId": "nisa-123456789222", "AnalysisFindings": [ { "NetworkInsightsAccessScopeAnalysisId": "nisa-123456789222", "NetworkInsightsAccessScopeId": "nis-123456789111", "FindingComponents": [ { "SequenceNumber": 1, "Component": { "Id": "eni-02e3d42d5cceca67d", "Arn": "arn:aws:ec2:us-east-1:936459623503:network-interface/eni-02e3d32d9cceca17d" }, "OutboundHeader": { "DestinationAddresses": [ "0.0.0.0/5", "11.0.0.0/8", "12.0.0.0/6", "128.0.0.0/3", "16.0.0.0/4", "160.0.0.0/5", "168.0.0.0/6", "172.0.0.0/12" "8.0.0.0/7" ], "DestinationPortRanges": [ { "From": 0, "To": 65535 } ], "Protocol": "6", "SourceAddresses": [ "10.0.2.253/32" ], "SourcePortRanges": [ { "From": 0, "To": 65535 } ] }, [etc] ] } } ] } ``` Para obter mais informações, consulte [Introdução ao Analisador de Acesso à Rede usando AWS CLI](https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/getting-started-cli.html) no *Guia do Analisador de Acesso à Rede*. + Para ver detalhes da API, consulte [GetNetworkInsightsAccessScopeAnalysisFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-network-insights-access-scope-analysis-findings.html) na *Referência de comandos da AWS CLI*. ### `get-network-insights-access-scope-content` O código de exemplo a seguir mostra como usar `get-network-insights-access-scope-content`. **AWS CLI** **Para que o Network Insights acesse o conteúdo do escopo** O exemplo `get-network-insights-access-scope-content` a seguir obtém o conteúdo do ID de análise de escopo selecionado em sua conta da AWS. ``` aws ec2 get-network-insights-access-scope-content \ --region us-east-1 \ --network-insights-access-scope-id nis-123456789222 ``` Resultado: ``` { "NetworkInsightsAccessScopeContent": { "NetworkInsightsAccessScopeId": "nis-123456789222", "MatchPaths": [ { "Source": { "ResourceStatement": { "ResourceTypes": [ "AWS::EC2::NetworkInterface" ] } }, "Destination": { "ResourceStatement": { "ResourceTypes": [ "AWS::EC2::InternetGateway" ] } } } ] } } ``` Para obter mais informações, consulte [Introdução ao Analisador de Acesso à Rede usando AWS CLI](https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/getting-started-cli.html) no *Guia do Analisador de Acesso à Rede*. + Para ver detalhes da API, consulte [GetNetworkInsightsAccessScopeContent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-network-insights-access-scope-content.html) na *Referência de comandos da AWS CLI*. ### `get-password-data` O código de exemplo a seguir mostra como usar `get-password-data`. **AWS CLI** **Obter a senha criptografada** Este exemplo obtém a senha criptografada. Comando: ``` aws ec2 get-password-data --instance-id i-1234567890abcdef0 ``` Resultado: ``` { "InstanceId": "i-1234567890abcdef0", "Timestamp": "2013-08-07T22:18:38.000Z", "PasswordData": "gSlJFq+VpcZXqy+iktxMF6NyxQ4qCrT4+gaOuNOenX1MmgXPTj7XEXAMPLE UQ+YeFfb+L1U4C4AKv652Ux1iRB3CPTYP7WmU3TUnhsuBd+p6LVk7T2lKUml6OXbk6WPW1VYYm/TRPB1 e1DQ7PY4an/DgZT4mwcpRFigzhniQgDDeO1InvSDcwoUTwNs0Y1S8ouri2W4n5GNlriM3Q0AnNVelVz/ 53TkDtxbNoU606M1gK9zUWSxqEgwvbV2j8c5rP0WCuaMWSFl4ziDu4bd7q+4RSyi8NUsVWnKZ4aEZffu DPGzKrF5yLlf3etP2L4ZR6CvG7K1hx7VKOQVN32Dajw==" } ``` **Obter a senha descriptografada** Este exemplo obtém a senha descriptografada. Comando: ``` aws ec2 get-password-data --instance-id i-1234567890abcdef0 --priv-launch-key C:\Keys\MyKeyPair.pem ``` Resultado: ``` { "InstanceId": "i-1234567890abcdef0", "Timestamp": "2013-08-30T23:18:05.000Z", "PasswordData": "&ViJ652e*u" } ``` + Para ver detalhes da API, consulte [GetPasswordData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-password-data.html) na *Referência de comandos da AWS CLI*. ### `get-reserved-instances-exchange-quote` O código de exemplo a seguir mostra como usar `get-reserved-instances-exchange-quote`. **AWS CLI** **Obter uma cotação para trocar uma Instância Reservada Conversível** Este exemplo obtém as informações de troca para as Instâncias Reservadas Conversíveis especificadas. Comando: ``` aws ec2 get-reserved-instances-exchange-quote --reserved-instance-ids 7b8750c3-397e-4da4-bbcb-a45ebexample --target-configurations OfferingId=6fea5434-b379-434c-b07b-a7abexample ``` Resultado: ``` { "CurrencyCode": "USD", "ReservedInstanceValueSet": [ { "ReservedInstanceId": "7b8750c3-397e-4da4-bbcb-a45ebexample", "ReservationValue": { "RemainingUpfrontValue": "0.000000", "HourlyPrice": "0.027800", "RemainingTotalValue": "730.556200" } } ], "PaymentDue": "424.983828", "TargetConfigurationValueSet": [ { "TargetConfiguration": { "InstanceCount": 5, "OfferingId": "6fea5434-b379-434c-b07b-a7abexample" }, "ReservationValue": { "RemainingUpfrontValue": "424.983828", "HourlyPrice": "0.016000", "RemainingTotalValue": "845.447828" } } ], "IsValidExchange": true, "OutputReservedInstancesWillExpireAt": "2020-10-01T13:03:39Z", "ReservedInstanceValueRollup": { "RemainingUpfrontValue": "0.000000", "HourlyPrice": "0.027800", "RemainingTotalValue": "730.556200" }, "TargetConfigurationValueRollup": { "RemainingUpfrontValue": "424.983828", "HourlyPrice": "0.016000", "RemainingTotalValue": "845.447828" } } ``` + Para ver detalhes da API, consulte [GetReservedInstancesExchangeQuote](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-reserved-instances-exchange-quote.html) na *Referência de comandos da AWS CLI*. ### `get-security-groups-for-vpc` O código de exemplo a seguir mostra como usar `get-security-groups-for-vpc`. **AWS CLI** **Visualizar grupos de segurança que podem ser associados a interfaces de rede em uma VPC especificada.** O exemplo `get-security-groups-for-vpc` a seguir mostra os grupos de segurança que podem ser associados às interfaces de rede na VPC. ``` aws ec2 get-security-groups-for-vpc \ --vpc-id vpc-6c31a611 \ --region us-east-1 ``` Resultado: ``` { "SecurityGroupForVpcs": [ { "Description": "launch-wizard-36 created 2022-08-29T15:59:35.338Z", "GroupName": "launch-wizard-36", "OwnerId": "470889052923", "GroupId": "sg-007e0c3027ee885f5", "Tags": [], "PrimaryVpcId": "vpc-6c31a611" }, { "Description": "launch-wizard-18 created 2024-01-19T20:22:27.527Z", "GroupName": "launch-wizard-18", "OwnerId": "470889052923", "GroupId": "sg-0147193bef51c9eef", "Tags": [], "PrimaryVpcId": "vpc-6c31a611" } } ``` + Para ver detalhes da API, consulte [GetSecurityGroupsForVpc](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-security-groups-for-vpc.html) na *Referência de comandos da AWS CLI*. ### `get-serial-console-access-status` O código de exemplo a seguir mostra como usar `get-serial-console-access-status`. **AWS CLI** **Visualizar o status do acesso da conta ao console de série** O exemplo `get-serial-console-access-status` a seguir determina se o acesso ao console de série está habilitado para sua conta. ``` aws ec2 get-serial-console-access-status ``` Resultado: ``` { "SerialConsoleAccessEnabled": true } ``` Para obter mais informações, consulte [Console de Série do EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-serial-console.html) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [GetSerialConsoleAccessStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-serial-console-access-status.html) na *Referência de comandos da AWS CLI*. ### `get-snapshot-block-public-access-state` O código de exemplo a seguir mostra como usar `get-snapshot-block-public-access-state`. **AWS CLI** **Obter o status atual do bloqueio do acesso público para snapshots** O exemplo `get-snapshot-block-public-access-state` a seguir mostra o estado atual do bloqueio do acesso público aos snapshots. ``` aws ec2 get-snapshot-block-public-access-state ``` Resultado: ``` { "State": "block-all-sharing" } ``` Para obter mais informações, consulte [Bloquear acesso público aos snapshots](https://docs.aws.amazon.com/ebs/latest/userguide/block-public-access-snapshots.html) no *Guia do usuário do Amazon EBS*. + Para ver detalhes da API, consulte [GetSnapshotBlockPublicAccessState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-snapshot-block-public-access-state.html) na *Referência de comandos da AWS CLI*. ### `get-spot-placement-scores` O código de exemplo a seguir mostra como usar `get-spot-placement-scores`. **AWS CLI** **Calcular a pontuação de posicionamento de Spot para requisitos especificados** O exemplo `get-spot-placement-scores` a seguir gera primeiro uma lista de todos os parâmetros possíveis que podem ser especificados para a configuração da pontuação de posicionamento de Spot usando o parâmetro `--generate-cli-skeleton` e salva a lista em um arquivo JSON. Em seguida, o arquivo JSON é usado para configurar os requisitos a serem usados para calcular a pontuação de posicionamento Spot. Gerar todos os parâmetros possíveis que podem ser especificados para a configuração da pontuação de posicionamento Spot e salvar a saída diretamente em um arquivo JSON. ``` aws ec2 get-spot-placement-scores \ --region us-east-1 \ --generate-cli-skeleton input > attributes.json ``` Resultado: ``` { "InstanceTypes": [ "" ], "TargetCapacity": 0, "TargetCapacityUnitType": "vcpu", "SingleAvailabilityZone": true, "RegionNames": [ "" ], "InstanceRequirementsWithMetadata": { "ArchitectureTypes": [ "x86_64_mac" ], "VirtualizationTypes": [ "hvm" ], "InstanceRequirements": { "VCpuCount": { "Min": 0, "Max": 0 }, "MemoryMiB": { "Min": 0, "Max": 0 }, "CpuManufacturers": [ "amd" ], "MemoryGiBPerVCpu": { "Min": 0.0, "Max": 0.0 }, "ExcludedInstanceTypes": [ "" ], "InstanceGenerations": [ "previous" ], "SpotMaxPricePercentageOverLowestPrice": 0, "OnDemandMaxPricePercentageOverLowestPrice": 0, "BareMetal": "excluded", "BurstablePerformance": "excluded", "RequireHibernateSupport": true, "NetworkInterfaceCount": { "Min": 0, "Max": 0 }, "LocalStorage": "included", "LocalStorageTypes": [ "hdd" ], "TotalLocalStorageGB": { "Min": 0.0, "Max": 0.0 }, "BaselineEbsBandwidthMbps": { "Min": 0, "Max": 0 }, "AcceleratorTypes": [ "fpga" ], "AcceleratorCount": { "Min": 0, "Max": 0 }, "AcceleratorManufacturers": [ "amd" ], "AcceleratorNames": [ "vu9p" ], "AcceleratorTotalMemoryMiB": { "Min": 0, "Max": 0 } } }, "DryRun": true, "MaxResults": 0, "NextToken": "" } ``` Configurar o arquivo JSON. Você deve fornecer um valor para : `TargetCapacity`. Para obter uma descrição de cada parâmetro e seus valores padrão, consulte Calcular a pontuação de posicionamento Spot (AWS CLI) . Calcule uma pontuação de posicionamento Spot para os requisitos especificados em `attributes.json`. Especifique o nome e o caminho para seu arquivo JSON usando o parâmetro `--cli-input-json`. ``` aws ec2 get-spot-placement-scores \ --region us-east-1 \ --cli-input-json file://attributes.json ``` Saída se `SingleAvailabilityZone` estiver definido como `false` ou omitido (se omitido, o padrão é `false`). Uma lista pontuada de regiões é retornada. ``` "Recommendation": [ { "Region": "us-east-1", "Score": 7 }, { "Region": "us-west-1", "Score": 5 }, ... ``` Saída se `SingleAvailabilityZone` estiver definido como `true`. Uma lista pontuada de Zonas de Disponibilidade Únicas é retornada. ``` "Recommendation": [ { "Region": "us-east-1", "AvailabilityZoneId": "use1-az1" "Score": 8 }, { "Region": "us-east-1", "AvailabilityZoneId": "usw2-az3" "Score": 6 }, ... ``` Para obter mais informações sobre o cálculo de uma pontuação de posicionamento Spot, e para exemplos de configurações, consulte [Calcular uma pontuação de posicionamento Spot](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html#work-with-spot-placement-score) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [GetSpotPlacementScores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-spot-placement-scores.html) na *Referência de comandos da AWS CLI*. ### `get-subnet-cidr-reservations` O código de exemplo a seguir mostra como usar `get-subnet-cidr-reservations`. **AWS CLI** **Obter informações sobre uma reserva CIDR de sub-rede** O exemplo `get-subnet-cidr-reservations` a seguir mostra as informações da reserva de sub-rede CIDR especificada. ``` aws ec2 get-subnet-cidr-reservations \ --subnet-id subnet-03c51e2e6cEXAMPLE ``` Resultado: ``` { "SubnetIpv4CidrReservations": [ { "SubnetCidrReservationId": "scr-044f977c4eEXAMPLE", "SubnetId": "subnet-03c51e2e6cEXAMPLE", "Cidr": "10.1.0.16/28", "ReservationType": "prefix", "OwnerId": "123456789012" } ], "SubnetIpv6CidrReservations": [] } ``` Para obter mais informações, consulte [Comportamento do endereçamento IP para sua sub-rede](https://docs.aws.amazon.com/vpc/latest/userguide/subnet-cidr-reservation.html) no *Guia do usuário da Amazon VPC*. + Para ver detalhes da API, consulte [GetSubnetCidrReservations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-subnet-cidr-reservations.html) na *Referência de comandos da AWS CLI*. ### `get-transit-gateway-attachment-propagations` O código de exemplo a seguir mostra como usar `get-transit-gateway-attachment-propagations`. **AWS CLI** **Listar as tabelas de rotas para as quais o anexo de recurso especificado propaga rotas** O exemplo `get-transit-gateway-attachment-propagations` a seguir lista as tabelas de rotas para as quais o anexo de recurso especificado propaga rotas. ``` aws ec2 get-transit-gateway-attachment-propagations \ --transit-gateway-attachment-id tgw-attach-09fbd47ddfEXAMPLE ``` Resultado: ``` { "TransitGatewayAttachmentPropagations": [ { "TransitGatewayRouteTableId": "tgw-rtb-0882c61b97EXAMPLE", "State": "enabled" } ] } ``` Para obter mais informações, consulte [Tabelas de rota do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [GetTransitGatewayAttachmentPropagations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-transit-gateway-attachment-propagations.html) na *Referência de comandos da AWS CLI*. ### `get-transit-gateway-multicast-domain-associations` O código de exemplo a seguir mostra como usar `get-transit-gateway-multicast-domain-associations`. **AWS CLI** **Visualizar informações sobre as associações de um domínio multicast de gateway de trânsito** O exemplo `get-transit-gateway-multicast-domain-associations` a seguir retorna as associações para o domínio multicast especificado. ``` aws ec2 get-transit-gateway-multicast-domain-associations \ --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef7EXAMPLE ``` Resultado: ``` { "MulticastDomainAssociations": [ { "TransitGatewayAttachmentId": "tgw-attach-028c1dd0f8EXAMPLE", "ResourceId": "vpc-01128d2c24EXAMPLE", "ResourceType": "vpc", "Subnet": { "SubnetId": "subnet-000de86e3bEXAMPLE", "State": "associated" } }, { "TransitGatewayAttachmentId": "tgw-attach-070e571cd1EXAMPLE", "ResourceId": "vpc-7EXAMPLE", "ResourceType": "vpc", "Subnet": { "SubnetId": "subnet-4EXAMPLE", "State": "associated" } }, { "TransitGatewayAttachmentId": "tgw-attach-070e571cd1EXAMPLE", "ResourceId": "vpc-7EXAMPLE", "ResourceType": "vpc", "Subnet": { "SubnetId": "subnet-5EXAMPLE", "State": "associated" } }, { "TransitGatewayAttachmentId": "tgw-attach-070e571cd1EXAMPLE", "ResourceId": "vpc-7EXAMPLE", "ResourceType": "vpc", "Subnet": { "SubnetId": "subnet-aEXAMPLE", "State": "associated" } }, { "TransitGatewayAttachmentId": "tgw-attach-070e571cd1EXAMPLE", "ResourceId": "vpc-7EXAMPLE", "ResourceType": "vpc", "Subnet": { "SubnetId": "subnet-fEXAMPLE", "State": "associated" } } ] } ``` Consulte mais informações em [Multicast domains](https://docs.aws.amazon.com/vpc/latest/tgw/multicast-domains-about.html) no *Guia do Transit Gateway*. + Para ver detalhes da API, consulte [GetTransitGatewayMulticastDomainAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-transit-gateway-multicast-domain-associations.html) na *Referência de comandos da AWS CLI*. ### `get-transit-gateway-prefix-list-references` O código de exemplo a seguir mostra como usar `get-transit-gateway-prefix-list-references`. **AWS CLI** **Obter referências a uma lista de prefixos na tabela de rotas do gateway de trânsito** O exemplo `get-transit-gateway-prefix-list-references` a seguir obtém as referências da lista de prefixos para a tabela de rotas do Gateway de Trânsito especificada e filtra pelo ID de uma lista de prefixos específica. ``` aws ec2 get-transit-gateway-prefix-list-references \ --transit-gateway-route-table-id tgw-rtb-0123456789abcd123 \ --filters Name=prefix-list-id,Values=pl-11111122222222333 ``` Resultado: ``` { "TransitGatewayPrefixListReferences": [ { "TransitGatewayRouteTableId": "tgw-rtb-0123456789abcd123", "PrefixListId": "pl-11111122222222333", "PrefixListOwnerId": "123456789012", "State": "available", "Blackhole": false, "TransitGatewayAttachment": { "TransitGatewayAttachmentId": "tgw-attach-aabbccddaabbccaab", "ResourceType": "vpc", "ResourceId": "vpc-112233445566aabbc" } } ] } ``` Para obter mais informações, consulte [Referências de lista de prefixos](https://docs.aws.amazon.com/vpc/latest/tgw/create-prefix-list-reference.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [GetTransitGatewayPrefixListReferences](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-transit-gateway-prefix-list-references.html) na *Referência de comandos da AWS CLI*. ### `get-transit-gateway-route-table-associations` O código de exemplo a seguir mostra como usar `get-transit-gateway-route-table-associations`. **AWS CLI** **Obter informações sobre as associações para a tabela de rotas do gateway de trânsito** O exemplo `get-transit-gateway-route-table-associations` a seguir exibe informações sobre as associações para as tabelas de rotas de gateway de trânsito especificadas. ``` aws ec2 get-transit-gateway-route-table-associations \ --transit-gateway-route-table-id tgw-rtb-0a823edbdeEXAMPLE ``` Resultado: ``` { "Associations": [ { "TransitGatewayAttachmentId": "tgw-attach-09b52ccdb5EXAMPLE", "ResourceId": "vpc-4d7de228", "ResourceType": "vpc", "State": "associating" } ] } ``` Para obter mais informações, consulte [Tabelas de rota do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html#associate-tgw-route-table) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [GetTransitGatewayRouteTableAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-transit-gateway-route-table-associations.html) na *Referência de comandos da AWS CLI*. ### `get-transit-gateway-route-table-propagations` O código de exemplo a seguir mostra como usar `get-transit-gateway-route-table-propagations`. **AWS CLI** **Exibir informações sobre as propagações para a tabela de rotas do gateway de trânsito especificado** O exemplo `get-transit-gateway-route-table-propagations` a seguir retorna as propagações da tabela de rotas para a tabela de rotas especificada. ``` aws ec2 get-transit-gateway-route-table-propagations \ --transit-gateway-route-table-id tgw-rtb-002573ed1eEXAMPLE ``` Resultado: ``` { "TransitGatewayRouteTablePropagations": [ { "TransitGatewayAttachmentId": "tgw-attach-01f8100bc7EXAMPLE", "ResourceId": "vpc-3EXAMPLE", "ResourceType": "vpc", "State": "enabled" }, { "TransitGatewayAttachmentId": "tgw-attach-08e0bc912cEXAMPLE", "ResourceId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE", "ResourceType": "direct-connect-gateway", "State": "enabled" }, { "TransitGatewayAttachmentId": "tgw-attach-0a89069f57EXAMPLE", "ResourceId": "8384da05-13ce-4a91-aada-5a1baEXAMPLE", "ResourceType": "direct-connect-gateway", "State": "enabled" } ] } ``` Para obter mais informações, consulte [Tabelas de rota do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [GetTransitGatewayRouteTablePropagations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-transit-gateway-route-table-propagations.html) na *Referência de comandos da AWS CLI*. ### `get-verified-access-endpoint-policy` O código de exemplo a seguir mostra como usar `get-verified-access-endpoint-policy`. **AWS CLI** **Obter a política de acesso verificado de um endpoint** O exemplo `get-verified-access-endpoint-policy` a seguir obtém a política de acesso verificado do endpoint especificado. ``` aws ec2 get-verified-access-endpoint-policy \ --verified-access-endpoint-id vae-066fac616d4d546f2 ``` Resultado: ``` { "PolicyEnabled": true, "PolicyDocument": "permit(principal,action,resource)\nwhen {\n context.identity.groups.contains(\"finance\") &&\n context.identity.email_verified == true\n};" } ``` Para obter mais informações, consulte [Políticas de acesso verificado](https://docs.aws.amazon.com/verified-access/latest/ug/auth-policies.html) no *Guia do usuário do acesso verificado da AWS*. + Para ver detalhes da API, consulte [GetVerifiedAccessEndpointPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-verified-access-endpoint-policy.html) na *Referência de comandos da AWS CLI*. ### `get-verified-access-group-policy` O código de exemplo a seguir mostra como usar `get-verified-access-group-policy`. **AWS CLI** **Obter a política de acesso verificado de um grupo** O exemplo `get-verified-access-group-policy` a seguir obtém a política de acesso verificado do grupo especificado. ``` aws ec2 get-verified-access-group-policy \ --verified-access-group-id vagr-0dbe967baf14b7235 ``` Resultado: ``` { "PolicyEnabled": true, "PolicyDocument": "permit(principal,action,resource)\nwhen {\n context.identity.groups.contains(\"finance\") &&\n context.identity.email_verified == true\n};" } ``` Para obter mais informações, consulte [Grupos de acesso verificado](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-groups.html) no *Guia do usuário do acesso verificado da AWS*. + Para ver detalhes da API, consulte [GetVerifiedAccessGroupPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-verified-access-group-policy.html) na *Referência de comandos da AWS CLI*. ### `get-vpn-connection-device-sample-configuration` O código de exemplo a seguir mostra como usar `get-vpn-connection-device-sample-configuration`. **AWS CLI** **Fazer download do arquivo de amostra de configuração** O exemplo `get-vpn-connection-device-sample-configuration` a seguir faz download do arquivo de configuração de amostra especificado. Para listar os dispositivos de gateway com um arquivo de configuração de amostra, chame o comando `get-vpn-connection-device-types`. ``` aws ec2 get-vpn-connection-device-sample-configuration \ --vpn-connection-id vpn-123456789abc01234 \ --vpn-connection-device-type-id 5fb390ba ``` Resultado: ``` { "VpnConnectionDeviceSampleConfiguration": "contents-of-the-sample-configuration-file" } ``` Para obter mais informações, consulte [Fazer download do arquivo de configuração](https://docs.aws.amazon.com/vpn/latest/s2svpn/SetUpVPNConnections.html#vpn-download-config) no *Guia do usuário do AWS Site-to-Site VPN*. + Para ver detalhes da API, consulte [GetVpnConnectionDeviceSampleConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-vpn-connection-device-sample-configuration.html) na *Referência de comandos da AWS CLI*. ### `get-vpn-connection-device-types` O código de exemplo a seguir mostra como usar `get-vpn-connection-device-types`. **AWS CLI** **Listar dispositivos de gateway com um arquivo de configuração de amostra** O exemplo `get-vpn-connection-device-types` a seguir lista os dispositivos de gateway da Palo Alto Networks que têm exemplos de arquivos de configuração. ``` aws ec2 get-vpn-connection-device-types \ --query "VpnConnectionDeviceTypes[?Vendor==`Palo Alto Networks`]" ``` Resultado: ``` [ { "VpnConnectionDeviceTypeId": "754a6372", "Vendor": "Palo Alto Networks", "Platform": "PA Series", "Software": "PANOS 4.1.2+" }, { "VpnConnectionDeviceTypeId": "9612cbed", "Vendor": "Palo Alto Networks", "Platform": "PA Series", "Software": "PANOS 4.1.2+ (GUI)" }, { "VpnConnectionDeviceTypeId": "5fb390ba", "Vendor": "Palo Alto Networks", "Platform": "PA Series", "Software": "PANOS 7.0+" } ] ``` Para obter mais informações, consulte [Fazer download do arquivo de configuração](https://docs.aws.amazon.com/vpn/latest/s2svpn/SetUpVPNConnections.html#vpn-download-config) no *Guia do usuário do AWS Site-to-Site VPN*. + Para ver detalhes da API, consulte [GetVpnConnectionDeviceTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-vpn-connection-device-types.html) na *Referência de comandos da AWS CLI*. ### `import-client-vpn-client-certificate-revocation-list` O código de exemplo a seguir mostra como usar `import-client-vpn-client-certificate-revocation-list`. **AWS CLI** **Importar uma lista de revogação de certificados de cliente** O exemplo `import-client-vpn-client-certificate-revocation-list` a seguir importa uma lista de revogação de certificados de cliente para o endpoint do Client VPN especificando a localização do arquivo no computador local. ``` aws ec2 import-client-vpn-client-certificate-revocation-list \ --certificate-revocation-list file:///path/to/crl.pem \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde ``` Resultado: ``` { "Return": true } ``` Para obter mais informações, consulte [Listas de revogação de certificados de cliente](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-certificates.html) no *Guia do administrador do AWS Client VPN*. + Para ver detalhes da API, consulte [ImportClientVpnClientCertificateRevocationList](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/import-client-vpn-client-certificate-revocation-list.html) na *Referência de comandos da AWS CLI*. ### `import-image` O código de exemplo a seguir mostra como usar `import-image`. **AWS CLI** **Importar um arquivo de imagem da VM como uma AMI** O exemplo `import-image` a seguir importa o OVA especificado. ``` aws ec2 import-image \ --disk-containers Format=ova,UserBucket="{S3Bucket=my-import-bucket,S3Key=vms/my-server-vm.ova}" ``` Resultado: ``` { "ImportTaskId": "import-ami-1234567890abcdef0", "Progress": "2", "SnapshotDetails": [ { "DiskImageSize": 0.0, "Format": "ova", "UserBucket": { "S3Bucket": "my-import-bucket", "S3Key": "vms/my-server-vm.ova" } } ], "Status": "active", "StatusMessage": "pending" } ``` + Para ver detalhes da API, consulte [ImportImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/import-image.html) na *Referência de comandos da AWS CLI*. ### `import-key-pair` O código de exemplo a seguir mostra como usar `import-key-pair`. **AWS CLI** **Importar uma chave pública** Primeiro, gere um par de chaves com uma ferramenta de sua escolha. Por exemplo, use este comando ssh-keygen: Comando: ``` ssh-keygen -t rsa -C "my-key" -f ~/.ssh/my-key ``` Resultado: ``` Generating public/private rsa key pair. Enter passphrase (empty for no passphrase): Enter same passphrase again: Your identification has been saved in /home/ec2-user/.ssh/my-key. Your public key has been saved in /home/ec2-user/.ssh/my-key.pub. ... ``` Este exemplo de comando importa a chave pública especificada. Comando: ``` aws ec2 import-key-pair --key-name "my-key" --public-key-material fileb://~/.ssh/my-key.pub ``` Resultado: ``` { "KeyName": "my-key", "KeyFingerprint": "1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca" } ``` + Para ver detalhes da API, consulte [ImportKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/import-key-pair.html) na *Referência de comandos da AWS CLI*. ### `import-snapshot` O código de exemplo a seguir mostra como usar `import-snapshot`. **AWS CLI** **Importar um snapshot** O exemplo `import-snapshot` a seguir importa o disco especificado como um snapshot. ``` aws ec2 import-snapshot \ --description "My server VMDK" \ --disk-container Format=VMDK,UserBucket={'S3Bucket=my-import-bucket,S3Key=vms/my-server-vm.vmdk'} ``` Resultado: ``` { "Description": "My server VMDK", "ImportTaskId": "import-snap-1234567890abcdef0", "SnapshotTaskDetail": { "Description": "My server VMDK", "DiskImageSize": "0.0", "Format": "VMDK", "Progress": "3", "Status": "active", "StatusMessage": "pending" "UserBucket": { "S3Bucket": "my-import-bucket", "S3Key": "vms/my-server-vm.vmdk" } } } ``` + Para ver detalhes da API, consulte [ImportSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/import-snapshot.html) na *Referência de comandos da AWS CLI*. ### `list-images-in-recycle-bin` O código de exemplo a seguir mostra como usar `list-images-in-recycle-bin`. **AWS CLI** **Listar as imagens na Lixeira** O exemplo `list-images-in-recycle-bin` a seguir lista todas as imagens que estão atualmente retidas na Lixeira. ``` aws ec2 list-images-in-recycle-bin ``` Resultado: ``` { "Images": [ { "RecycleBinEnterTime": "2022-03-14T15:35:08.000Z", "Description": "Monthly AMI One", "RecycleBinExitTime": "2022-03-15T15:35:08.000Z", "Name": "AMI_01", "ImageId": "ami-0111222333444abcd" } ] } ``` Consulte mais informações em [Recover deleted AMIs from the Recycle Bin](https://docs.aws.amazon.com/ebs/latest/userguide/recycle-bin-working-with-amis.html) no *Manual do usuário do Amazon EBS*. + Para ver detalhes da API, consulte [ListImagesInRecycleBin](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/list-images-in-recycle-bin.html) na *Referência de comandos da AWS CLI*. ### `list-snapshots-in-recycle-bin` O código de exemplo a seguir mostra como usar `list-snapshots-in-recycle-bin`. **AWS CLI** **Exibir snapshots na lixeira** O exemplo `list-snapshots-in-recycle-bin` a seguir lista informações sobre snapshots na Lixeira, incluindo o ID do snapshot, uma descrição do snapshot, o ID do volume do qual o snapshot foi criado, a data e a hora em que o snapshot foi excluído e entrou na Lixeira e a data e a hora em que o período de retenção expira. ``` aws ec2 list-snapshots-in-recycle-bin \ --snapshot-id snap-01234567890abcdef ``` Resultado: ``` { "SnapshotRecycleBinInfo": [ { "Description": "Monthly data backup snapshot", "RecycleBinEnterTime": "2022-12-01T13:00:00.000Z", "RecycleBinExitTime": "2022-12-15T13:00:00.000Z", "VolumeId": "vol-abcdef09876543210", "SnapshotId": "snap-01234567890abcdef" } ] } ``` Consulte mais informações sobre a Lixeira em [Recover deleted snapshots from the Recycle Bin](https://docs.aws.amazon.com/ebs/latest/userguide/recycle-bin-working-with-snaps.html) no *Manual do usuário do Amazon EBS*. + Para ver detalhes da API, consulte [ListSnapshotsInRecycleBin](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/list-snapshots-in-recycle-bin.html) na *Referência de comandos da AWS CLI*. ### `lock-snapshot` O código de exemplo a seguir mostra como usar `lock-snapshot`. **AWS CLI** **Exemplo 1: bloquear um snapshot no modo de governança** O exemplo `lock-snapshot` a seguir bloqueia o snapshot especificado no modo de governança. ``` aws ec2 lock-snapshot \ --snapshot-id snap-0b5e733b4a8df6e0d \ --lock-mode governance \ --lock-duration 365 ``` Resultado: ``` { "SnapshotId": "snap-0b5e733b4a8df6e0d", "LockState": "governance", "LockDuration": 365, "LockCreatedOn": "2024-05-05T00:56:06.208000+00:00", "LockExpiresOn": "2025-05-05T00:56:06.208000+00:00", "LockDurationStartTime": "2024-05-05T00:56:06.208000+00:00" } ``` Para obter mais informações, consulte [Bloqueio de snapshots](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-snapshot-lock.html) no *Guia do usuário do Amazon EBS*. **Exemplo 2: bloquear um snapshot no modo de conformidade** O exemplo `lock-snapshot` a seguir bloqueia o snapshot especificado no modo de conformidade. ``` aws ec2 lock-snapshot \ --snapshot-id snap-0163a8524c5b9901f \ --lock-mode compliance \ --cool-off-period 24 \ --lock-duration 365 ``` Resultado: ``` { "SnapshotId": "snap-0b5e733b4a8df6e0d", "LockState": "compliance-cooloff", "LockDuration": 365, "CoolOffPeriod": 24, "CoolOffPeriodExpiresOn": "2024-05-06T01:02:20.527000+00:00", "LockCreatedOn": "2024-05-05T01:02:20.527000+00:00", "LockExpiresOn": "2025-05-05T01:02:20.527000+00:00", "LockDurationStartTime": "2024-05-05T01:02:20.527000+00:00" } ``` Para obter mais informações, consulte [Bloqueio de snapshots](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-snapshot-lock.html) no *Guia do usuário do Amazon EBS*. + Para ver detalhes da API, consulte [LockSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/lock-snapshot.html) na *Referência de comandos da AWS CLI*. ### `modify-address-attribute` O código de exemplo a seguir mostra como usar `modify-address-attribute`. **AWS CLI** **Modificar o atributo do nome de domínio associado a um endereço IP elástico** Os exemplos `modify-address-attribute` a seguir modificam o atributo de nome de domínio de um endereço IP elástico. Linux: ``` aws ec2 modify-address-attribute \ --allocation-id eipalloc-abcdef01234567890 \ --domain-name example.com ``` Windows: ``` aws ec2 modify-address-attribute ^ --allocation-id eipalloc-abcdef01234567890 ^ --domain-name example.com ``` Resultado: ``` { "Addresses": [ { "PublicIp": "192.0.2.0", "AllocationId": "eipalloc-abcdef01234567890", "PtrRecord": "example.net." "PtrRecordUpdate": { "Value": "example.com.", "Status": "PENDING" } ] } ``` Para monitorar a alteração pendente e visualizar os atributos modificados de um endereço IP elástico, consulte [describe-addresses-attribute](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-addresses-attribute.html) na *Referência de Comandos da CLI da AWS*. + Para ver detalhes da API, consulte [ModifyAddressAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-address-attribute.html) na *Referência de comandos da AWS CLI*. ### `modify-availability-zone-group` O código de exemplo a seguir mostra como usar `modify-availability-zone-group`. **AWS CLI** **Habilitar um grupo de zonas** O exemplo `modify-availability-zone-group` a seguir habilita o grupo de zonas especificado. ``` aws ec2 modify-availability-zone-group \ --group-name us-west-2-lax-1 \ --opt-in-status opted-in ``` Resultado: ``` { "Return": true } ``` Para obter mais informações, consulte [Regiões e zonas](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [ModifyAvailabilityZoneGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-availability-zone-group.html) na *Referência de comandos da AWS CLI*. ### `modify-capacity-reservation-fleet` O código de exemplo a seguir mostra como usar `modify-capacity-reservation-fleet`. **AWS CLI** **Exemplo 1: modificar a capacidade total de destino de uma Frota de Reserva de Capacidade** O exemplo `modify-capacity-reservation-fleet` a seguir modifica a capacidade total de destino da Frota de Reserva de Capacidade especificada. Ao modificar a capacidade total de destino de uma frota de reserva de capacidade, a frota cria automaticamente novas reservas de capacidade ou modifica ou cancela as reservas de capacidade existentes na frota para atender à nova capacidade total de destino. Não é possível tentar fazer modificações adicionais em uma frota enquanto ela estiver no estado `modifying`. ``` aws ec2 modify-capacity-reservation-fleet \ --capacity-reservation-fleet-id crf-01234567890abcedf \ --total-target-capacity 160 ``` Resultado: ``` { "Return": true } ``` **Exemplo 2: modificar a data de término de uma frota de reserva de capacidade** O exemplo `modify-capacity-reservation-fleet` a seguir modifica a data final da Frota de Reserva de Capacidade especificada. Quando você modifica a data de término da frota, as datas de término de todas as reservas de capacidade individuais são atualizadas de maneira adequada. Não é possível tentar fazer modificações adicionais em uma frota enquanto ela estiver no estado `modifying`. ``` aws ec2 modify-capacity-reservation-fleet \ --capacity-reservation-fleet-id crf-01234567890abcedf \ --end-date 2022-07-04T23:59:59.000Z ``` Resultado: ``` { "Return": true } ``` Para obter mais informações sobre as Frotas de Reserva de Capacidade, consulte [Frotas de reserva de capacidade](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-fleets.html) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [ModifyCapacityReservationFleet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-capacity-reservation-fleet.html) na *Referência de comandos da AWS CLI*. ### `modify-capacity-reservation` O código de exemplo a seguir mostra como usar `modify-capacity-reservation`. **AWS CLI** **Exemplo 1: alterar o número de instâncias reservadas por uma reserva de capacidade existente** O exemplo `modify-capacity-reservation` a seguir altera o número de instâncias para as quais a reserva de capacidade reserva a capacidade. ``` aws ec2 modify-capacity-reservation \ --capacity-reservation-id cr-1234abcd56EXAMPLE \ --instance-count 5 ``` Resultado: ``` { "Return": true } ``` Consulte mais informações em [Modify a Capacity Reservation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-modify.html) no *Manual do usuário do Amazon EC2*. **Exemplo 2: alterar a data e a hora de término de uma reserva de capacidade existente** O exemplo `modify-capacity-reservation` a seguir modifica uma reserva de capacidade existente para terminar na data e na hora especificadas. ``` aws ec2 modify-capacity-reservation \ --capacity-reservation-id cr-1234abcd56EXAMPLE \ --end-date-type limited \ --end-date 2019-08-31T23:59:59Z ``` Consulte mais informações em [Modify a Capacity Reservation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-modify.html) no *Manual do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [ModifyCapacityReservation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-capacity-reservation.html) na *Referência de comandos da AWS CLI*. ### `modify-client-vpn-endpoint` O código de exemplo a seguir mostra como usar `modify-client-vpn-endpoint`. **AWS CLI** **Modificar um endpoint do Client VPN** O exemplo `modify-client-vpn-endpoint` a seguir ativa o registro em log da conexão do cliente para o endpoint de Client VPN especificado. ``` aws ec2 modify-client-vpn-endpoint \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ --connection-log-options Enabled=true,CloudwatchLogGroup=ClientVPNLogs ``` Resultado: ``` { "Return": true } ``` Para obter mais informações, consulte [Endpoints de Client VPN](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-endpoints.html) no *Guia do administrador do Cliente VPN da AWS*. + Para ver detalhes da API, consulte [ModifyClientVpnEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-client-vpn-endpoint.html) na *Referência de comandos da AWS CLI*. ### `modify-default-credit-specification` O código de exemplo a seguir mostra como usar `modify-default-credit-specification`. **AWS CLI** **Modificar a opção de crédito padrão** O exemplo `modify-default-credit-specification` a seguir modifica a opção de crédito padrão para instâncias T2. ``` aws ec2 modify-default-credit-specification \ --instance-family t2 \ --cpu-credits unlimited ``` Resultado: ``` { "InstanceFamilyCreditSpecification": { "InstanceFamily": "t2", "CpuCredits": "unlimited" } } ``` + Para ver detalhes da API, consulte [ModifyDefaultCreditSpecification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-default-credit-specification.html) na *Referência de comandos da AWS CLI*. ### `modify-ebs-default-kms-key-id` O código de exemplo a seguir mostra como usar `modify-ebs-default-kms-key-id`. **AWS CLI** **Definir a CMK padrão para criptografia do EBS** O exemplo `modify-ebs-default-kms-key-id` a seguir define a CMK especificada como a CMK padrão para criptografia do EBS para sua conta AWS na Região atual. ``` aws ec2 modify-ebs-default-kms-key-id \ --kms-key-id alias/my-cmk ``` Resultado: ``` { "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/0ea3fef3-80a7-4778-9d8c-1c0c6EXAMPLE" } ``` + Para ver detalhes da API, consulte [ModifyEbsDefaultKmsKeyId](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-ebs-default-kms-key-id.html) na *Referência de comandos da AWS CLI*. ### `modify-fleet` O código de exemplo a seguir mostra como usar `modify-fleet`. **AWS CLI** **Escalar uma frota EC** O exemplo `modify-fleet` a seguir modifica a capacidade de destino da Frota EC2 especificada. Se o valor especificado for maior do que a capacidade atual, a Frota EC2 executará instâncias adicionais. Se o valor especificado for menor que a capacidade atual, a Frota EC2 cancela todas as solicitações abertas e, se a política de encerramento for `terminate`, a frota EC2 encerrará todas as instâncias que excederem a nova capacidade de destino. ``` aws ec2 modify-fleet \ --fleet-ids fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE \ --target-capacity-specification TotalTargetCapacity=5 ``` Resultado: ``` { "Return": true } ``` Consulte mais informações em [Trabalhar com uma frota do EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html) no *Manual do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [ModifyFleet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-fleet.html) na *Referência de comandos da AWS CLI*. ### `modify-fpga-image-attribute` O código de exemplo a seguir mostra como usar `modify-fpga-image-attribute`. **AWS CLI** **Modificar os atributos de uma imagem do Amazon FPGA** Este exemplo adiciona permissões de carregamento para o ID da conta `123456789012` para a AFI especificada. Comando: ``` aws ec2 modify-fpga-image-attribute --attribute loadPermission --fpga-image-id afi-0d123e123bfc85abc --load-permission Add=[{UserId=123456789012}] ``` Resultado: ``` { "FpgaImageAttribute": { "FpgaImageId": "afi-0d123e123bfc85abc", "LoadPermissions": [ { "UserId": "123456789012" } ] } } ``` + Para ver detalhes da API, consulte [ModifyFpgaImageAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-fpga-image-attribute.html) na *Referência de comandos da AWS CLI*. ### `modify-hosts` O código de exemplo a seguir mostra como usar `modify-hosts`. **AWS CLI** **Exemplo 1: habilitar o posicionamento automático para um Host Dedicado** O exemplo `modify-hosts` a seguir habilita o posicionamento automático de um Host dedicado, para que ele aceite todas as execuções de instâncias não direcionadas que correspondam à configuração do tipo de instância. ``` aws ec2 modify-hosts \ --host-id h-06c2f189b4EXAMPLE \ --auto-placement on ``` Resultado: ``` { "Successful": [ "h-06c2f189b4EXAMPLE" ], "Unsuccessful": [] } ``` Consulte mais informações em [Modificar a configuração de posicionamento automático para um host dedicado](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/modify-host-auto-placement.html) no *Manual do usuário do Amazon EC2*. **Exemplo 2: habilitar a recuperação de host para um host dedicado** O exemplo `modify-hosts` a seguir habilita a recuperação de host para o Host Dedicado especificado. ``` aws ec2 modify-hosts \ --host-id h-06c2f189b4EXAMPLE \ --host-recovery on ``` Resultado: ``` { "Successful": [ "h-06c2f189b4EXAMPLE" ], "Unsuccessful": [] } ``` Consulte mais informações em [Modificar a configuração de posicionamento automático para um host dedicado](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/modify-host-auto-placement.html) no *Manual do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [ModifyHosts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-hosts.html) na *Referência de comandos da AWS CLI*. ### `modify-id-format` O código de exemplo a seguir mostra como usar `modify-id-format`. **AWS CLI** **Habilitar o formato de ID mais longo para um recurso** O exemplo `modify-id-format` a seguir ativa o formato de ID mais longo para o tipo de recurso `instance`. ``` aws ec2 modify-id-format \ --resource instance \ --use-long-ids ``` **Desativar o formato de ID mais longo para um recurso** O exemplo `modify-id-format` a seguir desativa o formato de ID mais longo para o tipo de recurso `instance`. ``` aws ec2 modify-id-format \ --resource instance \ --no-use-long-ids ``` O exemplo `modify-id-format` a seguir habilita o formato mais longo de ID para todos os tipos de recursos compatíveis que estejam no período de inclusão. ``` aws ec2 modify-id-format \ --resource all-current \ --use-long-ids ``` + Para ver detalhes da API, consulte [ModifyIdFormat](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-id-format.html) na *Referência de comandos da AWS CLI*. ### `modify-identity-id-format` O código de exemplo a seguir mostra como usar `modify-identity-id-format`. **AWS CLI** **Permitir que um perfil do IAM use IDs mais longos para um recurso** O exemplo `modify-identity-id-format` a seguir permite que a perfil do IAM `EC2Role` em sua conta AWS use o formato de ID longo para o tipo de recurso `instance`. ``` aws ec2 modify-identity-id-format \ --principal-arn arn:aws:iam::123456789012:role/EC2Role \ --resource instance \ --use-long-ids ``` **Permitir que um usuário do IAM use IDs mais longos para um recurso** O exemplo `modify-identity-id-format` a seguir permite que o usuário do IAM `AdminUser` em sua conta AWS use o formato de ID mais longo para o tipo de recurso `volume`. ``` aws ec2 modify-identity-id-format \ --principal-arn arn:aws:iam::123456789012:user/AdminUser \ --resource volume \ --use-long-ids ``` O exemplo `modify-identity-id-format` a seguir permite que o usuário do IAM `AdminUser` em sua conta AWS use o formato de ID mais longo para todos os tipos de recursos compatíveis que estão dentro do período de inscrição. ``` aws ec2 modify-identity-id-format \ --principal-arn arn:aws:iam::123456789012:user/AdminUser \ --resource all-current \ --use-long-ids ``` + Para ver detalhes da API, consulte [ModifyIdentityIdFormat](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-identity-id-format.html) na *Referência de comandos da AWS CLI*. ### `modify-image-attribute` O código de exemplo a seguir mostra como usar `modify-image-attribute`. **AWS CLI** **Exemplo 1: tornar uma AMI pública** O exemplo `modify-instance-attribute` a seguir torna pública a AMI especificada. ``` aws ec2 modify-image-attribute \ --image-id ami-5731123e \ --launch-permission "Add=[{Group=all}]" ``` Este comando não produz saída. **Exemplo 2: tornar uma AMI privada** O exemplo `modify-instance-attribute` a seguir torna a AMI especificada privada. ``` aws ec2 modify-image-attribute \ --image-id ami-5731123e \ --launch-permission "Remove=[{Group=all}]" ``` Este comando não produz saída. **Exemplo 3: conceder permissão de lançamento a uma conta AWS** O exemplo `modify-instance-attribute` a seguir concede permissões de lançamento para a conta AWS especificada. ``` aws ec2 modify-image-attribute \ --image-id ami-5731123e \ --launch-permission "Add=[{UserId=123456789012}]" ``` Este comando não produz saída. **Exemplo 4: remover a permissão de lançamento de uma conta AWS** O exemplo `modify-instance-attribute` a seguir remove as permissões de lançamento da conta AWS especificada. ``` aws ec2 modify-image-attribute \ --image-id ami-5731123e \ --launch-permission "Remove=[{UserId=123456789012}]" ``` + Para ver detalhes da API, consulte [ModifyImageAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-image-attribute.html) na *Referência de comandos da AWS CLI*. ### `modify-instance-attribute` O código de exemplo a seguir mostra como usar `modify-instance-attribute`. **AWS CLI** **Exemplo 1: modificar o tipo de instância** O exemplo `modify-instance-attribute` a seguir modifica o tipo de instância da instância especificada. A instância deve estar no estado `stopped`. ``` aws ec2 modify-instance-attribute \ --instance-id i-1234567890abcdef0 \ --instance-type "{\"Value\": \"m1.small\"}" ``` Este comando não produz saída. **Exemplo 2: habilitar a rede aprimorada em uma instância** O exemplo `modify-instance-attribute` a seguir ativa a rede aprimorada para a instância especificada. A instância deve estar no estado `stopped`. ``` aws ec2 modify-instance-attribute \ --instance-id i-1234567890abcdef0 \ --sriov-net-support simple ``` Este comando não produz saída. **Exemplo 3: modificar o atributo sourceDestCheck** O exemplo `modify-instance-attribute` a seguir define o atributo `sourceDestCheck` para a instância especificada para `true`. A instância deve estar em uma VPC. ``` aws ec2 modify-instance-attribute --instance-id i-1234567890abcdef0 --source-dest-check "{\"Value\": true}" ``` Este comando não produz saída. **Exemplo 4: modificar o atributo deleteOnTermination do volume raiz** O exemplo `modify-instance-attribute` a seguir define o atributo `deleteOnTermination` para o volume raiz da instância especificada com suporte do Amazon EBS para `false`. Por padrão, esse atributo é `true` para o volume raiz. Comando: ``` aws ec2 modify-instance-attribute \ --instance-id i-1234567890abcdef0 \ --block-device-mappings "[{\"DeviceName\": \"/dev/sda1\",\"Ebs\":{\"DeleteOnTermination\":false}}]" ``` Este comando não produz saída. **Exemplo 5: modificar os dados do usuário anexados a uma instância** O exemplo `modify-instance-attribute` a seguir adiciona o conteúdo do arquivo `UserData.txt` como UserData para a instância especificada. Conteúdo do arquivo `UserData.txt` original: ``` #!/bin/bash yum update -y service httpd start chkconfig httpd on ``` O conteúdo do arquivo deve ser codificado em base64. O primeiro comando converte o arquivo de texto em base64 e o salva como um novo arquivo. Versão Linux/macOS do comando: ``` base64 UserData.txt > UserData.base64.txt ``` Este comando não produz saída. Versão Windows do comando: ``` certutil -encode UserData.txt tmp.b64 && findstr /v /c:- tmp.b64 > UserData.base64.txt ``` Resultado: ``` Input Length = 67 Output Length = 152 CertUtil: -encode command completed successfully. ``` Agora você pode referenciar esse arquivo no comando CLI a seguir: ``` aws ec2 modify-instance-attribute \ --instance-id=i-09b5a14dbca622e76 \ --attribute userData --value file://UserData.base64.txt ``` Este comando não produz saída. Para obter mais informações, consulte [Dados do usuário e CLI AWS](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html#user-data-api-cli) no *Guia do usuário do EC2*. + Para ver detalhes da API, consulte [ModifyInstanceAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-instance-attribute.html) na *Referência de comandos da AWS CLI*. ### `modify-instance-capacity-reservation-attributes` O código de exemplo a seguir mostra como usar `modify-instance-capacity-reservation-attributes`. **AWS CLI** **Exemplo 1: modificar as configurações de segmentação da reserva de capacidade de uma instância** O exemplo `modify-instance-capacity-reservation-attributes` a seguir modifica uma instância interrompida para ter como destino uma Reserva de capacidade específica. ``` aws ec2 modify-instance-capacity-reservation-attributes \ --instance-id i-EXAMPLE8765abcd4e \ --capacity-reservation-specification 'CapacityReservationTarget={CapacityReservationId= cr-1234abcd56EXAMPLE }' ``` Resultado: ``` { "Return": true } ``` Consulte mais informações em [Modificar as configurações de reserva de capacidade da instância](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-modify-instance.html) no *Manual do usuário do Amazon EC2*. **Exemplo 2: modificar as configurações de segmentação da reserva de capacidade de uma instância** O exemplo `modify-instance-capacity-reservation-attributes` a seguir modifica uma instância interrompida direcionada à reserva de capacidade especificada para execução em qualquer reserva de capacidade que tenha atributos correspondentes (por exemplo, tipo de instância, plataforma, Zona de Disponibilidade) e critérios de correspondência de instância em aberto. ``` aws ec2 modify-instance-capacity-reservation-attributes \ --instance-id i-EXAMPLE8765abcd4e \ --capacity-reservation-specification 'CapacityReservationPreference=open' ``` Resultado: ``` { "Return": true } ``` Consulte mais informações em [Modificar as configurações de reserva de capacidade da instância](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-modify-instance.html) no *Manual do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [ModifyInstanceCapacityReservationAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-instance-capacity-reservation-attributes.html) na *Referência de comandos da AWS CLI*. ### `modify-instance-credit-specification` O código de exemplo a seguir mostra como usar `modify-instance-credit-specification`. **AWS CLI** **Modificar a opção de crédito para uso de CPU de uma instância** Este exemplo modifica a opção de crédito para uso da CPU da instância especificada na região especificada para “ilimitado”. As opções de crédito válidas são “padrão” e “ilimitado”. Comando: ``` aws ec2 modify-instance-credit-specification --instance-credit-specification "InstanceId=i-1234567890abcdef0,CpuCredits=unlimited" ``` Resultado: ``` { "SuccessfulInstanceCreditSpecifications": [ { "InstanceId": "i-1234567890abcdef0" } ], "UnsuccessfulInstanceCreditSpecifications": [] } ``` + Para ver detalhes da API, consulte [ModifyInstanceCreditSpecification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-instance-credit-specification.html) na *Referência de comandos da AWS CLI*. ### `modify-instance-event-start-time` O código de exemplo a seguir mostra como usar `modify-instance-event-start-time`. **AWS CLI** **Modificar o horário de início do evento para uma instância** O comando `modify-instance-event-start-time` a seguir mostra como modificar a hora de início do evento para a instância especificada. Especifique o ID do evento usando o parâmetro `--instance-event-id`. Especifique a nova data e hora usando o parâmetro `--not-before`. ``` aws ec2 modify-instance-event-start-time --instance-id i-1234567890abcdef0 --instance-event-id instance-event-0abcdef1234567890 --not-before 2019-03-25T10:00:00.000 ``` Resultado: ``` "Event": { "InstanceEventId": "instance-event-0abcdef1234567890", "Code": "system-reboot", "Description": "scheduled reboot", "NotAfter": "2019-03-25T12:00:00.000Z", "NotBefore": "2019-03-25T10:00:00.000Z", "NotBeforeDeadline": "2019-04-22T21:00:00.000Z" } ``` Para obter mais informações, consulte Trabalhar com instâncias programadas para reinicialização no *Guia do usuário do Amazon Elastic Compute Cloud* + Para ver detalhes da API, consulte [ModifyInstanceEventStartTime](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-instance-event-start-time.html) na *Referência de comandos da AWS CLI*. ### `modify-instance-event-window` O código de exemplo a seguir mostra como usar `modify-instance-event-window`. **AWS CLI** **Exemplo 1: modificar o intervalo de tempo de uma janela de eventos** O exemplo `modify-instance-event-window` a seguir modifica o intervalo de tempo de uma janela de eventos. Especifique o`time-range`Parâmetro para modificar o intervalo de tempo. Você também deve especificar o parâmetro `cron-expression`. ``` aws ec2 modify-instance-event-window \ --region us-east-1 \ --instance-event-window-id iew-0abcdef1234567890 --time-range StartWeekDay=monday,StartHour=2,EndWeekDay=wednesday,EndHour=8 ``` Resultado: ``` { "InstanceEventWindow": { "InstanceEventWindowId": "iew-0abcdef1234567890", "TimeRanges": [ { "StartWeekDay": "monday", "StartHour": 2, "EndWeekDay": "wednesday", "EndHour": 8 } ], "Name": "myEventWindowName", "AssociationTarget": { "InstanceIds": [ "i-0abcdef1234567890", "i-0be35f9acb8ba01f0" ], "Tags": [], "DedicatedHostIds": [] }, "State": "creating", "Tags": [ { "Key": "K1", "Value": "V1" } ] } } ``` Para restrições da janela de eventos, consulte [Considerações](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations) na seção Eventos Programados do *Guia do usuário do Amazon EC2*. **Exemplo 2: modificar um conjunto de intervalos de tempo para uma janela de eventos** O exemplo `modify-instance-event-window` a seguir modifica o intervalo de tempo de uma janela de eventos. Especifique o`time-range`Parâmetro para modificar o intervalo de tempo. Você também deve especificar o parâmetro `cron-expression`. ``` aws ec2 modify-instance-event-window \ --region us-east-1 \ --instance-event-window-id iew-0abcdef1234567890 \ --time-range '[{"StartWeekDay": "monday", "StartHour": 2, "EndWeekDay": "wednesday", "EndHour": 8}, {"StartWeekDay": "thursday", "StartHour": 2, "EndWeekDay": "friday", "EndHour": 8}]' ``` Resultado: ``` { "InstanceEventWindow": { "InstanceEventWindowId": "iew-0abcdef1234567890", "TimeRanges": [ { "StartWeekDay": "monday", "StartHour": 2, "EndWeekDay": "wednesday", "EndHour": 8 }, { "StartWeekDay": "thursday", "StartHour": 2, "EndWeekDay": "friday", "EndHour": 8 } ], "Name": "myEventWindowName", "AssociationTarget": { "InstanceIds": [ "i-0abcdef1234567890", "i-0be35f9acb8ba01f0" ], "Tags": [], "DedicatedHostIds": [] }, "State": "creating", "Tags": [ { "Key": "K1", "Value": "V1" } ] } } ``` Para restrições da janela de eventos, consulte [Considerações](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations) na seção Eventos Programados do *Guia do usuário do Amazon EC2*. **Exemplo 3: modificar a expressão cron de uma janela de eventos** O exemplo `modify-instance-event-window` a seguir modifica a expressão cron de uma janela de eventos. Especifique o`cron-expression`para modificar a expressão cron. Você também deve especificar o parâmetro `time-range`. ``` aws ec2 modify-instance-event-window \ --region us-east-1 \ --instance-event-window-id iew-0abcdef1234567890 \ --cron-expression "* 21-23 * * 2,3" ``` Resultado: ``` { "InstanceEventWindow": { "InstanceEventWindowId": "iew-0abcdef1234567890", "Name": "myEventWindowName", "CronExpression": "* 21-23 * * 2,3", "AssociationTarget": { "InstanceIds": [ "i-0abcdef1234567890", "i-0be35f9acb8ba01f0" ], "Tags": [], "DedicatedHostIds": [] }, "State": "creating", "Tags": [ { "Key": "K1", "Value": "V1" } ] } } ``` Para restrições da janela de eventos, consulte [Considerações](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations) na seção Eventos Programados do *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [ModifyInstanceEventWindow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-instance-event-window.html) na *Referência de comandos da AWS CLI*. ### `modify-instance-maintenance-options` O código de exemplo a seguir mostra como usar `modify-instance-maintenance-options`. **AWS CLI** **Exemplo 1: desativar o comportamento de recuperação de uma instância** O exemplo `modify-instance-maintenance-options` a seguir desabilita a recuperação automática simplificada de uma instância em execução ou interrompida. ``` aws ec2 modify-instance-maintenance-options \ --instance-id i-0abcdef1234567890 \ --auto-recovery disabled ``` Resultado: ``` { "InstanceId": "i-0abcdef1234567890", "AutoRecovery": "disabled" } ``` Consulte mais informações em [Configurar a recuperação automática simplificada](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-configuration-recovery.html) no *Manual do usuário do Amazon EC2*. **Exemplo 2: definir o comportamento de recuperação de uma instância como padrão** O exemplo `modify-instance-maintenance-options` a seguir define o comportamento de recuperação automática como padrão, o que permite a recuperação automática simplificada para tipos de instância compatíveis. ``` aws ec2 modify-instance-maintenance-options \ --instance-id i-0abcdef1234567890 \ --auto-recovery default ``` Resultado: ``` { "InstanceId": "i-0abcdef1234567890", "AutoRecovery": "default" } ``` Consulte mais informações em [Configurar a recuperação automática simplificada](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-configuration-recovery.html) no *Manual do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [ModifyInstanceMaintenanceOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-instance-maintenance-options.html) na *Referência de comandos da AWS CLI*. ### `modify-instance-metadata-options` O código de exemplo a seguir mostra como usar `modify-instance-metadata-options`. **AWS CLI** **Exemplo 1: habilitar o IMDSv2** O exemplo `modify-instance-metadata-options` a seguir cria e configura o uso do IMDSv2 na instância especificada. ``` aws ec2 modify-instance-metadata-options \ --instance-id i-1234567898abcdef0 \ --http-tokens required \ --http-endpoint enabled ``` Resultado: ``` { "InstanceId": "i-1234567898abcdef0", "InstanceMetadataOptions": { "State": "pending", "HttpTokens": "required", "HttpPutResponseHopLimit": 1, "HttpEndpoint": "enabled" } } ``` Para mais informações, consulte [Metadados da instância](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) no *Manual do usuário do Amazon EC2*. **Exemplo 2: desativar os metadados da instância** O exemplo `modify-instance-metadata-options` a seguir desativa o uso de todas as versões dos metadados da instância na instância especificada. ``` aws ec2 modify-instance-metadata-options \ --instance-id i-1234567898abcdef0 \ --http-endpoint disabled ``` Resultado: ``` { "InstanceId": "i-1234567898abcdef0", "InstanceMetadataOptions": { "State": "pending", "HttpTokens": "required", "HttpPutResponseHopLimit": 1, "HttpEndpoint": "disabled" } } ``` Para mais informações, consulte [Metadados da instância](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) no *Manual do usuário do Amazon EC2*. **Exemplo 3: habilitar o endpoint de IPv6 de metadados de instância para sua instância** O exemplo `modify-instance-metadata-options` a seguir mostra como ativar o endpoint IPv6 para serviço de metadados da instância. Por padrão, o endpoint IPv6 está desabilitado. Isso é verdade mesmo se você tiver iniciado uma instância em uma sub-rede somente IPv6. O endpoint IPv6 para o IMDS pode ser acessado somente em instâncias desenvolvidas no Nitro System. ``` aws ec2 modify-instance-metadata-options \ --instance-id i-1234567898abcdef0 \ --http-protocol-ipv6 enabled \ --http-endpoint enabled ``` Resultado: ``` { "InstanceId": "i-1234567898abcdef0", "InstanceMetadataOptions": { "State": "pending", "HttpTokens": "required", "HttpPutResponseHopLimit": 1, "HttpEndpoint": "enabled", HttpProtocolIpv6": "enabled" } } ``` Para mais informações, consulte [Metadados da instância](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) no *Manual do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [ModifyInstanceMetadataOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-instance-metadata-options.html) na *Referência de comandos da AWS CLI*. ### `modify-instance-placement` O código de exemplo a seguir mostra como usar `modify-instance-placement`. **AWS CLI** **Exemplo 1: remover a afinidade de uma instância com um host dedicado** O exemplo `modify-instance-placement` a seguir remove a afinidade de uma instância com um Host dedicado e habilita esse host para execução em qualquer Host dedicado disponível na conta que ofereça suporte ao seu tipo de instância. ``` aws ec2 modify-instance-placement \ --instance-id i-0e6ddf6187EXAMPLE \ --affinity default ``` Resultado: ``` { "Return": true } ``` **Exemplo 2: estabelecer afinidade entre uma instância e o host dedicado especificado** O exemplo `modify-instance-placement` a seguir estabelece uma relação de execução entre uma instância e um Host Dedicado. A instância só pode ser executada no Host Dedicado especificado. ``` aws ec2 modify-instance-placement \ --instance-id i-0e6ddf6187EXAMPLE \ --affinity host \ --host-id i-0e6ddf6187EXAMPLE ``` Resultado: ``` { "Return": true } ``` **Exemplo 3: mover uma instância para um grupo de posicionamento** O exemplo `modify-instance-placement` a seguir move uma instância para um grupo de posicionamento, interrompe a instância, modifica o posicionamento da instância e, em seguida, reinicia a instância. ``` aws ec2 stop-instances \ --instance-ids i-0123a456700123456 aws ec2 modify-instance-placement \ --instance-id i-0123a456700123456 \ --group-name MySpreadGroup aws ec2 start-instances \ --instance-ids i-0123a456700123456 ``` **Exemplo 4: remover uma instância de um grupo de posicionamento** O exemplo `modify-instance-placement` a seguir remove uma instância de um grupo de posicionamento interrompendo a instância, modificando o posicionamento da instância e depois reiniciando a instância. O exemplo a seguir especifica uma string vazia ("") para o nome do grupo de posicionamento para indicar que a instância não deve estar localizada em um grupo de posicionamento. Interromper a instância: ``` aws ec2 stop-instances \ --instance-ids i-0123a456700123456 ``` Modificar o posicionamento (prompt de comando do Windows): ``` aws ec2 modify-instance-placement \ --instance-id i-0123a456700123456 \ --group-name "" ``` Modificar o posicionamento (Windows, PowerShell, Linux e macOS): ``` aws ec2 modify-instance-placement ` --instance-id i-0123a456700123456 ` --group-name '' ``` Reinicie a instância: ``` aws ec2 start-instances \ --instance-ids i-0123a456700123456 ``` Resultado: ``` { "Return": true } ``` Consulte mais informações em [Modificar a locação e a afinidade de host dedicado](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/moving-instances-dedicated-hosts.html) no *Manual do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [ModifyInstancePlacement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-instance-placement.html) na *Referência de comandos da AWS CLI*. ### `modify-ipam-pool` O código de exemplo a seguir mostra como usar `modify-ipam-pool`. **AWS CLI** **Modificar um pool IPAM** O exemplo `modify-ipam-pool` a seguir modifica um pool IPAM. (Linux): ``` aws ec2 modify-ipam-pool \ --ipam-pool-id ipam-pool-0533048da7d823723 \ --add-allocation-resource-tags "Key=Owner,Value=Build Team" \ --clear-allocation-default-netmask-length \ --allocation-min-netmask-length 14 ``` (Windows): ``` aws ec2 modify-ipam-pool ^ --ipam-pool-id ipam-pool-0533048da7d823723 ^ --add-allocation-resource-tags "Key=Owner,Value=Build Team" ^ --clear-allocation-default-netmask-length ^ --allocation-min-netmask-length 14 ``` Resultado: ``` { "IpamPool": { "OwnerId": "123456789012", "IpamPoolId": "ipam-pool-0533048da7d823723", "IpamPoolArn": "arn:aws:ec2::123456789012:ipam-pool/ipam-pool-0533048da7d823723", "IpamScopeArn": "arn:aws:ec2::123456789012:ipam-scope/ipam-scope-02fc38cd4c48e7d38", "IpamScopeType": "private", "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-08440e7a3acde3908", "IpamRegion": "us-east-1", "Locale": "None", "PoolDepth": 1, "State": "modify-complete", "AutoImport": true, "AddressFamily": "ipv4", "AllocationMinNetmaskLength": 14, "AllocationMaxNetmaskLength": 26, "AllocationResourceTags": [ { "Key": "Environment", "Value": "Preprod" }, { "Key": "Owner", "Value": "Build Team" } ] } } ``` Para obter mais informações, consulte [Editar um pool](https://docs.aws.amazon.com/vpc/latest/ipam/mod-pool-ipam.html) no *Guia do usuário do IPAM da Amazon VPC*. + Para ver detalhes da API, consulte [ModifyIpamPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-ipam-pool.html) na *Referência de comandos da AWS CLI*. ### `modify-ipam-resource-cidr` O código de exemplo a seguir mostra como usar `modify-ipam-resource-cidr`. **AWS CLI** **Modificar o CIDR alocado a um recurso** O exemplo `modify-ipam-resource-cidr` a seguir modifica um CIDR de recurso. (Linux): ``` aws ec2 modify-ipam-resource-cidr \ --current-ipam-scope-id ipam-scope-02fc38cd4c48e7d38 \ --destination-ipam-scope-id ipam-scope-0da34c61fd189a141 \ --resource-id vpc-010e1791024eb0af9 \ --resource-cidr 10.0.1.0/24 \ --resource-region us-east-1 \ --monitored ``` (Windows): ``` aws ec2 modify-ipam-resource-cidr ^ --current-ipam-scope-id ipam-scope-02fc38cd4c48e7d38 ^ --destination-ipam-scope-id ipam-scope-0da34c61fd189a141 ^ --resource-id vpc-010e1791024eb0af9 ^ --resource-cidr 10.0.1.0/24 ^ --resource-region us-east-1 ^ --monitored ``` Resultado: ``` { "IpamResourceCidr": { "IpamId": "ipam-08440e7a3acde3908", "IpamScopeId": "ipam-scope-0da34c61fd189a141", "IpamPoolId": "ipam-pool-0533048da7d823723", "ResourceRegion": "us-east-1", "ResourceOwnerId": "123456789012", "ResourceId": "vpc-010e1791024eb0af9", "ResourceCidr": "10.0.1.0/24", "ResourceType": "vpc", "ResourceTags": [ { "Key": "Environment", "Value": "Preprod" }, { "Key": "Owner", "Value": "Build Team" } ], "IpUsage": 0.0, "ComplianceStatus": "noncompliant", "ManagementState": "managed", "OverlapStatus": "overlapping", "VpcId": "vpc-010e1791024eb0af9" } } ``` Para obter mais informações sobre movimentação de recursos, consulte [Movimentação de recursos CIDRs entre escopos](https://docs.aws.amazon.com/vpc/latest/ipam/move-resource-ipam.html) no *Guia do usuário IPAM da Amazon VPC*. Para obter mais informações sobre a alteração dos estados de monitoramento, consulte [Alterar o estado de monitoramento dos CIDRs de recursos](https://docs.aws.amazon.com/vpc/latest/ipam/change-monitoring-state-ipam.html) no *Guia do usuário IPAM da Amazon VPC*. + Para ver detalhes da API, consulte [ModifyIpamResourceCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-ipam-resource-cidr.html) na *Referência de comandos da AWS CLI*. ### `modify-ipam-resource-discovery` O código de exemplo a seguir mostra como usar `modify-ipam-resource-discovery`. **AWS CLI** **Modificar as regiões operacionais de uma descoberta de recursos** Neste exemplo, você é um administrador delegado do IPAM que deseja modificar as regiões operacionais de uma descoberta de recursos. Para concluir essa solicitação: Você não pode modificar uma descoberta de recursos padrão e deve ser o proprietário da descoberta do recurso. Você precisa do ID de descoberta do recurso, que pode ser obtido com [describe-ipam-resource-discoveries](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-ipam-resource-discoveries.html). O exemplo `modify-ipam-resource-discovery` a seguir modifica uma descoberta de recursos não padrão em sua conta AWS. ``` aws ec2 modify-ipam-resource-discovery \ --ipam-resource-discovery-id ipam-res-disco-0f4ef577a9f37a162 \ --add-operating-regions RegionName='us-west-1' \ --remove-operating-regions RegionName='us-east-2' \ --region us-east-1 ``` Resultado: ``` { "IpamResourceDiscovery": { "OwnerId": "149977607591", "IpamResourceDiscoveryId": "ipam-res-disco-0365d2977fc1672fe", "IpamResourceDiscoveryArn": "arn:aws:ec2::149977607591:ipam-resource-discovery/ipam-res-disco-0365d2977fc1672fe", "IpamResourceDiscoveryRegion": "us-east-1", "Description": "Example", "OperatingRegions": [ { "RegionName": "us-east-1" }, { "RegionName": "us-west-1" } ], "IsDefault": false, "State": "modify-in-progress" } } ``` Para obter mais informações, consulte [Trabalhar com descobertas de recurso](https://docs.aws.amazon.com/vpc/latest/ipam/res-disc-work-with.html) no *Guia do usuário da Amazon VPC IPAM*. + Para ver detalhes da API, consulte [ModifyIpamResourceDiscovery](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-ipam-resource-discovery.html) na *Referência de comandos da AWS CLI*. ### `modify-ipam-scope` O código de exemplo a seguir mostra como usar `modify-ipam-scope`. **AWS CLI** **Modificar a descrição de um escopo** Nesse cenário, você é um administrador delegado do IPAM que deseja modificar a descrição de um escopo do IPAM. Para concluir essa solicitação, você precisará do ID do escopo, que pode ser obtido com [describe-ipam-scopes](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-ipam-scopes.html). O exemplo `modify-ipam-scope` a seguir atualiza a descrição do escopo. ``` aws ec2 modify-ipam-scope \ --ipam-scope-id ipam-scope-0d3539a30b57dcdd1 \ --description example \ --region us-east-1 ``` Resultado: ``` { "IpamScope": { "OwnerId": "320805250157", "IpamScopeId": "ipam-scope-0d3539a30b57dcdd1", "IpamScopeArn": "arn:aws:ec2::320805250157:ipam-scope/ipam-scope-0d3539a30b57dcdd1", "IpamArn": "arn:aws:ec2::320805250157:ipam/ipam-005f921c17ebd5107", "IpamRegion": "us-east-1", "IpamScopeType": "public", "IsDefault": true, "Description": "example", "PoolCount": 1, "State": "modify-in-progress" } } ``` Para mais informações sobre escopos, consulte [Como o IPAM funciona](https://docs.aws.amazon.com/vpc/latest/ipam/how-it-works-ipam.html), no *Guia do usuário do Amazon VPC IPAM*. + Para ver detalhes da API, consulte [ModifyIpamScope](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-ipam-scope.html) na *Referência de comandos da AWS CLI*. ### `modify-ipam` O código de exemplo a seguir mostra como usar `modify-ipam`. **AWS CLI** **Modificar um IPAM** O exemplo `modify-ipam` a seguir modifica um IPAM adicionando uma região operacional. (Linux): ``` aws ec2 modify-ipam \ --ipam-id ipam-08440e7a3acde3908 \ --add-operating-regions RegionName=us-west-2 ``` (Windows): ``` aws ec2 modify-ipam ^ --ipam-id ipam-08440e7a3acde3908 ^ --add-operating-regions RegionName=us-west-2 ``` Resultado: ``` { "Ipam": { "OwnerId": "123456789012", "IpamId": "ipam-08440e7a3acde3908", "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-08440e7a3acde3908", "IpamRegion": "us-east-1", "PublicDefaultScopeId": "ipam-scope-0b9eed026396dbc16", "PrivateDefaultScopeId": "ipam-scope-02fc38cd4c48e7d38", "ScopeCount": 3, "OperatingRegions": [ { "RegionName": "us-east-1" }, { "RegionName": "us-east-2" }, { "RegionName": "us-west-1" }, { "RegionName": "us-west-2" } ], "State": "modify-in-progress" } } ``` + Para ver detalhes da API, consulte [ModifyIpam](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-ipam.html) na *Referência de comandos da AWS CLI*. ### `modify-launch-template` O código de exemplo a seguir mostra como usar `modify-launch-template`. **AWS CLI** **Alterar a versão do modelo de inicialização padrão** Este exemplo especifica a versão 2 do modelo de execução especificado como a versão padrão. Comando: ``` aws ec2 modify-launch-template --launch-template-id lt-0abcd290751193123 --default-version 2 ``` Resultado: ``` { "LaunchTemplate": { "LatestVersionNumber": 2, "LaunchTemplateId": "lt-0abcd290751193123", "LaunchTemplateName": "WebServers", "DefaultVersionNumber": 2, "CreatedBy": "arn:aws:iam::123456789012:root", "CreateTime": "2017-12-01T13:35:46.000Z" } } ``` + Para ver detalhes da API, consulte [ModifyLaunchTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-launch-template.html) na *Referência de comandos da AWS CLI*. ### `modify-managed-prefix-list` O código de exemplo a seguir mostra como usar `modify-managed-prefix-list`. **AWS CLI** **Modificar uma lista de prefixos** O exemplo `modify-managed-prefix-list` a seguir adiciona uma entrada à lista de prefixos especificada. ``` aws ec2 modify-managed-prefix-list \ --prefix-list-id pl-0123456abcabcabc1 \ --add-entries Cidr=10.1.0.0/16,Description=vpc-c \ --current-version 1 ``` Resultado: ``` { "PrefixList": { "PrefixListId": "pl-0123456abcabcabc1", "AddressFamily": "IPv4", "State": "modify-in-progress", "PrefixListArn": "arn:aws:ec2:us-west-2:123456789012:prefix-list/pl-0123456abcabcabc1", "PrefixListName": "vpc-cidrs", "MaxEntries": 10, "Version": 1, "OwnerId": "123456789012" } } ``` Para obter mais informações, consulte [Listas de prefixos gerenciados](https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html) no *Guia do usuário da Amazon VPC*. + Para ver detalhes da API, consulte [ModifyManagedPrefixList](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-managed-prefix-list.html) na *Referência de comandos da AWS CLI*. ### `modify-network-interface-attribute` O código de exemplo a seguir mostra como usar `modify-network-interface-attribute`. **AWS CLI** **Modificar o atributo de anexo de uma interface de rede** Este exemplo de comando modifica o atributo `attachment` da interface de rede especificada. Comando: ``` aws ec2 modify-network-interface-attribute --network-interface-id eni-686ea200 --attachment AttachmentId=eni-attach-43348162,DeleteOnTermination=false ``` **Modificar o atributo de descrição de uma interface de rede** Este exemplo de comando modifica o atributo `description` da interface de rede especificada. Comando: ``` aws ec2 modify-network-interface-attribute --network-interface-id eni-686ea200 --description "My description" ``` **Modificar o atributo groupSet de uma interface de rede** Este exemplo de comando modifica o atributo `groupSet` da interface de rede especificada. Comando: ``` aws ec2 modify-network-interface-attribute --network-interface-id eni-686ea200 --groups sg-903004f8 sg-1a2b3c4d ``` **Modificar o atributo sourceDestCheck de uma interface de rede** Este exemplo de comando modifica o atributo `sourceDestCheck` da interface de rede especificada. Comando: ``` aws ec2 modify-network-interface-attribute --network-interface-id eni-686ea200 --no-source-dest-check ``` + Para ver detalhes da API, consulte [ModifyNetworkInterfaceAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-network-interface-attribute.html) na *Referência de comandos da AWS CLI*. ### `modify-private-dns-name-options` O código de exemplo a seguir mostra como usar `modify-private-dns-name-options`. **AWS CLI** **Modificar as opções para nomes de host de instância** O exemplo `modify-private-dns-name-options` a seguir desabilita a opção de responder a consultas ao DNS para nomes de host da instância com registros A do DNS. ``` aws ec2 modify-private-dns-name-options \ --instance-id i-1234567890abcdef0 \ --no-enable-resource-name-dns-a-record ``` Resultado: ``` { "Return": true } ``` Para obter mais informações, consulte [Tipos de nomes do host de instâncias do Amazon EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [ModifyPrivateDnsNameOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-private-dns-name-options.html) na *Referência de comandos da AWS CLI*. ### `modify-reserved-instances` O código de exemplo a seguir mostra como usar `modify-reserved-instances`. **AWS CLI** **Modificar instâncias reservadas** Esse exemplo de comando move uma instância reservada para outra zona de disponibilidade na mesma região. Comando: ``` aws ec2 modify-reserved-instances --reserved-instances-ids b847fa93-e282-4f55-b59a-1342f5bd7c02 --target-configurations AvailabilityZone=us-west-1c,Platform=EC2-Classic,InstanceCount=10 ``` Resultado: ``` { "ReservedInstancesModificationId": "rimod-d3ed4335-b1d3-4de6-ab31-0f13aaf46687" } ``` **Modificar a plataforma de rede das Instâncias Reservadas** Este exemplo de comando converte Instâncias Reservadas do EC2-Classic em EC2-VPC. Comando: ``` aws ec2 modify-reserved-instances --reserved-instances-ids f127bd27-edb7-44c9-a0eb-0d7e09259af0 --target-configurations AvailabilityZone=us-west-1c,Platform=EC2-VPC,InstanceCount=5 ``` Resultado: ``` { "ReservedInstancesModificationId": "rimod-82fa9020-668f-4fb6-945d-61537009d291" } ``` Para obter mais informações, consulte Modificar Instâncias Reservadas no *Guia do usuário do Amazon EC2*. **Modificar o tamanho de instância de instâncias reservadas** Este exemplo de comando modifica uma instância reservada que tem 10 instâncias m1.small Linux/UNIX em us-west-1c para que oito instâncias m1.small se tornem duas instâncias m1.large e as duas instâncias m1.small restantes se tornem uma instância m1.medium na mesma Zona de Disponibilidade. Comando: ``` aws ec2 modify-reserved-instances --reserved-instances-ids 1ba8e2e3-3556-4264-949e-63ee671405a9 --target-configurations AvailabilityZone=us-west-1c,Platform=EC2-Classic,InstanceCount=2,InstanceType=m1.large AvailabilityZone=us-west-1c,Platform=EC2-Classic,InstanceCount=1,InstanceType=m1.medium ``` Resultado: ``` { "ReservedInstancesModificationId": "rimod-acc5f240-080d-4717-b3e3-1c6b11fa00b6" } ``` Para obter mais informações, consulte Modificar o tamanho da instância de suas reservas no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [ModifyReservedInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-reserved-instances.html) na *Referência de comandos da AWS CLI*. ### `modify-security-group-rules` O código de exemplo a seguir mostra como usar `modify-security-group-rules`. **AWS CLI** **Modificar as regras de um grupo de segurança para atualizar a descrição da regra, o protocolo IP e o intervalo de endereços CidrIpv** O exemplo `modify-security-group-rules` a seguir atualiza a descrição, o protocolo IP e o intervalo CIDR IPV4 de uma regra de grupo de segurança especificada. Use o parâmetro `security-group-rules` para inserir as atualizações para as regras do grupo de segurança especificado. `-1` especifica todos os protocolos. ``` aws ec2 modify-security-group-rules \ --group-id sg-1234567890abcdef0 \ --security-group-rules SecurityGroupRuleId=sgr-abcdef01234567890,SecurityGroupRule='{Description=test,IpProtocol=-1,CidrIpv4=0.0.0.0/0}' ``` Resultado: ``` { "Return": true } ``` Para obter mais informações sobre regras de grupo de segurança, consulte [Regras de grupo de segurança](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules.html) no *Guia do usuário da Amazon EC2*. + Para ver detalhes da API, consulte [ModifySecurityGroupRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-security-group-rules.html) na *Referência de comandos da AWS CLI*. ### `modify-snapshot-attribute` O código de exemplo a seguir mostra como usar `modify-snapshot-attribute`. **AWS CLI** **Exemplo 1: modificar um atributo de snapshot** O exemplo `modify-snapshot-attribute` a seguir atualiza o atributo `createVolumePermission` do snapshot especificado, removendo as permissões de volume do usuário especificado. ``` aws ec2 modify-snapshot-attribute \ --snapshot-id snap-1234567890abcdef0 \ --attribute createVolumePermission \ --operation-type remove \ --user-ids 123456789012 ``` **Exemplo 2: tornar público um snapshot** O exemplo `modify-snapshot-attribute` a seguir torna público o snapshot especificado. ``` aws ec2 modify-snapshot-attribute \ --snapshot-id snap-1234567890abcdef0 \ --attribute createVolumePermission \ --operation-type add \ --group-names all ``` + Para ver detalhes da API, consulte [ModifySnapshotAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-snapshot-attribute.html) na *Referência de comandos da AWS CLI*. ### `modify-snapshot-tier` O código de exemplo a seguir mostra como usar `modify-snapshot-tier`. **AWS CLI** **Como arquivar um snapshot** O exemplo `modify-snapshot-tier` a seguir arquiva o snapshot especificado. O parâmetro de resposta `TieringStartTime` indica a data e hora em que o processo de arquivamento foi iniciado, no formato de hora UTC (AAAA-MM-DDTHH:MM:SSZ). ``` aws ec2 modify-snapshot-tier \ --snapshot-id snap-01234567890abcedf \ --storage-tier archive ``` Resultado: ``` { "SnapshotId": "snap-01234567890abcedf", "TieringStartTime": "2021-09-15T16:44:37.574Z" } ``` Consulte mais informações sobre o arquivamento de snapshots em [Archive Amazon EBS snapshots](https://docs.aws.amazon.com/ebs/latest/userguide/snapshot-archive.html) no *Guia do usuário do Amazon EBS*. + Para ver detalhes da API, consulte [ModifySnapshotTier](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-snapshot-tier.html) na *Referência de comandos da AWS CLI*. ### `modify-spot-fleet-request` O código de exemplo a seguir mostra como usar `modify-spot-fleet-request`. **AWS CLI** **Modificar uma solicitação de frota spot** Este comando de exemplo atualiza a capacidade de destino da solicitação de frota Spot especificada. Comando: ``` aws ec2 modify-spot-fleet-request --target-capacity 20 --spot-fleet-request-id sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE ``` Resultado: ``` { "Return": true } ``` Este exemplo de comando diminui a capacidade de destino da frota Spot especificada sem encerrar qualquer instância Spot como resultado. Comando: ``` aws ec2 modify-spot-fleet-request --target-capacity 10 --excess-capacity-termination-policy NoTermination --spot-fleet-request-ids sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE ``` Resultado: ``` { "Return": true } ``` + Para ver detalhes da API, consulte [ModifySpotFleetRequest](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-spot-fleet-request.html) na *Referência de comandos da AWS CLI*. ### `modify-subnet-attribute` O código de exemplo a seguir mostra como usar `modify-subnet-attribute`. **AWS CLI** **Alterar o comportamento de endereçamento IPv4 público de uma sub-rede** Este exemplo modifica a subnet-1a2b3c4d para especificar que todas as instâncias executadas nessa sub-rede recebam um endereço IPv4 público. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 modify-subnet-attribute --subnet-id subnet-1a2b3c4d --map-public-ip-on-launch ``` **Alterar o comportamento de endereçamento IPv6 de uma sub-rede** Este exemplo modifica a subnet-1a2b3c4d para especificar que todas as instâncias executadas nessa sub-rede recebam um endereço IPv6 do intervalo da sub-rede. Comando: ``` aws ec2 modify-subnet-attribute --subnet-id subnet-1a2b3c4d --assign-ipv6-address-on-creation ``` Para obter mais informações, consulte Endereço IP na VPC no *Guia do usuário da Nuvem privada virtual AWS*. + Para ver detalhes da API, consulte [ModifySubnetAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-subnet-attribute.html) na *Referência de comandos da AWS CLI*. ### `modify-traffic-mirror-filter-network-services` O código de exemplo a seguir mostra como usar `modify-traffic-mirror-filter-network-services`. **AWS CLI** **Adicionar serviços de rede a um filtro de espelhamento de tráfego** O exemplo `modify-traffic-mirror-filter-network-services` a seguir adiciona os serviços de rede Amazon DNS ao filtro especificado. ``` aws ec2 modify-traffic-mirror-filter-network-services \ --traffic-mirror-filter-id tmf-04812ff784EXAMPLE \ --add-network-service amazon-dns ``` Resultado: ``` { "TrafficMirrorFilter": { "Tags": [ { "Key": "Name", "Value": "Production" } ], "EgressFilterRules": [], "NetworkServices": [ "amazon-dns" ], "TrafficMirrorFilterId": "tmf-04812ff784EXAMPLE", "IngressFilterRules": [ { "SourceCidrBlock": "0.0.0.0/0", "RuleNumber": 1, "DestinationCidrBlock": "0.0.0.0/0", "Description": "TCP Rule", "Protocol": 6, "TrafficDirection": "ingress", "TrafficMirrorFilterId": "tmf-04812ff784EXAMPLE", "RuleAction": "accept", "TrafficMirrorFilterRuleId": "tmf-04812ff784EXAMPLE" } ] } } ``` Para obter mais informações, consulte [Modificar serviços de rede do filtro de espelhamento de tráfego](https://docs.aws.amazon.com/vpc/latest/mirroring/traffic-mirroring-filter.html#modify-traffic-mirroring-filter-network-services) do *Guia de espelhamento de tráfego da AWS*. + Para ver detalhes da API, consulte [ModifyTrafficMirrorFilterNetworkServices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-traffic-mirror-filter-network-services.html) na *Referência de comandos da AWS CLI*. ### `modify-traffic-mirror-filter-rule` O código de exemplo a seguir mostra como usar `modify-traffic-mirror-filter-rule`. **AWS CLI** **Modificar uma regra de filtro de espelhamento de tráfego** O exemplo `modify-traffic-mirror-filter-rule` a seguir modifica a descrição da regra de filtro de espelhamento de tráfego especificada. ``` aws ec2 modify-traffic-mirror-filter-rule \ --traffic-mirror-filter-rule-id tmfr-0ca76e0e08EXAMPLE \ --description "TCP Rule" ``` Resultado: ``` { "TrafficMirrorFilterRule": { "TrafficMirrorFilterRuleId": "tmfr-0ca76e0e08EXAMPLE", "TrafficMirrorFilterId": "tmf-0293f26e86EXAMPLE", "TrafficDirection": "ingress", "RuleNumber": 100, "RuleAction": "accept", "Protocol": 6, "DestinationCidrBlock": "10.0.0.0/24", "SourceCidrBlock": "10.0.0.0/24", "Description": "TCP Rule" } } ``` Para obter mais informações, consulte [Modificar suas regras de filtro de espelhamento de tráfego](https://docs.aws.amazon.com/vpc/latest/mirroring/traffic-mirroring-filter.html#modify-traffic-mirroring-filter-rules) no *Guia de espelhamento de tráfego da AWS*. + Para ver detalhes da API, consulte [ModifyTrafficMirrorFilterRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-traffic-mirror-filter-rule.html) na *Referência de comandos da AWS CLI*. ### `modify-traffic-mirror-session` O código de exemplo a seguir mostra como usar `modify-traffic-mirror-session`. **AWS CLI** **Modificar uma sessão de espelhamento de tráfego** O exemplo `modify-traffic-mirror-session` a seguir altera a descrição da sessão do espelhamento de tráfego e o número de pacotes a serem espelhados. ``` aws ec2 modify-traffic-mirror-session \ --description "Change packet length" \ --traffic-mirror-session-id tms-08a33b1214EXAMPLE \ --remove-fields "packet-length" ``` Resultado: ``` { "TrafficMirrorSession": { "TrafficMirrorSessionId": "tms-08a33b1214EXAMPLE", "TrafficMirrorTargetId": "tmt-07f75d8feeEXAMPLE", "TrafficMirrorFilterId": "tmf-04812ff784EXAMPLE", "NetworkInterfaceId": "eni-070203f901EXAMPLE", "OwnerId": "111122223333", "SessionNumber": 1, "VirtualNetworkId": 7159709, "Description": "Change packet length", "Tags": [] } } ``` Para obter mais informações, consulte [Modificar sessão de espelhamento de tráfego](https://docs.aws.amazon.com/vpc/latest/mirroring/traffic-mirroring-session.html#modify-traffic-mirroring-session) no *Guia de espelhamento de tráfego*. + Para ver detalhes da API, consulte [ModifyTrafficMirrorSession](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-traffic-mirror-session.html) na *Referência de comandos da AWS CLI*. ### `modify-transit-gateway-prefix-list-reference` O código de exemplo a seguir mostra como usar `modify-transit-gateway-prefix-list-reference`. **AWS CLI** **Modificar uma referência da lista de prefixos** O exemplo `modify-transit-gateway-prefix-list-reference` a seguir modifica a referência da lista de prefixos na tabela de rotas especificada alterando o anexo para o qual o tráfego é roteado. ``` aws ec2 modify-transit-gateway-prefix-list-reference \ --transit-gateway-route-table-id tgw-rtb-0123456789abcd123 \ --prefix-list-id pl-11111122222222333 \ --transit-gateway-attachment-id tgw-attach-aabbccddaabbccaab ``` Resultado: ``` { "TransitGatewayPrefixListReference": { "TransitGatewayRouteTableId": "tgw-rtb-0123456789abcd123", "PrefixListId": "pl-11111122222222333", "PrefixListOwnerId": "123456789012", "State": "modifying", "Blackhole": false, "TransitGatewayAttachment": { "TransitGatewayAttachmentId": "tgw-attach-aabbccddaabbccaab", "ResourceType": "vpc", "ResourceId": "vpc-112233445566aabbc" } } } ``` Para obter mais informações, consulte [Referências de lista de prefixos](https://docs.aws.amazon.com/vpc/latest/tgw/create-prefix-list-reference.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [ModifyTransitGatewayPrefixListReference](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-transit-gateway-prefix-list-reference.html) na *Referência de comandos da AWS CLI*. ### `modify-transit-gateway-vpc-attachment` O código de exemplo a seguir mostra como usar `modify-transit-gateway-vpc-attachment`. **AWS CLI** **Modificar um anexo VPC do gateway de trânsito** O exemplo `modify-transit-gateway-vpc-attachment` a seguir adiciona uma sub-rede ao anexo VPC do gateway de trânsito especificado. ``` aws ec2 modify-transit-gateway-vpc-attachment \ --transit-gateway-attachment-id tgw-attach-09fbd47ddfEXAMPLE \ --add-subnet-ids subnet-0e51f45802EXAMPLE ``` Resultado: ``` { "TransitGatewayVpcAttachment": { "TransitGatewayAttachmentId": "tgw-attach-09fbd47ddfEXAMPLE", "TransitGatewayId": "tgw-0560315ccfEXAMPLE", "VpcId": "vpc-5eccc927", "VpcOwnerId": "111122223333", "State": "modifying", "SubnetIds": [ "subnet-0e51f45802EXAMPLE", "subnet-1EXAMPLE" ], "CreationTime": "2019-08-08T16:47:38.000Z", "Options": { "DnsSupport": "enable", "Ipv6Support": "disable" } } } ``` Para obter mais informações, consulte [Anexos do gateway de trânsito para uma VPC](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-vpc-attachments.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [ModifyTransitGatewayVpcAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-transit-gateway-vpc-attachment.html) na *Referência de comandos da AWS CLI*. ### `modify-transit-gateway` O código de exemplo a seguir mostra como usar `modify-transit-gateway`. **AWS CLI** **Modificar um gateway de trânsito** O exemplo `modify-transit-gateway` a seguir modifica o gateway de trânsito especificado ativando o suporte ECMP para anexos VPN. ``` aws ec2 modify-transit-gateway \ --transit-gateway-id tgw-111111222222aaaaa \ --options VpnEcmpSupport=enable ``` Resultado: ``` { "TransitGateway": { "TransitGatewayId": "tgw-111111222222aaaaa", "TransitGatewayArn": "64512", "State": "modifying", "OwnerId": "123456789012", "CreationTime": "2020-04-30T08:41:37.000Z", "Options": { "AmazonSideAsn": 64512, "AutoAcceptSharedAttachments": "disable", "DefaultRouteTableAssociation": "enable", "AssociationDefaultRouteTableId": "tgw-rtb-0123456789abcd123", "DefaultRouteTablePropagation": "enable", "PropagationDefaultRouteTableId": "tgw-rtb-0123456789abcd123", "VpnEcmpSupport": "enable", "DnsSupport": "enable" } } } ``` Para obter mais informações, consulte [Gateways de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-transit-gateways.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [ModifyTransitGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-transit-gateway.html) na *Referência de comandos da AWS CLI*. ### `modify-verified-access-endpoint-policy` O código de exemplo a seguir mostra como usar `modify-verified-access-endpoint-policy`. **AWS CLI** **Configurar a política de acesso verificado para um endpoint** O exemplo `modify-verified-access-endpoint-policy` a seguir adiciona a política de acesso verificado especificada ao endpoint de acesso verificado especificado. ``` aws ec2 modify-verified-access-endpoint-policy \ --verified-access-endpoint-id vae-066fac616d4d546f2 \ --policy-enabled \ --policy-document file://policy.txt ``` Conteúdo de `policy.txt`: ``` permit(principal,action,resource) when { context.identity.groups.contains("finance") && context.identity.email.verified == true }; ``` Resultado: ``` { "PolicyEnabled": true, "PolicyDocument": "permit(principal,action,resource)\nwhen {\n context.identity.groups.contains(\"finance\") &&\n context.identity.email_verified == true\n};" } ``` Para obter mais informações, consulte [Políticas de acesso verificado](https://docs.aws.amazon.com/verified-access/latest/ug/auth-policies.html) no *Guia do usuário do acesso verificado da AWS*. + Para ver detalhes da API, consulte [ModifyVerifiedAccessEndpointPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-verified-access-endpoint-policy.html) na *Referência de comandos da AWS CLI*. ### `modify-verified-access-endpoint` O código de exemplo a seguir mostra como usar `modify-verified-access-endpoint`. **AWS CLI** **Modificar a configuração de um endpoint do acesso verificado** O exemplo `modify-verified-access-endpoint` a seguir adiciona a descrição especificada ao endpoint de acesso verificado especificado. ``` aws ec2 modify-verified-access-endpoint \ --verified-access-endpoint-id vae-066fac616d4d546f2 \ --description 'Testing Verified Access' ``` Resultado: ``` { "VerifiedAccessEndpoint": { "VerifiedAccessInstanceId": "vai-0ce000c0b7643abea", "VerifiedAccessGroupId": "vagr-0dbe967baf14b7235", "VerifiedAccessEndpointId": "vae-066fac616d4d546f2", "ApplicationDomain": "example.com", "EndpointType": "network-interface", "AttachmentType": "vpc", "DomainCertificateArn": "arn:aws:acm:us-east-2:123456789012:certificate/eb065ea0-26f9-4e75-a6ce-0a1a7EXAMPLE", "EndpointDomain": "my-ava-app.edge-00c3372d53b1540bb.vai-0ce000c0b7643abea.prod.verified-access.us-east-2.amazonaws.com", "SecurityGroupIds": [ "sg-004915970c4c8f13a" ], "NetworkInterfaceOptions": { "NetworkInterfaceId": "eni-0aec70418c8d87a0f", "Protocol": "https", "Port": 443 }, "Status": { "Code": "updating" }, "Description": "Testing Verified Access", "CreationTime": "2023-08-25T20:54:43", "LastUpdatedTime": "2023-08-25T22:46:32" } } ``` Para obter mais informações, consulte [Endpoints de acesso verificado](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-endpoints.html) no *Guia do usuário do acesso verificado da AWS*. + Para ver detalhes da API, consulte [ModifyVerifiedAccessEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-verified-access-endpoint.html) na *Referência de comandos da AWS CLI*. ### `modify-verified-access-group-policy` O código de exemplo a seguir mostra como usar `modify-verified-access-group-policy`. **AWS CLI** **Configurar uma política de acesso verificado para um grupo** O exemplo `modify-verified-access-group-policy` a seguir adiciona a política de acesso verificado especificada ao grupo de acesso verificado especificado. ``` aws ec2 modify-verified-access-group-policy \ --verified-access-group-id vagr-0dbe967baf14b7235 \ --policy-enabled \ --policy-document file://policy.txt ``` Conteúdo de `policy.txt`: ``` permit(principal,action,resource) when { context.identity.groups.contains("finance") && context.identity.email.verified == true }; ``` Resultado: ``` { "PolicyEnabled": true, "PolicyDocument": "permit(principal,action,resource)\nwhen {\n context.identity.groups.contains(\"finance\") &&\n context.identity.email_verified == true\n};" } ``` Para obter mais informações, consulte [Grupos de acesso verificado](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-groups.html) no *Guia do usuário do acesso verificado da AWS*. + Para ver detalhes da API, consulte [ModifyVerifiedAccessGroupPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-verified-access-group-policy.html) na *Referência de comandos da AWS CLI*. ### `modify-verified-access-group` O código de exemplo a seguir mostra como usar `modify-verified-access-group`. **AWS CLI** **Modificar a configuração de um grupo de acesso verificado** O exemplo `modify-verified-access-group` a seguir adiciona a descrição especificada ao grupo de acesso verificado especificado. ``` aws ec2 modify-verified-access-group \ --verified-access-group-id vagr-0dbe967baf14b7235 \ --description "Testing Verified Access" ``` Resultado: ``` { "VerifiedAccessGroup": { "VerifiedAccessGroupId": "vagr-0dbe967baf14b7235", "VerifiedAccessInstanceId": "vai-0ce000c0b7643abea", "Description": "Testing Verified Access", "Owner": "123456789012", "VerifiedAccessGroupArn": "arn:aws:ec2:us-east-2:123456789012:verified-access-group/vagr-0dbe967baf14b7235", "CreationTime": "2023-08-25T19:55:19", "LastUpdatedTime": "2023-08-25T22:17:25" } } ``` Para obter mais informações, consulte [Grupos de acesso verificado](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-groups.html) no *Guia do usuário do acesso verificado da AWS*. + Para ver detalhes da API, consulte [ModifyVerifiedAccessGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-verified-access-group.html) na *Referência de comandos da AWS CLI*. ### `modify-verified-access-instance-logging-configuration` O código de exemplo a seguir mostra como usar `modify-verified-access-instance-logging-configuration`. **AWS CLI** **Habilitar o registro em uma instância de acesso verificado** O exemplo `modify-verified-access-instance-logging-configuration` a seguir habilita o log de acesso para a instância especificada do acesso verificado. Os logs serão entregues ao grupo de logs do CloudWatch Logs especificado. ``` aws ec2 modify-verified-access-instance-logging-configuration \ --verified-access-instance-id vai-0ce000c0b7643abea \ --access-logs CloudWatchLogs={Enabled=true,LogGroup=my-log-group} ``` Resultado: ``` { "LoggingConfiguration": { "VerifiedAccessInstanceId": "vai-0ce000c0b7643abea", "AccessLogs": { "S3": { "Enabled": false }, "CloudWatchLogs": { "Enabled": true, "DeliveryStatus": { "Code": "success" }, "LogGroup": "my-log-group" }, "KinesisDataFirehose": { "Enabled": false }, "LogVersion": "ocsf-1.0.0-rc.2", "IncludeTrustContext": false } } } ``` Para obter mais informações, consulte [Logs do acesso verificado](https://docs.aws.amazon.com/verified-access/latest/ug/access-logs.html) no *Guia do usuário do acesso verificado da AWS*. + Para ver detalhes da API, consulte [ModifyVerifiedAccessInstanceLoggingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-verified-access-instance-logging-configuration.html) na *Referência de comandos da AWS CLI*. ### `modify-verified-access-instance` O código de exemplo a seguir mostra como usar `modify-verified-access-instance`. **AWS CLI** **Modificar a configuração da instância de acesso verificado** O exemplo `modify-verified-access-instance` a seguir adiciona a descrição especificada à instância de acesso verificado especificada. ``` aws ec2 modify-verified-access-instance \ --verified-access-instance-id vai-0ce000c0b7643abea \ --description "Testing Verified Access" ``` Resultado: ``` { "VerifiedAccessInstance": { "VerifiedAccessInstanceId": "vai-0ce000c0b7643abea", "Description": "Testing Verified Access", "VerifiedAccessTrustProviders": [ { "VerifiedAccessTrustProviderId": "vatp-0bb32de759a3e19e7", "TrustProviderType": "user", "UserTrustProviderType": "iam-identity-center" } ], "CreationTime": "2023-08-25T18:27:56", "LastUpdatedTime": "2023-08-25T22:41:04" } } ``` Para obter mais informações, consulte [Instâncias de acesso verificado](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-instances.html) no *Guia do usuário do acesso verificado da AWS*. + Para ver detalhes da API, consulte [ModifyVerifiedAccessInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-verified-access-instance.html) na *Referência de comandos da AWS CLI*. ### `modify-verified-access-trust-provider` O código de exemplo a seguir mostra como usar `modify-verified-access-trust-provider`. **AWS CLI** **Modificar a configuração de um provedor confiável de acesso verificado** O exemplo `modify-verified-access-trust-provider` a seguir adiciona a descrição especificada ao provedor confiável especificado do acesso verificado. ``` aws ec2 modify-verified-access-trust-provider \ --verified-access-trust-provider-id vatp-0bb32de759a3e19e7 \ --description "Testing Verified Access" ``` Resultado: ``` { "VerifiedAccessTrustProvider": { "VerifiedAccessTrustProviderId": "vatp-0bb32de759a3e19e7", "Description": "Testing Verified Access", "TrustProviderType": "user", "UserTrustProviderType": "iam-identity-center", "PolicyReferenceName": "idc", "CreationTime": "2023-08-25T19:00:38", "LastUpdatedTime": "2023-08-25T19:18:21" } } ``` Para obter mais informações, consulte [Provedores confiáveis para acesso verificado](https://docs.aws.amazon.com/verified-access/latest/ug/trust-providers.html) no *Guia do usuário de acesso verificado da AWS*. + Para ver detalhes da API, consulte [ModifyVerifiedAccessTrustProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-verified-access-trust-provider.html) na *Referência de comandos da AWS CLI*. ### `modify-volume-attribute` O código de exemplo a seguir mostra como usar `modify-volume-attribute`. **AWS CLI** **Modificar um atributo de volume** Este exemplo define o atributo `autoEnableIo` do volume com o ID `vol-1234567890abcdef0` como `true`. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 modify-volume-attribute --volume-id vol-1234567890abcdef0 --auto-enable-io ``` + Para ver detalhes da API, consulte [ModifyVolumeAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-volume-attribute.html) na *Referência de comandos da AWS CLI*. ### `modify-volume` O código de exemplo a seguir mostra como usar `modify-volume`. **AWS CLI** **Exemplo 1: modificar um volume alterando seu tamanho** O exemplo `modify-volume` a seguir altera o tamanho do volume especificado para 150 GB. Comando: ``` aws ec2 modify-volume --size 150 --volume-id vol-1234567890abcdef0 ``` Resultado: ``` { "VolumeModification": { "TargetSize": 150, "TargetVolumeType": "io1", "ModificationState": "modifying", "VolumeId": " vol-1234567890abcdef0", "TargetIops": 100, "StartTime": "2019-05-17T11:27:19.000Z", "Progress": 0, "OriginalVolumeType": "io1", "OriginalIops": 100, "OriginalSize": 100 } } ``` **Exemplo 2: modificar um volume alterando seu tipo, tamanho e valor de IOPS** O exemplo `modify-volume` a seguir altera o tipo de volume para SSD de IOPS provisionadas, define a taxa de IOPS alvo como 10000 e define o tamanho do volume como 350 GB. ``` aws ec2 modify-volume \ --volume-type io1 \ --iops 10000 \ --size 350 \ --volume-id vol-1234567890abcdef0 ``` Resultado: ``` { "VolumeModification": { "TargetSize": 350, "TargetVolumeType": "io1", "ModificationState": "modifying", "VolumeId": "vol-0721c1a9d08c93bf6", "TargetIops": 10000, "StartTime": "2019-05-17T11:38:57.000Z", "Progress": 0, "OriginalVolumeType": "gp2", "OriginalIops": 150, "OriginalSize": 50 } } ``` + Para ver detalhes da API, consulte [ModifyVolume](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-volume.html) na *Referência de comandos da AWS CLI*. ### `modify-vpc-attribute` O código de exemplo a seguir mostra como usar `modify-vpc-attribute`. **AWS CLI** **Modificar o atributo enableDnsSupport** Este exemplo modifica o atributo `enableDnsSupport`. Esse atributo indica se a VPC conta com resolução de DNS habilitada. Se este atributo é `true`, o servidor de DNS da Amazon resolve os nomes de hosts DNS de suas instâncias para os endereços IP correspondentes; caso contrário, ele não resolve. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 modify-vpc-attribute --vpc-id vpc-a01106c2 --enable-dns-support "{\"Value\":false}" ``` **Modificar o atributo enableDnsHostnames** Este exemplo modifica o atributo `enableDnsHostnames`. Esse atributo indica se instâncias executadas na VPC obtêm nomes de host DNS. Se esse atributo é `true`, as instâncias na VPC obtêm os nomes de hosts DNS; caso contrário, isso não ocorrerá. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 modify-vpc-attribute --vpc-id vpc-a01106c2 --enable-dns-hostnames "{\"Value\":false}" ``` + Para ver detalhes da API, consulte [ModifyVpcAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-vpc-attribute.html) na *Referência de comandos da AWS CLI*. ### `modify-vpc-endpoint-connection-notification` O código de exemplo a seguir mostra como usar `modify-vpc-endpoint-connection-notification`. **AWS CLI** **Modificar uma notificação de conexão de endpoint** Este exemplo altera o tópico do SNS para a notificação de conexão de endpoint especificada. Comando: ``` aws ec2 modify-vpc-endpoint-connection-notification --connection-notification-id vpce-nfn-008776de7e03f5abc --connection-events Accept Reject --connection-notification-arn arn:aws:sns:us-east-2:123456789012:mytopic ``` Resultado: ``` { "ReturnValue": true } ``` + Para ver detalhes da API, consulte [ModifyVpcEndpointConnectionNotification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-vpc-endpoint-connection-notification.html) na *Referência de comandos da AWS CLI*. ### `modify-vpc-endpoint-service-configuration` O código de exemplo a seguir mostra como usar `modify-vpc-endpoint-service-configuration`. **AWS CLI** **Modificar uma configuração de serviço de endpoint** Este exemplo altera o requisito de aceitação para o serviço de endpoint especificado. Comando: ``` aws ec2 modify-vpc-endpoint-service-configuration --service-id vpce-svc-09222513e6e77dc86 --no-acceptance-required ``` Resultado: ``` { "ReturnValue": true } ``` + Para ver detalhes da API, consulte [ModifyVpcEndpointServiceConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-vpc-endpoint-service-configuration.html) na *Referência de comandos da AWS CLI*. ### `modify-vpc-endpoint-service-payer-responsibility` O código de exemplo a seguir mostra como usar `modify-vpc-endpoint-service-payer-responsibility`. **AWS CLI** **Modificar a responsabilidade do pagador** O exemplo `modify-vpc-endpoint-service-payer-responsibility` a seguir modifica a responsabilidade do pagador pelo serviço de endpoint especificado. ``` aws ec2 modify-vpc-endpoint-service-payer-responsibility \ --service-id vpce-svc-071afff70666e61e0 \ --payer-responsibility ServiceOwner ``` Este comando não produz saída. + Para ver detalhes da API, consulte [ModifyVpcEndpointServicePayerResponsibility](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-vpc-endpoint-service-payer-responsibility.html) na *Referência de comandos da AWS CLI*. ### `modify-vpc-endpoint-service-permissions` O código de exemplo a seguir mostra como usar `modify-vpc-endpoint-service-permissions`. **AWS CLI** **Modificar as permissões de serviço endpoint** Este exemplo adiciona permissão para que uma conta AWS se conecte ao serviço de endpoint especificado. Comando: ``` aws ec2 modify-vpc-endpoint-service-permissions --service-id vpce-svc-03d5ebb7d9579a2b3 --add-allowed-principals '["arn:aws:iam::123456789012:root"]' ``` Resultado: ``` { "ReturnValue": true } ``` Este exemplo adiciona permissão para que um usuário do IAM específico (`admin`) se conecte ao serviço de endpoint especificado. Comando: ``` aws ec2 modify-vpc-endpoint-service-permissions --service-id vpce-svc-03d5ebb7d9579a2b3 --add-allowed-principals '["arn:aws:iam::123456789012:user/admin"]' ``` + Para ver detalhes da API, consulte [ModifyVpcEndpointServicePermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-vpc-endpoint-service-permissions.html) na *Referência de comandos da AWS CLI*. ### `modify-vpc-endpoint` O código de exemplo a seguir mostra como usar `modify-vpc-endpoint`. **AWS CLI** **Modificar um endpoint do gateway** Este exemplo modifica o endpoint do gateway `vpce-1a2b3c4d` associando a tabela de rotas `rtb-aaa222bb` ao endpoint e redefinindo o documento de política. Comando: ``` aws ec2 modify-vpc-endpoint --vpc-endpoint-id vpce-1a2b3c4d --add-route-table-ids rtb-aaa222bb --reset-policy ``` Resultado: ``` { "Return": true } ``` **Modificar um endpoint de interface** Este exemplo modifica o endpoint da interface `vpce-0fe5b17a0707d6fa5` adicionando uma sub-rede `subnet-d6fcaa8d` ao endpoint. Comando: ``` aws ec2 modify-vpc-endpoint --vpc-endpoint-id vpce-0fe5b17a0707d6fa5 --add-subnet-id subnet-d6fcaa8d ``` Resultado: ``` { "Return": true } ``` + Para ver detalhes da API, consulte [ModifyVpcEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-vpc-endpoint.html) na *Referência de comandos da AWS CLI*. ### `modify-vpc-peering-connection-options` O código de exemplo a seguir mostra como usar `modify-vpc-peering-connection-options`. **AWS CLI** **Habilitar a comunicação por meio de uma conexão de emparelhamento da VPC a partir de sua conexão ClassicLink local** Neste exemplo, para conexão de emparelhamento `pcx-aaaabbb`, o proprietário da VPC solicitante modifica as opções de conexão de emparelhamento da VPC para habilitar uma conexão ClassicLink local para se comunicar com a VPC de emparelhamento. Comando: ``` aws ec2 modify-vpc-peering-connection-options --vpc-peering-connection-id pcx-aaaabbbb --requester-peering-connection-options AllowEgressFromLocalClassicLinkToRemoteVpc=true ``` Resultado: ``` { "RequesterPeeringConnectionOptions": { "AllowEgressFromLocalClassicLinkToRemoteVpc": true } } ``` **Habilitar a comunicação por meio de uma conexão de emparelhamento da VPC de sua VPC local para uma conexão remota do ClassicLink** Neste exemplo, o proprietário da VPC que vai aceitar a conexão modifica as opções de conexão de emparelhamento da VPC para habilitar a comunicação da VPC local com a conexão ClassicLink remota na VPC emparelhada. Comando: ``` aws ec2 modify-vpc-peering-connection-options --vpc-peering-connection-id pcx-aaaabbbb --accepter-peering-connection-options AllowEgressFromLocalVpcToRemoteClassicLink=true ``` Resultado: ``` { "AccepterPeeringConnectionOptions": { "AllowEgressFromLocalVpcToRemoteClassicLink": true } } ``` **Habilitar um suporte de resolução DNS para a conexão de emparelhamento da VPC** Neste exemplo, o proprietário da VPC solicitante modifica as opções de conexão de emparelhamento da VPC para `pcx-aaaabbbb` para habilitar a VPC local a solucionar nomes de hosts DNS públicos para endereços IP privados quando em consultas provenientes de instâncias na VPC emparelhada. Comando: ``` aws ec2 modify-vpc-peering-connection-options --vpc-peering-connection-id pcx-aaaabbbb --requester-peering-connection-options AllowDnsResolutionFromRemoteVpc=true ``` Resultado: ``` { "RequesterPeeringConnectionOptions": { "AllowDnsResolutionFromRemoteVpc": true } } ``` + Para ver detalhes da API, consulte [ModifyVpcPeeringConnectionOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-vpc-peering-connection-options.html) na *Referência de comandos da AWS CLI*. ### `modify-vpc-tenancy` O código de exemplo a seguir mostra como usar `modify-vpc-tenancy`. **AWS CLI** **Modificar a locação de uma VPC** Este exemplo modifica a locação da VPC `vpc-1a2b3c4d` para `default`. Comando: ``` aws ec2 modify-vpc-tenancy --vpc-id vpc-1a2b3c4d --instance-tenancy default ``` Resultado: ``` { "Return": true } ``` + Para ver detalhes da API, consulte [ModifyVpcTenancy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-vpc-tenancy.html) na *Referência de comandos da AWS CLI*. ### `modify-vpn-connection-options` O código de exemplo a seguir mostra como usar `modify-vpn-connection-options`. **AWS CLI** **Modificar as opções de conexão da VPN** O exemplo `modify-vpn-connection-options` a seguir modifica o CIDR IPv4 local no lado do gateway do cliente da conexão VPN especificada. ``` aws ec2 modify-vpn-connection-options \ --vpn-connection-id vpn-1122334455aabbccd \ --local-ipv4-network-cidr 10.0.0.0/16 ``` Resultado: ``` { "VpnConnections": [ { "CustomerGatewayConfiguration": "...configuration information...", "CustomerGatewayId": "cgw-01234567abcde1234", "Category": "VPN", "State": "modifying", "Type": "ipsec.1", "VpnConnectionId": "vpn-1122334455aabbccd", "TransitGatewayId": "tgw-00112233445566aab", "Options": { "EnableAcceleration": false, "StaticRoutesOnly": true, "LocalIpv4NetworkCidr": "10.0.0.0/16", "RemoteIpv4NetworkCidr": "0.0.0.0/0", "TunnelInsideIpVersion": "ipv4" }, "Routes": [], "Tags": [ { "Key": "Name", "Value": "CanadaVPN" } ], "VgwTelemetry": [ { "AcceptedRouteCount": 0, "LastStatusChange": "2020-07-29T10:35:11.000Z", "OutsideIpAddress": "203.0.113.3", "Status": "DOWN", "StatusMessage": "" }, { "AcceptedRouteCount": 0, "LastStatusChange": "2020-09-02T09:09:33.000Z", "OutsideIpAddress": "203.0.113.5", "Status": "UP", "StatusMessage": "" } ] } ] } ``` Para obter mais informações, consulte [Modificar opções de conexão da VPN Site-to-Site](https://docs.aws.amazon.com/vpn/latest/s2svpn/modify-vpn-connection-options.html) no *Guia do usuário do AWS VPN Site-to-Site*. + Para ver detalhes da API, consulte [ModifyVpnConnectionOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-vpn-connection-options.html) na *Referência de comandos da AWS CLI*. ### `modify-vpn-connection` O código de exemplo a seguir mostra como usar `modify-vpn-connection`. **AWS CLI** **Modificar uma conexão VPN** O exemplo `modify-vpn-connection` a seguir altera o gateway de destino da conexão VPN `vpn-12345678901234567` para o gateway privado virtual `vgw-11223344556677889`: ``` aws ec2 modify-vpn-connection \ --vpn-connection-id vpn-12345678901234567 \ --vpn-gateway-id vgw-11223344556677889 ``` Resultado: ``` { "VpnConnection": { "CustomerGatewayConfiguration": "...configuration information...", "CustomerGatewayId": "cgw-aabbccddee1122334", "Category": "VPN", "State": "modifying", "Type": "ipsec.1", "VpnConnectionId": "vpn-12345678901234567", "VpnGatewayId": "vgw-11223344556677889", "Options": { "StaticRoutesOnly": false }, "VgwTelemetry": [ { "AcceptedRouteCount": 0, "LastStatusChange": "2019-07-17T07:34:00.000Z", "OutsideIpAddress": "18.210.3.222", "Status": "DOWN", "StatusMessage": "IPSEC IS DOWN" }, { "AcceptedRouteCount": 0, "LastStatusChange": "2019-07-20T21:20:16.000Z", "OutsideIpAddress": "34.193.129.33", "Status": "DOWN", "StatusMessage": "IPSEC IS DOWN" } ] } } ``` + Para ver detalhes da API, consulte [ModifyVpnConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-vpn-connection.html) na *Referência de comandos da AWS CLI*. ### `modify-vpn-tunnel-certificate` O código de exemplo a seguir mostra como usar `modify-vpn-tunnel-certificate`. **AWS CLI** **Rotacionar um certificado de túnel de VPN** O exemplo `modify-vpn-tunnel-certificate` a seguir rotaciona o certificado para o túnel especificado para uma conexão VPN ``` aws ec2 modify-vpn-tunnel-certificate \ --vpn-tunnel-outside-ip-address 203.0.113.17 \ --vpn-connection-id vpn-12345678901234567 ``` Resultado: ``` { "VpnConnection": { "CustomerGatewayConfiguration": ...configuration information..., "CustomerGatewayId": "cgw-aabbccddee1122334", "Category": "VPN", "State": "modifying", "Type": "ipsec.1", "VpnConnectionId": "vpn-12345678901234567", "VpnGatewayId": "vgw-11223344556677889", "Options": { "StaticRoutesOnly": false }, "VgwTelemetry": [ { "AcceptedRouteCount": 0, "LastStatusChange": "2019-09-11T17:27:14.000Z", "OutsideIpAddress": "203.0.113.17", "Status": "DOWN", "StatusMessage": "IPSEC IS DOWN", "CertificateArn": "arn:aws:acm:us-east-1:123456789101:certificate/c544d8ce-20b8-4fff-98b0-example" }, { "AcceptedRouteCount": 0, "LastStatusChange": "2019-09-11T17:26:47.000Z", "OutsideIpAddress": "203.0.114.18", "Status": "DOWN", "StatusMessage": "IPSEC IS DOWN", "CertificateArn": "arn:aws:acm:us-east-1:123456789101:certificate/5ab64566-761b-4ad3-b259-example" } ] } } ``` + Para ver detalhes da API, consulte [ModifyVpnTunnelCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-vpn-tunnel-certificate.html) na *Referência de comandos da AWS CLI*. ### `modify-vpn-tunnel-options` O código de exemplo a seguir mostra como usar `modify-vpn-tunnel-options`. **AWS CLI** **Modificar as opções de túnel de uma conexão VPN** O exemplo `modify-vpn-tunnel-options` a seguir atualiza os grupos Diffie-Hellman permitidos para o túnel especificado e a conexão VPN. ``` aws ec2 modify-vpn-tunnel-options \ --vpn-connection-id vpn-12345678901234567 \ --vpn-tunnel-outside-ip-address 203.0.113.17 \ --tunnel-options Phase1DHGroupNumbers=[{Value=14},{Value=15},{Value=16},{Value=17},{Value=18}],Phase2DHGroupNumbers=[{Value=14},{Value=15},{Value=16},{Value=17},{Value=18}] ``` Resultado: ``` { "VpnConnection": { "CustomerGatewayConfiguration": "...configuration information...", "CustomerGatewayId": "cgw-aabbccddee1122334", "Category": "VPN", "State": "available", "Type": "ipsec.1", "VpnConnectionId": "vpn-12345678901234567", "VpnGatewayId": "vgw-11223344556677889", "Options": { "StaticRoutesOnly": false, "TunnelOptions": [ { "OutsideIpAddress": "203.0.113.17", "Phase1DHGroupNumbers": [ { "Value": 14 }, { "Value": 15 }, { "Value": 16 }, { "Value": 17 }, { "Value": 18 } ], "Phase2DHGroupNumbers": [ { "Value": 14 }, { "Value": 15 }, { "Value": 16 }, { "Value": 17 }, { "Value": 18 } ] }, { "OutsideIpAddress": "203.0.114.19" } ] }, "VgwTelemetry": [ { "AcceptedRouteCount": 0, "LastStatusChange": "2019-09-10T21:56:54.000Z", "OutsideIpAddress": "203.0.113.17", "Status": "DOWN", "StatusMessage": "IPSEC IS DOWN" }, { "AcceptedRouteCount": 0, "LastStatusChange": "2019-09-10T21:56:43.000Z", "OutsideIpAddress": "203.0.114.19", "Status": "DOWN", "StatusMessage": "IPSEC IS DOWN" } ] } } ``` + Para ver detalhes da API, consulte [ModifyVpnTunnelOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-vpn-tunnel-options.html) na *Referência de comandos da AWS CLI*. ### `monitor-instances` O código de exemplo a seguir mostra como usar `monitor-instances`. **AWS CLI** **Para habilitar o monitoramento detalhado de uma instância** Este exemplo de comando habilita o monitoramento detalhado da instância especificada. Comando: ``` aws ec2 monitor-instances --instance-ids i-1234567890abcdef0 ``` Resultado: ``` { "InstanceMonitorings": [ { "InstanceId": "i-1234567890abcdef0", "Monitoring": { "State": "pending" } } ] } ``` + Consulte detalhes da API em [MonitorInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/monitor-instances.html) na *Referência de comandos da AWS CLI*. ### `move-address-to-vpc` O código de exemplo a seguir mostra como usar `move-address-to-vpc`. **AWS CLI** **Mover um endereço para EC2-VPC** Este exemplo move o endereço IP elástico 54.123.4.56 para a plataforma EC2-VPC. Comando: ``` aws ec2 move-address-to-vpc --public-ip 54.123.4.56 ``` Resultado: ``` { "Status": "MoveInProgress" } ``` + Para ver detalhes da API, consulte [MoveAddressToVpc](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/move-address-to-vpc.html) na *Referência de comandos da AWS CLI*. ### `move-byoip-cidr-to-ipam` O código de exemplo a seguir mostra como usar `move-byoip-cidr-to-ipam`. **AWS CLI** **Transferir um CIDR BYOIP para o IPAM** O exemplo `move-byoip-cidr-to-ipam` a seguir transfere um CIDR BYOIP para o IPAM. (Linux): ``` aws ec2 move-byoip-cidr-to-ipam \ --region us-west-2 \ --ipam-pool-id ipam-pool-0a03d430ca3f5c035 \ --ipam-pool-owner 111111111111 \ --cidr 130.137.249.0/24 ``` (Windows): ``` aws ec2 move-byoip-cidr-to-ipam ^ --region us-west-2 ^ --ipam-pool-id ipam-pool-0a03d430ca3f5c035 ^ --ipam-pool-owner 111111111111 ^ --cidr 130.137.249.0/24 ``` Resultado: ``` { "ByoipCidr": { "Cidr": "130.137.249.0/24", "State": "pending-transfer" } } ``` Para obter mais informações, consulte [Tutorial: transferir um CIDR IPv4 BYOIP existente para IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoip-ipam-transfer-ipv4.html) no *Guia do usuário IPAM da Amazon VPC*. + Para ver detalhes da API, consulte [MoveByoipCidrToIpam](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/move-byoip-cidr-to-ipam.html) na *Referência de comandos da AWS CLI*. ### `network-insights-access-scope` O código de exemplo a seguir mostra como usar `network-insights-access-scope`. **AWS CLI** **Criar escopos de acesso do Network Insights** O exemplo `create-network-insights-access-scope` a seguir cria um escopo de acesso ao Network Insights em sua conta da AWS. ``` aws ec2 create-network-insights-access-scope \ --cli-input-json file://access-scope-file.json ``` Conteúdo de `access-scope-file.json`: ``` { { "MatchPaths": [ { "Source": { "ResourceStatement": { "Resources": [ "vpc-abcd12e3" ] } } } ], "ExcludePaths": [ { "Source": { "ResourceStatement": { "ResourceTypes": [ "AWS::EC2::InternetGateway" ] } } } ] } } ``` Resultado: ``` { "NetworkInsightsAccessScopeAnalysisId": "nisa-123456789111" }{ "NetworkInsightsAccessScope": { "NetworkInsightsAccessScopeId": "nis-123456789222", "NetworkInsightsAccessScopeArn": "arn:aws:ec2:us-east-1:123456789222:network-insights-access-scope/nis-123456789222", "CreatedDate": "2022-01-25T19:20:28.796000+00:00", "UpdatedDate": "2022-01-25T19:20:28.797000+00:00" }, "NetworkInsightsAccessScopeContent": { "NetworkInsightsAccessScopeId": "nis-04c0c0fbca737c404", "MatchPaths": [ { "Source": { "ResourceStatement": { "Resources": [ "vpc-abcd12e3" ] } } } ], "ExcludePaths": [ { "Source": { "ResourceStatement": { "ResourceTypes": [ "AWS::EC2::InternetGateway" ] } } } ] } } ``` Para obter mais informações, consulte [Introdução ao Analisador de Acesso à Rede usando AWS CLI](https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/getting-started-cli-naa.html) no *Guia do Analisador de Acesso à Rede*. + Para ver detalhes da API, consulte [NetworkInsightsAccessScope](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/network-insights-access-scope.html) na *Referência de comandos da AWS CLI*. ### `provision-byoip-cidr` O código de exemplo a seguir mostra como usar `provision-byoip-cidr`. **AWS CLI** **Provisionar um intervalo de endereços** O exemplo `provision-byoip-cidr` a seguir provisiona um intervalo de endereços IP públicos para uso comAWS. ``` aws ec2 provision-byoip-cidr \ --cidr 203.0.113.25/24 \ --cidr-authorization-context Message="$text_message",Signature="$signed_message" ``` Resultado: ``` { "ByoipCidr": { "Cidr": "203.0.113.25/24", "State": "pending-provision" } } ``` Para obter mais informações sobre a criação de cadeias de mensagens para o contexto de autorização, consulte [Traga seus próprios endereços IP](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [ProvisionByoipCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/provision-byoip-cidr.html) na *Referência de comandos da AWS CLI*. ### `provision-ipam-pool-cidr` O código de exemplo a seguir mostra como usar `provision-ipam-pool-cidr`. **AWS CLI** **Provisionar um CIDR para um pool do IPAM** O exemplo `provision-ipam-pool-cidr` a seguir provisiona um CIDR para um grupo do IPAM. (Linux): ``` aws ec2 provision-ipam-pool-cidr \ --ipam-pool-id ipam-pool-0533048da7d823723 \ --cidr 10.0.0.0/24 ``` (Windows): ``` aws ec2 provision-ipam-pool-cidr ^ --ipam-pool-id ipam-pool-0533048da7d823723 ^ --cidr 10.0.0.0/24 ``` Resultado: ``` { "IpamPoolCidr": { "Cidr": "10.0.0.0/24", "State": "pending-provision" } } ``` Para obter mais informações, consulte [Provisionar CIDRs para um pool](https://docs.aws.amazon.com/vpc/latest/ipam/prov-cidr-ipam.html) no *Guia do usuário do IPAM da Amazon VPC*. + Para ver detalhes da API, consulte [ProvisionIpamPoolCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/provision-ipam-pool-cidr.html) na *Referência de comandos da AWS CLI*. ### `purchase-host-reservation` O código de exemplo a seguir mostra como usar `purchase-host-reservation`. **AWS CLI** **Comprar uma reserva de host dedicado** Este exemplo compra a oferta de Reserva de Host Dedicado especificada para o Host Dedicado especificado em sua conta. Comando: ``` aws ec2 purchase-host-reservation --offering-id hro-03f707bf363b6b324 --host-id-set h-013abcd2a00cbd123 ``` Resultado: ``` { "TotalHourlyPrice": "1.499", "Purchase": [ { "HourlyPrice": "1.499", "InstanceFamily": "m4", "PaymentOption": "NoUpfront", "HostIdSet": [ "h-013abcd2a00cbd123" ], "HostReservationId": "hr-0d418a3a4ffc669ae", "UpfrontPrice": "0.000", "Duration": 31536000 } ], "TotalUpfrontPrice": "0.000" } ``` + Para ver detalhes da API, consulte [PurchaseHostReservation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/purchase-host-reservation.html) na *Referência de comandos da AWS CLI*. ### `purchase-reserved-instances-offering` O código de exemplo a seguir mostra como usar `purchase-reserved-instances-offering`. **AWS CLI** **Comprar uma oferta de instância reservada** Este exemplo de comando ilustra a compra de uma oferta de Instâncias Reservadas, especificando o ID da oferta e a contagem de instâncias. Comando: ``` aws ec2 purchase-reserved-instances-offering --reserved-instances-offering-id ec06327e-dd07-46ee-9398-75b5fexample --instance-count 3 ``` Resultado: ``` { "ReservedInstancesId": "af9f760e-6f91-4559-85f7-4980eexample" } ``` + Para ver detalhes da API, consulte [PurchaseReservedInstancesOffering](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/purchase-reserved-instances-offering.html) na *Referência de comandos da AWS CLI*. ### `purchase-scheduled-instances` O código de exemplo a seguir mostra como usar `purchase-scheduled-instances`. **AWS CLI** **Comprar uma instância programada** Este exemplo compra uma Instância Programada. Comando: ``` aws ec2 purchase-scheduled-instances --purchase-requests file://purchase-request.json ``` Purchase-request.json: ``` [ { "PurchaseToken": "eyJ2IjoiMSIsInMiOjEsImMiOi...", "InstanceCount": 1 } ] ``` Resultado: ``` { "ScheduledInstanceSet": [ { "AvailabilityZone": "us-west-2b", "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012", "HourlyPrice": "0.095", "CreateDate": "2016-01-25T21:43:38.612Z", "Recurrence": { "OccurrenceDaySet": [ 1 ], "Interval": 1, "Frequency": "Weekly", "OccurrenceRelativeToEnd": false, "OccurrenceUnit": "" }, "Platform": "Linux/UNIX", "TermEndDate": "2017-01-31T09:00:00Z", "InstanceCount": 1, "SlotDurationInHours": 32, "TermStartDate": "2016-01-31T09:00:00Z", "NetworkPlatform": "EC2-VPC", "TotalScheduledInstanceHours": 1696, "NextSlotStartTime": "2016-01-31T09:00:00Z", "InstanceType": "c4.large" } ] } ``` + Para ver detalhes da API, consulte [PurchaseScheduledInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/purchase-scheduled-instances.html) na *Referência de comandos da AWS CLI*. ### `reboot-instances` O código de exemplo a seguir mostra como usar `reboot-instances`. **AWS CLI** **Para reinicializar uma instância do Amazon EC** Este exemplo reinicia a instância especificada. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 reboot-instances --instance-ids i-1234567890abcdef5 ``` Para obter mais informações, consulte Reinicializar a instância no *Guia do usuário do Amazon Elastic Compute Cloud*. + Consulte detalhes da API em [RebootInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reboot-instances.html) na *Referência de comandos da AWS CLI*. ### `register-image` O código de exemplo a seguir mostra como usar `register-image`. **AWS CLI** **Exemplo 1: registrar uma AMI usando um arquivo de manifesto** O exemplo `register-image` a seguir registra uma AMI usando o arquivo de manifesto especificado no Amazon S3. ``` aws ec2 register-image \ --name my-image \ --image-location amzn-s3-demo-bucket/myimage/image.manifest.xml ``` Resultado: ``` { "ImageId": "ami-1234567890EXAMPLE" } ``` Para obter mais informações, consulte [Imagens de máquina da Amazon (AMIs)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html) no *Guia do usuário do Amazon EC2*. **Exemplo 2: registrar uma AMI usando um snapshot de um dispositivo raiz** O exemplo `register-image` a seguir registra uma AMI usando o snapshot especificado de um volume raiz do EBS como um dispositivo `/dev/xvda`. O mapeamento de dispositivos de blocos também inclui um volume EBS vazio de 100 GiB como dispositivo `/dev/xvdf`. ``` aws ec2 register-image \ --name my-image \ --root-device-name /dev/xvda \ --block-device-mappings DeviceName=/dev/xvda,Ebs={SnapshotId=snap-0db2cf683925d191f} DeviceName=/dev/xvdf,Ebs={VolumeSize=100} ``` Resultado: ``` { "ImageId": "ami-1a2b3c4d5eEXAMPLE" } ``` Para obter mais informações, consulte [Imagens de máquina da Amazon (AMIs)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [RegisterImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/register-image.html) na *Referência de comandos da AWS CLI*. ### `register-instance-event-notification-attributes` O código de exemplo a seguir mostra como usar `register-instance-event-notification-attributes`. **AWS CLI** **Exemplo 1: incluir todas as tags em notificações de eventos** O exemplo `register-instance-event-notification-attributes` a seguir inclui todas as tags em notificações de eventos. ``` aws ec2 register-instance-event-notification-attributes \ --instance-tag-attribute IncludeAllTagsOfInstance=true ``` Resultado: ``` { "InstanceTagAttribute": { "InstanceTagKeys": [], "IncludeAllTagsOfInstance": true } } ``` Para obter mais informações, consulte [Eventos programados para sua instância](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html) no *Guia do usuário do Amazon EC2 para instâncias do Linux*. **Exemplo 2: incluir tags específicas em notificações de eventos** O exemplo `register-instance-event-notification-attributes` a seguir inclui as tags especificadas nas notificações de eventos. Não é possível especificar tags se `IncludeAllTagsOfInstance` for `true`. ``` aws ec2 register-instance-event-notification-attributes \ --instance-tag-attribute InstanceTagKeys="tag-key1","tag-key2" ``` Resultado: ``` { "InstanceTagAttribute": { "InstanceTagKeys": [ "tag-key1", "tag-key2" ], "IncludeAllTagsOfInstance": false } } ``` Para obter mais informações, consulte [Eventos programados para sua instância](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html) no *Guia do usuário do Amazon EC2 para instâncias do Linux*. + Para ver detalhes da API, consulte [RegisterInstanceEventNotificationAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/register-instance-event-notification-attributes.html) na *Referência de comandos da AWS CLI*. ### `register-transit-gateway-multicase-group-sources` O código de exemplo a seguir mostra como usar `register-transit-gateway-multicase-group-sources`. **AWS CLI** **Registrar uma origem em um grupo de multicast do gateway de trânsito.** O exemplo `register-transit-gateway-multicast-group-sources` a seguir registra a origem do grupo de interface de rede especificado com um grupo multicast. ``` aws ec2 register-transit-gateway-multicast-group-sources \ --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef79d6e597 \ --group-ip-address 224.0.1.0 \ --network-interface-ids eni-07f290fc3c090cbae ``` Resultado: ``` { "RegisteredMulticastGroupSources": { "TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c4905cef79d6e597", "RegisteredNetworkInterfaceIds": [ "eni-07f290fc3c090cbae" ], "GroupIpAddress": "224.0.1.0" } } ``` Para obter mais informações, consulte [Registrar fontes com um grupo multicast](https://docs.aws.amazon.com/vpc/latest/tgw/working-with-multicast.html#add-source-multicast-group) no *Guia do usuário de Gateways de trânsito da AWS*. + Para ver detalhes da API, consulte [RegisterTransitGatewayMulticaseGroupSources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/register-transit-gateway-multicase-group-sources.html) na *Referência de comandos da AWS CLI*. ### `register-transit-gateway-multicast-group-members` O código de exemplo a seguir mostra como usar `register-transit-gateway-multicast-group-members`. **AWS CLI** **Visualizar informações sobre as associações de um domínio multicast de gateway de trânsito** O exemplo `register-transit-gateway-multicast-group-members` a seguir retorna as associações para o domínio multicast especificado. ``` aws ec2 register-transit-gateway-multicast-group-members \ --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef79d6e597 \ --group-ip-address 224.0.1.0 \ --network-interface-ids eni-0e246d32695012e81 ``` Resultado: ``` { "RegisteredMulticastGroupMembers": { "TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c4905cef79d6e597", "RegisteredNetworkInterfaceIds": [ "eni-0e246d32695012e81" ], "GroupIpAddress": "224.0.1.0" } } ``` Consulte mais informações em [Multicast domains](https://docs.aws.amazon.com/vpc/latest/tgw/multicast-domains-about.html) no *Guia do usuário do Transit Gateway*. + Para ver detalhes da API, consulte [RegisterTransitGatewayMulticastGroupMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/register-transit-gateway-multicast-group-members.html) na *Referência de comandos da AWS CLI*. ### `register-transit-gateway-multicast-group-sources` O código de exemplo a seguir mostra como usar `register-transit-gateway-multicast-group-sources`. **AWS CLI** **Registrar uma origem em um grupo de multicast do gateway de trânsito.** O exemplo `register-transit-gateway-multicast-group-sources` a seguir registra a origem do grupo de interface de rede especificado com um grupo multicast. ``` aws ec2 register-transit-gateway-multicast-group-sources \ --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef79d6e597 \ --group-ip-address 224.0.1.0 \ --network-interface-ids eni-07f290fc3c090cbae ``` Resultado: ``` { "RegisteredMulticastGroupSources": { "TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c4905cef79d6e597", "RegisteredNetworkInterfaceIds": [ "eni-07f290fc3c090cbae" ], "GroupIpAddress": "224.0.1.0" } } ``` Consulte mais informações em [Multicast domains](https://docs.aws.amazon.com/vpc/latest/tgw/multicast-domains-about.html) no *Guia do Transit Gateway*. + Para ver detalhes da API, consulte [RegisterTransitGatewayMulticastGroupSources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/register-transit-gateway-multicast-group-sources.html) na *Referência de comandos da AWS CLI*. ### `reject-transit-gateway-peering-attachment` O código de exemplo a seguir mostra como usar `reject-transit-gateway-peering-attachment`. **AWS CLI** **Rejeitar um anexo de emparelhamento do gateway de trânsito** O exemplo `reject-transit-gateway-peering-attachment` a seguir rejeita a solicitação de anexo de emparelhamento do gateway de trânsito especificada. O parâmetro `--region` especifica a região na qual o gateway de trânsito do aceitante está localizado. ``` aws ec2 reject-transit-gateway-peering-attachment \ --transit-gateway-attachment-id tgw-attach-4455667788aabbccd \ --region us-east-2 ``` Resultado: ``` { "TransitGatewayPeeringAttachment": { "TransitGatewayAttachmentId": "tgw-attach-4455667788aabbccd", "RequesterTgwInfo": { "TransitGatewayId": "tgw-123abc05e04123abc", "OwnerId": "123456789012", "Region": "us-west-2" }, "AccepterTgwInfo": { "TransitGatewayId": "tgw-11223344aabbcc112", "OwnerId": "123456789012", "Region": "us-east-2" }, "State": "rejecting", "CreationTime": "2019-12-09T11:50:31.000Z" } } ``` Para obter mais informações, consulte [Anexos de pareamento do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-peering.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [RejectTransitGatewayPeeringAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reject-transit-gateway-peering-attachment.html) na *Referência de comandos da AWS CLI*. ### `reject-transit-gateway-vpc-attachment` O código de exemplo a seguir mostra como usar `reject-transit-gateway-vpc-attachment`. **AWS CLI** **Rejeitar um anexo de emparelhamento do gateway da VPC** O exemplo `reject-transit-gateway-vpc-attachment` a seguir rejeita o anexo da VPC do gateway de trânsito especificado. ``` aws ec2 reject-transit-gateway-vpc-attachment \ --transit-gateway-attachment-id tgw-attach-0a34fe6b4fEXAMPLE ``` Resultado: ``` { "TransitGatewayVpcAttachment": { "TransitGatewayAttachmentId": "tgw-attach-0a34fe6b4fEXAMPLE", "TransitGatewayId": "tgw-0262a0e521EXAMPLE", "VpcId": "vpc-07e8ffd50fEXAMPLE", "VpcOwnerId": "111122223333", "State": "pending", "SubnetIds": [ "subnet-0752213d59EXAMPLE" ], "CreationTime": "2019-07-10T17:33:46.000Z", "Options": { "DnsSupport": "enable", "Ipv6Support": "disable" } } } ``` Para obter mais informações, consulte [Anexos do gateway de trânsito para uma VPC](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-vpc-attachments.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [RejectTransitGatewayVpcAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reject-transit-gateway-vpc-attachment.html) na *Referência de comandos da AWS CLI*. ### `reject-transit-gateway-vpc-attachments` O código de exemplo a seguir mostra como usar `reject-transit-gateway-vpc-attachments`. **AWS CLI** **Rejeitar um anexo de emparelhamento do gateway da VPC** O exemplo `reject-transit-gateway-vpc-attachment` a seguir rejeita o anexo da VPC do gateway de trânsito especificado. ``` aws ec2 reject-transit-gateway-vpc-attachment \ --transit-gateway-attachment-id tgw-attach-0a34fe6b4fEXAMPLE ``` Resultado: ``` { "TransitGatewayVpcAttachment": { "TransitGatewayAttachmentId": "tgw-attach-0a34fe6b4fEXAMPLE", "TransitGatewayId": "tgw-0262a0e521EXAMPLE", "VpcId": "vpc-07e8ffd50fEXAMPLE", "VpcOwnerId": "111122223333", "State": "pending", "SubnetIds": [ "subnet-0752213d59EXAMPLE" ], "CreationTime": "2019-07-10T17:33:46.000Z", "Options": { "DnsSupport": "enable", "Ipv6Support": "disable" } } } ``` Para obter mais informações, consulte [Anexos do gateway de trânsito para uma VPC](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-vpc-attachments.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [RejectTransitGatewayVpcAttachments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reject-transit-gateway-vpc-attachments.html) na *Referência de comandos da AWS CLI*. ### `reject-vpc-endpoint-connections` O código de exemplo a seguir mostra como usar `reject-vpc-endpoint-connections`. **AWS CLI** **Rejeitar uma solicitação de conexão de endpoint** Este exemplo rejeita a solicitação de conexão de endpoint especificada para o serviço de endpoint especificado. Comando: ``` aws ec2 reject-vpc-endpoint-connections --service-id vpce-svc-03d5ebb7d9579a2b3 --vpc-endpoint-ids vpce-0c1308d7312217abc ``` Resultado: ``` { "Unsuccessful": [] } ``` + Para ver detalhes da API, consulte [RejectVpcEndpointConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reject-vpc-endpoint-connections.html) na *Referência de comandos da AWS CLI*. ### `reject-vpc-peering-connection` O código de exemplo a seguir mostra como usar `reject-vpc-peering-connection`. **AWS CLI** **Rejeitar uma conexão de emparelhamento da VPC** Este exemplo rejeita a solicitação de conexão de emparelhamento da VPC especificada. Comando: ``` aws ec2 reject-vpc-peering-connection --vpc-peering-connection-id pcx-1a2b3c4d ``` Resultado: ``` { "Return": true } ``` + Para ver detalhes da API, consulte [RejectVpcPeeringConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reject-vpc-peering-connection.html) na *Referência de comandos da AWS CLI*. ### `release-address` O código de exemplo a seguir mostra como usar `release-address`. **AWS CLI** **Para liberar um endereço IP elástico do EC2-Classic** Este exemplo libera um endereço IP elástico para usar com instâncias no EC2-Classic. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 release-address --public-ip 198.51.100.0 ``` **Para liberar um endereço IP elástico para o EC2-VPC** Este exemplo libera um endereço IP elástico para usar com instâncias em uma VPC. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 release-address --allocation-id eipalloc-64d5890a ``` + Consulte detalhes da API em [ReleaseAddress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/release-address.html) na *Referência de comandos da AWS CLI*. ### `release-hosts` O código de exemplo a seguir mostra como usar `release-hosts`. **AWS CLI** **Liberar um host dedicado da sua conta** Liberar um host dedicado da sua conta. As instâncias que estão no host devem ser interrompidas ou encerradas antes que o host possa ser liberado. Comando: ``` aws ec2 release-hosts --host-id=h-0029d6e3cacf1b3da ``` Resultado: ``` { "Successful": [ "h-0029d6e3cacf1b3da" ], "Unsuccessful": [] } ``` + Para ver detalhes da API, consulte [ReleaseHosts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/release-hosts.html) na *Referência de comandos da AWS CLI*. ### `release-ipam-pool-allocation` O código de exemplo a seguir mostra como usar `release-ipam-pool-allocation`. **AWS CLI** **Liberar uma alocação de pool IPAM** Neste exemplo, você é um administrador delegado do IPAM que tentou excluir um pool do IPAM, mas recebeu um erro informando que você não pode excluir o pool enquanto o pool tem alocações. Você está usando esse comando para liberar uma alocação de pool. Observe o seguinte: Você só pode usar esse comando para alocações personalizadas. Para remover uma alocação para um recurso sem excluir o recurso, defina seu estado monitorado como falso usando [modify-ipam-resource-cidr](https://docs.aws.amazon.com/cli/latest/reference/ec2/modify-ipam-resource-cidr.html). Para concluir essa solicitação, você precisará do ID do pool IPAM, que pode ser obtido com [describe-ipam-pools](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-ipam-pools.html). Você também precisará do ID de alocação, que pode ser obtido com [get-ipam-pool-allocations](https://docs.aws.amazon.com/cli/latest/reference/ec2/get-ipam-pool-allocations.html). Se não quiser remover as alocações uma por uma, você pode usar `--cascade option` ao excluir um pool IPAM para liberar automaticamente todas as alocações no pool antes de excluí-las. Há vários pré-requisitos antes de executar esse comando. Para obter mais informações, consulte [Liberar uma alocação](https://docs.aws.amazon.com/vpc/latest/ipam/release-alloc-ipam.html) no *Guia do usuário IPAM da Amazon VPC*. O `--region` em que você executa esse comando deve ser o local do pool IPAM onde está a alocação. O exemplo `release-ipam-pool-allocation` a seguir libera uma alocação de pool IPAM. ``` aws ec2 release-ipam-pool-allocation \ --ipam-pool-id ipam-pool-07bdd12d7c94e4693 \ --cidr 10.0.0.0/23 \ --ipam-pool-allocation-id ipam-pool-alloc-0e66a1f730da54791b99465b79e7d1e89 \ --region us-west-1 ``` Resultado: ``` { "Success": true } ``` Depois de liberar uma alocação, talvez pode querer executar [delete-ipam-pool](https://docs.aws.amazon.com/cli/latest/reference/ec2/delete-ipam-pool.html). + Para ver detalhes da API, consulte [ReleaseIpamPoolAllocation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/release-ipam-pool-allocation.html) na *Referência de comandos da AWS CLI*. ### `replace-iam-instance-profile-association` O código de exemplo a seguir mostra como usar `replace-iam-instance-profile-association`. **AWS CLI** **Para substituir um perfil de instância do IAM de uma instância** Este exemplo substitui o perfil de instância do IAM representado pela associação `iip-assoc-060bae234aac2e7fa` pelo perfil de instância do IAM chamado `AdminRole`. ``` aws ec2 replace-iam-instance-profile-association \ --iam-instance-profile Name=AdminRole \ --association-id iip-assoc-060bae234aac2e7fa ``` Resultado: ``` { "IamInstanceProfileAssociation": { "InstanceId": "i-087711ddaf98f9489", "State": "associating", "AssociationId": "iip-assoc-0b215292fab192820", "IamInstanceProfile": { "Id": "AIPAJLNLDX3AMYZNWYYAY", "Arn": "arn:aws:iam::123456789012:instance-profile/AdminRole" } } } ``` + Consulte detalhes da API em [ReplaceIamInstanceProfileAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/replace-iam-instance-profile-association.html) na *Referência de comandos da AWS CLI*. ### `replace-network-acl-association` O código de exemplo a seguir mostra como usar `replace-network-acl-association`. **AWS CLI** **Substituir a ACL de rede associada a uma sub-rede** Este exemplo associa a ACL de rede especificada à sub-rede da associação de ACL de rede especificada. Comando: ``` aws ec2 replace-network-acl-association --association-id aclassoc-e5b95c8c --network-acl-id acl-5fb85d36 ``` Resultado: ``` { "NewAssociationId": "aclassoc-3999875b" } ``` + Para ver detalhes da API, consulte [ReplaceNetworkAclAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/replace-network-acl-association.html) na *Referência de comandos da AWS CLI*. ### `replace-network-acl-entry` O código de exemplo a seguir mostra como usar `replace-network-acl-entry`. **AWS CLI** **Substituir uma entrada de ACL de rede** Este exemplo substitui uma entrada para a rede ACL especificada. A nova regra 100 permite o tráfego de entrada de 203.0.113.12/24 na porta UDP 53 (DNS) em qualquer sub-rede associada. Comando: ``` aws ec2 replace-network-acl-entry --network-acl-id acl-5fb85d36 --ingress --rule-number 100 --protocol udp --port-range From=53,To=53 --cidr-block 203.0.113.12/24 --rule-action allow ``` + Para ver detalhes da API, consulte [ReplaceNetworkAclEntry](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/replace-network-acl-entry.html) na *Referência de comandos da AWS CLI*. ### `replace-route-table-association` O código de exemplo a seguir mostra como usar `replace-route-table-association`. **AWS CLI** **Substituir uma tabela de rotas associada a uma sub-rede** Este exemplo associa a tabela de rotas especificada à sub-rede para a associação da tabela de rotas especificada. Comando: ``` aws ec2 replace-route-table-association --association-id rtbassoc-781d0d1a --route-table-id rtb-22574640 ``` Resultado: ``` { "NewAssociationId": "rtbassoc-3a1f0f58" } ``` + Para ver detalhes da API, consulte [ReplaceRouteTableAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/replace-route-table-association.html) na *Referência de comandos da AWS CLI*. ### `replace-route` O código de exemplo a seguir mostra como usar `replace-route`. **AWS CLI** **Substituir uma rota** Este exemplo substitui a rota especificada na tabela de rotas especificada. A nova rota corresponde ao CIDR especificado e envia o tráfego para o gateway privado virtual especificado. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 replace-route --route-table-id rtb-22574640 --destination-cidr-block 10.0.0.0/16 --gateway-id vgw-9a4cacf3 ``` + Para ver detalhes da API, consulte [ReplaceRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/replace-route.html) na *Referência de comandos da AWS CLI*. ### `replace-transit-gateway-route` O código de exemplo a seguir mostra como usar `replace-transit-gateway-route`. **AWS CLI** **Substituir a rota especificada na tabela de rotas do gateway de trânsito especificada** O exemplo `replace-transit-gateway-route` a seguir substitui a rota na tabela de rotas de gateway de trânsito especificada. ``` aws ec2 replace-transit-gateway-route \ --destination-cidr-block 10.0.2.0/24 \ --transit-gateway-attachment-id tgw-attach-09b52ccdb5EXAMPLE \ --transit-gateway-route-table-id tgw-rtb-0a823edbdeEXAMPLE ``` Resultado: ``` { "Route": { "DestinationCidrBlock": "10.0.2.0/24", "TransitGatewayAttachments": [ { "ResourceId": "vpc-4EXAMPLE", "TransitGatewayAttachmentId": "tgw-attach-09b52ccdb5EXAMPLE", "ResourceType": "vpc" } ], "Type": "static", "State": "active" } } ``` Para obter mais informações, consulte [Tabelas de rota do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [ReplaceTransitGatewayRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/replace-transit-gateway-route.html) na *Referência de comandos da AWS CLI*. ### `report-instance-status` O código de exemplo a seguir mostra como usar `report-instance-status`. **AWS CLI** **Reportar feedback de status de uma instância** Este exemplo de comando reporta um feedback de status para a instância especificada. Comando: ``` aws ec2 report-instance-status --instances i-1234567890abcdef0 --status impaired --reason-codes unresponsive ``` + Para ver detalhes da API, consulte [ReportInstanceStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/report-instance-status.html) na *Referência de comandos da AWS CLI*. ### `request-spot-fleet` O código de exemplo a seguir mostra como usar `request-spot-fleet`. **AWS CLI** **Solicitar uma frota Spot na sub-rede com o menor preço** Esse exemplo de comando cria uma solicitação de frota Spot com duas especificações de lançamento que diferem somente por sub-rede. A frota Spot lança as instâncias na sub-rede especificada de menor preço. Se as instâncias forem executadas em uma VPC padrão, elas receberão um endereço IP público por padrão. Se as instâncias forem executadas em uma VPC não padrão, elas não receberão um endereço IP público por padrão. Observe que você não pode especificar sub-redes diferentes da mesma zona de disponibilidade em uma solicitação de frota spot. Comando: ``` aws ec2 request-spot-fleet --spot-fleet-request-config file://config.json ``` Config.json: ``` { "SpotPrice": "0.04", "TargetCapacity": 2, "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", "LaunchSpecifications": [ { "ImageId": "ami-1a2b3c4d", "KeyName": "my-key-pair", "SecurityGroups": [ { "GroupId": "sg-1a2b3c4d" } ], "InstanceType": "m3.medium", "SubnetId": "subnet-1a2b3c4d, subnet-3c4d5e6f", "IamInstanceProfile": { "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" } } ] } ``` Resultado: ``` { "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" } ``` **Solicitar uma frota Spot na zona de disponibilidade com o menor preço** Esse exemplo de comando cria uma solicitação de frota Spot com duas especificações de lançamento que diferem somente por Zona de Disponibilidade. A frota Spot lança as instâncias na Zona de Disponibilidade especificada de menor preço. Se sua conta oferece suporte somente ao EC2-VPC, o Amazon EC2 executará as instâncias Spot na sub-rede padrão da Zona de Disponibilidade. Se sua conta oferece suporte ao EC2-Classic, o Amazon EC2 executará as instâncias no EC2-Classic na Zona de Disponibilidade. Comando: ``` aws ec2 request-spot-fleet --spot-fleet-request-config file://config.json ``` Config.json: ``` { "SpotPrice": "0.04", "TargetCapacity": 2, "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", "LaunchSpecifications": [ { "ImageId": "ami-1a2b3c4d", "KeyName": "my-key-pair", "SecurityGroups": [ { "GroupId": "sg-1a2b3c4d" } ], "InstanceType": "m3.medium", "Placement": { "AvailabilityZone": "us-west-2a, us-west-2b" }, "IamInstanceProfile": { "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" } } ] } ``` **Lançar instâncias spot em uma sub-rede e atribuir a elas endereços IP públicos** Este comando de exemplo atribui endereços IP públicos a instâncias lançadas em uma VPC não padrão. Observe que, ao especificar uma interface de rede, você deve incluir o ID da sub-rede e o ID do grupo de segurança usando a interface de rede. Comando: ``` aws ec2 request-spot-fleet --spot-fleet-request-config file://config.json ``` Config.json: ``` { "SpotPrice": "0.04", "TargetCapacity": 2, "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", "LaunchSpecifications": [ { "ImageId": "ami-1a2b3c4d", "KeyName": "my-key-pair", "InstanceType": "m3.medium", "NetworkInterfaces": [ { "DeviceIndex": 0, "SubnetId": "subnet-1a2b3c4d", "Groups": [ "sg-1a2b3c4d" ], "AssociatePublicIpAddress": true } ], "IamInstanceProfile": { "Arn": "arn:aws:iam::880185128111:instance-profile/my-iam-role" } } ] } ``` **Solicitar uma frota Spot usando a estratégia de alocação diversificada** Esse exemplo de comando cria uma solicitação de frota Spot que executa 30 instâncias usando a estratégia de alocação diversificada. As especificações de lançamento variam de acordo com o tipo de instância. A frota spot distribui as instâncias pelas especificações de execução, de modo que haja 10 instâncias de cada tipo. Comando: ``` aws ec2 request-spot-fleet --spot-fleet-request-config file://config.json ``` Config.json: ``` { "SpotPrice": "0.70", "TargetCapacity": 30, "AllocationStrategy": "diversified", "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", "LaunchSpecifications": [ { "ImageId": "ami-1a2b3c4d", "InstanceType": "c4.2xlarge", "SubnetId": "subnet-1a2b3c4d" }, { "ImageId": "ami-1a2b3c4d", "InstanceType": "m3.2xlarge", "SubnetId": "subnet-1a2b3c4d" }, { "ImageId": "ami-1a2b3c4d", "InstanceType": "r3.2xlarge", "SubnetId": "subnet-1a2b3c4d" } ] } ``` Para obter mais informações, consulte Solicitações de frota Spot no *Guia do usuário do Amazon Elastic Compute Cloud*. + Para ver detalhes da API, consulte [RequestSpotFleet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/request-spot-fleet.html) na *Referência de comandos da AWS CLI*. ### `request-spot-instances` O código de exemplo a seguir mostra como usar `request-spot-instances`. **AWS CLI** **Solicitar Instâncias spot** Este exemplo de comando cria uma solicitação única de Instância Spot para cinco instâncias na Zona de Disponibilidade especificada. Se sua conta oferece suporte somente ao EC2-VPC, o Amazon EC2 executará as instâncias na sub-rede especificada da Zona de Disponibilidade. Se sua conta oferece suporte ao EC2-Classic, o Amazon EC2 executará as instâncias no EC2-Classic na Zona de Disponibilidade especificada. Comando: ``` aws ec2 request-spot-instances --spot-price "0.03" --instance-count 5 --type "one-time" --launch-specification file://specification.json ``` Specification.json: ``` { "ImageId": "ami-1a2b3c4d", "KeyName": "my-key-pair", "SecurityGroupIds": [ "sg-1a2b3c4d" ], "InstanceType": "m3.medium", "Placement": { "AvailabilityZone": "us-west-2a" }, "IamInstanceProfile": { "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" } } ``` Resultado: ``` { "SpotInstanceRequests": [ { "Status": { "UpdateTime": "2014-03-25T20:54:21.000Z", "Code": "pending-evaluation", "Message": "Your Spot request has been submitted for review, and is pending evaluation." }, "ProductDescription": "Linux/UNIX", "SpotInstanceRequestId": "sir-df6f405d", "State": "open", "LaunchSpecification": { "Placement": { "AvailabilityZone": "us-west-2a" }, "ImageId": "ami-1a2b3c4d", "KeyName": "my-key-pair", "SecurityGroups": [ { "GroupName": "my-security-group", "GroupId": "sg-1a2b3c4d" } ], "Monitoring": { "Enabled": false }, "IamInstanceProfile": { "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" }, "InstanceType": "m3.medium" }, "Type": "one-time", "CreateTime": "2014-03-25T20:54:20.000Z", "SpotPrice": "0.050000" }, ... ] } ``` Este exemplo de comando cria uma solicitação única de Instância Spot para cinco instâncias na sub-rede especificada. O Amazon EC2 executa as instâncias na sub-rede especificada. Se a VPC não for padrão, as instâncias não receberão um endereço IP público por padrão. Comando: ``` aws ec2 request-spot-instances --spot-price "0.050" --instance-count 5 --type "one-time" --launch-specification file://specification.json ``` Specification.json: ``` { "ImageId": "ami-1a2b3c4d", "SecurityGroupIds": [ "sg-1a2b3c4d" ], "InstanceType": "m3.medium", "SubnetId": "subnet-1a2b3c4d", "IamInstanceProfile": { "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" } } ``` Resultado: ``` { "SpotInstanceRequests": [ { "Status": { "UpdateTime": "2014-03-25T22:21:58.000Z", "Code": "pending-evaluation", "Message": "Your Spot request has been submitted for review, and is pending evaluation." }, "ProductDescription": "Linux/UNIX", "SpotInstanceRequestId": "sir-df6f405d", "State": "open", "LaunchSpecification": { "Placement": { "AvailabilityZone": "us-west-2a" } "ImageId": "ami-1a2b3c4d" "SecurityGroups": [ { "GroupName": "my-security-group", "GroupID": "sg-1a2b3c4d" } ] "SubnetId": "subnet-1a2b3c4d", "Monitoring": { "Enabled": false }, "IamInstanceProfile": { "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" }, "InstanceType": "m3.medium", }, "Type": "one-time", "CreateTime": "2014-03-25T22:21:58.000Z", "SpotPrice": "0.050000" }, ... ] } ``` Este exemplo atribui um endereço IP público às Instâncias Spot que você lança em uma VPC não padrão. Observe que, ao especificar uma interface de rede, você deve incluir o ID da sub-rede e o ID do grupo de segurança usando a interface de rede. Comando: ``` aws ec2 request-spot-instances --spot-price "0.050" --instance-count 1 --type "one-time" --launch-specification file://specification.json ``` Specification.json: ``` { "ImageId": "ami-1a2b3c4d", "KeyName": "my-key-pair", "InstanceType": "m3.medium", "NetworkInterfaces": [ { "DeviceIndex": 0, "SubnetId": "subnet-1a2b3c4d", "Groups": [ "sg-1a2b3c4d" ], "AssociatePublicIpAddress": true } ], "IamInstanceProfile": { "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" } } ``` + Para ver detalhes da API, consulte [RequestSpotInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/request-spot-instances.html) na *Referência de comandos da AWS CLI*. ### `reset-address-attribute` O código de exemplo a seguir mostra como usar `reset-address-attribute`. **AWS CLI** **Redefinir o atributo do nome de domínio associado a um endereço IP elástico** Os exemplos `reset-address-attribute` a seguir redefinem o atributo de nome de domínio de um endereço IP elástico. Linux: ``` aws ec2 reset-address-attribute \ --allocation-id eipalloc-abcdef01234567890 \ --attribute domain-name ``` Windows: ``` aws ec2 reset-address-attribute ^ --allocation-id eipalloc-abcdef01234567890 ^ --attribute domain-name ``` Resultado: ``` { "Addresses": [ { "PublicIp": "192.0.2.0", "AllocationId": "eipalloc-abcdef01234567890", "PtrRecord": "example.com." "PtrRecordUpdate": { "Value": "example.net.", "Status": "PENDING" } ] } ``` Para monitorar a alteração pendente, consulte [describe-addresses-attribute](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-addresses-attribute.html) na *Referência de Comandos da CLI da AWS*. + Para ver detalhes da API, consulte [ResetAddressAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reset-address-attribute.html) na *Referência de comandos da AWS CLI*. ### `reset-ebs-default-kms-key-id` O código de exemplo a seguir mostra como usar `reset-ebs-default-kms-key-id`. **AWS CLI** **Redefinir sua CMK padrão para criptografia EBS** O exemplo `reset-ebs-default-kms-key-id` a seguir redefine a CMK padrão para criptografia do EBS para sua conta AWS na Região atual. ``` aws ec2 reset-ebs-default-kms-key-id ``` Resultado: ``` { "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/8c5b2c63-b9bc-45a3-a87a-5513eEXAMPLE" } ``` + Para ver detalhes da API, consulte [ResetEbsDefaultKmsKeyId](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reset-ebs-default-kms-key-id.html) na *Referência de comandos da AWS CLI*. ### `reset-fpga-image-attribute` O código de exemplo a seguir mostra como usar `reset-fpga-image-attribute`. **AWS CLI** **Redefinir os atributos de uma imagem do Amazon FPGA** Este exemplo redefine as permissões de carga para a AFI especificada. Comando: ``` aws ec2 reset-fpga-image-attribute --fpga-image-id afi-0d123e123bfc85abc --attribute loadPermission ``` Resultado: ``` { "Return": true } ``` + Para ver detalhes da API, consulte [ResetFpgaImageAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reset-fpga-image-attribute.html) na *Referência de comandos da AWS CLI*. ### `reset-image-attribute` O código de exemplo a seguir mostra como usar `reset-image-attribute`. **AWS CLI** **Redefinir o atributo launchPermission** Este exemplo redefine o atributo `launchPermission` da AMI especificada para seu valor padrão. Por padrão, as AMIs são privadas. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 reset-image-attribute --image-id ami-5731123e --attribute launchPermission ``` + Para ver detalhes da API, consulte [ResetImageAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reset-image-attribute.html) na *Referência de comandos da AWS CLI*. ### `reset-instance-attribute` O código de exemplo a seguir mostra como usar `reset-instance-attribute`. **AWS CLI** **Redefinir o atributo sourceDestCheck** Este exemplo redefine o atributo `sourceDestCheck` da instância especificada. A instância deve estar em uma VPC. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 reset-instance-attribute --instance-id i-1234567890abcdef0 --attribute sourceDestCheck ``` **Redefinir o atributo kernel** Este exemplo redefine o atributo `kernel` da instância especificada. A instância deve estar no estado `stopped`. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 reset-instance-attribute --instance-id i-1234567890abcdef0 --attribute kernel ``` **Redefinir o atributo ramdisk** Este exemplo redefine o atributo `ramdisk` da instância especificada. A instância deve estar no estado `stopped`. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 reset-instance-attribute --instance-id i-1234567890abcdef0 --attribute ramdisk ``` + Para ver detalhes da API, consulte [ResetInstanceAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reset-instance-attribute.html) na *Referência de comandos da AWS CLI*. ### `reset-network-interface-attribute` O código de exemplo a seguir mostra como usar `reset-network-interface-attribute`. **AWS CLI** **Redefinir um atributo da interface de rede** O exemplo `reset-network-interface-attribute` a seguir redefine o valor do atributo de verificação de origem/destino para `true`. ``` aws ec2 reset-network-interface-attribute \ --network-interface-id eni-686ea200 \ --source-dest-check ``` Este comando não produz saída. + Para ver detalhes da API, consulte [ResetNetworkInterfaceAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reset-network-interface-attribute.html) na *Referência de comandos da AWS CLI*. ### `reset-snapshot-attribute` O código de exemplo a seguir mostra como usar `reset-snapshot-attribute`. **AWS CLI** **Redefinir um atributo de snapshot** Este exemplo redefine as permissões de criação de volume para o snapshot `snap-1234567890abcdef0`. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 reset-snapshot-attribute --snapshot-id snap-1234567890abcdef0 --attribute createVolumePermission ``` + Para ver detalhes da API, consulte [ResetSnapshotAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reset-snapshot-attribute.html) na *Referência de comandos da AWS CLI*. ### `restore-address-to-classic` O código de exemplo a seguir mostra como usar `restore-address-to-classic`. **AWS CLI** **Restaurar um endereço para EC2-Classic** Este exemplo restaura o endereço IP elástico 198.51.100.0 na plataforma EC2-Classic. Comando: ``` aws ec2 restore-address-to-classic --public-ip 198.51.100.0 ``` Resultado: ``` { "Status": "MoveInProgress", "PublicIp": "198.51.100.0" } ``` + Para ver detalhes da API, consulte [RestoreAddressToClassic](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/restore-address-to-classic.html) na *Referência de comandos da AWS CLI*. ### `restore-image-from-recycle-bin` O código de exemplo a seguir mostra como usar `restore-image-from-recycle-bin`. **AWS CLI** **Restaurar uma imagem da Lixeira** O exemplo `restore-image-from-recycle-bin` a seguir restaura a AMI ami-0111222333444abcd da Lixeira. ``` aws ec2 restore-image-from-recycle-bin \ --image-id ami-0111222333444abcd ``` Resultado: ``` { "Return": true } ``` Consulte mais informações em [Recover deleted AMIs from the Recycle Bin](https://docs.aws.amazon.com/ebs/latest/userguide/recycle-bin-working-with-amis.html) no *Manual do usuário do Amazon EBS*. + Para ver detalhes da API, consulte [RestoreImageFromRecycleBin](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/restore-image-from-recycle-bin.html) na *Referência de comandos da AWS CLI*. ### `restore-managed-prefix-list-version` O código de exemplo a seguir mostra como usar `restore-managed-prefix-list-version`. **AWS CLI** us-west-2\$1\$1Restaurar uma versão da lista de prefixos\$1\$1 O `restore-managed-prefix-list-version` a seguir restaura as entradas da versão 1 da lista de prefixos especificada. ``` aws ec2 restore-managed-prefix-list-version \ --prefix-list-id pl-0123456abcabcabc1 \ --current-version 2 \ --previous-version 1 ``` Resultado: ``` { "PrefixList": { "PrefixListId": "pl-0123456abcabcabc1", "AddressFamily": "IPv4", "State": "restore-in-progress", "PrefixListArn": "arn:aws:ec2:us-west-2:123456789012:prefix-list/pl-0123456abcabcabc1", "PrefixListName": "vpc-cidrs", "MaxEntries": 10, "Version": 2, "OwnerId": "123456789012" } } ``` Para obter mais informações, consulte [Listas de prefixos gerenciados](https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html) no *Guia do usuário da Amazon VPC*. + Para ver detalhes da API, consulte [RestoreManagedPrefixListVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/restore-managed-prefix-list-version.html) na *Referência de comandos da AWS CLI*. ### `restore-snapshot-from-recycle-bin` O código de exemplo a seguir mostra como usar `restore-snapshot-from-recycle-bin`. **AWS CLI** **Restaurar os snapshots da lixeira** O exemplo `restore-snapshot-from-recycle-bin` a seguir restaura o snapshot da Lixeira. Quando você restaura um snapshot da lixeira, ele fica imediatamente disponível para uso e é removido da lixeira. É possível usar um snapshot restaurado como usa qualquer outro snapshot em sua conta. ``` aws ec2 restore-snapshot-from-recycle-bin \ --snapshot-id snap-01234567890abcdef ``` Este comando não produz saída. Consulte mais informações sobre a Lixeira em [Recover deleted snapshots from the Recycle Bin](https://docs.aws.amazon.com/ebs/latest/userguide/recycle-bin-working-with-snaps.html) no *Manual do usuário do Amazon EBS*. + Para ver detalhes da API, consulte [RestoreSnapshotFromRecycleBin](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/restore-snapshot-from-recycle-bin.html) na *Referência de comandos da AWS CLI*. ### `restore-snapshot-tier` O código de exemplo a seguir mostra como usar `restore-snapshot-tier`. **AWS CLI** **Exemplo 1: restaurar permanentemente um snapshot arquivado** O exemplo `restore-snapshot-tier` a seguir restaura permanentemente o snapshot especificado. Especifique `--snapshot-id` e inclua a opção `permanent-restore`. ``` aws ec2 restore-snapshot-tier \ --snapshot-id snap-01234567890abcedf \ --permanent-restore ``` Resultado: ``` { "SnapshotId": "snap-01234567890abcedf", "IsPermanentRestore": true } ``` Consulte mais informações sobre o arquivamento de snapshots em [Archive Amazon EBS snapshots](https://docs.aws.amazon.com/ebs/latest/userguide/snapshot-archive.html) no *Guia do usuário do Amazon EBS*. **Exemplo 2: restaurar temporariamente um snapshot arquivado** O exemplo `restore-snapshot-tier` a seguir restaura temporariamente o snapshot especificado. Omita a opção `--permanent-restore`. Especifique `--snapshot-id` e, para `temporary-restore-days`, especifique o número de dias pelos quais restaurar o snapshot. `temporary-restore-days` deve ser especificado em dias. O intervalo permitido é de `1` a `180`. Se você não especificar um valor, o padrão de `1` dia será adotado. ``` aws ec2 restore-snapshot-tier \ --snapshot-id snap-01234567890abcedf \ --temporary-restore-days 5 ``` Resultado: ``` { "SnapshotId": "snap-01234567890abcedf", "RestoreDuration": 5, "IsPermanentRestore": false } ``` Consulte mais informações sobre o arquivamento de snapshots em [Archive Amazon EBS snapshots](https://docs.aws.amazon.com/ebs/latest/userguide/snapshot-archive.html) no *Guia do usuário do Amazon EBS*. **Exemplo 3: modificar o período de restauração** O exemplo `restore-snapshot-tier` a seguir altera o período de restauração do snapshot especificado para `10` dias. ``` aws ec2 restore-snapshot-tier \ --snapshot-id snap-01234567890abcedf --temporary-restore-days 10 ``` Resultado: ``` { "SnapshotId": "snap-01234567890abcedf", "RestoreDuration": 10, "IsPermanentRestore": false } ``` Consulte mais informações sobre o arquivamento de snapshots em [Archive Amazon EBS snapshots](https://docs.aws.amazon.com/ebs/latest/userguide/snapshot-archive.html) no *Guia do usuário do Amazon EBS*. **Exemplo 4: modificar o tipo de restauração** O exemplo `restore-snapshot-tier` a seguir altera o tipo de restauração para o snapshot especificado de temporária para permanente. ``` aws ec2 restore-snapshot-tier \ --snapshot-id snap-01234567890abcedf --permanent-restore ``` Resultado: ``` { "SnapshotId": "snap-01234567890abcedf", "IsPermanentRestore": true } ``` Consulte mais informações sobre o arquivamento de snapshots em [Archive Amazon EBS snapshots](https://docs.aws.amazon.com/ebs/latest/userguide/snapshot-archive.html) no *Guia do usuário do Amazon EBS*. + Para ver detalhes da API, consulte [RestoreSnapshotTier](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/restore-snapshot-tier.html) na *Referência de comandos da AWS CLI*. ### `revoke-client-vpn-ingress` O código de exemplo a seguir mostra como usar `revoke-client-vpn-ingress`. **AWS CLI** **Revogar uma regra de autorização de um endpoint do Client VPN** O exemplo `revoke-client-vpn-ingress` a seguir revoga uma regra de acesso à Internet (`0.0.0.0/0`) para todos os grupos. ``` aws ec2 revoke-client-vpn-ingress \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ --target-network-cidr 0.0.0.0/0 --revoke-all-groups ``` Resultado: ``` { "Status": { "Code": "revoking" } } ``` Para obter mais informações, consulte [Regras de autorização](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-rules.html) no *Guia do administrador do Cliente VPN da AWS*. + Para ver detalhes da API, consulte [RevokeClientVpnIngress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/revoke-client-vpn-ingress.html) na *Referência de comandos da AWS CLI*. ### `revoke-security-group-egress` O código de exemplo a seguir mostra como usar `revoke-security-group-egress`. **AWS CLI** **Exemplo 1: remover a regra que permite tráfego de saída para um intervalo de endereços específico** O comando de exemplo `revoke-security-group-egress` a seguir remove a regra que concede acesso aos intervalos de endereços especificados na porta TCP 80. ``` aws ec2 revoke-security-group-egress \ --group-id sg-026c12253ce15eff7 \ --ip-permissions [{IpProtocol=tcp,FromPort=80,ToPort=80,IpRanges=[{CidrIp=10.0.0.0/16}] ``` Este comando não produz saída. Para obter mais informações, consulte [Grupos de segurança](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-security-groups.html) no *Manual do usuário da Amazon EC2*. **Exemplo 2: remover a regra que permite tráfego de saída para um grupo de segurança específico** O comando de exemplo `revoke-security-group-egress` a seguir remove a regra que concede acesso ao grupo de segurança especificado na porta TCP 80. ``` aws ec2 revoke-security-group-egress \ --group-id sg-026c12253ce15eff7 \ --ip-permissions '[{"IpProtocol": "tcp", "FromPort": 443, "ToPort": 443,"UserIdGroupPairs": [{"GroupId": "sg-06df23a01ff2df86d"}]}]' ``` Este comando não produz saída. Para obter mais informações, consulte [Grupos de segurança](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-security-groups.html) no *Manual do usuário da Amazon EC2*. + Para ver detalhes da API, consulte [RevokeSecurityGroupEgress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/revoke-security-group-egress.html) na *Referência de comandos da AWS CLI*. ### `revoke-security-group-ingress` O código de exemplo a seguir mostra como usar `revoke-security-group-ingress`. **AWS CLI** **Exemplo 1: remover uma regra de um grupo de segurança** O exemplo `revoke-security-group-ingress` a seguir remove o acesso à porta TCP 22 para o intervalo de endereços `203.0.113.0/24` do grupo de segurança especificado para uma VPC padrão. ``` aws ec2 revoke-security-group-ingress \ --group-name mySecurityGroup --protocol tcp \ --port 22 \ --cidr 203.0.113.0/24 ``` Se for bem-sucedido, esse comando não gerará nenhum resultado. Para obter mais informações, consulte [Grupos de segurança](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-security-groups.html) no *Manual do usuário da Amazon EC2*. **Exemplo 2: remover uma regra usando o conjunto de permissões de IP** O exemplo `revoke-security-group-ingress` a seguir usa o parâmetro `ip-permissions` para remover uma regra de entrada que permite a mensagem do ICMP `Destination Unreachable: Fragmentation Needed and Don't Fragment was Set` (Tipo 3, Código 4). ``` aws ec2 revoke-security-group-ingress \ --group-id sg-026c12253ce15eff7 \ --ip-permissions IpProtocol=icmp,FromPort=3,ToPort=4,IpRanges=[{CidrIp=0.0.0.0/0}] ``` Se for bem-sucedido, esse comando não gerará nenhum resultado. Para obter mais informações, consulte [Grupos de segurança](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-security-groups.html) no *Manual do usuário da Amazon EC2*. + Para ver detalhes da API, consulte [RevokeSecurityGroupIngress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/revoke-security-group-ingress.html) na *Referência de comandos da AWS CLI*. ### `run-instances` O código de exemplo a seguir mostra como usar `run-instances`. **AWS CLI** **Exemplo 1: executar uma instância em uma sub-rede padrão** O exemplo `run-instances` a seguir executa uma única instância do tipo `t2.micro` na sub-rede padrão da região atual e a associa à sub-rede padrão da VPC padrão da região. O par de chaves é opcional se você não planeja se conectar à instância usando SSH (Linux) ou RDP (Windows). ``` aws ec2 run-instances \ --image-id ami-0abcdef1234567890 \ --instance-type t2.micro \ --key-name MyKeyPair ``` Resultado: ``` { "Instances": [ { "AmiLaunchIndex": 0, "ImageId": "ami-0abcdef1234567890", "InstanceId": "i-1231231230abcdef0", "InstanceType": "t2.micro", "KeyName": "MyKeyPair", "LaunchTime": "2018-05-10T08:05:20.000Z", "Monitoring": { "State": "disabled" }, "Placement": { "AvailabilityZone": "us-east-2a", "GroupName": "", "Tenancy": "default" }, "PrivateDnsName": "ip-10-0-0-157.us-east-2.compute.internal", "PrivateIpAddress": "10.0.0.157", "ProductCodes": [], "PublicDnsName": "", "State": { "Code": 0, "Name": "pending" }, "StateTransitionReason": "", "SubnetId": "subnet-04a636d18e83cfacb", "VpcId": "vpc-1234567890abcdef0", "Architecture": "x86_64", "BlockDeviceMappings": [], "ClientToken": "", "EbsOptimized": false, "Hypervisor": "xen", "NetworkInterfaces": [ { "Attachment": { "AttachTime": "2018-05-10T08:05:20.000Z", "AttachmentId": "eni-attach-0e325c07e928a0405", "DeleteOnTermination": true, "DeviceIndex": 0, "Status": "attaching" }, "Description": "", "Groups": [ { "GroupName": "MySecurityGroup", "GroupId": "sg-0598c7d356eba48d7" } ], "Ipv6Addresses": [], "MacAddress": "0a:ab:58:e0:67:e2", "NetworkInterfaceId": "eni-0c0a29997760baee7", "OwnerId": "123456789012", "PrivateDnsName": "ip-10-0-0-157.us-east-2.compute.internal", "PrivateIpAddress": "10.0.0.157", "PrivateIpAddresses": [ { "Primary": true, "PrivateDnsName": "ip-10-0-0-157.us-east-2.compute.internal", "PrivateIpAddress": "10.0.0.157" } ], "SourceDestCheck": true, "Status": "in-use", "SubnetId": "subnet-04a636d18e83cfacb", "VpcId": "vpc-1234567890abcdef0", "InterfaceType": "interface" } ], "RootDeviceName": "/dev/xvda", "RootDeviceType": "ebs", "SecurityGroups": [ { "GroupName": "MySecurityGroup", "GroupId": "sg-0598c7d356eba48d7" } ], "SourceDestCheck": true, "StateReason": { "Code": "pending", "Message": "pending" }, "Tags": [], "VirtualizationType": "hvm", "CpuOptions": { "CoreCount": 1, "ThreadsPerCore": 1 }, "CapacityReservationSpecification": { "CapacityReservationPreference": "open" }, "MetadataOptions": { "State": "pending", "HttpTokens": "optional", "HttpPutResponseHopLimit": 1, "HttpEndpoint": "enabled" } } ], "OwnerId": "123456789012", "ReservationId": "r-02a3f596d91211712" } ``` **Exemplo 2: para executar uma instância em uma sub-rede não padrão e adicionar um endereço IP público** O exemplo `run-instances` a seguir solicita um endereço IP público para uma instância que você está executando em uma sub-rede não padrão. A instância está associada ao grupo de segurança especificado. ``` aws ec2 run-instances \ --image-id ami-0abcdef1234567890 \ --instance-type t2.micro \ --subnet-id subnet-08fc749671b2d077c \ --security-group-ids sg-0b0384b66d7d692f9 \ --associate-public-ip-address \ --key-name MyKeyPair ``` Para obter um exemplo da saída de `run-instances`, consulte o Exemplo 1. **Exemplo 3: executar uma instância com volumes adicionais** O exemplo `run-instances` a seguir usa um mapeamento de dispositivos de blocos, especificado em mapping.json, para anexar volumes adicionais na execução. Um mapeamento de dispositivos de blocos pode especificar volumes do EBS, volumes de armazenamento de instância ou tanto volumes do EBS quanto volumes de armazenamento de instância. ``` aws ec2 run-instances \ --image-id ami-0abcdef1234567890 \ --instance-type t2.micro \ --subnet-id subnet-08fc749671b2d077c \ --security-group-ids sg-0b0384b66d7d692f9 \ --key-name MyKeyPair \ --block-device-mappings file://mapping.json ``` Conteúdo de `mapping.json`. Este exemplo adiciona `/dev/sdh` como um volume vazio do EBS com um tamanho de 100 GiB. ``` [ { "DeviceName": "/dev/sdh", "Ebs": { "VolumeSize": 100 } } ] ``` Conteúdo de `mapping.json`. Este exemplo adiciona `ephemeral1` como um volume de armazenamento de instância. ``` [ { "DeviceName": "/dev/sdc", "VirtualName": "ephemeral1" } ] ``` Para obter um exemplo da saída de `run-instances`, consulte o Exemplo 1. Para obter mais informações sobre mapeamentos de dispositivos de blocos, consulte [Mapeamento de dispositivos de blocos](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) no *Guia do usuário do Amazon EC2*. **Exemplo 4: executar uma instância e adicionar tags na criação** O exemplo `run-instances` a seguir adiciona uma tag com uma chave de `webserver` e um valor de `production` à instância. O comando também aplica uma tag com uma chave de `cost-center` e um valor de `cc123` a qualquer volume do EBS criado (neste caso, o volume do dispositivo raiz). ``` aws ec2 run-instances \ --image-id ami-0abcdef1234567890 \ --instance-type t2.micro \ --count 1 \ --subnet-id subnet-08fc749671b2d077c \ --key-name MyKeyPair \ --security-group-ids sg-0b0384b66d7d692f9 \ --tag-specifications 'ResourceType=instance,Tags=[{Key=webserver,Value=production}]' 'ResourceType=volume,Tags=[{Key=cost-center,Value=cc123}]' ``` Para obter um exemplo da saída de `run-instances`, consulte o Exemplo 1. **Exemplo 5: executar uma instância com dados do usuário** O exemplo `run-instances` a seguir passa dados do usuário em um arquivo chamado `my_script.txt` que contém um script de configuração para a sua instância. O script é executado na inicialização. ``` aws ec2 run-instances \ --image-id ami-0abcdef1234567890 \ --instance-type t2.micro \ --count 1 \ --subnet-id subnet-08fc749671b2d077c \ --key-name MyKeyPair \ --security-group-ids sg-0b0384b66d7d692f9 \ --user-data file://my_script.txt ``` Para obter um exemplo da saída de `run-instances`, consulte o Exemplo 1. Para obter mais informações sobre dados do usuário da instância, consulte [Trabalho com dados do usuário da instância](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instancedata-add-user-data.html) no *Guia do usuário do Amazon EC2*. **Exemplo 6: executar uma instância de desempenho expansível** O exemplo `run-instances` a seguir executa uma instância t2.micro com a opção de crédito `unlimited`. Ao executar uma instância T2, se você não especificar a `--credit-specification`, o padrão é a opção de crédito `standard`. Ao executar uma instância T3, o padrão é a opção de crédito `unlimited`. ``` aws ec2 run-instances \ --image-id ami-0abcdef1234567890 \ --instance-type t2.micro \ --count 1 \ --subnet-id subnet-08fc749671b2d077c \ --key-name MyKeyPair \ --security-group-ids sg-0b0384b66d7d692f9 \ --credit-specification CpuCredits=unlimited ``` Para obter um exemplo da saída de `run-instances`, consulte o Exemplo 1. Para obter mais informações sobre instâncias de desempenho expansível, consulte [Instâncias de desempenho expansível](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) no *Guia do usuário do Amazon EC2*. + Consulte detalhes da API em [RunInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/run-instances.html) na *Referência de comandos da AWS CLI*. ### `run-scheduled-instances` O código de exemplo a seguir mostra como usar `run-scheduled-instances`. **AWS CLI** **Executar uma instância programada** Este exemplo inicia a Instância Programada especificada em uma VPC. Comando: ``` aws ec2 run-scheduled-instances --scheduled-instance-id sci-1234-1234-1234-1234-123456789012 --instance-count 1 --launch-specification file://launch-specification.json ``` Launch-specification.json: ``` { "ImageId": "ami-12345678", "KeyName": "my-key-pair", "InstanceType": "c4.large", "NetworkInterfaces": [ { "DeviceIndex": 0, "SubnetId": "subnet-12345678", "AssociatePublicIpAddress": true, "Groups": ["sg-12345678"] } ], "IamInstanceProfile": { "Name": "my-iam-role" } } ``` Resultado: ``` { "InstanceIdSet": [ "i-1234567890abcdef0" ] } ``` Este exemplo lança a Instância Programada especificada no EC2-Classic. Comando: ``` aws ec2 run-scheduled-instances --scheduled-instance-id sci-1234-1234-1234-1234-123456789012 --instance-count 1 --launch-specification file://launch-specification.json ``` Launch-specification.json: ``` { "ImageId": "ami-12345678", "KeyName": "my-key-pair", "SecurityGroupIds": ["sg-12345678"], "InstanceType": "c4.large", "Placement": { "AvailabilityZone": "us-west-2b" } "IamInstanceProfile": { "Name": "my-iam-role" } } ``` Resultado: ``` { "InstanceIdSet": [ "i-1234567890abcdef0" ] } ``` + Para ver detalhes da API, consulte [RunScheduledInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/run-scheduled-instances.html) na *Referência de comandos da AWS CLI*. ### `search-local-gateway-routes` O código de exemplo a seguir mostra como usar `search-local-gateway-routes`. **AWS CLI** **Pesquisar rotas em uma tabela de rotas de gateway local** O exemplo `search-local-gateway-routes` a seguir pesquisa rotas estáticas na tabela de rotas do gateway local especificada na tabela de rotas do gateway local. ``` aws ec2 search-local-gateway-routes \ --local-gateway-route-table-id lgw-rtb-059615ef7dEXAMPLE \ --filters "Name=type,Values=static" ``` Resultado: ``` { "Route": { "DestinationCidrBlock": "0.0.0.0/0", "LocalGatewayVirtualInterfaceGroupId": "lgw-vif-grp-07145b276bEXAMPLE", "Type": "static", "State": "deleted", "LocalGatewayRouteTableId": "lgw-rtb-059615ef7EXAMPLE" } } ``` + Para ver detalhes da API, consulte [SearchLocalGatewayRoutes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/search-local-gateway-routes.html) na *Referência de comandos da AWS CLI*. ### `search-transit-gateway-multicast-groups` O código de exemplo a seguir mostra como usar `search-transit-gateway-multicast-groups`. **AWS CLI** **Pesquisar um ou mais grupos multicast do gateway de trânsito e retornar as informações de associação ao grupo** O exemplo `search-transit-gateway-multicast-groups` a seguir retorna a associação do grupo multicast especificado. ``` aws ec2 search-transit-gateway-multicast-groups \ --transit-gateway-multicast-domain-id tgw-mcast-domain-000fb24d04EXAMPLE ``` Resultado: ``` { "MulticastGroups": [ { "GroupIpAddress": "224.0.1.0", "TransitGatewayAttachmentId": "tgw-attach-0372e72386EXAMPLE", "SubnetId": "subnet-0187aff814EXAMPLE", "ResourceId": "vpc-0065acced4EXAMPLE", "ResourceType": "vpc", "NetworkInterfaceId": "eni-03847706f6EXAMPLE", "GroupMember": false, "GroupSource": true, "SourceType": "static" } ] } ``` Consulte mais informações em [Multicast on transit gateways](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-multicast-overview.html) no *Guia do usuário do Transit Gateway*. + Para ver detalhes da API, consulte [SearchTransitGatewayMulticastGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/search-transit-gateway-multicast-groups.html) na *Referência de comandos da AWS CLI*. ### `search-transit-gateway-routes` O código de exemplo a seguir mostra como usar `search-transit-gateway-routes`. **AWS CLI** **Procurar rotas na tabela de rotas do gateway de trânsito especificada** O exemplo `search-transit-gateway-routes` a seguir retorna todas as rotas do tipo `static` na tabela de rotas especificada. ``` aws ec2 search-transit-gateway-routes \ --transit-gateway-route-table-id tgw-rtb-0a823edbdeEXAMPLE \ --filters "Name=type,Values=static" ``` Resultado: ``` { "Routes": [ { "DestinationCidrBlock": "10.0.2.0/24", "TransitGatewayAttachments": [ { "ResourceId": "vpc-4EXAMPLE", "TransitGatewayAttachmentId": "tgw-attach-09b52ccdb5EXAMPLE", "ResourceType": "vpc" } ], "Type": "static", "State": "active" }, { "DestinationCidrBlock": "10.1.0.0/24", "TransitGatewayAttachments": [ { "ResourceId": "vpc-4EXAMPLE", "TransitGatewayAttachmentId": "tgw-attach-09b52ccdb5EXAMPLE", "ResourceType": "vpc" } ], "Type": "static", "State": "active" } ], "AdditionalRoutesAvailable": false } ``` Para obter mais informações, consulte [Tabelas de rota do gateway de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html) no *Guia de gateways de trânsito*. + Para ver detalhes da API, consulte [SearchTransitGatewayRoutes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/search-transit-gateway-routes.html) na *Referência de comandos da AWS CLI*. ### `send-diagnostic-interrupt` O código de exemplo a seguir mostra como usar `send-diagnostic-interrupt`. **AWS CLI** **Enviar uma interrupção para diagnóstico** O exemplo `send-diagnostic-interrupt` a seguir envia uma interrupção de diagnóstico para a instância especificada. ``` aws ec2 send-diagnostic-interrupt \ --instance-id i-1234567890abcdef0 ``` Este comando não produz saída. + Para ver detalhes da API, consulte [SendDiagnosticInterrupt](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/send-diagnostic-interrupt.html) na *Referência de comandos da AWS CLI*. ### `start-instances` O código de exemplo a seguir mostra como usar `start-instances`. **AWS CLI** **Para iniciar uma instância do Amazon EC** Este exemplo inicia a instância especificada com o Amazon EBS. Comando: ``` aws ec2 start-instances --instance-ids i-1234567890abcdef0 ``` Resultado: ``` { "StartingInstances": [ { "InstanceId": "i-1234567890abcdef0", "CurrentState": { "Code": 0, "Name": "pending" }, "PreviousState": { "Code": 80, "Name": "stopped" } } ] } ``` Para obter mais informações, consulte Interromper e iniciar sua instância no *Guia do usuário do Amazon Elastic Compute Cloud*. + Consulte detalhes da API em [StartInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/start-instances.html) na *Referência de comandos da AWS CLI*. ### `start-network-insights-access-scope-analysis` O código de exemplo a seguir mostra como usar `start-network-insights-access-scope-analysis`. **AWS CLI** **Iniciar uma análise do escopo de acesso do Network Insights** O exemplo `start-network-insights-access-scope-analysis` a seguir inicia a análise do escopo em sua conta da AWS. ``` aws ec2 start-network-insights-access-scope-analysis \ --region us-east-1 \ --network-insights-access-scope-id nis-123456789111 ``` Resultado: ``` { "NetworkInsightsAccessScopeAnalysis": { "NetworkInsightsAccessScopeAnalysisId": "nisa-123456789222", "NetworkInsightsAccessScopeAnalysisArn": "arn:aws:ec2:us-east-1:123456789012:network-insights-access-scope-analysis/nisa-123456789222", "NetworkInsightsAccessScopeId": "nis-123456789111", "Status": "running", "StartDate": "2022-01-26T00:47:06.814000+00:00" } } ``` Para obter mais informações, consulte [Introdução ao Analisador de Acesso à Rede usando AWS CLI](https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/getting-started-cli.html) no *Guia do Analisador de Acesso à Rede*. + Para ver detalhes da API, consulte [StartNetworkInsightsAccessScopeAnalysis](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/start-network-insights-access-scope-analysis.html) na *Referência de comandos da AWS CLI*. ### `start-network-insights-analysis` O código de exemplo a seguir mostra como usar `start-network-insights-analysis`. **AWS CLI** **Analisar um caminho** O exemplo `start-network-insights-analysis` a seguir analisa o caminho entre a origem e o destino. Para visualizar os resultados da análise do caminho, use o comando `describe-network-insights-analyses`. ``` aws ec2 start-network-insights-analysis \ --network-insights-path-id nip-0b26f224f1d131fa8 ``` Resultado: ``` { "NetworkInsightsAnalysis": { "NetworkInsightsAnalysisId": "nia-02207aa13eb480c7a", "NetworkInsightsAnalysisArn": "arn:aws:ec2:us-east-1:123456789012:network-insights-analysis/nia-02207aa13eb480c7a", "NetworkInsightsPathId": "nip-0b26f224f1d131fa8", "StartDate": "2021-01-20T22:58:37.495Z", "Status": "running" } } ``` Para obter mais informações, consulte [Introdução ao uso da AWS CLI](https://docs.aws.amazon.com/vpc/latest/reachability/getting-started-cli.html) no *Guia do Reachability Analyzer*. + Para ver detalhes da API, consulte [StartNetworkInsightsAnalysis](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/start-network-insights-analysis.html) na *Referência de comandos da AWS CLI*. ### `start-vpc-endpoint-service-private-dns-verification` O código de exemplo a seguir mostra como usar `start-vpc-endpoint-service-private-dns-verification`. **AWS CLI** **Iniciar o processo de verificação de DNS** O exemplo `start-vpc-endpoint-service-private-dns-verification` a seguir inicia o processo de verificação de DNS para o serviço de endpoint especificado. ``` aws ec2 start-vpc-endpoint-service-private-dns-verification \ --service-id vpce-svc-071afff70666e61e0 ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar nomes DNS](https://docs.aws.amazon.com/vpc/latest/privatelink/manage-dns-names.html) no *Guia do usuário do AWS PrivateLink*. + Para ver detalhes da API, consulte [StartVpcEndpointServicePrivateDnsVerification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/start-vpc-endpoint-service-private-dns-verification.html) na *Referência de comandos da AWS CLI*. ### `stop-instances` O código de exemplo a seguir mostra como usar `stop-instances`. **AWS CLI** **Exemplo 1: interromper uma instância do Amazon EC** O exemplo `stop-instances` a seguir interrompe a instância especificada com o Amazon EBS. ``` aws ec2 stop-instances \ --instance-ids i-1234567890abcdef0 ``` Resultado: ``` { "StoppingInstances": [ { "InstanceId": "i-1234567890abcdef0", "CurrentState": { "Code": 64, "Name": "stopping" }, "PreviousState": { "Code": 16, "Name": "running" } } ] } ``` Para obter mais informações, consulte [Interromper e iniciar sua instância](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html) no *Guia do usuário do Amazon Elastic Compute Cloud*. **Exemplo 2: hibernar uma instância do Amazon EC** O exemplo `stop-instances` a seguir hiberna uma instância com o Amazon EBS se ela estiver habilitada para isso e atender aos pré-requisitos de hibernação. Depois de colocar a instância em hibernação, ela é interrompida. ``` aws ec2 stop-instances \ --instance-ids i-1234567890abcdef0 \ --hibernate ``` Resultado: ``` { "StoppingInstances": [ { "CurrentState": { "Code": 64, "Name": "stopping" }, "InstanceId": "i-1234567890abcdef0", "PreviousState": { "Code": 16, "Name": "running" } } ] } ``` Para obter mais informações, consulte [Colocar em hibernação uma instância sob demanda do Linux](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) no *Guia do usuário do Amazon Elastic Cloud Compute*. + Consulte detalhes da API em [StopInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/stop-instances.html) na *Referência de comandos da AWS CLI*. ### `terminate-client-vpn-connections` O código de exemplo a seguir mostra como usar `terminate-client-vpn-connections`. **AWS CLI** **Encerrar uma conexão com um endpoint do Client VPN** O exemplo `terminate-client-vpn-connections` a seguir encerra a conexão especificada com o endpoint do Client VPN. ``` aws ec2 terminate-client-vpn-connections \ --client-vpn-endpoint-id vpn-endpoint-123456789123abcde \ --connection-id cvpn-connection-04edd76f5201e0cb8 ``` Resultado: ``` { "ClientVpnEndpointId": "vpn-endpoint-123456789123abcde", "ConnectionStatuses": [ { "ConnectionId": "cvpn-connection-04edd76f5201e0cb8", "PreviousStatus": { "Code": "active" }, "CurrentStatus": { "Code": "terminating" } } ] } ``` Para obter mais informações, consulte [Conexões do cliente](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-connections.html) no *Guia do administrador do AWS Client VPN*. + Para ver detalhes da API, consulte [TerminateClientVpnConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/terminate-client-vpn-connections.html) na *Referência de comandos da AWS CLI*. ### `terminate-instances` O código de exemplo a seguir mostra como usar `terminate-instances`. **AWS CLI** **Para encerrar uma instância do Amazon EC** Este exemplo encerra a instância especificada. Comando: ``` aws ec2 terminate-instances --instance-ids i-1234567890abcdef0 ``` Resultado: ``` { "TerminatingInstances": [ { "InstanceId": "i-1234567890abcdef0", "CurrentState": { "Code": 32, "Name": "shutting-down" }, "PreviousState": { "Code": 16, "Name": "running" } } ] } ``` Para obter mais informações, consulte Using Amazon EC2 Instances no *Guia do usuário da AWS Command Line Interface*. + Consulte detalhes da API em [TerminateInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/terminate-instances.html) na *Referência de comandos da AWS CLI*. ### `unassign-ipv6-addresses` O código de exemplo a seguir mostra como usar `unassign-ipv6-addresses`. **AWS CLI** **Cancelar a atribuição de um endereço IPv6 de uma interface de rede** Este exemplo desatribui o endereço IPv6 especificado da interface de rede especificada. Comando: ``` aws ec2 unassign-ipv6-addresses --ipv6-addresses 2001:db8:1234:1a00:3304:8879:34cf:4071 --network-interface-id eni-23c49b68 ``` Resultado: ``` { "NetworkInterfaceId": "eni-23c49b68", "UnassignedIpv6Addresses": [ "2001:db8:1234:1a00:3304:8879:34cf:4071" ] } ``` + Para ver detalhes da API, consulte [UnassignIpv6Addresses](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/unassign-ipv6-addresses.html) na *Referência de comandos da AWS CLI*. ### `unassign-private-ip-addresses` O código de exemplo a seguir mostra como usar `unassign-private-ip-addresses`. **AWS CLI** **Cancelar a atribuição de um endereço IP privado secundário de uma interface de rede** Este exemplo cancela a atribuição do endereço IP privado especificado da interface de rede especificada. Se o comando for bem-sucedido, nenhuma saída será retornada. Comando: ``` aws ec2 unassign-private-ip-addresses --network-interface-id eni-e5aa89a3 --private-ip-addresses 10.0.0.82 ``` + Para ver detalhes da API, consulte [UnassignPrivateIpAddresses](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/unassign-private-ip-addresses.html) na *Referência de comandos da AWS CLI*. ### `unassign-private-nat-gateway-address` O código de exemplo a seguir mostra como usar `unassign-private-nat-gateway-address`. **AWS CLI** **Cancelar a atribuição de um endereço IP privado do seu gateway NAT privado** O exemplo `unassign-private-nat-gateway-address` a seguir cancela a atribuição do endereço IP especificado do gateway NAT privado especificado. ``` aws ec2 unassign-private-nat-gateway-address \ --nat-gateway-id nat-1234567890abcdef0 \ --private-ip-addresses 10.0.20.197 ``` Resultado: ``` { "NatGatewayId": "nat-0ee3edd182361f662", "NatGatewayAddresses": [ { "NetworkInterfaceId": "eni-0065a61b324d1897a", "PrivateIp": "10.0.20.197", "IsPrimary": false, "Status": "unassigning" } ] } ``` Para obter mais informações, consulte [Gateways NAT](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) no *Guia do usuário da Amazon VPC*. + Para ver detalhes da API, consulte [UnassignPrivateNatGatewayAddress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/unassign-private-nat-gateway-address.html) na *Referência de comandos da AWS CLI*. ### `unlock-snapshot` O código de exemplo a seguir mostra como usar `unlock-snapshot`. **AWS CLI** **Desbloquear um snapshot** O exemplo `unlock-snapshot` a seguir desbloqueia o snapshot especificado. ``` aws ec2 unlock-snapshot \ --snapshot-id snap-0b5e733b4a8df6e0d ``` Resultado: ``` { "SnapshotId": "snap-0b5e733b4a8df6e0d" } ``` Para obter mais informações, consulte [Bloqueio de snapshots](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-snapshot-lock.html) no *Guia do usuário do Amazon EBS*. + Para ver detalhes da API, consulte [UnlockSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/unlock-snapshot.html) na *Referência de comandos da AWS CLI*. ### `unmonitor-instances` O código de exemplo a seguir mostra como usar `unmonitor-instances`. **AWS CLI** **Para desabilitar o monitoramento detalhado de uma instância** Este exemplo de comando desabilita o monitoramento detalhado da instância especificada. Comando: ``` aws ec2 unmonitor-instances --instance-ids i-1234567890abcdef0 ``` Resultado: ``` { "InstanceMonitorings": [ { "InstanceId": "i-1234567890abcdef0", "Monitoring": { "State": "disabling" } } ] } ``` + Consulte detalhes da API em [UnmonitorInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/unmonitor-instances.html) na *Referência de comandos da AWS CLI*. ### `update-security-group-rule-descriptions-egress` O código de exemplo a seguir mostra como usar `update-security-group-rule-descriptions-egress`. **AWS CLI** **Atualizar a descrição de uma regra de saída de grupo de segurança** O exemplo `update-security-group-rule-descriptions-egress` a seguir atualiza a descrição da regra do grupo de segurança para a porta especificada e o intervalo de endereços IPv4. A descrição '`Outbound HTTP access to server 2`' substitui qualquer descrição existente para a regra. ``` aws ec2 update-security-group-rule-descriptions-egress \ --group-id sg-02f0d35a850ba727f \ --ip-permissions IpProtocol=tcp,FromPort=80,ToPort=80,IpRanges=[{CidrIp=203.0.113.0/24,Description="Outbound HTTP access to server 2"}] ``` Resultado: ``` { "Return": true } ``` Consulte mais informações em [Regras de grupo de segurança](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-security-groups.html#security-group-rules) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [UpdateSecurityGroupRuleDescriptionsEgress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/update-security-group-rule-descriptions-egress.html) na *Referência de comandos da AWS CLI*. ### `update-security-group-rule-descriptions-ingress` O código de exemplo a seguir mostra como usar `update-security-group-rule-descriptions-ingress`. **AWS CLI** **Exemplo 1: atualizar a descrição de uma regra de grupo de segurança de entrada com uma fonte CIDR** O exemplo `update-security-group-rule-descriptions-ingress` a seguir atualiza a descrição da regra do grupo de segurança para a porta especificada e o intervalo de endereços IPv4. A descrição '`SSH access from ABC office`' substitui qualquer descrição existente para a regra. ``` aws ec2 update-security-group-rule-descriptions-ingress \ --group-id sg-02f0d35a850ba727f \ --ip-permissions IpProtocol=tcp,FromPort=22,ToPort=22,IpRanges='[{CidrIp=203.0.113.0/16,Description="SSH access from corpnet"}]' ``` Resultado: ``` { "Return": true } ``` Consulte mais informações em [Regras de grupo de segurança](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-security-groups.html#security-group-rules) no *Guia do usuário do Amazon EC2*. **Exemplo 2: atualizar a descrição de uma regra de grupo de segurança de entrada com uma fonte de lista de prefixos** O exemplo `update-security-group-rule-descriptions-ingress` a seguir atualiza a descrição da regra do grupo de segurança para a porta especificada e a lista de prefixos. A descrição '`SSH access from ABC office`' substitui qualquer descrição existente para a regra. ``` aws ec2 update-security-group-rule-descriptions-ingress \ --group-id sg-02f0d35a850ba727f \ --ip-permissions IpProtocol=tcp,FromPort=22,ToPort=22,PrefixListIds='[{PrefixListId=pl-12345678,Description="SSH access from corpnet"}]' ``` Resultado: ``` { "Return": true } ``` Consulte mais informações em [Regras de grupo de segurança](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-security-groups.html#security-group-rules) no *Guia do usuário do Amazon EC2*. + Para ver detalhes da API, consulte [UpdateSecurityGroupRuleDescriptionsIngress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/update-security-group-rule-descriptions-ingress.html) na *Referência de comandos da AWS CLI*. ### `withdraw-byoip-cidr` O código de exemplo a seguir mostra como usar `withdraw-byoip-cidr`. **AWS CLI** **Parar de anunciar um intervalo de endereços** O exemplo `withdraw-byoip-cidr` a seguir interrompe o anúncio do intervalo de endereços especificado. ``` aws ec2 withdraw-byoip-cidr --cidr 203.0.113.25/24 ``` Resultado: ``` { "ByoipCidr": { "Cidr": "203.0.113.25/24", "StatusMessage": "ipv4pool-ec2-1234567890abcdef0", "State": "advertised" } } ``` + Para ver detalhes da API, consulte [WithdrawByoipCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/withdraw-byoip-cidr.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon EC2 Instance Connect usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o Amazon EC2 Instance Connect. *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-ssh-public-key` O código de exemplo a seguir mostra como usar `send-ssh-public-key`. **AWS CLI** **Como enviar uma chave pública SSH para uma instância** O exemplo `send-ssh-public-key` a seguir envia a chave pública SSH especificada para a instância especificada. A chave é usada para autenticar o usuário especificado. ``` aws ec2-instance-connect send-ssh-public-key \ --instance-id i-1234567890abcdef0 \ --instance-os-user ec2-user \ --availability-zone us-east-2b \ --ssh-public-key file://path/my-rsa-key.pub ``` Este comando não produz saída. + Para ver detalhes da API, consulte [SendSshPublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2-instance-connect/send-ssh-public-key.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon ECR usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface 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 ### `batch-check-layer-availability` O código de exemplo a seguir mostra como usar `batch-check-layer-availability`. **AWS CLI** **Como verificar a disponibilidade de uma camada** O exemplo `batch-check-layer-availability` a seguir verifica a disponibilidade de uma camada com o resumo `sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed` no repositório `cluster-autoscaler`. ``` aws ecr batch-check-layer-availability \ --repository-name cluster-autoscaler \ --layer-digests sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed ``` Resultado: ``` { "layers": [ { "layerDigest": "sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed", "layerAvailability": "AVAILABLE", "layerSize": 2777, "mediaType": "application/vnd.docker.container.image.v1+json" } ], "failures": [] } ``` + Para ver detalhes da API, consulte [BatchCheckLayerAvailability](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/batch-check-layer-availability.html) na *Referência de comandos da AWS CLI*. ### `batch-delete-image` O código de exemplo a seguir mostra como usar `batch-delete-image`. **AWS CLI** **Exemplo 1: excluir uma imagem** O exemplo `batch-delete-image` a seguir exclui uma imagem com a tag `precise` no repositório especificado no registro padrão de uma conta. ``` aws ecr batch-delete-image \ --repository-name ubuntu \ --image-ids imageTag=precise ``` Resultado: ``` { "failures": [], "imageIds": [ { "imageTag": "precise", "imageDigest": "sha256:19665f1e6d1e504117a1743c0a3d3753086354a38375961f2e665416ef4b1b2f" } ] } ``` **Exemplo 2: excluir várias imagens** O exemplo `batch-delete-image` a seguir exclui todas as imagens marcadas com `prod` e `team1` no repositório especificado. ``` aws ecr batch-delete-image \ --repository-name MyRepository \ --image-ids imageTag=prod imageTag=team1 ``` Resultado: ``` { "imageIds": [ { "imageDigest": "sha256:123456789012", "imageTag": "prod" }, { "imageDigest": "sha256:567890121234", "imageTag": "team1" } ], "failures": [] } ``` Para obter mais informações, consulte [Excluir uma imagem](https://docs.aws.amazon.com/AmazonECR/latest/userguide/delete_image.html) no *Guia do usuário do Amazon ECR*. + Para ver detalhes da API, consulte [BatchDeleteImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/batch-delete-image.html) na *Referência de comandos da AWS CLI*. ### `batch-get-image` O código de exemplo a seguir mostra como usar `batch-get-image`. **AWS CLI** **Exemplo 1: obter uma imagem** O exemplo `batch-get-image` a seguir obtém uma imagem com a tag `v1.13.6` em um repositório chamado `cluster-autoscaler` no registro padrão de uma conta. ``` aws ecr batch-get-image \ --repository-name cluster-autoscaler \ --image-ids imageTag=v1.13.6 ``` Resultado: ``` { "images": [ { "registryId": "012345678910", "repositoryName": "cluster-autoscaler", "imageId": { "imageDigest": "sha256:4a1c6567c38904384ebc64e35b7eeddd8451110c299e3368d2210066487d97e5", "imageTag": "v1.13.6" }, "imageManifest": "{\n \"schemaVersion\": 2,\n \"mediaType\": \"application/vnd.docker.distribution.manifest.v2+json\",\n \"config\": {\n \"mediaType\": \"application/vnd.docker.container.image.v1+json\",\n \"size\": 2777,\n \"digest\": \"sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed\"\n },\n \"layers\": [\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 17743696,\n \"digest\": \"sha256:39fafc05754f195f134ca11ecdb1c9a691ab0848c697fffeb5a85f900caaf6e1\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 2565026,\n \"digest\": \"sha256:8c8a779d3a537b767ae1091fe6e00c2590afd16767aa6096d1b318d75494819f\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 28005981,\n \"digest\": \"sha256:c44ba47496991c9982ee493b47fd25c252caabf2b4ae7dd679c9a27b6a3c8fb7\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 775,\n \"digest\": \"sha256:e2c388b44226544363ca007be7b896bcce1baebea04da23cbd165eac30be650f\"\n }\n ]\n}" } ], "failures": [] } ``` **Exemplo 2: obter várias imagens** O exemplo `batch-get-image` a seguir exibe detalhes de todas as imagens marcadas com `prod` e `team1` no repositório especificado. ``` aws ecr batch-get-image \ --repository-name MyRepository \ --image-ids imageTag=prod imageTag=team1 ``` Resultado: ``` { "images": [ { "registryId": "123456789012", "repositoryName": "MyRepository", "imageId": { "imageDigest": "sha256:123456789012", "imageTag": "prod" }, "imageManifest": "manifestExample1" }, { "registryId": "567890121234", "repositoryName": "MyRepository", "imageId": { "imageDigest": "sha256:123456789012", "imageTag": "team1" }, "imageManifest": "manifestExample2" } ], "failures": [] } ``` Para obter mais informações, consulte [Imagens](https://docs.aws.amazon.com/AmazonECR/latest/userguide/images.html) no *Guia do usuário do Amazon ECR*. + Para ver detalhes da API, consulte [BatchGetImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/batch-get-image.html) na *Referência de comandos da AWS CLI*. ### `complete-layer-upload` O código de exemplo a seguir mostra como usar `complete-layer-upload`. **AWS CLI** **Como concluir o upload de uma camada de imagem** O exemplo `complete-layer-upload` a seguir conclui o upload de uma camada de imagem para o repositório `layer-test`. ``` aws ecr complete-layer-upload \ --repository-name layer-test \ --upload-id 6cb64b8a-9378-0e33-2ab1-b780fab8a9e9 \ --layer-digests 6cb64b8a-9378-0e33-2ab1-b780fab8a9e9:48074e6d3a68b39aad8ccc002cdad912d4148c0f92b3729323e ``` Resultado: ``` { "uploadId": "6cb64b8a-9378-0e33-2ab1-b780fab8a9e9", "layerDigest": "sha256:9a77f85878aa1906f2020a0ecdf7a7e962d57e882250acd773383224b3fe9a02", "repositoryName": "layer-test", "registryId": "130757420319" } ``` + Para ver detalhes da API, consulte [CompleteLayerUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/complete-layer-upload.html) na *Referência de comandos da AWS CLI*. ### `create-repository` O código de exemplo a seguir mostra como usar `create-repository`. **AWS CLI** **Exemplo 1: criar um repositório** O exemplo `create-repository` a seguir cria um repositório dentro do namespace especificado no registro padrão de uma conta. ``` aws ecr create-repository \ --repository-name project-a/sample-repo ``` Resultado: ``` { "repository": { "registryId": "123456789012", "repositoryName": "project-a/sample-repo", "repositoryArn": "arn:aws:ecr:us-west-2:123456789012:repository/project-a/sample-repo" } } ``` Para obter mais informações, consulte [Creating a repository](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-create.html) no *Guia do usuário do Amazon ECR*. **Exemplo 2: criar um repositório configurado com imutabilidade da tag de imagem** O exemplo `create-repository` a seguir cria um repositório configurado para imutabilidade de tags no registro padrão de uma conta. ``` aws ecr create-repository \ --repository-name project-a/sample-repo \ --image-tag-mutability IMMUTABLE ``` Resultado: ``` { "repository": { "registryId": "123456789012", "repositoryName": "project-a/sample-repo", "repositoryArn": "arn:aws:ecr:us-west-2:123456789012:repository/project-a/sample-repo", "imageTagMutability": "IMMUTABLE" } } ``` Para obter mais informações, consulte [Mutabilidade da tag de imagem](https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-tag-mutability.html) no *Guia do usuário do Amazon ECR*. **Exemplo 3: criar um repositório configurado com uma configuração de digitalização** O exemplo de `create-repository` a seguir cria um repositório configurado para realizar uma verificação de vulnerabilidade no envio de imagens por push no registro padrão de uma conta. ``` aws ecr create-repository \ --repository-name project-a/sample-repo \ --image-scanning-configuration scanOnPush=true ``` Resultado: ``` { "repository": { "registryId": "123456789012", "repositoryName": "project-a/sample-repo", "repositoryArn": "arn:aws:ecr:us-west-2:123456789012:repository/project-a/sample-repo", "imageScanningConfiguration": { "scanOnPush": true } } } ``` Para obter mais informações, consulte [Verificação de Imagens](https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html) no *Guia do Usuário do Amazon ECR*. + Para ver detalhes da API, consulte [CreateRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/create-repository.html) na *Referência de comandos da AWS CLI*. ### `delete-lifecycle-policy` O código de exemplo a seguir mostra como usar `delete-lifecycle-policy`. **AWS CLI** **Para excluir uma política de ciclo de vida de um repositório** O exemplo `delete-lifecycle-policy` a seguir exclui a política de ciclo de vida do repositório `hello-world`. ``` aws ecr delete-lifecycle-policy \ --repository-name hello-world ``` Resultado: ``` { "registryId": "012345678910", "repositoryName": "hello-world", "lifecyclePolicyText": "{\"rules\":[{\"rulePriority\":1,\"description\":\"Remove untagged images.\",\"selection\":{\"tagStatus\":\"untagged\",\"countType\":\"sinceImagePushed\",\"countUnit\":\"days\",\"countNumber\":10},\"action\":{\"type\":\"expire\"}}]}", "lastEvaluatedAt": 0.0 } ``` + Para ver detalhes da API, consulte [DeleteLifecyclePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/delete-lifecycle-policy.html) na *Referência de comandos da AWS CLI*. ### `delete-repository-policy` O código de exemplo a seguir mostra como usar `delete-repository-policy`. **AWS CLI** **Para excluir a política de repositório de um repositório** O exemplo `delete-repository-policy` a seguir exclui a política de repositório do repositório `cluster-autoscaler`. ``` aws ecr delete-repository-policy \ --repository-name cluster-autoscaler ``` Resultado: ``` { "registryId": "012345678910", "repositoryName": "cluster-autoscaler", "policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"allow public pull\",\n \"Effect\" : \"Allow\",\n \"Principal\" : \"*\",\n \"Action\" : [ \"ecr:BatchCheckLayerAvailability\", \"ecr:BatchGetImage\", \"ecr:GetDownloadUrlForLayer\" ]\n } ]\n}" } ``` + Para ver detalhes da API, consulte [DeleteRepositoryPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/delete-repository-policy.html) na *Referência de comandos da AWS CLI*. ### `delete-repository` O código de exemplo a seguir mostra como usar `delete-repository`. **AWS CLI** **Para excluir um repositório** A força de comando do exemplo de `delete-repository` a seguir exclui o repositório especificado no registro padrão de uma conta. O sinalizador `--force` será obrigatório se o repositório contiver imagens. ``` aws ecr delete-repository \ --repository-name ubuntu \ --force ``` Resultado: ``` { "repository": { "registryId": "123456789012", "repositoryName": "ubuntu", "repositoryArn": "arn:aws:ecr:us-west-2:123456789012:repository/ubuntu" } } ``` Para obter mais informações, consulte [Excluir um repositório](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-delete.html) no *Guia do usuário do Amazon ECR*. + Para ver detalhes da API, consulte [DeleteRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/delete-repository.html) na *Referência de comandos da AWS CLI*. ### `describe-image-scan-findings` O código de exemplo a seguir mostra como usar `describe-image-scan-findings`. **AWS CLI** **Para descrever os resultados das descobertas de uma imagem** O exemplo `describe-image-scan-findings` a seguir retorna os resultados da descoberta de uma imagem usando o resumo da imagem no repositório especificado no registro padrão de uma conta. ``` aws ecr describe-image-scan-findings \ --repository-name sample-repo \ --image-id imageDigest=sha256:74b2c688c700ec95a93e478cdb959737c148df3fbf5ea706abe0318726e885e6 ``` Resultado: ``` { "imageScanFindings": { "findings": [ { "name": "CVE-2019-5188", "description": "A code execution vulnerability exists in the directory rehashing functionality of E2fsprogs e2fsck 1.45.4. A specially crafted ext4 directory can cause an out-of-bounds write on the stack, resulting in code execution. An attacker can corrupt a partition to trigger this vulnerability.", "uri": "http://people.ubuntu.com/~ubuntu-security/cve/CVE-2019-5188", "severity": "MEDIUM", "attributes": [ { "key": "package_version", "value": "1.44.1-1ubuntu1.1" }, { "key": "package_name", "value": "e2fsprogs" }, { "key": "CVSS2_VECTOR", "value": "AV:L/AC:L/Au:N/C:P/I:P/A:P" }, { "key": "CVSS2_SCORE", "value": "4.6" } ] } ], "imageScanCompletedAt": 1579839105.0, "vulnerabilitySourceUpdatedAt": 1579811117.0, "findingSeverityCounts": { "MEDIUM": 1 } }, "registryId": "123456789012", "repositoryName": "sample-repo", "imageId": { "imageDigest": "sha256:74b2c688c700ec95a93e478cdb959737c148df3fbf5ea706abe0318726e885e6" }, "imageScanStatus": { "status": "COMPLETE", "description": "The scan was completed successfully." } } ``` Para obter mais informações, consulte [Verificação de Imagens](https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html) no *Guia do Usuário do Amazon ECR*. + Para ver detalhes da API, consulte [DescribeImageScanFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/describe-image-scan-findings.html) na *Referência de comandos da AWS CLI*. ### `describe-images` O código de exemplo a seguir mostra como usar `describe-images`. **AWS CLI** **Para descrever uma imagem em um repositório** O exemplo de `describe-images` a seguir exibe os detalhes sobre uma imagem no repositório `cluster-autoscaler` com a tag `v1.13.6`. ``` aws ecr describe-images \ --repository-name cluster-autoscaler \ --image-ids imageTag=v1.13.6 ``` Resultado: ``` { "imageDetails": [ { "registryId": "012345678910", "repositoryName": "cluster-autoscaler", "imageDigest": "sha256:4a1c6567c38904384ebc64e35b7eeddd8451110c299e3368d2210066487d97e5", "imageTags": [ "v1.13.6" ], "imageSizeInBytes": 48318255, "imagePushedAt": 1565128275.0 } ] } ``` + Consulte detalhes da API em [DescribeImages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/describe-images.html) na *Referência de comandos da AWS CLI*. ### `describe-repositories` O código de exemplo a seguir mostra como usar `describe-repositories`. **AWS CLI** **Como descrever os repositórios em um registro** Este exemplo descreve os repositórios no registro padrão de uma conta. Comando: ``` aws ecr describe-repositories ``` Resultado: ``` { "repositories": [ { "registryId": "012345678910", "repositoryName": "ubuntu", "repositoryArn": "arn:aws:ecr:us-west-2:012345678910:repository/ubuntu" }, { "registryId": "012345678910", "repositoryName": "test", "repositoryArn": "arn:aws:ecr:us-west-2:012345678910:repository/test" } ] } ``` + Consulte detalhes da API em [DescribeRepositories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/describe-repositories.html) na *Referência de comandos da AWS CLI*. ### `get-authorization-token` O código de exemplo a seguir mostra como usar `get-authorization-token`. **AWS CLI** **Para obter um token de autorização para seu registro padrão** O comando do exemplo de `get-authorization-token` a seguir obtém um token de autorização para o registro padrão. ``` aws ecr get-authorization-token ``` Resultado: ``` { "authorizationData": [ { "authorizationToken": "QVdTOkN...", "expiresAt": 1448875853.241, "proxyEndpoint": "https://123456789012.dkr.ecr.us-west-2.amazonaws.com" } ] } ``` + Para ver detalhes da API, consulte [GetAuthorizationToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/get-authorization-token.html) na *Referência de comandos da AWS CLI*. ### `get-download-url-for-layer` O código de exemplo a seguir mostra como usar `get-download-url-for-layer`. **AWS CLI** **Para obter o URL de download de uma camada** O exemplo `get-download-url-for-layer` a seguir exibe o URL de download de uma camada com o resumo `sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed` no repositório `cluster-autoscaler`. ``` aws ecr get-download-url-for-layer \ --repository-name cluster-autoscaler \ --layer-digest sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed ``` Resultado: ``` { "downloadUrl": "https://prod-us-west-2-starport-layer-bucket.s3.us-west-2.amazonaws.com/e501-012345678910-9cb60dc0-7284-5643-3987-da6dac0465f0/04620aac-66a5-4167-8232-55ee7ef6d565?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20190814T220617Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=AKIA32P3D2JDNMVAJLGF%2F20190814%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=9161345894947a1672467a0da7a1550f2f7157318312fe4941b59976239c3337", "layerDigest": "sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed" } ``` + Para ver detalhes da API, consulte [GetDownloadUrlForLayer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/get-download-url-for-layer.html) na *Referência de comandos da AWS CLI*. ### `get-lifecycle-policy-preview` O código de exemplo a seguir mostra como usar `get-lifecycle-policy-preview`. **AWS CLI** **Para recuperar detalhes de uma prévia da política de ciclo de vida** O exemplo `get-lifecycle-policy-preview` a seguir recupera o resultado de uma prévia da política de ciclo de vida para o repositório especificado no registro padrão de uma conta. Comando: ``` aws ecr get-lifecycle-policy-preview \ --repository-name "project-a/amazon-ecs-sample" ``` Resultado: ``` { "registryId": "012345678910", "repositoryName": "project-a/amazon-ecs-sample", "lifecyclePolicyText": "{\n \"rules\": [\n {\n \"rulePriority\": 1,\n \"description\": \"Expire images older than 14 days\",\n \"selection\": {\n \"tagStatus\": \"untagged\",\n \"countType\": \"sinceImagePushed\",\n \"countUnit\": \"days\",\n \"countNumber\": 14\n },\n \"action\": {\n \"type\": \"expire\"\n }\n }\n ]\n}\n", "status": "COMPLETE", "previewResults": [], "summary": { "expiringImageTotalCount": 0 } } ``` Para obter mais informações, consulte [Políticas de ciclo de vida](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html) no *Guia do usuário do Amazon ECR*. + Para ver detalhes da API, consulte [GetLifecyclePolicyPreview](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/get-lifecycle-policy-preview.html) na *Referência de comandos da AWS CLI*. ### `get-lifecycle-policy` O código de exemplo a seguir mostra como usar `get-lifecycle-policy`. **AWS CLI** **Para recuperar uma política de ciclo de vida** O exemplo `get-lifecycle-policy` a seguir exibe detalhes da política de ciclo de vida do repositório especificado no registro padrão da conta. ``` aws ecr get-lifecycle-policy \ --repository-name "project-a/amazon-ecs-sample" ``` Resultado: ``` { "registryId": "123456789012", "repositoryName": "project-a/amazon-ecs-sample", "lifecyclePolicyText": "{\"rules\":[{\"rulePriority\":1,\"description\":\"Expire images older than 14 days\",\"selection\":{\"tagStatus\":\"untagged\",\"countType\":\"sinceImagePushed\",\"countUnit\":\"days\",\"countNumber\":14},\"action\":{\"type\":\"expire\"}}]}", "lastEvaluatedAt": 1504295007.0 } ``` Para obter mais informações, consulte [Políticas de ciclo de vida](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html) no *Guia do usuário do Amazon ECR*. + Para ver detalhes da API, consulte [GetLifecyclePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/get-lifecycle-policy.html) na *Referência de comandos da AWS CLI*. ### `get-login-password` O código de exemplo a seguir mostra como usar `get-login-password`. **AWS CLI** **Para recuperar uma senha para se autenticar em um registro** A seguir, `get-login-password` exibe uma senha que você pode usar com um cliente de contêiner de sua escolha para se autenticar em qualquer registro do Amazon ECR ao qual a entidade principal do IAM tenha acesso. ``` aws ecr get-login-password ``` Resultado: ``` ``` Para usar com a CLI do Docker, canalize a saída do comando `get-login-password` para o comando `docker login`. Ao recuperar a senha, certifique-se de especificar a mesma região em que seu registro do Amazon ECR existe. ``` aws ecr get-login-password \ --region \ | docker login \ --username AWS \ --password-stdin .dkr.ecr..amazonaws.com ``` Para obter mais informações, consulte [Autenticação de registro](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries#registry_auth) no *Guia do usuário do Amazon ECR*. + Para ver detalhes da API, consulte [GetLoginPassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/get-login-password.html) na *Referência de comandos da AWS CLI*. ### `get-login` O código de exemplo a seguir mostra como usar `get-login`. **AWS CLI** **Para recuperar um comando de login do Docker para seu registro padrão** Este exemplo imprime um comando que você pode usar para fazer login no seu registro padrão do Amazon ECR. Comando: ``` aws ecr get-login ``` Resultado: ``` docker login -u AWS -p -e none https://.dkr.ecr..amazonaws.com ``` **Como fazer login no registro de outra conta** Este exemplo imprime um ou mais comandos que você pode usar para fazer login nos registros do Amazon ECR associados a outras contas. Comando: ``` aws ecr get-login --registry-ids 012345678910 023456789012 ``` Resultado: ``` docker login -u -p -e none docker login -u -p -e none ``` + Para ver detalhes da API, consulte [GetLogin](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/get-login.html) na *Referência de comandos da AWS CLI*. ### `get-repository-policy` O código de exemplo a seguir mostra como usar `get-repository-policy`. **AWS CLI** Recupera a política de repositório de um repositório especificado. O exemplo de `get-repository-policy` a seguir exibe os detalhes sobre a política de repositório para o repositório `cluster-autoscaler`. ``` aws ecr get-repository-policy \ --repository-name cluster-autoscaler ``` Resultado: ``` { "registryId": "012345678910", "repositoryName": "cluster-autoscaler", "policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"allow public pull\",\n \"Effect\" : \"Allow\",\n \"Principal\" : \"*\",\n \"Action\" : [ \"ecr:BatchCheckLayerAvailability\", \"ecr:BatchGetImage\", \"ecr:GetDownloadUrlForLayer\" ]\n } ]\n}" } ``` + Para receber detalhes da API, consulte [GetRepositoryPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/get-repository-policy.html) na *Referência de comandos da AWS CLI*. ### `initiate-layer-upload` O código de exemplo a seguir mostra como usar `initiate-layer-upload`. **AWS CLI** **Para iniciar o upload de uma camada de imagem** O exemplo `initiate-layer-upload` a seguir inicia o upload de uma camada de imagem para o repositório `layer-test`. ``` aws ecr initiate-layer-upload \ --repository-name layer-test ``` Resultado: ``` { "partSize": 10485760, "uploadId": "6cb64b8a-9378-0e33-2ab1-b780fab8a9e9" } ``` + Para ver detalhes da API, consulte [InitiateLayerUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/initiate-layer-upload.html) na *Referência de comandos da AWS CLI*. ### `list-images` O código de exemplo a seguir mostra como usar `list-images`. **AWS CLI** **Para listar as imagens em um repositório** O exemplo de `list-images` a seguir exibe uma lista das imagens presentes no repositório `cluster-autoscaler`. ``` aws ecr list-images \ --repository-name cluster-autoscaler ``` Resultado: ``` { "imageIds": [ { "imageDigest": "sha256:99c6fb4377e9a420a1eb3b410a951c9f464eff3b7dbc76c65e434e39b94b6570", "imageTag": "v1.13.8" }, { "imageDigest": "sha256:99c6fb4377e9a420a1eb3b410a951c9f464eff3b7dbc76c65e434e39b94b6570", "imageTag": "v1.13.7" }, { "imageDigest": "sha256:4a1c6567c38904384ebc64e35b7eeddd8451110c299e3368d2210066487d97e5", "imageTag": "v1.13.6" } ] } ``` + Consulte detalhes da API em [ListImages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/list-images.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar as tags para o repositório** O exemplo `list-tags-for-resource` a seguir exibe uma lista das tags associadas ao repositório `hello-world`. ``` aws ecr list-tags-for-resource \ --resource-arn arn:aws:ecr:us-west-2:012345678910:repository/hello-world ``` Resultado: ``` { "tags": [ { "Key": "Stage", "Value": "Integ" } ] } ``` + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `put-image-scanning-configuration` O código de exemplo a seguir mostra como usar `put-image-scanning-configuration`. **AWS CLI** **Para atualizar a configuração de digitalização de imagens para um repositório** O exemplo `put-image-scanning-configuration` a seguir atualiza a configuração de verificação de imagens para o repositório especificado. ``` aws ecr put-image-scanning-configuration \ --repository-name sample-repo \ --image-scanning-configuration scanOnPush=true ``` Resultado: ``` { "registryId": "012345678910", "repositoryName": "sample-repo", "imageScanningConfiguration": { "scanOnPush": true } } ``` Para obter mais informações, consulte [Verificação de Imagens](https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html) no *Guia do Usuário do Amazon ECR*. + Para ver detalhes da API, consulte [PutImageScanningConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/put-image-scanning-configuration.html) na *Referência de comandos da AWS CLI*. ### `put-image-tag-mutability` O código de exemplo a seguir mostra como usar `put-image-tag-mutability`. **AWS CLI** **Para atualizar a configuração de mutabilidade de tag de imagem para um repositório existente** O exemplo `put-image-tag-mutability` a seguir configura o repositório especificado para imutabilidade de tags. Isso impede que todas as tags de imagem dentro do repositório sejam substituídas. ``` aws ecr put-image-tag-mutability \ --repository-name hello-repository \ --image-tag-mutability IMMUTABLE ``` Resultado: ``` { "registryId": "012345678910", "repositoryName": "sample-repo", "imageTagMutability": "IMMUTABLE" } ``` Para obter mais informações, consulte [Mutabilidade da tag de imagem](https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-tag-mutability.html) no *Guia do usuário do Amazon ECR*. + Consulte detalhes da API em [PutImageTagMutability](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/put-image-tag-mutability.html) na *Referência de comandos da AWS CLI*. ### `put-image` O código de exemplo a seguir mostra como usar `put-image`. **AWS CLI** **Como remarcar uma imagem com seu manifesto** O exemplo `put-image` a seguir cria uma nova tag no repositório `hello-world` com um manifesto de imagem existente. ``` aws ecr put-image \ --repository-name hello-world \ --image-tag 2019.08 \ --image-manifest file://hello-world.manifest.json ``` Conteúdo de `hello-world.manifest.json`: ``` { "schemaVersion": 2, "mediaType": "application/vnd.docker.distribution.manifest.v2+json", "config": { "mediaType": "application/vnd.docker.container.image.v1+json", "size": 5695, "digest": "sha256:cea5fe7701b7db3dd1c372f3cea6f43cdda444fcc488f530829145e426d8b980" }, "layers": [ { "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", "size": 39096921, "digest": "sha256:d8868e50ac4c7104d2200d42f432b661b2da8c1e417ccfae217e6a1e04bb9295" }, { "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", "size": 57938, "digest": "sha256:83251ac64627fc331584f6c498b3aba5badc01574e2c70b2499af3af16630eed" }, { "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", "size": 423, "digest": "sha256:589bba2f1b36ae56f0152c246e2541c5aa604b058febfcf2be32e9a304fec610" }, { "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", "size": 680, "digest": "sha256:d62ecaceda3964b735cdd2af613d6bb136a52c1da0838b2ff4b4dab4212bcb1c" }, { "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", "size": 162, "digest": "sha256:6d93b41cfc6bf0d2522b7cf61588de4cd045065b36c52bd3aec2ba0622b2b22b" }, { "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", "size": 28268840, "digest": "sha256:6986b4d4c07932c680b3587f2eac8b0e013568c003cc23b04044628a5c5e599f" }, { "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", "size": 35369152, "digest": "sha256:8c5ec60f10102dc8da0649d866c7c2f706e459d0bdc25c83ad2de86f4996c276" }, { "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", "size": 155, "digest": "sha256:cde50b1c594539c5f67cbede9aef95c9ae321ccfb857f7b251b45b84198adc85" }, { "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", "size": 28737, "digest": "sha256:2e102807ab72a73fc9abf53e8c50e421bdc337a0a8afcb242176edeec65977e4" }, { "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", "size": 190, "digest": "sha256:fc379bbd5ed37808772bef016553a297356c59b8f134659e6ee4ecb563c2f5a7" }, { "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", "size": 28748, "digest": "sha256:021db240dfccf5a1aff19507d17c0177e5888e518acf295b52204b1825e8b7ee" } ] } ``` Resultado: ``` { "image": { "registryId": "130757420319", "repositoryName": "hello-world", "imageId": { "imageDigest": "sha256:8ece96b74f87652876199d83bd107d0435a196133af383ac54cb82b6cc5283ae", "imageTag": "2019.08" }, "imageManifest": "{\n \"schemaVersion\": 2,\n \"mediaType\": \"application/vnd.docker.distribution.manifest.v2+json\",\n \"config\": {\n \"mediaType\": \"application/vnd.docker.container.image.v1+json\",\n \"size\": 5695,\n \"digest\": \"sha256:cea5fe7701b7db3dd1c372f3cea6f43cdda444fcc488f530829145e426d8b980\"\n },\n \"layers\": [\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 39096921,\n \"digest\": \"sha256:d8868e50ac4c7104d2200d42f432b661b2da8c1e417ccfae217e6a1e04bb9295\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 57938,\n \"digest\": \"sha256:83251ac64627fc331584f6c498b3aba5badc01574e2c70b2499af3af16630eed\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 423,\n \"digest\": \"sha256:589bba2f1b36ae56f0152c246e2541c5aa604b058febfcf2be32e9a304fec610\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 680,\n \"digest\": \"sha256:d62ecaceda3964b735cdd2af613d6bb136a52c1da0838b2ff4b4dab4212bcb1c\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 162,\n \"digest\": \"sha256:6d93b41cfc6bf0d2522b7cf61588de4cd045065b36c52bd3aec2ba0622b2b22b\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 28268840,\n \"digest\": \"sha256:6986b4d4c07932c680b3587f2eac8b0e013568c003cc23b04044628a5c5e599f\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 35369152,\n \"digest\": \"sha256:8c5ec60f10102dc8da0649d866c7c2f706e459d0bdc25c83ad2de86f4996c276\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 155,\n \"digest\": \"sha256:cde50b1c594539c5f67cbede9aef95c9ae321ccfb857f7b251b45b84198adc85\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 28737,\n \"digest\": \"sha256:2e102807ab72a73fc9abf53e8c50e421bdc337a0a8afcb242176edeec65977e4\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 190,\n \"digest\": \"sha256:fc379bbd5ed37808772bef016553a297356c59b8f134659e6ee4ecb563c2f5a7\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 28748,\n \"digest\": \"sha256:021db240dfccf5a1aff19507d17c0177e5888e518acf295b52204b1825e8b7ee\"\n }\n ]\n}\n" } } ``` + Para ver detalhes da API, consulte [PutImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/put-image.html) na *Referência de comandos da AWS CLI*. ### `put-lifecycle-policy` O código de exemplo a seguir mostra como usar `put-lifecycle-policy`. **AWS CLI** **Para criar uma política de ciclo de vida** O exemplo `put-lifecycle-policy` a seguir cria uma política de ciclo de vida para o repositório especificado no registro padrão de uma conta. ``` aws ecr put-lifecycle-policy \ --repository-name "project-a/amazon-ecs-sample" \ --lifecycle-policy-text "file://policy.json" ``` Conteúdo de `policy.json`: ``` { "rules": [ { "rulePriority": 1, "description": "Expire images older than 14 days", "selection": { "tagStatus": "untagged", "countType": "sinceImagePushed", "countUnit": "days", "countNumber": 14 }, "action": { "type": "expire" } } ] } ``` Resultado: ``` { "registryId": "", "repositoryName": "project-a/amazon-ecs-sample", "lifecyclePolicyText": "{\"rules\":[{\"rulePriority\":1,\"description\":\"Expire images older than 14 days\",\"selection\":{\"tagStatus\":\"untagged\",\"countType\":\"sinceImagePushed\",\"countUnit\":\"days\",\"countNumber\":14},\"action\":{\"type\":\"expire\"}}]}" } ``` Para obter mais informações, consulte [Políticas de ciclo de vida](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html) no *Guia do usuário do Amazon ECR*. + Consulte detalhes da API em [PutLifeCyclePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/put-life-cycle-policy.html) na *Referência de comandos da AWS CLI*. ### `set-repository-policy` O código de exemplo a seguir mostra como usar `set-repository-policy`. **AWS CLI** **Para definir a política de repositório para um repositório** O exemplo `set-repository-policy` a seguir anexa uma política de repositório contida em um arquivo ao repositório `cluster-autoscaler`. ``` aws ecr set-repository-policy \ --repository-name cluster-autoscaler \ --policy-text file://my-policy.json ``` Conteúdo de `my-policy.json`: ``` { "Version":"2012-10-17", "Statement" : [ { "Sid" : "allow public pull", "Effect" : "Allow", "Principal" : "*", "Action" : [ "ecr:BatchCheckLayerAvailability", "ecr:BatchGetImage", "ecr:GetDownloadUrlForLayer" ] } ] } ``` Resultado: ``` { "registryId": "012345678910", "repositoryName": "cluster-autoscaler", "policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"allow public pull\",\n \"Effect\" : \"Allow\",\n \"Principal\" : \"*\",\n \"Action\" : [ \"ecr:BatchCheckLayerAvailability\", \"ecr:BatchGetImage\", \"ecr:GetDownloadUrlForLayer\" ]\n } ]\n}" } ``` + Para obter detalhes sobre a API, consulte [SetRepositoryPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/set-repository-policy.html) na *Referência de comandos da AWS CLI*. ### `start-image-scan` O código de exemplo a seguir mostra como usar `start-image-scan`. **AWS CLI** **Para iniciar uma verificação de vulnerabilidade de imagem** O exemplo `start-image-scan` a seguir inicia uma verificação de imagem para e especificada pelo resumo da imagem no repositório especificado. ``` aws ecr start-image-scan \ --repository-name sample-repo \ --image-id imageDigest=sha256:74b2c688c700ec95a93e478cdb959737c148df3fbf5ea706abe0318726e885e6 ``` Resultado: ``` { "registryId": "012345678910", "repositoryName": "sample-repo", "imageId": { "imageDigest": "sha256:74b2c688c700ec95a93e478cdb959737c148df3fbf5ea706abe0318726e885e6" }, "imageScanStatus": { "status": "IN_PROGRESS" } } ``` Para obter mais informações, consulte [Verificação de Imagens](https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html) no *Guia do Usuário do Amazon ECR*. + Para ver detalhes da API, consulte [StartImageScan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/start-image-scan.html) na *Referência de comandos da AWS CLI*. ### `start-lifecycle-policy-preview` O código de exemplo a seguir mostra como usar `start-lifecycle-policy-preview`. **AWS CLI** **Para criar uma política de ciclo de vida** O exemplo de `start-lifecycle-policy-preview` a seguir cria uma pré-visualização prévia da política de ciclo de vida definida por um arquivo JSON para o repositório especificado. ``` aws ecr start-lifecycle-policy-preview \ --repository-name "project-a/amazon-ecs-sample" \ --lifecycle-policy-text "file://policy.json" ``` Conteúdo de `policy.json`: ``` { "rules": [ { "rulePriority": 1, "description": "Expire images older than 14 days", "selection": { "tagStatus": "untagged", "countType": "sinceImagePushed", "countUnit": "days", "countNumber": 14 }, "action": { "type": "expire" } } ] } ``` Resultado: ``` { "registryId": "012345678910", "repositoryName": "project-a/amazon-ecs-sample", "lifecyclePolicyText": "{\n \"rules\": [\n {\n \"rulePriority\": 1,\n \"description\": \"Expire images older than 14 days\",\n \"selection\": {\n \"tagStatus\": \"untagged\",\n \"countType\": \"sinceImagePushed\",\n \"countUnit\": \"days\",\n \"countNumber\": 14\n },\n \"action\": {\n \"type\": \"expire\"\n }\n }\n ]\n}\n", "status": "IN_PROGRESS" } ``` + Para ver detalhes da API, consulte [StartLifecyclePolicyPreview](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/start-lifecycle-policy-preview.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como marcar um repositório** O exemplo `tag-resource` a seguir define uma tag com uma chave `Integ` e um valor `Stage` no repositório `hello-world`. ``` aws ecr tag-resource \ --resource-arn arn:aws:ecr:us-west-2:012345678910:repository/hello-world \ --tags Key=Stage,Value=Integ ``` Este comando não produz saída. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Como desmarcar um repositório** O exemplo `untag-resource` a seguir remove a tag com a chave `Stage` do repositório `hello-world`. ``` aws ecr untag-resource \ --resource-arn arn:aws:ecr:us-west-2:012345678910:repository/hello-world \ --tag-keys Stage ``` Este comando não produz saída. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `upload-layer-part` O código de exemplo a seguir mostra como usar `upload-layer-part`. **AWS CLI** **Como carregar uma parte da camada** O `upload-layer-part` a seguir carrega uma parte da camada de imagem no repositório `layer-test`. ``` aws ecr upload-layer-part \ --repository-name layer-test \ --upload-id 6cb64b8a-9378-0e33-2ab1-b780fab8a9e9 \ --part-first-byte 0 \ --part-last-byte 8323314 \ --layer-part-blob file:///var/lib/docker/image/overlay2/layerdb/sha256/ff986b10a018b48074e6d3a68b39aad8ccc002cdad912d4148c0f92b3729323e/layer.b64 ``` Resultado: ``` { "uploadId": "6cb64b8a-9378-0e33-2ab1-b780fab8a9e9", "registryId": "012345678910", "lastByteReceived": 8323314, "repositoryName": "layer-test" } ``` + Para ver detalhes da API, consulte [UploadLayerPart](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/upload-layer-part.html) na *Referência de comandos da AWS CLI*. # Exemplos públicos do Amazon ECR Public usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o Amazon ECR Public. *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 ### `batch-delete-image` O código de exemplo a seguir mostra como usar `batch-delete-image`. **AWS CLI** **Exemplo 1: para excluir uma imagem usando IDs de resumo de imagem, a imagem e todas as respectivas tags são excluídas em um repositório em um registro público** O exemplo de `batch-delete-image` a seguir exclui uma imagem especificando o respectivo resumo. ``` aws ecr-public batch-delete-image \ --repository-name project-a/nginx-web-app \ --image-ids imageDigest=sha256:b1f9deb5fe3711a3278379ebbcaefbc5d70a2263135db86bd27a0dae150546c2 ``` Resultado: ``` { "imageIds": [ { "imageDigest": "sha256:b1f9deb5fe3711a3278379ebbcaefbc5d70a2263135db86bd27a0dae150546c2", "imageTag": "latest" } ], "failures": [] } ``` Consulte mais informações em [Deleting an image in a public repository](https://docs.aws.amazon.com/AmazonECR/latest/public/public-image-delete.html) no *Guia do usuário do Amazon ECR Public*. **Exemplo 2: como excluir qualquer imagem especificando a tag associada à imagem que você deseja excluir do repositório** O exemplo de `batch-delete-image` a seguir exclui uma imagem especificando a tag associada ao repositório de imagens chamado `project-a/nginx-web-app` em um registro público. Se você tiver apenas uma tag e executar esse comando, a imagem será removida. Caso contrário, se você tiver várias tags para a mesma imagem, especifique uma para que somente a tag seja removida do repositório, não a imagem. ``` aws ecr-public batch-delete-image \ --repository-name project-a/nginx-web-app \ --image-ids imageTag=_temp ``` Resultado: ``` { "imageIds": [ { "imageDigest": "sha256:f7a86a0760e2f8d7eff07e515fc87bf4bac45c35376c06f9a280f15ecad6d7e0", "imageTag": "_temp" } ], "failures": [] } ``` Consulte mais informações em [Deleting an image in a public repository](https://docs.aws.amazon.com/AmazonECR/latest/public/public-image-delete.html) no *Guia do usuário do Amazon ECR Public*. **Exemplo 3: para excluir várias imagens, é possível especificar várias tags de imagem ou resumos de imagem na solicitação para um repositório em um registro público** O exemplo de `batch-delete-image` a seguir exclui várias imagens de um repositório chamado project-a/nginx-web-app especificando várias tags de imagem ou resumos de imagem na solicitação. ``` aws ecr-public batch-delete-image \ --repository-name project-a/nginx-web-app \ --image-ids imageTag=temp2.0 imageDigest=sha256:47ba980bc055353d9c0af89b1894f68faa43ca93856917b8406316be86f01278 ``` Resultado: ``` { "imageIds": [ { "imageDigest": "sha256:47ba980bc055353d9c0af89b1894f68faa43ca93856917b8406316be86f01278" }, { "imageDigest": "sha256:f7a86a0760e2f8d7eff07e515fc87bf4bac45c35376c06f9a280f15ecad6d7e0", "imageTag": "temp2.0" } ], "failures": [] } ``` Consulte mais informações em [Deleting an image in a public repository](https://docs.aws.amazon.com/AmazonECR/latest/public/public-image-delete.html) no *Guia do usuário do Amazon ECR Public*. **Exemplo 4: para excluir uma imagem entre contas da AWS usando os IDs imagedigest e registry-id, a imagem e todas as suas tags são excluídas em um repositório em um registro público** O exemplo de `batch-delete-image` a seguir exclui uma imagem especificando o resumo da imagem entre contas da AWS: ``` aws ecr-public batch-delete-image \ --registry-id 123456789098 \ --repository-name project-a/nginx-web-app \ --image-ids imageDigest=sha256:b1f9deb5fe3711a3278379ebbcaefbc5d70a2263135db86bd27a0dae150546c2 \ --region us-east-1 ``` Resultado: ``` { "imageIds": [ { "imageDigest": "sha256:b1f9deb5fe3711a3278379ebbcaefbc5d70a2263135db86bd27a0dae150546c2", "imageTag": "temp2.0" } ], "failures": [] } ``` Consulte mais informações em [Deleting an image in a public repository](https://docs.aws.amazon.com/AmazonECR/latest/public/public-image-delete.html) no *Guia do usuário do Amazon ECR Public*. + Para ver detalhes da API, consulte [BatchDeleteImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/batch-delete-image.html) na *Referência de comandos da AWS CLI*. ### `create-repository` O código de exemplo a seguir mostra como usar `create-repository`. **AWS CLI** **Exemplo 1: criar um repositório em um registro público** O exemplo de `create-repository` a seguir cria um repositório chamado project-a/nginx-web-app em um registro público. ``` aws ecr-public create-repository \ --repository-name project-a/nginx-web-app ``` Resultado: ``` { "repository": { "repositoryArn": "arn:aws:ecr-public::123456789012:repository/project-a/nginx-web-app", "registryId": "123456789012", "repositoryName": "project-a/nginx-web-app", "repositoryUri": "public.ecr.aws/public-registry-custom-alias/project-a/nginx-web-app", "createdAt": "2024-07-01T21:08:55.131000+00:00" }, "catalogData": {} } ``` Para obter mais informações, consulte [Criar um repositório público](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-create.html) no *Guia do usuário público do Amazon ECR*. **Exemplo 2: criar um repositório em um registro público com uma breve descrição do conteúdo do repositório, do sistema e da arquitetura operacional com os quais as imagens no repositório são compatíveis** O exemplo de `create-repository` a seguir cria um repositório chamado project-a/nginx-web-app em um registro público com uma breve descrição do conteúdo do repositório, do sistema e da arquitetura operacional com os quais as imagens no repositório são compatíveis. ``` aws ecr-public create-repository \ --repository-name project-a/nginx-web-app \ --catalog-data 'description=My project-a ECR Public Repository,architectures=ARM,ARM 64,x86,x86-64,operatingSystems=Linux' ``` Resultado: ``` { "repository": { "repositoryArn": "arn:aws:ecr-public::123456789012:repository/project-a/nginx-web-app", "registryId": "123456789012", "repositoryName": "project-a/nginx-web-app", "repositoryUri": "public.ecr.aws/public-registry-custom-alias/project-a/nginx-web-app", "createdAt": "2024-07-01T21:23:20.455000+00:00" }, "catalogData": { "description": "My project-a ECR Public Repository", "architectures": [ "ARM", "ARM 64", "x86", "x86-64" ], "operatingSystems": [ "Linux" ] } } ``` Para obter mais informações, consulte [Criar um repositório público](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-create.html) no *Guia do usuário público do Amazon ECR*. **Exemplo 3: criar um repositório em um registro público, junto com informações sobre tags, logoImageBlob, aboutText e usageText** O exemplo `create-repository` a seguir cria um repositório chamado project-a/nginx-web-app em um registro público, junto com informações sobre tags, logoImageBlob, aboutText e usageText. ``` aws ecr-public create-repository \ --cli-input-json file://myfile.json ``` Conteúdo de `myfile.json`: ``` { "repositoryName": "project-a/nginx-web-app", "catalogData": { "description": "My project-a ECR Public Repository", "architectures": [ "ARM", "ARM 64", "x86", "x86-64" ], "operatingSystems": [ "Linux" ], "logoImageBlob": "iVBORw0KGgoA<>ErkJggg==", "aboutText": "## Quick reference\n\nMaintained by: [the Amazon Linux Team](https://github.com/aws/amazon-linux-docker-images)\n\nWhere to get help: [the Docker Community Forums](https://forums.docker.com/), [the Docker Community Slack](https://dockr.ly/slack), or [Stack Overflow](https://stackoverflow.com/search?tab=newest&q=docker)\n\n## Supported tags and respective `dockerfile` links\n\n* [`2.0.20200722.0`, `2`, `latest`](https://github.com/amazonlinux/container-images/blob/03d54f8c4d522bf712cffd6c8f9aafba0a875e78/Dockerfile)\n* [`2.0.20200722.0-with-sources`, `2-with-sources`, `with-sources`](https://github.com/amazonlinux/container-images/blob/1e7349845e029a2e6afe6dc473ef17d052e3546f/Dockerfile)\n* [`2018.03.0.20200602.1`, `2018.03`, `1`](https://github.com/amazonlinux/container-images/blob/f10932e08c75457eeb372bf1cc47ea2a4b8e98c8/Dockerfile)\n* [`2018.03.0.20200602.1-with-sources`, `2018.03-with-sources`, `1-with-sources`](https://github.com/amazonlinux/container-images/blob/8c9ee491689d901aa72719be0ec12087a5fa8faf/Dockerfile)\n\n## What is Amazon Linux?\n\nAmazon Linux is provided by Amazon Web Services (AWS). It is designed to provide a stable, secure, and high-performance execution environment for applications running on Amazon EC2. The full distribution includes packages that enable easy integration with AWS, including launch configuration tools and many popular AWS libraries and tools. AWS provides ongoing security and maintenance updates to all instances running Amazon Linux.\n\nThe Amazon Linux container image contains a minimal set of packages. To install additional packages, [use `yum`](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/managing-software.html).\n\nAWS provides two versions of Amazon Linux: [Amazon Linux 2](https://aws.amazon.com/amazon-linux-2/) and [Amazon Linux AMI](https://aws.amazon.com/amazon-linux-ami/).\n\nFor information on security updates for Amazon Linux, please refer to [Amazon Linux 2 Security Advisories](https://alas.aws.amazon.com/alas2.html) and [Amazon Linux AMI Security Advisories](https://alas.aws.amazon.com/). Note that Docker Hub's vulnerability scanning for Amazon Linux is currently based on RPM versions, which does not reflect the state of backported patches for vulnerabilities.\n\n## Where can I run Amazon Linux container images?\n\nYou can run Amazon Linux container images in any Docker based environment. Examples include, your laptop, in Amazon EC2 instances, and Amazon ECS clusters.\n\n## License\n\nAmazon Linux is available under the [GNU General Public License, version 2.0](https://github.com/aws/amazon-linux-docker-images/blob/master/LICENSE). Individual software packages are available under their own licenses; run `rpm -qi [package name]` or check `/usr/share/doc/[package name]-*` and `/usr/share/licenses/[package name]-*` for details.\n\nAs with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).\n\nSome additional license information which was able to be auto-detected might be found in [the `repo-info` repository's `amazonlinux/` directory](https://github.com/docker-library/repo-info/tree/master/repos/amazonlinux).\n\n## Security\n\nFor information on security updates for Amazon Linux, please refer to [Amazon Linux 2 Security Advisories](https://alas.aws.amazon.com/alas2.html) and [Amazon Linux AMI Security Advisories](https://alas.aws.amazon.com/). Note that Docker Hub's vulnerability scanning for Amazon Linux is currently based on RPM versions, which does not reflect the state of backported patches for vulnerabilities.", "usageText": "## Supported architectures\n\namd64, arm64v8\n\n## Where can I run Amazon Linux container images?\n\nYou can run Amazon Linux container images in any Docker based environment. Examples include, your laptop, in Amazon EC2 instances, and ECS clusters.\n\n## How do I install a software package from Extras repository in Amazon Linux 2?\n\nAvailable packages can be listed with the `amazon-linux-extras` command. Packages can be installed with the `amazon-linux-extras install ` command. Example: `amazon-linux-extras install rust1`\n\n## Will updates be available for Amazon Linux containers?\n\nSimilar to the Amazon Linux images for Amazon EC2 and on-premises use, Amazon Linux container images will get ongoing updates from Amazon in the form of security updates, bug fix updates, and other enhancements. Security bulletins for Amazon Linux are available at https://alas.aws.amazon.com/\n\n## Will AWS Support the current version of Amazon Linux going forward?\n\nYes; in order to avoid any disruption to your existing applications and to facilitate migration to Amazon Linux 2, AWS will provide regular security updates for Amazon Linux 2018.03 AMI and container image for 2 years after the final LTS build is announced. You can also use all your existing support channels such as AWS Support and Amazon Linux Discussion Forum to continue to submit support requests." }, "tags": [ { "Key": "Name", "Value": "project-a/nginx-web-app" }, { "Key": "Environment", "Value": "Prod" } ] } ``` Resultado: ``` { "repository": { "repositoryArn": "arn:aws:ecr-public::123456789012:repository/project-a/nginx-web-app", "registryId": "123456789012", "repositoryName": "project-a/nginx-web-app", "repositoryUri": "public.ecr.aws/public-registry-custom-alias/project-a/nginx-web-app", "createdAt": "2024-07-01T21:53:05.749000+00:00" }, "catalogData": { "description": "My project-a ECR Public Repository", "architectures": [ "ARM", "ARM 64", "x86", "x86-64" ], "operatingSystems": [ "Linux" ], "logoUrl": "https://d3g9o9u8re44ak.cloudfront.net/logo/23861450-4b9b-403c-9a4c-7aa0ef140bb8/2f9bf5a7-a32f-45b4-b5cd-c5770a35e6d7.png", "aboutText": "## Quick reference\n\nMaintained by: [the Amazon Linux Team](https://github.com/aws/amazon-linux-docker-images)\n\nWhere to get help: [the Docker Community Forums](https://forums.docker.com/), [the Docker Community Slack](https://dockr.ly/slack), or [Stack Overflow](https://stackoverflow.com/search?tab=newest&q=docker)\n\n## Supported tags and respective `dockerfile` links\n\n* [`2.0.20200722.0`, `2`, `latest`](https://github.com/amazonlinux/container-images/blob/03d54f8c4d522bf712cffd6c8f9aafba0a875e78/Dockerfile)\n* [`2.0.20200722.0-with-sources`, `2-with-sources`, `with-sources`](https://github.com/amazonlinux/container-images/blob/1e7349845e029a2e6afe6dc473ef17d052e3546f/Dockerfile)\n* [`2018.03.0.20200602.1`, `2018.03`, `1`](https://github.com/amazonlinux/container-images/blob/f10932e08c75457eeb372bf1cc47ea2a4b8e98c8/Dockerfile)\n* [`2018.03.0.20200602.1-with-sources`, `2018.03-with-sources`, `1-with-sources`](https://github.com/amazonlinux/container-images/blob/8c9ee491689d901aa72719be0ec12087a5fa8faf/Dockerfile)\n\n## What is Amazon Linux?\n\nAmazon Linux is provided by Amazon Web Services (AWS). It is designed to provide a stable, secure, and high-performance execution environment for applications running on Amazon EC2. The full distribution includes packages that enable easy integration with AWS, including launch configuration tools and many popular AWS libraries and tools. AWS provides ongoing security and maintenance updates to all instances running Amazon Linux.\n\nThe Amazon Linux container image contains a minimal set of packages. To install additional packages, [use `yum`](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/managing-software.html).\n\nAWS provides two versions of Amazon Linux: [Amazon Linux 2](https://aws.amazon.com/amazon-linux-2/) and [Amazon Linux AMI](https://aws.amazon.com/amazon-linux-ami/).\n\nFor information on security updates for Amazon Linux, please refer to [Amazon Linux 2 Security Advisories](https://alas.aws.amazon.com/alas2.html) and [Amazon Linux AMI Security Advisories](https://alas.aws.amazon.com/). Note that Docker Hub's vulnerability scanning for Amazon Linux is currently based on RPM versions, which does not reflect the state of backported patches for vulnerabilities.\n\n## Where can I run Amazon Linux container images?\n\nYou can run Amazon Linux container images in any Docker based environment. Examples include, your laptop, in Amazon EC2 instances, and Amazon ECS clusters.\n\n## License\n\nAmazon Linux is available under the [GNU General Public License, version 2.0](https://github.com/aws/amazon-linux-docker-images/blob/master/LICENSE). Individual software packages are available under their own licenses; run `rpm -qi [package name]` or check `/usr/share/doc/[package name]-*` and `/usr/share/licenses/[package name]-*` for details.\n\nAs with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).\n\nSome additional license information which was able to be auto-detected might be found in [the `repo-info` repository's `amazonlinux/` directory](https://github.com/docker-library/repo-info/tree/master/repos/amazonlinux).\n\n## Security\n\nFor information on security updates for Amazon Linux, please refer to [Amazon Linux 2 Security Advisories](https://alas.aws.amazon.com/alas2.html) and [Amazon Linux AMI Security Advisories](https://alas.aws.amazon.com/). Note that Docker Hub's vulnerability scanning for Amazon Linux is currently based on RPM versions, which does not reflect the state of backported patches for vulnerabilities.", "usageText": "## Supported architectures\n\namd64, arm64v8\n\n## Where can I run Amazon Linux container images?\n\nYou can run Amazon Linux container images in any Docker based environment. Examples include, your laptop, in Amazon EC2 instances, and ECS clusters.\n\n## How do I install a software package from Extras repository in Amazon Linux 2?\n\nAvailable packages can be listed with the `amazon-linux-extras` command. Packages can be installed with the `amazon-linux-extras install ` command. Example: `amazon-linux-extras install rust1`\n\n## Will updates be available for Amazon Linux containers?\n\nSimilar to the Amazon Linux images for Amazon EC2 and on-premises use, Amazon Linux container images will get ongoing updates from Amazon in the form of security updates, bug fix updates, and other enhancements. Security bulletins for Amazon Linux are available at https://alas.aws.amazon.com/\n\n## Will AWS Support the current version of Amazon Linux going forward?\n\nYes; in order to avoid any disruption to your existing applications and to facilitate migration to Amazon Linux 2, AWS will provide regular security updates for Amazon Linux 2018.03 AMI and container image for 2 years after the final LTS build is announced. You can also use all your existing support channels such as AWS Support and Amazon Linux Discussion Forum to continue to submit support requests." } } ``` Para obter mais informações, consulte [Criar um repositório público](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-create.html) no *Guia do usuário público do Amazon ECR* e [Dados do catálogo do repositório](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-catalog-data.html) no *Guia do usuário público do Amazon ECR*. + Para ver detalhes da API, consulte [CreateRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/create-repository.html) na *Referência de comandos da AWS CLI*. ### `delete-repository-policy` O código de exemplo a seguir mostra como usar `delete-repository-policy`. **AWS CLI** **Como excluir uma política de repositório em um registro público** O exemplo de `delete-repository-policy` a seguir exclui a política de repositório do repositório do ECR Public em sua conta da AWS. ``` aws ecr-public delete-repository-policy \ --repository-name project-a/nginx-web-app \ --region us-east-1 ``` Resultado: ``` { "registryId": "123456789012", "repositoryName": "project-a/nginx-web-app", "policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"AllowPush\",\n \"Effect\" : \"Allow\",\n \"Principal\" : {\n \"AWS\" : [ \"arn:aws:iam:"123456789012":user/eksuser1\", \"arn:aws:iam:"123456789012":user/admin\" ]\n },\n \"Action\" : [ \"ecr-public:BatchCheckLayerAvailability\", \"ecr-public:PutImage\", \"ecr-public:InitiateLayerUpload\", \"ecr-public:UploadLayerPart\", \"ecr-public:CompleteLayerUpload\" ]\n } ]\n}" } ``` Consulte mais informações em [Deleting a public repository policy statement](https://docs.aws.amazon.com/AmazonECR/latest/public/delete-public-repository-policy.html) no *Guia do usuário do Amazon ECR Public*. + Para ver detalhes da API, consulte [DeleteRepositoryPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/delete-repository-policy.html) na *Referência de comandos da AWS CLI*. ### `delete-repository` O código de exemplo a seguir mostra como usar `delete-repository`. **AWS CLI** **Para excluir um repositório em um registro público** O exemplo `delete-repository` a seguir exclui um repositório chamado `project-a/nginx-web-app` do seu registro público. ``` aws ecr-public delete-repository \ --repository-name project-a/nginx-web-app ``` Resultado: ``` { "repository": { "repositoryArn": "arn:aws:ecr-public::123456789012:repository/project-a/nginx-web-app", "registryId": "123456789012", "repositoryName": "project-a/nginx-web-app", "repositoryUri": "public.ecr.aws/public-registry-custom-alias/project-a/nginx-web-app", "createdAt": "2024-07-01T22:14:50.103000+00:00" } } ``` Consulte mais informações em [Deleting a public repository](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-delete.html) no *Guia do usuário do Amazon ECR Public*. + Para ver detalhes da API, consulte [DeleteRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/delete-repository.html) na *Referência de comandos da AWS CLI*. ### `describe-image-tags` O código de exemplo a seguir mostra como usar `describe-image-tags`. **AWS CLI** **Exemplo 1: como descrever os detalhes da tag de imagem no repositório público** O exemplo de `describe-image-tags` a seguir descreve as tags de imagem no repositório `project-a/nginx-web-app` de amostra. ``` aws ecr-public describe-image-tags \ --repository-name project-a/nginx-web-app \ --region us-east-1 ``` Resultado: ``` { "imageTagDetails": [ { "imageTag": "latest", "createdAt": "2024-07-10T22:29:00-05:00", "imageDetail": { "imageDigest": "sha256:b1f9deb5fe3711a3278379ebbcaefbc5d70a2263135db86bd27a0dae150546c2", "imageSizeInBytes": 121956548, "imagePushedAt": "2024-07-10T22:29:00-05:00", "imageManifestMediaType": "application/vnd.docker.distribution.manifest.v2+json", "artifactMediaType": "application/vnd.docker.container.image.v1+json" } } ] } ``` + Consulte detalhes da API em [DescribeImageTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/describe-image-tags.html) na *Referência de comandos da AWS CLI*. ### `describe-images` O código de exemplo a seguir mostra como usar `describe-images`. **AWS CLI** **Exemplo 1: como descrever imagens em um repositório de registro público** O exemplo de `describe-images` a seguir descreve imagesDetails em um repositório chamado `project-a/nginx-web-app` em um registro público. ``` aws ecr-public describe-images \ --repository-name project-a/nginx-web-app \ --region us-east-1 ``` Resultado: ``` { "imageDetails": [ { "registryId": "123456789012", "repositoryName": "project-a/nginx-web-app", "imageDigest": "sha256:0d8c93e72e82fa070d49565c00af32abbe8ddfd7f75e39f4306771ae0628c7e8", "imageTags": [ "temp1.0" ], "imageSizeInBytes": 123184716, "imagePushedAt": "2024-07-23T11:32:49-05:00", "imageManifestMediaType": "application/vnd.docker.distribution.manifest.v2+json", "artifactMediaType": "application/vnd.docker.container.image.v1+json" }, { "registryId": "123456789012", "repositoryName": "project-a/nginx-web-app", "imageDigest": "sha256:b1f9deb5fe3711a3278379ebbcaefbc5d70a2263135db86bd27a0dae150546c2", "imageTags": [ "temp2.0" ], "imageSizeInBytes": 121956548, "imagePushedAt": "2024-07-23T11:39:38-05:00", "imageManifestMediaType": "application/vnd.docker.distribution.manifest.v2+json", "artifactMediaType": "application/vnd.docker.container.image.v1+json" }, { "registryId": "123456789012", "repositoryName": "project-a/nginx-web-app", "imageDigest": "sha256:f7a86a0760e2f8d7eff07e515fc87bf4bac45c35376c06f9a280f15ecad6d7e0", "imageTags": [ "temp3.0", "latest" ], "imageSizeInBytes": 232108879, "imagePushedAt": "2024-07-22T00:54:34-05:00", "imageManifestMediaType": "application/vnd.docker.distribution.manifest.v2+json", "artifactMediaType": "application/vnd.docker.container.image.v1+json" } ] } ``` Consulte mais informações em [Describe an image in a public repository](https://docs.aws.amazon.com/AmazonECR/latest/public/docker-push-multi-architecture-image.html) no *Amazon ECR Public*. **Exemplo 2: como descrever imagens do repositório classificando imageTags e imagePushedAt** O exemplo de `describe-images` a seguir descreve imagens em um repositório chamado project-a/nginx-web-app em um registro público. ``` aws ecr-public describe-images \ --repository-name project-a/nginx-web-app \ --query 'sort_by(imageDetails,& imagePushedAt)[*].imageTags[*]' \ --output text ``` Resultado: ``` temp3.0 latest temp1.0 temp2.0 ``` **Exemplo 3: como descrever imagens do repositório para gerar as duas últimas tags de imagem enviadas no repositório** O exemplo de `describe-images` a seguir obtém detalhes de imagetags do repositório chamado `project-a/nginx-web-app` em um registro público e consulta o resultado para exibir somente os dois primeiros registros. ``` aws ecr-public describe-images \ --repository-name project-a/nginx-web-app \ --query 'sort_by(imageDetails,& imagePushedAt)[*].imageTags[*] | [0:2]' \ --output text ``` Resultado: ``` temp3.0 latest temp1.0 ``` + Consulte detalhes da API em [DescribeImages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/describe-images.html) na *Referência de comandos da AWS CLI*. ### `describe-registries` O código de exemplo a seguir mostra como usar `describe-registries`. **AWS CLI** **Como descrever todos os registros em um registro público** O exemplo de `describe-registries` a seguir descreve todos os registros na sua conta. ``` aws ecr-public describe-registries ``` Resultado: ``` { "registries": [ { "registryId": "123456789012", "registryArn": "arn:aws:ecr-public::123456789012:registry/123456789012", "registryUri": "public.ecr.aws/publicregistrycustomalias", "verified": false, "aliases": [ { "name": "publicregistrycustomalias", "status": "ACTIVE", "primaryRegistryAlias": true, "defaultRegistryAlias": true } ] } ] } ``` + Consulte detalhes da API em [DescribeRegistries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/describe-registries.html) na *Referência de comandos da AWS CLI*. ### `describe-repository` O código de exemplo a seguir mostra como usar `describe-repository`. **AWS CLI** **Exemplo 1: como descrever um repositório em um registro público** O exemplo de `describe-repositories` a seguir cria um repositório chamado `project-a/nginx-web-app` em um registro público. ``` aws ecr-public describe-repositories \ --repository-name project-a/nginx-web-app ``` Resultado: ``` { "repositories": [ { "repositoryArn": "arn:aws:ecr-public::123456789012:repository/project-a/nginx-web-app", "registryId": "123456789012", "repositoryName": "project-a/nginx-web-app", "repositoryUri": "public.ecr.aws/public-registry-custom-alias/project-a/nginx-web-app", "createdAt": "2024-07-07T00:07:56.526000-05:00" } ] } ``` **Exemplo 2: como descrever todos os repositórios em um registro público em uma tabela** O exemplo de `describe-repositories` a seguir descreve todos os repositórios em um registro público e, depois, exibe os nomes dos repositórios em formato de tabela. ``` aws ecr-public describe-repositories \ --region us-east-1 \ --output table \ --query "repositories[*].repositoryName" ``` Resultado: ``` ----------------------------- | DescribeRepositories | +---------------------------+ | project-a/nginx-web-app | | nginx | | myfirstrepo1 | | helm-test-chart | | test-ecr-public | | nginx-web-app | | sample-repo | +---------------------------+ ``` + Para ver detalhes da API, consulte [DescribeRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/describe-repository.html) na *Referência de comandos da AWS CLI*. ### `get-authorization-token` O código de exemplo a seguir mostra como usar `get-authorization-token`. **AWS CLI** **Exemplo 1: como recuperar um token de autorização para qualquer registro público do Amazon ECR ao qual a entidade principal do IAM tenha acesso** O exemplo de `get-authorization-token` a seguir obtém um token de autorização com a AWS CLI e o define como uma variável de ambiente. ``` aws ecr-public get-authorization-token \ --region us-east-1 ``` Resultado: ``` { "authorizationData": { "authorizationToken": "QVdTOmV5SndZWGxzYjJKJFHDSFKJHERWUY65IOU36TRYEGFNSDLRIUOTUYTHJKLDFGOcmFUQk9OSFV2UVV4a0x6Sm1ZV0Z6TDFndlZtUjJSVmgxVEVObU9IZEdTWEZxU210c1JUQm5RWGxOUVV4NlNFUnROWG92ZWtGbWJFUjRkbWMyV0U5amFpczRNWGxTVkM5Tk5qWkVUM2RDYm05TVJqSkxjV3BsUVZvMmFYSm5iV1ZvVFdGSVRqVlFMMHN4VnpsTGVXbDFRWGRoTmpsbWFuQllhbVl6TkdGaGMwUjJha2xsYUhscWRscHZTRUpFVkVnNVQwNUdOVFpPY2xZclVFNVFVWGRSVFZvd04xUkhjVGxZZFVkQ1ZFZHBPRUptUzBVclYxQldMMjVMVkRsd2VFVlNSa1EzTWpWSlIxRkVWakJGZFZOVWEzaFBSVk5FWWpSc1lWZHZWMHBSYmxaMlJYWmhZekpaWVVOeFppdFlUa2xKU1RCdFUwdElVbXRJYlhGRk1WaFhNVTVRTkdwc1FYRlVNVWxZZUhkV05Xa3ZXWGd3ZUVZMWIyeE5VRU5QZEdSaWRHOU9lakZOZVdwTVZEUkNRVzlvYzNKSlpsRXhhR2cwWjJwRVJFVjNWalEzYjNCUmRIcEZUR1pYU1Rsc1kxSlNNbU5hUW5wRE1tOUpRMHR5Y1hkeGNXNDVMMmx4Um5GUlVGQnhjMVpQZG5WYUswOW9SQ3RPY0hwSlRsUk5lVXQyY0c1b1FsQjVZVEprVmtSdmJsQklOM05RU3pkNmQydERhMkZ5VmxSRmFVUndWVlE1ZGtsVWFXUkJWMFZEWVhoSFdXTk5VMXBTYTFreVRHZEVlVVZ0ZFRWRk4xTTVjRXBDUjBRMlYyTkdPVWhGWkVweVVGcEVaRFJxZUVablkwNXFaamh5YkVKWmJGSTNOVzFXSzFjdllXSTVTMWx2YUZacksxSnJWSFJ0Wml0T1NFSnpWVFZvV204eVFYbzFWRU5SYjNaR01Va3hPR3h2TWxkNVJsSmpUbTVSTjNjemJsUkdVRlZKVDBjeE9VeHlXVEpGVFRSS2NWbFdkVEJrV0VreFVsSktXbkpCVGtsMFdVZEJOMjltWjFFNGVHRktNbGRuWlVoUlNXNXdZV3A0VjI5M2FYZGljbE5tZGpkQ1ZYTmhOVFUyTDBzeVpteDBka0pUTVdkNGJ6TkxkSEJDYml0cE0waGhTbVpEZEZkQ00yOU1TM1pXTDNSVFlWaFpWelZXVWxjNFRXNXdhR3BhUmpoU1FuWnFkRlJMVW5abGRYRlNjVVJKZDBaSFpXUTRabEZUTUdOTVQwcFFkVXAyYjA5Tk9UaFlZMjEwVnpFMlpXdE9hMnBWV0hST1owUkpVV3R1VFU1dGJXWjNNVGc0VTAxUlNHZE9TbXRMY2tWYWJVeFljVVk0ZWpsTFdWWlRNbEZMVDJkMk1FaFBTMDl5YzJSM1NqTlplRGhUWVVOQlJGWnRlbkU1WTBKVFdqTktSR05WTkd0RGNEVjZNalJHVXpkVk9HTnVSa2xLUVd4SVJDODJXbGcyYldGemJVczJPRVp6TDBoNFMwWkRUMmdyYldGa1QwWjVhMlZQTm5SQ1l6QkpNbFpyVUhSaGVIbFVOR296VjFGVlQyMHpNeTlPWVVoSk1FdDBWalZFU2pneU5rcHNLemQxZDNwcVp6RlNja3AwVm10VU0yRnRWWGMzZDJnMFduSnFjVXczWTBjclNXeHFUVlUyVkZwWGNWY3ZSV0V6WW1oT2JIRklZVlJHU1RrMGEyOVJiMHBPVUhORk9FdERjbFJZY0daS2VVdHRZa2x5YjFORE4zSkJaWEJPZUU5eGR6WnhZMlY1WXprM1JtSkZhVFZFYkVFck5EUk9ZMWRyVEVNd1dqa2lMQ0prWVhSaGEyVjVJam9pWlhsS1VWSkdaMmxQYVVwV1ZXeENhVk5YVm14WFdFWk5VMjFrV21SRE9YaGFhWFF4VkhwS1MyTkljSHBVUms0MFlWaHNTbUpIYUhsWFZHdDZZVWhqZDFKRmFETldNbFYyWTJ0cmVVMUlTbHBWUjJONFRURlJNMDlHYUd4U01uaHVWRVJzUWxaV1pGZFJibkJLV1RCYU5HTXpUakpXTUhoWFRrWndhRTVyTVVwVFZFSkdWV3RzTUZaVVpEQlRSVGxyVkVkb2FGUlVVWHBaTVhCSFQxWmFOVlJxU20xaVZXUnVTM3BaTlZaV2NIcFdWMlJGVkcwMVRHSXdSakpXUnpoNlVsUm5kbUpzUmpGT2FUazFWVzFTY0dWR1FtOVdiVEZoVmpKc1NWRllhRmRTUkZwc1V6SkdSbUpWYkhCVlNFbDJWVzB4Ym1OVk1IWmFhelZ3WkZoa1FtVnFUa3BpTTJoTVRWVk9jMVo2V2t4aWJFWnJWRVUxVW1ONlp6QldWVFZPWW14c01sZFlZekprUjFwVFkxaE9kRnBXWkhaVFZWcGhWa2MxU2xWRlVtdFRiWE16WWpOVmVrNXFSa2RVTTJSd1QwaGtXbVJIVVhsbGJYQkRaRlp2ZGxvd1ZqWmlNbEl4Vkc1T2FtSldjRU5VU0ZVd1kwZDRjbU14WkhaVVYwNTRaRzV2TWxSVlVsQmpiSEJPVkc1VmVsZEZPVzVYYkVwWlUyNWtVbGRZWkZWaVdFWlNUVzF3VFZSSVFraE9XRnBwWVZoak0xUnJXak5OYm04eFpEQk9XbEZzYkhSTmEyaHpaRmRTUTJORVFUQlpWMk01VUZOSmMwbHJiRUpTUTBrMlNXNUZlbHA2U1RGVVZXeFVZekIwYVU5RWFEVmtiRVpzVVZWc2QxbHJWbmxOYW13MVZWaG9UazVzVWpWbFJHaDZZMjFHVkZVeFFubFZXRTVLVGpCMGFXSlZNWGhpUjBwTVlUSTVNRTVVYXpCTE0wVnlWakF4VG1WSE5VcGtSa0pRVld4V1UwOVdVWGhqTVc4eVZraFdlVnA2VGsxV01tUnhVV3Q0ZEdGcVRsUk5hMnN5V2tSV2FtUkdVakZqVm5CUFVrUlNjR0pHUm1GbGFscDRXV2x6Y2xFd1VYcGhSRnBZVmtaU2FVNXVSVFZYYlVaVFpXdHdkVmRZVGpaVGEyaDBWMnhDVlU0elZrWlRSRUpIVlVWa2MwNVlhRFZsUkVwelQwWkNSbE5WY0ZGWFNFWXhaVmMxVEZsVE9VeFdhMGt4V1ROS1Rrd3pXazFpYkhCdFVrUldWRlJHVlhaTmJVazBZbFZzUkV3d2N6UldSV2MxVDBWa05tSXpiM2hXVms1V1ZtMDFiRkZUT1hoUFJVcHpUMGRzU2xaSVJrTkxNVTVFWWtaa05WWnViRmRYVjJRd1RXcG5kMVJWUmpCa1JYQkdZVlYwZFZNeU1VVlpWVTVQV25wa1ExZHFVbE5sUjBaRVlWVTFXbVZwY3pSTE1HTTFVbFZGTlZwRll6UlRSMVoxVFcxb05XTnJkRUpWZWxsM1RETmplbUV4WkdGU1JsWm9ZVVpzZEdWR2JFTlVNblJYVkRCNE5HUXlkRXhaTWxKTlYxZDBWRTB5YUZwaFJsazFVMGR3Y0ZGVk9YaGxhekV6VVZRd09VbHVNRDBpTENKMlpYSnphVzl1SWpvaU15SXNJblI1Y0dVaU9pSkVRVlJCWDB0RldTSXNJbVY0Y0dseVlYUnBiMjRpT2pFM01qRTVOVGMzTmpKOQ==", "expiresAt": "2024-07-25T21:37:26.301000-04:00" } } ``` Consulte mais informações em [Amazon ECR public registries](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#registry_auth_http) no *Amazon ECR Public*. **Exemplo 2: como recuperar um token de autorização para qualquer registro público do Amazon ECR ao qual a entidade principal do IAM tenha acesso** O exemplo de `get-authorization-token` a seguir obtém um token de autorização com a AWS CLI e o define como uma variável de ambiente. ``` aws ecr-public get-authorization-token \ --region us-east-1 \ --output=text \ --query 'authorizationData.authorizationToken' ``` Resultado: ``` QVdTOmV5SndZWGxzYjJKJFHDSFKJHERWUY65IOU36TRYEGFNSDLRIUOTUYTHJKLDFGOcmFUQk9OSFV2UVV4a0x6Sm1ZV0Z6TDFndlZtUjJSVmgxVEVObU9IZEdTWEZxU210c1JUQm5RWGxOUVV4NlNFUnROWG92ZWtGbWJFUjRkbWMyV0U5amFpczRNWGxTVkM5Tk5qWkVUM2RDYm05TVJqSkxjV3BsUVZvMmFYSm5iV1ZvVFdGSVRqVlFMMHN4VnpsTGVXbDFRWGRoTmpsbWFuQllhbVl6TkdGaGMwUjJha2xsYUhscWRscHZTRUpFVkVnNVQwNUdOVFpPY2xZclVFNVFVWGRSVFZvd04xUkhjVGxZZFVkQ1ZFZHBPRUptUzBVclYxQldMMjVMVkRsd2VFVlNSa1EzTWpWSlIxRkVWakJGZFZOVWEzaFBSVk5FWWpSc1lWZHZWMHBSYmxaMlJYWmhZekpaWVVOeFppdFlUa2xKU1RCdFUwdElVbXRJYlhGRk1WaFhNVTVRTkdwc1FYRlVNVWxZZUhkV05Xa3ZXWGd3ZUVZMWIyeE5VRU5QZEdSaWRHOU9lakZOZVdwTVZEUkNRVzlvYzNKSlpsRXhhR2cwWjJwRVJFVjNWalEzYjNCUmRIcEZUR1pYU1Rsc1kxSlNNbU5hUW5wRE1tOUpRMHR5Y1hkeGNXNDVMMmx4Um5GUlVGQnhjMVpQZG5WYUswOW9SQ3RPY0hwSlRsUk5lVXQyY0c1b1FsQjVZVEprVmtSdmJsQklOM05RU3pkNmQydERhMkZ5VmxSRmFVUndWVlE1ZGtsVWFXUkJWMFZEWVhoSFdXTk5VMXBTYTFreVRHZEVlVVZ0ZFRWRk4xTTVjRXBDUjBRMlYyTkdPVWhGWkVweVVGcEVaRFJxZUVablkwNXFaamh5YkVKWmJGSTNOVzFXSzFjdllXSTVTMWx2YUZacksxSnJWSFJ0Wml0T1NFSnpWVFZvV204eVFYbzFWRU5SYjNaR01Va3hPR3h2TWxkNVJsSmpUbTVSTjNjemJsUkdVRlZKVDBjeE9VeHlXVEpGVFRSS2NWbFdkVEJrV0VreFVsSktXbkpCVGtsMFdVZEJOMjltWjFFNGVHRktNbGRuWlVoUlNXNXdZV3A0VjI5M2FYZGljbE5tZGpkQ1ZYTmhOVFUyTDBzeVpteDBka0pUTVdkNGJ6TkxkSEJDYml0cE0waGhTbVpEZEZkQ00yOU1TM1pXTDNSVFlWaFpWelZXVWxjNFRXNXdhR3BhUmpoU1FuWnFkRlJMVW5abGRYRlNjVVJKZDBaSFpXUTRabEZUTUdOTVQwcFFkVXAyYjA5Tk9UaFlZMjEwVnpFMlpXdE9hMnBWV0hST1owUkpVV3R1VFU1dGJXWjNNVGc0VTAxUlNHZE9TbXRMY2tWYWJVeFljVVk0ZWpsTFdWWlRNbEZMVDJkMk1FaFBTMDl5YzJSM1NqTlplRGhUWVVOQlJGWnRlbkU1WTBKVFdqTktSR05WTkd0RGNEVjZNalJHVXpkVk9HTnVSa2xLUVd4SVJDODJXbGcyYldGemJVczJPRVp6TDBoNFMwWkRUMmdyYldGa1QwWjVhMlZQTm5SQ1l6QkpNbFpyVUhSaGVIbFVOR296VjFGVlQyMHpNeTlPWVVoSk1FdDBWalZFU2pneU5rcHNLemQxZDNwcVp6RlNja3AwVm10VU0yRnRWWGMzZDJnMFduSnFjVXczWTBjclNXeHFUVlUyVkZwWGNWY3ZSV0V6WW1oT2JIRklZVlJHU1RrMGEyOVJiMHBPVUhORk9FdERjbFJZY0daS2VVdHRZa2x5YjFORE4zSkJaWEJPZUU5eGR6WnhZMlY1WXprM1JtSkZhVFZFYkVFck5EUk9ZMWRyVEVNd1dqa2lMQ0prWVhSaGEyVjVJam9pWlhsS1VWSkdaMmxQYVVwV1ZXeENhVk5YVm14WFdFWk5VMjFrV21SRE9YaGFhWFF4VkhwS1MyTkljSHBVUms0MFlWaHNTbUpIYUhsWFZHdDZZVWhqZDFKRmFETldNbFYyWTJ0cmVVMUlTbHBWUjJONFRURlJNMDlHYUd4U01uaHVWRVJzUWxaV1pGZFJibkJLV1RCYU5HTXpUakpXTUhoWFRrWndhRTVyTVVwVFZFSkdWV3RzTUZaVVpEQlRSVGxyVkVkb2FGUlVVWHBaTVhCSFQxWmFOVlJxU20xaVZXUnVTM3BaTlZaV2NIcFdWMlJGVkcwMVRHSXdSakpXUnpoNlVsUm5kbUpzUmpGT2FUazFWVzFTY0dWR1FtOVdiVEZoVmpKc1NWRllhRmRTUkZwc1V6SkdSbUpWYkhCVlNFbDJWVzB4Ym1OVk1IWmFhelZ3WkZoa1FtVnFUa3BpTTJoTVRWVk9jMVo2V2t4aWJFWnJWRVUxVW1ONlp6QldWVFZPWW14c01sZFlZekprUjFwVFkxaE9kRnBXWkhaVFZWcGhWa2MxU2xWRlVtdFRiWE16WWpOVmVrNXFSa2RVTTJSd1QwaGtXbVJIVVhsbGJYQkRaRlp2ZGxvd1ZqWmlNbEl4Vkc1T2FtSldjRU5VU0ZVd1kwZDRjbU14WkhaVVYwNTRaRzV2TWxSVlVsQmpiSEJPVkc1VmVsZEZPVzVYYkVwWlUyNWtVbGRZWkZWaVdFWlNUVzF3VFZSSVFraE9XRnBwWVZoak0xUnJXak5OYm04eFpEQk9XbEZzYkhSTmEyaHpaRmRTUTJORVFUQlpWMk01VUZOSmMwbHJiRUpTUTBrMlNXNUZlbHA2U1RGVVZXeFVZekIwYVU5RWFEVmtiRVpzVVZWc2QxbHJWbmxOYW13MVZWaG9UazVzVWpWbFJHaDZZMjFHVkZVeFFubFZXRTVLVGpCMGFXSlZNWGhpUjBwTVlUSTVNRTVVYXpCTE0wVnlWakF4VG1WSE5VcGtSa0pRVld4V1UwOVdVWGhqTVc4eVZraFdlVnA2VGsxV01tUnhVV3Q0ZEdGcVRsUk5hMnN5V2tSV2FtUkdVakZqVm5CUFVrUlNjR0pHUm1GbGFscDRXV2x6Y2xFd1VYcGhSRnBZVmtaU2FVNXVSVFZYYlVaVFpXdHdkVmRZVGpaVGEyaDBWMnhDVlU0elZrWlRSRUpIVlVWa2MwNVlhRFZsUkVwelQwWkNSbE5WY0ZGWFNFWXhaVmMxVEZsVE9VeFdhMGt4V1ROS1Rrd3pXazFpYkhCdFVrUldWRlJHVlhaTmJVazBZbFZzUkV3d2N6UldSV2MxVDBWa05tSXpiM2hXVms1V1ZtMDFiRkZUT1hoUFJVcHpUMGRzU2xaSVJrTkxNVTVFWWtaa05WWnViRmRYVjJRd1RXcG5kMVJWUmpCa1JYQkdZVlYwZFZNeU1VVlpWVTVQV25wa1ExZHFVbE5sUjBaRVlWVTFXbVZwY3pSTE1HTTFVbFZGTlZwRll6UlRSMVoxVFcxb05XTnJkRUpWZWxsM1RETmplbUV4WkdGU1JsWm9ZVVpzZEdWR2JFTlVNblJYVkRCNE5HUXlkRXhaTWxKTlYxZDBWRTB5YUZwaFJsazFVMGR3Y0ZGVk9YaGxhekV6VVZRd09VbHVNRDBpTENKMlpYSnphVzl1SWpvaU15SXNJblI1Y0dVaU9pSkVRVlJCWDB0RldTSXNJbVY0Y0dseVlYUnBiMjRpT2pFM01qRTVOVGMzTmpKOQ ``` Consulte mais informações em [Amazon ECR public registries](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#registry_auth_http) no *Amazon ECR Public*. + Para ver detalhes da API, consulte [GetAuthorizationToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/get-authorization-token.html) na *Referência de comandos da AWS CLI*. ### `get-login-password` O código de exemplo a seguir mostra como usar `get-login-password`. **AWS CLI** **Exemplo 1: como autenticar o Docker em um registro público do Amazon ECR** O exemplo de `get-login-password` a seguir recupera e exibe um token de autenticação usando a API GetAuthorizationToken que você pode usar para se autenticar em um registro público do Amazon ECR. ``` aws ecr-public get-login-password \ --region us-east-1 | docker login \ --username AWS \ --password-stdin public.ecr.aws ``` Esse comando não produz nenhuma saída no terminal, mas canaliza a saída para o Docker. Consulte mais informações em [Authenticate to the public registry](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth) no *Amazon ECR Public*. **Exemplo 2: como autenticar o docker em seu próprio registro público personalizado do Amazon ECR** O exemplo de `get-login-password` a seguir recupera e exibe um token de autenticação usando a API GetAuthorizationToken que você pode usar para se autenticar em seu próprio registro público do Amazon ECR. ``` aws ecr-public get-login-password \ --region us-east-1 \ | docker login \ --username AWS \ --password-stdin public.ecr.aws/ ``` Esse comando não produz nenhuma saída no terminal, mas canaliza a saída para o Docker. Consulte mais informações em [Authenticate to your own Amazon ECR Public](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth) no *Amazon ECR Public*. + Para ver detalhes da API, consulte [GetLoginPassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/get-login-password.html) na *Referência de comandos da AWS CLI*. ### `get-registry-catalog-data` O código de exemplo a seguir mostra como usar `get-registry-catalog-data`. **AWS CLI** **Como recuperar metadados do catálogo para um registro público do ECR** O `get-registry-catalog-data` a seguir recupera os metadados do catálogo para um registro público do ECR. ``` aws ecr-public get-registry-catalog-data \ --region us-east-1 ``` Resultado: ``` { "registryCatalogData": { "displayName": "YourCustomPublicRepositoryalias" } } ``` + Consulte detalhes da API em [GetRegistryCatalogData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/get-registry-catalog-data.html) na *Referência de comandos da AWS CLI*. ### `get-repository-catalog-data` O código de exemplo a seguir mostra como usar `get-repository-catalog-data`. **AWS CLI** **Como recuperar metadados do catálogo para um repositório em um registro público** O exemplo de `get-repository-catalog-data` a seguir lista os metadados do catálogo para o repositório `project-a/nginx-web-app` em um registro público. ``` aws ecr-public get-repository-catalog-data \ --repository-name project-a/nginx-web-app \ --region us-east-1 ``` Resultado: ``` { "catalogData": { "description": "My project-a ECR Public Repository", "architectures": [ "ARM", "ARM 64", "x86", "x86-64" ], "operatingSystems": [ "Linux" ], "logoUrl": "https://d3g9o9u8re44ak.cloudfront.net/logo/491d3846-8f33-4d8b-a10c-c2ce271e6c0d/4f09d87c-2569-4916-a932-5c296bf6f88a.png", "aboutText": "## Quick reference\n\nMaintained ", "usageText": "## Supported architectures\n\namd64, arm64v8\n\n## " } } ``` Consulte mais informações em [Repository catalog data](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-catalog-data.html) no *Amazon ECR Public*. + Consulte detalhes da API em [GetRepositoryCatalogData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/get-repository-catalog-data.html) na *Referência de comandos da AWS CLI*. ### `get-repository-policy` O código de exemplo a seguir mostra como usar `get-repository-policy`. **AWS CLI** **Como obter uma política de repositório associada ao repositório** O exemplo de `get-repository-policy` a seguir obtém uma política de repositório associada ao repositório. ``` aws ecr-public get-repository-policy \ --repository-name project-a/nginx-web-app \ --region us-east-1 ``` Resultado: ``` { "registryId": "123456789012", "repositoryName": "project-a/nginx-web-app", "policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"AllowPush\",\n \"Effect\" : \"Allow\",\n \"Principal\" : {\n \"AWS\" : [ \"arn:aws:iam::123456789012:user/eksuser1\", \"arn:aws:iam::123456789012:user/admin\" ]\n },\n \"Action\" : [ \"ecr-public:BatchCheckLayerAvailability\", \"ecr-public:PutImage\", \"ecr-public:InitiateLayerUpload\", \"ecr-public:UploadLayerPart\", \"ecr-public:CompleteLayerUpload\" ]\n } ]\n}" } ``` Consulte mais informações em [Use GetRepositoryPolicy with an AWS SDK or CLI](https://docs.aws.amazon.com/AmazonECR/latest/userguide/example_ecr_GetRepositoryPolicy_section.html) no *Guia do usuário do Amazon ECR Public*. + Para receber detalhes da API, consulte [GetRepositoryPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/get-repository-policy.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Como listar tags para um repositório público em um registro público** O exemplo de `list-tags-for-resource` a seguir lista as tags de um recurso chamado `project-a/nginx-web-app` em um registro público. ``` aws ecr-public list-tags-for-resource \ --resource-arn arn:aws:ecr-public::123456789012:repository/project-a/nginx-web-app \ --region us-east-1 ``` Resultado: ``` { "tags": [ { "Key": "Environment", "Value": "Prod" }, { "Key": "stack", "Value": "dev1" }, { "Key": "Name", "Value": "project-a/nginx-web-app" } ] } ``` Consulte mais informações em [List tags for a public repository](https://docs.aws.amazon.com/AmazonECR/latest/public/ecr-public-using-tags.html) no *Guia do usuário do Amazon ECR Public*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `put-registry-catalog-data` O código de exemplo a seguir mostra como usar `put-registry-catalog-data`. **AWS CLI** **Como criar ou atualizar metadados do catálogo para um registro público do ECR** O `put-registry-catalog-data` a seguir cria ou atualiza os metadados do catálogo para um registro público do ECR. Somente contas que têm o selo de conta verificada podem ter um nome de exibição do registro. ``` aws ecr-public put-registry-catalog-data \ --region us-east-1 \ --display-name ``` Resultado: ``` { "registryCatalogData": { "displayName": "YourCustomPublicRepositoryalias" } } ``` + Consulte detalhes da API em [PutRegistryCatalogData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/put-registry-catalog-data.html) na *Referência de comandos da AWS CLI*. ### `put-repository-catalog-data` O código de exemplo a seguir mostra como usar `put-repository-catalog-data`. **AWS CLI** **Como criar ou atualizar os dados do catálogo para um repositório em um registro público** O exemplo de `put-repository-catalog-data` a seguir cria ou atualiza dados de catálogo para um repositório chamado project-a/nginx-web-app em um registro público, além de informações sobre tags, logoImageBlob, aboutText e usageText. ``` aws ecr-public put-repository-catalog-data \ --repository-name project-a/nginx-web-app \ --cli-input-json file://repository-catalog-data.json \ --region us-east-1 ``` Conteúdo de `repository-catalog-data.json`: ``` { "repositoryName": "project-a/nginx-web-app", "catalogData": { "description": "My project-a ECR Public Repository", "architectures": [ "ARM", "ARM 64", "x86", "x86-64" ], "operatingSystems": [ "Linux" ], "logoImageBlob": "iVBORw0KGgoA<>ErkJggg==", "aboutText": "## Quick reference.", "usageText": "## Supported architectures are as follows." } } ``` Resultado: ``` { "catalogData": { "description": "My project-a ECR Public Repository", "architectures": [ "ARM", "ARM 64", "x86", "x86-64" ], "operatingSystems": [ "Linux" ], "logoUrl": "https://d3g9o9u8re44ak.cloudfront.net/logo/df86cf58-ee60-4061-b804-0be24d97ccb1/4a9ed9b2-69e4-4ede-b924-461462d20ef0.png", "aboutText": "## Quick reference.", "usageText": "## Supported architectures are as follows." } } ``` Consulte mais informações em [Repository catalog data](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-catalog-data.html) no *Amazon ECR Public*. + Consulte detalhes da API em [PutRepositoryCatalogData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/put-repository-catalog-data.html) na *Referência de comandos da AWS CLI*. ### `set-repository-policy` O código de exemplo a seguir mostra como usar `set-repository-policy`. **AWS CLI** **Exemplo 1: como definir uma política de repositório para permitir uma extração no repositório** O exemplo de `set-repository-policy` a seguir aplica uma política de repositório público do ECR ao repositório especificado para controlar as permissões de acesso. ``` aws ecr-public set-repository-policy \ --repository-name project-a/nginx-web-app \ --policy-text file://my-repository-policy.json ``` Conteúdo de `my-repository-policy.json`: ``` { "Version":"2012-10-17", "Statement" : [ { "Sid" : "allow public pull", "Effect" : "Allow", "Principal" : "*", "Action" : [ "ecr:BatchCheckLayerAvailability", "ecr:BatchGetImage", "ecr:GetDownloadUrlForLayer" ] } ] } ``` Resultado: ``` { "registryId": "12345678901", "repositoryName": "project-a/nginx-web-app", "policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"allow public pull\",\n \"Effect\" : \"Allow\",\n \"Principal\" : \"*\",\n \"Action\" : [ \"ecr:BatchCheckLayerAvailability\", \"ecr:BatchGetImage\", \"ecr:GetDownloadUrlForLayer\" ]\n } ]\n}" } ``` Consulte mais informações em [Setting a repository policy statement](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-policy-examples.html) no *Guia do usuário do Amazon ECR Public*. **Exemplo 2: como definir uma política de repositório para permitir que um usuário do IAM em sua conta envie imagens** O exemplo de `set-repository-policy` a seguir permite que um usuário do IAM em sua conta envie imagens a um repositório do ECR em sua conta da AWS usando o arquivo de entrada chamado `file://my-repository-policy.json` como texto da política. ``` aws ecr-public set-repository-policy \ --repository-name project-a/nginx-web-app \ --policy-text file://my-repository-policy.json ``` Conteúdo de `my-repository-policy.json`: ``` { "Version":"2012-10-17", "Statement": [ { "Sid": "AllowPush", "Effect": "Allow", "Principal": { "AWS": [ "arn:aws:iam::account-id:user/push-pull-user-1", "arn:aws:iam::account-id:user/push-pull-user-2" ] }, "Action": [ "ecr-public:BatchCheckLayerAvailability", "ecr-public:PutImage", "ecr-public:InitiateLayerUpload", "ecr-public:UploadLayerPart", "ecr-public:CompleteLayerUpload" ] } ] } ``` Resultado: ``` { "registryId": "12345678901", "repositoryName": "project-a/nginx-web-app", "policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"AllowPush\",\n \"Effect\" : \"Allow\",\n \"Principal\" : {\n \"AWS\" : [ \"arn:aws:iam::12345678901:user/admin\", \"arn:aws:iam::12345678901:user/eksuser1\" ]\n },\n \"Action\" : [ \"ecr-public:BatchCheckLayerAvailability\", \"ecr-public:PutImage\", \"ecr-public:InitiateLayerUpload\", \"ecr-public:UploadLayerPart\", \"ecr-public:CompleteLayerUpload\" ]\n } ]\n}" } ``` Consulte mais informações em [Setting a repository policy statement](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-policy-examples.html) no *Guia do usuário do Amazon ECR Public*. **Exemplo 3: como definir uma política de repositório para permitir que um usuário do IAM de uma conta diferente envie imagens** O exemplo de `set-repository-policy` a seguir permite que uma conta específica envie imagens usando a entrada de CLI file://my-repository-policy.json em sua conta da AWS. ``` aws ecr-public set-repository-policy \ --repository-name project-a/nginx-web-app \ --policy-text file://my-repository-policy.json ``` Conteúdo de `my-repository-policy.json`: ``` { "Version":"2012-10-17", "Statement": [ { "Sid": "AllowCrossAccountPush", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::other-or-same-account-id:role/RoleName" }, "Action": [ "ecr-public:BatchCheckLayerAvailability", "ecr-public:PutImage", "ecr-public:InitiateLayerUpload", "ecr-public:UploadLayerPart", "ecr-public:CompleteLayerUpload" ] } ] } ``` Resultado: ``` { "registryId": "12345678901", "repositoryName": "project-a/nginx-web-app", "policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"AllowCrossAccountPush\",\n \"Effect\" : \"Allow\",\n \"Principal\" : {\n \"AWS\" : \"arn:aws:iam::12345678901:role/RoleName\"\n },\n \"Action\" : [ \"ecr-public:BatchCheckLayerAvailability\", \"ecr-public:PutImage\", \"ecr-public:InitiateLayerUpload\", \"ecr-public:UploadLayerPart\", \"ecr-public:CompleteLayerUpload\" ]\n } ]\n}" } ``` Consulte mais informações em [Public repository policy examples](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-policy-examples.html) no *Guia do usuário do Amazon ECR Public*. + Para obter detalhes sobre a API, consulte [SetRepositoryPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/set-repository-policy.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Exemplo 1: como marcar um repositório público existente em um registro público** O exemplo de `tag-resource` a seguir cria um repositório chamado `project-a/nginx-web-app` em um registro público. ``` aws ecr-public tag-resource \ --resource-arn arn:aws:ecr-public::123456789012:repository/project-a/nginx-web-app \ --tags Key=stack,Value=dev \ --region us-east-1 ``` Consulte mais informações em [Using Tags for a public repository](https://docs.aws.amazon.com/AmazonECR/latest/public/ecr-public-using-tags.html) no *Amazon ECR Public*. **Exemplo 2: como marcar um repositório público existente com várias tags em um registro público** O exemplo de `tag-resource` a seguir marca um repositório existente com várias tags. ``` aws ecr-public tag-resource \ --resource-arn arn:aws:ecr-public::890517186334:repository/project-a/nginx-web-app \ --tags Key=key1,Value=value1 Key=key2,Value=value2 Key=key3,Value=value3 \ --region us-east-1 ``` Consulte mais informações em [Using Tags for a public repository](https://docs.aws.amazon.com/AmazonECR/latest/public/ecr-public-using-tags.html) no *Amazon ECR Public*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Exemplo 1: como desmarcar um repositório público existente em um registro público** O exemplo de `untag-resource` a seguir cria um repositório chamado `project-a/nginx-web-app` em um registro público. ``` aws ecr-public untag-resource \ --resource-arn arn:aws:ecr-public::123456789012:repository/project-a/nginx-web-app \ --tag-keys stack \ --region us-east-1 ``` Este comando não produz saída. Consulte mais informações em [Using Tags for a public repository](https://docs.aws.amazon.com/AmazonECR/latest/public/ecr-public-using-tags.html) no *Amazon ECR Public*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/untag-resource.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon ECS usando o AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface 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 ### `capacity-provider-update` O código de exemplo a seguir mostra como usar `capacity-provider-update`. **AWS CLI** **Atualizar o provedor de capacidade em um cluster do ECS** O exemplo de `update-capacity-provider` a seguir mostra como podemos modificar os parâmetros do provedor de capacidade em um cluster do ECS. ``` aws ecs update-capacity-provider \ --name Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt \ --auto-scaling-group-provider "managedScaling={status=DISABLED,targetCapacity=50,minimumScalingStepSize=2,maximumScalingStepSize=30,instanceWarmupPeriod=200},managedTerminationProtection=DISABLED,managedDraining=DISABLED" ``` Resultado: ``` { "capacityProvider": { "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt", "name": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt", "status": "ACTIVE", "autoScalingGroupProvider": { "autoScalingGroupArn": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:424941d1-b43f-4a17-adbb-08b6a6e397e1:autoScalingGroupName/Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-ECSAutoScalingGroup-f44jrQHS2nRB", "managedScaling": { "status": "ENABLED", "targetCapacity": 100, "minimumScalingStepSize": 1, "maximumScalingStepSize": 10000, "instanceWarmupPeriod": 300 }, "managedTerminationProtection": "DISABLED", "managedDraining": "ENABLED" }, "updateStatus": "UPDATE_IN_PROGRESS", "tags": [] } } ``` Consulte mais informações sobre o provedor de capacidade em [Provedores de capacidade do Amazon ECS para o tipo de inicialização do EC2](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/asg-capacity-providers.html) no *Guia do desenvolvedor do Amazon ECS*. + Consulte detalhes da API em [CapacityProviderUpdate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/capacity-provider-update.html) na *Referência de comandos da AWS CLI*. ### `create-capacity-provider` O código de exemplo a seguir mostra como usar `create-capacity-provider`. **AWS CLI** **Para criar um provedor de capacidade** O exemplo create-capacity-provider a seguir cria um provedor de capacidade que usa um grupo do Auto Scaling chamado MyASG, tem a escalabilidade gerenciada e proteção contra encerramento gerenciado habilitadas. Essa configuração é usada para o auto scaling do cluster do Amazon ECS. ``` aws ecs create-capacity-provider \ --name "MyCapacityProvider" \ --auto-scaling-group-provider "autoScalingGroupArn=arn:aws:autoscaling:us-east-1:123456789012:autoScalingGroup:57ffcb94-11f0-4d6d-bf60-3bac5EXAMPLE:autoScalingGroupName/MyASG,managedScaling={status=ENABLED,targetCapacity=100},managedTerminationProtection=ENABLED" ``` Resultado: ``` { "capacityProvider": { "capacityProviderArn": "arn:aws:ecs:us-east-1:123456789012:capacity-provider/MyCapacityProvider", "name": "MyCapacityProvider", "status": "ACTIVE", "autoScalingGroupProvider": { "autoScalingGroupArn": "arn:aws:autoscaling:us-east-1:132456789012:autoScalingGroup:57ffcb94-11f0-4d6d-bf60-3bac5EXAMPLE:autoScalingGroupName/MyASG", "managedScaling": { "status": "ENABLED", "targetCapacity": 100, "minimumScalingStepSize": 1, "maximumScalingStepSize": 10000, "instanceWarmupPeriod": 300 }, "managedTerminationProtection": "ENABLED" }, "tags": [] } ``` Para obter mais informações, consulte [Ajuste de escala automático de clusters do Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-auto-scaling.html) no *Guia do desenvolvedor do Amazon ECS*. + Para ver detalhes da API, consulte [CreateCapacityProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/create-capacity-provider.html) na *Referência de comandos da AWS CLI*. ### `create-cluster` O código de exemplo a seguir mostra como usar `create-cluster`. **AWS CLI** **Exemplo 1: como criar um cluster** O exemplo de `create-cluster` a seguir cria um cluster chamado `MyCluster` e habilita o CloudWatch Container Insights com observabilidade aprimorada. ``` aws ecs create-cluster \ --cluster-name MyCluster \ --settings name=containerInsights,value=enhanced ``` Resultado: ``` { "cluster": { "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", "clusterName": "MyCluster", "status": "ACTIVE", "registeredContainerInstancesCount": 0, "pendingTasksCount": 0, "runningTasksCount": 0, "activeServicesCount": 0, "statistics": [], "settings": [ { "name": "containerInsights", "value": "enhanced" } ], "tags": [] } } ``` Para obter mais informações, consulte [Creating a Cluster](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create_cluster.html) no *Guia do desenvolvedor do Amazon ECS*. **Exemplo 2: como criar um cluster usando provedores de capacidade** O exemplo de `create-cluster` a seguir cria um cluster e associa dois provedores de capacidade existentes a ele. O comando `create-capacity-provider` é usado para criar um provedor de capacidade. Embora recomendado, não é necessário especificar uma estratégia de provedor de capacidade. Neste exemplo, criamos um cluster chamado `MyCluster` e associamos os provedores de capacidade `MyCapacityProvider1` e `MyCapacityProvider2` a ele. Uma estratégia de provedor de capacidade padrão é especificada e distribui a tarefa igualmente em ambos os provedores de capacidade. ``` aws ecs create-cluster \ --cluster-name MyCluster \ --capacity-providers MyCapacityProvider1 MyCapacityProvider2 \ --default-capacity-provider-strategy capacityProvider=MyCapacityProvider1,weight=1 capacityProvider=MyCapacityProvider2,weight=1 ``` Resultado: ``` { "cluster": { "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", "clusterName": "MyCluster", "status": "PROVISIONING", "registeredContainerInstancesCount": 0, "pendingTasksCount": 0, "runningTasksCount": 0, "activeServicesCount": 0, "statistics": [], "settings": [ { "name": "containerInsights", "value": "enabled" } ], "capacityProviders": [ "MyCapacityProvider1", "MyCapacityProvider2" ], "defaultCapacityProviderStrategy": [ { "capacityProvider": "MyCapacityProvider1", "weight": 1, "base": 0 }, { "capacityProvider": "MyCapacityProvider2", "weight": 1, "base": 0 } ], "attachments": [ { "id": "0fb0c8f4-6edd-4de1-9b09-17e470ee1918", "type": "asp", "status": "PRECREATED", "details": [ { "name": "capacityProviderName", "value": "MyCapacityProvider1" }, { "name": "scalingPlanName", "value": "ECSManagedAutoScalingPlan-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } ] }, { "id": "ae592060-2382-4663-9476-b015c685593c", "type": "asp", "status": "PRECREATED", "details": [ { "name": "capacityProviderName", "value": "MyCapacityProvider2" }, { "name": "scalingPlanName", "value": "ECSManagedAutoScalingPlan-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" } ] } ], "attachmentsStatus": "UPDATE_IN_PROGRESS" } } ``` Para obter mais informações, consulte [provedores de capacidade de clusters](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html) no *Guia do desenvolvedor do Amazon ECS*. **Exemplo 3: como criar um cluster com várias tags** O exemplo `create-cluster` a seguir cria um cluster com várias tags. Para obter mais informações sobre como adicionar tags com sintaxe simplificada, consulte [Usar sintaxe simplificada com a AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-shorthand.html) no *Guia do usuário da AWS CLI*. ``` aws ecs create-cluster \ --cluster-name MyCluster \ --tags key=key1,value=value1 key=key2,value=value2 ``` Resultado: ``` { "cluster": { "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", "clusterName": "MyCluster", "status": "ACTIVE", "registeredContainerInstancesCount": 0, "pendingTasksCount": 0, "runningTasksCount": 0, "activeServicesCount": 0, "statistics": [], "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ] } } ``` Para obter mais informações, consulte [Creating a Cluster](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create_cluster.html) no *Guia do desenvolvedor do Amazon ECS*. + Consulte detalhes da API em [CreateCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/create-cluster.html) na *Referência de comandos da AWS CLI*. ### `create-service` O código de exemplo a seguir mostra como usar `create-service`. **AWS CLI** **Exemplo 1: como criar um serviço com uma tarefa do Fargate** O exemplo de `create-service` a seguir demonstra como criar um serviço usando uma tarefa do Fargate. ``` aws ecs create-service \ --cluster MyCluster \ --service-name MyService \ --task-definition sample-fargate:1 \ --desired-count 2 \ --launch-type FARGATE \ --platform-version LATEST \ --network-configuration 'awsvpcConfiguration={subnets=[subnet-12344321],securityGroups=[sg-12344321],assignPublicIp=ENABLED}' \ --tags key=key1,value=value1 key=key2,value=value2 key=key3,value=value3 ``` Resultado: ``` { "service": { "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/MyCluster/MyService", "serviceName": "MyService", "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", "loadBalancers": [], "serviceRegistries": [], "status": "ACTIVE", "desiredCount": 2, "runningCount": 0, "pendingCount": 0, "launchType": "FARGATE", "platformVersion": "LATEST", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:1", "deploymentConfiguration": { "maximumPercent": 200, "minimumHealthyPercent": 100 }, "deployments": [ { "id": "ecs-svc/1234567890123456789", "status": "PRIMARY", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:1", "desiredCount": 2, "pendingCount": 0, "runningCount": 0, "createdAt": 1557119253.821, "updatedAt": 1557119253.821, "launchType": "FARGATE", "platformVersion": "1.3.0", "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321" ], "securityGroups": [ "sg-12344321" ], "assignPublicIp": "ENABLED" } } } ], "roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS", "events": [], "createdAt": 1557119253.821, "placementConstraints": [], "placementStrategy": [], "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321" ], "securityGroups": [ "sg-12344321" ], "assignPublicIp": "ENABLED" } }, "schedulingStrategy": "REPLICA", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" }, { "key": "key3", "value": "value3" } ], "enableECSManagedTags": false, "propagateTags": "NONE" } } ``` Para obter mais informações, consulte [Creating a Service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create-service-console-v2.html) no *Guia do desenvolvedor do Amazon ECS*. **Exemplo 2: como criar um serviço usando o tipo de inicialização do EC** O exemplo de `create-service` a seguir mostra como criar um serviço chamado `ecs-simple-service` com uma tarefa que usa o tipo de inicialização do EC2. O serviço usa a definição de tarefa `sleep360` e mantem uma instanciação da tarefa. ``` aws ecs create-service \ --cluster MyCluster \ --service-name ecs-simple-service \ --task-definition sleep360:2 \ --desired-count 1 ``` Resultado: ``` { "service": { "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/MyCluster/ecs-simple-service", "serviceName": "ecs-simple-service", "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", "loadBalancers": [], "serviceRegistries": [], "status": "ACTIVE", "desiredCount": 1, "runningCount": 0, "pendingCount": 0, "launchType": "EC2", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sleep360:2", "deploymentConfiguration": { "maximumPercent": 200, "minimumHealthyPercent": 100 }, "deployments": [ { "id": "ecs-svc/1234567890123456789", "status": "PRIMARY", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sleep360:2", "desiredCount": 1, "pendingCount": 0, "runningCount": 0, "createdAt": 1557206498.798, "updatedAt": 1557206498.798, "launchType": "EC2" } ], "events": [], "createdAt": 1557206498.798, "placementConstraints": [], "placementStrategy": [], "schedulingStrategy": "REPLICA", "enableECSManagedTags": false, "propagateTags": "NONE" } } ``` Para obter mais informações, consulte [Creating a Service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create-service-console-v2.html) no *Guia do desenvolvedor do Amazon ECS*. **Exemplo 3: como criar um serviço que usa um controlador de implantação externo** O exemplo de `create-service` a seguir cria um serviço que usa um controlador de implantação externo. ``` aws ecs create-service \ --cluster MyCluster \ --service-name MyService \ --deployment-controller type=EXTERNAL \ --desired-count 1 ``` Resultado: ``` { "service": { "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/MyCluster/MyService", "serviceName": "MyService", "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", "loadBalancers": [], "serviceRegistries": [], "status": "ACTIVE", "desiredCount": 1, "runningCount": 0, "pendingCount": 0, "launchType": "EC2", "deploymentConfiguration": { "maximumPercent": 200, "minimumHealthyPercent": 100 }, "taskSets": [], "deployments": [], "roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS", "events": [], "createdAt": 1557128207.101, "placementConstraints": [], "placementStrategy": [], "schedulingStrategy": "REPLICA", "deploymentController": { "type": "EXTERNAL" }, "enableECSManagedTags": false, "propagateTags": "NONE" } } ``` Para obter mais informações, consulte [Creating a Service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create-service-console-v2.html) no *Guia do desenvolvedor do Amazon ECS*. **Exemplo 4: como criar um serviço por trás de um balanceador de carga** O exemplo de `create-service` a seguir mostra como criar um serviço que fique por trás de um balanceador de carga. É necessário ter um balanceador de carga configurado na mesma região da instância de contêiner. Este exemplo usa a opção `--cli-input-json` e um arquivo de entrada JSON chamado `ecs-simple-service-elb.json` com o conteúdo a seguir. ``` aws ecs create-service \ --cluster MyCluster \ --service-name ecs-simple-service-elb \ --cli-input-json file://ecs-simple-service-elb.json ``` Conteúdo de `ecs-simple-service-elb.json`: ``` { "serviceName": "ecs-simple-service-elb", "taskDefinition": "ecs-demo", "loadBalancers": [ { "loadBalancerName": "EC2Contai-EcsElast-123456789012", "containerName": "simple-demo", "containerPort": 80 } ], "desiredCount": 10, "role": "ecsServiceRole" } ``` Resultado: ``` { "service": { "status": "ACTIVE", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/ecs-demo:1", "pendingCount": 0, "loadBalancers": [ { "containerName": "ecs-demo", "containerPort": 80, "loadBalancerName": "EC2Contai-EcsElast-123456789012" } ], "roleArn": "arn:aws:iam::123456789012:role/ecsServiceRole", "desiredCount": 10, "serviceName": "ecs-simple-service-elb", "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/ecs-simple-service-elb", "deployments": [ { "status": "PRIMARY", "pendingCount": 0, "createdAt": 1428100239.123, "desiredCount": 10, "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/ecs-demo:1", "updatedAt": 1428100239.123, "id": "ecs-svc/1234567890123456789", "runningCount": 0 } ], "events": [], "runningCount": 0 } } ``` Para obter mais informações, consulte [Uso do balanceamento de carga para distribuir o tráfego de serviço do Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) no *Guia do desenvolvedor do Amazon ECS*. **Exemplo 5: como configurar volumes do Amazon EBS ao criar o serviço** O exemplo de `create-service` a seguir mostra como criar volumes do EBS para cada tarefa gerenciada pelo serviço. Você deve ter uma função de infraestrutura do Amazon ECS configurada com a política `AmazonECSInfrastructureRolePolicyForVolumes` gerenciada anexada. É necessário especificar uma definição de tarefa com o mesmo nome de volume da solicitação `create-service`. Este exemplo usa a opção `--cli-input-json` e um arquivo de entrada JSON chamado `ecs-simple-service-ebs.json` com o conteúdo a seguir. ``` aws ecs create-service \ --cli-input-json file://ecs-simple-service-ebs.json ``` Conteúdo de `ecs-simple-service-ebs.json`: ``` { "cluster": "mycluster", "taskDefinition": "mytaskdef", "serviceName": "ecs-simple-service-ebs", "desiredCount": 2, "launchType": "FARGATE", "networkConfiguration":{ "awsvpcConfiguration":{ "assignPublicIp": "ENABLED", "securityGroups": ["sg-12344321"], "subnets":["subnet-12344321"] } }, "volumeConfigurations": [ { "name": "myEbsVolume", "managedEBSVolume": { "roleArn":"arn:aws:iam::123456789012:role/ecsInfrastructureRole", "volumeType": "gp3", "sizeInGiB": 100, "iops": 3000, "throughput": 125, "filesystemType": "ext4" } } ] } ``` Resultado: ``` { "service": { "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/mycluster/ecs-simple-service-ebs", "serviceName": "ecs-simple-service-ebs", "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/mycluster", "loadBalancers": [], "serviceRegistries": [], "status": "ACTIVE", "desiredCount": 2, "runningCount": 0, "pendingCount": 0, "launchType": "EC2", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:3", "deploymentConfiguration": { "deploymentCircuitBreaker": { "enable": false, "rollback": false }, "maximumPercent": 200, "minimumHealthyPercent": 100 }, "deployments": [ { "id": "ecs-svc/7851020056849183687", "status": "PRIMARY", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:3", "desiredCount": 0, "pendingCount": 0, "runningCount": 0, "failedTasks": 0, "createdAt": "2025-01-21T11:32:38.034000-06:00", "updatedAt": "2025-01-21T11:32:38.034000-06:00", "launchType": "EC2", "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321" ], "securityGroups": [ "sg-12344321" ], "assignPublicIp": "DISABLED" } }, "rolloutState": "IN_PROGRESS", "rolloutStateReason": "ECS deployment ecs-svc/7851020056849183687 in progress.", "volumeConfigurations": [ { "name": "myEBSVolume", "managedEBSVolume": { "volumeType": "gp3", "sizeInGiB": 100, "iops": 3000, "throughput": 125, "roleArn": "arn:aws:iam::123456789012:role/ecsInfrastructureRole", "filesystemType": "ext4" } } ] } ], "roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS", "events": [], "createdAt": "2025-01-21T11:32:38.034000-06:00", "placementConstraints": [], "placementStrategy": [], "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321" ], "securityGroups": [ "sg-12344321" ], "assignPublicIp": "DISABLED" } }, "healthCheckGracePeriodSeconds": 0, "schedulingStrategy": "REPLICA", "deploymentController": { "type": "ECS" }, "createdBy": "arn:aws:iam::123456789012:user/AIDACKCEVSQ6C2EXAMPLE", "enableECSManagedTags": false, "propagateTags": "NONE", "enableExecuteCommand": false, "availabilityZoneRebalancing": "DISABLED" } } ``` Consulte mais informações em [Uso de volumes do Amazon EBS com o Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html) no *Guia do desenvolvedor do Amazon ECS*. + Consulte detalhes da API em [CreateService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/create-service.html) na *Referência de comandos da AWS CLI*. ### `create-task-set` O código de exemplo a seguir mostra como usar `create-task-set`. **AWS CLI** **Para criar um conjunto de tarefas** O exemplo `create-task-set` a seguir cria uma tarefa definida em um serviço que usa um controlador de implantação externo. ``` aws ecs create-task-set \ --cluster MyCluster \ --service MyService \ --task-definition MyTaskDefinition:2 \ --network-configuration "awsvpcConfiguration={subnets=[subnet-12344321],securityGroups=[sg-12344321]}" ``` Resultado: ``` { "taskSet": { "id": "ecs-svc/1234567890123456789", "taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789", "status": "ACTIVE", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/MyTaskDefinition:2", "computedDesiredCount": 0, "pendingCount": 0, "runningCount": 0, "createdAt": 1557128360.711, "updatedAt": 1557128360.711, "launchType": "EC2", "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321" ], "securityGroups": [ "sg-12344321" ], "assignPublicIp": "DISABLED" } }, "loadBalancers": [], "serviceRegistries": [], "scale": { "value": 0.0, "unit": "PERCENT" }, "stabilityStatus": "STABILIZING", "stabilityStatusAt": 1557128360.711 } } ``` + Para ver detalhes da API, consulte [CreateTaskSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/create-task-set.html) na *Referência de comandos da AWS CLI*. ### `delete-account-setting` O código de exemplo a seguir mostra como usar `delete-account-setting`. **AWS CLI** **Para excluir as configurações de conta para um usuário ou perfil específico do IAM** O exemplo `delete-account-setting` a seguir exclui as configurações de conta para o usuário ou perfil específico do IAM. ``` aws ecs delete-account-setting \ --name serviceLongArnFormat \ --principal-arn arn:aws:iam::123456789012:user/MyUser ``` Resultado: ``` { "setting": { "name": "serviceLongArnFormat", "value": "enabled", "principalArn": "arn:aws:iam::123456789012:user/MyUser" } } ``` Para obter mais informações, consulte [Nomes de recursos da Amazon (ARNs) e IDs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-resource-ids.html) no *Guia do desenvolvedor do Amazon ECS*. + Para ver detalhes da API, consulte [DeleteAccountSetting](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/delete-account-setting.html) na *Referência de comandos da AWS CLI*. ### `delete-attributes` O código de exemplo a seguir mostra como usar `delete-attributes`. **AWS CLI** **Para excluir um ou mais atributos personalizados de um recurso do Amazon ECS** O `delete-attributes` a seguir exclui um atributo com o nome `stack` de uma instância de contêiner. ``` aws ecs delete-attributes \ --attributes name=stack,targetId=arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34 ``` Resultado: ``` { "attributes": [ { "name": "stack", "targetId": "arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34", "value": "production" } ] } ``` + Para ver detalhes da API, consulte [DeleteAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/delete-attributes.html) na *Referência de comandos da AWS CLI*. ### `delete-capacity-provider` O código de exemplo a seguir mostra como usar `delete-capacity-provider`. **AWS CLI** **Exemplo 1: como excluir um provedor de capacidade usando o nome do recurso da Amazon (ARN)** O exemplo `delete-capacity-provider` a seguir exclui um provedor de capacidade ao especificar o nome do recurso da Amazon (ARN) do provedor de capacidade. O ARN e o status da exclusão do provedor de capacidade podem ser recuperados usando o comando `describe-capacity-providers`. ``` aws ecs delete-capacity-provider \ --capacity-provider arn:aws:ecs:us-west-2:123456789012:capacity-provider/ExampleCapacityProvider ``` Resultado: ``` { "capacityProvider": { "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/ExampleCapacityProvider", "name": "ExampleCapacityProvider", "status": "ACTIVE", "autoScalingGroupProvider": { "autoScalingGroupArn": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:autoScalingGroupName/MyAutoScalingGroup", "managedScaling": { "status": "ENABLED", "targetCapacity": 100, "minimumScalingStepSize": 1, "maximumScalingStepSize": 10000 }, "managedTerminationProtection": "DISABLED" }, "updateStatus": "DELETE_IN_PROGRESS", "tags": [] } } ``` Para obter mais informações, consulte [provedores de capacidade de clusters](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html) no *Guia do desenvolvedor do Amazon ECS*. **Exemplo 2: como excluir um provedor de capacidade usando o nome** O exemplo `delete-capacity-provider` a seguir exclui um provedor de capacidade especificando o nome abreviado do provedor de capacidade. O nome curto e o status da exclusão do provedor de capacidade podem ser recuperados usando o comando `describe-capacity-providers`. ``` aws ecs delete-capacity-provider \ --capacity-provider ExampleCapacityProvider ``` Resultado: ``` { "capacityProvider": { "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/ExampleCapacityProvider", "name": "ExampleCapacityProvider", "status": "ACTIVE", "autoScalingGroupProvider": { "autoScalingGroupArn": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:autoScalingGroupName/MyAutoScalingGroup", "managedScaling": { "status": "ENABLED", "targetCapacity": 100, "minimumScalingStepSize": 1, "maximumScalingStepSize": 10000 }, "managedTerminationProtection": "DISABLED" }, "updateStatus": "DELETE_IN_PROGRESS", "tags": [] } } ``` Para obter mais informações, consulte [provedores de capacidade de clusters](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html) no *Guia do desenvolvedor do Amazon ECS*. + Para ver detalhes da API, consulte [DeleteCapacityProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/delete-capacity-provider.html) na *Referência de comandos da AWS CLI*. ### `delete-cluster` O código de exemplo a seguir mostra como usar `delete-cluster`. **AWS CLI** **Como excluir um cluster vazio** O exemplo de `delete-cluster` a seguir exclui o cluster vazio especificado. ``` aws ecs delete-cluster --cluster MyCluster ``` Resultado: ``` { "cluster": { "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", "status": "INACTIVE", "clusterName": "MyCluster", "registeredContainerInstancesCount": 0, "pendingTasksCount": 0, "runningTasksCount": 0, "activeServicesCount": 0 "statistics": [], "tags": [] } } ``` Para obter mais informações, consulte [Deleting a Cluster](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/delete_cluster.html) no *Guia do desenvolvedor do Amazon ECS*. + Consulte detalhes da API em [DeleteCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/delete-cluster.html) na *Referência de comandos da AWS CLI*. ### `delete-service` O código de exemplo a seguir mostra como usar `delete-service`. **AWS CLI** **Como excluir um serviço** O exemplo de `ecs delete-service` a seguir exclui o serviço especificado de um cluster. Inclua o parâmetro `--force` para excluir um serviço mesmo que ele não tenha sido reduzido a zero tarefas. ``` aws ecs delete-service --cluster MyCluster --service MyService1 --force ``` Para obter mais informações, consulte [Deleting a Service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/delete-service.html) no *Guia do desenvolvedor do Amazon ECS*. + Consulte detalhes da API em [DeleteService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/delete-service.html) na *Referência de comandos da AWS CLI*. ### `delete-task-definitions` O código de exemplo a seguir mostra como usar `delete-task-definitions`. **AWS CLI** **Para excluir uma definição de tarefa** O exemplo `delete-task-definitions` a seguir exclui uma definição de tarefa INATIVA. ``` aws ecs delete-task-definitions \ --task-definition curltest:1 ``` Resultado: ``` { "taskDefinitions": [ { "taskDefinitionArn": "arn:aws:ecs:us-east-1:123456789012:task-definition/curltest:1", "containerDefinitions": [ { "name": "ctest", "image": "mreferre/eksutils", "cpu": 0, "portMappings": [], "essential": true, "entryPoint": [ "sh", "-c" ], "command": [ "curl ${ECS_CONTAINER_METADATA_URI_V4}/task" ], "environment": [], "mountPoints": [], "volumesFrom": [], "logConfiguration": { "logDriver": "awslogs", "options": { "awslogs-create-group": "true", "awslogs-group": "/ecs/curltest", "awslogs-region": "us-east-1", "awslogs-stream-prefix": "ecs" } } } ], "family": "curltest", "taskRoleArn": "arn:aws:iam::123456789012:role/ecsTaskExecutionRole", "executionRoleArn": "arn:aws:iam::123456789012:role/ecsTaskExecutionRole", "networkMode": "awsvpc", "revision": 1, "volumes": [], "status": "DELETE_IN_PROGRESS", "compatibilities": [ "EC2", "FARGATE" ], "requiresCompatibilities": [ "FARGATE" ], "cpu": "256", "memory": "512", "registeredAt": "2021-09-10T12:56:24.704000+00:00", "deregisteredAt": "2023-03-14T15:20:59.419000+00:00", "registeredBy": "arn:aws:sts::123456789012:assumed-role/Admin/jdoe" } ], "failures": [] } ``` Para obter mais informações, consulte [Definições de tarefa do Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html) no *Guia do desenvolvedor do Amazon ECS*. + Para ver detalhes da API, consulte [DeleteTaskDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/delete-task-definitions.html) na *Referência de comandos da AWS CLI*. ### `delete-task-set` O código de exemplo a seguir mostra como usar `delete-task-set`. **AWS CLI** **Para excluir uma tarefa** O exemplo `delete-task-set` a seguir mostra como excluir um conjunto de tabelas. Inclua o parâmetro `--force` para excluir um conjunto de tarefas mesmo que ele não tenha sido reduzido a zero. ``` aws ecs delete-task-set \ --cluster MyCluster \ --service MyService \ --task-set arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789 \ --force ``` Resultado: ``` { "taskSet": { "id": "ecs-svc/1234567890123456789", "taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789", "status": "DRAINING", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:2", "computedDesiredCount": 0, "pendingCount": 0, "runningCount": 0, "createdAt": 1557130260.276, "updatedAt": 1557130290.707, "launchType": "EC2", "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12345678" ], "securityGroups": [ "sg-12345678" ], "assignPublicIp": "DISABLED" } }, "loadBalancers": [], "serviceRegistries": [], "scale": { "value": 0.0, "unit": "PERCENT" }, "stabilityStatus": "STABILIZING", "stabilityStatusAt": 1557130290.707 } } ``` + Para ver detalhes da API, consulte [DeleteTaskSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/delete-task-set.html) na *Referência de comandos da AWS CLI*. ### `deregister-container-instance` O código de exemplo a seguir mostra como usar `deregister-container-instance`. **AWS CLI** **Como cancelar o registro de uma instância de contêiner de um cluster** O exemplo `deregister-container-instance` a seguir cancela o registro de uma instância de contêiner do cluster especificado. Se ainda houver tarefas em execução na instância de contêiner, você deverá interromper essas tarefas antes de cancelar o registro ou usar a opção `--force`. ``` aws ecs deregister-container-instance \ --cluster arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster \ --container-instance arn:aws:ecs:us-west-2:123456789012:container-instance/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --force ``` Resultado: ``` { "containerInstance": { "remainingResources": [ { "integerValue": 1024, "doubleValue": 0.0, "type": "INTEGER", "longValue": 0, "name": "CPU" }, { "integerValue": 985, "doubleValue": 0.0, "type": "INTEGER", "longValue": 0, "name": "MEMORY" }, { "type": "STRINGSET", "integerValue": 0, "name": "PORTS", "stringSetValue": [ "22", "2376", "2375", "51678", "51679" ], "longValue": 0, "doubleValue": 0.0 }, { "type": "STRINGSET", "integerValue": 0, "name": "PORTS_UDP", "stringSetValue": [], "longValue": 0, "doubleValue": 0.0 } ], "agentConnected": true, "attributes": [ { "name": "ecs.capability.secrets.asm.environment-variables" }, { "name": "com.amazonaws.ecs.capability.logging-driver.syslog" }, { "value": "ami-01a82c3fce2c3ba58", "name": "ecs.ami-id" }, { "name": "ecs.capability.secrets.asm.bootstrap.log-driver" }, { "name": "com.amazonaws.ecs.capability.logging-driver.none" }, { "name": "ecs.capability.ecr-endpoint" }, { "name": "com.amazonaws.ecs.capability.logging-driver.json-file" }, { "value": "vpc-1234567890123467", "name": "ecs.vpc-id" }, { "name": "ecs.capability.execution-role-awslogs" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.17" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.18" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.19" }, { "name": "ecs.capability.docker-plugin.local" }, { "name": "ecs.capability.task-eni" }, { "name": "ecs.capability.task-cpu-mem-limit" }, { "name": "ecs.capability.secrets.ssm.bootstrap.log-driver" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.30" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.31" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.32" }, { "name": "ecs.capability.execution-role-ecr-pull" }, { "name": "ecs.capability.container-health-check" }, { "value": "subnet-1234567890123467", "name": "ecs.subnet-id" }, { "value": "us-west-2a", "name": "ecs.availability-zone" }, { "value": "t2.micro", "name": "ecs.instance-type" }, { "name": "com.amazonaws.ecs.capability.task-iam-role-network-host" }, { "name": "ecs.capability.aws-appmesh" }, { "name": "com.amazonaws.ecs.capability.logging-driver.awslogs" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.24" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.25" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.26" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.27" }, { "name": "com.amazonaws.ecs.capability.privileged-container" }, { "name": "ecs.capability.container-ordering" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.28" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.29" }, { "value": "x86_64", "name": "ecs.cpu-architecture" }, { "value": "93f43776-2018.10.0", "name": "ecs.capability.cni-plugin-version" }, { "name": "ecs.capability.secrets.ssm.environment-variables" }, { "name": "ecs.capability.pid-ipc-namespace-sharing" }, { "name": "com.amazonaws.ecs.capability.ecr-auth" }, { "value": "linux", "name": "ecs.os-type" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.20" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.21" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.22" }, { "name": "ecs.capability.task-eia" }, { "name": "ecs.capability.private-registry-authentication.secretsmanager" }, { "name": "com.amazonaws.ecs.capability.task-iam-role" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.23" } ], "pendingTasksCount": 0, "tags": [], "containerInstanceArn": "arn:aws:ecs:us-west-2:123456789012:container-instance/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "registeredResources": [ { "integerValue": 1024, "doubleValue": 0.0, "type": "INTEGER", "longValue": 0, "name": "CPU" }, { "integerValue": 985, "doubleValue": 0.0, "type": "INTEGER", "longValue": 0, "name": "MEMORY" }, { "type": "STRINGSET", "integerValue": 0, "name": "PORTS", "stringSetValue": [ "22", "2376", "2375", "51678", "51679" ], "longValue": 0, "doubleValue": 0.0 }, { "type": "STRINGSET", "integerValue": 0, "name": "PORTS_UDP", "stringSetValue": [], "longValue": 0, "doubleValue": 0.0 } ], "status": "INACTIVE", "registeredAt": 1557768075.681, "version": 4, "versionInfo": { "agentVersion": "1.27.0", "agentHash": "aabe65ee", "dockerVersion": "DockerVersion: 18.06.1-ce" }, "attachments": [], "runningTasksCount": 0, "ec2InstanceId": "i-12345678901234678" } } ``` Para obter mais informações, consulte [Cancelar o registro de uma instância de contêiner](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deregister_container_instance.html) no *Guia do desenvolvedor do ECS*. + Para ver detalhes da API, consulte [DeregisterContainerInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/deregister-container-instance.html) na *Referência de comandos da AWS CLI*. ### `deregister-task-definition` O código de exemplo a seguir mostra como usar `deregister-task-definition`. **AWS CLI** **Como cancelar o registro de uma definição de tarefa** O exemplo `deregister-task-definition` a seguir cancela o registro da primeira revisão da definição da tarefa `curler` na sua região padrão. ``` aws ecs deregister-task-definition --task-definition curler:1 ``` Observe que, na saída resultante, o status da definição da tarefa mostra`INACTIVE`: ``` { "taskDefinition": { "status": "INACTIVE", "family": "curler", "volumes": [], "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/curler:1", "containerDefinitions": [ { "environment": [], "name": "curler", "mountPoints": [], "image": "curl:latest", "cpu": 100, "portMappings": [], "entryPoint": [], "memory": 256, "command": [ "curl -v http://example.com/" ], "essential": true, "volumesFrom": [] } ], "revision": 1 } } ``` Para obter mais informações, consulte [Definições de tarefa do Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html) no *Guia do desenvolvedor do Amazon ECS*. + Para ver detalhes da API, consulte [DeregisterTaskDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/deregister-task-definition.html) na *Referência de comandos da AWS CLI*. ### `describe-capacity-providers` O código de exemplo a seguir mostra como usar `describe-capacity-providers`. **AWS CLI** **Exemplo 1: como descrever todos os provedores de capacidade** O exemplo `describe-capacity-providers` a seguir recupera detalhes sobre todos os provedores de capacidade. ``` aws ecs describe-capacity-providers ``` Resultado: ``` { "capacityProviders": [ { "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/MyCapacityProvider", "name": "MyCapacityProvider", "status": "ACTIVE", "autoScalingGroupProvider": { "autoScalingGroupArn": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:autoScalingGroupName/MyAutoScalingGroup", "managedScaling": { "status": "ENABLED", "targetCapacity": 100, "minimumScalingStepSize": 1, "maximumScalingStepSize": 1000 }, "managedTerminationProtection": "ENABLED" }, "tags": [] }, { "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/FARGATE", "name": "FARGATE", "status": "ACTIVE", "tags": [] }, { "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/FARGATE_SPOT", "name": "FARGATE_SPOT", "status": "ACTIVE", "tags": [] } ] } ``` Para obter mais informações, consulte [provedores de capacidade de clusters](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html) no *Guia do desenvolvedor do Amazon ECS*. **Exemplo 2: como descrever um fornecedor de capacidade específico** O exemplo `describe-capacity-providers` a seguir recupera detalhes sobre um provedor de capacidade específico. O uso do parâmetro `--include TAGS` adicionará as tags associadas ao provedor de capacidade à saída. ``` aws ecs describe-capacity-providers \ --capacity-providers MyCapacityProvider \ --include TAGS ``` Resultado: ``` { "capacityProviders": [ { "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/MyCapacityProvider", "name": "MyCapacityProvider", "status": "ACTIVE", "autoScalingGroupProvider": { "autoScalingGroupArn": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:autoScalingGroupName/MyAutoScalingGroup", "managedScaling": { "status": "ENABLED", "targetCapacity": 100, "minimumScalingStepSize": 1, "maximumScalingStepSize": 1000 }, "managedTerminationProtection": "ENABLED" }, "tags": [ { "key": "environment", "value": "production" } ] } ] } ``` Para obter mais informações, consulte [provedores de capacidade de clusters](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html) no *Guia do desenvolvedor do Amazon ECS*. + Para ver detalhes da API, consulte [DescribeCapacityProviders](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-capacity-providers.html) na *Referência de comandos da AWS CLI*. ### `describe-clusters` O código de exemplo a seguir mostra como usar `describe-clusters`. **AWS CLI** **Exemplo 1: como descrever um cluster** O exemplo de `describe-clusters` a seguir recupera detalhes do cluster especificado. ``` aws ecs describe-clusters \ --cluster default ``` Resultado: ``` { "clusters": [ { "status": "ACTIVE", "clusterName": "default", "registeredContainerInstancesCount": 0, "pendingTasksCount": 0, "runningTasksCount": 0, "activeServicesCount": 1, "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/default" } ], "failures": [] } ``` Para obter mais informações, consulte [Clusters do Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_clusters.html) no *Guia do desenvolvedor do Amazon ECS*. **Exemplo 2: como descrever um cluster com a opção de anexo** O exemplo de `describe-clusters` a seguir especifica a opção de ANEXOS. Ele recupera detalhes sobre o cluster especificado e uma lista dos recursos anexados ao cluster no formato de anexos. Ao usar um provedor de capacidade com um cluster, os recursos (planos do AutoScaling ou políticas de dimensionamento) são representados como ANEXOS asp ou as\$1policy. ``` aws ecs describe-clusters \ --include ATTACHMENTS \ --clusters sampleCluster ``` Resultado: ``` { "clusters": [ { "clusterArn": "arn:aws:ecs:af-south-1:123456789222:cluster/sampleCluster", "clusterName": "sampleCluster", "status": "ACTIVE", "registeredContainerInstancesCount": 0, "runningTasksCount": 0, "pendingTasksCount": 0, "activeServicesCount": 0, "statistics": [], "tags": [], "settings": [], "capacityProviders": [ "sampleCapacityProvider" ], "defaultCapacityProviderStrategy": [], "attachments": [ { "id": "a1b2c3d4-5678-901b-cdef-EXAMPLE22222", "type": "as_policy", "status": "CREATED", "details": [ { "name": "capacityProviderName", "value": "sampleCapacityProvider" }, { "name": "scalingPolicyName", "value": "ECSManagedAutoScalingPolicy-3048e262-fe39-4eaf-826d-6f975d303188" } ] } ], "attachmentsStatus": "UPDATE_COMPLETE" } ], "failures": [] } ``` Para obter mais informações, consulte [Clusters do Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_clusters.html) no *Guia do desenvolvedor do Amazon ECS*. + Consulte detalhes da API em [DescribeClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-clusters.html) na *Referência de comandos da AWS CLI*. ### `describe-container-instances` O código de exemplo a seguir mostra como usar `describe-container-instances`. **AWS CLI** **Para descrever a instância de contêiner** O exemplo `describe-container-instances` a seguir recupera os detalhes de uma instância de contêiner no cluster `update`, usando o UUID da instância de contêiner como identificador. ``` aws ecs describe-container-instances \ --cluster update \ --container-instances a1b2c3d4-5678-90ab-cdef-11111EXAMPLE ``` Resultado: ``` { "failures": [], "containerInstances": [ { "status": "ACTIVE", "registeredResources": [ { "integerValue": 2048, "longValue": 0, "type": "INTEGER", "name": "CPU", "doubleValue": 0.0 }, { "integerValue": 3955, "longValue": 0, "type": "INTEGER", "name": "MEMORY", "doubleValue": 0.0 }, { "name": "PORTS", "longValue": 0, "doubleValue": 0.0, "stringSetValue": [ "22", "2376", "2375", "51678" ], "type": "STRINGSET", "integerValue": 0 } ], "ec2InstanceId": "i-A1B2C3D4", "agentConnected": true, "containerInstanceArn": "arn:aws:ecs:us-west-2:123456789012:container-instance/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "pendingTasksCount": 0, "remainingResources": [ { "integerValue": 2048, "longValue": 0, "type": "INTEGER", "name": "CPU", "doubleValue": 0.0 }, { "integerValue": 3955, "longValue": 0, "type": "INTEGER", "name": "MEMORY", "doubleValue": 0.0 }, { "name": "PORTS", "longValue": 0, "doubleValue": 0.0, "stringSetValue": [ "22", "2376", "2375", "51678" ], "type": "STRINGSET", "integerValue": 0 } ], "runningTasksCount": 0, "versionInfo": { "agentVersion": "1.0.0", "agentHash": "4023248", "dockerVersion": "DockerVersion: 1.5.0" } } ] } ``` Para obter mais informações, consulte [Instâncias de contêiner do Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_instances.html) no *Guia do desenvolvedor do Amazon ECS*. + Para ver detalhes da API, consulte [DescribeContainerInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-container-instances.html) na *Referência de comandos da AWS CLI*. ### `describe-service-deployments` O código de exemplo a seguir mostra como usar `describe-service-deployments`. **AWS CLI** **Como descrever os detalhes da implantação do serviço** O exemplo de `describe-service-deployments` a seguir retorna os detalhes da implantação do serviço com o ARN `arn:aws:ecs:us-east-1:123456789012:service-deployment/example-cluster/example-service/ejGvqq2ilnbKT9qj0vLJe`. ``` aws ecs describe-service-deployments \ --service-deployment-arn arn:aws:ecs:us-east-1:123456789012:service-deployment/example-cluster/example-service/ejGvqq2ilnbKT9qj0vLJe ``` Resultado: ``` { "serviceDeployments": [ { "serviceDeploymentArn": "arn:aws:ecs:us-east-1:123456789012:service-deployment/example-cluster/example-service/ejGvqq2ilnbKT9qj0vLJe", "serviceArn": "arn:aws:ecs:us-east-1:123456789012:service/example-cluster/example-service", "clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/example-cluster", "createdAt": "2024-10-31T08:03:30.917000-04:00", "startedAt": "2024-10-31T08:03:32.510000-04:00", "finishedAt": "2024-10-31T08:05:04.527000-04:00", "updatedAt": "2024-10-31T08:05:04.527000-04:00", "sourceServiceRevisions": [], "targetServiceRevision": { "arn": "arn:aws:ecs:us-east-1:123456789012:service-revision/example-cluster/example-service/1485800978477494678", "requestedTaskCount": 1, "runningTaskCount": 1, "pendingTaskCount": 0 }, "status": "SUCCESSFUL", "deploymentConfiguration": { "deploymentCircuitBreaker": { "enable": true, "rollback": true }, "maximumPercent": 200, "minimumHealthyPercent": 100, "alarms": { "alarmNames": [], "rollback": false, "enable": false } }, "deploymentCircuitBreaker": { "status": "MONITORING_COMPLETE", "failureCount": 0, "threshold": 3 }, "alarms": { "status": "DISABLED" } } ], "failures": [] } ``` Consulte mais informações em [Visualize o histórico de serviços usando implantações de serviços do Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-deployment.html) no *Guia do desenvolvedor do Amazon ECS*. + Consulte detalhes da API em [DescribeServiceDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-service-deployments.html) na *Referência de comandos da AWS CLI*. ### `describe-service-revisions` O código de exemplo a seguir mostra como usar `describe-service-revisions`. **AWS CLI** **Como descrever os detalhes da revisão do serviço** O exemplo de `describe-service-revisions` a seguir retorna os detalhes da revisão do serviço com o ARN `arn:aws:ecs:us-east-1:123456789012:service-revision/example-cluster/example-service/1485800978477494678`. ``` aws ecs describe-service-revisions \ --service-revision-arns arn:aws:ecs:us-east-1:123456789012:service-revision/example-cluster/example-service/1485800978477494678 ``` Resultado: ``` { "serviceRevisions": [ { "serviceRevisionArn": "arn:aws:ecs:us-east-1:123456789012:service-revision/example-cluster/example-service/1485800978477494678", "serviceArn": "arn:aws:ecs:us-east-1:123456789012:service/example-cluster/example-service", "clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/example-cluster", "taskDefinition": "arn:aws:ecs:us-east-1:123456789012:task-definition/webserver:5", "capacityProviderStrategy": [ { "capacityProvider": "FARGATE", "weight": 1, "base": 0 } ], "platformVersion": "1.4.0", "platformFamily": "Linux", "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-0d0eab1bb38d5ca64", "subnet-0db5010045995c2d5" ], "securityGroups": [ "sg-02556bf85a191f59a" ], "assignPublicIp": "ENABLED" } }, "containerImages": [ { "containerName": "aws-otel-collector", "imageDigest": "sha256:7a1b3560655071bcacd66902c20ebe9a69470d5691fe3bd36baace7c2f3c4640", "image": "public.ecr.aws/aws-observability/aws-otel-collector:v0.32.0" }, { "containerName": "web", "imageDigest": "sha256:28402db69fec7c17e179ea87882667f1e054391138f77ffaf0c3eb388efc3ffb", "image": "nginx" } ], "guardDutyEnabled": false, "serviceConnectConfiguration": { "enabled": false }, "createdAt": "2024-10-31T08:03:29.302000-04:00" } ], "failures": [] } ``` Consulte mais informações em [Revisões de serviços do Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-revision.html) no *Guia do desenvolvedor do Amazon ECS*. + Consulte detalhes da API em [DescribeServiceRevisions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-service-revisions.html) na *Referência de comandos da AWS CLI*. ### `describe-services` O código de exemplo a seguir mostra como usar `describe-services`. **AWS CLI** **Para descrever um serviço** O exemplo `describe-services` a seguir recupera detalhes do serviço `my-http-service` no cluster padrão. ``` aws ecs describe-services --services my-http-service ``` Resultado: ``` { "services": [ { "status": "ACTIVE", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/amazon-ecs-sample:1", "pendingCount": 0, "loadBalancers": [], "desiredCount": 10, "createdAt": 1466801808.595, "serviceName": "my-http-service", "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/default", "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/my-http-service", "deployments": [ { "status": "PRIMARY", "pendingCount": 0, "createdAt": 1466801808.595, "desiredCount": 10, "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/amazon-ecs-sample:1", "updatedAt": 1428326312.703, "id": "ecs-svc/1234567890123456789", "runningCount": 10 } ], "events": [ { "message": "(service my-http-service) has reached a steady state.", "id": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "createdAt": 1466801812.435 } ], "runningCount": 10 } ], "failures": [] } ``` Para obter mais informações, consulte [Serviços](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) no *Guia do desenvolvedor do Amazon ECS*. + Consulte detalhes da API em [DescribeServices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-services.html) na *Referência de comandos da AWS CLI*. ### `describe-task-definition` O código de exemplo a seguir mostra como usar `describe-task-definition`. **AWS CLI** **Para descrever uma definição de tarefa** O exemplo `describe-task-definition` a seguir recupera os detalhes de uma definição de tarefa. ``` aws ecs describe-task-definition \ --task-definition hello_world:8 ``` Resultado: ``` { "taskDefinition": { "taskDefinitionArn": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:8", "containerDefinitions": [ { "cpu": 10, "environment": [], "essential": true, "image": "wordpress", "links": [ "mysql" ] , "memory": 500, "mountPoints": [], "name": "wordpress", "portMappings": [ { "containerPort": 80, "hostPort": 80 } ], "volumesFrom": [] }, { "cpu": 10, "environment": [ { "name": "MYSQL_ROOT_PASSWORD", "value": "password" } ], "essential": true, "image": "mysql", "memory": 500, "mountPoints": [], "name": "mysql", "portMappings": [], "volumesFrom": [] } ], "family": "hello_world", "revision": 8, "volumes": [], "status": "ACTIVE", "placementConstraints": [], "compatibilities": [ "EXTERNAL", "EC2" ], "registeredAt": "2024-06-21T11:15:12.669000-05:00", "registeredBy": "arn:aws:sts::012345678910:assumed-role/demo-role/jane-doe" }, "tags": [] } ``` Para obter mais informações, consulte [Definições de tarefa do Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html) no *Guia do desenvolvedor do Amazon ECS*. + Para ver detalhes da API, consulte [DescribeTaskDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-task-definition.html) na *Referência de comandos da AWS CLI*. ### `describe-task-sets` O código de exemplo a seguir mostra como usar `describe-task-sets`. **AWS CLI** **Para descrever um conjunto de tarefas** O exemplo `describe-task-sets` a seguir descreve uma tarefa definida em um serviço que usa um implantador externo. ``` aws ecs describe-task-sets \ --cluster MyCluster \ --service MyService \ --task-sets arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789 ``` Resultado: ``` { "taskSets": [ { "id": "ecs-svc/1234567890123456789", "taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789", "status": "ACTIVE", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:2", "computedDesiredCount": 0, "pendingCount": 0, "runningCount": 0, "createdAt": 1557207715.195, "updatedAt": 1557207740.014, "launchType": "EC2", "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321" ], "securityGroups": [ "sg-1234431" ], "assignPublicIp": "DISABLED" } }, "loadBalancers": [], "serviceRegistries": [], "scale": { "value": 0.0, "unit": "PERCENT" }, "stabilityStatus": "STEADY_STATE", "stabilityStatusAt": 1557207740.014 } ], "failures": [] } ``` + Para ver detalhes da API, consulte [DescribeTaskSets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-task-sets.html) na *Referência de comandos da AWS CLI*. ### `describe-tasks` O código de exemplo a seguir mostra como usar `describe-tasks`. **AWS CLI** **Exemplo 1: como descrever uma única tarefa** O exemplo de `describe-tasks` a seguir recupera os detalhes de uma tarefa em um cluster. É possível especificar a tarefa usando o ID ou o ARN completo da tarefa. Este exemplo usa o ARN completo da tarefa. ``` aws ecs describe-tasks \ --cluster MyCluster \ --tasks arn:aws:ecs:us-east-1:123456789012:task/MyCluster/4d590253bb114126b7afa7b58EXAMPLE ``` Resultado: ``` { "tasks": [ { "attachments": [], "attributes": [ { "name": "ecs.cpu-architecture", "value": "x86_64" } ], "availabilityZone": "us-east-1b", "clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/MyCluster", "connectivity": "CONNECTED", "connectivityAt": "2021-08-11T12:21:26.681000-04:00", "containerInstanceArn": "arn:aws:ecs:us-east-1:123456789012:container-instance/test/025c7e2c5e054a6790a29fc1fEXAMPLE", "containers": [ { "containerArn": "arn:aws:ecs:us-east-1:123456789012:container/MyCluster/4d590253bb114126b7afa7b58eea9221/a992d1cc-ea46-474a-b6e8-24688EXAMPLE", "taskArn": "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/4d590253bb114126b7afa7b58EXAMPLE", "name": "simple-app", "image": "httpd:2.4", "runtimeId": "91251eed27db90006ad67b1a08187290869f216557717dd5c39b37c94EXAMPLE", "lastStatus": "RUNNING", "networkBindings": [ { "bindIP": "0.0.0.0", "containerPort": 80, "hostPort": 80, "protocol": "tcp" } ], "networkInterfaces": [], "healthStatus": "UNKNOWN", "cpu": "10", "memory": "300" } ], "cpu": "10", "createdAt": "2021-08-11T12:21:26.681000-04:00", "desiredStatus": "RUNNING", "enableExecuteCommand": false, "group": "service:testupdate", "healthStatus": "UNKNOWN", "lastStatus": "RUNNING", "launchType": "EC2", "memory": "300", "overrides": { "containerOverrides": [ { "name": "simple-app" } ], "inferenceAcceleratorOverrides": [] }, "pullStartedAt": "2021-08-11T12:21:28.234000-04:00", "pullStoppedAt": "2021-08-11T12:21:33.793000-04:00", "startedAt": "2021-08-11T12:21:34.945000-04:00", "startedBy": "ecs-svc/968695068243EXAMPLE", "tags": [], "taskArn": "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/4d590253bb114126b7afa7b58eea9221", "taskDefinitionArn": "arn:aws:ecs:us-east-1:123456789012:task-definition/console-sample-app-static2:1", "version": 2 } ], "failures": [] } ``` Para obter mais informações, consulte [Definições de tarefa do Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html) no *Guia do desenvolvedor do Amazon ECS*. **Exemplo 2: como descrever várias tarefas** O exemplo de `describe-tasks` a seguir recupera os detalhes de várias tarefas de um cluster. É possível especificar a tarefa usando o ID ou o ARN completo da tarefa. Este exemplo usa os IDs completos das tarefas. ``` aws ecs describe-tasks \ --cluster MyCluster \ --tasks "74de0355a10a4f979ac495c14EXAMPLE" "d789e94343414c25b9f6bd59eEXAMPLE" ``` Resultado: ``` { "tasks": [ { "attachments": [ { "id": "d9e7735a-16aa-4128-bc7a-b2d51EXAMPLE", "type": "ElasticNetworkInterface", "status": "ATTACHED", "details": [ { "name": "subnetId", "value": "subnet-0d0eab1bb3EXAMPLE" }, { "name": "networkInterfaceId", "value": "eni-0fa40520aeEXAMPLE" }, { "name": "macAddress", "value": "0e:89:76:28:07:b3" }, { "name": "privateDnsName", "value": "ip-10-0-1-184.ec2.internal" }, { "name": "privateIPv4Address", "value": "10.0.1.184" } ] } ], "attributes": [ { "name": "ecs.cpu-architecture", "value": "x86_64" } ], "availabilityZone": "us-east-1b", "clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/MyCluster", "connectivity": "CONNECTED", "connectivityAt": "2021-12-20T12:13:37.875000-05:00", "containers": [ { "containerArn": "arn:aws:ecs:us-east-1:123456789012:container/MyCluster/74de0355a10a4f979ac495c14EXAMPLE/aad3ba00-83b3-4dac-84d4-11f8cEXAMPLE", "taskArn": "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/74de0355a10a4f979ac495c14EXAMPLE", "name": "web", "image": "nginx", "runtimeId": "74de0355a10a4f979ac495c14EXAMPLE-265927825", "lastStatus": "RUNNING", "networkBindings": [], "networkInterfaces": [ { "attachmentId": "d9e7735a-16aa-4128-bc7a-b2d51EXAMPLE", "privateIpv4Address": "10.0.1.184" } ], "healthStatus": "UNKNOWN", "cpu": "99", "memory": "100" } ], "cpu": "256", "createdAt": "2021-12-20T12:13:20.226000-05:00", "desiredStatus": "RUNNING", "enableExecuteCommand": false, "group": "service:tdsevicetag", "healthStatus": "UNKNOWN", "lastStatus": "RUNNING", "launchType": "FARGATE", "memory": "512", "overrides": { "containerOverrides": [ { "name": "web" } ], "inferenceAcceleratorOverrides": [] }, "platformVersion": "1.4.0", "platformFamily": "Linux", "pullStartedAt": "2021-12-20T12:13:42.665000-05:00", "pullStoppedAt": "2021-12-20T12:13:46.543000-05:00", "startedAt": "2021-12-20T12:13:48.086000-05:00", "startedBy": "ecs-svc/988401040018EXAMPLE", "tags": [], "taskArn": "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/74de0355a10a4f979ac495c14EXAMPLE", "taskDefinitionArn": "arn:aws:ecs:us-east-1:123456789012:task-definition/webserver:2", "version": 3, "ephemeralStorage": { "sizeInGiB": 20 } }, { "attachments": [ { "id": "214eb5a9-45cd-4bf8-87bc-57fefEXAMPLE", "type": "ElasticNetworkInterface", "status": "ATTACHED", "details": [ { "name": "subnetId", "value": "subnet-0d0eab1bb3EXAMPLE" }, { "name": "networkInterfaceId", "value": "eni-064c7766daEXAMPLE" }, { "name": "macAddress", "value": "0e:76:83:01:17:a9" }, { "name": "privateDnsName", "value": "ip-10-0-1-41.ec2.internal" }, { "name": "privateIPv4Address", "value": "10.0.1.41" } ] } ], "attributes": [ { "name": "ecs.cpu-architecture", "value": "x86_64" } ], "availabilityZone": "us-east-1b", "clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/MyCluster", "connectivity": "CONNECTED", "connectivityAt": "2021-12-20T12:13:35.243000-05:00", "containers": [ { "containerArn": "arn:aws:ecs:us-east-1:123456789012:container/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE/9afef792-609b-43a5-bb6a-3efdbEXAMPLE", "taskArn": "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE", "name": "web", "image": "nginx", "runtimeId": "d789e94343414c25b9f6bd59eEXAMPLE-265927825", "lastStatus": "RUNNING", "networkBindings": [], "networkInterfaces": [ { "attachmentId": "214eb5a9-45cd-4bf8-87bc-57fefEXAMPLE", "privateIpv4Address": "10.0.1.41" } ], "healthStatus": "UNKNOWN", "cpu": "99", "memory": "100" } ], "cpu": "256", "createdAt": "2021-12-20T12:13:20.226000-05:00", "desiredStatus": "RUNNING", "enableExecuteCommand": false, "group": "service:tdsevicetag", "healthStatus": "UNKNOWN", "lastStatus": "RUNNING", "launchType": "FARGATE", "memory": "512", "overrides": { "containerOverrides": [ { "name": "web" } ], "inferenceAcceleratorOverrides": [] }, "platformVersion": "1.4.0", "platformFamily": "Linux", "pullStartedAt": "2021-12-20T12:13:44.611000-05:00", "pullStoppedAt": "2021-12-20T12:13:48.251000-05:00", "startedAt": "2021-12-20T12:13:49.326000-05:00", "startedBy": "ecs-svc/988401040018EXAMPLE", "tags": [], "taskArn": "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE", "taskDefinitionArn": "arn:aws:ecs:us-east-1:123456789012:task-definition/webserver:2", "version": 3, "ephemeralStorage": { "sizeInGiB": 20 } } ], "failures": [] } ``` Para obter mais informações, consulte [Definições de tarefa do Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html) no *Guia do desenvolvedor do Amazon ECS*. + Consulte detalhes da API em [DescribeTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-tasks.html) na *Referência de comandos da AWS CLI*. ### `execute-command` O código de exemplo a seguir mostra como usar `execute-command`. **AWS CLI** **Para executar um comando /bin/sh interativo** O exemplo `execute-command` a seguir executa um comando /bin/sh interativo em um contêiner chamado MyContainer para uma tarefa com o ID `arn:aws:ecs:us-east-1:123456789012:task/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE`. ``` aws ecs execute-command \ --cluster MyCluster \ --task arn:aws:ecs:us-east-1:123456789012:task/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE \ --container MyContainer \ --interactive \ --command "/bin/sh" ``` Este comando não produz saída. Para obter mais informações, consulte [Usar o Amazon ECS Exec para depuração](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html) no *Guia do desenvolvedor do Amazon ECS*. + Para ver detalhes da API, consulte [ExecuteCommand](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/execute-command.html) na *Referência de comandos da AWS CLI*. ### `get-task-protection` O código de exemplo a seguir mostra como usar `get-task-protection`. **AWS CLI** **Recuperar o status de proteção da tarefa no serviço do ECS** O `get-task-protection` a seguir fornece o status de proteção das tarefas do ECS que pertencem ao serviço do Amazon ECS. ``` aws ecs get-task-protection \ --cluster ECS-project-update-cluster \ --tasks c43ed3b1331041f289316f958adb6a24 ``` Resultado: ``` { "protectedTasks": [ { "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/c43ed3b1331041f289316f958adb6a24", "protectionEnabled": false } ], "failures": [] } ``` Consulte mais informações sobre proteção de tarefas em [Como proteger as tarefas do Amazon ECS de serem encerradas por eventos de redução horizontal da escala](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-scale-in-protection.html) no *Guia do desenvolvedor do Amazon ECS*. + Consulte detalhes da API em [GetTaskProtection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/get-task-protection.html) na *Referência de comandos da AWS CLI*. ### `list-account-settings` O código de exemplo a seguir mostra como usar `list-account-settings`. **AWS CLI** **Exemplo 1: ver as configurações de conta de uma conta** O exemplo `list-account-settings` a seguir exibe as configurações efetivas da conta. ``` aws ecs list-account-settings --effective-settings ``` Resultado: ``` { "settings": [ { "name": "containerInstanceLongArnFormat", "value": "enabled", "principalArn": "arn:aws:iam::123456789012:root" }, { "name": "serviceLongArnFormat", "value": "enabled", "principalArn": "arn:aws:iam::123456789012:root" }, { "name": "taskLongArnFormat", "value": "enabled", "principalArn": "arn:aws:iam::123456789012:root" } ] } ``` **Exemplo 2: visualizar as configurações de conta para um usuário ou perfil do IAM específico** O exemplo `list-account-settings` a seguir exibe as configurações de conta para o usuário ou perfil do IAM específico. ``` aws ecs list-account-settings --principal-arn arn:aws:iam::123456789012:user/MyUser ``` Resultado: ``` { "settings": [ { "name": "serviceLongArnFormat", "value": "enabled", "principalArn": "arn:aws:iam::123456789012:user/MyUser" } ] } ``` Para obter mais informações, consulte [Nomes de recursos da Amazon (ARNs) e IDs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-resource-ids.html) no *Guia do desenvolvedor do Amazon ECS*. + Para ver detalhes da API, consulte [ListAccountSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-account-settings.html) na *Referência de comandos da AWS CLI*. ### `list-attributes` O código de exemplo a seguir mostra como usar `list-attributes`. **AWS CLI** **Para listar as instâncias de contêiner que contêm um atributo específico** O exemplo a seguir lista os atributos das instâncias de contêineres que têm o atributo `stack=production` no cluster padrão. ``` aws ecs list-attributes \ --target-type container-instance \ --attribute-name stack \ --attribute-value production \ --cluster default ``` Resultado: ``` { "attributes": [ { "name": "stack", "targetId": "arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34", "value": "production" } ] } ``` Para obter mais informações, consulte [Configuração do agente de contêineres do Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) no *Guia do desenvolvedor do Amazon ECS*. + Para ver detalhes da API, consulte [ListAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-attributes.html) na *Referência de comandos da AWS CLI*. ### `list-clusters` O código de exemplo a seguir mostra como usar `list-clusters`. **AWS CLI** **Para listar os clusters disponíveis** O exemplo de `list-clusters` a seguir lista todos os clusters disponíveis. ``` aws ecs list-clusters ``` Resultado: ``` { "clusterArns": [ "arn:aws:ecs:us-west-2:123456789012:cluster/MyECSCluster1", "arn:aws:ecs:us-west-2:123456789012:cluster/AnotherECSCluster" ] } ``` Para obter mais informações, consulte [Clusters do Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_clusters.html) no *Guia do desenvolvedor do Amazon ECS*. + Consulte detalhes da API em [ListClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-clusters.html) na *Referência de comandos da AWS CLI*. ### `list-container-instances` O código de exemplo a seguir mostra como usar `list-container-instances`. **AWS CLI** **Para listar as instâncias de contêiner em um cluster** O exemplo `list-container-instances` a seguir lista todas as instâncias de contêineres disponíveis em um cluster. ``` aws ecs list-container-instances --cluster MyCluster ``` Resultado: ``` { "containerInstanceArns": [ "arn:aws:ecs:us-west-2:123456789012:container-instance/MyCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "arn:aws:ecs:us-west-2:123456789012:container-instance/MyCluster/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" ] } ``` Para obter mais informações, consulte [Instâncias de contêiner do Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_instances.html) no *Guia do desenvolvedor do Amazon ECS*. + Para ver detalhes da API, consulte [ListContainerInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-container-instances.html) na *Referência de comandos da AWS CLI*. ### `list-service-deployments` O código de exemplo a seguir mostra como usar `list-service-deployments`. **AWS CLI** **Como listar implantações de serviço** O exemplo de `list-service-deployments` a seguir recupera as implantações de serviço para o serviço chamado `example-service`. ``` aws ecs list-service-deployments \ --service arn:aws:ecs:us-east-1:123456789012:service/example-cluster/example-service ``` Resultado: ``` { "serviceDeployments": [ { "serviceDeploymentArn": "arn:aws:ecs:us-east-1:123456789012:service-deployment/example-cluster/example-service/ejGvqq2ilnbKT9qj0vLJe", "serviceArn": "arn:aws:ecs:us-east-1:123456789012:service/example-cluster/example-service", "clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/example-cluster", "startedAt": "2024-10-31T08:03:32.510000-04:00", "createdAt": "2024-10-31T08:03:30.917000-04:00", "finishedAt": "2024-10-31T08:05:04.527000-04:00", "targetServiceRevisionArn": "arn:aws:ecs:us-east-1:123456789012:service-revision/example-cluster/example-service/1485800978477494678", "status": "SUCCESSFUL" } ] } ``` Consulte mais informações em [Visualize o histórico de serviços usando implantações de serviços do Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-deployment.html) no *Guia do desenvolvedor do Amazon ECS*. + Consulte detalhes da API em [ListServiceDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-service-deployments.html) na *Referência de comandos da AWS CLI*. ### `list-services-by-namespace` O código de exemplo a seguir mostra como usar `list-services-by-namespace`. **AWS CLI** **Para listar os serviços em um namespace** O exemplo `list-services-by-namespace` a seguir lista todos os serviços configurados para o namespace especificado em sua região padrão. ``` aws ecs list-services-by-namespace \ --namespace service-connect ``` Resultado: ``` { "serviceArns": [ "arn:aws:ecs:us-west-2:123456789012:service/MyCluster/MyService", "arn:aws:ecs:us-west-2:123456789012:service/tutorial/service-connect-nginx-service" ] } ``` Para obter mais informações, consulte [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) no *Guia do desenvolvedor do Amazon ECS*. + Para ver detalhes da API, consulte [ListServicesByNamespace](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-services-by-namespace.html) na *Referência de comandos da AWS CLI*. ### `list-services` O código de exemplo a seguir mostra como usar `list-services`. **AWS CLI** **Para listar os serviços em um cluster** O exemplo de `list-services` a seguir mostra como listar os serviços em execução em um cluster. ``` aws ecs list-services --cluster MyCluster ``` Resultado: ``` { "serviceArns": [ "arn:aws:ecs:us-west-2:123456789012:service/MyCluster/MyService" ] } ``` Para obter mais informações, consulte [Serviços](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) no *Guia do desenvolvedor do Amazon ECS*. + Consulte detalhes da API em [ListServices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-services.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar as tags de um recurso** O exemplo `list-tags-for-resource` a seguir lista as marcas de um cluster específico. ``` aws ecs list-tags-for-resource \ --resource-arn arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster ``` Resultado: ``` { "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" }, { "key": "key3", "value": "value3" } ] } ``` + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `list-task-definition-families` O código de exemplo a seguir mostra como usar `list-task-definition-families`. **AWS CLI** **Exemplo 1: listar as famílias de definição de tarefas registradas** O exemplo `list-task-definition-families` a seguir lista todas as famílias de definição de tarefas registradas. ``` aws ecs list-task-definition-families ``` Resultado: ``` { "families": [ "node-js-app", "web-timer", "hpcc", "hpcc-c4-8xlarge" ] } ``` **Exemplo 2: filtrar as famílias de definição de tarefas registradas** O exemplo `list-task-definition-families` a seguir lista as revisões de definição de tarefas que começam com “hpcc”. ``` aws ecs list-task-definition-families --family-prefix hpcc ``` Resultado: ``` { "families": [ "hpcc", "hpcc-c4-8xlarge" ] } ``` Para obter mais informações, consulte [Parâmetros de definição de tarefas](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#family) no *Guia do desenvolvedor do Amazon ECS*. + Para ver detalhes da API, consulte [ListTaskDefinitionFamilies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-task-definition-families.html) na *Referência de comandos da AWS CLI*. ### `list-task-definitions` O código de exemplo a seguir mostra como usar `list-task-definitions`. **AWS CLI** **Exemplo 1: listar as definições de tarefas registradas** O exemplo `list-task-definitions` a seguir lista todas as definições de tarefas registradas. ``` aws ecs list-task-definitions ``` Resultado: ``` { "taskDefinitionArns": [ "arn:aws:ecs:us-west-2:123456789012:task-definition/sleep300:2", "arn:aws:ecs:us-west-2:123456789012:task-definition/sleep360:1", "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:3", "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:4", "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:5", "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:6" ] } ``` **Exemplo 2: listar as definições de tarefas registradas em uma família** O exemplo lista-task-definitions a seguir lista as revisões de definição de tarefas de uma família especificada. ``` aws ecs list-task-definitions --family-prefix wordpress ``` Resultado: ``` { "taskDefinitionArns": [ "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:3", "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:4", "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:5", "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:6" ] } ``` Para obter mais informações, consulte [Definições de tarefa do Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html) no *Guia do desenvolvedor do Amazon ECS*. + Para ver detalhes da API, consulte [ListTaskDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-task-definitions.html) na *Referência de comandos da AWS CLI*. ### `list-tasks` O código de exemplo a seguir mostra como usar `list-tasks`. **AWS CLI** **Exemplo 1: listar as tarefas em um cluster** O exemplo de `list-tasks` a seguir lista todas as tarefas de um cluster. ``` aws ecs list-tasks --cluster default ``` Resultado: ``` { "taskArns": [ "arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" ] } ``` **Exemplo 2: como listar as tarefas de uma instância de contêiner específica** O exemplo de `list-tasks` a seguir lista as tarefas de uma instância de contêiner, usando o UUID da instância de contêiner como filtro. ``` aws ecs list-tasks --cluster default --container-instance a1b2c3d4-5678-90ab-cdef-33333EXAMPLE ``` Resultado: ``` { "taskArns": [ "arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-cdef-44444EXAMPLE" ] } ``` Para obter mais informações, consulte [Definições de tarefa do Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html) no *Guia do desenvolvedor do Amazon ECS*. + Consulte detalhes da API em [ListTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-tasks.html) na *Referência de comandos da AWS CLI*. ### `put-account-setting-default` O código de exemplo a seguir mostra como usar `put-account-setting-default`. **AWS CLI** **Para modificar as configurações padrão da conta** O exemplo `put-account-setting-default` a seguir modifica a configuração padrão de conta para todos os usuários ou perfis do IAM na sua conta. Essas alterações se aplicarão a toda a conta da AWS, a menos que um usuário ou uma função do IAM cancele explicitamente essas configurações por conta própria. ``` aws ecs put-account-setting-default --name serviceLongArnFormat --value enabled ``` Resultado: ``` { "setting": { "name": "serviceLongArnFormat", "value": "enabled", "principalArn": "arn:aws:iam::123456789012:root" } } ``` Para obter mais informações, consulte [Nomes de recursos da Amazon (ARNs) e IDs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-resource-ids.html) no *Guia do desenvolvedor do Amazon ECS*. + Para ver detalhes da API, consulte [PutAccountSettingDefault](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/put-account-setting-default.html) na *Referência de comandos da AWS CLI*. ### `put-account-setting` O código de exemplo a seguir mostra como usar `put-account-setting`. **AWS CLI** **Para modificar configurações da sua conta de usuário do IAM** O exemplo de `put-account-setting` a seguir define a configuração da conta `containerInsights` como `enhanced` para a conta de usuário do IAM. Isso ativa o Container Insights com observabilidade aprimorada. ``` aws ecs put-account-setting \ --name containerInsights \ --value enhanced ``` Resultado: ``` { "setting": { "name": "containerInsights", "value": "enhanced", "principalArn": "arn:aws:iam::123456789012:user/johndoe", "type": "user" } } ``` Para obter mais informações, consulte [Modificar configurações da conta](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-modifying-longer-id-settings.html) no *Guia do desenvolvedor do Amazon ECS*. + Para ver detalhes da API, consulte [PutAccountSetting](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/put-account-setting.html) na *Referência de comandos da AWS CLI*. ### `put-account-settings` O código de exemplo a seguir mostra como usar `put-account-settings`. **AWS CLI** **Para modificar as configurações de conta para um usuário ou perfil do IAM** O exemplo `put-account-setting` a seguir modifica as configurações de conta para o usuário ou perfil específico do IAM. ``` aws ecs put-account-setting \ --name serviceLongArnFormat \ --value enabled \ --principal-arn arn:aws:iam::123456789012:user/MyUser ``` Resultado: ``` { "setting": { "name": "serviceLongArnFormat", "value": "enabled", "principalArn": "arn:aws:iam::123456789012:user/MyUser" } } ``` + Para ver detalhes da API, consulte [PutAccountSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/put-account-settings.html) na *Referência de comandos da AWS CLI*. ### `put-attributes` O código de exemplo a seguir mostra como usar `put-attributes`. **AWS CLI** **Para criar um atributo e associá-lo a um recurso do Amazon ECS** O `put-attributes` a seguir aplica um atributo com a pilha de nome e a produção de valor a uma instância de contêiner. ``` aws ecs put-attributes \ --attributes name=stack,value=production,targetId=arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34 ``` Resultado: ``` { "attributes": [ { "name": "stack", "targetId": "arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34", "value": "production" } ] } ``` + Para ver detalhes da API, consulte [PutAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/put-attributes.html) na *Referência de comandos da AWS CLI*. ### `put-cluster-capacity-providers` O código de exemplo a seguir mostra como usar `put-cluster-capacity-providers`. **AWS CLI** **Exemplo 1: adicionar um provedor de capacidade existente a um cluster** O exemplo `put-cluster-capacity-providers` a seguir adiciona um provedor de capacidade existente a um cluster. O comando `create-capacity-provider` é usado para criar um provedor de capacidade. O comando `describe-clusters` é usado para descrever os provedores de capacidade atuais e a estratégia padrão de provedor de capacidade associada a um cluster. Ao adicionar um novo provedor de capacidade a um cluster, você deve especificar todos os provedores de capacidade existentes, além do novo provedor de capacidade que você deseja associar ao cluster. Você também deve especificar a estratégia padrão do provedor de capacidade para associar ao cluster. Neste exemplo, o cluster `MyCluster` tem o provedor de capacidade `MyCapacityProvider2` associado a ele e você deseja adicionar o provedor de capacidade `MyCapacityProvider1` e incluí-lo na estratégia padrão do provedor de capacidade para que as tarefas sejam distribuídas uniformemente entre os dois provedores de capacidade. ``` aws ecs put-cluster-capacity-providers \ --cluster MyCluster \ --capacity-providers MyCapacityProvider1 MyCapacityProvider2 \ --default-capacity-provider-strategy capacityProvider=MyCapacityProvider1,weight=1 capacityProvider=MyCapacityProvider2,weight=1 ``` Resultado: ``` { "cluster": { "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", "clusterName": "MyCluster", "status": "ACTIVE", "registeredContainerInstancesCount": 0, "runningTasksCount": 0, "pendingTasksCount": 0, "activeServicesCount": 0, "statistics": [], "tags": [], "settings": [ { "name": "containerInsights", "value": "enabled" } ], "capacityProviders": [ "MyCapacityProvider1", "MyCapacityProvider2" ], "defaultCapacityProviderStrategy": [ { "capacityProvider": "MyCapacityProvider1", "weight": 1, "base": 0 }, { "capacityProvider": "MyCapacityProvider2", "weight": 1, "base": 0 } ], "attachments": [ { "id": "0fb0c8f4-6edd-4de1-9b09-17e470ee1918", "type": "as_policy", "status": "ACTIVE", "details": [ { "name": "capacityProviderName", "value": "MyCapacityProvider1" }, { "name": "scalingPolicyName", "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } ] }, { "id": "ae592060-2382-4663-9476-b015c685593c", "type": "as_policy", "status": "ACTIVE", "details": [ { "name": "capacityProviderName", "value": "MyCapacityProvider2" }, { "name": "scalingPolicyName", "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" } ] } ], "attachmentsStatus": "UPDATE_IN_PROGRESS" } } ``` Para obter mais informações, consulte [provedores de capacidade de clusters](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html) no *Guia do desenvolvedor do Amazon ECS*. **Exemplo 2: remover um provedor de capacidade de um cluster** O exemplo `put-cluster-capacity-providers` a seguir remove um provedor de capacidade existentes de um cluster. O comando `describe-clusters` é usado para descrever os provedores de capacidade atuais associados a um cluster. Ao remover um provedor de capacidade de um cluster, você deve especificar os provedores de capacidade que deseja que permaneçam associados ao cluster, bem como a estratégia padrão do provedor de capacidade a ser associada ao cluster. Neste exemplo, o cluster tem os provedores de capacidade `MyCapacityProvider1` e `MyCapacityProvider2` associados a ele e você deseja remover o provedor de capacidade `MyCapacityProvider2`, então você especifica somente `MyCapacityProvider1` no comando junto com a estratégia atualizada do provedor de capacidade padrão. ``` aws ecs put-cluster-capacity-providers \ --cluster MyCluster \ --capacity-providers MyCapacityProvider1 \ --default-capacity-provider-strategy capacityProvider=MyCapacityProvider1,weight=1,base=0 ``` Resultado: ``` { "cluster": { "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", "clusterName": "MyCluster", "status": "ACTIVE", "registeredContainerInstancesCount": 0, "runningTasksCount": 0, "pendingTasksCount": 0, "activeServicesCount": 0, "statistics": [], "tags": [], "settings": [ { "name": "containerInsights", "value": "enabled" } ], "capacityProviders": [ "MyCapacityProvider1" ], "defaultCapacityProviderStrategy": [ "capacityProvider": "MyCapacityProvider1", "weight": 1, "base": 0 ], "attachments": [ { "id": "0fb0c8f4-6edd-4de1-9b09-17e470ee1918", "type": "as_policy", "status": "ACTIVE", "details": [ { "name": "capacityProviderName", "value": "MyCapacityProvider1" }, { "name": "scalingPolicyName", "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } ] }, { "id": "ae592060-2382-4663-9476-b015c685593c", "type": "as_policy", "status": "DELETING", "details": [ { "name": "capacityProviderName", "value": "MyCapacityProvider2" }, { "name": "scalingPolicyName", "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" } ] } ], "attachmentsStatus": "UPDATE_IN_PROGRESS" } } ``` Para obter mais informações, consulte [provedores de capacidade de clusters](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html) no *Guia do desenvolvedor do Amazon ECS*. **Exemplo 3: remover todos os provedores de capacidade de um cluster** O exemplo `put-cluster-capacity-providers` a seguir remove todos os provedores de capacidade existentes do cluster. ``` aws ecs put-cluster-capacity-providers \ --cluster MyCluster \ --capacity-providers [] \ --default-capacity-provider-strategy [] ``` Resultado: ``` { "cluster": { "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", "clusterName": "MyCluster", "status": "ACTIVE", "registeredContainerInstancesCount": 0, "runningTasksCount": 0, "pendingTasksCount": 0, "activeServicesCount": 0, "statistics": [], "tags": [], "settings": [ { "name": "containerInsights", "value": "enabled" } ], "capacityProviders": [], "defaultCapacityProviderStrategy": [], "attachments": [ { "id": "0fb0c8f4-6edd-4de1-9b09-17e470ee1918", "type": "as_policy", "status": "DELETING", "details": [ { "name": "capacityProviderName", "value": "MyCapacityProvider1" }, { "name": "scalingPolicyName", "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } ] }, { "id": "ae592060-2382-4663-9476-b015c685593c", "type": "as_policy", "status": "DELETING", "details": [ { "name": "capacityProviderName", "value": "MyCapacityProvider2" }, { "name": "scalingPolicyName", "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" } ] } ], "attachmentsStatus": "UPDATE_IN_PROGRESS" } } ``` Para obter mais informações, consulte [provedores de capacidade de clusters](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html) no *Guia do desenvolvedor do Amazon ECS*. + Para ver detalhes da API, consulte [PutClusterCapacityProviders](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/put-cluster-capacity-providers.html) na *Referência de comandos da AWS CLI*. ### `register-task-definition` O código de exemplo a seguir mostra como usar `register-task-definition`. **AWS CLI** **Exemplo 1: registrar uma definição de tarefa com um arquivo JSON** O exemplo `register-task-definition` a seguir registra uma definição de tarefa na família especificada. As definições do contêiner são salvas no formato JSON no local do arquivo especificado. ``` aws ecs register-task-definition \ --cli-input-json file:///sleep360.json ``` Conteúdo de `sleep360.json`: ``` { "containerDefinitions": [ { "name": "sleep", "image": "busybox", "cpu": 10, "command": [ "sleep", "360" ], "memory": 10, "essential": true } ], "family": "sleep360" } ``` Resultado: ``` { "taskDefinition": { "status": "ACTIVE", "family": "sleep360", "placementConstraints": [], "compatibilities": [ "EXTERNAL", "EC2" ], "volumes": [], "taskDefinitionArn": "arn:aws:ecs:us-east-1:123456789012:task-definition/sleep360:1", "containerDefinitions": [ { "environment": [], "name": "sleep", "mountPoints": [], "image": "busybox", "cpu": 10, "portMappings": [], "command": [ "sleep", "360" ], "memory": 10, "essential": true, "volumesFrom": [] } ], "revision": 1 } } ``` Para obter mais informações, consulte [Exemplos de definições de tarefa](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/example_task_definitions.html) no *Guia do desenvolvedor do Amazon ECS*. **Exemplo 2: registrar uma definição de tarefa com um parâmetro de string JSON** O exemplo `register-task-definition` a seguir registra uma definição de tarefa usando definições de contêiner fornecidas como um parâmetro de string JSON com aspas duplas de escape. ``` aws ecs register-task-definition \ --family sleep360 \ --container-definitions "[{\"name\":\"sleep\",\"image\":\"busybox\",\"cpu\":10,\"command\":[\"sleep\",\"360\"],\"memory\":10,\"essential\":true}]" ``` A saída é idêntica ao exemplo anterior. Para obter mais informações, consulte [Criar uma definição de tarefa](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create-task-definition.html) no *Guia do desenvolvedor do Amazon ECS*. + Para ver detalhes da API, consulte [RegisterTaskDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/register-task-definition.html) na *Referência de comandos da AWS CLI*. ### `run-task` O código de exemplo a seguir mostra como usar `run-task`. **AWS CLI** **Exemplo 1: como executar uma tarefa no cluster padrão** O exemplo `run-task` a seguir executa uma tarefa no cluster padrão e usa um token de cliente. ``` aws ecs run-task \ --cluster default \ --task-definition sleep360:1 \ --client-token 550e8400-e29b-41d4-a716-446655440000 ``` Resultado: ``` { "tasks": [ { "attachments": [], "attributes": [ { "name": "ecs.cpu-architecture", "value": "x86_64" } ], "availabilityZone": "us-east-1b", "capacityProviderName": "example-capacity-provider", "clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/default", "containerInstanceArn": "arn:aws:ecs:us-east-1:123456789012:container-instance/default/bc4d2ec611d04bb7bb97e83ceEXAMPLE", "containers": [ { "containerArn": "arn:aws:ecs:us-east-1:123456789012:container/default/d6f51cc5bbc94a47969c92035e9f66f8/75853d2d-711e-458a-8362-0f0aEXAMPLE", "taskArn": "arn:aws:ecs:us-east-1:123456789012:task/default/d6f51cc5bbc94a47969c9203EXAMPLE", "name": "sleep", "image": "busybox", "lastStatus": "PENDING", "networkInterfaces": [], "cpu": "10", "memory": "10" } ], "cpu": "10", "createdAt": "2023-11-21T16:59:34.403000-05:00", "desiredStatus": "RUNNING", "enableExecuteCommand": false, "group": "family:sleep360", "lastStatus": "PENDING", "launchType": "EC2", "memory": "10", "overrides": { "containerOverrides": [ { "name": "sleep" } ], "inferenceAcceleratorOverrides": [] }, "tags": [], "taskArn": "arn:aws:ecs:us-east-1:123456789012:task/default/d6f51cc5bbc94a47969c9203EXAMPLE", "taskDefinitionArn": "arn:aws:ecs:us-east-1:123456789012:task-definition/sleep360:1", "version": 1 } ], "failures": [] } ``` Para obter mais informações, consulte [Execução de uma aplicação como uma tarefa do Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/standalone-task-create.html) no *Guia do desenvolvedor do Amazon ECS*. **Exemplo 2: como configurar um volume do Amazon EBS para uma tarefa autônoma** O exemplo de `run-task` a seguir configura um volume criptografado do Amazon EBS para uma tarefa do Fargate no cluster padrão. Você deve ter uma função de infraestrutura do Amazon ECS configurada com a política `AmazonECSInfrastructureRolePolicyForVolumes` gerenciada anexada. É necessário especificar uma definição de tarefa com o mesmo nome de volume da solicitação `run-task`. Este exemplo usa a opção `--cli-input-json` e um arquivo de entrada JSON chamado `ebs.json`. ``` aws ecs run-task \ --cli-input-json file://ebs.json ``` Conteúdo de `ebs.json`: ``` { "cluster": "default", "taskDefinition": "mytaskdef", "launchType": "FARGATE", "networkConfiguration":{ "awsvpcConfiguration":{ "assignPublicIp": "ENABLED", "securityGroups": ["sg-12344321"], "subnets":["subnet-12344321"] } }, "volumeConfigurations": [ { "name": "myEBSVolume", "managedEBSVolume": { "volumeType": "gp3", "sizeInGiB": 100, "roleArn":"arn:aws:iam::1111222333:role/ecsInfrastructureRole", "encrypted": true, "kmsKeyId": "arn:aws:kms:region:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" } } ] } ``` Resultado: ``` { "tasks": [ { "attachments": [ { "id": "ce868693-15ca-4083-91ac-f782f64000c9", "type": "ElasticNetworkInterface", "status": "PRECREATED", "details": [ { "name": "subnetId", "value": "subnet-070982705451dad82" } ] }, { "id": "a17ed863-786c-4372-b5b3-b23e53f37877", "type": "AmazonElasticBlockStorage", "status": "CREATED", "details": [ { "name": "roleArn", "value": "arn:aws:iam::123456789012:role/ecsInfrastructureRole" }, { "name": "volumeName", "value": "myEBSVolume" }, { "name": "deleteOnTermination", "value": "true" } ] } ], "attributes": [ { "name": "ecs.cpu-architecture", "value": "x86_64" } ], "availabilityZone": "us-west-2b", "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/default", "containers": [ { "containerArn": "arn:aws:ecs:us-west-2:123456789012:container/default/7f1fbd3629434cc4b82d72d2f09b67c9/e21962a2-f328-4699-98a3-5161ac2c186a", "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/default/7f1fbd3629434cc4b82d72d2f09b67c9", "name": "container-using-ebs", "image": "amazonlinux:2", "lastStatus": "PENDING", "networkInterfaces": [], "cpu": "0" } ], "cpu": "1024", "createdAt": "2025-01-23T10:29:46.650000-06:00", "desiredStatus": "RUNNING", "enableExecuteCommand": false, "group": "family:mytaskdef", "lastStatus": "PROVISIONING", "launchType": "FARGATE", "memory": "3072", "overrides": { "containerOverrides": [ { "name": "container-using-ebs" } ], "inferenceAcceleratorOverrides": [] }, "platformVersion": "1.4.0", "platformFamily": "Linux", "tags": [], "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/default/7f1fbd3629434cc4b82d72d2f09b67c9", "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:4", "version": 1, "ephemeralStorage": { "sizeInGiB": 20 }, "fargateEphemeralStorage": { "sizeInGiB": 20 } } ], "failures": [] } ``` Consulte mais informações em [Uso de volumes do Amazon EBS com o Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html) no *Guia do desenvolvedor do Amazon ECS*. + Para ver detalhes da API, consulte [RunTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/run-task.html) na *Referência de comandos da AWS CLI*. ### `start-task` O código de exemplo a seguir mostra como usar `start-task`. **AWS CLI** **Exemplo 1: como iniciar uma nova tarefa** O exemplo de `start-task` a seguir inicia uma tarefa usando a revisão mais recente da definição da tarefa `sleep360` na instância de contêiner especificada no cluster padrão. ``` aws ecs start-task \ --task-definition sleep360 \ --container-instances 765936fadbdd46b5991a4bd70c2a43d4 ``` Resultado: ``` { "tasks": [ { "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/default/666fdccc2e2d4b6894dd422f4eeee8f8", "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/default", "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/sleep360:3", "containerInstanceArn": "arn:aws:ecs:us-west-2:123456789012:container-instance/default/765936fadbdd46b5991a4bd70c2a43d4", "overrides": { "containerOverrides": [ { "name": "sleep" } ] }, "lastStatus": "PENDING", "desiredStatus": "RUNNING", "cpu": "128", "memory": "128", "containers": [ { "containerArn": "arn:aws:ecs:us-west-2:123456789012:container/75f11ed4-8a3d-4f26-a33b-ad1db9e02d41", "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/default/666fdccc2e2d4b6894dd422f4eeee8f8", "name": "sleep", "lastStatus": "PENDING", "networkInterfaces": [], "cpu": "10", "memory": "10" } ], "version": 1, "createdAt": 1563421494.186, "group": "family:sleep360", "launchType": "EC2", "attachments": [], "tags": [] } ], "failures": [] } ``` Para obter mais informações, consulte [Programação de contêineres no Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html) no *Guia do desenvolvedor do Amazon ECS*. **Exemplo 2: como configurar um volume do Amazon EBS ao iniciar uma tarefa** O exemplo de `start-task` a seguir configura um volume criptografado do Amazon EBS para uma tarefa na instância de contêiner especificada. Você deve ter uma função de infraestrutura do Amazon ECS configurada com a política `AmazonECSInfrastructureRolePolicyForVolumes` gerenciada anexada. É necessário especificar uma definição de tarefa com o mesmo nome de volume da solicitação `start-task`. Este exemplo usa a opção `--cli-input-json` e um arquivo de entrada JSON chamado `ebs.json` com o conteúdo a seguir. ``` aws ecs start-task \ --cli-input-json file://ebs.json \ --container-instances 765936fadbdd46b5991a4bd70c2a43d4 ``` Conteúdo de `ebs.json`: ``` { "cluster": "default", "taskDefinition": "mytaskdef", "networkConfiguration":{ "awsvpcConfiguration":{ "assignPublicIp": "ENABLED", "securityGroups": ["sg-12344321"], "subnets":["subnet-12344321"] } }, "volumeConfigurations": [ { "name": "myEBSVolume", "managedEBSVolume": { "volumeType": "gp3", "sizeInGiB": 100, "roleArn":"arn:aws:iam::123456789012:role/ecsInfrastructureRole", "encrypted": true, "kmsKeyId": "arn:aws:kms:region:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab" } } ] } ``` Resultado: ``` { "tasks": [ { "attachments": [ { "id": "aea29489-9dcd-49f1-8164-4d91566e1113", "type": "ElasticNetworkInterface", "status": "PRECREATED", "details": [ { "name": "subnetId", "value": "subnet-12344321" } ] }, { "id": "f29e1222-9a1e-410f-b499-a12a7cd6d42e", "type": "AmazonElasticBlockStorage", "status": "CREATED", "details": [ { "name": "roleArn", "value": "arn:aws:iam::123456789012:role/ecsInfrastructureRole" }, { "name": "volumeName", "value": "myEBSVolume" }, { "name": "deleteOnTermination", "value": "true" } ] } ], "attributes": [ { "name": "ecs.cpu-architecture", "value": "arm64" } ], "availabilityZone": "us-west-2c", "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/default", "containerInstanceArn": "arn:aws:ecs:us-west-2:123456789012:container-instance/default/765936fadbdd46b5991a4bd70c2a43d4", "containers": [ { "containerArn": "arn:aws:ecs:us-west-2:123456789012:container/default/bb122ace3ed84add92c00a351a03c69e/a4a9ed10-51c7-4567-9653-50e71b94f867", "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/default/bb122ace3ed84add92c00a351a03c69e", "name": "container-using-ebs", "image": "amazonlinux:2", "lastStatus": "PENDING", "networkInterfaces": [], "cpu": "0" } ], "cpu": "1024", "createdAt": "2025-01-23T14:51:05.191000-06:00", "desiredStatus": "RUNNING", "enableExecuteCommand": false, "group": "family:mytaskdef", "lastStatus": "PROVISIONING", "launchType": "EC2", "memory": "3072", "overrides": { "containerOverrides": [ { "name": "container-using-ebs" } ], "inferenceAcceleratorOverrides": [] }, "tags": [], "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/default/bb122ace3ed84add92c00a351a03c69e", "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:4", "version": 1 } ], "failures": [] } ``` Consulte mais informações em [Uso de volumes do Amazon EBS com o Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html) no *Guia do desenvolvedor do Amazon ECS*. + Para ver detalhes da API, consulte [StartTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/start-task.html) na *Referência de comandos da AWS CLI*. ### `stop-task` O código de exemplo a seguir mostra como usar `stop-task`. **AWS CLI** **Para interromper uma tarefa** O exemplo `stop-task` a seguir interrompe a execução da tarefa especificada no cluster padrão. ``` aws ecs stop-task \ --task 666fdccc2e2d4b6894dd422f4eeee8f8 ``` Resultado: ``` { "task": { "taskArn": "arn:aws:ecs:us-west-2:130757420319:task/default/666fdccc2e2d4b6894dd422f4eeee8f8", "clusterArn": "arn:aws:ecs:us-west-2:130757420319:cluster/default", "taskDefinitionArn": "arn:aws:ecs:us-west-2:130757420319:task-definition/sleep360:3", "containerInstanceArn": "arn:aws:ecs:us-west-2:130757420319:container-instance/default/765936fadbdd46b5991a4bd70c2a43d4", "overrides": { "containerOverrides": [] }, "lastStatus": "STOPPED", "desiredStatus": "STOPPED", "cpu": "128", "memory": "128", "containers": [], "version": 2, "stoppedReason": "Taskfailedtostart", "stopCode": "TaskFailedToStart", "connectivity": "CONNECTED", "connectivityAt": 1563421494.186, "pullStartedAt": 1563421494.252, "pullStoppedAt": 1563421496.252, "executionStoppedAt": 1563421497, "createdAt": 1563421494.186, "stoppingAt": 1563421497.252, "stoppedAt": 1563421497.252, "group": "family:sleep360", "launchType": "EC2", "attachments": [], "tags": [] } } ``` + Para ver detalhes da API, consulte [StopTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/stop-task.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como marcar um recurso** O exemplo `tag-resource` a seguir adiciona uma única tag ao recurso especificado. ``` aws ecs tag-resource \ --resource-arn arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster --tags key=key1,value=value1 ``` Este comando não produz saída. **Para adicionar várias tags a um recurso** O exemplo `tag-resource` a seguir adiciona várias tags ao compartilhamento de recursos especificado. ``` aws ecs tag-resource \ --resource-arn arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster \ --tags key=key1,value=value1 key=key2,value=value2 key=key3,value=value3 ``` Este comando não produz saída. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover uma tag de um recurso** O exemplo `untag-resource` a seguir remove as tags listadas do recurso especificado. ``` aws ecs untag-resource \ --resource-arn arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster \ --tag-keys key1,key2 ``` Este comando não produz saída. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-cluster-settings` O código de exemplo a seguir mostra como usar `update-cluster-settings`. **AWS CLI** **Para modificar as configurações do seu cluster** O exemplo de `update-cluster-settings` a seguir habilita o CloudWatch Container Insights com observabilidade aprimorada para o cluster `MyCluster`. ``` aws ecs update-cluster-settings \ --cluster MyCluster \ --settings name=containerInsights,value=enhanced ``` Resultado: ``` { "cluster": { "clusterArn": "arn:aws:ecs:us-esat-1:123456789012:cluster/MyCluster", "clusterName": "default", "status": "ACTIVE", "registeredContainerInstancesCount": 0, "runningTasksCount": 0, "pendingTasksCount": 0, "activeServicesCount": 0, "statistics": [], "tags": [], "settings": [ { "name": "containerInsights", "value": "enhanced" } ] } } ``` Para obter mais informações, consulte [Modificar configurações da conta](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-modifying-longer-id-settings.html) no *Guia do desenvolvedor do Amazon ECS*. + Para ver detalhes da API, consulte [UpdateClusterSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/update-cluster-settings.html) na *Referência de comandos da AWS CLI*. ### `update-cluster` O código de exemplo a seguir mostra como usar `update-cluster`. **AWS CLI** **Exemplo 1: atualizar o cluster do ECS habilitando containerInsights** O `update-cluster` a seguir atualiza o valor de containerInsights para `enabled` em um cluster já criado. Por padrão, isso está desabilitado. ``` aws ecs update-cluster \ --cluster ECS-project-update-cluster \ --settings name=containerInsights,value=enabled ``` Resultado: ``` "cluster": { "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/ECS-project-update-cluster", "clusterName": "ECS-project-update-cluster", "status": "ACTIVE", "registeredContainerInstancesCount": 0, "runningTasksCount": 0, "pendingTasksCount": 0, "activeServicesCount": 0, "statistics": [], "tags": [], "settings": [ { "name": "containerInsights", "value": "enabled" } ], "capacityProviders": [ "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt" ], "defaultCapacityProviderStrategy": [ { "capacityProvider": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt", "weight": 1, "base": 0 } ], "attachments": [ { "id": "069d002b-7634-42e4-b1d4-544f4c8f6380", "type": "as_policy", "status": "CREATED", "details": [ { "name": "capacityProviderName", "value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt" }, { "name": "scalingPolicyName", "value": "ECSManagedAutoScalingPolicy-152363a6-8c65-484c-b721-42c3e070ae93" } ] }, { "id": "08b5b6ca-45e9-4209-a65d-e962a27c490a", "type": "managed_draining", "status": "CREATED", "details": [ { "name": "capacityProviderName", "value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt" }, { "name": "autoScalingLifecycleHookName", "value": "ecs-managed-draining-termination-hook" } ] }, { "id": "45d0b36f-8cff-46b6-9380-1288744802ab", "type": "sc", "status": "ATTACHED", "details": [] } ], "attachmentsStatus": "UPDATE_COMPLETE", "serviceConnectDefaults": { "namespace": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-igwrsylmy3kwvcdx" } } ``` **Exemplo 2: atualizar o cluster do ECS para definir um namespace padrão do Service Connect** O `update-cluster` a seguir atualiza o cluster do ECS definindo um namespace padrão do Service Connect. ``` aws ecs update-cluster \ --cluster ECS-project-update-cluster \ --service-connect-defaults namespace=test ``` Resultado: ``` { "cluster": { "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/ECS-project-update-cluster", "clusterName": "ECS-project-update-cluster", "status": "ACTIVE", "registeredContainerInstancesCount": 0, "runningTasksCount": 0, "pendingTasksCount": 0, "activeServicesCount": 0, "statistics": [], "tags": [], "settings": [ { "name": "containerInsights", "value": "enabled" } ], "capacityProviders": [ "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt" ], "defaultCapacityProviderStrategy": [ { "capacityProvider": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt", "weight": 1, "base": 0 } ], "attachments": [ { "id": "069d002b-7634-42e4-b1d4-544f4c8f6380", "type": "as_policy", "status": "CREATED", "details": [ { "name": "capacityProviderName", "value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt" }, { "name": "scalingPolicyName", "value": "ECSManagedAutoScalingPolicy-152363a6-8c65-484c-b721-42c3e070ae93" } ] }, { "id": "08b5b6ca-45e9-4209-a65d-e962a27c490a", "type": "managed_draining", "status": "CREATED", "details": [ { "name": "capacityProviderName", "value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt" }, { "name": "autoScalingLifecycleHookName", "value": "ecs-managed-draining-termination-hook" } ] }, { "id": "45d0b36f-8cff-46b6-9380-1288744802ab", "type": "sc", "status": "DELETED", "details": [] }, { "id": "3e6890c3-609c-4832-91de-d6ca891b3ef1", "type": "sc", "status": "ATTACHED", "details": [] }, { "id": "961b8ec1-c2f1-4070-8495-e669b7668e90", "type": "sc", "status": "DELETED", "details": [] } ], "attachmentsStatus": "UPDATE_COMPLETE", "serviceConnectDefaults": { "namespace": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-dtjmxqpfi46ht7dr" } } } ``` Consulte mais informações sobre o Service Connect em [Uso do Service Connect para conectar serviços do Amazon ECS com nomes abreviados](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) no *Guia do desenvolvedor do Amazon ECS*. + Para ver detalhes da API, consulte [UpdateCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/update-cluster.html) na *Referência de comandos da AWS CLI*. ### `update-container-agent` O código de exemplo a seguir mostra como usar `update-container-agent`. **AWS CLI** **Para atualizar o agente de contêiner em uma instância de contêiner do Amazon ECS** O exemplo `update-container-agent` a seguir atualiza o agente de contêiner na instância de contêiner especificada no cluster padrão. ``` aws ecs update-container-agent --cluster default --container-instance a1b2c3d4-5678-90ab-cdef-11111EXAMPLE ``` Resultado: ``` { "containerInstance": { "status": "ACTIVE", ... "agentUpdateStatus": "PENDING", "versionInfo": { "agentVersion": "1.0.0", "agentHash": "4023248", "dockerVersion": "DockerVersion: 1.5.0" } } } ``` Para obter mais informações, consulte [Atualização do agente de contêineres do Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) no *Guia do desenvolvedor do Amazon ECS*. + Para ver detalhes da API, consulte [UpdateContainerAgent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/update-container-agent.html) na *Referência de comandos da AWS CLI*. ### `update-container-instances-state` O código de exemplo a seguir mostra como usar `update-container-instances-state`. **AWS CLI** **Para atualizar o estado de uma instância de contêiner** O `update-container-instances-state` a seguir atualiza o estado da instância de contêiner especificada para o `DRAINING` que a removerá do cluster em que está registrada. ``` aws ecs update-container-instances-state \ --container-instances 765936fadbdd46b5991a4bd70c2a43d4 \ --status DRAINING ``` Resultado: ``` { "containerInstances": [ { "containerInstanceArn": "arn:aws:ecs:us-west-2:130757420319:container-instance/default/765936fadbdd46b5991a4bd70c2a43d4", "ec2InstanceId": "i-013d87ffbb4d513bf", "version": 4390, "versionInfo": { "agentVersion": "1.29.0", "agentHash": "a190a73f", "dockerVersion": "DockerVersion:18.06.1-ce" }, "remainingResources": [ { "name": "CPU", "type": "INTEGER", "doubleValue": 0, "longValue": 0, "integerValue": 1536 }, { "name": "MEMORY", "type": "INTEGER", "doubleValue": 0, "longValue": 0, "integerValue": 2681 }, { "name": "PORTS", "type": "STRINGSET", "doubleValue": 0, "longValue": 0, "integerValue": 0, "stringSetValue": [ "22", "2376", "2375", "51678", "51679" ] }, { "name": "PORTS_UDP", "type": "STRINGSET", "doubleValue": 0, "longValue": 0, "integerValue": 0, "stringSetValue": [] } ], "registeredResources": [ { "name": "CPU", "type": "INTEGER", "doubleValue": 0, "longValue": 0, "integerValue": 2048 }, { "name": "MEMORY", "type": "INTEGER", "doubleValue": 0, "longValue": 0, "integerValue": 3705 }, { "name": "PORTS", "type": "STRINGSET", "doubleValue": 0, "longValue": 0, "integerValue": 0, "stringSetValue": [ "22", "2376", "2375", "51678", "51679" ] }, { "name": "PORTS_UDP", "type": "STRINGSET", "doubleValue": 0, "longValue": 0, "integerValue": 0, "stringSetValue": [] } ], "status": "DRAINING", "agentConnected": true, "runningTasksCount": 2, "pendingTasksCount": 0, "attributes": [ { "name": "ecs.capability.secrets.asm.environment-variables" }, { "name": "ecs.capability.branch-cni-plugin-version", "value": "e0703516-" }, { "name": "ecs.ami-id", "value": "ami-00e0090ac21971297" }, { "name": "ecs.capability.secrets.asm.bootstrap.log-driver" }, { "name": "com.amazonaws.ecs.capability.logging-driver.none" }, { "name": "ecs.capability.ecr-endpoint" }, { "name": "ecs.capability.docker-plugin.local" }, { "name": "ecs.capability.task-cpu-mem-limit" }, { "name": "ecs.capability.secrets.ssm.bootstrap.log-driver" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.30" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.31" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.32" }, { "name": "ecs.availability-zone", "value": "us-west-2c" }, { "name": "ecs.capability.aws-appmesh" }, { "name": "com.amazonaws.ecs.capability.logging-driver.awslogs" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.24" }, { "name": "ecs.capability.task-eni-trunking" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.25" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.26" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.27" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.28" }, { "name": "com.amazonaws.ecs.capability.privileged-container" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.29" }, { "name": "ecs.cpu-architecture", "value": "x86_64" }, { "name": "com.amazonaws.ecs.capability.ecr-auth" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.20" }, { "name": "ecs.os-type", "value": "linux" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.21" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.22" }, { "name": "ecs.capability.task-eia" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.23" }, { "name": "ecs.capability.private-registry-authentication.secretsmanager" }, { "name": "com.amazonaws.ecs.capability.logging-driver.syslog" }, { "name": "com.amazonaws.ecs.capability.logging-driver.json-file" }, { "name": "ecs.capability.execution-role-awslogs" }, { "name": "ecs.vpc-id", "value": "vpc-1234" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.17" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.18" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.19" }, { "name": "ecs.capability.task-eni" }, { "name": "ecs.capability.execution-role-ecr-pull" }, { "name": "ecs.capability.container-health-check" }, { "name": "ecs.subnet-id", "value": "subnet-1234" }, { "name": "ecs.instance-type", "value": "c5.large" }, { "name": "com.amazonaws.ecs.capability.task-iam-role-network-host" }, { "name": "ecs.capability.container-ordering" }, { "name": "ecs.capability.cni-plugin-version", "value": "91ccefc8-2019.06.0" }, { "name": "ecs.capability.pid-ipc-namespace-sharing" }, { "name": "ecs.capability.secrets.ssm.environment-variables" }, { "name": "com.amazonaws.ecs.capability.task-iam-role" } ], "registeredAt": 1560788724.507, "attachments": [], "tags": [] } ], "failures": [] } ``` + Para ver detalhes da API, consulte [UpdateContainerInstancesState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/update-container-instances-state.html) na *Referência de comandos da AWS CLI*. ### `update-service-primary-task-set` O código de exemplo a seguir mostra como usar `update-service-primary-task-set`. **AWS CLI** **Para atualizar o conjunto de tarefas principal de um serviço** O exemplo `update-service-primary-task-set` a seguir atualiza o conjunto de tarefas principal para o serviço especificado. ``` aws ecs update-service-primary-task-set \ --cluster MyCluster \ --service MyService \ --primary-task-set arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789 ``` Resultado: ``` { "taskSet": { "id": "ecs-svc/1234567890123456789", "taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789", "status": "PRIMARY", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:2", "computedDesiredCount": 1, "pendingCount": 0, "runningCount": 0, "createdAt": 1557128360.711, "updatedAt": 1557129412.653, "launchType": "EC2", "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321" ], "securityGroups": [ "sg-12344312" ], "assignPublicIp": "DISABLED" } }, "loadBalancers": [], "serviceRegistries": [], "scale": { "value": 50.0, "unit": "PERCENT" }, "stabilityStatus": "STABILIZING", "stabilityStatusAt": 1557129279.914 } } ``` + Para ver detalhes da API, consulte [UpdateServicePrimaryTaskSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/update-service-primary-task-set.html) na *Referência de comandos da AWS CLI*. ### `update-service` O código de exemplo a seguir mostra como usar `update-service`. **AWS CLI** **Exemplo 1: como alterar a definição de tarefa usada em um serviço** O exemplo de `update-service` a seguir atualiza o serviço `my-http-service` para usar a definição de tarefa `amazon-ecs-sample`. ``` aws ecs update-service \ --cluster test \ --service my-http-service \ --task-definition amazon-ecs-sample ``` Resultado: ``` { "service": { "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/test/my-http-service", "serviceName": "my-http-service", "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/test", "loadBalancers": [], "serviceRegistries": [], "status": "ACTIVE", "desiredCount": 2, "runningCount": 2, "pendingCount": 0, "launchType": "FARGATE", "platformVersion": "1.4.0", "platformFamily": "Linux", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/amazon-ecs-sample:2", "deploymentConfiguration": { "deploymentCircuitBreaker": { "enable": true, "rollback": true }, "maximumPercent": 200, "minimumHealthyPercent": 100, "alarms": { "alarmNames": [], "rollback": false, "enable": false } }, "deployments": [ { "id": "ecs-svc/7419115625193919142", "status": "PRIMARY", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/amazon-ecs-sample:2", "desiredCount": 0, "pendingCount": 0, "runningCount": 0, "failedTasks": 0, "createdAt": "2025-02-21T13:26:02.734000-06:00", "updatedAt": "2025-02-21T13:26:02.734000-06:00", "launchType": "FARGATE", "platformVersion": "1.4.0", "platformFamily": "Linux", "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321" ], "securityGroups": [ "sg-12344321" ], "assignPublicIp": "ENABLED" } }, "rolloutState": "IN_PROGRESS", "rolloutStateReason": "ECS deployment ecs-svc/7419115625193919142 in progress." }, { "id": "ecs-svc/1709597507655421668", "status": "ACTIVE", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/old-amazon-ecs-sample:4", "desiredCount": 2, "pendingCount": 0, "runningCount": 2, "failedTasks": 0, "createdAt": "2025-01-24T11:13:07.621000-06:00", "updatedAt": "2025-02-02T16:11:30.838000-06:00", "launchType": "FARGATE", "platformVersion": "1.4.0", "platformFamily": "Linux", "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321" ], "securityGroups": [ "sg-12344321" ], "assignPublicIp": "ENABLED" } }, "rolloutState": "COMPLETED", "rolloutStateReason": "ECS deployment ecs-svc/1709597507655421668 completed." } ], "roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS", "events": [ { "id": "e40b4d1c-80d9-4834-aaf3-6a268e530e17", "createdAt": "2025-02-21T10:31:26.037000-06:00", "message": "(my-http-service) has reached a steady state." }, { "id": "6ac069ad-fc8b-4e49-a35d-b5574a964c8e", "createdAt": "2025-02-21T04:31:22.703000-06:00", "message": "(my-http-service) has reached a steady state." }, { "id": "265f7d37-dfd1-4880-a846-ec486f341919", "createdAt": "2025-02-20T22:31:22.514000-06:00", "message": "(my-http-service) has reached a steady state." } ], "createdAt": "2024-10-30T17:12:43.218000-05:00", "placementConstraints": [], "placementStrategy": [], "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321", ], "securityGroups": [ "sg-12344321" ], "assignPublicIp": "ENABLED" } }, "healthCheckGracePeriodSeconds": 0, "schedulingStrategy": "REPLICA", "deploymentController": { "type": "ECS" }, "createdBy": "arn:aws:iam::123456789012:role/AIDACKCEVSQ6C2EXAMPLE", "enableECSManagedTags": true, "propagateTags": "NONE", "enableExecuteCommand": false, "availabilityZoneRebalancing": "DISABLED" } } ``` Consulte mais informações em [Atualização de um serviço do Amazon ECS usando o console](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-service-console-v2.html) no *Guia do desenvolvedor do Amazon ECS*. **Exemplo 2: alterar o número de tarefas em um serviço** O exemplo de `update-service` a seguir atualiza a contagem de tarefas desejada do serviço `my-http-service` para 2. ``` aws ecs update-service \ --cluster MyCluster \ --service my-http-service \ --desired-count 2 ``` Resultado: ``` { "service": { "serviceArn": "arn:aws:ecs:us-east-1:123456789012:service/MyCluster/my-http-service", "serviceName": "my-http-service", "clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/MyCluster", "loadBalancers": [], "serviceRegistries": [], "status": "ACTIVE", "desiredCount": 2, "runningCount": 1, "pendingCount": 0, "capacityProviderStrategy": [ { "capacityProvider": "FARGATE", "weight": 1, "base": 0 } ], "platformVersion": "LATEST", "platformFamily": "Linux", "taskDefinition": "arn:aws:ecs:us-east-1:123456789012:task-definition/MyTaskDefinition", "deploymentConfiguration": { "deploymentCircuitBreaker": { "enable": true, "rollback": true }, "maximumPercent": 200, "minimumHealthyPercent": 100, "alarms": { "alarmNames": [], "rollback": false, "enable": false } }, "deployments": [ { "id": "ecs-svc/1976744184940610707", "status": "PRIMARY", "taskkDefinition": "arn:aws:ecs:us-east-1:123456789012:task-definition/MyTaskDefinition", "desiredCount": 1, "pendingCount": 0, "runningCount": 1, "failedTasks": 0, "createdAt": "2024-12-03T16:24:25.225000-05:00", "updatedAt": "2024-12-03T16:25:15.837000-05:00", "capacityProviderStrategy": [ { "capacityProvider": "FARGATE", "weight": 1, "base": 0 } ], "platformVersion": "1.4.0", "platformFamily": "Linux", "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-0d0eab1bb38d5ca64", "subnet-0db5010045995c2d5" ], "securityGroups": [ "sg-02556bf85a191f59a" ], "assignPublicIp": "ENABLED" } }, "rolloutState": "COMPLETED", "rolloutStateReason": "ECS deployment ecs-svc/1976744184940610707 completed." } ], "roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS", "events": [ { "id": "f27350b9-4b2a-4e2e-b72e-a4b68380de45", "createdAt": "2024-12-30T13:24:07.345000-05:00", "message": "(service my-http-service) has reached a steady state." }, { "id": "e764ec63-f53f-45e3-9af2-d99f922d2957", "createdAt": "2024-12-30T12:32:21.600000-05:00", "message": "(service my-http-service) has reached a steady state." }, { "id": "28444756-c2fa-47f8-bd60-93a8e05f3991", "createdAt": "2024-12-08T19:26:10.367000-05:00", "message": "(service my-http-service) has reached a steady state." } ], "createdAt": "2024-12-03T16:24:25.225000-05:00", "placementConstraints": [], "placementStrategy": [], "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-0d0eab1bb38d5ca64", "subnet-0db5010045995c2d5" ], "securityGroups": [ "sg-02556bf85a191f59a" ], "assignPublicIp": "ENABLED" } }, "healthCheckGracePeriodSeconds": 0, "schedulingStrategy": "REPLICA", "deploymentController": { "type": "ECS" }, "createdBy": "arn:aws:iam::123456789012:role/Admin", "enableECSManagedTags": true, "propagateTags": "NONE", "enableExecuteCommand": false, "availabilityZoneRebalancing": "ENABLED" } } ``` Consulte mais informações em [Atualização de um serviço do Amazon ECS usando o console](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-service-console-v2.html) no *Guia do desenvolvedor do Amazon ECS*. **Exemplo 3: como configurar volumes do Amazon EBS para anexação na atualização do serviço** O exemplo de `update-service` a seguir atualiza o serviço `my-http-service` para usar volumes do Amazon EBS. Você deve ter uma função de infraestrutura do Amazon ECS configurada com a política `AmazonECSInfrastructureRolePolicyForVolumes` gerenciada anexada. Você também deve especificar uma definição de tarefa com o mesmo nome de volume da solicitação `update-service` e com `configuredAtLaunch` definida como `true`. Este exemplo usa a opção `--cli-input-json` e um arquivo de entrada JSON chamado `ebs.json`. ``` aws ecs update-service \ --cli-input-json file://ebs.json ``` Conteúdo de `ebs.json`: ``` { "cluster": "mycluster", "taskDefinition": "mytaskdef", "service": "my-http-service", "desiredCount": 2, "volumeConfigurations": [ { "name": "myEbsVolume", "managedEBSVolume": { "roleArn":"arn:aws:iam::123456789012:role/ecsInfrastructureRole", "volumeType": "gp3", "sizeInGiB": 100, "iops": 3000, "throughput": 125, "filesystemType": "ext4" } } ] } ``` Resultado: ``` { "service": { "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/mycluster/my-http-service", "serviceName": "my-http-service", "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/mycluster", "loadBalancers": [], "serviceRegistries": [], "status": "ACTIVE", "desiredCount": 2, "runningCount": 2, "pendingCount": 0, "launchType": "FARGATE", "platformVersion": "LATEST", "platformFamily": "Linux", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:1", "deploymentConfiguration": { "deploymentCircuitBreaker": { "enable": true, "rollback": true }, "maximumPercent": 200, "minimumHealthyPercent": 100, "alarms": { "alarmNames": [], "rollback": false, "enable": false } }, "deployments": [ { "id": "ecs-svc/2420458347226626275", "status": "PRIMARY", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:1", "desiredCount": 0, "pendingCount": 0, "runningCount": 0, "failedTasks": 0, "createdAt": "2025-02-21T15:07:20.519000-06:00", "updatedAt": "2025-02-21T15:07:20.519000-06:00", "launchType": "FARGATE", "platformVersion": "1.4.0", "platformFamily": "Linux", "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321", ], "securityGroups": [ "sg-12344321" ], "assignPublicIp": "ENABLED" } }, "rolloutState": "IN_PROGRESS", "rolloutStateReason": "ECS deployment ecs-svc/2420458347226626275 in progress.", "volumeConfigurations": [ { "name": "ebs-volume", "managedEBSVolume": { "volumeType": "gp3", "sizeInGiB": 100, "iops": 3000, "throughput": 125, "roleArn": "arn:aws:iam::123456789012:role/ecsInfrastructureRole", "filesystemType": "ext4" } } ] }, { "id": "ecs-svc/5191625155316533644", "status": "ACTIVE", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:2", "desiredCount": 2, "pendingCount": 0, "runningCount": 2, "failedTasks": 0, "createdAt": "2025-02-21T14:54:48.862000-06:00", "updatedAt": "2025-02-21T14:57:22.502000-06:00", "launchType": "FARGATE", "platformVersion": "1.4.0", "platformFamily": "Linux", "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321" ], "securityGroups": [ "sg-12344321" ], "assignPublicIp": "ENABLED" } }, "rolloutState": "COMPLETED", "rolloutStateReason": "ECS deployment ecs-svc/5191625155316533644 completed." } ], "roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS", "events": [ { "id": "b5823113-c2c5-458e-9649-8c2ed38f23a5", "createdAt": "2025-02-21T14:57:22.508000-06:00", "message": "(service my-http-service) has reached a steady state." }, { "id": "b05a48e8-da35-4074-80aa-37ceb3167357", "createdAt": "2025-02-21T14:57:22.507000-06:00", "message": "(service my-http-service) (deployment ecs-svc/5191625155316533644) deployment completed." }, { "id": "a10cd55d-4ba6-4cea-a655-5a5d32ada8a0", "createdAt": "2025-02-21T14:55:32.833000-06:00", "message": "(service my-http-service) has started 1 tasks: (task fb9c8df512684aec92f3c57dc3f22361)." }, ], "createdAt": "2025-02-21T14:54:48.862000-06:00", "placementConstraints": [], "placementStrategy": [], "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321" ], "securityGroups": [ "sg-12344321" ], "assignPublicIp": "ENABLED" } }, "healthCheckGracePeriodSeconds": 0, "schedulingStrategy": "REPLICA", "deploymentController": { "type": "ECS" }, "createdBy": "arn:aws:iam::123456789012:role/AIDACKCEVSQ6C2EXAMPLE", "enableECSManagedTags": true, "propagateTags": "NONE", "enableExecuteCommand": false, "availabilityZoneRebalancing": "ENABLED" } } ``` Consulte mais informações em [Uso de volumes do Amazon EBS com o Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html) no *Guia do desenvolvedor do Amazon ECS*. **Exemplo 4: como atualizar um serviço para não usar mais volumes do Amazon EBS** O exemplo de `update-service` a seguir atualiza o serviço `my-http-service` para deixar de usar volumes do Amazon EBS. Você deve especificar uma revisão de definição de tarefa com `configuredAtLaunch` definida como `false`. ``` aws ecs update-service \ --cluster mycluster \ --task-definition mytaskdef \ --service my-http-service \ --desired-count 2 \ --volume-configurations "[]" ``` Resultado: ``` { "service": { "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/mycluster/my-http-service", "serviceName": "my-http-service", "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/mycluster", "loadBalancers": [], "serviceRegistries": [], "status": "ACTIVE", "desiredCount": 2, "runningCount": 2, "pendingCount": 0, "launchType": "FARGATE", "platformVersion": "LATEST", "platformFamily": "Linux", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:3", "deploymentConfiguration": { "deploymentCircuitBreaker": { "enable": true, "rollback": true }, "maximumPercent": 200, "minimumHealthyPercent": 100, "alarms": { "alarmNames": [], "rollback": false, "enable": false } }, "deployments": [ { "id": "ecs-svc/7522791612543716777", "status": "PRIMARY", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:3", "desiredCount": 0, "pendingCount": 0, "runningCount": 0, "failedTasks": 0, "createdAt": "2025-02-21T15:25:38.598000-06:00", "updatedAt": "2025-02-21T15:25:38.598000-06:00", "launchType": "FARGATE", "platformVersion": "1.4.0", "platformFamily": "Linux", "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321" ], "securityGroups": [ "sg-12344321" ], "assignPublicIp": "ENABLED" } }, "rolloutState": "IN_PROGRESS", "rolloutStateReason": "ECS deployment ecs-svc/7522791612543716777 in progress." }, { "id": "ecs-svc/2420458347226626275", "status": "ACTIVE", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/myoldtaskdef:1", "desiredCount": 2, "pendingCount": 0, "runningCount": 2, "failedTasks": 0, "createdAt": "2025-02-21T15:07:20.519000-06:00", "updatedAt": "2025-02-21T15:10:59.955000-06:00", "launchType": "FARGATE", "platformVersion": "1.4.0", "platformFamily": "Linux", "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321" ], "securityGroups": [ "sg-12344321" ], "assignPublicIp": "ENABLED" } }, "rolloutState": "COMPLETED", "rolloutStateReason": "ECS deployment ecs-svc/2420458347226626275 completed.", "volumeConfigurations": [ { "name": "ebs-volume", "managedEBSVolume": { "volumeType": "gp3", "sizeInGiB": 100, "iops": 3000, "throughput": 125, "roleArn": "arn:aws:iam::123456789012:role/ecsInfrastructureRole", "filesystemType": "ext4" } } ] } ], "roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS", "events": [ { "id": "4f2c3ca1-7800-4048-ba57-bba210ada2ad", "createdAt": "2025-02-21T15:10:59.959000-06:00", "message": "(service my-http-service) has reached a steady state." }, { "id": "4b36a593-2d40-4ed6-8be8-b9b699eb6198", "createdAt": "2025-02-21T15:10:59.958000-06:00", "message": "(service my-http-service) (deployment ecs-svc/2420458347226626275) deployment completed." }, { "id": "88380089-14e2-4ef0-8dbb-a33991683371", "createdAt": "2025-02-21T15:09:39.055000-06:00", "message": "(service my-http-service) has stopped 1 running tasks: (task fb9c8df512684aec92f3c57dc3f22361)." }, { "id": "97d84243-d52f-4255-89bb-9311391c61f6", "createdAt": "2025-02-21T15:08:57.653000-06:00", "message": "(service my-http-service) has stopped 1 running tasks: (task 33eff090ad2c40539daa837e6503a9bc)." }, { "id": "672ece6c-e2d0-4021-b5da-eefb14001687", "createdAt": "2025-02-21T15:08:15.631000-06:00", "message": "(service my-http-service) has started 1 tasks: (task 996c02a66ff24f3190a4a8e0c841740f)." }, { "id": "a3cf9bea-9be6-4175-ac28-4c68360986eb", "createdAt": "2025-02-21T15:07:36.931000-06:00", "message": "(service my-http-service) has started 1 tasks: (task d5d23c39f89e46cf9a647b9cc6572feb)." }, { "id": "b5823113-c2c5-458e-9649-8c2ed38f23a5", "createdAt": "2025-02-21T14:57:22.508000-06:00", "message": "(service my-http-service) has reached a steady state." }, { "id": "b05a48e8-da35-4074-80aa-37ceb3167357", "createdAt": "2025-02-21T14:57:22.507000-06:00", "message": "(service my-http-service) (deployment ecs-svc/5191625155316533644) deployment completed." }, { "id": "a10cd55d-4ba6-4cea-a655-5a5d32ada8a0", "createdAt": "2025-02-21T14:55:32.833000-06:00", "message": "(service my-http-service) has started 1 tasks: (task fb9c8df512684aec92f3c57dc3f22361)." }, { "id": "42da91fa-e26d-42ef-88c3-bb5965c56b2f", "createdAt": "2025-02-21T14:55:02.703000-06:00", "message": "(service my-http-service) has started 1 tasks: (task 33eff090ad2c40539daa837e6503a9bc)." } ], "createdAt": "2025-02-21T14:54:48.862000-06:00", "placementConstraints": [], "placementStrategy": [], "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321" ], "securityGroups": [ "sg-12344321" ], "assignPublicIp": "ENABLED" } }, "healthCheckGracePeriodSeconds": 0, "schedulingStrategy": "REPLICA", "deploymentController": { "type": "ECS" }, "createdBy": "arn:aws:iam::123456789012:role/AIDACKCEVSQ6C2EXAMPLE", "enableECSManagedTags": true, "propagateTags": "NONE", "enableExecuteCommand": false, "availabilityZoneRebalancing": "ENABLED" } } ``` Consulte mais informações em [Uso de volumes do Amazon EBS com o Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html) no *Guia do desenvolvedor do Amazon ECS*. **Exemplo 5: como ativar o rebalanceamento da zona de disponibilidade para um serviço** O exemplo de `update-service` a seguir ativa o rebalanceamento da zona de disponibilidade para o serviço `my-http-service`. ``` aws ecs update-service \ --cluster MyCluster \ --service my-http-service \ --availability-zone-rebalancing ENABLED ``` Resultado: ``` { "service": { "serviceArn": "arn:aws:ecs:us-east-1:123456789012:service/MyCluster/my-http-service", "serviceName": "my-http-service", "clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/MyCluster", "loadBalancers": [], "serviceRegistries": [], "status": "ACTIVE", "desiredCount": 2, "runningCount": 1, "pendingCount": 0, "capacityProviderStrategy": [ { "capacityProvider": "FARGATE", "weight": 1, "base": 0 } ], "platformVersion": "LATEST", "platformFamily": "Linux", "taskDefinition": "arn:aws:ecs:us-east-1:123456789012:task-definition/MyTaskDefinition", "deploymentConfiguration": { "deploymentCircuitBreaker": { "enable": true, "rollback": true }, "maximumPercent": 200, "minimumHealthyPercent": 100, "alarms": { "alarmNames": [], "rollback": false, "enable": false } }, "deployments": [ { "id": "ecs-svc/1976744184940610707", "status": "PRIMARY", "taskkDefinition": "arn:aws:ecs:us-east-1:123456789012:task-definition/MyTaskDefinition", "desiredCount": 1, "pendingCount": 0, "runningCount": 1, "failedTasks": 0, "createdAt": "2024-12-03T16:24:25.225000-05:00", "updatedAt": "2024-12-03T16:25:15.837000-05:00", "capacityProviderStrategy": [ { "capacityProvider": "FARGATE", "weight": 1, "base": 0 } ], "platformVersion": "1.4.0", "platformFamily": "Linux", "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-0d0eab1bb38d5ca64", "subnet-0db5010045995c2d5" ], "securityGroups": [ "sg-02556bf85a191f59a" ], "assignPublicIp": "ENABLED" } }, "rolloutState": "COMPLETED", "rolloutStateReason": "ECS deployment ecs-svc/1976744184940610707 completed." } ], "roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS", "events": [], "createdAt": "2024-12-03T16:24:25.225000-05:00", "placementConstraints": [], "placementStrategy": [], "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-0d0eab1bb38d5ca64", "subnet-0db5010045995c2d5" ], "securityGroups": [ "sg-02556bf85a191f59a" ], "assignPublicIp": "ENABLED" } }, "healthCheckGracePeriodSeconds": 0, "schedulingStrategy": "REPLICA", "deploymentController": { "type": "ECS" }, "createdBy": "arn:aws:iam::123456789012:role/Admin", "enableECSManagedTags": true, "propagateTags": "NONE", "enableExecuteCommand": false, "availabilityZoneRebalancing": "ENABLED" } } ``` Consulte mais informações em [Atualização de um serviço do Amazon ECS usando o console](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-service-console-v2.html) no *Guia do desenvolvedor do Amazon ECS*. + Consulte detalhes da API em [UpdateService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/update-service.html) na *Referência de comandos da AWS CLI*. ### `update-task-protection` O código de exemplo a seguir mostra como usar `update-task-protection`. **AWS CLI** **Exemplo 1: habilitar a proteção de tarefas para tarefas do ECS** O `update-task-protection` a seguir protege tarefas do ECS contra encerramento durante a redução da escala horizontal de implantações ou o ajuste de escala automático do serviço. É possível especificar um período de expiração personalizado para a proteção de tarefas de 1 até 2.880 minutos (48 horas). Se você não especificar o período de expiração, o tempo padrão de habilitação da proteção de tarefas será de duas horas. ``` aws ecs update-task-protection \ --cluster ECS-project-update-cluster \ --tasks c43ed3b1331041f289316f958adb6a24 \ --protection-enabled \ --expires-in-minutes 300 ``` Resultado: ``` { "protectedTasks": [ { "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/c43ed3b1331041f289316f958adb6a24", "protectionEnabled": true, "expirationDate": "2024-09-14T19:53:36.687000-05:00" } ], "failures": [] } ``` **Exemplo 2: desabilitar a proteção de tarefas do ECS** O `update-task-protection` a seguir desabilita as tarefas protegidas contra a redução de escala horizontal de implantações ou o ajuste automático do serviço. ``` aws ecs update-task-protection \ --cluster ECS-project-update-cluster \ --tasks c43ed3b1331041f289316f958adb6a24 \ --no-protection-enabled ``` Resultado: ``` { "protectedTasks": [ { "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/c43ed3b1331041f289316f958adb6a24", "protectionEnabled": false } ], "failures": [] } ``` Consulte mais informações sobre proteção de tarefas em [Como proteger as tarefas do Amazon ECS de serem encerradas por eventos de redução horizontal da escala](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-scale-in-protection.html) no *Guia do desenvolvedor do Amazon ECS*. + Consulte detalhes da API em [UpdateTaskProtection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/update-task-protection.html) na *Referência de comandos da AWS CLI*. ### `update-task-set` O código de exemplo a seguir mostra como usar `update-task-set`. **AWS CLI** **Para atualizar um conjunto de tarefas** O exemplo `update-task-set` a seguir atualiza um conjunto de tarefas para ajustar a escala. ``` aws ecs update-task-set \ --cluster MyCluster \ --service MyService \ --task-set arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789 \ --scale value=50,unit=PERCENT ``` Resultado: ``` { "taskSet": { "id": "ecs-svc/1234567890123456789", "taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789", "status": "ACTIVE", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:2", "computedDesiredCount": 0, "pendingCount": 0, "runningCount": 0, "createdAt": 1557128360.711, "updatedAt": 1557129279.914, "launchType": "EC2", "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321" ], "securityGroups": [ "sg-12344321" ], "assignPublicIp": "DISABLED" } }, "loadBalancers": [], "serviceRegistries": [], "scale": { "value": 50.0, "unit": "PERCENT" }, "stabilityStatus": "STABILIZING", "stabilityStatusAt": 1557129279.914 } } ``` + Para ver detalhes da API, consulte [UpdateTaskSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/update-task-set.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon EFS usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface 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 ### `create-file-system` O código de exemplo a seguir mostra como usar `create-file-system`. **AWS CLI** **Para criar um sistema de arquivos criptografado** O exemplo `create-file-system` a seguir cria um sistema de arquivos criptografado usando a CMK padrão. Ele também adiciona a tag `Name=my-file-system`. ``` aws efs create-file-system \ --performance-mode generalPurpose \ --throughput-mode bursting \ --encrypted \ --tags Key=Name,Value=my-file-system ``` Resultado: ``` { "OwnerId": "123456789012", "CreationToken": "console-d7f56c5f-e433-41ca-8307-9d9c0example", "FileSystemId": "fs-c7a0456e", "FileSystemArn": "arn:aws:elasticfilesystem:us-west-2:123456789012:file-system/fs-48499b4d", "CreationTime": 1595286880.0, "LifeCycleState": "creating", "Name": "my-file-system", "NumberOfMountTargets": 0, "SizeInBytes": { "Value": 0, "ValueInIA": 0, "ValueInStandard": 0 }, "PerformanceMode": "generalPurpose", "Encrypted": true, "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/a59b3472-e62c-42e4-adcf-30d92example", "ThroughputMode": "bursting", "Tags": [ { "Key": "Name", "Value": "my-file-system" } ] } ``` Para ter mais informações, consulte [Criar sistemas de arquivos do Amazon EFS](https://docs.aws.amazon.com/efs/latest/ug/creating-using-create-fs.html) no *Guia do usuário do Amazon Elastic File System*. + Para ver detalhes da API, consulte [CreateFileSystem](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/efs/create-file-system.html) na *Referência de comandos da AWS CLI*. ### `create-mount-target` O código de exemplo a seguir mostra como usar `create-mount-target`. **AWS CLI** **Para criar um destino de montagem** O exemplo `create-mount-target` a seguir cria um destino de montagem para o sistema de arquivos especificado. ``` aws efs create-mount-target \ --file-system-id fs-c7a0456e \ --subnet-id subnet-02bf4c428bexample \ --security-groups sg-068f739363example ``` Resultado: ``` { "OwnerId": "123456789012", "MountTargetId": "fsmt-f9a14450", "FileSystemId": "fs-c7a0456e", "SubnetId": "subnet-02bf4c428bexample", "LifeCycleState": "creating", "IpAddress": "10.0.1.24", "NetworkInterfaceId": "eni-02d542216aexample", "AvailabilityZoneId": "use2-az2", "AvailabilityZoneName": "us-east-2b", "VpcId": "vpc-0123456789abcdef0" } ``` Para obter mais informações, consulte [Criar destinos de montagem](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html) no *Guia do usuário do Amazon Elastic File System*. + Para ver detalhes da API, consulte [CreateMountTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/efs/create-mount-target.html) na *Referência de comandos da AWS CLI*. ### `delete-file-system` O código de exemplo a seguir mostra como usar `delete-file-system`. **AWS CLI** **Para excluir um sistema de arquivos** O exemplo `delete-file-system` a seguir exclui o sistema de arquivos especificado. ``` aws efs delete-file-system \ --file-system-id fs-c7a0456e ``` Este comando não produz saída. Para ter mais informações, consulte [Excluir um sistema de arquivos do Amazon EFS](https://docs.aws.amazon.com/efs/latest/ug/delete-efs-fs.html) no *Guia do usuário do Amazon Elastic File System*. + Para ver detalhes da API, consulte [DeleteFileSystem](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/efs/delete-file-system.html) na *Referência de comandos da AWS CLI*. ### `delete-mount-target` O código de exemplo a seguir mostra como usar `delete-mount-target`. **AWS CLI** **Para excluir um destino de montagem** O exemplo `delete-mount-target` a seguir exclui o destino de montagem especificado. ``` aws efs delete-mount-target \ --mount-target-id fsmt-f9a14450 ``` Este comando não produz saída. Para obter mais informações, consulte [Criar destinos de montagem](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html) no *Guia do usuário do Amazon Elastic File System*. + Para ver detalhes da API, consulte [DeleteMountTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/efs/delete-mount-target.html) na *Referência de comandos da AWS CLI*. ### `describe-file-systems` O código de exemplo a seguir mostra como usar `describe-file-systems`. **AWS CLI** **Para descrever um sistema de arquivos** O exemplo `describe-file-systems` a seguir descreve o sistema de arquivos especificado. ``` aws efs describe-file-systems \ --file-system-id fs-c7a0456e ``` Resultado: ``` { "FileSystems": [ { "OwnerId": "123456789012", "CreationToken": "console-d7f56c5f-e433-41ca-8307-9d9c0example", "FileSystemId": "fs-c7a0456e", "FileSystemArn": "arn:aws:elasticfilesystem:us-west-2:123456789012:file-system/fs-48499b4d", "CreationTime": 1595286880.0, "LifeCycleState": "available", "Name": "my-file-system", "NumberOfMountTargets": 3, "SizeInBytes": { "Value": 6144, "Timestamp": 1600991437.0, "ValueInIA": 0, "ValueInStandard": 6144 }, "PerformanceMode": "generalPurpose", "Encrypted": true, "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/a59b3472-e62c-42e4-adcf-30d92example", "ThroughputMode": "bursting", "Tags": [ { "Key": "Name", "Value": "my-file-system" } ] } ] } ``` Para ter mais informações, consulte [Gerenciar sistemas de arquivos do Amazon EFS](https://docs.aws.amazon.com/efs/latest/ug/managing.html) no *Guia do usuário do Amazon Elastic File System*. + Para ver detalhes da API, consulte [DescribeFileSystems](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/efs/describe-file-systems.html) na *Referência de comandos da AWS CLI*. ### `describe-mount-targets` O código de exemplo a seguir mostra como usar `describe-mount-targets`. **AWS CLI** **Para descrever um destino de montagem** O exemplo `describe-mount-targets` a seguir descreve o destino de montagem especificado. ``` aws efs describe-mount-targets \ --mount-target-id fsmt-f9a14450 ``` Resultado: ``` { "MountTargets": [ { "OwnerId": "123456789012", "MountTargetId": "fsmt-f9a14450", "FileSystemId": "fs-c7a0456e", "SubnetId": "subnet-02bf4c428bexample", "LifeCycleState": "creating", "IpAddress": "10.0.1.24", "NetworkInterfaceId": "eni-02d542216aexample", "AvailabilityZoneId": "use2-az2", "AvailabilityZoneName": "us-east-2b", "VpcId": "vpc-0123456789abcdef0" } ] } ``` Para obter mais informações, consulte [Criar destinos de montagem](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html) no *Guia do usuário do Amazon Elastic File System*. + Para ver detalhes da API, consulte [DescribeMountTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/efs/describe-mount-targets.html) na *Referência de comandos da AWS CLI*. ### `describe-tags` O código de exemplo a seguir mostra como usar `describe-tags`. **AWS CLI** **Para descrever as tags de um sistema de arquivos** O exemplo `describe-tags` a seguir descreve as tags para o sistema de arquivos especificado. ``` aws efs describe-tags \ --file-system-id fs-c7a0456e ``` Resultado: ``` { "Tags": [ { "Key": "Name", "Value": "my-file-system" }, { "Key": "Department", "Value": "Business Intelligence" } ] } ``` Para obter mais informações, consulte [Gerenciar tags do sistema de arquivos](https://docs.aws.amazon.com/efs/latest/ug/manage-fs-tags.html) no *Guia do usuário do Amazon Elastic File System*. + Para ver detalhes da API, consulte [DescribeTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/efs/describe-tags.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para recuperar as tags para um recurso** O exemplo `list-tags-for-resource` a seguir recupera as tags associadas ao sistema de arquivos especificado. ``` aws efs list-tags-for-resource \ --resource-id fs-c7a0456e ``` Resultado: ``` { "Tags": [ { "Key": "Name", "Value": "my-file-system" }, { "Key": "Department", "Value": "Business Intelligence" } ] } ``` Para obter mais informações, consulte [Gerenciar tags do sistema de arquivos](https://docs.aws.amazon.com/efs/latest/ug/manage-fs-tags.html) no *Guia do usuário do Amazon Elastic File System*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/efs/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como marcar um recurso** O exemplo `tag-resource` a seguir adiciona a tag `Department=Business Intelligence` ao sistema de arquivos especificado. ``` aws efs tag-resource \ --resource-id fs-c7a0456e \ --tags Key=Department,Value="Business Intelligence" ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar tags do sistema de arquivos](https://docs.aws.amazon.com/efs/latest/ug/manage-fs-tags.html) no *Guia do usuário do Amazon Elastic File System*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/efs/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover uma tag de um recurso** O exemplo `untag-resource` a seguir remove a tag com a chave de tag `Department` do sistema de arquivos especificado. ``` aws efs untag-resource \ --resource-id fs-c7a0456e \ --tag-keys Department ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar tags do sistema de arquivos](https://docs.aws.amazon.com/efs/latest/ug/manage-fs-tags.html) no *Guia do usuário do Amazon Elastic File System*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/efs/untag-resource.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon EKS usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface 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 ### `associate-access-policy` O código de exemplo a seguir mostra como usar `associate-access-policy`. **AWS CLI** **Para associar uma política de acesso e seu escopo à entrada de acesso do cluster** O `associate-access-policy` a seguir associa uma política de acesso e seu escopo à entrada de acesso do cluster especificado. ``` aws eks associate-access-policy \ --cluster-name eks-customer \ --principal-arn arn:aws:iam::111122223333:role/Admin \ --policy-arn arn:aws:eks::aws:cluster-access-policy/AmazonEKSEditPolicy \ --access-scope type=namespace,namespaces=default ``` Resultado: ``` { "clusterName": "eks-customer", "principalArn": "arn:aws:iam::111122223333:role/Admin", "associatedAccessPolicy": { "policyArn": "arn:aws:eks::aws:cluster-access-policy/AmazonEKSEditPolicy", "accessScope": { "type": "namespace", "namespaces": [ "default" ] }, "associatedAt": "2025-05-24T15:59:51.981000-05:00", "modifiedAt": "2025-05-24T15:59:51.981000-05:00" } } ``` Para obter mais informações, consulte [Associar políticas de acesso às entradas de acesso](https://docs.aws.amazon.com/eks/latest/userguide/access-policies.html) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [AssociateAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/associate-access-policy.html) na *Referência de comandos da AWS CLI*. ### `associate-encryption-config` O código de exemplo a seguir mostra como usar `associate-encryption-config`. **AWS CLI** **Como associar uma configuração de criptografia a um cluster existente** O exemplo `associate-encryption-config` a seguir habilita a criptografia em clusters do EKS existentes que ainda não têm a criptografia ativada. ``` aws eks associate-encryption-config \ --cluster-name my-eks-cluster \ --encryption-config '[{"resources":["secrets"],"provider":{"keyArn":"arn:aws:kms:region-code:account:key/key"}}]' ``` Resultado: ``` { "update": { "id": "3141b835-8103-423a-8e68-12c2521ffa4d", "status": "InProgress", "type": "AssociateEncryptionConfig", "params": [ { "type": "EncryptionConfig", "value": "[{\"resources\":[\"secrets\"],\"provider\":{\"keyArn\":\"arn:aws:kms:region-code:account:key/key\"}}]" } ], "createdAt": "2024-03-14T11:01:26.297000-04:00", "errors": [] } } ``` Para obter mais informações, consulte [Habilitar a criptografia secreta em um cluster existente](https://docs.aws.amazon.com/eks/latest/userguide/enable-kms.html) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [AssociateEncryptionConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/associate-encryption-config.html) na *Referência de comandos da AWS CLI*. ### `associate-identity-provider-config` O código de exemplo a seguir mostra como usar `associate-identity-provider-config`. **AWS CLI** **Associar um provedor de identidade ao seu cluster do Amazon EKS** O exemplo `associate-identity-provider-config` a seguir associa um provedor de identidade ao seu cluster do Amazon EKS. ``` aws eks associate-identity-provider-config \ --cluster-name my-eks-cluster \ --oidc 'identityProviderConfigName=my-identity-provider,issuerUrl=https://oidc.eks.us-east-2.amazonaws.com/id/38D6A4619A0A69E342B113ED7F1A7652,clientId=kubernetes,usernameClaim=email,usernamePrefix=my-username-prefix,groupsClaim=my-claim,groupsPrefix=my-groups-prefix,requiredClaims={Claim1=value1,Claim2=value2}' \ --tags env=dev ``` Resultado: ``` { "update": { "id": "8c6c1bef-61fe-42ac-a242-89412387b8e7", "status": "InProgress", "type": "AssociateIdentityProviderConfig", "params": [ { "type": "IdentityProviderConfig", "value": "[{\"type\":\"oidc\",\"name\":\"my-identity-provider\"}]" } ], "createdAt": "2024-04-11T13:46:49.648000-04:00", "errors": [] }, "tags": { "env": "dev" } } ``` Para obter mais informações, consulte [Autenticar usuários para o cluster em um provedor de identidade OpenID Connect – Associar um provedor de identidade OIDC](https://docs.aws.amazon.com/eks/latest/userguide/authenticate-oidc-identity-provider.html#associate-oidc-identity-provider) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [AssociateIdentityProviderConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/associate-identity-provider-config.html) na *Referência de comandos da AWS CLI*. ### `create-access-entry` O código de exemplo a seguir mostra como usar `create-access-entry`. **AWS CLI** **Exemplo 1: criar a entrada de acesso para o cluster do EKS** O exemplo a seguir `create-access-entry` cria uma entrada de acesso que permite que uma entidade principal do IAM acesse o cluster do EKS. ``` aws eks create-access-entry \ --cluster-name eks-customer \ --principal-arn arn:aws:iam::111122223333:user/eks-user ``` Resultado: ``` { "accessEntry": { "clusterName": "eks-customer", "principalArn": "arn:aws:iam::111122223333:user/eks-user", "kubernetesGroups": [], "accessEntryArn": "arn:aws:eks:us-west-2:111122223333:access-entry/eks-customer/user/111122223333/eks-user/a1b2c3d4-5678-90ab-cdef-a6506e3d36p0", "createdAt": "2025-04-14T22:45:48.097000-05:00", "modifiedAt": "2025-04-14T22:45:48.097000-05:00", "tags": {}, "username": "arn:aws:iam::111122223333:user/eks-user", "type": "STANDARD" } } ``` Para obter mais informações, consulte [Criar entidades de acesso](https://docs.aws.amazon.com/eks/latest/userguide/creating-access-entries.html) no *Guia do usuário do Amazon EKS*. **Exemplo 2: criar a entrada de acesso para o cluster do EKS especificando o tipo de entrada de acesso** O exemplo a seguir `create-access-entry` cria uma entrada de acesso do tipo `EC2_LINUX` no cluster do EKS. Por padrão, é criada uma entrada de acesso de tipo `STANDARD`. Além do padrão, se especificarmos qualquer outro tipo de entrada de acesso, um ARN de função do IAM precisará ser passado na CLI. ``` aws eks create-access-entry \ --cluster-name eks-customer \ --principal-arn arn:aws:iam::111122223333:role/admin-test-ip \ --type EC2_LINUX ``` Resultado: ``` { "accessEntry": { "clusterName": "eks-customer", "principalArn": "arn:aws:iam::111122223333:role/admin-test-ip", "kubernetesGroups": [ "system:nodes" ], "accessEntryArn": "arn:aws:eks:us-west-2:111122223333:access-entry/eks-customer/role/111122223333/admin-test-ip/accb5418-f493-f390-3e6e-c3f19f725fcp", "createdAt": "2025-05-06T19:42:45.453000-05:00", "modifiedAt": "2025-05-06T19:42:45.453000-05:00", "tags": {}, "username": "system:node:{{EC2PrivateDNSName}}", "type": "EC2_LINUX" } } ``` Para obter mais informações, consulte [Criar entradas de acesso](https://docs.aws.amazon.com/eks/latest/userguide/creating-access-entries.html) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [CreateAccessEntry](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/create-access-entry.html) na *Referência de comandos da AWS CLI*. ### `create-addon` O código de exemplo a seguir mostra como usar `create-addon`. **AWS CLI** **Exemplo 1: criar um complemento do Amazon EKS com uma versão compatível padrão para a respectiva versão do cluster do EKS** O comando de exemplo `create-addon` a seguir cria um complemento do Amazon EKS com uma versão compatível padrão para a respectiva versão do cluster do EKS. ``` aws eks create-addon \ --cluster-name my-eks-cluster \ --addon-name my-eks-addon \ --service-account-role-arn arn:aws:iam::111122223333:role/role-name ``` Resultado: ``` { "addon": { "addonName": "my-eks-addon", "clusterName": "my-eks-cluster", "status": "CREATING", "addonVersion": "v1.15.1-eksbuild.1", "health": { "issues": [] }, "addonArn": "arn:aws:eks:us-east-2:111122223333:addon/my-eks-cluster/my-eks-addon/1ec71ee1-b9c2-8915-4e17-e8be0a55a149", "createdAt": "2024-03-14T12:20:03.264000-04:00", "modifiedAt": "2024-03-14T12:20:03.283000-04:00", "serviceAccountRoleArn": "arn:aws:iam::111122223333:role/role-name", "tags": {} } } ``` Para obter mais informações, consulte [Gerenciamento de complementos do Amazon EKS – Criar um complemento](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#creating-an-add-on), no *Guia do usuário do Amazon EKS*. **Exemplo 2: criar um complemento do Amazon EKS com uma versão específica de complemento** O comando de exemplo `create-addon` a seguir cria um complemento do Amazon EKS com uma versão específica de complemento. ``` aws eks create-addon \ --cluster-name my-eks-cluster \ --addon-name my-eks-addon \ --service-account-role-arn arn:aws:iam::111122223333:role/role-name \ --addon-version v1.16.4-eksbuild.2 ``` Resultado: ``` { "addon": { "addonName": "my-eks-addon", "clusterName": "my-eks-cluster", "status": "CREATING", "addonVersion": "v1.16.4-eksbuild.2", "health": { "issues": [] }, "addonArn": "arn:aws:eks:us-east-2:111122223333:addon/my-eks-cluster/my-eks-addon/34c71ee6-7738-6c8b-c6bd-3921a176b5ff", "createdAt": "2024-03-14T12:30:24.507000-04:00", "modifiedAt": "2024-03-14T12:30:24.521000-04:00", "serviceAccountRoleArn": "arn:aws:iam::111122223333:role/role-name", "tags": {} } } ``` Para obter mais informações, consulte [Gerenciamento de complementos do Amazon EKS – Criar um complemento](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#creating-an-add-on), no *Guia do usuário do Amazon EKS*. **Exemplo 3: criar um complemento do Amazon EKS com valores de configuração personalizados e resolver detalhes de conflitos** O comando de exemplo `create-addon` a seguir cria um complemento do Amazon EKS com valores de configuração personalizados e resolve detalhes de conflitos. ``` aws eks create-addon \ --cluster-name my-eks-cluster \ --addon-name my-eks-addon \ --service-account-role-arn arn:aws:iam::111122223333:role/role-name \ --addon-version v1.16.4-eksbuild.2 \ --configuration-values '{"resources":{"limits":{"cpu":"100m"}}}' \ --resolve-conflicts OVERWRITE ``` Resultado: ``` { "addon": { "addonName": "my-eks-addon", "clusterName": "my-eks-cluster", "status": "CREATING", "addonVersion": "v1.16.4-eksbuild.2", "health": { "issues": [] }, "addonArn": "arn:aws:eks:us-east-2:111122223333:addon/my-eks-cluster/my-eks-addon/a6c71ee9-0304-9237-1be8-25af1b0f1ffb", "createdAt": "2024-03-14T12:35:58.313000-04:00", "modifiedAt": "2024-03-14T12:35:58.327000-04:00", "serviceAccountRoleArn": "arn:aws:iam::111122223333:role/role-name", "tags": {}, "configurationValues": "{\"resources\":{\"limits\":{\"cpu\":\"100m\"}}}" } } ``` Para obter mais informações, consulte [Gerenciamento de complementos do Amazon EKS – Criar um complemento](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#creating-an-add-on), no *Guia do usuário do Amazon EKS*. **Exemplo 4: criar um complemento do Amazon EKS com arquivo de valores de configuração JSON personalizados** O comando de exemplo `create-addon` a seguir cria um complemento do Amazon EKS com valores de configuração personalizados e resolve detalhes de conflitos. ``` aws eks create-addon \ --cluster-name my-eks-cluster \ --addon-name my-eks-addon \ --service-account-role-arn arn:aws:iam::111122223333:role/role-name \ --addon-version v1.16.4-eksbuild.2 \ --configuration-values 'file://configuration-values.json' \ --resolve-conflicts OVERWRITE \ --tags '{"eks-addon-key-1": "value-1" , "eks-addon-key-2": "value-2"}' ``` Conteúdo de `configuration-values.json`: ``` { "resources": { "limits": { "cpu": "150m" } }, "env": { "AWS_VPC_K8S_CNI_LOGLEVEL": "ERROR" } } ``` Resultado: ``` { "addon": { "addonName": "my-eks-addon", "clusterName": "my-eks-cluster", "status": "CREATING", "addonVersion": "v1.16.4-eksbuild.2", "health": { "issues": [] }, "addonArn": "arn:aws:eks:us-east-2:111122223333:addon/my-eks-cluster/my-eks-addon/d8c71ef8-fbd8-07d0-fb32-6a7be19ececd", "createdAt": "2024-03-14T13:10:51.763000-04:00", "modifiedAt": "2024-03-14T13:10:51.777000-04:00", "serviceAccountRoleArn": "arn:aws:iam::111122223333:role/role-name", "tags": { "eks-addon-key-1": "value-1", "eks-addon-key-2": "value-2" }, "configurationValues": "{\n \"resources\": {\n \"limits\": {\n \"cpu\": \"150m\"\n }\n },\n \"env\": {\n \"AWS_VPC_K8S_CNI_LOGLEVEL\": \"ERROR\"\n }\n}" } } ``` Para obter mais informações, consulte [Gerenciamento de complementos do Amazon EKS – Criar um complemento](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#creating-an-add-on), no *Guia do usuário do Amazon EKS*. **Exemplo 5: criar um complemento do Amazon EKS com arquivo de valores de configuração YAML personalizados** O comando de exemplo `create-addon` a seguir cria um complemento do Amazon EKS com valores de configuração personalizados e resolve detalhes de conflitos. ``` aws eks create-addon \ --cluster-name my-eks-cluster \ --addon-name my-eks-addon \ --service-account-role-arn arn:aws:iam::111122223333:role/role-name \ --addon-version v1.16.4-eksbuild.2 \ --configuration-values 'file://configuration-values.yaml' \ --resolve-conflicts OVERWRITE \ --tags '{"eks-addon-key-1": "value-1" , "eks-addon-key-2": "value-2"}' ``` Conteúdo de `configuration-values.yaml`: ``` resources: limits: cpu: '100m' env: AWS_VPC_K8S_CNI_LOGLEVEL: 'DEBUG' ``` Resultado: ``` { "addon": { "addonName": "my-eks-addon", "clusterName": "my-eks-cluster", "status": "CREATING", "addonVersion": "v1.16.4-eksbuild.2", "health": { "issues": [] }, "addonArn": "arn:aws:eks:us-east-2:111122223333:addon/my-eks-cluster/my-eks-addon/d4c71efb-3909-6f36-a548-402cd4b5d59e", "createdAt": "2024-03-14T13:15:45.220000-04:00", "modifiedAt": "2024-03-14T13:15:45.237000-04:00", "serviceAccountRoleArn": "arn:aws:iam::111122223333:role/role-name", "tags": { "eks-addon-key-3": "value-3", "eks-addon-key-4": "value-4" }, "configurationValues": "resources:\n limits:\n cpu: '100m'\nenv:\n AWS_VPC_K8S_CNI_LOGLEVEL: 'INFO'" } } ``` Para obter mais informações, consulte [Gerenciamento de complementos do Amazon EKS – Criar um complemento](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#creating-an-add-on), no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [CreateAddon](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/create-addon.html) na *Referência de comandos da AWS CLI*. ### `create-cluster` O código de exemplo a seguir mostra como usar `create-cluster`. **AWS CLI** **Como criar um cluster** Este comando de exemplo cria o cluster `prod` na sua região padrão. Comando: ``` aws eks create-cluster --name prod \ --role-arn arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI \ --resources-vpc-config subnetIds=subnet-6782e71e,subnet-e7e761ac,securityGroupIds=sg-6979fe18 ``` Resultado: ``` { "cluster": { "name": "prod", "arn": "arn:aws:eks:us-west-2:012345678910:cluster/prod", "createdAt": 1527808069.147, "version": "1.10", "roleArn": "arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI", "resourcesVpcConfig": { "subnetIds": [ "subnet-6782e71e", "subnet-e7e761ac" ], "securityGroupIds": [ "sg-6979fe18" ], "vpcId": "vpc-950809ec" }, "status": "CREATING", "certificateAuthority": {} } } ``` **Como criar um cluster com acesso ao endpoint privado e registro em log habilitado** Este comando de exemplo cria o cluster `example` na região padrão com acesso ao endpoint público desabilitado e acesso ao endpoint privado e todos os tipos de registro em log habilitados. Comando: ``` aws eks create-cluster --name example --kubernetes-version 1.12 \ --role-arn arn:aws:iam::012345678910:role/example-cluster-ServiceRole-1XWBQWYSFRE2Q \ --resources-vpc-config subnetIds=subnet-0a188dccd2f9a632f,subnet-09290d93da4278664,subnet-0f21dd86e0e91134a,subnet-0173dead68481a583,subnet-051f70a57ed6fcab6,subnet-01322339c5c7de9b4,securityGroupIds=sg-0c5b580845a031c10,endpointPublicAccess=false,endpointPrivateAccess=true \ --logging '{"clusterLogging":[{"types":["api","audit","authenticator","controllerManager","scheduler"],"enabled":true}]}' ``` Resultado: ``` { "cluster": { "name": "example", "arn": "arn:aws:eks:us-west-2:012345678910:cluster/example", "createdAt": 1565804921.901, "version": "1.12", "roleArn": "arn:aws:iam::012345678910:role/example-cluster-ServiceRole-1XWBQWYSFRE2Q", "resourcesVpcConfig": { "subnetIds": [ "subnet-0a188dccd2f9a632f", "subnet-09290d93da4278664", "subnet-0f21dd86e0e91134a", "subnet-0173dead68481a583", "subnet-051f70a57ed6fcab6", "subnet-01322339c5c7de9b4" ], "securityGroupIds": [ "sg-0c5b580845a031c10" ], "vpcId": "vpc-0f622c01f68d4afec", "endpointPublicAccess": false, "endpointPrivateAccess": true }, "logging": { "clusterLogging": [ { "types": [ "api", "audit", "authenticator", "controllerManager", "scheduler" ], "enabled": true } ] }, "status": "CREATING", "certificateAuthority": {}, "platformVersion": "eks.3" } } ``` + Consulte detalhes da API em [CreateCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/create-cluster.html) na *Referência de comandos da AWS CLI*. ### `create-fargate-profile` O código de exemplo a seguir mostra como usar `create-fargate-profile`. **AWS CLI** **Exemplo 1: criar um perfil do EKS Fargate para um seletor com um namespace** O exemplo `create-fargate-profile` a seguir cria um perfil do EKS Fargate para um seletor com um namespace. ``` aws eks create-fargate-profile \ --cluster-name my-eks-cluster \ --pod-execution-role-arn arn:aws:iam::111122223333:role/role-name \ --fargate-profile-name my-fargate-profile \ --selectors '[{"namespace": "default"}]' ``` Resultado: ``` { "fargateProfile": { "fargateProfileName": "my-fargate-profile", "fargateProfileArn": "arn:aws:eks:us-east-2:111122223333:fargateprofile/my-eks-cluster/my-fargate-profile/a2c72bca-318e-abe8-8ed1-27c6d4892e9e", "clusterName": "my-eks-cluster", "createdAt": "2024-03-19T12:38:47.368000-04:00", "podExecutionRoleArn": "arn:aws:iam::111122223333:role/role-name", "subnets": [ "subnet-09d912bb63ef21b9a", "subnet-04ad87f71c6e5ab4d", "subnet-0e2907431c9988b72" ], "selectors": [ { "namespace": "default" } ], "status": "CREATING", "tags": {} } } ``` Para obter mais informações, consulte [Perfil do AWS Fargate – Criar um perfil do Fargate](https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html#create-fargate-profile) no *Guia do usuário do Amazon EKS*. **Exemplo 2: criar um perfil do EKS Fargate para um seletor com um namespace e rótulos** O exemplo `create-fargate-profile` a seguir cria um perfil do EKS Fargate para um seletor com um namespace e rótulos. ``` aws eks create-fargate-profile \ --cluster-name my-eks-cluster \ --pod-execution-role-arn arn:aws:iam::111122223333:role/role-name \ --fargate-profile-name my-fargate-profile \ --selectors '[{"namespace": "default", "labels": {"labelname1": "labelvalue1"}}]' ``` Resultado: ``` { "fargateProfile": { "fargateProfileName": "my-fargate-profile", "fargateProfileArn": "arn:aws:eks:us-east-2:111122223333:fargateprofile/my-eks-cluster/my-fargate-profile/88c72bc7-e8a4-fa34-44e4-2f1397224bb3", "clusterName": "my-eks-cluster", "createdAt": "2024-03-19T12:33:48.125000-04:00", "podExecutionRoleArn": "arn:aws:iam::111122223333:role/role-name", "subnets": [ "subnet-09d912bb63ef21b9a", "subnet-04ad87f71c6e5ab4d", "subnet-0e2907431c9988b72" ], "selectors": [ { "namespace": "default", "labels": { "labelname1": "labelvalue1" } } ], "status": "CREATING", "tags": {} } } ``` Para obter mais informações, consulte [Perfil do AWS Fargate – Criar um perfil do Fargate](https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html#create-fargate-profile) no *Guia do usuário do Amazon EKS*. **Exemplo 3: criar um perfil do EKS Fargate para um seletor com um namespace e rótulos, junto com IDs de sub-redes nas quais iniciar um pod.** O exemplo `create-fargate-profile` a seguir cria o perfil do EKS Fargate para um seletor com um namespace e rótulos, junto com IDs de sub-redes nas quais iniciar um pod. ``` aws eks create-fargate-profile \ --cluster-name my-eks-cluster \ --pod-execution-role-arn arn:aws:iam::111122223333:role/role-name \ --fargate-profile-name my-fargate-profile \ --selectors '[{"namespace": "default", "labels": {"labelname1": "labelvalue1"}}]' \ --subnets '["subnet-09d912bb63ef21b9a", "subnet-04ad87f71c6e5ab4d", "subnet-0e2907431c9988b72"]' ``` Resultado: ``` { "fargateProfile": { "fargateProfileName": "my-fargate-profile", "fargateProfileArn": "arn:aws:eks:us-east-2:111122223333:fargateprofile/my-eks-cluster/my-fargate-profile/e8c72bc8-e87b-5eb6-57cb-ed4fe57577e3", "clusterName": "my-eks-cluster", "createdAt": "2024-03-19T12:35:58.640000-04:00", "podExecutionRoleArn": "arn:aws:iam::111122223333:role/role-name", "subnets": [ "subnet-09d912bb63ef21b9a", "subnet-04ad87f71c6e5ab4d", "subnet-0e2907431c9988b72" ], "selectors": [ { "namespace": "default", "labels": { "labelname1": "labelvalue1" } } ], "status": "CREATING", "tags": {} } } ``` Para obter mais informações, consulte [Perfil do AWS Fargate – Criar um perfil do Fargate](https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html#create-fargate-profile) no *Guia do usuário do Amazon EKS*. **Exemplo 4: criar um perfil do EKS Fargate para um seletor com vários namespaces e rótulos, junto com IDs de sub-redes nas quais iniciar um pod** O exemplo `create-fargate-profile` a seguir cria um perfil do EKS Fargate para um seletor com vários namespaces e rótulos, junto com IDs de sub-redes nas quais iniciar um pod. ``` aws eks create-fargate-profile \ --cluster-name my-eks-cluster \ --pod-execution-role-arn arn:aws:iam::111122223333:role/role-name \ --fargate-profile-name my-fargate-profile \ --selectors '[{"namespace": "default1", "labels": {"labelname1": "labelvalue1", "labelname2": "labelvalue2"}}, {"namespace": "default2", "labels": {"labelname1": "labelvalue1", "labelname2": "labelvalue2"}}]' \ --subnets '["subnet-09d912bb63ef21b9a", "subnet-04ad87f71c6e5ab4d", "subnet-0e2907431c9988b72"]' \ --tags '{"eks-fargate-profile-key-1": "value-1" , "eks-fargate-profile-key-2": "value-2"}' ``` Resultado: ``` { "fargateProfile": { "fargateProfileName": "my-fargate-profile", "fargateProfileArn": "arn:aws:eks:us-east-2:111122223333:fargateprofile/my-eks-cluster/my-fargate-profile/4cc72bbf-b766-8ee6-8d29-e62748feb3cd", "clusterName": "my-eks-cluster", "createdAt": "2024-03-19T12:15:55.271000-04:00", "podExecutionRoleArn": "arn:aws:iam::111122223333:role/role-name", "subnets": [ "subnet-09d912bb63ef21b9a", "subnet-04ad87f71c6e5ab4d", "subnet-0e2907431c9988b72" ], "selectors": [ { "namespace": "default1", "labels": { "labelname2": "labelvalue2", "labelname1": "labelvalue1" } }, { "namespace": "default2", "labels": { "labelname2": "labelvalue2", "labelname1": "labelvalue1" } } ], "status": "CREATING", "tags": { "eks-fargate-profile-key-2": "value-2", "eks-fargate-profile-key-1": "value-1" } } } ``` Para obter mais informações, consulte [Perfil do AWS Fargate – Criar um perfil do Fargate](https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html#create-fargate-profile) no *Guia do usuário do Amazon EKS*. **Exemplo 5: criar um perfil do EKS Fargate com um seletor curinga para namespaces e rótulos, junto com IDs de sub-redes nas quais iniciar um pod** O exemplo `create-fargate-profile` a seguir cria um perfil do EKS Fargate para um seletor com vários namespaces e rótulos, junto com IDs de sub-redes nas quais iniciar um pod. ``` aws eks create-fargate-profile \ --cluster-name my-eks-cluster \ --pod-execution-role-arn arn:aws:iam::111122223333:role/role-name \ --fargate-profile-name my-fargate-profile \ --selectors '[{"namespace": "prod*", "labels": {"labelname*?": "*value1"}}, {"namespace": "*dev*", "labels": {"labelname*?": "*value*"}}]' \ --subnets '["subnet-09d912bb63ef21b9a", "subnet-04ad87f71c6e5ab4d", "subnet-0e2907431c9988b72"]' \ --tags '{"eks-fargate-profile-key-1": "value-1" , "eks-fargate-profile-key-2": "value-2"}' ``` Resultado: ``` { "fargateProfile": { "fargateProfileName": "my-fargate-profile", "fargateProfileArn": "arn:aws:eks:us-east-2:111122223333:fargateprofile/my-eks-cluster/my-fargate-profile/e8c72bd6-5966-0bfe-b77b-1802893e5a6f", "clusterName": "my-eks-cluster", "createdAt": "2024-03-19T13:05:20.550000-04:00", "podExecutionRoleArn": "arn:aws:iam::111122223333:role/role-name", "subnets": [ "subnet-09d912bb63ef21b9a", "subnet-04ad87f71c6e5ab4d", "subnet-0e2907431c9988b72" ], "selectors": [ { "namespace": "prod*", "labels": { "labelname*?": "*value1" } }, { "namespace": "*dev*", "labels": { "labelname*?": "*value*" } } ], "status": "CREATING", "tags": { "eks-fargate-profile-key-2": "value-2", "eks-fargate-profile-key-1": "value-1" } } } ``` Para obter mais informações, consulte [Perfil do AWS Fargate – Criar um perfil do Fargate](https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html#create-fargate-profile) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [CreateFargateProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/create-fargate-profile.html) na *Referência de comandos da AWS CLI*. ### `create-nodegroup` O código de exemplo a seguir mostra como usar `create-nodegroup`. **AWS CLI** **Exemplo 1: criar um grupo de nós gerenciado para um cluster do Amazon EKS** O exemplo `create-nodegroup` a seguir cria um grupo de nós gerenciados para um cluster do Amazon EKS. ``` aws eks create-nodegroup \ --cluster-name my-eks-cluster \ --nodegroup-name my-eks-nodegroup \ --node-role arn:aws:iam::111122223333:role/role-name \ --subnets "subnet-0e2907431c9988b72" "subnet-04ad87f71c6e5ab4d" "subnet-09d912bb63ef21b9a" \ --scaling-config minSize=1,maxSize=3,desiredSize=1 \ --region us-east-2 ``` Resultado: ``` { "nodegroup": { "nodegroupName": "my-eks-nodegroup", "nodegroupArn": "arn:aws:eks:us-east-2:111122223333:nodegroup/my-eks-cluster/my-eks-nodegroup/bac7550f-b8b8-5fbb-4f3e-7502a931119e", "clusterName": "my-eks-cluster", "version": "1.26", "releaseVersion": "1.26.12-20240329", "createdAt": "2024-04-04T13:19:32.260000-04:00", "modifiedAt": "2024-04-04T13:19:32.260000-04:00", "status": "CREATING", "capacityType": "ON_DEMAND", "scalingConfig": { "minSize": 1, "maxSize": 3, "desiredSize": 1 }, "instanceTypes": [ "t3.medium" ], "subnets": [ "subnet-0e2907431c9988b72, subnet-04ad87f71c6e5ab4d, subnet-09d912bb63ef21b9a" ], "amiType": "AL2_x86_64", "nodeRole": "arn:aws:iam::111122223333:role/role-name", "diskSize": 20, "health": { "issues": [] }, "updateConfig": { "maxUnavailable": 1 }, "tags": {} } } ``` Para obter mais informações, consulte [Criar um grupo de nós gerenciados](https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html) no *Guia do usuário do Amazon EKS*. **Exemplo 2: criar um grupo de nós gerenciado para um cluster do Amazon EKS com tipos de instância e tamanho de disco personalizados** O exemplo `create-nodegroup` a seguir cria um grupo de nós gerenciados para um cluster do Amazon EKS com instance-types e disk-size personalizados. ``` aws eks create-nodegroup \ --cluster-name my-eks-cluster \ --nodegroup-name my-eks-nodegroup \ --node-role arn:aws:iam::111122223333:role/role-name \ --subnets "subnet-0e2907431c9988b72" "subnet-04ad87f71c6e5ab4d" "subnet-09d912bb63ef21b9a" \ --scaling-config minSize=1,maxSize=3,desiredSize=1 \ --capacity-type ON_DEMAND \ --instance-types 'm5.large' \ --disk-size 50 \ --region us-east-2 ``` Resultado: ``` { "nodegroup": { "nodegroupName": "my-eks-nodegroup", "nodegroupArn": "arn:aws:eks:us-east-2:111122223333:nodegroup/my-eks-cluster/my-eks-nodegroup/c0c7551b-e4f9-73d9-992c-a450fdb82322", "clusterName": "my-eks-cluster", "version": "1.26", "releaseVersion": "1.26.12-20240329", "createdAt": "2024-04-04T13:46:07.595000-04:00", "modifiedAt": "2024-04-04T13:46:07.595000-04:00", "status": "CREATING", "capacityType": "ON_DEMAND", "scalingConfig": { "minSize": 1, "maxSize": 3, "desiredSize": 1 }, "instanceTypes": [ "m5.large" ], "subnets": [ "subnet-0e2907431c9988b72", "subnet-04ad87f71c6e5ab4d", "subnet-09d912bb63ef21b9a" ], "amiType": "AL2_x86_64", "nodeRole": "arn:aws:iam::111122223333:role/role-name", "diskSize": 50, "health": { "issues": [] }, "updateConfig": { "maxUnavailable": 1 }, "tags": {} } } ``` Para obter mais informações, consulte [Criar um grupo de nós gerenciados](https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html) no *Guia do usuário do Amazon EKS*. **Exemplo 3: criar um grupo de nós gerenciados para um cluster do Amazon EKS com instance-types, disk-size, ami-type, capacity-type, update-config, rótulos, taints e tags personalizados.** O exemplo `create-nodegroup` a seguir cria um grupo de nós gerenciados para um cluster do Amazon EKS com instance-types, disk-size, ami-type, capacity-type, update-config, rótulos, taints e tags personalizados. ``` aws eks create-nodegroup \ --cluster-name my-eks-cluster \ --nodegroup-name my-eks-nodegroup \ --node-role arn:aws:iam::111122223333:role/role-name \ --subnets "subnet-0e2907431c9988b72" "subnet-04ad87f71c6e5ab4d" "subnet-09d912bb63ef21b9a" \ --scaling-config minSize=1,maxSize=5,desiredSize=4 \ --instance-types 't3.large' \ --disk-size 50 \ --ami-type AL2_x86_64 \ --capacity-type SPOT \ --update-config maxUnavailable=2 \ --labels '{"my-eks-nodegroup-label-1": "value-1" , "my-eks-nodegroup-label-2": "value-2"}' \ --taints '{"key": "taint-key-1" , "value": "taint-value-1", "effect": "NO_EXECUTE"}' \ --tags '{"my-eks-nodegroup-key-1": "value-1" , "my-eks-nodegroup-key-2": "value-2"}' ``` Resultado: ``` { "nodegroup": { "nodegroupName": "my-eks-nodegroup", "nodegroupArn": "arn:aws:eks:us-east-2:111122223333:nodegroup/my-eks-cluster/my-eks-nodegroup/88c75524-97af-0cb9-a9c5-7c0423ab5314", "clusterName": "my-eks-cluster", "version": "1.26", "releaseVersion": "1.26.12-20240329", "createdAt": "2024-04-04T14:05:07.940000-04:00", "modifiedAt": "2024-04-04T14:05:07.940000-04:00", "status": "CREATING", "capacityType": "SPOT", "scalingConfig": { "minSize": 1, "maxSize": 5, "desiredSize": 4 }, "instanceTypes": [ "t3.large" ], "subnets": [ "subnet-0e2907431c9988b72", "subnet-04ad87f71c6e5ab4d", "subnet-09d912bb63ef21b9a" ], "amiType": "AL2_x86_64", "nodeRole": "arn:aws:iam::111122223333:role/role-name", "labels": { "my-eks-nodegroup-label-2": "value-2", "my-eks-nodegroup-label-1": "value-1" }, "taints": [ { "key": "taint-key-1", "value": "taint-value-1", "effect": "NO_EXECUTE" } ], "diskSize": 50, "health": { "issues": [] }, "updateConfig": { "maxUnavailable": 2 }, "tags": { "my-eks-nodegroup-key-1": "value-1", "my-eks-nodegroup-key-2": "value-2" } } } ``` Para obter mais informações, consulte [Criar um grupo de nós gerenciados](https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [CreateNodegroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/create-nodegroup.html) na *Referência de comandos da AWS CLI*. ### `create-pod-identity-association` O código de exemplo a seguir mostra como usar `create-pod-identity-association`. **AWS CLI** **Exemplo 1: criar uma associação do Identidade de Pods do EKS no cluster do EKS** O exemplo a seguir `create-pod-identity-association` cria uma associação de Identidade de Pods do EKS entre uma conta de serviço no cluster do EKS e o perfil do IAM. ``` aws eks create-pod-identity-association \ --cluster-name eks-customer \ --namespace default \ --service-account default \ --role-arn arn:aws:iam::111122223333:role/my-role ``` Resultado: ``` { "association": { "clusterName": "eks-customer", "namespace": "default", "serviceAccount": "default", "roleArn": "arn:aws:iam::111122223333:role/my-role", "associationArn": "arn:aws:eks:us-west-2:111122223333:podidentityassociation/eks-customer/a-8mvwvh57cu74mgcst", "associationId": "a-8mvwvh57cu74mgcst", "tags": {}, "createdAt": "2025-05-24T19:40:13.961000-05:00", "modifiedAt": "2025-05-24T19:40:13.961000-05:00" } } ``` Para obter mais informações, consulte [Saiba como o a Identidade de Pods do EKS concede aos pods acesso aos serviços da AWS](https://docs.aws.amazon.com/eks/latest/userguide/pod-identities.html) no *Guia do usuário do Amazon EKS*. **Exemplo 2: criar uma associação de Identidade de Pods do EKS no cluster do EKS com tags** O `create-pod-identity-association` a seguir cria uma associação de Identidade de Pods do EKS entre uma conta de serviço e um perfil do IAM no cluster do EKS com tags. ``` aws eks create-pod-identity-association \ --cluster-name eks-customer \ --namespace default \ --service-account default \ --role-arn arn:aws:iam::111122223333:role/my-role \ --tags Key1=value1,Key2=value2 ``` Resultado: ``` { "association": { "clusterName": "eks-customer", "namespace": "default", "serviceAccount": "default", "roleArn": "arn:aws:iam::111122223333:role/my-role", "associationArn": "arn:aws:eks:us-west-2:111122223333:podidentityassociation/eks-customer/a-9njjin9gfghecgoda", "associationId": "a-9njjin9gfghecgoda", "tags": { "Key2": "value2", "Key1": "value1" }, "createdAt": "2025-05-24T19:52:14.135000-05:00", "modifiedAt": "2025-05-24T19:52:14.135000-05:00" } } ``` Para obter mais informações, consulte [Saiba como a Identidade de Pods do EKS concede aos pods acesso aos serviços da AWS](https://docs.aws.amazon.com/eks/latest/userguide/pod-identities.html) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [CreatePodIdentityAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/create-pod-identity-association.html) na *Referência de comandos da AWS CLI*. ### `delete-access-entry` O código de exemplo a seguir mostra como usar `delete-access-entry`. **AWS CLI** **Para excluir uma entrada de acesso associada ao cluster** O `delete-access-entry` a seguir exclui uma entrada de acesso associada ao cluster do EKS chamado `eks-customer`. ``` aws eks delete-access-entry \ --cluster-name eks-customer \ --principal-arn arn:aws:iam::111122223333:role/Admin ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir as entradas de acesso](https://docs.aws.amazon.com/eks/latest/userguide/deleting-access-entries.html) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [DeleteAccessEntry](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/delete-access-entry.html) na *Referência de comandos da AWS CLI*. ### `delete-addon` O código de exemplo a seguir mostra como usar `delete-addon`. **AWS CLI** **Exemplo 1. Para excluir um complemento do Amazon EKS, mas preservar o software do complemento no cluster do EKS** O comando de exemplo `delete-addon` a seguir exclui um complemento do Amazon EKS, mas preserva o software do complemento no cluster do Amazon EKS. ``` aws eks delete-addon \ --cluster-name my-eks-cluster \ --addon-name my-eks-addon \ --preserve ``` Resultado: ``` { "addon": { "addonName": "my-eks-addon", "clusterName": "my-eks-cluster", "status": "DELETING", "addonVersion": "v1.9.3-eksbuild.7", "health": { "issues": [] }, "addonArn": "arn:aws:eks:us-east-2:111122223333:addon/my-eks-cluster/my-eks-addon/a8c71ed3-944e-898b-9167-c763856af4b8", "createdAt": "2024-03-14T11:49:09.009000-04:00", "modifiedAt": "2024-03-14T12:03:49.776000-04:00", "tags": {} } } ``` Para obter mais informações, consulte [Gerenciamento de complementos do Amazon EKS – Excluir um complemento](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#removing-an-add-on), no *Amazon EKS*. **Exemplo 2. Para excluir um complemento do Amazon EKS e também excluir o software do complemento do cluster do EKS** O comando de exemplo `delete-addon` a seguir exclui um complemento do Amazon EKS e também exclui o software do complemento do cluster do EKS. ``` aws eks delete-addon \ --cluster-name my-eks-cluster \ --addon-name my-eks-addon ``` Resultado: ``` { "addon": { "addonName": "my-eks-addon", "clusterName": "my-eks-cluster", "status": "DELETING", "addonVersion": "v1.15.1-eksbuild.1", "health": { "issues": [] }, "addonArn": "arn:aws:eks:us-east-2:111122223333:addon/my-eks-cluster/my-eks-addon/bac71ed1-ec43-3bb6-88ea-f243cdb58954", "createdAt": "2024-03-14T11:45:31.983000-04:00", "modifiedAt": "2024-03-14T11:58:40.136000-04:00", "serviceAccountRoleArn": "arn:aws:iam::111122223333:role/role-name", "tags": {} } } ``` Para obter mais informações, consulte [Gerenciamento de complementos do Amazon EKS – Excluir um complemento](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#removing-an-add-on), no *Amazon EKS*. + Para ver detalhes da API, consulte [DeleteAddon](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/delete-addon.html) na *Referência de comandos da AWS CLI*. ### `delete-cluster` O código de exemplo a seguir mostra como usar `delete-cluster`. **AWS CLI** **Excluir um ambiente de gerenciamento de cluster do Amazon EKS** O exemplo `delete-cluster` a seguir exclui um ambiente de gerenciamento de cluster do Amazon EKS. ``` aws eks delete-cluster \ --name my-eks-cluster ``` Resultado: ``` { "cluster": { "name": "my-eks-cluster", "arn": "arn:aws:eks:us-east-2:111122223333:cluster/my-eks-cluster", "createdAt": "2024-03-14T11:31:44.348000-04:00", "version": "1.27", "endpoint": "https://DALSJ343KE23J3RN45653DSKJTT647TYD.yl4.us-east-2.eks.amazonaws.com", "roleArn": "arn:aws:iam::111122223333:role/eksctl-my-eks-cluster-cluster-ServiceRole-zMF6CBakwwbW", "resourcesVpcConfig": { "subnetIds": [ "subnet-0fb75d2d8401716e7", "subnet-02184492f67a3d0f9", "subnet-04098063527aab776", "subnet-0e2907431c9988b72", "subnet-04ad87f71c6e5ab4d", "subnet-09d912bb63ef21b9a" ], "securityGroupIds": [ "sg-0c1327f6270afbb36" ], "clusterSecurityGroupId": "sg-01c84d09d70f39a7f", "vpcId": "vpc-0012b8e1cc0abb17d", "endpointPublicAccess": true, "endpointPrivateAccess": true, "publicAccessCidrs": [ "0.0.0.0/0" ] }, "kubernetesNetworkConfig": { "serviceIpv4Cidr": "10.100.0.0/16", "ipFamily": "ipv4" }, "logging": { "clusterLogging": [ { "types": [ "api", "audit", "authenticator", "controllerManager", "scheduler" ], "enabled": true } ] }, "identity": { "oidc": { "issuer": "https://oidc.eks.us-east-2.amazonaws.com/id/DALSJ343KE23J3RN45653DSKJTT647TYD" } }, "status": "DELETING", "certificateAuthority": { "data": "XXX_CA_DATA_XXX" }, "platformVersion": "eks.16", "tags": { "aws:cloudformation:stack-name": "eksctl-my-eks-cluster-cluster", "alpha.eksctl.io/cluster-name": "my-eks-cluster", "karpenter.sh/discovery": "my-eks-cluster", "aws:cloudformation:stack-id": "arn:aws:cloudformation:us-east-2:111122223333:stack/eksctl-my-eks-cluster-cluster/e752ea00-e217-11ee-beae-0a9599c8c7ed", "auto-delete": "no", "eksctl.cluster.k8s.io/v1alpha1/cluster-name": "my-eks-cluster", "EKS-Cluster-Name": "my-eks-cluster", "alpha.eksctl.io/cluster-oidc-enabled": "true", "aws:cloudformation:logical-id": "ControlPlane", "alpha.eksctl.io/eksctl-version": "0.173.0-dev+a7ee89342.2024-03-01T03:40:57Z", "Name": "eksctl-my-eks-cluster-cluster/ControlPlane" }, "accessConfig": { "authenticationMode": "API_AND_CONFIG_MAP" } } } ``` Para obter mais informações, consulte [Excluir um cluster do Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html) no *Guia do usuário do Amazon EKS*. + Consulte detalhes da API em [DeleteCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/delete-cluster.html) na *Referência de comandos da AWS CLI*. ### `delete-fargate-profile` O código de exemplo a seguir mostra como usar `delete-fargate-profile`. **AWS CLI** **Exemplo 1: criar um perfil do EKS Fargate para um seletor com um namespace** O exemplo `delete-fargate-profile` a seguir cria um perfil do EKS Fargate para um seletor com um namespace. ``` aws eks delete-fargate-profile \ --cluster-name my-eks-cluster \ --fargate-profile-name my-fargate-profile ``` Resultado: ``` { "fargateProfile": { "fargateProfileName": "my-fargate-profile", "fargateProfileArn": "arn:aws:eks:us-east-2:111122223333:fargateprofile/my-eks-cluster/my-fargate-profile/1ac72bb3-3fc6-2631-f1e1-98bff53bed62", "clusterName": "my-eks-cluster", "createdAt": "2024-03-19T11:48:39.975000-04:00", "podExecutionRoleArn": "arn:aws:iam::111122223333:role/role-name", "subnets": [ "subnet-09d912bb63ef21b9a", "subnet-04ad87f71c6e5ab4d", "subnet-0e2907431c9988b72" ], "selectors": [ { "namespace": "default", "labels": { "foo": "bar" } } ], "status": "DELETING", "tags": {} } } ``` Para obter mais informações, consulte [Perfil do AWS Fargate – Excluir um Fargate](https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html#delete-fargate-profile) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [DeleteFargateProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/delete-fargate-profile.html) na *Referência de comandos da AWS CLI*. ### `delete-nodegroup` O código de exemplo a seguir mostra como usar `delete-nodegroup`. **AWS CLI** **Exemplo 1: excluir um grupo de nós gerenciado em um cluster do Amazon EKS** O exemplo `delete-nodegroup` a seguir exclui um grupo de nós gerenciado em um cluster do Amazon EKS. ``` aws eks delete-nodegroup \ --cluster-name my-eks-cluster \ --nodegroup-name my-eks-nodegroup ``` Resultado: ``` { "nodegroup": { "nodegroupName": "my-eks-nodegroup", "nodegroupArn": "arn:aws:eks:us-east-2:111122223333:nodegroup/my-eks-cluster/my-eks-nodegroup/1ec75f5f-0e21-dcc0-b46e-f9c442685cd8", "clusterName": "my-eks-cluster", "version": "1.26", "releaseVersion": "1.26.12-20240329", "createdAt": "2024-04-08T13:25:15.033000-04:00", "modifiedAt": "2024-04-08T13:25:31.252000-04:00", "status": "DELETING", "capacityType": "SPOT", "scalingConfig": { "minSize": 1, "maxSize": 5, "desiredSize": 4 }, "instanceTypes": [ "t3.large" ], "subnets": [ "subnet-0e2907431c9988b72", "subnet-04ad87f71c6e5ab4d", "subnet-09d912bb63ef21b9a" ], "amiType": "AL2_x86_64", "nodeRole": "arn:aws:iam::111122223333:role/role-name", "labels": { "my-eks-nodegroup-label-2": "value-2", "my-eks-nodegroup-label-1": "value-1" }, "taints": [ { "key": "taint-key-1", "value": "taint-value-1", "effect": "NO_EXECUTE" } ], "diskSize": 50, "health": { "issues": [] }, "updateConfig": { "maxUnavailable": 2 }, "tags": { "my-eks-nodegroup-key-1": "value-1", "my-eks-nodegroup-key-2": "value-2" } } } ``` + Para ver detalhes da API, consulte [DeleteNodegroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/delete-nodegroup.html) na *Referência de comandos da AWS CLI*. ### `delete-pod-identity-association` O código de exemplo a seguir mostra como usar `delete-pod-identity-association`. **AWS CLI** **Para excluir a associação de Identidade de Pods do EKS** O exemplo a seguir `delete-pod-identity-association` exclui a associação de Identidade de Pods do EKS com o ID de associação `a-9njjin9gfghecgocd` do cluster do EKS chamado `eks-customer`. ``` aws eks delete-pod-identity-association \ --cluster-name eks-customer \ --association-id a-9njjin9gfghecgocd ``` Resultado: ``` { "association": { "clusterName": "eks-customer", "namespace": "default", "serviceAccount": "default", "roleArn": "arn:aws:iam::111122223333:role/s3-role", "associationArn": "arn:aws:eks:us-west-2:111122223333:podidentityassociation/eks-customer/a-9njjin9gfghecgocd", "associationId": "a-9njjin9gfghecgocd", "tags": { "Key2": "value2", "Key1": "value1" }, "createdAt": "2025-05-24T19:52:14.135000-05:00", "modifiedAt": "2025-05-25T21:10:56.923000-05:00" } } ``` Para obter mais informações, consulte [Saiba como a Identidade de Pods do EKS concede aos pods acesso aos serviços da AWS](https://docs.aws.amazon.com/eks/latest/userguide/pod-identities.html) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [DeletePodIdentityAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/delete-pod-identity-association.html) na *Referência de comandos da AWS CLI*. ### `deregister-cluster` O código de exemplo a seguir mostra como usar `deregister-cluster`. **AWS CLI** **Como cancelar o registro de um cluster conectado para removê-lo do ambiente de gerenciamento do Amazon EKS** O exemplo `deregister-cluster` a seguir cancela o registro de um cluster conectado para removê-lo do ambiente de gerenciamento do Amazon EKS. ``` aws eks deregister-cluster \ --name my-eks-anywhere-cluster ``` Resultado: ``` { "cluster": { "name": "my-eks-anywhere-cluster", "arn": "arn:aws:eks:us-east-2:111122223333:cluster/my-eks-anywhere-cluster", "createdAt": "2024-04-12T12:38:37.561000-04:00", "status": "DELETING", "tags": {}, "connectorConfig": { "activationId": "dfb5ad28-13c3-4e26-8a19-5b2457638c74", "activationExpiry": "2024-04-15T12:38:37.082000-04:00", "provider": "EKS_ANYWHERE", "roleArn": "arn:aws:iam::111122223333:role/AmazonEKSConnectorAgentRole" } } } ``` Para obter mais informações, consulte [Cancelar o registro de um cluster](https://docs.aws.amazon.com/eks/latest/userguide/deregister-connected-cluster.html) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [DeregisterCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/deregister-cluster.html) na *Referência de comandos da AWS CLI*. ### `describe-access-entry` O código de exemplo a seguir mostra como usar `describe-access-entry`. **AWS CLI** **Para descrever a entrada de acesso para o cluster do EKS** O exemplo a seguir `describe-access-entry` descreve uma entrada de acesso para o cluster do EKS. ``` aws eks describe-access-entry \ --cluster-name eks-customer \ --principal-arn arn:aws:iam::111122223333:user/eks-admin-user ``` Resultado: ``` { "accessEntry": { "clusterName": "eks-customer", "principalArn": "arn:aws:iam::111122223333:user/eks-admin-user", "kubernetesGroups": [], "accessEntryArn": "arn:aws:eks:us-west-2:111122223333:access-entry/eks-customer/user/111122223333/eks-admin-user/0acb1bc6-cb0a-ede6-11ae-a6506e3d36p0", "createdAt": "2025-04-14T22:45:48.097000-05:00", "modifiedAt": "2025-04-14T22:45:48.097000-05:00", "tags": {}, "username": "arn:aws:iam::111122223333:user/eks-admin-user", "type": "STANDARD" } } ``` Para obter mais informações, consulte [Conceder aos usuários do IAM acesso ao Kubernetes com entradas de acesso ao EKS](https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html) no *Guia do usuário do Amazon EKS*. + Consulte detalhes da API em [DescribeAccessEntry](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-access-entry.html) na *Referência de comandos da AWS CLI*. ### `describe-addon-configuration` O código de exemplo a seguir mostra como usar `describe-addon-configuration`. **AWS CLI** **Exemplo 1: opções de configuração disponíveis ao criar ou atualizar complementos do Amazon vpc-cni** O exemplo `describe-addon-configuration` a seguir retorna todo o esquema de configuração disponível que você usa quando um complemento é criado ou atualizado para o complemento vpc-cni com a respectiva versão. ``` aws eks describe-addon-configuration \ --addon-name vpc-cni \ --addon-version v1.15.1-eksbuild.1 ``` Resultado: ``` { "addonName": "vpc-cni", "addonVersion": "v1.15.1-eksbuild.1", "configurationSchema": "{\"$ref\":\"#/definitions/VpcCni\",\"$schema\":\"http://json-schema.org/draft-06/schema#\",\"definitions\":{\"Affinity\":{\"type\":[\"object\",\"null\"]},\"EniConfig\":{\"additionalProperties\":false,\"properties\":{\"create\":{\"type\":\"boolean\"},\"region\":{\"type\":\"string\"},\"subnets\":{\"additionalProperties\":{\"additionalProperties\":false,\"properties\":{\"id\":{\"type\":\"string\"},\"securityGroups\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"}},\"required\":[\"id\"],\"type\":\"object\"},\"minProperties\":1,\"type\":\"object\"}},\"required\":[\"create\",\"region\",\"subnets\"],\"type\":\"object\"},\"Env\":{\"additionalProperties\":false,\"properties\":{\"ADDITIONAL_ENI_TAGS\":{\"type\":\"string\"},\"ANNOTATE_POD_IP\":{\"format\":\"boolean\",\"type\":\"string\"},\"AWS_EC2_ENDPOINT\":{\"type\":\"string\"},\"AWS_EXTERNAL_SERVICE_CIDRS\":{\"type\":\"string\"},\"AWS_MANAGE_ENIS_NON_SCHEDULABLE\":{\"format\":\"boolean\",\"type\":\"string\"},\"AWS_VPC_CNI_NODE_PORT_SUPPORT\":{\"format\":\"boolean\",\"type\":\"string\"},\"AWS_VPC_ENI_MTU\":{\"format\":\"integer\",\"type\":\"string\"},\"AWS_VPC_K8S_CNI_CUSTOM_NETWORK_CFG\":{\"format\":\"boolean\",\"type\":\"string\"},\"AWS_VPC_K8S_CNI_EXCLUDE_SNAT_CIDRS\":{\"type\":\"string\"},\"AWS_VPC_K8S_CNI_EXTERNALSNAT\":{\"format\":\"boolean\",\"type\":\"string\"},\"AWS_VPC_K8S_CNI_LOGLEVEL\":{\"type\":\"string\"},\"AWS_VPC_K8S_CNI_LOG_FILE\":{\"type\":\"string\"},\"AWS_VPC_K8S_CNI_RANDOMIZESNAT\":{\"type\":\"string\"},\"AWS_VPC_K8S_CNI_VETHPREFIX\":{\"type\":\"string\"},\"AWS_VPC_K8S_PLUGIN_LOG_FILE\":{\"type\":\"string\"},\"AWS_VPC_K8S_PLUGIN_LOG_LEVEL\":{\"type\":\"string\"},\"CLUSTER_ENDPOINT\":{\"type\":\"string\"},\"DISABLE_INTROSPECTION\":{\"format\":\"boolean\",\"type\":\"string\"},\"DISABLE_LEAKED_ENI_CLEANUP\":{\"format\":\"boolean\",\"type\":\"string\"},\"DISABLE_METRICS\":{\"format\":\"boolean\",\"type\":\"string\"},\"DISABLE_NETWORK_RESOURCE_PROVISIONING\":{\"format\":\"boolean\",\"type\":\"string\"},\"DISABLE_POD_V6\":{\"format\":\"boolean\",\"type\":\"string\"},\"ENABLE_BANDWIDTH_PLUGIN\":{\"format\":\"boolean\",\"type\":\"string\"},\"ENABLE_POD_ENI\":{\"format\":\"boolean\",\"type\":\"string\"},\"ENABLE_PREFIX_DELEGATION\":{\"format\":\"boolean\",\"type\":\"string\"},\"ENABLE_V4_EGRESS\":{\"format\":\"boolean\",\"type\":\"string\"},\"ENABLE_V6_EGRESS\":{\"format\":\"boolean\",\"type\":\"string\"},\"ENI_CONFIG_ANNOTATION_DEF\":{\"type\":\"string\"},\"ENI_CONFIG_LABEL_DEF\":{\"type\":\"string\"},\"INTROSPECTION_BIND_ADDRESS\":{\"type\":\"string\"},\"IP_COOLDOWN_PERIOD\":{\"format\":\"integer\",\"type\":\"string\"},\"MAX_ENI\":{\"format\":\"integer\",\"type\":\"string\"},\"MINIMUM_IP_TARGET\":{\"format\":\"integer\",\"type\":\"string\"},\"POD_SECURITY_GROUP_ENFORCING_MODE\":{\"type\":\"string\"},\"WARM_ENI_TARGET\":{\"format\":\"integer\",\"type\":\"string\"},\"WARM_IP_TARGET\":{\"format\":\"integer\",\"type\":\"string\"},\"WARM_PREFIX_TARGET\":{\"format\":\"integer\",\"type\":\"string\"}},\"title\":\"Env\",\"type\":\"object\"},\"Init\":{\"additionalProperties\":false,\"properties\":{\"env\":{\"$ref\":\"#/definitions/InitEnv\"}},\"title\":\"Init\",\"type\":\"object\"},\"InitEnv\":{\"additionalProperties\":false,\"properties\":{\"DISABLE_TCP_EARLY_DEMUX\":{\"format\":\"boolean\",\"type\":\"string\"},\"ENABLE_V6_EGRESS\":{\"format\":\"boolean\",\"type\":\"string\"}},\"title\":\"InitEnv\",\"type\":\"object\"},\"Limits\":{\"additionalProperties\":false,\"properties\":{\"cpu\":{\"type\":\"string\"},\"memory\":{\"type\":\"string\"}},\"title\":\"Limits\",\"type\":\"object\"},\"NodeAgent\":{\"additionalProperties\":false,\"properties\":{\"enableCloudWatchLogs\":{\"format\":\"boolean\",\"type\":\"string\"},\"enablePolicyEventLogs\":{\"format\":\"boolean\",\"type\":\"string\"},\"healthProbeBindAddr\":{\"format\":\"integer\",\"type\":\"string\"},\"metricsBindAddr\":{\"format\":\"integer\",\"type\":\"string\"}},\"title\":\"NodeAgent\",\"type\":\"object\"},\"Resources\":{\"additionalProperties\":false,\"properties\":{\"limits\":{\"$ref\":\"#/definitions/Limits\"},\"requests\":{\"$ref\":\"#/definitions/Limits\"}},\"title\":\"Resources\",\"type\":\"object\"},\"Tolerations\":{\"additionalProperties\":false,\"items\":{\"type\":\"object\"},\"type\":\"array\"},\"VpcCni\":{\"additionalProperties\":false,\"properties\":{\"affinity\":{\"$ref\":\"#/definitions/Affinity\"},\"enableNetworkPolicy\":{\"format\":\"boolean\",\"type\":\"string\"},\"enableWindowsIpam\":{\"format\":\"boolean\",\"type\":\"string\"},\"eniConfig\":{\"$ref\":\"#/definitions/EniConfig\"},\"env\":{\"$ref\":\"#/definitions/Env\"},\"init\":{\"$ref\":\"#/definitions/Init\"},\"livenessProbeTimeoutSeconds\":{\"type\":\"integer\"},\"nodeAgent\":{\"$ref\":\"#/definitions/NodeAgent\"},\"readinessProbeTimeoutSeconds\":{\"type\":\"integer\"},\"resources\":{\"$ref\":\"#/definitions/Resources\"},\"tolerations\":{\"$ref\":\"#/definitions/Tolerations\"}},\"title\":\"VpcCni\",\"type\":\"object\"}},\"description\":\"vpc-cni\"}" } ``` **Exemplo 2: opções de configuração disponíveis ao criar ou atualizar complementos do Amazon coredns** O exemplo `describe-addon-configuration` a seguir retorna todo o esquema de configuração disponível que você usa quando um complemento é criado ou atualizado para o complemento coredns com a respectiva versão. ``` aws eks describe-addon-configuration \ --addon-name coredns \ --addon-version v1.8.7-eksbuild.4 ``` Resultado: ``` { "addonName": "coredns", "addonVersion": "v1.8.7-eksbuild.4", "configurationSchema": "{\"$ref\":\"#/definitions/Coredns\",\"$schema\":\"http://json-schema.org/draft-06/schema#\",\"definitions\":{\"Coredns\":{\"additionalProperties\":false,\"properties\":{\"computeType\":{\"type\":\"string\"},\"corefile\":{\"description\":\"Entire corefile contents to use with installation\",\"type\":\"string\"},\"nodeSelector\":{\"additionalProperties\":{\"type\":\"string\"},\"type\":\"object\"},\"replicaCount\":{\"type\":\"integer\"},\"resources\":{\"$ref\":\"#/definitions/Resources\"}},\"title\":\"Coredns\",\"type\":\"object\"},\"Limits\":{\"additionalProperties\":false,\"properties\":{\"cpu\":{\"type\":\"string\"},\"memory\":{\"type\":\"string\"}},\"title\":\"Limits\",\"type\":\"object\"},\"Resources\":{\"additionalProperties\":false,\"properties\":{\"limits\":{\"$ref\":\"#/definitions/Limits\"},\"requests\":{\"$ref\":\"#/definitions/Limits\"}},\"title\":\"Resources\",\"type\":\"object\"}}}" } ``` Para obter mais informações, consulte [Criar ou atualizar um arquivo kubeconfig para um cluster do Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html) no *Amazon EKS*. + Para ver detalhes da API, consulte [DescribeAddonConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-addon-configuration.html) na *Referência de comandos da AWS CLI*. ### `describe-addon-versions` O código de exemplo a seguir mostra como usar `describe-addon-versions`. **AWS CLI** **Exemplo 1: listar todos os complementos disponíveis para o cluster do EKS** O exemplo `describe-addon-versions` a seguir lista todos os complementos da AWS disponíveis. ``` aws eks describe-addon-versions \ --query 'sort_by(addons &owner)[].{publisher: publisher, owner: owner, addonName: addonName, type: type}' \ --output table ``` Resultado: ``` -------------------------------------------------------------------------------------------------------------------- | DescribeAddonVersions | +---------------------------------------------+------------------+-----------------------+-------------------------+ | addonName | owner | publisher | type | +---------------------------------------------+------------------+-----------------------+-------------------------+ | vpc-cni | aws | eks | networking | | snapshot-controller | aws | eks | storage | | kube-proxy | aws | eks | networking | | eks-pod-identity-agent | aws | eks | security | | coredns | aws | eks | networking | | aws-mountpoint-s3-csi-driver | aws | s3 | storage | | aws-guardduty-agent | aws | eks | security | | aws-efs-csi-driver | aws | eks | storage | | aws-ebs-csi-driver | aws | eks | storage | | amazon-cloudwatch-observability | aws | eks | observability | | adot | aws | eks | observability | | upwind-security_upwind-operator | aws-marketplace | Upwind Security | security | | upbound_universal-crossplane | aws-marketplace | upbound | infra-management | | tetrate-io_istio-distro | aws-marketplace | tetrate-io | policy-management | | teleport_teleport | aws-marketplace | teleport | policy-management | | stormforge_optimize-live | aws-marketplace | StormForge | cost-management | | splunk_splunk-otel-collector-chart | aws-marketplace | Splunk | monitoring | | solo-io_istio-distro | aws-marketplace | Solo.io | service-mesh | | rafay-systems_rafay-operator | aws-marketplace | rafay-systems | kubernetes-management | | new-relic_kubernetes-operator | aws-marketplace | New Relic | observability | | netapp_trident-operator | aws-marketplace | NetApp Inc. | storage | | leaksignal_leakagent | aws-marketplace | leaksignal | monitoring | | kubecost_kubecost | aws-marketplace | kubecost | cost-management | | kong_konnect-ri | aws-marketplace | kong | ingress-service-type | | kasten_k10 | aws-marketplace | Kasten by Veeam | data-protection | | haproxy-technologies_kubernetes-ingress-ee | aws-marketplace | HAProxy Technologies | ingress-controller | | groundcover_agent | aws-marketplace | groundcover | monitoring | | grafana-labs_kubernetes-monitoring | aws-marketplace | Grafana Labs | monitoring | | factorhouse_kpow | aws-marketplace | factorhouse | monitoring | | dynatrace_dynatrace-operator | aws-marketplace | dynatrace | monitoring | | datree_engine-pro | aws-marketplace | datree | policy-management | | datadog_operator | aws-marketplace | Datadog | monitoring | | cribl_cribledge | aws-marketplace | Cribl | observability | | calyptia_fluent-bit | aws-marketplace | Calyptia Inc | observability | | accuknox_kubearmor | aws-marketplace | AccuKnox | security | +---------------------------------------------+------------------+-----------------------+-------------------------+ ``` Para obter mais informações, consulte [Gerenciamento de complementos do Amazon EKS – Criar um complemento](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#creating-an-add-on), no *Guia do usuário do Amazon EKS*. **Exemplo 2: listar todos os complementos disponíveis para a versão especificada do Kubernetes compatível com o EKS** O exemplo `describe-addon-versions` a seguir lista todos os complementos disponíveis para a versão específica do Kubernetes compatível com o EKS. ``` aws eks describe-addon-versions \ --kubernetes-version=1.26 \ --query 'sort_by(addons &owner)[].{publisher: publisher, owner: owner, addonName: addonName, type: type}' \ --output table ``` Resultado: ``` -------------------------------------------------------------------------------------------------------------------- | DescribeAddonVersions | +---------------------------------------------+------------------+-----------------------+-------------------------+ | addonName | owner | publisher | type | +---------------------------------------------+------------------+-----------------------+-------------------------+ | vpc-cni | aws | eks | networking | | snapshot-controller | aws | eks | storage | | kube-proxy | aws | eks | networking | | eks-pod-identity-agent | aws | eks | security | | coredns | aws | eks | networking | | aws-mountpoint-s3-csi-driver | aws | s3 | storage | | aws-guardduty-agent | aws | eks | security | | aws-efs-csi-driver | aws | eks | storage | | aws-ebs-csi-driver | aws | eks | storage | | amazon-cloudwatch-observability | aws | eks | observability | | adot | aws | eks | observability | | upwind-security_upwind-operator | aws-marketplace | Upwind Security | security | | tetrate-io_istio-distro | aws-marketplace | tetrate-io | policy-management | | stormforge_optimize-live | aws-marketplace | StormForge | cost-management | | splunk_splunk-otel-collector-chart | aws-marketplace | Splunk | monitoring | | solo-io_istio-distro | aws-marketplace | Solo.io | service-mesh | | rafay-systems_rafay-operator | aws-marketplace | rafay-systems | kubernetes-management | | new-relic_kubernetes-operator | aws-marketplace | New Relic | observability | | netapp_trident-operator | aws-marketplace | NetApp Inc. | storage | | leaksignal_leakagent | aws-marketplace | leaksignal | monitoring | | kubecost_kubecost | aws-marketplace | kubecost | cost-management | | kong_konnect-ri | aws-marketplace | kong | ingress-service-type | | haproxy-technologies_kubernetes-ingress-ee | aws-marketplace | HAProxy Technologies | ingress-controller | | groundcover_agent | aws-marketplace | groundcover | monitoring | | grafana-labs_kubernetes-monitoring | aws-marketplace | Grafana Labs | monitoring | | dynatrace_dynatrace-operator | aws-marketplace | dynatrace | monitoring | | datadog_operator | aws-marketplace | Datadog | monitoring | | cribl_cribledge | aws-marketplace | Cribl | observability | | calyptia_fluent-bit | aws-marketplace | Calyptia Inc | observability | | accuknox_kubearmor | aws-marketplace | AccuKnox | security | +---------------------------------------------+------------------+-----------------------+-------------------------+ ``` Para obter mais informações, consulte [Gerenciamento de complementos do Amazon EKS – Criar um complemento](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#creating-an-add-on), no *Guia do usuário do Amazon EKS*. **Exemplo 3: listar todas as versões de complementos vpc-cni disponíveis para a versão especificada do Kubernetes compatível com EKS** O exemplo `describe-addon-versions` a seguir lista todas as versões de complementos vpc-cni disponíveis para a versão especificada do Kubernetes compatível com o EKS. ``` aws eks describe-addon-versions \ --kubernetes-version=1.26 \ --addon-name=vpc-cni \ --query='addons[].addonVersions[].addonVersion' ``` Resultado: ``` [ "v1.18.0-eksbuild.1", "v1.17.1-eksbuild.1", "v1.16.4-eksbuild.2", "v1.16.3-eksbuild.2", "v1.16.2-eksbuild.1", "v1.16.0-eksbuild.1", "v1.15.5-eksbuild.1", "v1.15.4-eksbuild.1", "v1.15.3-eksbuild.1", "v1.15.1-eksbuild.1", "v1.15.0-eksbuild.2", "v1.14.1-eksbuild.1", "v1.14.0-eksbuild.3", "v1.13.4-eksbuild.1", "v1.13.3-eksbuild.1", "v1.13.2-eksbuild.1", "v1.13.0-eksbuild.1", "v1.12.6-eksbuild.2", "v1.12.6-eksbuild.1", "v1.12.5-eksbuild.2", "v1.12.0-eksbuild.2" ] ``` Para obter mais informações, consulte [Gerenciamento de complementos do Amazon EKS – Criar um complemento](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#creating-an-add-on), no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [DescribeAddonVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-addon-versions.html) na *Referência de comandos da AWS CLI*. ### `describe-addon` O código de exemplo a seguir mostra como usar `describe-addon`. **AWS CLI** **Descrever o complemento do EKS em execução ativa em seu cluster do Amazon EKS** O exemplo `describe-addon` a seguir executa ativamente o complemento do Amazon EKS em seu cluster do Amazon EKS. ``` aws eks describe-addon \ --cluster-name my-eks-cluster \ --addon-name vpc-cni ``` Resultado: ``` { "addon": { "addonName": "vpc-cni", "clusterName": "my-eks-cluster", "status": "ACTIVE", "addonVersion": "v1.16.4-eksbuild.2", "health": { "issues": [] }, "addonArn": "arn:aws:eks:us-east-2:111122223333:addon/my-eks-cluster/vpc-cni/0ec71efc-98dd-3203-60b0-4b939b2a5e5f", "createdAt": "2024-03-14T13:18:45.417000-04:00", "modifiedAt": "2024-03-14T13:18:49.557000-04:00", "serviceAccountRoleArn": "arn:aws:iam::111122223333:role/eksctl-my-eks-cluster-addon-vpc-cni-Role1-YfakrqOC1UTm", "tags": { "eks-addon-key-3": "value-3", "eks-addon-key-4": "value-4" }, "configurationValues": "resources:\n limits:\n cpu: '100m'\nenv:\n AWS_VPC_K8S_CNI_LOGLEVEL: 'DEBUG'" } } ``` + Para ver detalhes da API, consulte [DescribeAddon](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-addon.html) na *Referência de comandos da AWS CLI*. ### `describe-cluster` O código de exemplo a seguir mostra como usar `describe-cluster`. **AWS CLI** **Descrever o complemento do EKS em execução ativa em seu cluster do Amazon EKS** O exemplo `describe-cluster` a seguir executa ativamente o complemento do Amazon EKS em seu cluster do Amazon EKS. ``` aws eks describe-cluster \ --name my-eks-cluster ``` Resultado: ``` { "cluster": { "name": "my-eks-cluster", "arn": "arn:aws:eks:us-east-2:111122223333:cluster/my-eks-cluster", "createdAt": "2024-03-14T11:31:44.348000-04:00", "version": "1.26", "endpoint": "https://JSA79429HJDASKJDJ8223829MNDNASW.yl4.us-east-2.eks.amazonaws.com", "roleArn": "arn:aws:iam::111122223333:role/eksctl-my-eks-cluster-cluster-ServiceRole-zMF6CBakwwbW", "resourcesVpcConfig": { "subnetIds": [ "subnet-0fb75d2d8401716e7", "subnet-02184492f67a3d0f9", "subnet-04098063527aab776", "subnet-0e2907431c9988b72", "subnet-04ad87f71c6e5ab4d", "subnet-09d912bb63ef21b9a" ], "securityGroupIds": [ "sg-0c1327f6270afbb36" ], "clusterSecurityGroupId": "sg-01c84d09d70f39a7f", "vpcId": "vpc-0012b8e1cc0abb17d", "endpointPublicAccess": true, "endpointPrivateAccess": true, "publicAccessCidrs": [ "22.19.18.2/32" ] }, "kubernetesNetworkConfig": { "serviceIpv4Cidr": "10.100.0.0/16", "ipFamily": "ipv4" }, "logging": { "clusterLogging": [ { "types": [ "api", "audit", "authenticator", "controllerManager", "scheduler" ], "enabled": true } ] }, "identity": { "oidc": { "issuer": "https://oidc.eks.us-east-2.amazonaws.com/id/JSA79429HJDASKJDJ8223829MNDNASW" } }, "status": "ACTIVE", "certificateAuthority": { "data": "CA_DATA_STRING..." }, "platformVersion": "eks.14", "tags": { "aws:cloudformation:stack-name": "eksctl-my-eks-cluster-cluster", "alpha.eksctl.io/cluster-name": "my-eks-cluster", "karpenter.sh/discovery": "my-eks-cluster", "aws:cloudformation:stack-id": "arn:aws:cloudformation:us-east-2:111122223333:stack/eksctl-my-eks-cluster-cluster/e752ea00-e217-11ee-beae-0a9599c8c7ed", "auto-delete": "no", "eksctl.cluster.k8s.io/v1alpha1/cluster-name": "my-eks-cluster", "EKS-Cluster-Name": "my-eks-cluster", "alpha.eksctl.io/cluster-oidc-enabled": "true", "aws:cloudformation:logical-id": "ControlPlane", "alpha.eksctl.io/eksctl-version": "0.173.0-dev+a7ee89342.2024-03-01T03:40:57Z", "Name": "eksctl-my-eks-cluster-cluster/ControlPlane" }, "health": { "issues": [] }, "accessConfig": { "authenticationMode": "API_AND_CONFIG_MAP" } } } ``` + Consulte detalhes da API em [DescribeCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-cluster.html) na *Referência de comandos da AWS CLI*. ### `describe-fargate-profile` O código de exemplo a seguir mostra como usar `describe-fargate-profile`. **AWS CLI** **Descrever um perfil do Fargate** O exemplo `describe-fargate-profile` a seguir descreve um perfil do Fargate. ``` aws eks describe-fargate-profile \ --cluster-name my-eks-cluster \ --fargate-profile-name my-fargate-profile ``` Resultado: ``` { "fargateProfile": { "fargateProfileName": "my-fargate-profile", "fargateProfileArn": "arn:aws:eks:us-east-2:111122223333:fargateprofile/my-eks-cluster/my-fargate-profile/96c766ce-43d2-f9c9-954c-647334391198", "clusterName": "my-eks-cluster", "createdAt": "2024-04-11T10:42:52.486000-04:00", "podExecutionRoleArn": "arn:aws:iam::111122223333:role/eksctl-my-eks-cluster-farga-FargatePodExecutionRole-1htfAaJdJUEO", "subnets": [ "subnet-09d912bb63ef21b9a", "subnet-04ad87f71c6e5ab4d", "subnet-0e2907431c9988b72" ], "selectors": [ { "namespace": "prod*", "labels": { "labelname*?": "*value1" } }, { "namespace": "*dev*", "labels": { "labelname*?": "*value*" } } ], "status": "ACTIVE", "tags": { "eks-fargate-profile-key-2": "value-2", "eks-fargate-profile-key-1": "value-1" } } } ``` + Para ver detalhes da API, consulte [DescribeFargateProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-fargate-profile.html) na *Referência de comandos da AWS CLI*. ### `describe-identity-provider-config` O código de exemplo a seguir mostra como usar `describe-identity-provider-config`. **AWS CLI** **Descrever uma configuração de provedor de identidade associada ao cluster do Amazon EKS** O exemplo `describe-identity-provider-config` a seguir descreve uma configuração de provedor de identidade associada ao seu cluster do Amazon EKS. ``` aws eks describe-identity-provider-config \ --cluster-name my-eks-cluster \ --identity-provider-config type=oidc,name=my-identity-provider ``` Resultado: ``` { "identityProviderConfig": { "oidc": { "identityProviderConfigName": "my-identity-provider", "identityProviderConfigArn": "arn:aws:eks:us-east-2:111122223333:identityproviderconfig/my-eks-cluster/oidc/my-identity-provider/8ac76722-78e4-cec1-ed76-d49eea058622", "clusterName": "my-eks-cluster", "issuerUrl": "https://oidc.eks.us-east-2.amazonaws.com/id/38D6A4619A0A69E342B113ED7F1A7652", "clientId": "kubernetes", "usernameClaim": "email", "usernamePrefix": "my-username-prefix", "groupsClaim": "my-claim", "groupsPrefix": "my-groups-prefix", "requiredClaims": { "Claim1": "value1", "Claim2": "value2" }, "tags": { "env": "dev" }, "status": "ACTIVE" } } } ``` Para obter mais informações, consulte [Autenticar usuários para seu cluster a partir de um provedor de identidade OpenID Connect](https://docs.aws.amazon.com/eks/latest/userguide/authenticate-oidc-identity-provider.html) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [DescribeIdentityProviderConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-identity-provider-config.html) na *Referência de comandos da AWS CLI*. ### `describe-insight` O código de exemplo a seguir mostra como usar `describe-insight`. **AWS CLI** **Para obter os detalhes de um insight para um cluster do EKS usando seu ID** O exemplo a seguir `describe-insight` retorna os detalhes sobre o insight especificado usando o nome do cluster e o ID do insight. ``` aws eks describe-insight \ --cluster-name eks-customer \ --id 38ea7a64-a14f-4e0e-95c7-8dbcab3c3623 ``` Resultado: ``` { "insight": { "id": "38ea7a64-a14f-4e0e-95c7-8dbcab3c3623", "name": "Kubelet version skew", "category": "UPGRADE_READINESS", "kubernetesVersion": "1.33", "lastRefreshTime": "2025-05-24T11:22:50-05:00", "lastTransitionTime": "2025-05-24T11:22:50-05:00", "description": "Checks for kubelet versions of worker nodes in the cluster to see if upgrade would cause noncompliance with supported Kubernetes kubelet version skew policy.", "insightStatus": { "status": "PASSING", "reason": "Node kubelet versions match the cluster control plane version." }, "recommendation": "Upgrade your worker nodes to match the Kubernetes version of your cluster control plane.", "additionalInfo": { "Kubelet version skew policy": "https://kubernetes.io/releases/version-skew-policy/#kubelet", "Updating a managed node group": "https://docs.aws.amazon.com/eks/latest/userguide/update-managed-node-group.html" }, "resources": [], "categorySpecificSummary": { "deprecationDetails": [] } } } ``` Para obter mais informações, consulte [Exibir insights de clusters](https://docs.aws.amazon.com/eks/latest/userguide/view-cluster-insights.html) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [DescribeInsight](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-insight.html) na *Referência de comandos da AWS CLI*. ### `describe-nodegroup` O código de exemplo a seguir mostra como usar `describe-nodegroup`. **AWS CLI** **Descrever um grupo de nós gerenciado para um cluster do Amazon EKS** O exemplo `describe-nodegroup` a seguir descreve um grupo de nós gerenciado em um cluster do Amazon EKS. ``` aws eks describe-nodegroup \ --cluster-name my-eks-cluster \ --nodegroup-name my-eks-nodegroup ``` Resultado: ``` { "nodegroup": { "nodegroupName": "my-eks-nodegroup", "nodegroupArn": "arn:aws:eks:us-east-2:111122223333:nodegroup/my-eks-cluster/my-eks-nodegroup/a8c75f2f-df78-a72f-4063-4b69af3de5b1", "clusterName": "my-eks-cluster", "version": "1.26", "releaseVersion": "1.26.12-20240329", "createdAt": "2024-04-08T11:42:10.555000-04:00", "modifiedAt": "2024-04-08T11:44:12.402000-04:00", "status": "ACTIVE", "capacityType": "ON_DEMAND", "scalingConfig": { "minSize": 1, "maxSize": 3, "desiredSize": 1 }, "instanceTypes": [ "t3.medium" ], "subnets": [ "subnet-0e2907431c9988b72", "subnet-04ad87f71c6e5ab4d", "subnet-09d912bb63ef21b9a" ], "amiType": "AL2_x86_64", "nodeRole": "arn:aws:iam::111122223333:role/role-name", "labels": {}, "resources": { "autoScalingGroups": [ { "name": "eks-my-eks-nodegroup-a8c75f2f-df78-a72f-4063-4b69af3de5b1" } ] }, "diskSize": 20, "health": { "issues": [] }, "updateConfig": { "maxUnavailable": 1 }, "tags": {} } } ``` + Para ver detalhes da API, consulte [DescribeNodegroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-nodegroup.html) na *Referência de comandos da AWS CLI*. ### `describe-pod-identity-association` O código de exemplo a seguir mostra como usar `describe-pod-identity-association`. **AWS CLI** **Para fornecer detalhes sobre a associação de Identidade de Pods** O exemplo a seguir `describe-pod-identity-association` descreve uma associação de Identidade de Pods no cluster do EKS. ``` aws eks describe-pod-identity-association \ --cluster-name eks-customer \ --association-id a-9njjin9gfghecgocd ``` Resultado: ``` { "association": { "clusterName": "eks-customer", "namespace": "default", "serviceAccount": "default", "roleArn": "arn:aws:iam::111122223333:role/my-role", "associationArn": "arn:aws:eks:us-west-2:111122223333:podidentityassociation/eks-customer/a-9njjin9gfghecgocd", "associationId": "a-9njjin9gfghecgocd", "tags": { "Key2": "value2", "Key1": "value1" }, "createdAt": "2025-05-24T19:52:14.135000-05:00", "modifiedAt": "2025-05-24T19:52:14.135000-05:00" } } ``` Para obter mais informações, consulte [Saiba como a Identidade de Pods do EKS concede aos pods acesso aos serviços da AWS](https://docs.aws.amazon.com/eks/latest/userguide/pod-identities.html) no *Guia do usuário do Amazon EKS*. + Consulte detalhes da API em [DescribePodIdentityAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-pod-identity-association.html) na *Referência de comandos da AWS CLI*. ### `describe-update` O código de exemplo a seguir mostra como usar `describe-update`. **AWS CLI** **Exemplo 1: descrever uma atualização para um cluster** O exemplo `describe-update` a seguir descreve uma atualização para um cluster chamado. ``` aws eks describe-update \ --name my-eks-cluster \ --update-id 10bddb13-a71b-425a-b0a6-71cd03e59161 ``` Resultado: ``` { "update": { "id": "10bddb13-a71b-425a-b0a6-71cd03e59161", "status": "Successful", "type": "EndpointAccessUpdate", "params": [ { "type": "EndpointPublicAccess", "value": "false" }, { "type": "EndpointPrivateAccess", "value": "true" } ], "createdAt": "2024-03-14T10:01:26.297000-04:00", "errors": [] } } ``` Para obter mais informações, consulte [Atualizar uma versão do Kubernetes do cluster do Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/update-cluster.html) no *Guia do usuário do Amazon EKS*. **Exemplo 2: descrever uma atualização para um cluster** O exemplo `describe-update` a seguir descreve uma atualização para um cluster chamado. ``` aws eks describe-update \ --name my-eks-cluster \ --update-id e4994991-4c0f-475a-a040-427e6da52966 ``` Resultado: ``` { "update": { "id": "e4994991-4c0f-475a-a040-427e6da52966", "status": "Successful", "type": "AssociateEncryptionConfig", "params": [ { "type": "EncryptionConfig", "value": "[{\"resources\":[\"secrets\"],\"provider\":{\"keyArn\":\"arn:aws:kms:region-code:account:key/key\"}}]" } ], "createdAt": "2024-03-14T11:01:26.297000-04:00", "errors": [] } } ``` Para obter mais informações, consulte [Atualizar uma versão do Kubernetes do cluster do Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/update-cluster.html) no *Guia do usuário do Amazon EKS*. **Exemplo 3: descrever uma atualização para um cluster** O exemplo `describe-update` a seguir descreve uma atualização para um cluster chamado. ``` aws eks describe-update \ --name my-eks-cluster \ --update-id b5f0ba18-9a87-4450-b5a0-825e6e84496f ``` Resultado: ``` { "update": { "id": "b5f0ba18-9a87-4450-b5a0-825e6e84496f", "status": "Successful", "type": "VersionUpdate", "params": [ { "type": "Version", "value": "1.29" }, { "type": "PlatformVersion", "value": "eks.1" } ], "createdAt": "2024-03-14T12:05:26.297000-04:00", "errors": [] } } ``` Para obter mais informações, consulte [Atualizar uma versão do Kubernetes do cluster do Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/update-cluster.html) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [DescribeUpdate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-update.html) na *Referência de comandos da AWS CLI*. ### `disassociate-access-policy` O código de exemplo a seguir mostra como usar `disassociate-access-policy`. **AWS CLI** **Para desassociar uma política de acesso de uma entrada de acesso** O `disassociate-access-policy` a seguir remove a política de acesso associada à entrada de acesso. ``` aws eks disassociate-access-policy \ --cluster-name eks-customer \ --principal-arn arn:aws:iam::111122223333:role/Admin \ --policy-arn arn:aws:eks::aws:cluster-access-policy/AmazonEKSEditPolicy ``` Este comando não produz saída. Para obter mais informações, consulte [Associar políticas de acesso às entradas de acesso](https://docs.aws.amazon.com/eks/latest/userguide/access-policies.html) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [DisassociateAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/disassociate-access-policy.html) na *Referência de comandos da AWS CLI*. ### `disassociate-identity-provider-config` O código de exemplo a seguir mostra como usar `disassociate-identity-provider-config`. **AWS CLI** **Desassociar um provedor de identidade ao seu cluster do Amazon EKS** O exemplo `disassociate-identity-provider-config` a seguir desassocia um provedor de identidade ao seu cluster do Amazon EKS. ``` aws eks disassociate-identity-provider-config \ --cluster-name my-eks-cluster \ --identity-provider-config 'type=oidc,name=my-identity-provider' ``` Resultado: ``` { "update": { "id": "5f78d14e-c57b-4857-a3e4-cf664ae20949", "status": "InProgress", "type": "DisassociateIdentityProviderConfig", "params": [ { "type": "IdentityProviderConfig", "value": "[]" } ], "createdAt": "2024-04-11T13:53:43.314000-04:00", "errors": [] } } ``` Para obter mais informações, consulte [Autenticar usuários para o cluster em um provedor de identidade OpenID Connect – Desassociar um provedor de identidade OIDC do seu cluster](https://docs.aws.amazon.com/eks/latest/userguide/authenticate-oidc-identity-provider.html#disassociate-oidc-identity-provider) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [DisassociateIdentityProviderConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/disassociate-identity-provider-config.html) na *Referência de comandos da AWS CLI*. ### `get-token` O código de exemplo a seguir mostra como usar `get-token`. **AWS CLI** **Exemplo 1: obter um token de autenticação para um cluster do Amazon EKS chamado `my-eks-cluster`** O exemplo `get-token` a seguir obtém um token de autenticação para um cluster do Amazon EKS chamado my-eks-cluster. ``` aws eks get-token \ --cluster-name my-eks-cluster ``` Resultado: ``` { "kind": "ExecCredential", "apiVersion": "client.authentication.k8s.io/v1beta1", "spec": {}, "status": { "expirationTimestamp": "2024-04-11T20:59:56Z", "token": "k8s-aws-v1.EXAMPLE_TOKEN_DATA_STRING..." } } ``` **Exemplo 2: obter um token de autenticação para um cluster do Amazon EKS chamado `my-eks-cluster` assumindo esse roleARN como credenciais ao assinar o token** O exemplo `get-token` a seguir obtém um token de autenticação para um cluster do Amazon EKS chamado my-eks-cluster ao considerar esse roleARN como credenciais ao assinar o token. ``` aws eks get-token \ --cluster-name my-eks-cluster \ --role-arn arn:aws:iam::111122223333:role/eksctl-EKS-Linux-Cluster-v1-24-cluster-ServiceRole-j1k7AfTIQtnM ``` Resultado: ``` { "kind": "ExecCredential", "apiVersion": "client.authentication.k8s.io/v1beta1", "spec": {}, "status": { "expirationTimestamp": "2024-04-11T21:05:26Z", "token": "k8s-aws-v1.EXAMPLE_TOKEN_DATA_STRING..." } } ``` + Para ver detalhes da API, consulte [GetToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/get-token.html) na *Referência de comandos da AWS CLI*. ### `list-access-entries` O código de exemplo a seguir mostra como usar `list-access-entries`. **AWS CLI** **Para listar as entradas de acesso para um cluster do EKS** O `list-access-entries` a seguir retorna a lista de entradas de acesso associadas ao cluster do EKS `eks-customer`. ``` aws eks list-access-entries \ --cluster-name eks-customer ``` Resultado: ``` { "accessEntries": [ "arn:aws:iam::111122223333:role/Admin", "arn:aws:iam::111122223333:role/admin-test-ip", "arn:aws:iam::111122223333:role/assume-worker-node-role", "arn:aws:iam::111122223333:user/eks-admin-user" ] } ``` Para obter mais informações, consulte [Conceder aos usuários do IAM acesso ao Kubernetes com entradas de acesso ao EKS](https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [ListAccessEntries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-access-entries.html) na *Referência de comandos da AWS CLI*. ### `list-access-policies` O código de exemplo a seguir mostra como usar `list-access-policies`. **AWS CLI** **Para listar todas as políticas de acesso disponíveis** Este exemplo `list-access-policies` retorna a lista de todas as políticas de acesso disponíveis. ``` aws eks list-access-policies ``` Resultado: ``` { "accessPolicies": [ { "name": "AmazonEKSAdminPolicy", "arn": "arn:aws:eks::aws:cluster-access-policy/AmazonEKSAdminPolicy" }, { "name": "AmazonEKSAdminViewPolicy", "arn": "arn:aws:eks::aws:cluster-access-policy/AmazonEKSAdminViewPolicy" }, { "name": "AmazonEKSAutoNodePolicy", "arn": "arn:aws:eks::aws:cluster-access-policy/AmazonEKSAutoNodePolicy" }, { "name": "AmazonEKSBlockStorageClusterPolicy", "arn": "arn:aws:eks::aws:cluster-access-policy/AmazonEKSBlockStorageClusterPolicy" }, { "name": "AmazonEKSBlockStoragePolicy", "arn": "arn:aws:eks::aws:cluster-access-policy/AmazonEKSBlockStoragePolicy" }, { "name": "AmazonEKSClusterAdminPolicy", "arn": "arn:aws:eks::aws:cluster-access-policy/AmazonEKSClusterAdminPolicy" }, { "name": "AmazonEKSComputeClusterPolicy", "arn": "arn:aws:eks::aws:cluster-access-policy/AmazonEKSComputeClusterPolicy" }, { "name": "AmazonEKSComputePolicy", "arn": "arn:aws:eks::aws:cluster-access-policy/AmazonEKSComputePolicy" }, { "name": "AmazonEKSEditPolicy", "arn": "arn:aws:eks::aws:cluster-access-policy/AmazonEKSEditPolicy" }, { "name": "AmazonEKSHybridPolicy", "arn": "arn:aws:eks::aws:cluster-access-policy/AmazonEKSHybridPolicy" }, { "name": "AmazonEKSLoadBalancingClusterPolicy", "arn": "arn:aws:eks::aws:cluster-access-policy/AmazonEKSLoadBalancingClusterPolicy" }, { "name": "AmazonEKSLoadBalancingPolicy", "arn": "arn:aws:eks::aws:cluster-access-policy/AmazonEKSLoadBalancingPolicy" }, { "name": "AmazonEKSNetworkingClusterPolicy", "arn": "arn:aws:eks::aws:cluster-access-policy/AmazonEKSNetworkingClusterPolicy" }, { "name": "AmazonEKSNetworkingPolicy", "arn": "arn:aws:eks::aws:cluster-access-policy/AmazonEKSNetworkingPolicy" }, { "name": "AmazonEKSViewPolicy", "arn": "arn:aws:eks::aws:cluster-access-policy/AmazonEKSViewPolicy" }, { "name": "AmazonEMRJobPolicy", "arn": "arn:aws:eks::aws:cluster-access-policy/AmazonEMRJobPolicy" }, { "name": "AmazonSagemakerHyperpodClusterPolicy", "arn": "arn:aws:eks::aws:cluster-access-policy/AmazonSagemakerHyperpodClusterPolicy" }, { "name": "AmazonSagemakerHyperpodControllerPolicy", "arn": "arn:aws:eks::aws:cluster-access-policy/AmazonSagemakerHyperpodControllerPolicy" }, { "name": "AmazonSagemakerHyperpodSystemNamespacePolicy", "arn": "arn:aws:eks::aws:cluster-access-policy/AmazonSagemakerHyperpodSystemNamespacePolicy" } ] } ``` Para obter mais informações, consulte [Associar políticas de acesso às entradas de acesso](https://docs.aws.amazon.com/eks/latest/userguide/access-policies.html) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [ListAccessPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-access-policies.html) na *Referência de comandos da AWS CLI*. ### `list-addons` O código de exemplo a seguir mostra como usar `list-addons`. **AWS CLI** **Listar todos os complementos instalados em seu cluster Amazon EKS chamado `my-eks-cluster`** O exemplo `list-addons` a seguir lista todos os complementos instalados em seu cluster do Amazon EKS chamado my-eks-cluster. ``` aws eks list-addons \ --cluster-name my-eks-cluster ``` Resultado: ``` { "addons": [ "kube-proxy", "vpc-cni" ] } ``` + Para ver detalhes da API, consulte [ListAddons](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-addons.html) na *AWS CLI Command Reference*. ### `list-associated-access-policies` O código de exemplo a seguir mostra como usar `list-associated-access-policies`. **AWS CLI** **Para listar as políticas de acesso associadas a uma entrada de acesso**. O exemplo a seguir `list-associated-access-policies` retorna a lista de políticas de acesso associadas a uma entrada de acesso no cluster do EKS. ``` aws eks list-associated-access-policies \ --cluster-name eks-customer \ --principal-arn arn:aws:iam::111122223333:role/Admin ``` Resultado: ``` { "associatedAccessPolicies": [ { "policyArn": "arn:aws:eks::aws:cluster-access-policy/AmazonEKSAdminPolicy", "accessScope": { "type": "cluster", "namespaces": [] }, "associatedAt": "2025-05-24T17:26:22.935000-05:00", "modifiedAt": "2025-05-24T17:26:22.935000-05:00" } ], "clusterName": "eks-customer", "principalArn": "arn:aws:iam::111122223333:role/Admin" } ``` Para obter mais informações, consulte [Conceder aos usuários do IAM acesso ao Kubernetes com entradas de acesso ao EKS](https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [ListAssociatedAccessPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-associated-access-policies.html) na *Referência de comandos da AWS CLI*. ### `list-clusters` O código de exemplo a seguir mostra como usar `list-clusters`. **AWS CLI** **Para listar todos os complementos instalados em seu cluster do Amazon EKS chamado `my-eks-cluster`** O exemplo `list-clusters` a seguir lista todos os complementos instalados em seu cluster do Amazon EKS chamado my-eks-cluster. ``` aws eks list-clusters ``` Resultado: ``` { "clusters": [ "prod", "qa", "stage", "my-eks-cluster" ] } ``` + Consulte detalhes da API em [ListClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-clusters.html) na *Referência de comandos da AWS CLI*. ### `list-fargate-profiles` O código de exemplo a seguir mostra como usar `list-fargate-profiles`. **AWS CLI** **Para listar todos os perfis de fargate em seu cluster do Amazon EKS chamado `my-eks-cluster`** O exemplo `list-fargate-profiles` a seguir lista todos os perfis do Fargate em seu cluster do Amazon EKS chamado my-eks-cluster. ``` aws eks list-fargate-profiles \ --cluster-name my-eks-cluster ``` Resultado: ``` { "fargateProfileNames": [ "my-fargate-profile" ] } ``` + Para ver detalhes da API, consulte [ListFargateProfiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-fargate-profiles.html) na *Referência de comandos da AWS CLI*. ### `list-identity-provider-configs` O código de exemplo a seguir mostra como usar `list-identity-provider-configs`. **AWS CLI** **Listar provedores de identidade associados a um cluster do Amazon EKS** O exemplo `list-identity-provider-configs` a seguir lista o provedor de identidade associado a um cluster do Amazon EKS. ``` aws eks list-identity-provider-configs \ --cluster-name my-eks-cluster ``` Resultado: ``` { "identityProviderConfigs": [ { "type": "oidc", "name": "my-identity-provider" } ] } ``` Para obter mais informações, consulte [Autenticar usuários para seu cluster a partir de um provedor de identidade OpenID Connect](https://docs.aws.amazon.com/eks/latest/userguide/authenticate-oidc-identity-provider.html) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [ListIdentityProviderConfigs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-identity-provider-configs.html) na *Referência de comandos da AWS CLI*. ### `list-insights` O código de exemplo a seguir mostra como usar `list-insights`. **AWS CLI** **Para listar todos os insights do cluster especificado**. O exemplo a seguir `list-insights` retorna a lista de todos os insights verificados em relação ao cluster especificado. ``` aws eks list-insights \ --cluster-name eks-customer ``` Resultado: ``` { "insights": [ { "id": "38ea7a64-a14f-4e0e-95c7-8dbcab3c3616", "name": "Kubelet version skew", "category": "UPGRADE_READINESS", "kubernetesVersion": "1.33", "lastRefreshTime": "2025-05-24T11:22:50-05:00", "lastTransitionTime": "2025-05-24T11:22:50-05:00", "description": "Checks for kubelet versions of worker nodes in the cluster to see if upgrade would cause noncompliance with supported Kubernetes kubelet version skew policy.", "insightStatus": { "status": "PASSING", "reason": "Node kubelet versions match the cluster control plane version." } }, { "id": "9cd91472-f99c-45a9-b7d7-54d4900dee23", "name": "EKS add-on version compatibility", "category": "UPGRADE_READINESS", "kubernetesVersion": "1.33", "lastRefreshTime": "2025-05-24T11:22:59-05:00", "lastTransitionTime": "2025-05-24T11:22:50-05:00", "description": "Checks version of installed EKS add-ons to ensure they are compatible with the next version of Kubernetes. ", "insightStatus": { "status": "PASSING", "reason": "All installed EKS add-on versions are compatible with next Kubernetes version." } }, { "id": "0deb269d-b1e1-458c-a2b4-7a57f940c875", "name": "Cluster health issues", "category": "UPGRADE_READINESS", "kubernetesVersion": "1.33", "lastRefreshTime": "2025-05-24T11:22:59-05:00", "lastTransitionTime": "2025-05-24T11:22:50-05:00", "description": "Checks for any cluster health issues that prevent successful upgrade to the next Kubernetes version on EKS.", "insightStatus": { "status": "PASSING", "reason": "No cluster health issues detected." } }, { "id": "214fa274-344f-420b-812a-5049ce72c9ww", "name": "kube-proxy version skew", "category": "UPGRADE_READINESS", "kubernetesVersion": "1.33", "lastRefreshTime": "2025-05-24T11:22:50-05:00", "lastTransitionTime": "2025-05-24T11:22:50-05:00", "description": "Checks version of kube-proxy in cluster to see if upgrade would cause noncompliance with supported Kubernetes kube-proxy version skew policy.", "insightStatus": { "status": "PASSING", "reason": "kube-proxy versions match the cluster control plane version." } } ] } ``` Para obter mais informações, consulte [Exibir insights de clusters](https://docs.aws.amazon.com/eks/latest/userguide/view-cluster-insights.html) no *Guia do usuário do Amazon EKS*. + Consulte detalhes da API em [ListInsights](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-insights.html) na *Referência de comandos da AWS CLI*. ### `list-nodegroups` O código de exemplo a seguir mostra como usar `list-nodegroups`. **AWS CLI** **Listar todos os grupos de nós em um cluster do Amazon EKS** O exemplo `list-nodegroups` a seguir lista todos os grupos de nós gerenciados em um cluster do Amazon EKS. ``` aws eks list-nodegroups \ --cluster-name my-eks-cluster ``` Resultado: ``` { "nodegroups": [ "my-eks-managed-node-group", "my-eks-nodegroup" ] } ``` + Para ver detalhes da API, consulte [ListNodegroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-nodegroups.html) na *Referência de comandos da AWS CLI*. ### `list-pod-identity-associations` O código de exemplo a seguir mostra como usar `list-pod-identity-associations`. **AWS CLI** **Exemplo 1: para listar as associações da Identidade de Pods em um cluster do EKS**. O `list-pod-identity-associations` a seguir retorna a lista de associações da Identidade de Pods associadas ao cluster do EKS nomeado `eks-customer` em todos os namespaces e contas de serviço. ``` aws eks list-pod-identity-associations \ --cluster-name eks-customer ``` Resultado: ``` { "associations": [ { "clusterName": "eks-customer", "namespace": "default", "serviceAccount": "default", "associationArn": "arn:aws:eks:us-west-2:111122223333:podidentityassociation/eks-customer/a-9njjin9gfghecgocd", "associationId": "a-9njjin9gfghecgocd" }, { "clusterName": "eks-customer", "namespace": "kube-system", "serviceAccount": "eks-customer", "associationArn": "arn:aws:eks:us-west-2:111122223333:podidentityassociation/eks-customer/a-dvtacahdvjn01ffbc", "associationId": "a-dvtacahdvjn01ffbc" }, { "clusterName": "eks-customer", "namespace": "kube-system", "serviceAccount": "coredns", "associationArn": "arn:aws:eks:us-west-2:111122223333:podidentityassociation/eks-customer/a-yrpsdroc4ei7k6xps", "associationId": "a-yrpsdroc4ei7k6xps" } ] } ``` Para obter mais informações, consulte [Saiba como a Identidade de Pods do EKS concede aos pods acesso aos serviços da AWS](https://docs.aws.amazon.com/eks/latest/userguide/pod-identities.html) no *Guia do usuário do Amazon EKS*. **Exemplo 2: listar as associações da Identidade de Pods em um cluster do EKS com base no namespace e na conta de serviço** O `list-pod-identity-associations` a seguir retorna a lista de associações da Identidade de Pods no cluster do EKS com base no namespace e na conta de serviço. ``` aws eks list-pod-identity-associations \ --cluster-name eks-customer \ --namespace kube-system \ --service-account eks-customer ``` Resultado: ``` { "associations": [ { "clusterName": "eks-customer", "namespace": "kube-system", "serviceAccount": "eks-customer", "associationArn": "arn:aws:eks:us-west-2:111122223333:podidentityassociation/eks-customer/a-dvtacahdvjn01ffbc", "associationId": "a-dvtacahdvjn01ffbc" } ] } ``` Para obter mais informações, consulte [Saiba como a Identidade de Pods do EKS concede aos pods acesso aos serviços da AWS](https://docs.aws.amazon.com/eks/latest/userguide/pod-identities.html) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [ListPodIdentityAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-pod-identity-associations.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Exemplo 1: listar todas as tags de um ARN do cluster do Amazon EKS** O exemplo `list-tags-for-resource` a seguir lista todas as tags de um ARN do cluster do Amazon EKS. ``` aws eks list-tags-for-resource \ --resource-arn arn:aws:eks:us-east-2:111122223333:cluster/my-eks-cluster ``` Resultado: ``` { "tags": { "aws:cloudformation:stack-name": "eksctl-my-eks-cluster-cluster", "alpha.eksctl.io/cluster-name": "my-eks-cluster", "karpenter.sh/discovery": "my-eks-cluster", "aws:cloudformation:stack-id": "arn:aws:cloudformation:us-east-2:111122223333:stack/eksctl-my-eks-cluster-cluster/e752ea00-e217-11ee-beae-0a9599c8c7ed", "auto-delete": "no", "eksctl.cluster.k8s.io/v1alpha1/cluster-name": "my-eks-cluster", "EKS-Cluster-Name": "my-eks-cluster", "alpha.eksctl.io/cluster-oidc-enabled": "true", "aws:cloudformation:logical-id": "ControlPlane", "alpha.eksctl.io/eksctl-version": "0.173.0-dev+a7ee89342.2024-03-01T03:40:57Z", "Name": "eksctl-my-eks-cluster-cluster/ControlPlane" } } ``` **Exemplo 2: listar todas as tags de um ARN do grupo de nós do Amazon EKS** O exemplo `list-tags-for-resource` a seguir lista todas as tags de um ARN do grupo de nós do Amazon EKS. ``` aws eks list-tags-for-resource \ --resource-arn arn:aws:eks:us-east-2:111122223333:nodegroup/my-eks-cluster/my-eks-managed-node-group/60c71ed2-2cfb-020f-a5f4-ad32477f198c ``` Resultado: ``` { "tags": { "aws:cloudformation:stack-name": "eksctl-my-eks-cluster-nodegroup-my-eks-managed-node-group", "aws:cloudformation:stack-id": "arn:aws:cloudformation:us-east-2:111122223333:stack/eksctl-my-eks-cluster-nodegroup-my-eks-managed-node-group/eaa20310-e219-11ee-b851-0ab9ad8228ff", "eksctl.cluster.k8s.io/v1alpha1/cluster-name": "my-eks-cluster", "EKS-Cluster-Name": "my-eks-cluster", "alpha.eksctl.io/nodegroup-type": "managed", "NodeGroup Name 1": "my-eks-managed-node-group", "k8s.io/cluster-autoscaler/enabled": "true", "nodegroup-role": "worker", "alpha.eksctl.io/cluster-name": "my-eks-cluster", "alpha.eksctl.io/nodegroup-name": "my-eks-managed-node-group", "karpenter.sh/discovery": "my-eks-cluster", "NodeGroup Name 2": "AmazonLinux-Linux-Managed-NG-v1-26-v1", "auto-delete": "no", "k8s.io/cluster-autoscaler/my-eks-cluster": "owned", "aws:cloudformation:logical-id": "ManagedNodeGroup", "alpha.eksctl.io/eksctl-version": "0.173.0-dev+a7ee89342.2024-03-01T03:40:57Z" } } ``` **Exemplo 3: listar todas as tags de um ARN do perfil do Amazon EKS Fargate** O exemplo `list-tags-for-resource` a seguir lista todas as tags de um ARN do perfil do Amazon EKS Fargate. ``` aws eks list-tags-for-resource \ --resource-arn arn:aws:eks:us-east-2:111122223333:fargateprofile/my-eks-cluster/my-fargate-profile/d6c76780-e541-0725-c816-36754cab734b ``` Resultado: ``` { "tags": { "eks-fargate-profile-key-2": "value-2", "eks-fargate-profile-key-1": "value-1" } } ``` **Exemplo 4: listar todas as tags de um ARN complementar do Amazon EKS** O exemplo `list-tags-for-resource` a seguir lista todas as tags de um ARN adicional do Amazon EKS. ``` aws eks list-tags-for-resource \ --resource-arn arn:aws:eks:us-east-2:111122223333:addon/my-eks-cluster/vpc-cni/0ec71efc-98dd-3203-60b0-4b939b2a5e5f ``` Resultado: ``` { "tags": { "eks-addon-key-2": "value-2", "eks-addon-key-1": "value-1" } } ``` **Exemplo 5: listar todas as tags de um ARN provedor de identidade OIDC do Amazon EKS** O exemplo `list-tags-for-resource` a seguir lista todas as tags de um ARN do provedor de identidade OIDC do Amazon EKS. ``` aws eks list-tags-for-resource \ --resource-arn arn:aws:eks:us-east-2:111122223333:identityproviderconfig/my-eks-cluster/oidc/my-identity-provider/8ac76722-78e4-cec1-ed76-d49eea058622 ``` Resultado: ``` { "tags": { "my-identity-provider": "test" } } ``` + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `list-update` O código de exemplo a seguir mostra como usar `list-update`. **AWS CLI** **Exemplo 1: listar as atualizações associadas a um nome de cluster do Amazon EKS** O exemplo `list-updates` a seguir lista todos os IDs de atualização para um nome de cluster do Amazon EKS. ``` aws eks list-updates \ --name my-eks-cluster ``` Resultado: ``` { "updateIds": [ "5f78d14e-c57b-4857-a3e4-cf664ae20949", "760e5a3f-adad-48c7-88d3-7ac283c09c26", "cd4ec863-bc55-47d5-a377-3971502f529b", "f12657ce-e869-4f17-b158-a82ab8b7d937" ] } ``` **Exemplo 2: listar todos os IDs de atualização de um grupo de nós do Amazon EKS** O exemplo `list-updates` a seguir lista todos os IDs de atualização de um grupo de nós do Amazon EKS. ``` aws eks list-updates \ --name my-eks-cluster \ --nodegroup-name my-eks-managed-node-group ``` Resultado: ``` { "updateIds": [ "8c6c1bef-61fe-42ac-a242-89412387b8e7" ] } ``` **Exemplo 3: listar todos os IDs de atualização em um complemento do Amazon EKS** O exemplo `list-updates` a seguir lista todos os IDs de atualização de um complemento do Amazon EKS. ``` aws eks list-updates \ --name my-eks-cluster \ --addon-name vpc-cni ``` Resultado: ``` { "updateIds": [ "9cdba8d4-79fb-3c83-afe8-00b508d33268" ] } ``` + Para ver detalhes da API, consulte [ListUpdate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-update.html) na *Referência de comandos da AWS CLI*. ### `list-updates` O código de exemplo a seguir mostra como usar `list-updates`. **AWS CLI** **Para listar as atualizações de um cluster** Este comando de exemplo lista as atualizações atuais de um cluster chamado `example` na sua região padrão. Comando: ``` aws eks list-updates --name example ``` Resultado: ``` { "updateIds": [ "10bddb13-a71b-425a-b0a6-71cd03e59161" ] } ``` + Para ver detalhes da API, consulte [ListUpdates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-updates.html) na *Referência de comandos da AWS CLI*. ### `register-cluster` O código de exemplo a seguir mostra como usar `register-cluster`. **AWS CLI** **Exemplo 1: registrar um cluster do Kubernetes externo EKS\$1ANYWHERE no Amazon EKS** O exemplo `register-cluster` a seguir registra um cluster do Kubernetes externo EKS\$1ANYWHERE no Amazon EKS. ``` aws eks register-cluster \ --name my-eks-anywhere-cluster \ --connector-config 'roleArn=arn:aws:iam::111122223333:role/AmazonEKSConnectorAgentRole,provider=EKS_ANYWHERE' ``` Resultado: ``` { "cluster": { "name": "my-eks-anywhere-cluster", "arn": "arn:aws:eks:us-east-2:111122223333:cluster/my-eks-anywhere-cluster", "createdAt": "2024-04-12T12:38:37.561000-04:00", "status": "PENDING", "tags": {}, "connectorConfig": { "activationId": "xxxxxxxxACTIVATION_IDxxxxxxxx", "activationCode": "xxxxxxxxACTIVATION_CODExxxxxxxx", "activationExpiry": "2024-04-15T12:38:37.082000-04:00", "provider": "EKS_ANYWHERE", "roleArn": "arn:aws:iam::111122223333:role/AmazonEKSConnectorAgentRole" } } } ``` Para obter mais informações, consulte [Conectar um cluster externo](https://docs.aws.amazon.com/eks/latest/userguide/connecting-cluster.html) no *Guia do usuário do Amazon EKS*. **Exemplo 2: registrar qualquer cluster externo do Kubernetes no Amazon EKS** O exemplo `register-cluster` a seguir registra um cluster do Kubernetes externo EKS\$1ANYWHERE no Amazon EKS. ``` aws eks register-cluster \ --name my-eks-anywhere-cluster \ --connector-config 'roleArn=arn:aws:iam::111122223333:role/AmazonEKSConnectorAgentRole,provider=OTHER' ``` Resultado: ``` { "cluster": { "name": "my-onprem-k8s-cluster", "arn": "arn:aws:eks:us-east-2:111122223333:cluster/my-onprem-k8s-cluster", "createdAt": "2024-04-12T12:42:10.861000-04:00", "status": "PENDING", "tags": {}, "connectorConfig": { "activationId": "xxxxxxxxACTIVATION_IDxxxxxxxx", "activationCode": "xxxxxxxxACTIVATION_CODExxxxxxxx", "activationExpiry": "2024-04-15T12:42:10.339000-04:00", "provider": "OTHER", "roleArn": "arn:aws:iam::111122223333:role/AmazonEKSConnectorAgentRole" } } } ``` Para obter mais informações, consulte [Conectar um cluster externo](https://docs.aws.amazon.com/eks/latest/userguide/connecting-cluster.html) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [RegisterCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/register-cluster.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Exemplo 1: adicionar as tags especificadas a um cluster do Amazon EKS** O exemplo `tag-resource` a seguir adiciona as tags especificadas a um cluster do Amazon EKS. ``` aws eks tag-resource \ --resource-arn arn:aws:eks:us-east-2:111122223333:cluster/my-eks-cluster \ --tag 'my-eks-cluster-test-1=test-value-1,my-eks-cluster-dev-1=dev-value-2' ``` Este comando não produz saída. **Exemplo 2: adicionar as tags especificadas a um grupo de nós do Amazon EKS** O exemplo `tag-resource` a seguir adiciona as tags especificadas a um grupo de nós do Amazon EKS. ``` aws eks tag-resource \ --resource-arn arn:aws:eks:us-east-2:111122223333:nodegroup/my-eks-cluster/my-eks-managed-node-group/60c71ed2-2cfb-020f-a5f4-ad32477f198c \ --tag 'my-eks-nodegroup-test-1=test-value-1,my-eks-nodegroup-dev-1=dev-value-2' ``` Este comando não produz saída. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Exemplo 1: excluir as tags especificadas de um cluster do Amazon EKS** O exemplo `untag-resource` a seguir exclui as tags especificadas de um cluster do Amazon EKS. ``` aws eks untag-resource \ --resource-arn arn:aws:eks:us-east-2:111122223333:cluster/my-eks-cluster \ --tag-keys "my-eks-cluster-test-1" "my-eks-cluster-dev-1" ``` Este comando não produz saída. **Exemplo 2: excluir as tags especificadas de um grupo de nós do Amazon EKS** O exemplo `untag-resource` a seguir exclui as tags especificadas de um grupo de nós do Amazon EKS. ``` aws eks untag-resource \ --resource-arn arn:aws:eks:us-east-2:111122223333:nodegroup/my-eks-cluster/my-eks-managed-node-group/60c71ed2-2cfb-020f-a5f4-ad32477f198c \ --tag-keys "my-eks-nodegroup-test-1" "my-eks-nodegroup-dev-1" ``` Este comando não produz saída. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-access-entry` O código de exemplo a seguir mostra como usar `update-access-entry`. **AWS CLI** **Para atualizar uma entrada de acesso para um cluster do EKS** O `update-access-entry` a seguir atualiza uma entrada de acesso para o cluster do EKS adicionando o grupo de Kubernetes. `tester` ``` aws eks update-access-entry \ --cluster-name eks-customer \ --principal-arn arn:aws:iam::111122223333:role/Admin \ --kubernetes-groups tester ``` Resultado: ``` { "accessEntry": { "clusterName": "eks-customer", "principalArn": "arn:aws:iam::111122223333:role/Admin", "kubernetesGroups": [ "tester" ], "accessEntryArn": "arn:aws:eks:us-west-2:111122223333:access-entry/eks-customer/role/111122223333/Admin/d2cb8183-d6ec-b82a-d967-eca21902a4b4", "createdAt": "2025-05-24T11:02:04.432000-05:00", "modifiedAt": "2025-05-24T17:08:01.608000-05:00", "tags": {}, "username": "arn:aws:sts::111122223333:assumed-role/Admin/{{SessionName}}", "type": "STANDARD" } } ``` Para obter mais informações, consulte [Atualizar entradas de acesso](https://docs.aws.amazon.com/eks/latest/userguide/updating-access-entries.html) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [UpdateAccessEntry](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/update-access-entry.html) na *Referência de comandos da AWS CLI*. ### `update-addon` O código de exemplo a seguir mostra como usar `update-addon`. **AWS CLI** **Exemplo 1. Para atualizar um complemento do Amazon EKS com a função ARN da conta de serviço** O comando de exemplo `update-addon` a seguir atualiza um complemento do Amazon EKS com o ARN da função da conta de serviço. ``` aws eks update-addon \ --cluster-name my-eks-cluster \ --addon-name vpc-cni \ --service-account-role-arn arn:aws:iam::111122223333:role/eksctl-my-eks-cluster-addon-vpc-cni-Role1-YfakrqOC1UTm ``` Resultado: ``` { "update": { "id": "c00d2de2-c2e4-3d30-929e-46b8edec2ce4", "status": "InProgress", "type": "AddonUpdate", "params": [ { "type": "ServiceAccountRoleArn", "value": "arn:aws:iam::111122223333:role/eksctl-my-eks-cluster-addon-vpc-cni-Role1-YfakrqOC1UTm" } ], "updatedAt": "2024-04-12T16:04:55.614000-04:00", "errors": [] } } ``` Para obter mais informações, consulte [Gerenciamento de complementos do Amazon EKS – Atualizar um complemento](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#updating-an-add-on), no *Guia do usuário do Amazon EKS*. **Exemplo 2. Para atualizar um complemento do Amazon EKS com uma versão específica de complemento** O comando de exemplo `update-addon` a seguir atualiza um complemento do Amazon EKS com uma versão específica de complemento. ``` aws eks update-addon \ --cluster-name my-eks-cluster \ --addon-name vpc-cni \ --service-account-role-arn arn:aws:iam::111122223333:role/eksctl-my-eks-cluster-addon-vpc-cni-Role1-YfakrqOC1UTm \ --addon-version v1.16.4-eksbuild.2 ``` Resultado: ``` { "update": { "id": "f58dc0b0-2b18-34bd-bc6a-e4abc0011f36", "status": "InProgress", "type": "AddonUpdate", "params": [ { "type": "AddonVersion", "value": "v1.16.4-eksbuild.2" }, { "type": "ServiceAccountRoleArn", "value": "arn:aws:iam::111122223333:role/eksctl-my-eks-cluster-addon-vpc-cni-Role1-YfakrqOC1UTm" } ], "createdAt": "2024-04-12T16:07:16.550000-04:00", "errors": [] } } ``` Para obter mais informações, consulte [Gerenciamento de complementos do Amazon EKS – Atualizar um complemento](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#updating-an-add-on), no *Guia do usuário do Amazon EKS*. **Exemplo 3. Para atualizar um complemento do Amazon EKS com valores de configuração personalizados e resolver detalhes de conflitos** O comando de exemplo `update-addon` a seguir atualiza um complemento do Amazon EKS com valores de configuração personalizados e resolve detalhes de conflitos. ``` aws eks update-addon \ --cluster-name my-eks-cluster \ --addon-name vpc-cni \ --service-account-role-arn arn:aws:iam::111122223333:role/eksctl-my-eks-cluster-addon-vpc-cni-Role1-YfakrqOC1UTm \ --addon-version v1.16.4-eksbuild.2 \ --configuration-values '{"resources": {"limits":{"cpu":"100m"}, "requests":{"cpu":"50m"}}}' \ --resolve-conflicts PRESERVE ``` Resultado: ``` { "update": { "id": "cd9f2173-a8d8-3004-a90f-032f14326520", "status": "InProgress", "type": "AddonUpdate", "params": [ { "type": "AddonVersion", "value": "v1.16.4-eksbuild.2" }, { "type": "ServiceAccountRoleArn", "value": "arn:aws:iam::111122223333:role/eksctl-my-eks-cluster-addon-vpc-cni-Role1-YfakrqOC1UTm" }, { "type": "ResolveConflicts", "value": "PRESERVE" }, { "type": "ConfigurationValues", "value": "{\"resources\": {\"limits\":{\"cpu\":\"100m\"}, \"requests\":{\"cpu\":\"50m\"}}}" } ], "createdAt": "2024-04-12T16:16:27.363000-04:00", "errors": [] } } ``` Para obter mais informações, consulte [Gerenciamento de complementos do Amazon EKS – Atualizar um complemento](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#updating-an-add-on), no *Guia do usuário do Amazon EKS*. **Exemplo 4. Para atualizar um complemento do Amazon EKS com um arquivo de valores de configuração JSON personalizado** O comando de exemplo `update-addon` a seguir atualiza um complemento do Amazon EKS com valores de configuração JSON personalizados e detalhes de resolução de conflitos. ``` aws eks update-addon \ --cluster-name my-eks-cluster \ --addon-name vpc-cni \ --service-account-role-arn arn:aws:iam::111122223333:role/eksctl-my-eks-cluster-addon-vpc-cni-Role1-YfakrqOC1UTm \ --addon-version v1.17.1-eksbuild.1 \ --configuration-values 'file://configuration-values.json' \ --resolve-conflicts PRESERVE ``` Conteúdo de `configuration-values.json`: ``` { "resources": { "limits": { "cpu": "100m" }, "requests": { "cpu": "50m" } }, "env": { "AWS_VPC_K8S_CNI_LOGLEVEL": "ERROR" } } ``` Resultado: ``` { "update": { "id": "6881a437-174f-346b-9a63-6e91763507cc", "status": "InProgress", "type": "AddonUpdate", "params": [ { "type": "AddonVersion", "value": "v1.17.1-eksbuild.1" }, { "type": "ServiceAccountRoleArn", "value": "arn:aws:iam::111122223333:role/eksctl-my-eks-cluster-addon-vpc-cni-Role1-YfakrqOC1UTm" }, { "type": "ResolveConflicts", "value": "PRESERVE" }, { "type": "ConfigurationValues", "value": "{\n \"resources\": {\n \"limits\": {\n \"cpu\": \"100m\"\n },\n \"requests\": {\n \"cpu\": \"50m\"\n }\n },\n \"env\": {\n \"AWS_VPC_K8S_CNI_LOGLEVEL\": \"ERROR\"\n }\n}" } ], "createdAt": "2024-04-12T16:22:55.519000-04:00", "errors": [] } } ``` Para obter mais informações, consulte [Gerenciamento de complementos do Amazon EKS – Atualizar um complemento](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#updating-an-add-on), no *Guia do usuário do Amazon EKS*. **Exemplo 5. Para atualizar um complemento do Amazon EKS com o arquivo de valores de configuração YAML personalizados** O comando de exemplo `update-addon` a seguir atualiza um complemento do Amazon EKS com valores de configuração YAML personalizados e resolve detalhes de conflitos. ``` aws eks update-addon \ --cluster-name my-eks-cluster \ --addon-name vpc-cni \ --service-account-role-arn arn:aws:iam::111122223333:role/eksctl-my-eks-cluster-addon-vpc-cni-Role1-YfakrqOC1UTm \ --addon-version v1.18.0-eksbuild.1 \ --configuration-values 'file://configuration-values.yaml' \ --resolve-conflicts PRESERVE ``` Conteúdo de `configuration-values.yaml`: ``` resources: limits: cpu: '100m' requests: cpu: '50m' env: AWS_VPC_K8S_CNI_LOGLEVEL: 'DEBUG' ``` Resultado: ``` { "update": { "id": "a067a4c9-69d0-3769-ace9-d235c5b16701", "status": "InProgress", "type": "AddonUpdate", "params": [ { "type": "AddonVersion", "value": "v1.18.0-eksbuild.1" }, { "type": "ServiceAccountRoleArn", "value": "arn:aws:iam::111122223333:role/eksctl-my-eks-cluster-addon-vpc-cni-Role1-YfakrqOC1UTm" }, { "type": "ResolveConflicts", "value": "PRESERVE" }, { "type": "ConfigurationValues", "value": "resources:\n limits:\n cpu: '100m'\n requests:\n cpu: '50m'\nenv:\n AWS_VPC_K8S_CNI_LOGLEVEL: 'DEBUG'" } ], "createdAt": "2024-04-12T16:25:07.212000-04:00", "errors": [] } } ``` Para obter mais informações, consulte [Gerenciamento de complementos do Amazon EKS – Atualizar um complemento](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#updating-an-add-on), no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [UpdateAddon](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/update-addon.html) na *Referência de comandos da AWS CLI*. ### `update-cluster-config` O código de exemplo a seguir mostra como usar `update-cluster-config`. **AWS CLI** **Para atualizar o acesso ao endpoint do cluster** Este comando de exemplo atualiza um cluster para desativar o acesso público ao endpoint e habilitar o acesso ao endpoint privado. Comando: ``` aws eks update-cluster-config --name example \ --resources-vpc-config endpointPublicAccess=false,endpointPrivateAccess=true ``` Resultado: ``` { "update": { "id": "ec883c93-2e9e-407c-a22f-8f6fa6e67d4f", "status": "InProgress", "type": "EndpointAccessUpdate", "params": [ { "type": "EndpointPublicAccess", "value": "false" }, { "type": "EndpointPrivateAccess", "value": "true" } ], "createdAt": 1565806986.506, "errors": [] } } ``` **Para habilitar o log para um cluster** Este comando de exemplo habilita todos os tipos de registro do ambiente de gerenciamento de cluster para um cluster chamado `example`. Comando: ``` aws eks update-cluster-config --name example \ --logging '{"clusterLogging":[{"types":["api","audit","authenticator","controllerManager","scheduler"],"enabled":true}]}' ``` Resultado: ``` { "update": { "id": "7551c64b-1d27-4b1e-9f8e-c45f056eb6fd", "status": "InProgress", "type": "LoggingUpdate", "params": [ { "type": "ClusterLogging", "value": "{\"clusterLogging\":[{\"types\":[\"api\",\"audit\",\"authenticator\",\"controllerManager\",\"scheduler\"],\"enabled\":true}]}" } ], "createdAt": 1565807210.37, "errors": [] } } ``` + Para ver detalhes da API, consulte [UpdateClusterConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/update-cluster-config.html) na *Referência de comandos da AWS CLI*. ### `update-cluster-version` O código de exemplo a seguir mostra como usar `update-cluster-version`. **AWS CLI** **Para atualizar um cluster do Amazon EKS chamado `my-eks-cluster` para a versão especificada do Kubernetes** O exemplo `update-cluster-version` a seguir atualiza um cluster do Amazon EKS para a versão especificada do Kubernetes. ``` aws eks update-cluster-version \ --name my-eks-cluster \ --kubernetes-version 1.27 ``` Resultado: ``` { "update": { "id": "e4091a28-ea14-48fd-a8c7-975aeb469e8a", "status": "InProgress", "type": "VersionUpdate", "params": [ { "type": "Version", "value": "1.27" }, { "type": "PlatformVersion", "value": "eks.16" } ], "createdAt": "2024-04-12T16:56:01.082000-04:00", "errors": [] } } ``` Para obter mais informações, consulte [Atualizar uma versão do Kubernetes do cluster do Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/update-cluster.html) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [UpdateClusterVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/update-cluster-version.html) na *Referência de comandos da AWS CLI*. ### `update-kubeconfig` O código de exemplo a seguir mostra como usar `update-kubeconfig`. **AWS CLI** **Exemplo 1: configura seu kubectl criando ou atualizando o kubeconfig para que você possa se conectar a um cluster do Amazon EKS chamado `my-eks-cluster`** O exemplo `update-kubeconfig` a seguir configura seu kubectl criando ou atualizando o kubeconfig para que você possa se conectar a um cluster do Amazon EKS chamado my-eks-cluster. ``` aws eks update-kubeconfig \ --name my-eks-cluster ``` Resultado: ``` Updated context arn:aws:eks:us-east-2:111122223333:cluster/my-eks-cluster in /Users/xxx/.kube/config ``` Para obter mais informações, consulte [Criar ou atualizar um arquivo kubeconfig para um cluster do Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html) no *Guia do usuário do Amazon EKS*. **Exemplo 2: configura seu kubectl criando ou atualizando o kubeconfig (com a opção role-arn para assumir uma função de autenticação de cluster) para que você possa se conectar a um cluster do Amazon EKS chamado `my-eks-cluster`** O exemplo `update-kubeconfig` a seguir configura seu kubectl criando ou atualizando o kubeconfig (com a opção role-arn para assumir uma função de autenticação de cluster) para que você possa se conectar a um cluster do Amazon EKS chamado my-eks-cluster. ``` aws eks update-kubeconfig \ --name my-eks-cluster \ --role-arn arn:aws:iam::111122223333:role/eksctl-EKS-Linux-Cluster-v1-24-cluster-ServiceRole-j1k7AfTIQtnM ``` Resultado: ``` Updated context arn:aws:eks:us-east-2:111122223333:cluster/my-eks-cluster in /Users/xxx/.kube/config ``` Para obter mais informações, consulte [Criar ou atualizar um arquivo kubeconfig para um cluster do Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html) no *Guia do usuário do Amazon EKS*. **Exemplo 3: configura seu kubectl criando ou atualizando o kubeconfig (com a opção role-arn para assumir uma função de autenticação de cluster junto com o alias de cluster e o user-alias personalizados) para que você possa se conectar a um cluster do Amazon EKS chamado `my-eks-cluster`** O exemplo `update-kubeconfig` a seguir configura seu kubectl criando ou atualizando o kubeconfig (com a opção role-arn para assumir uma função de autenticação de cluster junto com o alias de cluster e user-alias personalizados) para que você possa se conectar a um cluster do Amazon EKS chamado my-eks-cluster. ``` aws eks update-kubeconfig \ --name my-eks-cluster \ --role-arn arn:aws:iam::111122223333:role/eksctl-EKS-Linux-Cluster-v1-24-cluster-ServiceRole-j1k7AfTIQtnM \ --alias stage-eks-cluster \ --user-alias john ``` Resultado: ``` Updated context stage-eks-cluster in /Users/dubaria/.kube/config ``` Para obter mais informações, consulte [Criar ou atualizar um arquivo kubeconfig para um cluster do Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html) no *Guia do usuário do Amazon EKS*. **Exemplo 4: imprime entradas do arquivo kubeconfig para análise e configura seu kubectl para que você possa se conectar a um cluster do Amazon EKS chamado `my-eks-cluster`** O exemplo `update-kubeconfig` a seguir configura seu kubectl criando ou atualizando o kubeconfig (com a opção role-arn para assumir uma função de autenticação de cluster junto com o alias de cluster e user-alias personalizados) para que você possa se conectar a um cluster do Amazon EKS chamado my-eks-cluster. ``` aws eks update-kubeconfig \ --name my-eks-cluster \ --role-arn arn:aws:iam::111122223333:role/eksctl-EKS-Linux-Cluster-v1-24-cluster-ServiceRole-j1k7AfTIQtnM \ --alias stage-eks-cluster \ --user-alias john \ --verbose ``` Resultado: ``` Updated context stage-eks-cluster in /Users/dubaria/.kube/config Entries: context: cluster: arn:aws:eks:us-east-2:111122223333:cluster/my-eks-cluster user: john name: stage-eks-cluster name: john user: exec: apiVersion: client.authentication.k8s.io/v1beta1 args: - --region - us-east-2 - eks - get-token - --cluster-name - my-eks-cluster - --output - json - --role - arn:aws:iam::111122223333:role/eksctl-EKS-Linux-Cluster-v1-24-cluster-ServiceRole-j1k7AfTIQtnM command: aws cluster: certificate-authority-data: xxx_CA_DATA_xxx server: https://DALSJ343KE23J3RN45653DSKJTT647TYD.yl4.us-east-2.eks.amazonaws.com name: arn:aws:eks:us-east-2:111122223333:cluster/my-eks-cluster ``` Para obter mais informações, consulte [Criar ou atualizar um arquivo kubeconfig para um cluster do Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [UpdateKubeconfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/update-kubeconfig.html) na *Referência de comandos da AWS CLI*. ### `update-nodegroup-config` O código de exemplo a seguir mostra como usar `update-nodegroup-config`. **AWS CLI** **Exemplo 1: atualizar um grupo de nós gerenciados para adicionar novos rótulos e taint ao nó de processamento do EKS para um cluster do Amazon EKS** O exemplo `update-nodegroup-config` a seguir atualiza um grupo de nós gerenciados para adicionar novos rótulos e taint ao nó de processamento do EKS para um cluster do Amazon EKS. ``` aws eks update-nodegroup-config \ --cluster-name my-eks-cluster \ --nodegroup-name my-eks-nodegroup \ --labels 'addOrUpdateLabels={my-eks-nodegroup-label-1=value-1,my-eks-nodegroup-label-2=value-2}' \ --taints 'addOrUpdateTaints=[{key=taint-key-1,value=taint-value-1,effect=NO_EXECUTE}]' ``` Resultado: ``` { "update": { "id": "e66d21d3-bd8b-3ad1-a5aa-b196dc08c7c1", "status": "InProgress", "type": "ConfigUpdate", "params": [ { "type": "LabelsToAdd", "value": "{\"my-eks-nodegroup-label-2\":\"value-2\",\"my-eks-nodegroup-label-1\":\"value-1\"}" }, { "type": "TaintsToAdd", "value": "[{\"effect\":\"NO_EXECUTE\",\"value\":\"taint-value-1\",\"key\":\"taint-key-1\"}]" } ], "createdAt": "2024-04-08T12:05:19.161000-04:00", "errors": [] } } ``` Para obter mais informações, consulte [Atualizar um grupo de nós gerenciados](https://docs.aws.amazon.com/eks/latest/userguide/update-managed-node-group.html) no *Guia do usuário do Amazon EKS*. **Exemplo 2: atualizar um grupo de nós gerenciados para remover rótulos e taints do nó de processamento do EKS de um cluster do Amazon EKS** O exemplo `update-nodegroup-config` a seguir atualiza um grupo de nós gerenciados para remover rótulos e taint do nó de processamento do EKS de um cluster do Amazon EKS. ``` aws eks update-nodegroup-config \ --cluster-name my-eks-cluster \ --nodegroup-name my-eks-nodegroup \ --labels 'removeLabels=my-eks-nodegroup-label-1, my-eks-nodegroup-label-2' \ --taints 'removeTaints=[{key=taint-key-1,value=taint-value-1,effect=NO_EXECUTE}]' ``` Resultado: ``` { "update": { "id": "67a08692-9e59-3ace-a916-13929f44cec3", "status": "InProgress", "type": "ConfigUpdate", "params": [ { "type": "LabelsToRemove", "value": "[\"my-eks-nodegroup-label-1\",\"my-eks-nodegroup-label-2\"]" }, { "type": "TaintsToRemove", "value": "[{\"effect\":\"NO_EXECUTE\",\"value\":\"taint-value-1\",\"key\":\"taint-key-1\"}]" } ], "createdAt": "2024-04-08T12:17:31.817000-04:00", "errors": [] } } ``` Para obter mais informações, consulte [Atualizar um grupo de nós gerenciados](https://docs.aws.amazon.com/eks/latest/userguide/update-managed-node-group.html) no *Guia do usuário do Amazon EKS*. **Exemplo 3: atualizar um grupo de nós gerenciados para remover e adicionar rótulos e taints ao nó de processamento do EKS de um cluster do Amazon EKS** O exemplo `update-nodegroup-config` a seguir atualiza um grupo de nós gerenciados para remover e adicionar rótulos e taint do nó de processamento do EKS de um cluster do Amazon EKS. ``` aws eks update-nodegroup-config \ --cluster-name my-eks-cluster \ --nodegroup-name my-eks-nodegroup \ --labels 'addOrUpdateLabels={my-eks-nodegroup-new-label-1=new-value-1,my-eks-nodegroup-new-label-2=new-value-2},removeLabels=my-eks-nodegroup-label-1, my-eks-nodegroup-label-2' \ --taints 'addOrUpdateTaints=[{key=taint-new-key-1,value=taint-new-value-1,effect=PREFER_NO_SCHEDULE}],removeTaints=[{key=taint-key-1,value=taint-value-1,effect=NO_EXECUTE}]' ``` Resultado: ``` { "update": { "id": "4a9c8c45-6ac7-3115-be71-d6412a2339b7", "status": "InProgress", "type": "ConfigUpdate", "params": [ { "type": "LabelsToAdd", "value": "{\"my-eks-nodegroup-new-label-1\":\"new-value-1\",\"my-eks-nodegroup-new-label-2\":\"new-value-2\"}" }, { "type": "LabelsToRemove", "value": "[\"my-eks-nodegroup-label-1\",\"my-eks-nodegroup-label-2\"]" }, { "type": "TaintsToAdd", "value": "[{\"effect\":\"PREFER_NO_SCHEDULE\",\"value\":\"taint-new-value-1\",\"key\":\"taint-new-key-1\"}]" }, { "type": "TaintsToRemove", "value": "[{\"effect\":\"NO_EXECUTE\",\"value\":\"taint-value-1\",\"key\":\"taint-key-1\"}]" } ], "createdAt": "2024-04-08T12:30:55.486000-04:00", "errors": [] } } ``` Para obter mais informações, consulte [Atualizar um grupo de nós gerenciados](https://docs.aws.amazon.com/eks/latest/userguide/update-managed-node-group.html) no *Guia do usuário do Amazon EKS*. **Exemplo 4: atualizar um grupo de nós gerenciados para atualizar scaling-config e update-config para o nó de processamento do EKS para um cluster do Amazon EKS** O exemplo `update-nodegroup-config` a seguir atualiza um grupo de nós gerenciados para atualizar scaling-config e update-config para o nó de processamento do EKS para um cluster do Amazon EKS. ``` aws eks update-nodegroup-config \ --cluster-name my-eks-cluster \ --nodegroup-name my-eks-nodegroup \ --scaling-config minSize=1,maxSize=5,desiredSize=2 \ --update-config maxUnavailable=2 ``` Resultado: ``` { "update": { "id": "a977160f-59bf-3023-805d-c9826e460aea", "status": "InProgress", "type": "ConfigUpdate", "params": [ { "type": "MinSize", "value": "1" }, { "type": "MaxSize", "value": "5" }, { "type": "DesiredSize", "value": "2" }, { "type": "MaxUnavailable", "value": "2" } ], "createdAt": "2024-04-08T12:35:17.036000-04:00", "errors": [] } } ``` Para obter mais informações, consulte [Atualizar um grupo de nós gerenciados](https://docs.aws.amazon.com/eks/latest/userguide/update-managed-node-group.html) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [UpdateNodegroupConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/update-nodegroup-config.html) na *Referência de comandos da AWS CLI*. ### `update-nodegroup-version` O código de exemplo a seguir mostra como usar `update-nodegroup-version`. **AWS CLI** **Exemplo 1: atualizar a versão do Kubernetes ou a versão da AMI de um grupo de nós gerenciados do Amazon EKS** O exemplo `update-nodegroup-version` a seguir atualiza a versão do Kubernetes ou a versão da AMI de um grupo de nós gerenciados do Amazon EKS para a versão mais recente disponível para seu cluster do Kubernetes. ``` aws eks update-nodegroup-version \ --cluster-name my-eks-cluster \ --nodegroup-name my-eks-nodegroup \ --no-force ``` Resultado: ``` { "update": { "id": "a94ebfc3-6bf8-307a-89e6-7dbaa36421f7", "status": "InProgress", "type": "VersionUpdate", "params": [ { "type": "Version", "value": "1.26" }, { "type": "ReleaseVersion", "value": "1.26.12-20240329" } ], "createdAt": "2024-04-08T13:16:00.724000-04:00", "errors": [] } } ``` Para obter mais informações, consulte [Atualizar um grupo de nós gerenciados](https://docs.aws.amazon.com/eks/latest/userguide/update-managed-node-group.html) no *Guia do usuário do Amazon EKS*. **Exemplo 2: atualizar a versão do Kubernetes ou a versão da AMI de um grupo de nós gerenciados do Amazon EKS** O exemplo `update-nodegroup-version` a seguir atualiza a versão do Kubernetes ou a versão da AMI de um grupo de nós gerenciados do Amazon EKS para a versão de lançamento da AMI especificada. ``` aws eks update-nodegroup-version \ --cluster-name my-eks-cluster \ --nodegroup-name my-eks-nodegroup \ --kubernetes-version '1.26' \ --release-version '1.26.12-20240307' \ --no-force ``` Resultado: ``` { "update": { "id": "4db06fe1-088d-336b-bdcd-3fdb94995fb7", "status": "InProgress", "type": "VersionUpdate", "params": [ { "type": "Version", "value": "1.26" }, { "type": "ReleaseVersion", "value": "1.26.12-20240307" } ], "createdAt": "2024-04-08T13:13:58.595000-04:00", "errors": [] } } ``` Para obter mais informações, consulte Atualizar um grupo de nós gerenciados – ` no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [UpdateNodegroupVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/update-nodegroup-version.html) na *Referência de comandos da AWS CLI*. ### `update-pod-identity-association` O código de exemplo a seguir mostra como usar `update-pod-identity-association`. **AWS CLI** Para atualizar uma associação de Identidades de Pods do EKS O exemplo a seguir `update-pod-identity-association` atualiza uma associação da Identidade de Pods do EKS alterando o perfil do IAM associado de `arn:aws:iam::111122223333:role/my-role` para `arn:aws:iam::111122223333:role/s3-role` para a ID de associação `a-9njjin9gfghecgocd`. Essa API só permite atualizar o perfil do IAM associado. ``` aws eks update-pod-identity-association \ --cluster-name eks-customer \ --association-id a-9njjin9gfghecgocd \ --role-arn arn:aws:iam::111122223333:role/s3-role ``` Resultado: ``` { "association": { "clusterName": "eks-customer", "namespace": "default", "serviceAccount": "default", "roleArn": "arn:aws:iam::111122223333:role/s3-role", "associationArn": "arn:aws:eks:us-west-2:111122223333:podidentityassociation/eks-customer/a-9njjin9gfghecgocd", "associationId": "a-9njjin9gfghecgocd", "tags": { "Key2": "value2", "Key1": "value1" }, "createdAt": "2025-05-24T19:52:14.135000-05:00", "modifiedAt": "2025-05-25T21:01:53.120000-05:00" } } ``` Para obter mais informações, consulte [Saiba como a Identidade de Pods do EKS concede aos pods acesso aos serviços da AWS](https://docs.aws.amazon.com/eks/latest/userguide/pod-identities.html) no *Guia do usuário do Amazon EKS*. + Para ver detalhes da API, consulte [UpdatePodIdentityAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/update-pod-identity-association.html) na *Referência de comandos da AWS CLI*. # Exemplos do Elastic Beanstalk usando o AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Elastic Beanstalk. *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 ### `abort-environment-update` O código de exemplo a seguir mostra como usar `abort-environment-update`. **AWS CLI** **Abortar uma implantação** O comando a seguir aborta a implantação de uma versão da aplicação em execução em um ambiente chamado `my-env`: ``` aws elasticbeanstalk abort-environment-update --environment-name my-env ``` + Para ver detalhes da API, consulte [AbortEnvironmentUpdate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/abort-environment-update.html) na *Referência de comandos da AWS CLI*. ### `check-dns-availability` O código de exemplo a seguir mostra como usar `check-dns-availability`. **AWS CLI** **Verificar a disponibilidade de um CNAME** O comando a seguir verifica a disponibilidade do subdomínio `my-cname.elasticbeanstalk.com`: ``` aws elasticbeanstalk check-dns-availability --cname-prefix my-cname ``` Resultado: ``` { "Available": true, "FullyQualifiedCNAME": "my-cname.elasticbeanstalk.com" } ``` + Para ver detalhes da API, consulte [CheckDnsAvailability](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/check-dns-availability.html) na *Referência de comandos da AWS CLI*. ### `create-application-version` O código de exemplo a seguir mostra como usar `create-application-version`. **AWS CLI** **Criar uma nova versão da aplicação** O comando a seguir cria uma nova versão, “v1", de uma aplicação chamada “MyApp”: ``` aws elasticbeanstalk create-application-version --application-name MyApp --version-label v1 --description MyAppv1 --source-bundle S3Bucket="amzn-s3-demo-bucket",S3Key="sample.war" --auto-create-application ``` A aplicação será criada automaticamente se ainda não existir, devido à opção de criação automática de aplicação. O pacote de origem é um arquivo .war armazenado em um bucket do S3 chamado “amzn-s3-demo-bucket” que contém a aplicação de amostra do Apache Tomcat. Resultado: ``` { "ApplicationVersion": { "ApplicationName": "MyApp", "VersionLabel": "v1", "Description": "MyAppv1", "DateCreated": "2015-02-03T23:01:25.412Z", "DateUpdated": "2015-02-03T23:01:25.412Z", "SourceBundle": { "S3Bucket": "amzn-s3-demo-bucket", "S3Key": "sample.war" } } } ``` + Para ver detalhes da API, consulte [CreateApplicationVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/create-application-version.html) na *Referência de comandos da AWS CLI*. ### `create-application` O código de exemplo a seguir mostra como usar `create-application`. **AWS CLI** **Criar uma nova aplicação** O comando a seguir cria uma nova aplicação chamada “MyApp”: ``` aws elasticbeanstalk create-application --application-name MyApp --description "my application" ``` O comando `create-application` configura somente o nome e a descrição da aplicação. Para enviar o código-fonte para a aplicação, crie uma versão inicial da aplicação usando o `create-application-version`. O `create-application-version` também tem uma opção `auto-create-application` com a qual você pode criar a aplicação e a versão da aplicação em uma única etapa. Resultado: ``` { "Application": { "ApplicationName": "MyApp", "ConfigurationTemplates": [], "DateUpdated": "2015-02-12T18:32:21.181Z", "Description": "my application", "DateCreated": "2015-02-12T18:32:21.181Z" } } ``` + Para ver detalhes da API, consulte [CreateApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/create-application.html) na *Referência de comandos da AWS CLI*. ### `create-configuration-template` O código de exemplo a seguir mostra como usar `create-configuration-template`. **AWS CLI** **Criar um modelo de configuração** O comando a seguir cria um modelo de configuração chamado `my-app-v1` das configurações aplicadas a um ambiente com o id `e-rpqsewtp2j`: ``` aws elasticbeanstalk create-configuration-template --application-name my-app --template-name my-app-v1 --environment-id e-rpqsewtp2j ``` Resultado: ``` { "ApplicationName": "my-app", "TemplateName": "my-app-v1", "DateCreated": "2015-08-12T18:40:39Z", "DateUpdated": "2015-08-12T18:40:39Z", "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8" } ``` + Para ver detalhes da API, consulte [CreateConfigurationTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/create-configuration-template.html) na *Referência de comandos da AWS CLI*. ### `create-environment` O código de exemplo a seguir mostra como usar `create-environment`. **AWS CLI** **Criar um novo ambiente para uma aplicação** O comando a seguir cria um novo ambiente para a versão, “v1" de uma aplicação chamada “my-app”: ``` aws elasticbeanstalk create-environment --application-name my-app --environment-name my-env --cname-prefix my-app --version-label v1 --solution-stack-name "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8" ``` Resultado: ``` { "ApplicationName": "my-app", "EnvironmentName": "my-env", "VersionLabel": "v1", "Status": "Launching", "EnvironmentId": "e-izqpassy4h", "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", "CNAME": "my-app.elasticbeanstalk.com", "Health": "Grey", "Tier": { "Type": "Standard", "Name": "WebServer", "Version": " " }, "DateUpdated": "2015-02-03T23:04:54.479Z", "DateCreated": "2015-02-03T23:04:54.479Z" } ``` `v1` é o rótulo de uma versão da aplicação carregada anteriormente com create-application-version. **Especificar um arquivo JSON para definir as opções de configuração do ambiente** O comando `create-environment` a seguir especifica que um arquivo JSON com o nome `myoptions.json` deve ser usado para substituir valores obtidos da pilha de soluções ou do modelo de configuração: ``` aws elasticbeanstalk create-environment --environment-name sample-env --application-name sampleapp --option-settings file://myoptions.json ``` `myoptions.json` é um objeto JSON que define várias configurações: ``` [ { "Namespace": "aws:elb:healthcheck", "OptionName": "Interval", "Value": "15" }, { "Namespace": "aws:elb:healthcheck", "OptionName": "Timeout", "Value": "8" }, { "Namespace": "aws:elb:healthcheck", "OptionName": "HealthyThreshold", "Value": "2" }, { "Namespace": "aws:elb:healthcheck", "OptionName": "UnhealthyThreshold", "Value": "3" } ] ``` Para obter mais informações, consulte os Valores de Opção no *Guia do desenvolvedor do Elastic Beanstalk da AWS*. + Para ver detalhes da API, consulte [CreateEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/create-environment.html) na *Referência de comandos da AWS CLI*. ### `create-storage-location` O código de exemplo a seguir mostra como usar `create-storage-location`. **AWS CLI** **Criar um local de armazenamento** O comando a seguir cria seu local de armazenamento no Amazon S3: ``` aws elasticbeanstalk create-storage-location ``` Resultado: ``` { "S3Bucket": "elasticbeanstalk-us-west-2-0123456789012" } ``` + Para ver detalhes da API, consulte [CreateStorageLocation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/create-storage-location.html) na *Referência de comandos da AWS CLI*. ### `delete-application-version` O código de exemplo a seguir mostra como usar `delete-application-version`. **AWS CLI** **Excluir uma versão da aplicação** O comando a seguir exclui uma versão da aplicação chamada `22a0-stage-150819_182129` de uma aplicação chamada `my-app`: ``` aws elasticbeanstalk delete-application-version --version-label 22a0-stage-150819_182129 --application-name my-app ``` + Para ver detalhes da API, consulte [DeleteApplicationVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/delete-application-version.html) na *Referência de comandos da AWS CLI*. ### `delete-application` O código de exemplo a seguir mostra como usar `delete-application`. **AWS CLI** **Como excluir uma aplicação do** O comando a seguir exclui uma aplicação chamada `my-app`: ``` aws elasticbeanstalk delete-application --application-name my-app ``` + Para ver detalhes da API, consulte [DeleteApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/delete-application.html) na *Referência de comandos da AWS CLI*. ### `delete-configuration-template` O código de exemplo a seguir mostra como usar `delete-configuration-template`. **AWS CLI** **Excluir um modelo de configuração** O comando a seguir exclui um modelo de configuração chamado `my-template` de uma aplicação chamada `my-app`: ``` aws elasticbeanstalk delete-configuration-template --template-name my-template --application-name my-app ``` + Para ver detalhes da API, consulte [DeleteConfigurationTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/delete-configuration-template.html) na *Referência de comandos da AWS CLI*. ### `delete-environment-configuration` O código de exemplo a seguir mostra como usar `delete-environment-configuration`. **AWS CLI** **Excluir um rascunho de uma configuração** O comando a seguir exclui o rascunho de uma configuração de um ambiente chamado`my-env`: ``` aws elasticbeanstalk delete-environment-configuration --environment-name my-env --application-name my-app ``` + Para ver detalhes da API, consulte [DeleteEnvironmentConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/delete-environment-configuration.html) na *Referência de comandos da AWS CLI*. ### `describe-application-versions` O código de exemplo a seguir mostra como usar `describe-application-versions`. **AWS CLI** **Visualizar informações sobre a versão de uma aplicação** O comando a seguir recupera informações sobre uma versão da aplicação chamada `v2`: ``` aws elasticbeanstalk describe-application-versions --application-name my-app --version-label "v2" ``` Resultado: ``` { "ApplicationVersions": [ { "ApplicationName": "my-app", "VersionLabel": "v2", "Description": "update cover page", "DateCreated": "2015-07-23T01:32:26.079Z", "DateUpdated": "2015-07-23T01:32:26.079Z", "SourceBundle": { "S3Bucket": "elasticbeanstalk-us-west-2-015321684451", "S3Key": "my-app/5026-stage-150723_224258.war" } }, { "ApplicationName": "my-app", "VersionLabel": "v1", "Description": "initial version", "DateCreated": "2015-07-23T22:26:10.816Z", "DateUpdated": "2015-07-23T22:26:10.816Z", "SourceBundle": { "S3Bucket": "elasticbeanstalk-us-west-2-015321684451", "S3Key": "my-app/5026-stage-150723_222618.war" } } ] } ``` + Para ver detalhes da API, consulte [DescribeApplicationVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/describe-application-versions.html) na *Referência de comandos da AWS CLI*. ### `describe-applications` O código de exemplo a seguir mostra como usar `describe-applications`. **AWS CLI** **Visualizar uma lista de aplicações** O comando a seguir recupera informações sobre aplicações na região atual: ``` aws elasticbeanstalk describe-applications ``` Resultado: ``` { "Applications": [ { "ApplicationName": "ruby", "ConfigurationTemplates": [], "DateUpdated": "2015-08-13T21:05:44.376Z", "Versions": [ "Sample Application" ], "DateCreated": "2015-08-13T21:05:44.376Z" }, { "ApplicationName": "pythonsample", "Description": "Application created from the EB CLI using \"eb init\"", "Versions": [ "Sample Application" ], "DateCreated": "2015-08-13T19:05:43.637Z", "ConfigurationTemplates": [], "DateUpdated": "2015-08-13T19:05:43.637Z" }, { "ApplicationName": "nodejs-example", "ConfigurationTemplates": [], "DateUpdated": "2015-08-06T17:50:02.486Z", "Versions": [ "add elasticache", "First Release" ], "DateCreated": "2015-08-06T17:50:02.486Z" } ] } ``` + Para ver detalhes da API, consulte [DescribeApplications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/describe-applications.html) na *Referência de comandos da AWS CLI*. ### `describe-configuration-options` O código de exemplo a seguir mostra como usar `describe-configuration-options`. **AWS CLI** **Visualizar opções de configuração para um ambiente** O comando a seguir recupera as descrições de todas as opções de configuração disponíveis para um ambiente chamado `my-env`: ``` aws elasticbeanstalk describe-configuration-options --environment-name my-env --application-name my-app ``` Resultado (abreviado): ``` { "Options": [ { "Name": "JVMOptions", "UserDefined": false, "DefaultValue": "Xms=256m,Xmx=256m,XX:MaxPermSize=64m,JVM Options=", "ChangeSeverity": "RestartApplicationServer", "Namespace": "aws:cloudformation:template:parameter", "ValueType": "KeyValueList" }, { "Name": "Interval", "UserDefined": false, "DefaultValue": "30", "ChangeSeverity": "NoInterruption", "Namespace": "aws:elb:healthcheck", "MaxValue": 300, "MinValue": 5, "ValueType": "Scalar" }, ... { "Name": "LowerThreshold", "UserDefined": false, "DefaultValue": "2000000", "ChangeSeverity": "NoInterruption", "Namespace": "aws:autoscaling:trigger", "MinValue": 0, "ValueType": "Scalar" }, { "Name": "ListenerEnabled", "UserDefined": false, "DefaultValue": "true", "ChangeSeverity": "Unknown", "Namespace": "aws:elb:listener", "ValueType": "Boolean" } ] } ``` As opções de configuração disponíveis variam de acordo com a plataforma e a versão da configuração. Para obter mais informações sobre namespaces e opções compatíveis, consulte Valores das opções no *Guia do desenvolvedor do Elastic AWS Beanstalk*. + Para ver detalhes da API, consulte [DescribeConfigurationOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/describe-configuration-options.html) na *Referência de comandos da AWS CLI*. ### `describe-configuration-settings` O código de exemplo a seguir mostra como usar `describe-configuration-settings`. **AWS CLI** **Visualizar definições de configuração para um ambiente** O comando a seguir recupera as definições de configuração de um ambiente chamado `my-env`: ``` aws elasticbeanstalk describe-configuration-settings --environment-name my-env --application-name my-app ``` Resultado (abreviado): ``` { "ConfigurationSettings": [ { "ApplicationName": "my-app", "EnvironmentName": "my-env", "Description": "Environment created from the EB CLI using \"eb create\"", "DeploymentStatus": "deployed", "DateCreated": "2015-08-13T19:16:25Z", "OptionSettings": [ { "OptionName": "Availability Zones", "ResourceName": "AWSEBAutoScalingGroup", "Namespace": "aws:autoscaling:asg", "Value": "Any" }, { "OptionName": "Cooldown", "ResourceName": "AWSEBAutoScalingGroup", "Namespace": "aws:autoscaling:asg", "Value": "360" }, ... { "OptionName": "ConnectionDrainingTimeout", "ResourceName": "AWSEBLoadBalancer", "Namespace": "aws:elb:policies", "Value": "20" }, { "OptionName": "ConnectionSettingIdleTimeout", "ResourceName": "AWSEBLoadBalancer", "Namespace": "aws:elb:policies", "Value": "60" } ], "DateUpdated": "2015-08-13T23:30:07Z", "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8" } ] } ``` Para obter mais informações sobre namespaces e opções compatíveis, consulte Valores das opções no *Guia do desenvolvedor do Elastic AWS Beanstalk*. + Para ver detalhes da API, consulte [DescribeConfigurationSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/describe-configuration-settings.html) na *Referência de comandos da AWS CLI*. ### `describe-environment-health` O código de exemplo a seguir mostra como usar `describe-environment-health`. **AWS CLI** **Visualizar a integridade do ambiente** O comando a seguir recupera informações gerais de integridade de um ambiente chamado `my-env`: ``` aws elasticbeanstalk describe-environment-health --environment-name my-env --attribute-names All ``` Resultado: ``` { "Status": "Ready", "EnvironmentName": "my-env", "Color": "Green", "ApplicationMetrics": { "Duration": 10, "Latency": { "P99": 0.004, "P75": 0.002, "P90": 0.003, "P95": 0.004, "P85": 0.003, "P10": 0.001, "P999": 0.004, "P50": 0.001 }, "RequestCount": 45, "StatusCodes": { "Status3xx": 0, "Status2xx": 45, "Status5xx": 0, "Status4xx": 0 } }, "RefreshedAt": "2015-08-20T21:09:18Z", "HealthStatus": "Ok", "InstancesHealth": { "Info": 0, "Ok": 1, "Unknown": 0, "Severe": 0, "Warning": 0, "Degraded": 0, "NoData": 0, "Pending": 0 }, "Causes": [] } ``` As informações de integridade só estão disponíveis para ambientes com relatórios de integridade aprimorados habilitados. Para obter informações adicionais, consulte Relatório e Monitoramento de Integridade Aprimorado no *Guia do desenvolvedor do Beanstalk da AWS*. + Para ver detalhes da API, consulte [DescribeEnvironmentHealth](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/describe-environment-health.html) na *Referência de comandos da AWS CLI*. ### `describe-environment-resources` O código de exemplo a seguir mostra como usar `describe-environment-resources`. **AWS CLI** **Visualizar informações sobre os recursos AWS em seu ambiente** O comando a seguir recupera informações sobre recursos em um ambiente chamado `my-env`: ``` aws elasticbeanstalk describe-environment-resources --environment-name my-env ``` Resultado: ``` { "EnvironmentResources": { "EnvironmentName": "my-env", "AutoScalingGroups": [ { "Name": "awseb-e-qu3fyyjyjs-stack-AWSEBAutoScalingGroup-QSB2ZO88SXZT" } ], "Triggers": [], "LoadBalancers": [ { "Name": "awseb-e-q-AWSEBLoa-1EEPZ0K98BIF0" } ], "Queues": [], "Instances": [ { "Id": "i-0c91c786" } ], "LaunchConfigurations": [ { "Name": "awseb-e-qu3fyyjyjs-stack-AWSEBAutoScalingLaunchConfiguration-1UUVQIBC96TQ2" } ] } } ``` + Para ver detalhes da API, consulte [DescribeEnvironmentResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/describe-environment-resources.html) na *Referência de comandos da AWS CLI*. ### `describe-environments` O código de exemplo a seguir mostra como usar `describe-environments`. **AWS CLI** **Visualizar informações sobre um ambiente** O comando a seguir recupera informações sobre um ambiente chamado `my-env`: ``` aws elasticbeanstalk describe-environments --environment-names my-env ``` Resultado: ``` { "Environments": [ { "ApplicationName": "my-app", "EnvironmentName": "my-env", "VersionLabel": "7f58-stage-150812_025409", "Status": "Ready", "EnvironmentId": "e-rpqsewtp2j", "EndpointURL": "awseb-e-w-AWSEBLoa-1483140XB0Q4L-109QXY8121.us-west-2.elb.amazonaws.com", "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", "CNAME": "my-env.elasticbeanstalk.com", "Health": "Green", "AbortableOperationInProgress": false, "Tier": { "Version": " ", "Type": "Standard", "Name": "WebServer" }, "DateUpdated": "2015-08-12T18:16:55.019Z", "DateCreated": "2015-08-07T20:48:49.599Z" } ] } ``` + Para ver detalhes da API, consulte [DescribeEnvironments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/describe-environments.html) na *Referência de comandos da AWS CLI*. ### `describe-events` O código de exemplo a seguir mostra como usar `describe-events`. **AWS CLI** **Visualizar eventos de um ambiente** O comando a seguir recupera eventos sobre um ambiente chamado `my-env`: ``` aws elasticbeanstalk describe-events --environment-name my-env ``` Resultado (abreviado): ``` { "Events": [ { "ApplicationName": "my-app", "EnvironmentName": "my-env", "Message": "Environment health has transitioned from Info to Ok.", "EventDate": "2015-08-20T07:06:53.535Z", "Severity": "INFO" }, { "ApplicationName": "my-app", "EnvironmentName": "my-env", "Severity": "INFO", "RequestId": "b7f3960b-4709-11e5-ba1e-07e16200da41", "Message": "Environment update completed successfully.", "EventDate": "2015-08-20T07:06:02.049Z" }, ... { "ApplicationName": "my-app", "EnvironmentName": "my-env", "Severity": "INFO", "RequestId": "ca8dfbf6-41ef-11e5-988b-651aa638f46b", "Message": "Using elasticbeanstalk-us-west-2-012445113685 as Amazon S3 storage bucket for environment data.", "EventDate": "2015-08-13T19:16:27.561Z" }, { "ApplicationName": "my-app", "EnvironmentName": "my-env", "Severity": "INFO", "RequestId": "cdfba8f6-41ef-11e5-988b-65638f41aa6b", "Message": "createEnvironment is starting.", "EventDate": "2015-08-13T19:16:26.581Z" } ] } ``` + Para ver detalhes da API, consulte [DescribeEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/describe-events.html) na *Referência de comandos da AWS CLI*. ### `describe-instances-health` O código de exemplo a seguir mostra como usar `describe-instances-health`. **AWS CLI** **Visualizar a integridade do ambiente** O comando a seguir recupera informações de integridade para instâncias em um ambiente chamado `my-env`: ``` aws elasticbeanstalk describe-instances-health --environment-name my-env --attribute-names All ``` Resultado: ``` { "InstanceHealthList": [ { "InstanceId": "i-08691cc7", "ApplicationMetrics": { "Duration": 10, "Latency": { "P99": 0.006, "P75": 0.002, "P90": 0.004, "P95": 0.005, "P85": 0.003, "P10": 0.0, "P999": 0.006, "P50": 0.001 }, "RequestCount": 48, "StatusCodes": { "Status3xx": 0, "Status2xx": 47, "Status5xx": 0, "Status4xx": 1 } }, "System": { "LoadAverage": [ 0.0, 0.02, 0.05 ], "CPUUtilization": { "SoftIRQ": 0.1, "IOWait": 0.2, "System": 0.3, "Idle": 97.8, "User": 1.5, "IRQ": 0.0, "Nice": 0.1 } }, "Color": "Green", "HealthStatus": "Ok", "LaunchedAt": "2015-08-13T19:17:09Z", "Causes": [] } ], "RefreshedAt": "2015-08-20T21:09:08Z" } ``` As informações de integridade só estão disponíveis para ambientes com relatórios de integridade aprimorados habilitados. Para obter informações adicionais, consulte Relatório e Monitoramento de Integridade Aprimorado no *Guia do desenvolvedor do Beanstalk da AWS*. + Para ver detalhes da API, consulte [DescribeInstancesHealth](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/describe-instances-health.html) na *Referência de comandos da AWS CLI*. ### `list-available-solution-stacks` O código de exemplo a seguir mostra como usar `list-available-solution-stacks`. **AWS CLI** **Visualizar as pilhas de soluções** O comando a seguir lista as pilhas de soluções para todas as configurações de plataforma disponíveis atualmente e todas as que você usou no passado: ``` aws elasticbeanstalk list-available-solution-stacks ``` Resultado (abreviado): ``` { "SolutionStacks": [ "64bit Amazon Linux 2015.03 v2.0.0 running Node.js", "64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.6", "64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.5", "64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.4", "64bit Amazon Linux 2015.03 v2.0.0 running Python 3.4", "64bit Amazon Linux 2015.03 v2.0.0 running Python 2.7", "64bit Amazon Linux 2015.03 v2.0.0 running Python", "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.2 (Puma)", "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.2 (Passenger Standalone)", "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.1 (Puma)", "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.1 (Passenger Standalone)", "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.0 (Puma)", "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.0 (Passenger Standalone)", "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 1.9.3", "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 7 Java 7", "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 7 Java 6", "64bit Windows Server Core 2012 R2 running IIS 8.5", "64bit Windows Server 2012 R2 running IIS 8.5", "64bit Windows Server 2012 running IIS 8", "64bit Windows Server 2008 R2 running IIS 7.5", "64bit Amazon Linux 2015.03 v2.0.0 running Docker 1.6.2", "64bit Amazon Linux 2015.03 v2.0.0 running Multi-container Docker 1.6.2 (Generic)", "64bit Debian jessie v2.0.0 running GlassFish 4.1 Java 8 (Preconfigured - Docker)", "64bit Debian jessie v2.0.0 running GlassFish 4.0 Java 7 (Preconfigured - Docker)", "64bit Debian jessie v2.0.0 running Go 1.4 (Preconfigured - Docker)", "64bit Debian jessie v2.0.0 running Go 1.3 (Preconfigured - Docker)", "64bit Debian jessie v2.0.0 running Python 3.4 (Preconfigured - Docker)", ], "SolutionStackDetails": [ { "PermittedFileTypes": [ "zip" ], "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Node.js" }, ... ] } ``` + Para ver detalhes da API, consulte [ListAvailableSolutionStacks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/list-available-solution-stacks.html) na *Referência de comandos da AWS CLI*. ### `rebuild-environment` O código de exemplo a seguir mostra como usar `rebuild-environment`. **AWS CLI** **Reconstruir um ambiente** O comando a seguir encerra e recria os recursos em um ambiente chamado `my-env`: ``` aws elasticbeanstalk rebuild-environment --environment-name my-env ``` + Para ver detalhes da API, consulte [RebuildEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/rebuild-environment.html) na *Referência de comandos da AWS CLI*. ### `request-environment-info` O código de exemplo a seguir mostra como usar `request-environment-info`. **AWS CLI** **Solicitar logs com falha** O comando a seguir solicita logs de um ambiente chamado `my-env`: ``` aws elasticbeanstalk request-environment-info --environment-name my-env --info-type tail ``` Depois de solicitar os logs, recupere a localização deles com retrieve-environment-info. + Para ver detalhes da API, consulte [RequestEnvironmentInfo](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/request-environment-info.html) na *Referência de comandos da AWS CLI*. ### `restart-app-server` O código de exemplo a seguir mostra como usar `restart-app-server`. **AWS CLI** **Reiniciar os servidores de aplicações** O comando a seguir reinicia os servidores de aplicações em todas as instâncias em um ambiente chamado `my-env`: ``` aws elasticbeanstalk restart-app-server --environment-name my-env ``` + Para ver detalhes da API, consulte [RestartAppServer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/restart-app-server.html) na *Referência de comandos da AWS CLI*. ### `retrieve-environment-info` O código de exemplo a seguir mostra como usar `retrieve-environment-info`. **AWS CLI** **Recuperar logs com falha** O comando a seguir recupera um link para logs de um ambiente chamado `my-env`: ``` aws elasticbeanstalk retrieve-environment-info --environment-name my-env --info-type tail ``` Resultado: ``` { "EnvironmentInfo": [ { "SampleTimestamp": "2015-08-20T22:23:17.703Z", "Message": "https://elasticbeanstalk-us-west-2-0123456789012.s3.amazonaws.com/resources/environments/logs/tail/e-fyqyju3yjs/i-09c1c867/TailLogs-1440109397703.out?AWSAccessKeyId=AKGPT4J56IAJ2EUBL5CQ&Expires=1440195891&Signature=n%2BEalOV6A2HIOx4Rcfb7LT16bBM%3D", "InfoType": "tail", "Ec2InstanceId": "i-09c1c867" } ] } ``` Visualizar o link em um navegador. Antes da recuperação, os logs devem ser solicitados com request-environment-info. + Para ver detalhes da API, consulte [RetrieveEnvironmentInfo](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/retrieve-environment-info.html) na *Referência de comandos da AWS CLI*. ### `swap-environment-cnames` O código de exemplo a seguir mostra como usar `swap-environment-cnames`. **AWS CLI** **Alternar entre CNAMEs de ambientes** O comando a seguir alterna os subdomínios atribuídos de dois ambientes: ``` aws elasticbeanstalk swap-environment-cnames --source-environment-name my-env-blue --destination-environment-name my-env-green ``` + Para ver detalhes da API, consulte [SwapEnvironmentCnames](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/swap-environment-cnames.html) na *Referência de comandos da AWS CLI*. ### `terminate-environment` O código de exemplo a seguir mostra como usar `terminate-environment`. **AWS CLI** **Encerrar um ambiente** O comando a seguir encerra um ambiente do Elastic Beanstalk chamado `my-env`: ``` aws elasticbeanstalk terminate-environment --environment-name my-env ``` Resultado: ``` { "ApplicationName": "my-app", "EnvironmentName": "my-env", "Status": "Terminating", "EnvironmentId": "e-fh2eravpns", "EndpointURL": "awseb-e-f-AWSEBLoa-1I9XUMP4-8492WNUP202574.us-west-2.elb.amazonaws.com", "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", "CNAME": "my-env.elasticbeanstalk.com", "Health": "Grey", "AbortableOperationInProgress": false, "Tier": { "Version": " ", "Type": "Standard", "Name": "WebServer" }, "DateUpdated": "2015-08-12T19:05:54.744Z", "DateCreated": "2015-08-12T18:52:53.622Z" } ``` + Para ver detalhes da API, consulte [TerminateEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/terminate-environment.html) na *Referência de comandos da AWS CLI*. ### `update-application-version` O código de exemplo a seguir mostra como usar `update-application-version`. **AWS CLI** **Alterar a descrição de uma versão da aplicação** O comando a seguir atualiza a descrição de uma versão da aplicação chamada `22a0-stage-150819_185942`: ``` aws elasticbeanstalk update-application-version --version-label 22a0-stage-150819_185942 --application-name my-app --description "new description" ``` Resultado: ``` { "ApplicationVersion": { "ApplicationName": "my-app", "VersionLabel": "22a0-stage-150819_185942", "Description": "new description", "DateCreated": "2015-08-19T18:59:17.646Z", "DateUpdated": "2015-08-20T22:53:28.871Z", "SourceBundle": { "S3Bucket": "elasticbeanstalk-us-west-2-0123456789012", "S3Key": "my-app/22a0-stage-150819_185942.war" } } } ``` + Para ver detalhes da API, consulte [UpdateApplicationVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/update-application-version.html) na *Referência de comandos da AWS CLI*. ### `update-application` O código de exemplo a seguir mostra como usar `update-application`. **AWS CLI** **Alterar a descrição de uma aplicação** O comando a seguir atualiza a descrição de uma aplicação chamada `my-app`: ``` aws elasticbeanstalk update-application --application-name my-app --description "my Elastic Beanstalk application" ``` Resultado: ``` { "Application": { "ApplicationName": "my-app", "Description": "my Elastic Beanstalk application", "Versions": [ "2fba-stage-150819_234450", "bf07-stage-150820_214945", "93f8", "fd7c-stage-150820_000431", "22a0-stage-150819_185942" ], "DateCreated": "2015-08-13T19:15:50.449Z", "ConfigurationTemplates": [], "DateUpdated": "2015-08-20T22:34:56.195Z" } } ``` + Para ver detalhes da API, consulte [UpdateApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/update-application.html) na *Referência de comandos da AWS CLI*. ### `update-configuration-template` O código de exemplo a seguir mostra como usar `update-configuration-template`. **AWS CLI** **Atualizar um modelo de configuração** O comando a seguir remove a configuração das métricas de integridade personalizadas do CloudWatch `ConfigDocument` configurada de um modelo de configuração salvo chamado `my-template`: ``` aws elasticbeanstalk update-configuration-template --template-name my-template --application-name my-app --options-to-remove Namespace=aws:elasticbeanstalk:healthreporting:system,OptionName=ConfigDocument ``` Resultado: ``` { "ApplicationName": "my-app", "TemplateName": "my-template", "DateCreated": "2015-08-20T22:39:31Z", "DateUpdated": "2015-08-20T22:43:11Z", "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8" } ``` Para obter mais informações sobre namespaces e opções compatíveis, consulte Valores das opções no *Guia do desenvolvedor do Elastic AWS Beanstalk*. + Para ver detalhes da API, consulte [UpdateConfigurationTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/update-configuration-template.html) na *Referência de comandos da AWS CLI*. ### `update-environment` O código de exemplo a seguir mostra como usar `update-environment`. **AWS CLI** **Atualizar um ambiente para uma nova versão** O comando a seguir atualiza um ambiente chamado “my-env” para a versão “v2" da aplicação à qual ele pertence: ``` aws elasticbeanstalk update-environment --environment-name my-env --version-label v2 ``` Esse comando exige que o ambiente “my-env” já exista e pertença a uma aplicação que tenha uma versão válida da aplicação com o rótulo “v2". Resultado: ``` { "ApplicationName": "my-app", "EnvironmentName": "my-env", "VersionLabel": "v2", "Status": "Updating", "EnvironmentId": "e-szqipays4h", "EndpointURL": "awseb-e-i-AWSEBLoa-1RDLX6TC9VUAO-0123456789.us-west-2.elb.amazonaws.com", "SolutionStackName": "64bit Amazon Linux running Tomcat 7", "CNAME": "my-env.elasticbeanstalk.com", "Health": "Grey", "Tier": { "Version": " ", "Type": "Standard", "Name": "WebServer" }, "DateUpdated": "2015-02-03T23:12:29.119Z", "DateCreated": "2015-02-03T23:04:54.453Z" } ``` **Definir uma variável de ambiente** O comando a seguir define o valor da variável “PARAM1" no ambiente “my-env” como “ParamValue”: ``` aws elasticbeanstalk update-environment --environment-name my-env --option-settings Namespace=aws:elasticbeanstalk:application:environment,OptionName=PARAM1,Value=ParamValue ``` O parâmetro `option-settings` usa um namespace além do nome e do valor da variável. O Elastic Beanstalk oferece suporte a vários namespaces para opções, além de variáveis de ambiente. **Definir as configurações de opção a partir de um arquivo** O comando a seguir configura várias opções no espaço de nome `aws:elb:loadbalancer` a partir de um arquivo: ``` aws elasticbeanstalk update-environment --environment-name my-env --option-settings file://options.json ``` `options.json` é um objeto JSON que define várias configurações: ``` [ { "Namespace": "aws:elb:healthcheck", "OptionName": "Interval", "Value": "15" }, { "Namespace": "aws:elb:healthcheck", "OptionName": "Timeout", "Value": "8" }, { "Namespace": "aws:elb:healthcheck", "OptionName": "HealthyThreshold", "Value": "2" }, { "Namespace": "aws:elb:healthcheck", "OptionName": "UnhealthyThreshold", "Value": "3" } ] ``` Resultado: ``` { "ApplicationName": "my-app", "EnvironmentName": "my-env", "VersionLabel": "7f58-stage-150812_025409", "Status": "Updating", "EnvironmentId": "e-wtp2rpqsej", "EndpointURL": "awseb-e-w-AWSEBLoa-14XB83101Q4L-104QXY80921.sa-east-1.elb.amazonaws.com", "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", "CNAME": "my-env.elasticbeanstalk.com", "Health": "Grey", "AbortableOperationInProgress": true, "Tier": { "Version": " ", "Type": "Standard", "Name": "WebServer" }, "DateUpdated": "2015-08-12T18:15:23.804Z", "DateCreated": "2015-08-07T20:48:49.599Z" } ``` Para obter mais informações sobre namespaces e opções compatíveis, consulte Valores das opções no *Guia do desenvolvedor do Elastic AWS Beanstalk*. + Para ver detalhes da API, consulte [UpdateEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/update-environment.html) na *Referência de comandos da AWS CLI*. ### `validate-configuration-settings` O código de exemplo a seguir mostra como usar `validate-configuration-settings`. **AWS CLI** **Validar as definições de configurações** O comando a seguir valida um documento de configuração de métricas personalizadas do CloudWatch: ``` aws elasticbeanstalk validate-configuration-settings --application-name my-app --environment-name my-env --option-settings file://options.json ``` `options.json` é um documento JSON que inclui uma ou mais configurações para validar: ``` [ { "Namespace": "aws:elasticbeanstalk:healthreporting:system", "OptionName": "ConfigDocument", "Value": "{\"CloudWatchMetrics\": {\"Environment\": {\"ApplicationLatencyP99.9\": null,\"InstancesSevere\": 60,\"ApplicationLatencyP90\": 60,\"ApplicationLatencyP99\": null,\"ApplicationLatencyP95\": 60,\"InstancesUnknown\": 60,\"ApplicationLatencyP85\": 60,\"InstancesInfo\": null,\"ApplicationRequests2xx\": null,\"InstancesDegraded\": null,\"InstancesWarning\": 60,\"ApplicationLatencyP50\": 60,\"ApplicationRequestsTotal\": null,\"InstancesNoData\": null,\"InstancesPending\": 60,\"ApplicationLatencyP10\": null,\"ApplicationRequests5xx\": null,\"ApplicationLatencyP75\": null,\"InstancesOk\": 60,\"ApplicationRequests3xx\": null,\"ApplicationRequests4xx\": null},\"Instance\": {\"ApplicationLatencyP99.9\": null,\"ApplicationLatencyP90\": 60,\"ApplicationLatencyP99\": null,\"ApplicationLatencyP95\": null,\"ApplicationLatencyP85\": null,\"CPUUser\": 60,\"ApplicationRequests2xx\": null,\"CPUIdle\": null,\"ApplicationLatencyP50\": null,\"ApplicationRequestsTotal\": 60,\"RootFilesystemUtil\": null,\"LoadAverage1min\": null,\"CPUIrq\": null,\"CPUNice\": 60,\"CPUIowait\": 60,\"ApplicationLatencyP10\": null,\"LoadAverage5min\": null,\"ApplicationRequests5xx\": null,\"ApplicationLatencyP75\": 60,\"CPUSystem\": 60,\"ApplicationRequests3xx\": 60,\"ApplicationRequests4xx\": null,\"InstanceHealth\": null,\"CPUSoftirq\": 60}},\"Version\": 1}" } ] ``` Se as opções que você especificar forem válidas para o ambiente especificado, o Elastic Beanstalk retornará uma matriz de mensagens vazia: ``` { "Messages": [] } ``` Se a validação falhar, a resposta incluirá informações sobre o erro: ``` { "Messages": [ { "OptionName": "ConfigDocumet", "Message": "Invalid option specification (Namespace: 'aws:elasticbeanstalk:healthreporting:system', OptionName: 'ConfigDocumet'): Unknown configuration setting.", "Namespace": "aws:elasticbeanstalk:healthreporting:system", "Severity": "error" } ] } ``` Para obter mais informações sobre namespaces e opções compatíveis, consulte Valores das opções no *Guia do desenvolvedor do Elastic AWS Beanstalk*. + Para ver detalhes da API, consulte [ValidateConfigurationSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/validate-configuration-settings.html) na *Referência de comandos da AWS CLI*. # Exemplos do Elastic Load Balancing Versão 1 usando o AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface 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-tags` O código de exemplo a seguir mostra como usar `add-tags`. **AWS CLI** **Adicionar uma tag ao balanceador de carga** Este exemplo adiciona tags ao balanceador de carga especificado. Comando: ``` aws elb add-tags --load-balancer-name my-load-balancer --tags "Key=project,Value=lima" "Key=department,Value=digital-media" ``` + Para ver detalhes da API, consulte [AddTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/add-tags.html) na *Referência de comandos da AWS CLI*. ### `apply-security-groups-to-load-balancer` O código de exemplo a seguir mostra como usar `apply-security-groups-to-load-balancer`. **AWS CLI** **Associar um grupo de segurança a um balanceador de carga em uma VPC** Este exemplo associa um grupo de segurança ao balanceador de carga especificado em uma VPC. Comando: ``` aws elb apply-security-groups-to-load-balancer --load-balancer-name my-load-balancer --security-groups sg-fc448899 ``` Resultado: ``` { "SecurityGroups": [ "sg-fc448899" ] } ``` + Para ver detalhes da API, consulte [ApplySecurityGroupsToLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/apply-security-groups-to-load-balancer.html) na *Referência de comandos da AWS CLI*. ### `attach-load-balancer-to-subnets` O código de exemplo a seguir mostra como usar `attach-load-balancer-to-subnets`. **AWS CLI** **Anexar sub-redes a um balanceador de carga** Este exemplo adiciona a sub-rede especificada ao conjunto de sub-redes configuradas para o balanceador de carga especificado. Comando: ``` aws elb attach-load-balancer-to-subnets --load-balancer-name my-load-balancer --subnets subnet-0ecac448 ``` Resultado: ``` { "Subnets": [ "subnet-15aaab61", "subnet-0ecac448" ] } ``` + Para ver detalhes da API, consulte [AttachLoadBalancerToSubnets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/attach-load-balancer-to-subnets.html) na *Referência de comandos da AWS CLI*. ### `configure-health-check` O código de exemplo a seguir mostra como usar `configure-health-check`. **AWS CLI** **Especificar as configurações de verificação de integridade para suas instâncias EC2 de backend** Este exemplo especifica as configurações de verificação de integridade usadas para avaliar a integridade de suas instâncias de backend do EC2. Comando: ``` aws elb configure-health-check --load-balancer-name my-load-balancer --health-check Target=HTTP:80/png,Interval=30,UnhealthyThreshold=2,HealthyThreshold=2,Timeout=3 ``` Resultado: ``` { "HealthCheck": { "HealthyThreshold": 2, "Interval": 30, "Target": "HTTP:80/png", "Timeout": 3, "UnhealthyThreshold": 2 } } ``` + Para ver detalhes da API, consulte [ConfigureHealthCheck](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/configure-health-check.html) na *Referência de comandos da AWS CLI*. ### `create-app-cookie-stickiness-policy` O código de exemplo a seguir mostra como usar `create-app-cookie-stickiness-policy`. **AWS CLI** **Gerar uma política de aderência para seu balanceador de carga HTTPS** Este exemplo gera uma políticas de aderência com os tempos de vida de sessão persistente que seguem as políticas de um cookie gerado pela aplicação. Comando: ``` aws elb create-app-cookie-stickiness-policy --load-balancer-name my-load-balancer --policy-name my-app-cookie-policy --cookie-name my-app-cookie ``` + Para ver detalhes da API, consulte [CreateAppCookieStickinessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/create-app-cookie-stickiness-policy.html) na *Referência de comandos da AWS CLI*. ### `create-lb-cookie-stickiness-policy` O código de exemplo a seguir mostra como usar `create-lb-cookie-stickiness-policy`. **AWS CLI** **Gerar uma política de aderência baseada em duração para seu balanceador de carga HTTPS** Este exemplo gera uma política de aderência com tempos de vida de sessão persistente controlados por um período de expiração especificado. Comando: ``` aws elb create-lb-cookie-stickiness-policy --load-balancer-name my-load-balancer --policy-name my-duration-cookie-policy --cookie-expiration-period 60 ``` + Para ver detalhes da API, consulte [CreateLbCookieStickinessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/create-lb-cookie-stickiness-policy.html) na *Referência de comandos da AWS CLI*. ### `create-load-balancer-listeners` O código de exemplo a seguir mostra como usar `create-load-balancer-listeners`. **AWS CLI** **Criar receptores HTTP para um balanceador de carga** Este exemplo cria um receptor para seu balanceador de carga na porta 80 usando o protocolo HTTP. Comando: ``` aws elb create-load-balancer-listeners --load-balancer-name my-load-balancer --listeners "Protocol=HTTP,LoadBalancerPort=80,InstanceProtocol=HTTP,InstancePort=80" ``` **Criar receptores HTTPS para um balanceador de carga** Este exemplo cria um receptor para seu balanceador de carga na porta 443 usando o protocolo HTTPS. Comando: ``` aws elb create-load-balancer-listeners --load-balancer-name my-load-balancer --listeners "Protocol=HTTPS,LoadBalancerPort=443,InstanceProtocol=HTTP,InstancePort=80" ``` + Para ver detalhes da API, consulte [CreateLoadBalancerListeners](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/create-load-balancer-listeners.html) na *Referência de comandos da AWS CLI*. ### `create-load-balancer-policy` O código de exemplo a seguir mostra como usar `create-load-balancer-policy`. **AWS CLI** **Criar uma política que habilite o Protocolo de Proxy em um balanceador de carga** Este exemplo cria uma política que habilita o Protocolo de Proxy em um balanceador de carga especificado. Comando: ``` aws elb create-load-balancer-policy --load-balancer-name my-load-balancer --policy-name my-ProxyProtocol-policy --policy-type-name ProxyProtocolPolicyType --policy-attributes AttributeName=ProxyProtocol,AttributeValue=true ``` **Criar uma política de negociação SSL usando a política de segurança recomendada** Este exemplo cria uma política de negociação SSL para o balanceador de carga HTTPS especificado usando a política de segurança recomendada. Comando: ``` aws elb create-load-balancer-policy --load-balancer-name my-load-balancer --policy-name my-SSLNegotiation-policy --policy-type-name SSLNegotiationPolicyType --policy-attributes AttributeName=Reference-Security-Policy,AttributeValue=ELBSecurityPolicy-2015-03 ``` **Criar uma política de negociação SSL usando uma política de segurança personalizada** Este exemplo cria uma política de negociação SSL para seu balanceador de carga HTTPS usando uma política de segurança personalizada, ativando os protocolos e as cifras. Comando: ``` aws elb create-load-balancer-policy --load-balancer-name my-load-balancer --policy-name my-SSLNegotiation-policy --policy-type-name SSLNegotiationPolicyType --policy-attributes AttributeName=Protocol-SSLv3,AttributeValue=true AttributeName=Protocol-TLSv1.1,AttributeValue=true AttributeName=DHE-RSA-AES256-SHA256,AttributeValue=true AttributeName=Server-Defined-Cipher-Order,AttributeValue=true ``` **Criar uma política de chave pública** Este exemplo cria uma política de chave pública. Comando: ``` aws elb create-load-balancer-policy --load-balancer-name my-load-balancer --policy-name my-PublicKey-policy --policy-type-name PublicKeyPolicyType --policy-attributes AttributeName=PublicKey,AttributeValue=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwAYUjnfyEyXr1pxjhFWBpMlggUcqoi3kl+dS74kj//c6x7ROtusUaeQCTgIUkayttRDWchuqo1pHC1u+n5xxXnBBe2ejbb2WRsKIQ5rXEeixsjFpFsojpSQKkzhVGI6mJVZBJDVKSHmswnwLBdofLhzvllpovBPTHe+o4haAWvDBALJU0pkSI1FecPHcs2hwxf14zHoXy1e2k36A64nXW43wtfx5qcVSIxtCEOjnYRg7RPvybaGfQ+v6Iaxb/+7J5kEvZhTFQId+bSiJImF1FSUT1W1xwzBZPUbcUkkXDj45vC2s3Z8E+Lk7a3uZhvsQHLZnrfuWjBWGWvZ/MhZYgEXAMPLE ``` **Criar uma política de autenticação de servidor de backend** Este exemplo cria uma política de autenticação de servidor de backend que permite a autenticação em sua instância de backend usando uma política de chave pública. Comando: ``` aws elb create-load-balancer-policy --load-balancer-name my-load-balancer --policy-name my-authentication-policy --policy-type-name BackendServerAuthenticationPolicyType --policy-attributes AttributeName=PublicKeyPolicyName,AttributeValue=my-PublicKey-policy ``` + Para ver detalhes da API, consulte [CreateLoadBalancerPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/create-load-balancer-policy.html) na *Referência de comandos da AWS CLI*. ### `create-load-balancer` O código de exemplo a seguir mostra como usar `create-load-balancer`. **AWS CLI** **Criar um balanceador de carga HTTP** Este exemplo cria um balanceador de carga com um receptor HTTP em uma VPC. Comando: ``` aws elb create-load-balancer --load-balancer-name my-load-balancer --listeners "Protocol=HTTP,LoadBalancerPort=80,InstanceProtocol=HTTP,InstancePort=80" --subnets subnet-15aaab61 --security-groups sg-a61988c3 ``` Resultado: ``` { "DNSName": "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com" } ``` Este exemplo cria um balanceador de carga com um receptor HTTP no EC2-Classic. Comando: ``` aws elb create-load-balancer --load-balancer-name my-load-balancer --listeners "Protocol=HTTP,LoadBalancerPort=80,InstanceProtocol=HTTP,InstancePort=80" --availability-zones us-west-2a us-west-2b ``` Resultado: ``` { "DNSName": "my-load-balancer-123456789.us-west-2.elb.amazonaws.com" } ``` **Criar um balanceador de carga HTTPS** Este exemplo cria um balanceador de carga com um receptor HTTPS em uma VPC. Comando: ``` aws elb create-load-balancer --load-balancer-name my-load-balancer --listeners "Protocol=HTTP,LoadBalancerPort=80,InstanceProtocol=HTTP,InstancePort=80" "Protocol=HTTPS,LoadBalancerPort=443,InstanceProtocol=HTTP,InstancePort=80,SSLCertificateId=arn:aws:iam::123456789012:server-certificate/my-server-cert" --subnets subnet-15aaab61 --security-groups sg-a61988c3 ``` Resultado: ``` { "DNSName": "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com" } ``` Este exemplo cria um balanceador de carga com um receptor HTTPS no EC2-Classic. Comando: ``` aws elb create-load-balancer --load-balancer-name my-load-balancer --listeners "Protocol=HTTP,LoadBalancerPort=80,InstanceProtocol=HTTP,InstancePort=80" "Protocol=HTTPS,LoadBalancerPort=443,InstanceProtocol=HTTP,InstancePort=80,SSLCertificateId=arn:aws:iam::123456789012:server-certificate/my-server-cert" --availability-zones us-west-2a us-west-2b ``` Resultado: ``` { "DNSName": "my-load-balancer-123456789.us-west-2.elb.amazonaws.com" } ``` **Criar um balanceador de carga interno** Este exemplo cria um balanceador de carga interno com um receptor HTTP em uma VPC. Comando: ``` aws elb create-load-balancer --load-balancer-name my-load-balancer --listeners "Protocol=HTTP,LoadBalancerPort=80,InstanceProtocol=HTTP,InstancePort=80" --scheme internal --subnets subnet-a85db0df --security-groups sg-a61988c3 ``` Resultado: ``` { "DNSName": "internal-my-load-balancer-123456789.us-west-2.elb.amazonaws.com" } ``` + Consulte detalhes da API em [CreateLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/create-load-balancer.html) na *Referência de comandos da AWS CLI*. ### `delete-load-balancer-listeners` O código de exemplo a seguir mostra como usar `delete-load-balancer-listeners`. **AWS CLI** **Excluir um receptor do balanceador de carga** Este exemplo exclui o receptor da porta especificada do balanceador de carga especificado. Comando: ``` aws elb delete-load-balancer-listeners --load-balancer-name my-load-balancer --load-balancer-ports 80 ``` + Para ver detalhes da API, consulte [DeleteLoadBalancerListeners](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/delete-load-balancer-listeners.html) na *Referência de comandos da AWS CLI*. ### `delete-load-balancer-policy` O código de exemplo a seguir mostra como usar `delete-load-balancer-policy`. **AWS CLI** **Excluir uma política do seu balanceador de carga** Este exemplo exclui a política especificada do balanceador de carga especificado. A política não deve ser habilitada em qualquer receptor. Comando: ``` aws elb delete-load-balancer-policy --load-balancer-name my-load-balancer --policy-name my-duration-cookie-policy ``` + Para ver detalhes da API, consulte [DeleteLoadBalancerPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/delete-load-balancer-policy.html) na *Referência de comandos da AWS CLI*. ### `delete-load-balancer` O código de exemplo a seguir mostra como usar `delete-load-balancer`. **AWS CLI** **Como excluir um balanceador de carga** Este exemplo exclui o balanceador de carga especificado. Comando: ``` aws elb delete-load-balancer --load-balancer-name my-load-balancer ``` + Consulte detalhes da API em [DeleteLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/delete-load-balancer.html) na *Referência de comandos da AWS CLI*. ### `deregister-instances-from-load-balancer` O código de exemplo a seguir mostra como usar `deregister-instances-from-load-balancer`. **AWS CLI** **Cancelar o registro de instâncias do balanceador de carga** Este exemplo cancela o registro das instâncias especificadas do balanceador de carga especificado. Comando: ``` aws elb deregister-instances-from-load-balancer --load-balancer-name my-load-balancer --instances i-d6f6fae3 ``` Resultado: ``` { "Instances": [ { "InstanceId": "i-207d9717" }, { "InstanceId": "i-afefb49b" } ] } ``` + Para ver detalhes da API, consulte [DeregisterInstancesFromLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/deregister-instances-from-load-balancer.html) na *Referência de comandos da AWS CLI*. ### `describe-account-limits` O código de exemplo a seguir mostra como usar `describe-account-limits`. **AWS CLI** **Descrever os limites do Classic Load Balancer** O exemplo `describe-account-limits` a seguir exibe detalhes sobre os limites do Classic Load Balancer para sua conta da AWS. ``` aws elb describe-account-limits ``` Resultado: ``` { "Limits": [ { "Name": "classic-load-balancers", "Max": "20" }, { "Name": "classic-listeners", "Max": "100" }, { "Name": "classic-registered-instances", "Max": "1000" } ] } ``` + Para ver detalhes da API, consulte [DescribeAccountLimits](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/describe-account-limits.html) na *Referência de comandos da AWS CLI*. ### `describe-instance-health` O código de exemplo a seguir mostra como usar `describe-instance-health`. **AWS CLI** **Descrever a integridade das instâncias de um balanceador de carga** Este exemplo descreve a integridade das instâncias do balanceador de carga especificado. Comando: ``` aws elb describe-instance-health --load-balancer-name my-load-balancer ``` Resultado: ``` { "InstanceStates": [ { "InstanceId": "i-207d9717", "ReasonCode": "N/A", "State": "InService", "Description": "N/A" }, { "InstanceId": "i-afefb49b", "ReasonCode": "N/A", "State": "InService", "Description": "N/A" } ] } ``` **Descrever a integridade de uma instância para um balanceador de carga** Este exemplo descreve a integridade da instância especificada para o balanceador de carga especificado. Comando: ``` aws elb describe-instance-health --load-balancer-name my-load-balancer --instances i-7299c809 ``` Veja a seguir um exemplo de resposta para uma instância que está sendo registrada. Resultado: ``` { "InstanceStates": [ { "InstanceId": "i-7299c809", "ReasonCode": "ELB", "State": "OutOfService", "Description": "Instance registration is still in progress." } ] } ``` Veja a seguir um exemplo de resposta para uma instância que não está íntegra. Resultado: ``` { "InstanceStates": [ { "InstanceId": "i-7299c809", "ReasonCode": "Instance", "State": "OutOfService", "Description": "Instance has failed at least the UnhealthyThreshold number of health checks consecutively." } ] } ``` + Para ver detalhes da API, consulte [DescribeInstanceHealth](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/describe-instance-health.html) na *Referência de comandos da AWS CLI*. ### `describe-load-balancer-attributes` O código de exemplo a seguir mostra como usar `describe-load-balancer-attributes`. **AWS CLI** **Descrever os atributos de um balanceador de carga** Este exemplo descreve os atributos do balanceador de carga especificado. Comando: ``` aws elb describe-load-balancer-attributes --load-balancer-name my-load-balancer ``` Resultado: ``` { "LoadBalancerAttributes": { "ConnectionDraining": { "Enabled": false, "Timeout": 300 }, "CrossZoneLoadBalancing": { "Enabled": true }, "ConnectionSettings": { "IdleTimeout": 30 }, "AccessLog": { "Enabled": false } } } ``` + Para ver detalhes da API, consulte [DescribeLoadBalancerAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/describe-load-balancer-attributes.html) na *Referência de comandos da AWS CLI*. ### `describe-load-balancer-policies` O código de exemplo a seguir mostra como usar `describe-load-balancer-policies`. **AWS CLI** **Descrever todas as políticas associadas a um balanceador de carga** Este exemplo descreve todas as políticas associadas ao balanceador de carga especificado. Comando: ``` aws elb describe-load-balancer-policies --load-balancer-name my-load-balancer ``` Resultado: ``` { "PolicyDescriptions": [ { "PolicyAttributeDescriptions": [ { "AttributeName": "ProxyProtocol", "AttributeValue": "true" } ], "PolicyName": "my-ProxyProtocol-policy", "PolicyTypeName": "ProxyProtocolPolicyType" }, { "PolicyAttributeDescriptions": [ { "AttributeName": "CookieName", "AttributeValue": "my-app-cookie" } ], "PolicyName": "my-app-cookie-policy", "PolicyTypeName": "AppCookieStickinessPolicyType" }, { "PolicyAttributeDescriptions": [ { "AttributeName": "CookieExpirationPeriod", "AttributeValue": "60" } ], "PolicyName": "my-duration-cookie-policy", "PolicyTypeName": "LBCookieStickinessPolicyType" }, . . . ] } ``` **Descrever uma política específica associada a um balanceador de carga** Este exemplo descreve a política especificada associada ao balanceador de carga especificado. Comando: ``` aws elb describe-load-balancer-policies --load-balancer-name my-load-balancer --policy-name my-authentication-policy ``` Resultado: ``` { "PolicyDescriptions": [ { "PolicyAttributeDescriptions": [ { "AttributeName": "PublicKeyPolicyName", "AttributeValue": "my-PublicKey-policy" } ], "PolicyName": "my-authentication-policy", "PolicyTypeName": "BackendServerAuthenticationPolicyType" } ] } ``` + Para ver detalhes da API, consulte [DescribeLoadBalancerPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/describe-load-balancer-policies.html) na *Referência de comandos da AWS CLI*. ### `describe-load-balancer-policy-types` O código de exemplo a seguir mostra como usar `describe-load-balancer-policy-types`. **AWS CLI** **Descrever os tipos de políticas de balanceador de carga definidos pelo Elastic Load Balancing** Este exemplo descreve os tipos de política do balanceador de carga que você pode usar para criar configurações de política para seu balanceador de carga. Comando: ``` aws elb describe-load-balancer-policy-types ``` Resultado: ``` { "PolicyTypeDescriptions": [ { "PolicyAttributeTypeDescriptions": [ { "Cardinality": "ONE", "AttributeName": "ProxyProtocol", "AttributeType": "Boolean" } ], "PolicyTypeName": "ProxyProtocolPolicyType", "Description": "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" }, { "PolicyAttributeTypeDescriptions": [ { "Cardinality": "ONE", "AttributeName": "PublicKey", "AttributeType": "String" } ], "PolicyTypeName": "PublicKeyPolicyType", "Description": "Policy containing a list of public keys to accept when authenticating the back-end server(s). This policy cannot be applied directly to back-end servers or listeners but must be part of a BackendServerAuthenticationPolicyType." }, { "PolicyAttributeTypeDescriptions": [ { "Cardinality": "ONE", "AttributeName": "CookieName", "AttributeType": "String" } ], "PolicyTypeName": "AppCookieStickinessPolicyType", "Description": "Stickiness policy with session lifetimes controlled by the lifetime of the application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners." }, { "PolicyAttributeTypeDescriptions": [ { "Cardinality": "ZERO_OR_ONE", "AttributeName": "CookieExpirationPeriod", "AttributeType": "Long" } ], "PolicyTypeName": "LBCookieStickinessPolicyType", "Description": "Stickiness policy with session lifetimes controlled by the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners." }, { "PolicyAttributeTypeDescriptions": [ . . . ], "PolicyTypeName": "SSLNegotiationPolicyType", "Description": "Listener policy that defines the ciphers and protocols that will be accepted by the load balancer. This policy can be associated only with HTTPS/SSL listeners." }, { "PolicyAttributeTypeDescriptions": [ { "Cardinality": "ONE_OR_MORE", "AttributeName": "PublicKeyPolicyName", "AttributeType": "PolicyName" } ], "PolicyTypeName": "BackendServerAuthenticationPolicyType", "Description": "Policy that controls authentication to back-end server(s) and contains one or more policies, such as an instance of a PublicKeyPolicyType. This policy can be associated only with back-end servers that are using HTTPS/SSL." } ] } ``` + Para ver detalhes da API, consulte [DescribeLoadBalancerPolicyTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/describe-load-balancer-policy-types.html) na *Referência de comandos da AWS CLI*. ### `describe-load-balancers` O código de exemplo a seguir mostra como usar `describe-load-balancers`. **AWS CLI** **Descrever os balanceadores de carga** Este exemplo descreve todos os balanceadores de carga. Comando: ``` aws elb describe-load-balancers ``` **Descrever um dos balanceadores de carga** Este exemplo descreve o balanceador de carga especificado. Comando: ``` aws elb describe-load-balancers --load-balancer-name my-load-balancer ``` Veja a seguir um exemplo de resposta para um balanceador de carga HTTPS em uma VPC. Resultado: ``` { "LoadBalancerDescriptions": [ { "Subnets": [ "subnet-15aaab61" ], "CanonicalHostedZoneNameID": "Z3DZXE0EXAMPLE", "CanonicalHostedZoneName": "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com", "ListenerDescriptions": [ { "Listener": { "InstancePort": 80, "LoadBalancerPort": 80, "Protocol": "HTTP", "InstanceProtocol": "HTTP" }, "PolicyNames": [] }, { "Listener": { "InstancePort": 443, "SSLCertificateId": "arn:aws:iam::123456789012:server-certificate/my-server-cert", "LoadBalancerPort": 443, "Protocol": "HTTPS", "InstanceProtocol": "HTTPS" }, "PolicyNames": [ "ELBSecurityPolicy-2015-03" ] } ], "HealthCheck": { "HealthyThreshold": 2, "Interval": 30, "Target": "HTTP:80/png", "Timeout": 3, "UnhealthyThreshold": 2 }, "VPCId": "vpc-a01106c2", "BackendServerDescriptions": [ { "InstancePort": 80, "PolicyNames": [ "my-ProxyProtocol-policy" ] } ], "Instances": [ { "InstanceId": "i-207d9717" }, { "InstanceId": "i-afefb49b" } ], "DNSName": "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com", "SecurityGroups": [ "sg-a61988c3" ], "Policies": { "LBCookieStickinessPolicies": [ { "PolicyName": "my-duration-cookie-policy", "CookieExpirationPeriod": 60 } ], "AppCookieStickinessPolicies": [], "OtherPolicies": [ "my-PublicKey-policy", "my-authentication-policy", "my-SSLNegotiation-policy", "my-ProxyProtocol-policy", "ELBSecurityPolicy-2015-03" ] }, "LoadBalancerName": "my-load-balancer", "CreatedTime": "2015-03-19T03:24:02.650Z", "AvailabilityZones": [ "us-west-2a" ], "Scheme": "internet-facing", "SourceSecurityGroup": { "OwnerAlias": "123456789012", "GroupName": "my-elb-sg" } } ] } ``` + Consulte detalhes da API em [DescribeLoadBalancers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/describe-load-balancers.html) na *Referência de comandos AWS CLI*. ### `describe-tags` O código de exemplo a seguir mostra como usar `describe-tags`. **AWS CLI** **Descrever as tags atribuídas a um balanceador de carga** Este exemplo descreve as tags atribuídas ao balanceador de carga especificado. Comando: ``` aws elb describe-tags --load-balancer-name my-load-balancer ``` Resultado: ``` { "TagDescriptions": [ { "Tags": [ { "Value": "lima", "Key": "project" }, { "Value": "digital-media", "Key": "department" } ], "LoadBalancerName": "my-load-balancer" } ] } ``` + Para ver detalhes da API, consulte [DescribeTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/describe-tags.html) na *Referência de comandos da AWS CLI*. ### `detach-load-balancer-from-subnets` O código de exemplo a seguir mostra como usar `detach-load-balancer-from-subnets`. **AWS CLI** **Separar os balanceadores de carga das sub-redes** Este exemplo separa o balanceador de carga especificado da sub-rede especificada. Comando: ``` aws elb detach-load-balancer-from-subnets --load-balancer-name my-load-balancer --subnets subnet-0ecac448 ``` Resultado: ``` { "Subnets": [ "subnet-15aaab61" ] } ``` + Para ver detalhes da API, consulte [DetachLoadBalancerFromSubnets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/detach-load-balancer-from-subnets.html) na *Referência de comandos da AWS CLI*. ### `disable-availability-zones-for-load-balancer` O código de exemplo a seguir mostra como usar `disable-availability-zones-for-load-balancer`. **AWS CLI** **Desativar as Zonas de Disponibilidade para um balanceador de carga** Este exemplo remove as Zonas de Disponibilidade especificadas do conjunto de Zonas de Disponibilidade do balanceador de carga especificado. Comando: ``` aws elb disable-availability-zones-for-load-balancer --load-balancer-name my-load-balancer --availability-zones us-west-2a ``` Resultado: ``` { "AvailabilityZones": [ "us-west-2b" ] } ``` + Para ver detalhes da API, consulte [DisableAvailabilityZonesForLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/disable-availability-zones-for-load-balancer.html) na *Referência de comandos da AWS CLI*. ### `enable-availability-zones-for-load-balancer` O código de exemplo a seguir mostra como usar `enable-availability-zones-for-load-balancer`. **AWS CLI** **Habilitar Zonas de Disponibilidade para um balanceador de carga** Este exemplo adiciona a Zona de Disponibilidade especificada ao balanceador de carga especificado. Comando: ``` aws elb enable-availability-zones-for-load-balancer --load-balancer-name my-load-balancer --availability-zones us-west-2b ``` Resultado: ``` { "AvailabilityZones": [ "us-west-2a", "us-west-2b" ] } ``` + Para ver detalhes da API, consulte [EnableAvailabilityZonesForLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/enable-availability-zones-for-load-balancer.html) na *Referência de comandos da AWS CLI*. ### `modify-load-balancer-attributes` O código de exemplo a seguir mostra como usar `modify-load-balancer-attributes`. **AWS CLI** **Modificar os atributos de um balanceador de carga** Este exemplo modifica o atributo `CrossZoneLoadBalancing` do balanceador de carga especificado. Comando: ``` aws elb modify-load-balancer-attributes --load-balancer-name my-load-balancer --load-balancer-attributes "{\"CrossZoneLoadBalancing\":{\"Enabled\":true}}" ``` Resultado: ``` { "LoadBalancerAttributes": { "CrossZoneLoadBalancing": { "Enabled": true } }, "LoadBalancerName": "my-load-balancer" } ``` Este exemplo modifica o atributo `ConnectionDraining` do balanceador de carga especificado. Comando: ``` aws elb modify-load-balancer-attributes --load-balancer-name my-load-balancer --load-balancer-attributes "{\"ConnectionDraining\":{\"Enabled\":true,\"Timeout\":300}}" ``` Resultado: ``` { "LoadBalancerAttributes": { "ConnectionDraining": { "Enabled": true, "Timeout": 300 } }, "LoadBalancerName": "my-load-balancer" } ``` + Para ver detalhes da API, consulte [ModifyLoadBalancerAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/modify-load-balancer-attributes.html) na *Referência de comandos da AWS CLI*. ### `register-instances-with-load-balancer` O código de exemplo a seguir mostra como usar `register-instances-with-load-balancer`. **AWS CLI** **Registrar instâncias com um balanceador de carga** Este exemplo registra a instância especificada com o balanceador de carga especificado. Comando: ``` aws elb register-instances-with-load-balancer --load-balancer-name my-load-balancer --instances i-d6f6fae3 ``` Resultado: ``` { "Instances": [ { "InstanceId": "i-d6f6fae3" }, { "InstanceId": "i-207d9717" }, { "InstanceId": "i-afefb49b" } ] } ``` + Para ver detalhes da API, consulte [RegisterInstancesWithLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/register-instances-with-load-balancer.html) na *Referência de comandos da AWS CLI*. ### `remove-tags` O código de exemplo a seguir mostra como usar `remove-tags`. **AWS CLI** **Remover tags de um balanceador de carga** Este exemplo remove uma tag do balanceador de carga especificado. Comando: ``` aws elb remove-tags --load-balancer-name my-load-balancer --tags project ``` + Para ver detalhes da API, consulte [RemoveTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/remove-tags.html) na *Referência de comandos da AWS CLI*. ### `set-load-balancer-listener-ssl-certificate` O código de exemplo a seguir mostra como usar `set-load-balancer-listener-ssl-certificate`. **AWS CLI** **Atualizar o certificado SSL para um balanceador de carga HTTPS** Este exemplo substitui o certificado SSL existente para o balanceador de carga HTTPS especificado. Comando: ``` aws elb set-load-balancer-listener-ssl-certificate --load-balancer-name my-load-balancer --load-balancer-port 443 --ssl-certificate-id arn:aws:iam::123456789012:server-certificate/new-server-cert ``` + Para ver detalhes da API, consulte [SetLoadBalancerListenerSslCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/set-load-balancer-listener-ssl-certificate.html) na *Referência de comandos da AWS CLI*. ### `set-load-balancer-policies-for-backend-server` O código de exemplo a seguir mostra como usar `set-load-balancer-policies-for-backend-server`. **AWS CLI** **Substituir as políticas associadas a uma porta para uma instância de backend** Este exemplo substitui as políticas atualmente associadas à porta especificada. Comando: ``` aws elb set-load-balancer-policies-for-backend-server --load-balancer-name my-load-balancer --instance-port 80 --policy-names my-ProxyProtocol-policy ``` **Remover todas as políticas atualmente associadas a uma porta na sua instância de backend** Este exemplo remove todas as políticas associadas à porta especificada. Comando: ``` aws elb set-load-balancer-policies-for-backend-server --load-balancer-name my-load-balancer --instance-port 80 --policy-names [] ``` Para confirmar que as políticas foram removidas, use o comando `describe-load-balancer-policies`. + Para ver detalhes da API, consulte [SetLoadBalancerPoliciesForBackendServer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/set-load-balancer-policies-for-backend-server.html) na *Referência de comandos da AWS CLI*. ### `set-load-balancer-policies-of-listener` O código de exemplo a seguir mostra como usar `set-load-balancer-policies-of-listener`. **AWS CLI** **Substituir as políticas associadas a um receptor** Este exemplo substitui as políticas atualmente associadas ao receptor especificado. Comando: ``` aws elb set-load-balancer-policies-of-listener --load-balancer-name my-load-balancer --load-balancer-port 443 --policy-names my-SSLNegotiation-policy ``` **Remover todas as políticas associadas ao receptor** Este exemplo remove todas as políticas atualmente associadas ao receptor especificado. Comando: ``` aws elb set-load-balancer-policies-of-listener --load-balancer-name my-load-balancer --load-balancer-port 443 --policy-names [] ``` Para confirmar se as políticas foram removidas do balanceador de carga, use o comando `describe-load-balancer-policies`. + Para ver detalhes da API, consulte [SetLoadBalancerPoliciesOfListener](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/set-load-balancer-policies-of-listener.html) na *Referência de comandos da AWS CLI*. # Exemplos do Elastic Load Balancing Versão 2 usando o AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface 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-listener-certificates` O código de exemplo a seguir mostra como usar `add-listener-certificates`. **AWS CLI** **Adicionar um certificado a um receptor seguro** Esse exemplo adiciona o certificado especificado ao receptor seguro especificado. Comando: ``` aws elbv2 add-listener-certificates --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 --certificates CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/5cc54884-f4a3-4072-80be-05b9ba72f705 ``` Resultado: ``` { "Certificates": [ { "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/5cc54884-f4a3-4072-80be-05b9ba72f705", "IsDefault": false } ] } ``` + Para ver detalhes da API, consulte [AddListenerCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/add-listener-certificates.html) na *Referência de comandos da AWS CLI*. ### `add-tags` O código de exemplo a seguir mostra como usar `add-tags`. **AWS CLI** **Adicionar tags ao balanceador de carga** O exemplo `add-tags` a seguir adiciona as tags `project` e `department` ao balanceador de carga especificado. ``` aws elbv2 add-tags \ --resource-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 \ --tags "Key=project,Value=lima" "Key=department,Value=digital-media" ``` + Para ver detalhes da API, consulte [AddTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/add-tags.html) na *Referência de comandos da AWS CLI*. ### `create-listener` O código de exemplo a seguir mostra como usar `create-listener`. **AWS CLI** **Exemplo 1: como criar um receptor HTTP** O exemplo de `create-listener` a seguir cria um receptor HTTP para o Application Load Balancer especificado. Esse receptor encaminha as solicitações para o grupo de destino especificado. ``` aws elbv2 create-listener \ --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 \ --protocol HTTP \ --port 80 \ --default-actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 ``` Para obter mais informações, consulte [Tutorial: criar um Application Load Balancer usando a AWS CLI](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/tutorial-application-load-balancer-cli.html#create-load-balancer-aws-cli) no *Guia do usuário dos Application Load Balancers*. **Exemplo 2: como criar um receptor HTTPS** O exemplo de `create-listener` a seguir cria um receptor HTTPS para o Application Load Balancer especificado. Esse receptor encaminha as solicitações para o grupo de destino especificado. É necessário especificar um certificado SSL para um receptor HTTPS. Você pode criar e gerenciar certificados usando AWS Certificate Manager (ACM). Como alternativa, você pode criar um certificado usando ferramentas SSL/TLS, obter a assinatura de uma autoridade de certificação (CA) e fazer upload do certificado no AWS Identity and Access Management (IAM). ``` aws elbv2 create-listener \ --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 \ --protocol HTTPS \ --port 443 \ --certificates CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/3dcb0a41-bd72-4774-9ad9-756919c40557 \ --ssl-policy ELBSecurityPolicy-2016-08 \ --default-actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 ``` Para obter mais informações, consulte [Adicionar um receptor HTTPS](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/tutorial-application-load-balancer-cli.html#https-listener-aws-cli) no *Guia do usuário de Application Load Balancers*. **Exemplo 3: como criar um receptor TCP** O exemplo de `create-listener` a seguir cria um receptor TCP para o Network Load Balancer especificado. Esse receptor encaminha as solicitações para o grupo de destino especificado. ``` aws elbv2 create-listener \ --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/net/my-network-load-balancer/5d1b75f4f1cee11e \ --protocol TCP \ --port 80 \ --default-actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-tcp-targets/b6bba954d1361c78 ``` Para obter mais informações, consulte [Tutorial: criar um Network Load Balancer usando a AWS CLI](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancer-cli.html#create-load-balancer-aws-cli) no *Guia do usuário dos Network Load Balancers*. **Exemplo 4: como criar um receptor TLS** O exemplo de `create-listener` a seguir cria um receptor TLS para o Network Load Balancer especificado. Esse receptor encaminha as solicitações para o grupo de destino especificado. É necessário especificar um certificado SSL para um listener TLS. ``` aws elbv2 create-listener \ --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 \ --protocol TLS \ --port 443 \ --certificates CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/3dcb0a41-bd72-4774-9ad9-756919c40557 \ --ssl-policy ELBSecurityPolicy-2016-08 \ --default-actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 ``` Para obter mais informações, consulte [Listeners TLS para o Network Load Balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html) no *Guia do usuário dos Network Load Balancers*. **Exemplo 5: como criar um receptor UDP** O exemplo de `create-listener` a seguir cria um receptor UDP para o Network Load Balancer especificado. Esse receptor encaminha as solicitações para o grupo de destino especificado. ``` aws elbv2 create-listener \ --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/net/my-network-load-balancer/5d1b75f4f1cee11e \ --protocol UDP \ --port 53 \ --default-actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-tcp-targets/b6bba954d1361c78 ``` Para obter mais informações, consulte [Tutorial: criar um Network Load Balancer usando a AWS CLI](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancer-cli.html#create-load-balancer-aws-cli) no *Guia do usuário dos Network Load Balancers*. **Exemplo 6: como criar um receptor para o gateway e encaminhamento especificados** O exemplo de `create-listener` a seguir cria um receptor para o Gateway Load Balancer especificado. Esse receptor encaminha as solicitações para o grupo de destino especificado. ``` aws elbv2 create-listener \ --load-balancer-arn arn:aws:elasticloadbalancing:us-east-1:850631746142:loadbalancer/gwy/my-gateway-load-balancer/e0f9b3d5c7f7d3d6 \ --default-actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-east-1:850631746142:targetgroup/my-glb-targets/007ca469fae3bb1615 ``` Resultado: ``` { "Listeners": [ { "ListenerArn": "arn:aws:elasticloadbalancing:us-east-1:850631746142:listener/gwy/my-agw-lb-example2/e0f9b3d5c7f7d3d6/afc127db15f925de", "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-east-1:850631746142:loadbalancer/gwy/my-agw-lb-example2/e0f9b3d5c7f7d3d6", "DefaultActions": [ { "Type": "forward", "TargetGroupArn": "arn:aws:elasticloadbalancing:us-east-1:850631746142:targetgroup/test-tg-agw-2/007ca469fae3bb1615", "ForwardConfig": { "TargetGroups": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-east-1:850631746142:targetgroup/test-tg-agw-2/007ca469fae3bb1615" } ] } } ] } ] } ``` Para mais informações, consulte [Saiba como começar a usar Gateway Load Balancers com a AWS CLI](https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/getting-started-cli.html) no *Guia do usuário para Gateway Load Balancers*. + Consulte detalhes da API em [CreateListener](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/create-listener.html) na *Referência de comandos da AWS CLI*. ### `create-load-balancer` O código de exemplo a seguir mostra como usar `create-load-balancer`. **AWS CLI** **Exemplo 1: como criar um balanceador de carga voltado para a internet** O exemplo de `create-load-balancer` a seguir cria um Application Load Balancer voltado para a internet e habilita as zonas de disponibilidade para as sub-redes especificadas. ``` aws elbv2 create-load-balancer \ --name my-load-balancer \ --subnets subnet-b7d581c0 subnet-8360a9e7 ``` Resultado: ``` { "LoadBalancers": [ { "Type": "application", "Scheme": "internet-facing", "IpAddressType": "ipv4", "VpcId": "vpc-3ac0fb5f", "AvailabilityZones": [ { "ZoneName": "us-west-2a", "SubnetId": "subnet-8360a9e7" }, { "ZoneName": "us-west-2b", "SubnetId": "subnet-b7d581c0" } ], "CreatedTime": "2017-08-25T21:26:12.920Z", "CanonicalHostedZoneId": "Z2P70J7EXAMPLE", "DNSName": "my-load-balancer-424835706.us-west-2.elb.amazonaws.com", "SecurityGroups": [ "sg-5943793c" ], "LoadBalancerName": "my-load-balancer", "State": { "Code": "provisioning" }, "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" } ] } ``` Para obter mais informações, consulte [Tutorial: criar um Application Load Balancer usando a AWS CLI](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/tutorial-application-load-balancer-cli.html) no *Guia do usuário dos Application Load Balancers*. **Exemplo 2: como criar um balanceador de carga interno** O exemplo de `create-load-balancer` a seguir cria um Application Load Balancer interno e habilita as zonas de disponibilidade para as sub-redes especificadas. ``` aws elbv2 create-load-balancer \ --name my-internal-load-balancer \ --scheme internal \ --subnets subnet-b7d581c0 subnet-8360a9e7 ``` Resultado: ``` { "LoadBalancers": [ { "Type": "application", "Scheme": "internal", "IpAddressType": "ipv4", "VpcId": "vpc-3ac0fb5f", "AvailabilityZones": [ { "ZoneName": "us-west-2a", "SubnetId": "subnet-8360a9e7" }, { "ZoneName": "us-west-2b", "SubnetId": "subnet-b7d581c0" } ], "CreatedTime": "2016-03-25T21:29:48.850Z", "CanonicalHostedZoneId": "Z2P70J7EXAMPLE", "DNSName": "internal-my-internal-load-balancer-1529930873.us-west-2.elb.amazonaws.com", "SecurityGroups": [ "sg-5943793c" ], "LoadBalancerName": "my-internal-load-balancer", "State": { "Code": "provisioning" }, "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-internal-load-balancer/5b49b8d4303115c2" } ] } ``` Para obter mais informações, consulte [Tutorial: criar um Application Load Balancer usando a AWS CLI](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/tutorial-application-load-balancer-cli.html) no *Guia do usuário dos Application Load Balancers*. **Exemplo 3: como criar um Network Load Balancer** O exemplo de `create-load-balancer` a seguir cria um Network Load Balancer voltado para a internet e habilita a zona de disponibilidade para as sub-redes especificadas. Ele usa o mapeamento de sub-redes para associar o endereço IP do Elastic específico à interface de rede usada pelos nós do balanceador de carga da zona de disponibilidade. ``` aws elbv2 create-load-balancer \ --name my-network-load-balancer \ --type network \ --subnet-mappings SubnetId=subnet-b7d581c0,AllocationId=eipalloc-64d5890a ``` Resultado: ``` { "LoadBalancers": [ { "Type": "network", "Scheme": "internet-facing", "IpAddressType": "ipv4", "VpcId": "vpc-3ac0fb5f", "AvailabilityZones": [ { "LoadBalancerAddresses": [ { "IpAddress": "35.161.207.171", "AllocationId": "eipalloc-64d5890a" } ], "ZoneName": "us-west-2b", "SubnetId": "subnet-5264e837" } ], "CreatedTime": "2017-10-15T22:41:25.657Z", "CanonicalHostedZoneId": "Z2P70J7EXAMPLE", "DNSName": "my-network-load-balancer-5d1b75f4f1cee11e.elb.us-west-2.amazonaws.com", "LoadBalancerName": "my-network-load-balancer", "State": { "Code": "provisioning" }, "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/net/my-network-load-balancer/5d1b75f4f1cee11e" } ] } ``` Para obter mais informações, consulte [Tutorial: criar um Network Load Balancer usando a AWS CLI](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancer-cli.html) no *Guia do usuário dos Network Load Balancers*. **Exemplo 4: como criar um Gateway Load Balancer** O exemplo de `create-load-balancer` a seguir cria um Gateway Load Balancer e habilita as zonas de disponibilidade para as sub-redes especificadas. ``` aws elbv2 create-load-balancer \ --name my-gateway-load-balancer \ --type gateway \ --subnets subnet-dc83f691 subnet-a62583f9 ``` Resultado: ``` { "LoadBalancers": [ { "Type": "gateway", "VpcId": "vpc-838475fe", "AvailabilityZones": [ { "ZoneName": "us-east-1b", "SubnetId": "subnet-a62583f9" }, { "ZoneName": "us-east-1a", "SubnetId": "subnet-dc83f691" } ], "CreatedTime": "2021-07-14T19:33:43.324000+00:00", "LoadBalancerName": "my-gateway-load-balancer", "State": { "Code": "provisioning" }, "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-east-1:850631746142:loadbalancer/gwy/my-gateway-load-balancer/dfbb5a7d32cdee79" } ] } ``` Para mais informações, consulte [Saiba como começar a usar Gateway Load Balancers com a AWS CLI](https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/getting-started-cli.html) no *Guia do usuário para Gateway Load Balancers*. + Consulte detalhes da API em [CreateLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/create-load-balancer.html) na *Referência de comandos da AWS CLI*. ### `create-rule` O código de exemplo a seguir mostra como usar `create-rule`. **AWS CLI** **Exemplo 1: criar uma regra usando uma condição de caminho e uma ação de avanço** O exemplo `create-rule` a seguir cria uma regra que encaminha solicitações para o grupo de destino especificado, se o URL contiver o padrão especificado. ``` aws elbv2 create-rule \ --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 \ --priority 5 \ --conditions file://conditions-pattern.json --actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 ``` Conteúdo de `conditions-pattern.json`: ``` [ { "Field": "path-pattern", "PathPatternConfig": { "Values": ["/images/*"] } } ] ``` **Exemplo 2: criar uma regra usando uma condição de host e uma resposta fixa** O exemplo `create-rule` a seguir cria uma regra que fornece uma resposta fixa se o nome do host no cabeçalho do host corresponder ao nome do host especificado. ``` aws elbv2 create-rule \ --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 \ --priority 10 \ --conditions file://conditions-host.json \ --actions file://actions-fixed-response.json ``` Conteúdo de `conditions-host.json` ``` [ { "Field": "host-header", "HostHeaderConfig": { "Values": ["*.example.com"] } } ] ``` Conteúdo de `actions-fixed-response.json` ``` [ { "Type": "fixed-response", "FixedResponseConfig": { "MessageBody": "Hello world", "StatusCode": "200", "ContentType": "text/plain" } } ] ``` **Exemplo 3: criar uma regra usando uma condição de endereço IP de origem, uma ação de autenticação e uma ação de encaminhamento** O exemplo `create-rule` a seguir cria uma regra que autentica o usuário se o endereço IP de origem corresponder ao endereço IP especificado e encaminha a solicitação para o grupo de destino especificado se a autenticação for bem-sucedida. ``` aws elbv2 create-rule \ --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 \ --priority 20 \ --conditions file://conditions-source-ip.json \ --actions file://actions-authenticate.json ``` Conteúdo de `conditions-source-ip.json` ``` [ { "Field": "source-ip", "SourceIpConfig": { "Values": ["192.0.2.0/24", "198.51.100.10/32"] } } ] ``` Conteúdo de `actions-authenticate.json` ``` [ { "Type": "authenticate-oidc", "AuthenticateOidcConfig": { "Issuer": "https://idp-issuer.com", "AuthorizationEndpoint": "https://authorization-endpoint.com", "TokenEndpoint": "https://token-endpoint.com", "UserInfoEndpoint": "https://user-info-endpoint.com", "ClientId": "abcdefghijklmnopqrstuvwxyz123456789", "ClientSecret": "123456789012345678901234567890", "SessionCookieName": "my-cookie", "SessionTimeout": 3600, "Scope": "email", "AuthenticationRequestExtraParams": { "display": "page", "prompt": "login" }, "OnUnauthenticatedRequest": "deny" }, "Order": 1 }, { "Type": "forward", "TargetGroupArn": "arn:aws:elasticloadbalancing:us-east-1:880185128111:targetgroup/cli-test/642a97ecb0e0f26b", "Order": 2 } ] ``` + Para ver detalhes da API, consulte [CreateRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/create-rule.html) na *Referência de comandos da AWS CLI*. ### `create-target-group` O código de exemplo a seguir mostra como usar `create-target-group`. **AWS CLI** **Exemplo 1: criar um grupo de destino para o Application Load Balancer** O exemplo de `create-target-group` a seguir cria um grupo de destino para um Application Load Balancer no qual você registra destinos por ID de instância (o tipo do destino é `instance`). Esse grupo de destino usa o protocolo HTTP, a porta 80 e as configurações padrão de verificação de integridade de um grupo de destino HTTP. ``` aws elbv2 create-target-group \ --name my-targets \ --protocol HTTP \ --port 80 \ --target-type instance \ --vpc-id vpc-3ac0fb5f ``` Resultado: ``` { "TargetGroups": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", "TargetGroupName": "my-targets", "Protocol": "HTTP", "Port": 80, "VpcId": "vpc-3ac0fb5f", "HealthCheckProtocol": "HTTP", "HealthCheckPort": "traffic-port", "HealthCheckEnabled": true, "HealthCheckIntervalSeconds": 30, "HealthCheckTimeoutSeconds": 5, "HealthyThresholdCount": 5, "UnhealthyThresholdCount": 2, "HealthCheckPath": "/", "Matcher": { "HttpCode": "200" }, "TargetType": "instance", "ProtocolVersion": "HTTP1", "IpAddressType": "ipv4" } ] } ``` Para obter mais informações, consulte [Criar um grupo de destino](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-target-group.html) no *Guia do usuário dos Application Load Balancers*. **Exemplo 2: criar um grupo de destino para rotear o tráfego de um Application Load Balancer para uma função do Lambda** O exemplo de `create-target-group` a seguir cria um grupo de destino para um Application Load Balancer, no qual o destino é uma função do Lambda (o tipo do destino é `lambda`). Por padrão, as verificações de integridade estão desabilitadas para esse grupo de destino. ``` aws elbv2 create-target-group \ --name my-lambda-target \ --target-type lambda ``` Resultado: ``` { "TargetGroups": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-lambda-target/a3003e085dbb8ddc", "TargetGroupName": "my-lambda-target", "HealthCheckEnabled": false, "HealthCheckIntervalSeconds": 35, "HealthCheckTimeoutSeconds": 30, "HealthyThresholdCount": 5, "UnhealthyThresholdCount": 2, "HealthCheckPath": "/", "Matcher": { "HttpCode": "200" }, "TargetType": "lambda", "IpAddressType": "ipv4" } ] } ``` Para obter mais informações, consulte [Lambda functions as targets](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/lambda-functions.html) no *Guia do usuário de Application Load Balancers*. **Exemplo 3: criar um grupo de destino para o Network Load Balancer** O exemplo de `create-target-group` a seguir cria um grupo de destino para um Network Load Balancer no qual você registra destinos por endereço IP (o tipo do destino é `ip`). Esse grupo de destino usa o protocolo TCP, a porta 80 e as configurações padrão de verificação de integridade de um grupo de destino TCP. ``` aws elbv2 create-target-group \ --name my-ip-targets \ --protocol TCP \ --port 80 \ --target-type ip \ --vpc-id vpc-3ac0fb5f ``` Resultado: ``` { "TargetGroups": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-ip-targets/b6bba954d1361c78", "TargetGroupName": "my-ip-targets", "Protocol": "TCP", "Port": 80, "VpcId": "vpc-3ac0fb5f", "HealthCheckEnabled": true, "HealthCheckProtocol": "TCP", "HealthCheckPort": "traffic-port", "HealthCheckIntervalSeconds": 30, "HealthCheckTimeoutSeconds": 10, "HealthyThresholdCount": 5, "UnhealthyThresholdCount": 2, "TargetType": "ip", "IpAddressType": "ipv4" } ] } ``` Para obter mais informações, consulte [Criar um grupo de destino](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-target-group.html) no *Guia do usuário do Network Load Balancer*. **Exemplo 4: criar um grupo de destino para rotear o tráfego de um Network Load Balancer para um Application Load Balancer** O exemplo `create-target-group` a seguir cria um grupo de destino para um Network Load Balancer no qual você registra um Application Load Balancer como destino (o tipo do destino é `alb`). aws elbv2 create-target-group --name my-alb-target --protocol TCP --port 80 --target-type alb --vpc-id vpc-3ac0fb5f Resultado: ``` { "TargetGroups": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-alb-target/a3003e085dbb8ddc", "TargetGroupName": "my-alb-target", "Protocol": "TCP", "Port": 80, "VpcId": "vpc-838475fe", "HealthCheckProtocol": "HTTP", "HealthCheckPort": "traffic-port", "HealthCheckEnabled": true, "HealthCheckIntervalSeconds": 30, "HealthCheckTimeoutSeconds": 6, "HealthyThresholdCount": 5, "UnhealthyThresholdCount": 2, "HealthCheckPath": "/", "Matcher": { "HttpCode": "200-399" }, "TargetType": "alb", "IpAddressType": "ipv4" } ] } ``` Para obter mais informações, consulte [Criar um grupo de destino com um Application Load Balancer como destino](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/application-load-balancer-target.html) no *Guia do usuário do Network Load Balancer*. **Exemplo 5: criar um grupo de destino para o Balanceador de Carga de Gateway** O exemplo `create-target-group` a seguir cria um grupo destino para um Balanceador de Carga de Gateway, no qual o destino é uma instância e o protocolo do grupo de destino é `GENEVE`. ``` aws elbv2 create-target-group \ --name my-glb-targetgroup \ --protocol GENEVE \ --port 6081 \ --target-type instance \ --vpc-id vpc-838475fe ``` Resultado: ``` { "TargetGroups": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-glb-targetgroup/00c3d57eacd6f40b6f", "TargetGroupName": "my-glb-targetgroup", "Protocol": "GENEVE", "Port": 6081, "VpcId": "vpc-838475fe", "HealthCheckProtocol": "TCP", "HealthCheckPort": "80", "HealthCheckEnabled": true, "HealthCheckIntervalSeconds": 10, "HealthCheckTimeoutSeconds": 5, "HealthyThresholdCount": 5, "UnhealthyThresholdCount": 2, "TargetType": "instance" } ] } ``` Para obter mais informações, consulte Criar um grupo de destino `\$1\$1 no *Guia do usuário do Balanceador de Carga do Gateway*. + Consulte detalhes da API em [CreateTargetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/create-target-group.html) na *Referência de comandos da AWS CLI*. ### `delete-listener` O código de exemplo a seguir mostra como usar `delete-listener`. **AWS CLI** **Excluir um receptor** O exemplo `delete-listener` a seguir exclui o receptor especificado. ``` aws elbv2 delete-listener \ --listener-arn arn:aws:elasticloadbalancing:ua-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 ``` + Para ver detalhes da API, consulte [DeleteListener](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/delete-listener.html) na *Referência de comandos da AWS CLI*. ### `delete-load-balancer` O código de exemplo a seguir mostra como usar `delete-load-balancer`. **AWS CLI** **Como excluir um balanceador de carga** O exemplo `delete-load-balancer` a seguir exclui o balanceador de carga especificado. ``` aws elbv2 delete-load-balancer \ --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 ``` + Consulte detalhes da API em [DeleteLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/delete-load-balancer.html) na *Referência de comandos da AWS CLI*. ### `delete-rule` O código de exemplo a seguir mostra como usar `delete-rule`. **AWS CLI** **Para excluir uma regra** O exemplo de `delete-rule` a seguir exclui a regra especificada. ``` aws elbv2 delete-rule \ --rule-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3 ``` + Consulte detalhes da API em [DeleteRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/delete-rule.html) na *Referência de comandos da AWS CLI*. ### `delete-target-group` O código de exemplo a seguir mostra como usar `delete-target-group`. **AWS CLI** **Como excluir um grupo de destino** O exemplo de `delete-target-group` a seguir exclui o grupo de destino especificado. ``` aws elbv2 delete-target-group \ --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir o balanceador de carga](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-delete.html) no *Guia do Application Load Balancer Guide*. + Consulte detalhes da API em [DeleteTargetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/delete-target-group.html) na *Referência de comandos da AWS CLI*. ### `deregister-targets` O código de exemplo a seguir mostra como usar `deregister-targets`. **AWS CLI** **Exemplo 1: cancelar o registro de um destino de um grupo de destino** O exemplo `deregister-targets` a seguir remove a instância especificada do grupo de destino especificado. ``` aws elbv2 deregister-targets \ --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 \ --targets Id=i-1234567890abcdef0 ``` **Exemplo 2: cancelar o registro de um destino registrado usando substituições de porta** O exemplo `deregister-targets` a seguir remove uma instância de um grupo de destino que foi registrado usando substituições de porta. ``` aws elbv2 deregister-targets \ --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-internal-targets/3bb63f11dfb0faf9 \ --targets Id=i-1234567890abcdef0,Port=80 Id=i-1234567890abcdef0,Port=766 ``` + Para ver detalhes da API, consulte [DeregisterTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/deregister-targets.html) na *Referência de comandos da AWS CLI*. ### `describe-account-limits` O código de exemplo a seguir mostra como usar `describe-account-limits`. **AWS CLI** **Descrever os limites do Balanceamento de Carga Elastic** O exemplo `describe-account-limits` a seguir mostra os limites do Balanceamento de Carga Elastic para sua conta AWS na Região atual. ``` aws elbv2 describe-account-limits ``` Resultado: ``` { "Limits": [ { "Name": "target-groups", "Max": "3000" }, { "Name": "targets-per-application-load-balancer", "Max": "1000" }, { "Name": "listeners-per-application-load-balancer", "Max": "50" }, { "Name": "rules-per-application-load-balancer", "Max": "100" }, { "Name": "network-load-balancers", "Max": "50" }, { "Name": "targets-per-network-load-balancer", "Max": "3000" }, { "Name": "targets-per-availability-zone-per-network-load-balancer", "Max": "500" }, { "Name": "listeners-per-network-load-balancer", "Max": "50" }, { "Name": "condition-values-per-alb-rule", "Max": "5" }, { "Name": "condition-wildcards-per-alb-rule", "Max": "5" }, { "Name": "target-groups-per-application-load-balancer", "Max": "100" }, { "Name": "target-groups-per-action-on-application-load-balancer", "Max": "5" }, { "Name": "target-groups-per-action-on-network-load-balancer", "Max": "1" }, { "Name": "certificates-per-application-load-balancer", "Max": "25" }, { "Name": "certificates-per-network-load-balancer", "Max": "25" }, { "Name": "targets-per-target-group", "Max": "1000" }, { "Name": "target-id-registrations-per-application-load-balancer", "Max": "1000" }, { "Name": "network-load-balancer-enis-per-vpc", "Max": "1200" }, { "Name": "application-load-balancers", "Max": "50" }, { "Name": "gateway-load-balancers", "Max": "100" }, { "Name": "gateway-load-balancers-per-vpc", "Max": "100" }, { "Name": "geneve-target-groups", "Max": "100" }, { "Name": "targets-per-availability-zone-per-gateway-load-balancer", "Max": "300" } ] } ``` Para obter mais informações, consulte [Quotas](https://docs.aws.amazon.com/general/latest/gr/elb.html#limits_elastic_load_balancer) na *Referência geral da AWS*. + Para ver detalhes da API, consulte [DescribeAccountLimits](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/describe-account-limits.html) na *Referência de comandos da AWS CLI*. ### `describe-listener-certificates` O código de exemplo a seguir mostra como usar `describe-listener-certificates`. **AWS CLI** **Descrever os certificados para um receptor seguro** Esse exemplo descreve os certificados do receptor seguro especificado. Comando: ``` aws elbv2 describe-listener-certificates --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 ``` Resultado: ``` { "Certificates": [ { "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/5cc54884-f4a3-4072-80be-05b9ba72f705", "IsDefault": false }, { "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/3dcb0a41-bd72-4774-9ad9-756919c40557", "IsDefault": false }, { "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/fe59da96-6f58-4a22-8eed-6d0d50477e1d", "IsDefault": true } ] } ``` + Para ver detalhes da API, consulte [DescribeListenerCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/describe-listener-certificates.html) na *Referência de comandos da AWS CLI*. ### `describe-listeners` O código de exemplo a seguir mostra como usar `describe-listeners`. **AWS CLI** **Descrever um receptor** Este exemplo descreve o receptor especificado. Comando: ``` aws elbv2 describe-listeners --listener-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 ``` Resultado: ``` { "Listeners": [ { "Port": 80, "Protocol": "HTTP", "DefaultActions": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", "Type": "forward" } ], "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2" } ] } ``` **Descrever os receptores de um balanceador de carga** Este exemplo descreve os receptores do balanceador de carga especificado. Comando: ``` aws elbv2 describe-listeners --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 ``` Resultado: ``` { "Listeners": [ { "Port": 443, "Protocol": "HTTPS", "DefaultActions": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", "Type": "forward" } ], "SslPolicy": "ELBSecurityPolicy-2015-05", "Certificates": [ { "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-server-cert" } ], "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65" }, { "Port": 80, "Protocol": "HTTP", "DefaultActions": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", "Type": "forward" } ], "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2" } ] } ``` + Para ver detalhes da API, consulte [DescribeListeners](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/describe-listeners.html) na *Referência de comandos da AWS CLI*. ### `describe-load-balancer-attributes` O código de exemplo a seguir mostra como usar `describe-load-balancer-attributes`. **AWS CLI** **Descrever os atributos do balanceador de carga** O exemplo `describe-load-balancer-attributes` a seguir exibe os atributos do balanceador de carga especificado. ``` aws elbv2 describe-load-balancer-attributes \ --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 ``` O exemplo de saída a seguir mostra os atributos de um Application Load Balancer. ``` { "Attributes": [ { "Value": "false", "Key": "access_logs.s3.enabled" }, { "Value": "", "Key": "access_logs.s3.bucket" }, { "Value": "", "Key": "access_logs.s3.prefix" }, { "Value": "60", "Key": "idle_timeout.timeout_seconds" }, { "Value": "false", "Key": "deletion_protection.enabled" }, { "Value": "true", "Key": "routing.http2.enabled" } ] } ``` O exemplo de saída a seguir inclui os atributos de um Network Load Balancer. ``` { "Attributes": [ { "Value": "false", "Key": "access_logs.s3.enabled" }, { "Value": "", "Key": "access_logs.s3.bucket" }, { "Value": "", "Key": "access_logs.s3.prefix" }, { "Value": "false", "Key": "deletion_protection.enabled" }, { "Value": "false", "Key": "load_balancing.cross_zone.enabled" } ] } ``` + Para ver detalhes da API, consulte [DescribeLoadBalancerAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/describe-load-balancer-attributes.html) na *Referência de comandos da AWS CLI*. ### `describe-load-balancers` O código de exemplo a seguir mostra como usar `describe-load-balancers`. **AWS CLI** **Como descrever um balanceador de carga** Este exemplo descreve o balanceador de carga especificado. Comando: ``` aws elbv2 describe-load-balancers --load-balancer-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 ``` Resultado: ``` { "LoadBalancers": [ { "Type": "application", "Scheme": "internet-facing", "IpAddressType": "ipv4", "VpcId": "vpc-3ac0fb5f", "AvailabilityZones": [ { "ZoneName": "us-west-2a", "SubnetId": "subnet-8360a9e7" }, { "ZoneName": "us-west-2b", "SubnetId": "subnet-b7d581c0" } ], "CreatedTime": "2016-03-25T21:26:12.920Z", "CanonicalHostedZoneId": "Z2P70J7EXAMPLE", "DNSName": "my-load-balancer-424835706.us-west-2.elb.amazonaws.com", "SecurityGroups": [ "sg-5943793c" ], "LoadBalancerName": "my-load-balancer", "State": { "Code": "active" }, "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" } ] } ``` **Como descrever todos os balanceadores de carga** Este exemplo descreve todos os balanceadores de carga. Comando: ``` aws elbv2 describe-load-balancers ``` + Consulte detalhes da API em [DescribeLoadBalancers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/describe-load-balancers.html) na *Referência de comandos da AWS CLI*. ### `describe-rules` O código de exemplo a seguir mostra como usar `describe-rules`. **AWS CLI** **Exemplo 1: descrever uma regra** O exemplo `describe-rules` a seguir exibe os detalhes da regra especificada. ``` aws elbv2 describe-rules \ --rule-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee ``` **Exemplo 2: descrever as regras para um receptor** O exemplo `describe-rules` a seguir exibe os detalhes da regra para o receptor especificado. A saída inclui a regra padrão e quaisquer outras regras que você tenha adicionado. ``` aws elbv2 describe-rules \ --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 ``` + Para ver detalhes da API, consulte [DescribeRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/describe-rules.html) na *Referência de comandos da AWS CLI*. ### `describe-ssl-policies` O código de exemplo a seguir mostra como usar `describe-ssl-policies`. **AWS CLI** **Exemplo 1: listar as políticas usadas para negociação de SSL por tipo de balanceador de carga** O exemplo `describe-ssl-policies` a seguir exibe os nomes das políticas que você pode usar para negociação de SSL com um Application Load Balancer. O exemplo usa o parâmetro `--query` para exibir somente os nomes das políticas. ``` aws elbv2 describe-ssl-policies \ --load-balancer-type application \ --query SslPolicies[*].Name ``` Resultado: ``` [ "ELBSecurityPolicy-2016-08", "ELBSecurityPolicy-TLS13-1-2-2021-06", "ELBSecurityPolicy-TLS13-1-2-Res-2021-06", "ELBSecurityPolicy-TLS13-1-2-Ext1-2021-06", "ELBSecurityPolicy-TLS13-1-2-Ext2-2021-06", "ELBSecurityPolicy-TLS13-1-1-2021-06", "ELBSecurityPolicy-TLS13-1-0-2021-06", "ELBSecurityPolicy-TLS13-1-3-2021-06", "ELBSecurityPolicy-TLS-1-2-2017-01", "ELBSecurityPolicy-TLS-1-1-2017-01", "ELBSecurityPolicy-TLS-1-2-Ext-2018-06", "ELBSecurityPolicy-FS-2018-06", "ELBSecurityPolicy-2015-05", "ELBSecurityPolicy-TLS-1-0-2015-04", "ELBSecurityPolicy-FS-1-2-Res-2019-08", "ELBSecurityPolicy-FS-1-1-2019-08", "ELBSecurityPolicy-FS-1-2-2019-08", "ELBSecurityPolicy-FS-1-2-Res-2020-10" ] ``` **Exemplo 2: listar as políticas que oferecem suporte a um protocolo específico** O exemplo `describe-ssl-policies` a seguir exibe os nomes das políticas que oferecem suporte ao protocolo TLS 1.3. O exemplo usa o parâmetro `--query` para exibir somente os nomes das políticas. ``` aws elbv2 describe-ssl-policies \ --load-balancer-type application \ --query SslPolicies[?contains(SslProtocols,'TLSv1.3')].Name ``` Resultado: ``` [ "ELBSecurityPolicy-TLS13-1-2-2021-06", "ELBSecurityPolicy-TLS13-1-2-Res-2021-06", "ELBSecurityPolicy-TLS13-1-2-Ext1-2021-06", "ELBSecurityPolicy-TLS13-1-2-Ext2-2021-06", "ELBSecurityPolicy-TLS13-1-1-2021-06", "ELBSecurityPolicy-TLS13-1-0-2021-06", "ELBSecurityPolicy-TLS13-1-3-2021-06" ] ``` **Exemplo 3: exibir as cifras de uma política** O exemplo `describe-ssl-policies` a seguir exibe os nomes das cifras da política especificada. O exemplo usa o parâmetro `--query` para exibir somente os nomes das cifras. A primeira cifra da lista tem prioridade 1 e as cifras restantes estão em ordem de prioridade. ``` aws elbv2 describe-ssl-policies \ --names ELBSecurityPolicy-TLS13-1-2-2021-06 \ --query SslPolicies[*].Ciphers[*].Name ``` Resultado: ``` [ "TLS_AES_128_GCM_SHA256", "TLS_AES_256_GCM_SHA384", "TLS_CHACHA20_POLY1305_SHA256", "ECDHE-ECDSA-AES128-GCM-SHA256", "ECDHE-RSA-AES128-GCM-SHA256", "ECDHE-ECDSA-AES128-SHA256", "ECDHE-RSA-AES128-SHA256", "ECDHE-ECDSA-AES256-GCM-SHA384", "ECDHE-RSA-AES256-GCM-SHA384", "ECDHE-ECDSA-AES256-SHA384", "ECDHE-RSA-AES256-SHA384" ] ``` Para obter mais informações, consulte [Políticas de segurança](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) no *Guia do usuário dos Application Load Balancers*. + Para ver detalhes da API, consulte [DescribeSslPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/describe-ssl-policies.html) na *Referência de comandos da AWS CLI*. ### `describe-tags` O código de exemplo a seguir mostra como usar `describe-tags`. **AWS CLI** **Descrever as tags atribuídas a um balanceador de carga** Este exemplo descreve as tags atribuídas ao balanceador de carga especificado. Comando: ``` aws elbv2 describe-tags --resource-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 ``` Resultado: ``` { "TagDescriptions": [ { "ResourceArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", "Tags": [ { "Value": "lima", "Key": "project" }, { "Value": "digital-media", "Key": "department" } ] } ] } ``` + Para ver detalhes da API, consulte [DescribeTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/describe-tags.html) na *Referência de comandos da AWS CLI*. ### `describe-target-group-attributes` O código de exemplo a seguir mostra como usar `describe-target-group-attributes`. **AWS CLI** **Descrever os atributos do grupo de destino** O exemplo `describe-target-group-attributes` a seguir exibe os atributos do grupo de destino especificado. ``` aws elbv2 describe-target-group-attributes \ --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 ``` A saída inclui os atributos se o protocolo for HTTP ou HTTPS e o tipo de destino for `instance` ou `ip`. ``` { "Attributes": [ { "Value": "false", "Key": "stickiness.enabled" }, { "Value": "300", "Key": "deregistration_delay.timeout_seconds" }, { "Value": "lb_cookie", "Key": "stickiness.type" }, { "Value": "86400", "Key": "stickiness.lb_cookie.duration_seconds" }, { "Value": "0", "Key": "slow_start.duration_seconds" } ] } ``` A saída a seguir inclui os atributos se o protocolo for HTTP ou HTTPS e o tipo de destino for `lambda`. ``` { "Attributes": [ { "Value": "false", "Key": "lambda.multi_value_headers.enabled" } ] } ``` A saída a seguir inclui os atributos se o protocolo for TCP, TLS, UDP ou TCP\$1UDP. ``` { "Attributes": [ { "Value": "false", "Key": "proxy_protocol_v2.enabled" }, { "Value": "300", "Key": "deregistration_delay.timeout_seconds" } ] } ``` + Para ver detalhes da API, consulte [DescribeTargetGroupAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/describe-target-group-attributes.html) na *Referência de comandos da AWS CLI*. ### `describe-target-groups` O código de exemplo a seguir mostra como usar `describe-target-groups`. **AWS CLI** **Exemplo 1: como descrever um grupo de destino** O exemplo de `describe-target-groups` a seguir exibe os detalhes do grupo de destino especificado. ``` aws elbv2 describe-target-groups \ --target-group-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 ``` Resultado: ``` { "TargetGroups": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", "TargetGroupName": "my-targets", "Protocol": "HTTP", "Port": 80, "VpcId": "vpc-3ac0fb5f", "HealthCheckProtocol": "HTTP", "HealthCheckPort": "traffic-port", "HealthCheckEnabled": true, "HealthCheckIntervalSeconds": 30, "HealthCheckTimeoutSeconds": 5, "HealthyThresholdCount": 5, "UnhealthyThresholdCount": 2, "HealthCheckPath": "/", "Matcher": { "HttpCode": "200" }, "LoadBalancerArns": [ "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" ], "TargetType": "instance", "ProtocolVersion": "HTTP1", "IpAddressType": "ipv4" } ] } ``` **Exemplo 2: como descrever todos os grupos de destino de um balanceador de carga** O exemplo de `describe-target-groups` a seguir exibe os detalhes de todos os grupos de destino do balanceador de carga especificado. O exemplo usa o parâmetro `--query` para exibir somente os nomes dos grupo de destino. ``` aws elbv2 describe-target-groups \ --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 \ --query TargetGroups[*].TargetGroupName ``` Resultado: ``` [ "my-instance-targets", "my-ip-targets", "my-lambda-target" ] ``` Para ter mais informações, consulte [Grupos de destino](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html) no *Guia do Application Load Balancer*. + Consulte detalhes da API em [DescribeTargetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/describe-target-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-target-health` O código de exemplo a seguir mostra como usar `describe-target-health`. **AWS CLI** **Exemplo 1: como descrever a integridade dos destinos de um grupo de destino** O exemplo de `describe-target-health` a seguir exibe os detalhes de integridade dos destinos do grupo de destino especificado. Os destinos estão íntegros. ``` aws elbv2 describe-target-health \ --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 ``` Resultado: ``` { "TargetHealthDescriptions": [ { "HealthCheckPort": "80", "Target": { "Id": "i-ceddcd4d", "Port": 80 }, "TargetHealth": { "State": "healthy" } }, { "HealthCheckPort": "80", "Target": { "Id": "i-0f76fade", "Port": 80 }, "TargetHealth": { "State": "healthy" } } ] } ``` **Exemplo 2: como descrever a integridade de um destino** O exemplo de `describe-target-health` a seguir exibe os detalhes de integridade do destino especificado. Este destino é íntegro. ``` aws elbv2 describe-target-health \ --targets Id=i-0f76fade,Port=80 \ --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 ``` Resultado: ``` { "TargetHealthDescriptions": [ { "HealthCheckPort": "80", "Target": { "Id": "i-0f76fade", "Port": 80 }, "TargetHealth": { "State": "healthy" } } ] } ``` O exemplo de saída a seguir é de um destino cujo grupo de destino não está especificado em uma ação de um receptor. Esse destino não pode receber tráfego do balanceador de carga. ``` { "TargetHealthDescriptions": [ { "HealthCheckPort": "80", "Target": { "Id": "i-0f76fade", "Port": 80 }, "TargetHealth": { "State": "unused", "Reason": "Target.NotInUse", "Description": "Target group is not configured to receive traffic from the load balancer" } } ] } ``` O exemplo de saída a seguir é de um destino cujo grupo de destino foi especificado em uma ação de um receptor. O destino ainda está sendo registrado. ``` { "TargetHealthDescriptions": [ { "HealthCheckPort": "80", "Target": { "Id": "i-0f76fade", "Port": 80 }, "TargetHealth": { "State": "initial", "Reason": "Elb.RegistrationInProgress", "Description": "Target registration is in progress" } } ] } ``` O exemplo de saída a seguir é de um destino não íntegro. ``` { "TargetHealthDescriptions": [ { "HealthCheckPort": "80", "Target": { "Id": "i-0f76fade", "Port": 80 }, "TargetHealth": { "State": "unhealthy", "Reason": "Target.Timeout", "Description": "Connection to target timed out" } } ] } ``` O exemplo de saída a seguir é de um destino que é uma função do Lambda e com verificações de integridade desabilitadas. ``` { "TargetHealthDescriptions": [ { "Target": { "Id": "arn:aws:lambda:us-west-2:123456789012:function:my-function", "AvailabilityZone": "all", }, "TargetHealth": { "State": "unavailable", "Reason": "Target.HealthCheckDisabled", "Description": "Health checks are not enabled for this target" } } ] } ``` + Consulte detalhes da API em [DescribeTargetHealth](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/describe-target-health.html) na *Referência de comandos da AWS CLI*. ### `modify-listener` O código de exemplo a seguir mostra como usar `modify-listener`. **AWS CLI** **Exemplo 1: alterar a ação padrão para uma ação de encaminhamento** O exemplo `modify-listener` a seguir altera a ação padrão para uma ação de `forward` para o receptor especificado. ``` aws elbv2 modify-listener \ --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 \ --default-actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f ``` Resultado: ``` { "Listeners": [ { "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", "Protocol": "HTTP", "Port": 80, "DefaultActions": [ { "Type": "forward", "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f" } ] } ] } ``` **Exemplo 2: alterar a ação padrão para uma ação de redirecionamento** O exemplo `modify-listener` a seguir altera a ação padrão para uma ação de `redirect` para o receptor especificado. ``` aws elbv2 modify-listener \ --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 \ --default-actions Type=redirect, RedirectConfig='{Protocol=HTTPS,StatusCode=HTTP_302}' ``` Resultado: ``` { "Listeners": [ { "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", "Protocol": "HTTP", "Port": 80, "DefaultActions": [ { "Type": "redirect", "RedirectConfig": { "Protocol": "HTTPS", "Port": "#{port}", "Host": "#{host}", "Path": "/#{path}", "Query": "#{query}", "StatusCode": "HTTP_302", } } ] } ] } ``` **Exemplo 3: alterar o certificado do servidor** O exemplo `modify-listener` a seguir altera o certificado do servidor para o receptor HTTPS especificado. ``` aws elbv2 modify-listener \ --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65 \ --certificates CertificateArn=arn:aws:iam::123456789012:server-certificate/my-new-server-cert ``` Resultado: ``` { "Listeners": [ { "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65", "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", "Protocol": "HTTPS", "Port": 443, "DefaultActions": [ { "Type": "forward", "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" } ], "SslPolicy": "ELBSecurityPolicy-2015-05", "Certificates": [ { "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-new-server-cert" } ], } ] } ``` Para ter mais informações, consulte [Listener rules](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#listener-rules) no *Guia do usuário de Application Load Balancers*. + Para ver detalhes da API, consulte [ModifyListener](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/modify-listener.html) na *Referência de comandos da AWS CLI*. ### `modify-load-balancer-attributes` O código de exemplo a seguir mostra como usar `modify-load-balancer-attributes`. **AWS CLI** **Ativar a proteção contra exclusão** Este exemplo habilita a proteção contra exclusão do balanceador de carga especificado. Comando: ``` aws elbv2 modify-load-balancer-attributes --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 --attributes Key=deletion_protection.enabled,Value=true ``` Resultado: ``` { "Attributes": [ { "Value": "true", "Key": "deletion_protection.enabled" }, { "Value": "false", "Key": "access_logs.s3.enabled" }, { "Value": "60", "Key": "idle_timeout.timeout_seconds" }, { "Value": "", "Key": "access_logs.s3.prefix" }, { "Value": "", "Key": "access_logs.s3.bucket" } ] } ``` **Alterar o tempo limite de inatividade** Este exemplo altera o valor do tempo limite de inatividade do balanceador de carga especificado. Comando: ``` aws elbv2 modify-load-balancer-attributes --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 --attributes Key=idle_timeout.timeout_seconds,Value=30 ``` Resultado: ``` { "Attributes": [ { "Value": "30", "Key": "idle_timeout.timeout_seconds" }, { "Value": "false", "Key": "access_logs.s3.enabled" }, { "Value": "", "Key": "access_logs.s3.prefix" }, { "Value": "true", "Key": "deletion_protection.enabled" }, { "Value": "", "Key": "access_logs.s3.bucket" } ] } ``` **Habilitar logs de acesso** Este exemplo habilita os logs de acesso para o balanceador de carga especificado. Observe que o bucket do S3 deve existir na mesma região que o balanceador de carga e deve conter uma política anexada que conceda acesso ao serviço Elastic Load Balancing. Comando: ``` aws elbv2 modify-load-balancer-attributes --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 --attributes Key=access_logs.s3.enabled,Value=true Key=access_logs.s3.bucket,Value=my-loadbalancer-logs Key=access_logs.s3.prefix,Value=myapp ``` Resultado: ``` { "Attributes": [ { "Value": "true", "Key": "access_logs.s3.enabled" }, { "Value": "my-load-balancer-logs", "Key": "access_logs.s3.bucket" }, { "Value": "myapp", "Key": "access_logs.s3.prefix" }, { "Value": "60", "Key": "idle_timeout.timeout_seconds" }, { "Value": "false", "Key": "deletion_protection.enabled" } ] } ``` + Para ver detalhes da API, consulte [ModifyLoadBalancerAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/modify-load-balancer-attributes.html) na *Referência de comandos da AWS CLI*. ### `modify-rule` O código de exemplo a seguir mostra como usar `modify-rule`. **AWS CLI** **Modificar uma regra** O exemplo `modify-rule` a seguir atualiza as ações e condições da regra especificada. ``` aws elbv2 modify-rule \ --actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 \ --conditions Field=path-pattern,Values='/images/*' --rule-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee ``` Resultado: ``` { "Rules": [ { "Priority": "10", "Conditions": [ { "Field": "path-pattern", "Values": [ "/images/*" ] } ], "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee", "IsDefault": false, "Actions": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", "Type": "forward" } ] } ] } ``` + Para ver detalhes da API, consulte [ModifyRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/modify-rule.html) na *Referência de comandos da AWS CLI*. ### `modify-target-group-attributes` O código de exemplo a seguir mostra como usar `modify-target-group-attributes`. **AWS CLI** **Modificar o tempo limite de atraso do cancelamento de registro** Este exemplo define o tempo limite do atraso de cancelamento de registro para o valor especificado para o grupo de destino especificado. Comando: ``` aws elbv2 modify-target-group-attributes --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 --attributes Key=deregistration_delay.timeout_seconds,Value=600 ``` Resultado: ``` { "Attributes": [ { "Value": "false", "Key": "stickiness.enabled" }, { "Value": "600", "Key": "deregistration_delay.timeout_seconds" }, { "Value": "lb_cookie", "Key": "stickiness.type" }, { "Value": "86400", "Key": "stickiness.lb_cookie.duration_seconds" } ] } ``` + Para ver detalhes da API, consulte [ModifyTargetGroupAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/modify-target-group-attributes.html) na *Referência de comandos da AWS CLI*. ### `modify-target-group` O código de exemplo a seguir mostra como usar `modify-target-group`. **AWS CLI** **Modificar as configurações de verificação de integridade de um grupo de destino** O exemplo `modify-target-group` a seguir altera a configuração das verificações de integridade usadas para avaliar a integridade dos destinos para o grupo de destino especificado. Observe que, devido à forma como a CLI analisa as vírgulas, você deve delimitar o intervalo da opção `--matcher` com aspas simples em vez de aspas duplas. ``` aws elbv2 modify-target-group \ --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f \ --health-check-protocol HTTPS \ --health-check-port 443 \ --matcher HttpCode='200,299' ``` Resultado: ``` { "TargetGroups": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f", "TargetGroupName": "my-https-targets", "Protocol": "HTTPS", "Port": 443, "VpcId": "vpc-3ac0fb5f", "HealthCheckProtocol": "HTTPS", "HealthCheckPort": "443", "HealthCheckEnabled": true, "HealthCheckIntervalSeconds": 30, "HealthCheckTimeoutSeconds": 5, "HealthyThresholdCount": 5, "UnhealthyThresholdCount": 2, "Matcher": { "HttpCode": "200,299" }, "LoadBalancerArns": [ "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" ], "TargetType": "instance", "ProtocolVersion": "HTTP1", "IpAddressType": "ipv4" } ] } ``` Para ter mais informações, consulte [Grupos de destino](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html) no *Guia do Application Load Balancer*. + Para ver detalhes da API, consulte [ModifyTargetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/modify-target-group.html) na *Referência de comandos da AWS CLI*. ### `register-targets` O código de exemplo a seguir mostra como usar `register-targets`. **AWS CLI** **Exemplo 1: registrar destinos com um grupo de destino por ID de instância** O exemplo `register-targets` a seguir registra as instâncias especificadas com um grupo de destino. O grupo de destino deve ter um tipo de destino de `instance`. ``` aws elbv2 register-targets \ --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 \ --targets Id=i-1234567890abcdef0 Id=i-0abcdef1234567890 ``` **Exemplo 2: registrar destinos em um grupo de destino usando substituições de porta** O exemplo `register-targets` a seguir registra a instância especificada com um grupo de destino usando várias portas. Isso permite que você registre contêineres na mesma instância que os destinos no grupo de destino. ``` aws elbv2 register-targets \ --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-internal-targets/3bb63f11dfb0faf9 \ --targets Id=i-0598c7d356eba48d7,Port=80 Id=i-0598c7d356eba48d7,Port=766 ``` **Exemplo 3: registrar destinos com um grupo de destino por endereço IP** O exemplo `register-targets` a seguir registra os endereços IP especificados com um grupo de destino. O grupo de destino deve ter um tipo de destino de `ip`. ``` aws elbv2 register-targets \ --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-tcp-ip-targets/8518e899d173178f \ --targets Id=10.0.1.15 Id=10.0.1.23 ``` **Exemplo 4: registrar uma função do Lambda como um destino** O exemplo `register-targets` a seguir registra os endereços IP especificados com um grupo de destino. O grupo de destino deve ter um tipo de destino de `lambda`. O Elastic Load Balancing precisa ter permissão para invocar cada função do Lambda. ``` aws elbv2 register-targets \ --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-tcp-ip-targets/8518e899d173178f \ --targets Id=arn:aws:lambda:us-west-2:123456789012:function:my-function ``` + Para ver detalhes da API, consulte [RegisterTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/register-targets.html) na *Referência de comandos da AWS CLI*. ### `remove-listener-certificates` O código de exemplo a seguir mostra como usar `remove-listener-certificates`. **AWS CLI** **Remover um certificado de um receptor seguro** Este exemplo remove os certificados especificados do receptor seguro especificado. Comando: ``` aws elbv2 remove-listener-certificates --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 --certificates CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/5cc54884-f4a3-4072-80be-05b9ba72f705 ``` + Para ver detalhes da API, consulte [RemoveListenerCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/remove-listener-certificates.html) na *Referência de comandos da AWS CLI*. ### `remove-tags` O código de exemplo a seguir mostra como usar `remove-tags`. **AWS CLI** **Remover tags de um balanceador de carga** O exemplo `remove-tags` a seguir remove as tags `project` e `department` do balanceador de carga especificado. ``` aws elbv2 remove-tags \ --resource-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 \ --tag-keys project department ``` + Para ver detalhes da API, consulte [RemoveTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/remove-tags.html) na *Referência de comandos da AWS CLI*. ### `set-ip-address-type` O código de exemplo a seguir mostra como usar `set-ip-address-type`. **AWS CLI** **Definir o tipo de endereço de um balanceador de carga** Este exemplo define o tipo de endereço do balanceador de carga especificado como `dualstack`. As sub-redes do balanceador de carga devem conter blocos CIDR IPv6 associados. Comando: ``` aws elbv2 set-ip-address-type --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 --ip-address-type dualstack ``` Resultado: ``` { "IpAddressType": "dualstack" } ``` + Para encontrar detalhes da API, consulte [SetIpAddressType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/set-ip-address-type.html) na *Referência de comandos da AWS CLI*. ### `set-rule-priorities` O código de exemplo a seguir mostra como usar `set-rule-priorities`. **AWS CLI** **Definir a prioridade da regra** Este exemplo define a prioridade da regra especificada. Comando: ``` aws elbv2 set-rule-priorities --rule-priorities RuleArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3,Priority=5 ``` Resultado: ``` { "Rules": [ { "Priority": "5", "Conditions": [ { "Field": "path-pattern", "Values": [ "/img/*" ] } ], "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3", "IsDefault": false, "Actions": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", "Type": "forward" } ] } ] } ``` + Para ver detalhes da API, consulte [SetRulePriorities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/set-rule-priorities.html) na *Referência de comandos da AWS CLI*. ### `set-security-groups` O código de exemplo a seguir mostra como usar `set-security-groups`. **AWS CLI** **Associar um grupo de segurança a um balanceador de carga** Este exemplo associa o grupo de segurança especificado ao balanceador de carga especificado. Comando: ``` aws elbv2 set-security-groups --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 --security-groups sg-5943793c ``` Resultado: ``` { "SecurityGroupIds": [ "sg-5943793c" ] } ``` + Para ver detalhes da API, consulte [SetSecurityGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/set-security-groups.html) na *Referência de comandos da AWS CLI*. ### `set-subnets` O código de exemplo a seguir mostra como usar `set-subnets`. **AWS CLI** **Habilitar Zonas de Disponibilidade para um balanceador de carga** Este exemplo habilita a Zona de Disponibilidade da sub-rede especificada para o balanceador de carga especificado. Comando: ``` aws elbv2 set-subnets --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 --subnets subnet-8360a9e7 subnet-b7d581c0 ``` Resultado: ``` { "AvailabilityZones": [ { "SubnetId": "subnet-8360a9e7", "ZoneName": "us-west-2a" }, { "SubnetId": "subnet-b7d581c0", "ZoneName": "us-west-2b" } ] } ``` + Para ver detalhes da API, consulte [SetSubnets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/set-subnets.html) na *Referência de comandos da AWS CLI*. # Exemplos do ElastiCache usando o AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o ElastiCache. *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-tags-to-resource` O código de exemplo a seguir mostra como usar `add-tags-to-resource`. **AWS CLI** **Para adicionar tags a um recurso** O exemplo `add-tags-to-resource` a seguir adiciona até 10 tags, pares de valores-chave, a um cluster ou recurso de snapshot. ``` aws elasticache add-tags-to-resource \ --resource-name "arn:aws:elasticache:us-east-1:1234567890:cluster:my-mem-cluster" \ --tags '{"20150202":15, "ElastiCache":"Service"}' ``` Resultado: ``` { "TagList": [ { "Value": "20150202", "Key": "APIVersion" }, { "Value": "ElastiCache", "Key": "Service" } ] } ``` Para obter mais informações, consulte [Monitoramento de custos com tags de alocação de custos](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Tagging.html) no *Guia do usuário do Elasticache*. + Consulte detalhes da API em [AddTagsToResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/add-tags-to-resource.html) na *Referência de comandos da AWS CLI*. ### `authorize-cache-security-group-ingress` O código de exemplo a seguir mostra como usar `authorize-cache-security-group-ingress`. **AWS CLI** **Autorizar a entrada do grupo de segurança de cache** O exemplo `authorize-cache-security-group-ingress` a seguir permite a entrada na rede para um grupo de segurança de cache. ``` aws elasticache authorize-cache-security-group-ingress \ --cache-security-group-name "my-sec-grp" \ --ec2-security-group-name "my-ec2-sec-grp" \ --ec2-security-group-owner-id "1234567890" ``` O comando não produz saída. Para obter mais informações, consulte [Atualizações de autoatendimento no Amazon ElastiCache](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Self-Service-Updates.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [AuthorizeCacheSecurityGroupIngress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/authorize-cache-security-group-ingress.html) na *Referência de comandos da AWS CLI*. ### `batch-apply-update-action` O código de exemplo a seguir mostra como usar `batch-apply-update-action`. **AWS CLI** **Aplicar uma atualização de serviço** O exemplo `batch-apply-update-action` a seguir aplica uma atualização de serviço a um cluster Redis. ``` aws elasticache batch-apply-update-action \ --service-update-name elc-xxxxx406-xxx \ --replication-group-ids test-cluster ``` Resultado: ``` { "ProcessedUpdateActions": [ { "ReplicationGroupId": "pat-cluster", "ServiceUpdateName": "elc-xxxxx406-xxx", "UpdateActionStatus": "waiting-to-start" } ], "UnprocessedUpdateActions": [] } ``` Para obter mais informações, consulte [Atualizações de autoatendimento no Amazon ElastiCache](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Self-Service-Updates.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [BatchApplyUpdateAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/batch-apply-update-action.html) na *Referência de comandos da AWS CLI*. ### `batch-stop-update-action` O código de exemplo a seguir mostra como usar `batch-stop-update-action`. **AWS CLI** **Interromper uma atualização de serviço** O exemplo `batch-stop-update-action` a seguir aplica uma atualização de serviço a um cluster Redis. ``` aws elasticache batch-stop-update-action \ --service-update-name elc-xxxxx406-xxx \ --replication-group-ids test-cluster ``` Resultado: ``` { "ProcessedUpdateActions": [ { "ReplicationGroupId": "pat-cluster", "ServiceUpdateName": "elc-xxxxx406-xxx", "UpdateActionStatus": "stopping" } ], "UnprocessedUpdateActions": [] } ``` Para obter mais informações, consulte [Atualizações de autoatendimento no Amazon ElastiCache](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Self-Service-Updates.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [BatchStopUpdateAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/batch-stop-update-action.html) na *Referência de comandos da AWS CLI*. ### `copy-snapshot` O código de exemplo a seguir mostra como usar `copy-snapshot`. **AWS CLI** **Para copiar um snapshot** O exemplo `copy-snapshot` a seguir faz uma cópia de um snapshot existente. ``` aws elasticache copy-snapshot \ --source-snapshot-name "my-snapshot" \ --target-snapshot-name "my-snapshot-copy" ``` Resultado: ``` { "Snapshot":{ "Engine": "redis", "CacheParameterGroupName": "default.redis3.2", "VpcId": "vpc-3820329f3", "CacheClusterId": "my-redis4", "SnapshotRetentionLimit": 7, "NumCacheNodes": 1, "SnapshotName": "my-snapshot-copy", "CacheClusterCreateTime": "2016-12-21T22:24:04.955Z", "AutoMinorVersionUpgrade": true, "PreferredAvailabilityZone": "us-east-1c", "SnapshotStatus": "creating", "SnapshotSource": "manual", "SnapshotWindow": "07:00-08:00", "EngineVersion": "3.2.4", "NodeSnapshots": [ { "CacheSize": "3 MB", "SnapshotCreateTime": "2016-12-28T07:00:52Z", "CacheNodeId": "0001", "CacheNodeCreateTime": "2016-12-21T22:24:04.955Z" } ], "CacheSubnetGroupName": "default", "Port": 6379, "PreferredMaintenanceWindow": "tue:09:30-tue:10:30", "CacheNodeType": "cache.m3.large" } } ``` Para obter mais informações, consulte [Exportar um backup](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html) no *Guia do Usuário do Elasticache*. + Para ver detalhes da API, consulte [CopySnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/copy-snapshot.html) na *Referência de comandos da AWS CLI*. ### `create-cache-cluster` O código de exemplo a seguir mostra como usar `create-cache-cluster`. **AWS CLI** **Criar um cluster de cache** O exemplo `create-cache-cluster` a seguir cria um cluster de cache usando o mecanismo Redis. ``` aws elasticache create-cache-cluster \ --cache-cluster-id "cluster-test" \ --engine redis \ --cache-node-type cache.m5.large \ --num-cache-nodes 1 ``` Resultado: ``` { "CacheCluster": { "CacheClusterId": "cluster-test", "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", "CacheNodeType": "cache.m5.large", "Engine": "redis", "EngineVersion": "5.0.5", "CacheClusterStatus": "creating", "NumCacheNodes": 1, "PreferredMaintenanceWindow": "sat:13:00-sat:14:00", "PendingModifiedValues": {}, "CacheSecurityGroups": [], "CacheParameterGroup": { "CacheParameterGroupName": "default.redis5.0", "ParameterApplyStatus": "in-sync", "CacheNodeIdsToReboot": [] }, "CacheSubnetGroupName": "default", "AutoMinorVersionUpgrade": true, "SnapshotRetentionLimit": 0, "SnapshotWindow": "06:30-07:30", "TransitEncryptionEnabled": false, "AtRestEncryptionEnabled": false } } ``` Para obter mais informações, consulte [Criar um cluster](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.Create.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [CreateCacheCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/create-cache-cluster.html) na *Referência de comandos da AWS CLI*. ### `create-cache-parameter-group` O código de exemplo a seguir mostra como usar `create-cache-parameter-group`. **AWS CLI** **Criar um grupo de parâmetros de cache** O exemplo `create-cache-parameter-group` a seguir cria um novo grupo de parâmetros de cache do Amazon ElastiCache. ``` aws elasticache create-cache-parameter-group \ --cache-parameter-group-family "redis5.0" \ --cache-parameter-group-name "mygroup" \ --description "mygroup" ``` Resultado: ``` { "CacheParameterGroup": { "CacheParameterGroupName": "mygroup", "CacheParameterGroupFamily": "redis5.0", "Description": "my group" } } ``` Para obter mais informações, consulte [Criar um grupo de parâmetros](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.Creating.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [CreateCacheParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/create-cache-parameter-group.html) na *Referência de comandos da AWS CLI*. ### `create-cache-subnet-group` O código de exemplo a seguir mostra como usar `create-cache-subnet-group`. **AWS CLI** **Criar um grupo de sub-rede de cache** O exemplo `create-cache-subnet-group` a seguir cria um novo grupo de sub-redes de cache. ``` aws elasticache create-cache-subnet-group \ --cache-subnet-group-name "mygroup" \ --cache-subnet-group-description "my subnet group" \ --subnet-ids "subnet-xxxxec4f" ``` Resultado: ``` { "CacheSubnetGroup": { "CacheSubnetGroupName": "mygroup", "CacheSubnetGroupDescription": "my subnet group", "VpcId": "vpc-a3e97cdb", "Subnets": [ { "SubnetIdentifier": "subnet-xxxxec4f", "SubnetAvailabilityZone": { "Name": "us-west-2d" } } ] } } ``` Para obter mais informações, consulte [Criar um grupo de sub-redes de cache](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/VPCs.CreatingSubnetGroup.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [CreateCacheSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/create-cache-subnet-group.html) na *Referência de comandos da AWS CLI*. ### `create-global-replication-group` O código de exemplo a seguir mostra como usar `create-global-replication-group`. **AWS CLI** **Criar um grupo de replicação global** O exemplo `create-global-replication-group` a seguir cria um novo grupo de replicação global. ``` aws elasticache create-global-replication-group \ --global-replication-group-id-suffix my-global-replication-group \ --primary-replication-group-id my-primary-cluster ``` Resultado: ``` { "GlobalReplicationGroup": { "GlobalReplicationGroupId": "sgaui-my-global-replication-group", "GlobalReplicationGroupDescription": " ", "Status": "creating", "CacheNodeType": "cache.r5.large", "Engine": "redis", "EngineVersion": "5.0.6", "Members": [ { "ReplicationGroupId": "my-primary-cluster", "ReplicationGroupRegion": "us-west-2", "Role": "PRIMARY", "AutomaticFailover": "enabled", "Status": "associating" } ], "ClusterEnabled": true, "GlobalNodeGroups": [ { "GlobalNodeGroupId": "sgaui-my-global-replication-group-0001", "Slots": "0-16383" } ], "AuthTokenEnabled": false, "TransitEncryptionEnabled": false, "AtRestEncryptionEnabled": false } } ``` Para obter mais informações, consulte [Replicação entre regiões da AWS usando o datastore global](https://docs.amazonaws.cn/en_us/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [CreateGlobalReplicationGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/create-global-replication-group.html) na *Referência de comandos da AWS CLI*. ### `create-replication-group` O código de exemplo a seguir mostra como usar `create-replication-group`. **AWS CLI** **Criar um grupo de replicação** O exemplo `create-replication-group` a seguir cria um grupo de replicação do Redis (modo cluster desabilitado) ou do Redis (modo cluster habilitado). Essa operação é válida somente para o Redis. ``` aws elasticache create-replication-group \ --replication-group-id "mygroup" \ --replication-group-description "my group" \ --engine "redis" \ --cache-node-type "cache.m5.large" ``` Resultado: ``` { "ReplicationGroup": { "ReplicationGroupId": "mygroup", "Description": "my group", "Status": "creating", "PendingModifiedValues": {}, "MemberClusters": [ "mygroup-001" ], "AutomaticFailover": "disabled", "SnapshotRetentionLimit": 0, "SnapshotWindow": "06:00-07:00", "ClusterEnabled": false, "CacheNodeType": "cache.m5.large", "TransitEncryptionEnabled": false, "AtRestEncryptionEnabled": false } } ``` Para obter mais informações, consulte [Criar um grupo de Replicação Redis](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Replication.CreatingRepGroup.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [CreateReplicationGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/create-replication-group.html) na *Referência de comandos da AWS CLI*. ### `create-snapshot` O código de exemplo a seguir mostra como usar `create-snapshot`. **AWS CLI** **Para criar um snapshot** O exemplo `create-snapshot` a seguir cria um snapshot usando o mecanismo Redis. ``` aws elasticache create-snapshot \ --snapshot-name mysnapshot \ --cache-cluster-id cluster-test ``` Resultado: ``` { "Snapshot": { "SnapshotName": "mysnapshot", "CacheClusterId": "cluster-test", "SnapshotStatus": "creating", "SnapshotSource": "manual", "CacheNodeType": "cache.m5.large", "Engine": "redis", "EngineVersion": "5.0.5", "NumCacheNodes": 1, "PreferredAvailabilityZone": "us-west-2b", "CacheClusterCreateTime": "2020-03-19T03:12:01.483Z", "PreferredMaintenanceWindow": "sat:13:00-sat:14:00", "Port": 6379, "CacheParameterGroupName": "default.redis5.0", "CacheSubnetGroupName": "default", "VpcId": "vpc-a3e97cdb", "AutoMinorVersionUpgrade": true, "SnapshotRetentionLimit": 0, "SnapshotWindow": "06:30-07:30", "NodeSnapshots": [ { "CacheNodeId": "0001", "CacheSize": "", "CacheNodeCreateTime": "2020-03-19T03:12:01.483Z" } ] } } ``` Para obter mais informações, consulte [Backup e restauração do ElastiCache para Redis](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [CreateSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/create-snapshot.html) na *Referência de comandos da AWS CLI*. ### `create-user-group` O código de exemplo a seguir mostra como usar `create-user-group`. **AWS CLI** **Criar um grupo de usuários** O exemplo `create-user-group` a seguir cria um novo grupo de usuários. ``` aws elasticache create-user-group \ --user-group-id myusergroup \ --engine redis \ --user-ids default ``` Resultado: ``` { "UserGroupId": "myusergroup", "Status": "creating", "Engine": "redis", "UserIds": [ "default" ], "ReplicationGroups": [], "ARN": "arn:aws:elasticache:us-west-2:xxxxxxxxxx52:usergroup:myusergroup" } ``` Para obter mais informações, consulte [Autenticação de usuários com controle de acesso baseado em função (RBAC)](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [CreateUserGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/create-user-group.html) na *Referência de comandos da AWS CLI*. ### `create-user` O código de exemplo a seguir mostra como usar `create-user`. **AWS CLI** **Para criar um usuário** O exemplo `create-user` a seguir cria um novo usuário. ``` aws elasticache create-user \ --user-id user1 \ --user-name myUser \ --passwords mYnuUzrpAxXw2rdzx \ --engine redis \ --access-string "on ~app::* -@all +@read" ``` Resultado: ``` { "UserId": "user2", "UserName": "myUser", "Status": "active", "Engine": "redis", "AccessString": "on ~app::* -@all +@read +@hash +@bitmap +@geo -setbit -bitfield -hset -hsetnx -hmset -hincrby -hincrbyfloat -hdel -bitop -geoadd -georadius -georadiusbymember", "UserGroupIds": [], "Authentication": { "Type": "password", "PasswordCount": 1 }, "ARN": "arn:aws:elasticache:us-west-2:xxxxxxxxxx52:user:user2" } ``` Para obter mais informações, consulte [Autenticação de usuários com controle de acesso baseado em função (RBAC)](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html) no *Guia do usuário do Elasticache*. + Consulte detalhes da API em [CreateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/create-user.html) na *Referência de comandos da AWS CLI*. ### `decrease-node-groups-in-global-replication-group` O código de exemplo a seguir mostra como usar `decrease-node-groups-in-global-replication-group`. **AWS CLI** **Diminuir o número de grupos de nós em um grupo de replicação global** O `decrease-node-groups-in-global-replication-group` a seguir diminui a contagem de grupos de nós usando o mecanismo Redis. ``` aws elasticache decrease-node-groups-in-global-replication-group \ --global-replication-group-id sgaui-test \ --node-group-count 1 \ --apply-immediately \ --global-node-groups-to-retain sgaui-test-0003 ``` Resultado: ``` { "GlobalReplicationGroup": { "GlobalReplicationGroupId": "sgaui-test", "GlobalReplicationGroupDescription": "test", "Status": "modifying", "CacheNodeType": "cache.r5.large", "Engine": "redis", "EngineVersion": "5.0.6", "Members": [ { "ReplicationGroupId": "test-2", "ReplicationGroupRegion": "us-east-1", "Role": "SECONDARY", "AutomaticFailover": "enabled", "Status": "associated" }, { "ReplicationGroupId": "test-1", "ReplicationGroupRegion": "us-west-2", "Role": "PRIMARY", "AutomaticFailover": "enabled", "Status": "associated" } ], "ClusterEnabled": true, "GlobalNodeGroups": [ { "GlobalNodeGroupId": "sgaui-test-0001", "Slots": "0-449,1816-5461" }, { "GlobalNodeGroupId": "sgaui-test-0002", "Slots": "6827-10922" }, { "GlobalNodeGroupId": "sgaui-test-0003", "Slots": "10923-14052,15418-16383" }, { "GlobalNodeGroupId": "sgaui-test-0004", "Slots": "450-1815,5462-6826,14053-15417" } ], "AuthTokenEnabled": false, "TransitEncryptionEnabled": false, "AtRestEncryptionEnabled": false } } ``` Para obter mais informações, consulte [Replicação entre Regiões da AWS usando o datastore global](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [DecreaseNodeGroupsInGlobalReplicationGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/decrease-node-groups-in-global-replication-group.html) na *Referência de comandos da AWS CLI*. ### `decrease-replica-count` O código de exemplo a seguir mostra como usar `decrease-replica-count`. **AWS CLI** **Diminuir a contagem de réplicas** O exemplo `decrease-replica-count` a seguir diminui dinamicamente o número de réplicas em um grupo de replicação Redis (modo de cluster desabilitado) ou o número de nós de réplica em um ou mais grupos de nós (fragmentos) de um grupo de replicação Redis (modo de cluster habilitado). Essa operação é executada sem tempo de inatividade do cluster. ``` aws elasticache decrease-replica-count \ --replication-group-id my-cluster \ --apply-immediately \ --new-replica-count 2 ``` Resultado: ``` { "ReplicationGroup": { "ReplicationGroupId": "my-cluster", "Description": " ", "Status": "modifying", "PendingModifiedValues": {}, "MemberClusters": [ "myrepliace", "my-cluster-001", "my-cluster-002", "my-cluster-003" ], "NodeGroups": [ { "NodeGroupId": "0001", "Status": "modifying", "PrimaryEndpoint": { "Address": "my-cluster.xxxxx.ng.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "ReaderEndpoint": { "Address": "my-cluster-ro.xxxxx.ng.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "NodeGroupMembers": [ { "CacheClusterId": "myrepliace", "CacheNodeId": "0001", "ReadEndpoint": { "Address": "myrepliace.xxxxx.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "PreferredAvailabilityZone": "us-west-2a", "CurrentRole": "replica" }, { "CacheClusterId": "my-cluster-001", "CacheNodeId": "0001", "ReadEndpoint": { "Address": "my-cluster-001.xxxxx.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "PreferredAvailabilityZone": "us-west-2a", "CurrentRole": "primary" }, { "CacheClusterId": "my-cluster-002", "CacheNodeId": "0001", "ReadEndpoint": { "Address": "my-cluster-002.xxxxx.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "PreferredAvailabilityZone": "us-west-2a", "CurrentRole": "replica" }, { "CacheClusterId": "my-cluster-003", "CacheNodeId": "0001", "ReadEndpoint": { "Address": "my-cluster-003.xxxxx.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "PreferredAvailabilityZone": "us-west-2a", "CurrentRole": "replica" } ] } ], "AutomaticFailover": "disabled", "SnapshotRetentionLimit": 0, "SnapshotWindow": "07:30-08:30", "ClusterEnabled": false, "CacheNodeType": "cache.r5.xlarge", "TransitEncryptionEnabled": false, "AtRestEncryptionEnabled": false } } ``` Para obter mais informações, consulte [Alterar o número de réplicas](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/increase-decrease-replica-count.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [DecreaseReplicaCount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/decrease-replica-count.html) na *Referência de comandos da AWS CLI*. ### `delete-cache-cluster` O código de exemplo a seguir mostra como usar `delete-cache-cluster`. **AWS CLI** **Excluir um cluster de cache** O exemplo `delete-cache-cluster` a seguir exclui o cluster provisionado anteriormente especificado. O comando exclui todos os nós de cache associados, os endpoints dos nós e o próprio cluster. Quando você recebe uma resposta bem-sucedida dessa operação, o Amazon ElastiCache imediatamente começa a excluir o cluster; você não pode cancelar ou reverter essa operação. Essa operação não é válida para o seguinte: Clusters Redis (modo de cluster ativado) Um cluster que é a última réplica de leitura de um grupo de replicação Um grupo de nós (fragmento) que tem o modo Multi-AZ ativado Um cluster de um grupo de replicação Redis (modo de cluster ativado) Um cluster que não está no estado disponível ``` aws elasticache delete-cache-cluster \ --cache-cluster-id "my-cluster-002" ``` Resultado: ``` { "CacheCluster": { "CacheClusterId": "my-cluster-002", "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", "CacheNodeType": "cache.r5.xlarge", "Engine": "redis", "EngineVersion": "5.0.5", "CacheClusterStatus": "deleting", "NumCacheNodes": 1, "PreferredAvailabilityZone": "us-west-2a", "CacheClusterCreateTime": "2019-11-26T03:35:04.546Z", "PreferredMaintenanceWindow": "mon:04:05-mon:05:05", "PendingModifiedValues": {}, "NotificationConfiguration": { "TopicArn": "arn:aws:sns:us-west-x:xxxxxxx4152:My_Topic", "TopicStatus": "active" }, "CacheSecurityGroups": [], "CacheParameterGroup": { "CacheParameterGroupName": "mygroup", "ParameterApplyStatus": "in-sync", "CacheNodeIdsToReboot": [] }, "CacheSubnetGroupName": "kxkxk", "AutoMinorVersionUpgrade": true, "SecurityGroups": [ { "SecurityGroupId": "sg-xxxxxxxxxx9836", "Status": "active" }, { "SecurityGroupId": "sg-xxxxxxxxxxxx7b", "Status": "active" } ], "ReplicationGroupId": "my-cluster", "SnapshotRetentionLimit": 0, "SnapshotWindow": "07:30-08:30", "TransitEncryptionEnabled": false, "AtRestEncryptionEnabled": false } } ``` Para obter mais informações, consulte [Excluir um cluster](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.Delete.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [DeleteCacheCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/delete-cache-cluster.html) na *Referência de comandos da AWS CLI*. ### `delete-cache-parameter-group` O código de exemplo a seguir mostra como usar `delete-cache-parameter-group`. **AWS CLI** **Excluir um grupo de parâmetros de cache** O exemplo `delete-cache-parameter-group` a seguir exclui o grupo de parâmetros de cache especificado. Não é possível excluir um grupo de parâmetros de cache se ele estiver associado a qualquer cluster de cache. ``` aws elasticache delete-cache-parameter-group \ --cache-parameter-group-name myparamgroup ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir um grupo de parâmetros](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.Deleting.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [DeleteCacheParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/delete-cache-parameter-group.html) na *Referência de comandos da AWS CLI*. ### `delete-cache-subnet-group` O código de exemplo a seguir mostra como usar `delete-cache-subnet-group`. **AWS CLI** **Excluir um grupo de sub-redes de cache** O exemplo `delete-cache-subnet-group` a seguir exclui o grupo de sub-rede de cache especificado. Não é possível excluir um grupo de sub-rede de cache se ele estiver associado a qualquer cluster. ``` aws elasticache delete-cache-subnet-group \ --cache-subnet-group-name "mygroup" ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir um grupo de sub-rede](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.Deleting.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [DeleteCacheSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/delete-cache-subnet-group.html) na *Referência de comandos da AWS CLI*. ### `delete-global-replication-group` O código de exemplo a seguir mostra como usar `delete-global-replication-group`. **AWS CLI** **Excluir um grupo de replicação global** O exemplo `delete-global-replication-group` a seguir exclui um novo grupo de replicação global. ``` aws elasticache delete-global-replication-group \ --global-replication-group-id my-global-replication-group \ --retain-primary-replication-group ``` Resultado: ``` { "GlobalReplicationGroup": { "GlobalReplicationGroupId": "sgaui-my-grg", "GlobalReplicationGroupDescription": "my-grg", "Status": "deleting", "CacheNodeType": "cache.r5.large", "Engine": "redis", "EngineVersion": "5.0.6", "Members": [ { "ReplicationGroupId": "my-cluster-grg", "ReplicationGroupRegion": "us-west-2", "Role": "PRIMARY", "AutomaticFailover": "enabled", "Status": "associated" } ], "ClusterEnabled": false, "AuthTokenEnabled": false, "TransitEncryptionEnabled": false, "AtRestEncryptionEnabled": false } } ``` Para obter mais informações, consulte [Replicação entre Regiões da AWS usando o datastore global](https://docs.amazonaws.cn/en_us/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [DeleteGlobalReplicationGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/delete-global-replication-group.html) na *Referência de comandos da AWS CLI*. ### `delete-replication-group` O código de exemplo a seguir mostra como usar `delete-replication-group`. **AWS CLI** **Excluir um grupo de replicação** O exemplo `delete-replication-group` a seguir exclui um grupo de replicação existente. Por padrão, essa operação exclui todo o grupo de replicação, incluindo o primário/primários e todas as réplicas de leitura. Se o grupo de replicação tiver somente um primário, você poderá, opcionalmente, excluir somente as réplicas de leitura e, ao mesmo tempo, reter o primário ao configurar retainPrimaryCluster=true. Quando você recebe uma resposta bem-sucedida dessa operação, o Amazon ElastiCache imediatamente começa a excluir os recursos selecionados; você não poderá cancelar ou reverter essa operação. Válido somente para Redis. ``` aws elasticache delete-replication-group \ --replication-group-id "mygroup" ``` Resultado: ``` { "ReplicationGroup": { "ReplicationGroupId": "mygroup", "Description": "my group", "Status": "deleting", "PendingModifiedValues": {}, "AutomaticFailover": "disabled", "SnapshotRetentionLimit": 0, "SnapshotWindow": "06:00-07:00", "TransitEncryptionEnabled": false, "AtRestEncryptionEnabled": false } } ``` + Para ver detalhes da API, consulte [DeleteReplicationGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/delete-replication-group.html) na *Referência de comandos da AWS CLI*. ### `delete-snapshot` O código de exemplo a seguir mostra como usar `delete-snapshot`. **AWS CLI** **Para excluir um snapshot** O exemplo `delete-snapshot` a seguir excluiu um snapshot usando o mecanismo Redis. ``` aws elasticache delete-snapshot \ --snapshot-name mysnapshot ``` Resultado: ``` { "Snapshot": { "SnapshotName": "my-cluster-snapshot", "ReplicationGroupId": "mycluster", "ReplicationGroupDescription": "mycluster", "SnapshotStatus": "deleting", "SnapshotSource": "manual", "CacheNodeType": "cache.r5.xlarge", "Engine": "redis", "EngineVersion": "5.0.5", "PreferredMaintenanceWindow": "thu:12:00-thu:13:00", "TopicArn": "arn:aws:sns:us-west-2:xxxxxxxxxxxxx152:My_Topic", "Port": 6379, "CacheParameterGroupName": "default.redis5.0.cluster.on", "CacheSubnetGroupName": "default", "VpcId": "vpc-a3e97cdb", "AutoMinorVersionUpgrade": true, "SnapshotRetentionLimit": 1, "SnapshotWindow": "13:00-14:00", "NumNodeGroups": 4, "AutomaticFailover": "enabled", "NodeSnapshots": [ { "CacheClusterId": "mycluster-0002-003", "NodeGroupId": "0002", "CacheNodeId": "0001", "CacheSize": "6 MB", "CacheNodeCreateTime": "2020-06-18T00:05:44.719000+00:00", "SnapshotCreateTime": "2020-06-25T20:34:30+00:00" }, { "CacheClusterId": "mycluster-0003-003", "NodeGroupId": "0003", "CacheNodeId": "0001", "CacheSize": "6 MB", "CacheNodeCreateTime": "2019-12-05T19:13:15.912000+00:00", "SnapshotCreateTime": "2020-06-25T20:34:30+00:00" }, { "CacheClusterId": "mycluster-0004-002", "NodeGroupId": "0004", "CacheNodeId": "0001", "CacheSize": "6 MB", "CacheNodeCreateTime": "2019-12-09T19:44:34.324000+00:00", "SnapshotCreateTime": "2020-06-25T20:34:30+00:00" }, { "CacheClusterId": "mycluster-0005-003", "NodeGroupId": "0005", "CacheNodeId": "0001", "CacheSize": "6 MB", "CacheNodeCreateTime": "2020-06-18T00:05:44.775000+00:00", "SnapshotCreateTime": "2020-06-25T20:34:30+00:00" } ] } } ``` Para obter mais informações, consulte [Backup e restauração do ElastiCache para Redis](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups.html) no *Guia do usuário do Elasticache*. + Consulte detalhes da API em [DeleteSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/delete-snapshot.html) na *Referência de comandos da AWS CLI*. ### `delete-user-group` O código de exemplo a seguir mostra como usar `delete-user-group`. **AWS CLI** **Excluir um grupo de usuários** O exemplo `delete-user-group` a seguir exclui um grupo de usuários. ``` aws elasticache delete-user-group \ --user-group-id myusergroup ``` Resultado: ``` { "UserGroupId": "myusergroup", "Status": "deleting", "Engine": "redis", "UserIds": [ "default" ], "ReplicationGroups": [], "ARN": "arn:aws:elasticache:us-west-2:xxxxxxxxxx52:usergroup:myusergroup" } ``` Para obter mais informações, consulte [Autenticação de usuários com controle de acesso baseado em função (RBAC)](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [DeleteUserGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/delete-user-group.html) na *Referência de comandos da AWS CLI*. ### `delete-user` O código de exemplo a seguir mostra como usar `delete-user`. **AWS CLI** **Para excluir um usuário** O exemplo `delete-user` a seguir exclui um usuário. ``` aws elasticache delete-user \ --user-id user2 ``` Resultado: ``` { "UserId": "user1", "UserName": "myUser", "Status": "deleting", "Engine": "redis", "AccessString": "on ~* +@all", "UserGroupIds": [ "myusergroup" ], "Authentication": { "Type": "password", "PasswordCount": 1 }, "ARN": "arn:aws:elasticache:us-west-2:xxxxxxxxxx52:user:user1" } ``` Para obter mais informações, consulte [Autenticação de usuários com controle de acesso baseado em função (RBAC)](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html) no *Guia do usuário do Elasticache*. + Consulte detalhes da API em [DeleteUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/delete-user.html) na *Referência de comandos da AWS CLI*. ### `describe-cache-clusters` O código de exemplo a seguir mostra como usar `describe-cache-clusters`. **AWS CLI** **Descrever um cluster de cache** O exemplo `describe-cache-clusters` a seguir descreve um cluster de cache. ``` aws elasticache describe-cache-clusters ``` Resultado: ``` { "CacheClusters": [ { "CacheClusterId": "my-cluster-003", "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", "CacheNodeType": "cache.r5.large", "Engine": "redis", "EngineVersion": "5.0.5", "CacheClusterStatus": "available", "NumCacheNodes": 1, "PreferredAvailabilityZone": "us-west-2a", "CacheClusterCreateTime": "2019-11-26T01:22:52.396Z", "PreferredMaintenanceWindow": "mon:17:30-mon:18:30", "PendingModifiedValues": {}, "NotificationConfiguration": { "TopicArn": "arn:aws:sns:us-west-2:xxxxxxxxxxx152:My_Topic", "TopicStatus": "active" }, "CacheSecurityGroups": [], "CacheParameterGroup": { "CacheParameterGroupName": "default.redis5.0", "ParameterApplyStatus": "in-sync", "CacheNodeIdsToReboot": [] }, "CacheSubnetGroupName": "kxkxk", "AutoMinorVersionUpgrade": true, "SecurityGroups": [ { "SecurityGroupId": "sg-xxxxxd7b", "Status": "active" } ], "ReplicationGroupId": "my-cluster", "SnapshotRetentionLimit": 0, "SnapshotWindow": "06:30-07:30", "AuthTokenEnabled": false, "TransitEncryptionEnabled": false, "AtRestEncryptionEnabled": false, "ARN": "arn:aws:elasticache:us-west-2:xxxxxxxxxxx152:cluster:my-cache-cluster", "ReplicationGroupLogDeliveryEnabled": false, "LogDeliveryConfigurations": [ { "LogType": "slow-log", "DestinationType": "cloudwatch-logs", "DestinationDetails": { "CloudWatchLogsDetails": { "LogGroup": "test-log" } }, "LogFormat": "text", "Status": "active" } ] } ] } ``` Para obter mais informações, consulte [Gerenciar clusters](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [DescribeCacheClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-cache-clusters.html) na *Referência de comandos da AWS CLI*. ### `describe-cache-engine-versions` O código de exemplo a seguir mostra como usar `describe-cache-engine-versions`. **AWS CLI** **Descrever uma versão do mecanismo de cache** O exemplo `describe-cache-engine-versions` a seguir retorna uma lista dos mecanismos de cache disponíveis e suas versões. ``` aws elasticache describe-cache-engine-versions \ --engine "Redis" ``` Resultado: ``` { "CacheEngineVersions": [ { "Engine": "redis", "EngineVersion": "2.6.13", "CacheParameterGroupFamily": "redis2.6", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 2.6.13" }, { "Engine": "redis", "EngineVersion": "2.8.19", "CacheParameterGroupFamily": "redis2.8", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 2.8.19" }, { "Engine": "redis", "EngineVersion": "2.8.21", "CacheParameterGroupFamily": "redis2.8", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 2.8.21" }, { "Engine": "redis", "EngineVersion": "2.8.22", "CacheParameterGroupFamily": "redis2.8", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 2.8.22" }, { "Engine": "redis", "EngineVersion": "2.8.23", "CacheParameterGroupFamily": "redis2.8", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 2.8.23" }, { "Engine": "redis", "EngineVersion": "2.8.24", "CacheParameterGroupFamily": "redis2.8", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 2.8.24" }, { "Engine": "redis", "EngineVersion": "2.8.6", "CacheParameterGroupFamily": "redis2.8", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 2.8.6" }, { "Engine": "redis", "EngineVersion": "3.2.10", "CacheParameterGroupFamily": "redis3.2", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 3.2.10" }, { "Engine": "redis", "EngineVersion": "3.2.4", "CacheParameterGroupFamily": "redis3.2", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 3.2.4" }, { "Engine": "redis", "EngineVersion": "3.2.6", "CacheParameterGroupFamily": "redis3.2", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 3.2.6" }, { "Engine": "redis", "EngineVersion": "4.0.10", "CacheParameterGroupFamily": "redis4.0", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 4.0.10" }, { "Engine": "redis", "EngineVersion": "5.0.0", "CacheParameterGroupFamily": "redis5.0", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 5.0.0" }, { "Engine": "redis", "EngineVersion": "5.0.3", "CacheParameterGroupFamily": "redis5.0", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 5.0.3" }, { "Engine": "redis", "EngineVersion": "5.0.4", "CacheParameterGroupFamily": "redis5.0", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 5.0.4" }, { "Engine": "redis", "EngineVersion": "5.0.5", "CacheParameterGroupFamily": "redis5.0", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 5.0.5" } ] } ``` + Para ver detalhes da API, consulte [DescribeCacheEngineVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-cache-engine-versions.html) na *Referência de comandos da AWS CLI*. ### `describe-cache-parameter-groups` O código de exemplo a seguir mostra como usar `describe-cache-parameter-groups`. **AWS CLI** **Descrever um grupo de parâmetros de cache** O exemplo `describe-cache-parameter-groups` a seguir retorna uma lista de descrições de grupo de parâmetros de cache. ``` aws elasticache describe-cache-parameter-groups \ --cache-parameter-group-name "mygroup" ``` Resultado: ``` { "CacheParameterGroups": [ { "CacheParameterGroupName": "mygroup", "CacheParameterGroupFamily": "redis5.0", "Description": " " } ] } ``` Para obter mais informações, consulte [Configurar parâmetros do mecanismo usando grupos de parâmetros](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/ParameterGroups.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [DescribeCacheParameterGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-cache-parameter-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-cache-parameters` O código de exemplo a seguir mostra como usar `describe-cache-parameters`. **AWS CLI** **Descrever os parâmetros do cache** O exemplo ''describe-cache-parameters'' a seguir retorna a lista de parâmetros detalhada para o grupo de parâmetros de cache especificado. ``` aws elasticache describe-cache-parameters \ --cache-parameter-group-name "myparamgroup" ``` Resultado: ``` { "Parameters": [ { "ParameterName": "activedefrag", "ParameterValue": "yes", "Description": "Enabled active memory defragmentation", "Source": "user", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "active-defrag-cycle-max", "ParameterValue": "75", "Description": "Maximal effort for defrag in CPU percentage", "Source": "user", "DataType": "integer", "AllowedValues": "1-75", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "active-defrag-cycle-min", "ParameterValue": "5", "Description": "Minimal effort for defrag in CPU percentage", "Source": "user", "DataType": "integer", "AllowedValues": "1-75", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "active-defrag-ignore-bytes", "ParameterValue": "104857600", "Description": "Minimum amount of fragmentation waste to start active defrag", "Source": "user", "DataType": "integer", "AllowedValues": "1048576-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "active-defrag-max-scan-fields", "ParameterValue": "1000", "Description": "Maximum number of set/hash/zset/list fields that will be processed from the main dictionary scan", "Source": "user", "DataType": "integer", "AllowedValues": "1-1000000", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "active-defrag-threshold-lower", "ParameterValue": "10", "Description": "Minimum percentage of fragmentation to start active defrag", "Source": "user", "DataType": "integer", "AllowedValues": "1-100", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "active-defrag-threshold-upper", "ParameterValue": "100", "Description": "Maximum percentage of fragmentation at which we use maximum effort", "Source": "user", "DataType": "integer", "AllowedValues": "1-100", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "activerehashing", "ParameterValue": "yes", "Description": "Apply rehashing or not.", "Source": "user", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "requires-reboot" }, { "ParameterName": "appendfsync", "ParameterValue": "everysec", "Description": "fsync policy for AOF persistence", "Source": "system", "DataType": "string", "AllowedValues": "always,everysec,no", "IsModifiable": false, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "appendonly", "ParameterValue": "no", "Description": "Enable Redis persistence.", "Source": "system", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": false, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "client-output-buffer-limit-normal-hard-limit", "ParameterValue": "0", "Description": "Normal client output buffer hard limit in bytes.", "Source": "user", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "client-output-buffer-limit-normal-soft-limit", "ParameterValue": "0", "Description": "Normal client output buffer soft limit in bytes.", "Source": "user", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "client-output-buffer-limit-normal-soft-seconds", "ParameterValue": "0", "Description": "Normal client output buffer soft limit in seconds.", "Source": "user", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "client-output-buffer-limit-pubsub-hard-limit", "ParameterValue": "33554432", "Description": "Pubsub client output buffer hard limit in bytes.", "Source": "user", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "client-output-buffer-limit-pubsub-soft-limit", "ParameterValue": "8388608", "Description": "Pubsub client output buffer soft limit in bytes.", "Source": "user", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "client-output-buffer-limit-pubsub-soft-seconds", "ParameterValue": "60", "Description": "Pubsub client output buffer soft limit in seconds.", "Source": "user", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "client-output-buffer-limit-replica-soft-seconds", "ParameterValue": "60", "Description": "Replica client output buffer soft limit in seconds.", "Source": "system", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": false, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "client-query-buffer-limit", "ParameterValue": "1073741824", "Description": "Max size of a single client query buffer", "Source": "user", "DataType": "integer", "AllowedValues": "1048576-1073741824", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "close-on-replica-write", "ParameterValue": "yes", "Description": "If enabled, clients who attempt to write to a read-only replica will be disconnected. Applicable to 2.8.23 and higher.", "Source": "user", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "cluster-enabled", "ParameterValue": "no", "Description": "Enable cluster mode", "Source": "user", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "requires-reboot" }, { "ParameterName": "cluster-require-full-coverage", "ParameterValue": "no", "Description": "Whether cluster becomes unavailable if one or more slots are not covered", "Source": "user", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "databases", "ParameterValue": "16", "Description": "Set the number of databases.", "Source": "user", "DataType": "integer", "AllowedValues": "1-1200000", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "requires-reboot" }, { "ParameterName": "hash-max-ziplist-entries", "ParameterValue": "512", "Description": "The maximum number of hash entries in order for the dataset to be compressed.", "Source": "user", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "hash-max-ziplist-value", "ParameterValue": "64", "Description": "The threshold of biggest hash entries in order for the dataset to be compressed.", "Source": "user", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "hll-sparse-max-bytes", "ParameterValue": "3000", "Description": "HyperLogLog sparse representation bytes limit", "Source": "user", "DataType": "integer", "AllowedValues": "1-16000", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "lazyfree-lazy-eviction", "ParameterValue": "no", "Description": "Perform an asynchronous delete on evictions", "Source": "user", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "lazyfree-lazy-expire", "ParameterValue": "no", "Description": "Perform an asynchronous delete on expired keys", "Source": "user", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "lazyfree-lazy-server-del", "ParameterValue": "no", "Description": "Perform an asynchronous delete on key updates", "Source": "user", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "lfu-decay-time", "ParameterValue": "1", "Description": "The amount of time in minutes to decrement the key counter for LFU eviction policy", "Source": "user", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "lfu-log-factor", "ParameterValue": "10", "Description": "The log factor for incrementing key counter for LFU eviction policy", "Source": "user", "DataType": "integer", "AllowedValues": "1-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "list-compress-depth", "ParameterValue": "0", "Description": "Number of quicklist ziplist nodes from each side of the list to exclude from compression. The head and tail of the list are always uncompressed for fast push/pop operations", "Source": "user", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "list-max-ziplist-size", "ParameterValue": "-2", "Description": "The number of entries allowed per internal list node can be specified as a fixed maximum size or a maximum number of elements", "Source": "system", "DataType": "integer", "AllowedValues": "-5,-4,-3,-2,-1,1-", "IsModifiable": false, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "lua-replicate-commands", "ParameterValue": "yes", "Description": "Always enable Lua effect replication or not", "Source": "user", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "lua-time-limit", "ParameterValue": "5000", "Description": "Max execution time of a Lua script in milliseconds. 0 for unlimited execution without warnings.", "Source": "system", "DataType": "integer", "AllowedValues": "5000", "IsModifiable": false, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "maxclients", "ParameterValue": "65000", "Description": "The maximum number of Redis clients.", "Source": "system", "DataType": "integer", "AllowedValues": "1-65000", "IsModifiable": false, "MinimumEngineVersion": "5.0.0", "ChangeType": "requires-reboot" }, { "ParameterName": "maxmemory-policy", "ParameterValue": "volatile-lru", "Description": "Max memory policy.", "Source": "user", "DataType": "string", "AllowedValues": "volatile-lru,allkeys-lru,volatile-lfu,allkeys-lfu,volatile-random,allkeys-random,volatile-ttl,noeviction", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "maxmemory-samples", "ParameterValue": "3", "Description": "Max memory samples.", "Source": "user", "DataType": "integer", "AllowedValues": "1-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "min-replicas-max-lag", "ParameterValue": "10", "Description": "The maximum amount of replica lag in seconds beyond which the master would stop taking writes. A value of 0 means the master always takes writes.", "Source": "user", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "min-replicas-to-write", "ParameterValue": "0", "Description": "The minimum number of replicas that must be present with lag no greater than min-replicas-max-lag for master to take writes. Setting this to 0 means the master always takes writes.", "Source": "user", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "notify-keyspace-events", "Description": "The keyspace events for Redis to notify Pub/Sub clients about. By default all notifications are disabled", "Source": "user", "DataType": "string", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "proto-max-bulk-len", "ParameterValue": "536870912", "Description": "Max size of a single element request", "Source": "user", "DataType": "integer", "AllowedValues": "1048576-536870912", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "rename-commands", "ParameterValue": "", "Description": "Redis commands that can be dynamically renamed by the customer", "Source": "user", "DataType": "string", "AllowedValues": "APPEND,BITCOUNT,BITFIELD,BITOP,BITPOS,BLPOP,BRPOP,BRPOPLPUSH,BZPOPMIN,BZPOPMAX,CLIENT,COMMAND,DBSIZE,DECR,DECRBY,DEL,DISCARD,DUMP,ECHO,EVAL,EVALSHA,EXEC,EXISTS,EXPIRE,EXPIREAT,FLUSHALL,FLUSHDB,GEOADD,GEOHASH,GEOPOS,GEODIST,GEORADIUS,GEORADIUSBYMEMBER,GET,GETBIT,GETRANGE,GETSET,HDEL,HEXISTS,HGET,HGETALL,HINCRBY,HINCRBYFLOAT,HKEYS,HLEN,HMGET,HMSET,HSET,HSETNX,HSTRLEN,HVALS,INCR,INCRBY,INCRBYFLOAT,INFO,KEYS,LASTSAVE,LINDEX,LINSERT,LLEN,LPOP,LPUSH,LPUSHX,LRANGE,LREM,LSET,LTRIM,MEMORY,MGET,MONITOR,MOVE,MSET,MSETNX,MULTI,OBJECT,PERSIST,PEXPIRE,PEXPIREAT,PFADD,PFCOUNT,PFMERGE,PING,PSETEX,PSUBSCRIBE,PUBSUB,PTTL,PUBLISH,PUNSUBSCRIBE,RANDOMKEY,READONLY,READWRITE,RENAME,RENAMENX,RESTORE,ROLE,RPOP,RPOPLPUSH,RPUSH,RPUSHX,SADD,SCARD,SCRIPT,SDIFF,SDIFFSTORE,SELECT,SET,SETBIT,SETEX,SETNX,SETRANGE,SINTER,SINTERSTORE,SISMEMBER,SLOWLOG,SMEMBERS,SMOVE,SORT,SPOP,SRANDMEMBER,SREM,STRLEN,SUBSCRIBE,SUNION,SUNIONSTORE,SWAPDB,TIME,TOUCH,TTL,TYPE,UNSUBSCRIBE,UNLINK,UNWATCH,WAIT,WATCH,ZADD,ZCARD,ZCOUNT,ZINCRBY,ZINTERSTORE,ZLEXCOUNT,ZPOPMAX,ZPOPMIN,ZRANGE,ZRANGEBYLEX,ZREVRANGEBYLEX,ZRANGEBYSCORE,ZRANK,ZREM,ZREMRANGEBYLEX,ZREMRANGEBYRANK,ZREMRANGEBYSCORE,ZREVRANGE,ZREVRANGEBYSCORE,ZREVRANK,ZSCORE,ZUNIONSTORE,SCAN,SSCAN,HSCAN,ZSCAN,XINFO,XADD,XTRIM,XDEL,XRANGE,XREVRANGE,XLEN,XREAD,XGROUP,XREADGROUP,XACK,XCLAIM,XPENDING,GEORADIUS_RO,GEORADIUSBYMEMBER_RO,LOLWUT,XSETID,SUBSTR", "IsModifiable": true, "MinimumEngineVersion": "5.0.3", "ChangeType": "immediate" }, { "ParameterName": "repl-backlog-size", "ParameterValue": "1048576", "Description": "The replication backlog size in bytes for PSYNC. This is the size of the buffer which accumulates slave data when slave is disconnected for some time, so that when slave reconnects again, only transfer the portion of data which the slave missed. Minimum value is 16K.", "Source": "user", "DataType": "integer", "AllowedValues": "16384-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "repl-backlog-ttl", "ParameterValue": "3600", "Description": "The amount of time in seconds after the master no longer have any slaves connected for the master to free the replication backlog. A value of 0 means to never release the backlog.", "Source": "user", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "replica-allow-chaining", "ParameterValue": "no", "Description": "Configures if chaining of replicas is allowed", "Source": "system", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": false, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "replica-ignore-maxmemory", "ParameterValue": "yes", "Description": "Determines if replica ignores maxmemory setting by not evicting items independent from the master", "Source": "system", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": false, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "replica-lazy-flush", "ParameterValue": "no", "Description": "Perform an asynchronous flushDB during replica sync", "Source": "system", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": false, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "reserved-memory-percent", "ParameterValue": "25", "Description": "The percent of memory reserved for non-cache memory usage. You may want to increase this parameter for nodes with read replicas, AOF enabled, etc, to reduce swap usage.", "Source": "user", "DataType": "integer", "AllowedValues": "0-100", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "set-max-intset-entries", "ParameterValue": "512", "Description": "The limit in the size of the set in order for the dataset to be compressed.", "Source": "user", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "slowlog-log-slower-than", "ParameterValue": "10000", "Description": "The execution time, in microseconds, to exceed in order for the command to get logged. Note that a negative number disables the slow log, while a value of zero forces the logging of every command.", "Source": "user", "DataType": "integer", "AllowedValues": "-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "slowlog-max-len", "ParameterValue": "128", "Description": "The length of the slow log. There is no limit to this length. Just be aware that it will consume memory. You can reclaim memory used by the slow log with SLOWLOG RESET.", "Source": "user", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "stream-node-max-bytes", "ParameterValue": "4096", "Description": "The maximum size of a single node in a stream in bytes", "Source": "user", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "stream-node-max-entries", "ParameterValue": "100", "Description": "The maximum number of items a single node in a stream can contain", "Source": "user", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "tcp-keepalive", "ParameterValue": "300", "Description": "If non-zero, send ACKs every given number of seconds.", "Source": "user", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "timeout", "ParameterValue": "0", "Description": "Close connection if client is idle for a given number of seconds, or never if 0.", "Source": "user", "DataType": "integer", "AllowedValues": "0,20-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "zset-max-ziplist-entries", "ParameterValue": "128", "Description": "The maximum number of sorted set entries in order for the dataset to be compressed.", "Source": "user", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "zset-max-ziplist-value", "ParameterValue": "64", "Description": "The threshold of biggest sorted set entries in order for the dataset to be compressed.", "Source": "user", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" } ] } ``` Para obter mais informações, consulte [Gerenciar parâmetros](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/ParameterGroups.Management.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [DescribeCacheParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-cache-parameters.html) na *Referência de comandos da AWS CLI*. ### `describe-cache-subnet-groups` O código de exemplo a seguir mostra como usar `describe-cache-subnet-groups`. **AWS CLI** **Descrever grupos de sub-redes de cache** O exemplo `describe-cache-subnet-groups` a seguir retorna uma lista de grupos de sub-rede. ``` aws elasticache describe-cache-subnet-groups ``` Resultado: ``` { "CacheSubnetGroups": [ { "CacheSubnetGroupName": "default", "CacheSubnetGroupDescription": "Default CacheSubnetGroup", "VpcId": "vpc-a3e97cdb", "Subnets": [ { "SubnetIdentifier": "subnet-8d4bacf5", "SubnetAvailabilityZone": { "Name": "us-west-2b" } }, { "SubnetIdentifier": "subnet-dde21380", "SubnetAvailabilityZone": { "Name": "us-west-2c" } }, { "SubnetIdentifier": "subnet-6485ec4f", "SubnetAvailabilityZone": { "Name": "us-west-2d" } }, { "SubnetIdentifier": "subnet-b4ebebff", "SubnetAvailabilityZone": { "Name": "us-west-2a" } } ] }, { "CacheSubnetGroupName": "kxkxk", "CacheSubnetGroupDescription": "mygroup", "VpcId": "vpc-a3e97cdb", "Subnets": [ { "SubnetIdentifier": "subnet-b4ebebff", "SubnetAvailabilityZone": { "Name": "us-west-2a" } } ] }, { "CacheSubnetGroupName": "test", "CacheSubnetGroupDescription": "test", "VpcId": "vpc-a3e97cdb", "Subnets": [ { "SubnetIdentifier": "subnet-b4ebebff", "SubnetAvailabilityZone": { "Name": "us-west-2a" } } ] } ] } ``` Para obter mais informações, consulte [Sub-redes e grupos de sub-redes](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.html) no *Guia do usuário do Elasticache* ou [Sub-redes e grupos de sub-redes](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/SubnetGroups.html) no *Guia do usuário do ElastiCache para Memcached*. + Para ver detalhes da API, consulte [DescribeCacheSubnetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-cache-subnet-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-engine-default-parameters` O código de exemplo a seguir mostra como usar `describe-engine-default-parameters`. **AWS CLI** **Descrever os parâmetros padrão do mecanismo** O exemplo `describe-engine-default-parameters` a seguir retorna as informações sobre o mecanismo padrão e parâmetros do sistema do mecanismo de cache especificado. ``` aws elasticache describe-engine-default-parameters \ --cache-parameter-group-family "redis5.0" ``` Resultado: ``` { "EngineDefaults": { "Parameters": [ { "ParameterName": "activedefrag", "ParameterValue": "no", "Description": "Enabled active memory defragmentation", "Source": "system", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "active-defrag-cycle-max", "ParameterValue": "75", "Description": "Maximal effort for defrag in CPU percentage", "Source": "system", "DataType": "integer", "AllowedValues": "1-75", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "active-defrag-cycle-min", "ParameterValue": "5", "Description": "Minimal effort for defrag in CPU percentage", "Source": "system", "DataType": "integer", "AllowedValues": "1-75", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "active-defrag-ignore-bytes", "ParameterValue": "104857600", "Description": "Minimum amount of fragmentation waste to start active defrag", "Source": "system", "DataType": "integer", "AllowedValues": "1048576-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "active-defrag-max-scan-fields", "ParameterValue": "1000", "Description": "Maximum number of set/hash/zset/list fields that will be processed from the main dictionary scan", "Source": "system", "DataType": "integer", "AllowedValues": "1-1000000", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "active-defrag-threshold-lower", "ParameterValue": "10", "Description": "Minimum percentage of fragmentation to start active defrag", "Source": "system", "DataType": "integer", "AllowedValues": "1-100", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "active-defrag-threshold-upper", "ParameterValue": "100", "Description": "Maximum percentage of fragmentation at which we use maximum effort", "Source": "system", "DataType": "integer", "AllowedValues": "1-100", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "activerehashing", "ParameterValue": "yes", "Description": "Apply rehashing or not.", "Source": "system", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": false, "MinimumEngineVersion": "5.0.0", "ChangeType": "requires-reboot" }, { "ParameterName": "appendfsync", "ParameterValue": "everysec", "Description": "fsync policy for AOF persistence", "Source": "system", "DataType": "string", "AllowedValues": "always,everysec,no", "IsModifiable": false, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "appendonly", "ParameterValue": "no", "Description": "Enable Redis persistence.", "Source": "system", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": false, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "client-output-buffer-limit-normal-hard-limit", "ParameterValue": "0", "Description": "Normal client output buffer hard limit in bytes.", "Source": "system", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "client-output-buffer-limit-normal-soft-limit", "ParameterValue": "0", "Description": "Normal client output buffer soft limit in bytes.", "Source": "system", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "client-output-buffer-limit-normal-soft-seconds", "ParameterValue": "0", "Description": "Normal client output buffer soft limit in seconds.", "Source": "system", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "client-output-buffer-limit-pubsub-hard-limit", "ParameterValue": "33554432", "Description": "Pubsub client output buffer hard limit in bytes.", "Source": "system", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "client-output-buffer-limit-pubsub-soft-limit", "ParameterValue": "8388608", "Description": "Pubsub client output buffer soft limit in bytes.", "Source": "system", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "client-output-buffer-limit-pubsub-soft-seconds", "ParameterValue": "60", "Description": "Pubsub client output buffer soft limit in seconds.", "Source": "system", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "client-output-buffer-limit-replica-soft-seconds", "ParameterValue": "60", "Description": "Replica client output buffer soft limit in seconds.", "Source": "system", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": false, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "client-query-buffer-limit", "ParameterValue": "1073741824", "Description": "Max size of a single client query buffer", "Source": "system", "DataType": "integer", "AllowedValues": "1048576-1073741824", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "close-on-replica-write", "ParameterValue": "yes", "Description": "If enabled, clients who attempt to write to a read-only replica will be disconnected. Applicable to 2.8.23 and higher.", "Source": "system", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "cluster-enabled", "ParameterValue": "no", "Description": "Enable cluster mode", "Source": "system", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": false, "MinimumEngineVersion": "5.0.0", "ChangeType": "requires-reboot" }, { "ParameterName": "cluster-require-full-coverage", "ParameterValue": "no", "Description": "Whether cluster becomes unavailable if one or more slots are not covered", "Source": "system", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "databases", "ParameterValue": "16", "Description": "Set the number of databases.", "Source": "system", "DataType": "integer", "AllowedValues": "1-1200000", "IsModifiable": false, "MinimumEngineVersion": "5.0.0", "ChangeType": "requires-reboot" }, { "ParameterName": "hash-max-ziplist-entries", "ParameterValue": "512", "Description": "The maximum number of hash entries in order for the dataset to be compressed.", "Source": "system", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "hash-max-ziplist-value", "ParameterValue": "64", "Description": "The threshold of biggest hash entries in order for the dataset to be compressed.", "Source": "system", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "hll-sparse-max-bytes", "ParameterValue": "3000", "Description": "HyperLogLog sparse representation bytes limit", "Source": "system", "DataType": "integer", "AllowedValues": "1-16000", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "lazyfree-lazy-eviction", "ParameterValue": "no", "Description": "Perform an asynchronous delete on evictions", "Source": "system", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "lazyfree-lazy-expire", "ParameterValue": "no", "Description": "Perform an asynchronous delete on expired keys", "Source": "system", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "lazyfree-lazy-server-del", "ParameterValue": "no", "Description": "Perform an asynchronous delete on key updates", "Source": "system", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "lfu-decay-time", "ParameterValue": "1", "Description": "The amount of time in minutes to decrement the key counter for LFU eviction policy", "Source": "system", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "lfu-log-factor", "ParameterValue": "10", "Description": "The log factor for incrementing key counter for LFU eviction policy", "Source": "system", "DataType": "integer", "AllowedValues": "1-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "list-compress-depth", "ParameterValue": "0", "Description": "Number of quicklist ziplist nodes from each side of the list to exclude from compression. The head and tail of the list are always uncompressed for fast push/pop operations", "Source": "system", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "list-max-ziplist-size", "ParameterValue": "-2", "Description": "The number of entries allowed per internal list node can be specified as a fixed maximum size or a maximum number of elements", "Source": "system", "DataType": "integer", "AllowedValues": "-5,-4,-3,-2,-1,1-", "IsModifiable": false, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "lua-replicate-commands", "ParameterValue": "yes", "Description": "Always enable Lua effect replication or not", "Source": "system", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "lua-time-limit", "ParameterValue": "5000", "Description": "Max execution time of a Lua script in milliseconds. 0 for unlimited execution without warnings.", "Source": "system", "DataType": "integer", "AllowedValues": "5000", "IsModifiable": false, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "maxclients", "ParameterValue": "65000", "Description": "The maximum number of Redis clients.", "Source": "system", "DataType": "integer", "AllowedValues": "1-65000", "IsModifiable": false, "MinimumEngineVersion": "5.0.0", "ChangeType": "requires-reboot" }, { "ParameterName": "maxmemory-policy", "ParameterValue": "volatile-lru", "Description": "Max memory policy.", "Source": "system", "DataType": "string", "AllowedValues": "volatile-lru,allkeys-lru,volatile-lfu,allkeys-lfu,volatile-random,allkeys-random,volatile-ttl,noeviction", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "maxmemory-samples", "ParameterValue": "3", "Description": "Max memory samples.", "Source": "system", "DataType": "integer", "AllowedValues": "1-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "min-replicas-max-lag", "ParameterValue": "10", "Description": "The maximum amount of replica lag in seconds beyond which the master would stop taking writes. A value of 0 means the master always takes writes.", "Source": "system", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "min-replicas-to-write", "ParameterValue": "0", "Description": "The minimum number of replicas that must be present with lag no greater than min-replicas-max-lag for master to take writes. Setting this to 0 means the master always takes writes.", "Source": "system", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "notify-keyspace-events", "Description": "The keyspace events for Redis to notify Pub/Sub clients about. By default all notifications are disabled", "Source": "system", "DataType": "string", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "proto-max-bulk-len", "ParameterValue": "536870912", "Description": "Max size of a single element request", "Source": "system", "DataType": "integer", "AllowedValues": "1048576-536870912", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "rename-commands", "ParameterValue": "", "Description": "Redis commands that can be dynamically renamed by the customer", "Source": "system", "DataType": "string", "AllowedValues": "APPEND,BITCOUNT,BITFIELD,BITOP,BITPOS,BLPOP,BRPOP,BRPOPLPUSH,BZPOPMIN,BZPOPMAX,CLIENT,COMMAND,DBSIZE,DECR,DECRBY,DEL,DISCARD,DUMP,ECHO,EVAL,EVALSHA,EXEC,EXISTS,EXPIRE,EXPIREAT,FLUSHALL,FLUSHDB,GEOADD,GEOHASH,GEOPOS,GEODIST,GEORADIUS,GEORADIUSBYMEMBER,GET,GETBIT,GETRANGE,GETSET,HDEL,HEXISTS,HGET,HGETALL,HINCRBY,HINCRBYFLOAT,HKEYS,HLEN,HMGET,HMSET,HSET,HSETNX,HSTRLEN,HVALS,INCR,INCRBY,INCRBYFLOAT,INFO,KEYS,LASTSAVE,LINDEX,LINSERT,LLEN,LPOP,LPUSH,LPUSHX,LRANGE,LREM,LSET,LTRIM,MEMORY,MGET,MONITOR,MOVE,MSET,MSETNX,MULTI,OBJECT,PERSIST,PEXPIRE,PEXPIREAT,PFADD,PFCOUNT,PFMERGE,PING,PSETEX,PSUBSCRIBE,PUBSUB,PTTL,PUBLISH,PUNSUBSCRIBE,RANDOMKEY,READONLY,READWRITE,RENAME,RENAMENX,RESTORE,ROLE,RPOP,RPOPLPUSH,RPUSH,RPUSHX,SADD,SCARD,SCRIPT,SDIFF,SDIFFSTORE,SELECT,SET,SETBIT,SETEX,SETNX,SETRANGE,SINTER,SINTERSTORE,SISMEMBER,SLOWLOG,SMEMBERS,SMOVE,SORT,SPOP,SRANDMEMBER,SREM,STRLEN,SUBSCRIBE,SUNION,SUNIONSTORE,SWAPDB,TIME,TOUCH,TTL,TYPE,UNSUBSCRIBE,UNLINK,UNWATCH,WAIT,WATCH,ZADD,ZCARD,ZCOUNT,ZINCRBY,ZINTERSTORE,ZLEXCOUNT,ZPOPMAX,ZPOPMIN,ZRANGE,ZRANGEBYLEX,ZREVRANGEBYLEX,ZRANGEBYSCORE,ZRANK,ZREM,ZREMRANGEBYLEX,ZREMRANGEBYRANK,ZREMRANGEBYSCORE,ZREVRANGE,ZREVRANGEBYSCORE,ZREVRANK,ZSCORE,ZUNIONSTORE,SCAN,SSCAN,HSCAN,ZSCAN,XINFO,XADD,XTRIM,XDEL,XRANGE,XREVRANGE,XLEN,XREAD,XGROUP,XREADGROUP,XACK,XCLAIM,XPENDING,GEORADIUS_RO,GEORADIUSBYMEMBER_RO,LOLWUT,XSETID,SUBSTR", "IsModifiable": true, "MinimumEngineVersion": "5.0.3", "ChangeType": "immediate" }, { "ParameterName": "repl-backlog-size", "ParameterValue": "1048576", "Description": "The replication backlog size in bytes for PSYNC. This is the size of the buffer which accumulates slave data when slave is disconnected for some time, so that when slave reconnects again, only transfer the portion of data which the slave missed. Minimum value is 16K.", "Source": "system", "DataType": "integer", "AllowedValues": "16384-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "repl-backlog-ttl", "ParameterValue": "3600", "Description": "The amount of time in seconds after the master no longer have any slaves connected for the master to free the replication backlog. A value of 0 means to never release the backlog.", "Source": "system", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "replica-allow-chaining", "ParameterValue": "no", "Description": "Configures if chaining of replicas is allowed", "Source": "system", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": false, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "replica-ignore-maxmemory", "ParameterValue": "yes", "Description": "Determines if replica ignores maxmemory setting by not evicting items independent from the master", "Source": "system", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": false, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "replica-lazy-flush", "ParameterValue": "no", "Description": "Perform an asynchronous flushDB during replica sync", "Source": "system", "DataType": "string", "AllowedValues": "yes,no", "IsModifiable": false, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "reserved-memory-percent", "ParameterValue": "25", "Description": "The percent of memory reserved for non-cache memory usage. You may want to increase this parameter for nodes with read replicas, AOF enabled, etc, to reduce swap usage.", "Source": "system", "DataType": "integer", "AllowedValues": "0-100", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "set-max-intset-entries", "ParameterValue": "512", "Description": "The limit in the size of the set in order for the dataset to be compressed.", "Source": "system", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "slowlog-log-slower-than", "ParameterValue": "10000", "Description": "The execution time, in microseconds, to exceed in order for the command to get logged. Note that a negative number disables the slow log, while a value of zero forces the logging of every command.", "Source": "system", "DataType": "integer", "AllowedValues": "-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "slowlog-max-len", "ParameterValue": "128", "Description": "The length of the slow log. There is no limit to this length. Just be aware that it will consume memory. You can reclaim memory used by the slow log with SLOWLOG RESET.", "Source": "system", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "stream-node-max-bytes", "ParameterValue": "4096", "Description": "The maximum size of a single node in a stream in bytes", "Source": "system", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "stream-node-max-entries", "ParameterValue": "100", "Description": "The maximum number of items a single node in a stream can contain", "Source": "system", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "tcp-keepalive", "ParameterValue": "300", "Description": "If non-zero, send ACKs every given number of seconds.", "Source": "system", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "timeout", "ParameterValue": "0", "Description": "Close connection if client is idle for a given number of seconds, or never if 0.", "Source": "system", "DataType": "integer", "AllowedValues": "0,20-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "zset-max-ziplist-entries", "ParameterValue": "128", "Description": "The maximum number of sorted set entries in order for the dataset to be compressed.", "Source": "system", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" }, { "ParameterName": "zset-max-ziplist-value", "ParameterValue": "64", "Description": "The threshold of biggest sorted set entries in order for the dataset to be compressed.", "Source": "system", "DataType": "integer", "AllowedValues": "0-", "IsModifiable": true, "MinimumEngineVersion": "5.0.0", "ChangeType": "immediate" } ] } } ``` + Para ver detalhes da API, consulte [DescribeEngineDefaultParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-engine-default-parameters.html) na *Referência de comandos da AWS CLI*. ### `describe-events` O código de exemplo a seguir mostra como usar `describe-events`. **AWS CLI** **Descrever eventos de um grupo de replicação** O exemplo `describe-events` a seguir retorna uma lista de eventos para um grupo de replicação. ``` aws elasticache describe-events \ --source-identifier test-cluster \ --source-type replication-group ``` Resultado: ``` { "Events": [ { "SourceIdentifier": "test-cluster", "SourceType": "replication-group", "Message": "Automatic failover has been turned on for replication group test-cluster", "Date": "2020-03-18T23:51:34.457Z" }, { "SourceIdentifier": "test-cluster", "SourceType": "replication-group", "Message": "Replication group test-cluster created", "Date": "2020-03-18T23:50:31.378Z" } ] } ``` Para obter mais informações, consulte [Monitorar eventos](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ECEvents.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [DescribeEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-events.html) na *Referência de comandos da AWS CLI*. ### `describe-global-replication-groups` O código de exemplo a seguir mostra como usar `describe-global-replication-groups`. **AWS CLI** **Descrever grupos de replicação global** O exemplo `describe-global-replication-groups` a seguir retorna detalhes de um datastore Global. ``` aws elasticache describe-global-replication-groups \ --global-replication-group-id my-grg ``` Resultado: ``` { "GlobalReplicationGroups": [ { "GlobalReplicationGroupId": "my-grg", "GlobalReplicationGroupDescription": "my-grg", "Status": "creating", "CacheNodeType": "cache.r5.large", "Engine": "redis", "EngineVersion": "5.0.6", "ClusterEnabled": false, "AuthTokenEnabled": false, "TransitEncryptionEnabled": false, "AtRestEncryptionEnabled": false } ] } ``` Para obter mais informações, consulte [Replicação entre Regiões da AWS usando o datastore global](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [DescribeGlobalReplicationGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-global-replication-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-replication-groups` O código de exemplo a seguir mostra como usar `describe-replication-groups`. **AWS CLI** **Retornar uma lista de detalhes do grupo de replicação** O exemplo `describe-replication-groups` a seguir retorna os grupos de replicação. ``` aws elasticache describe-replication-groups ``` Resultado: ``` { "ReplicationGroups": [ { "ReplicationGroupId": "my-cluster", "Description": "mycluster", "Status": "available", "PendingModifiedValues": {}, "MemberClusters": [ "pat-cluster-001", "pat-cluster-002", "pat-cluster-003", "pat-cluster-004" ], "NodeGroups": [ { "NodeGroupId": "0001", "Status": "available", "PrimaryEndpoint": { "Address": "my-cluster.xxxxih.ng.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "ReaderEndpoint": { "Address": "my-cluster-ro.xxxxih.ng.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "NodeGroupMembers": [ { "CacheClusterId": "my-cluster-001", "CacheNodeId": "0001", "ReadEndpoint": { "Address": "pat-cluster-001.xxxih.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "PreferredAvailabilityZone": "us-west-2a", "CurrentRole": "primary" }, { "CacheClusterId": "my-cluster-002", "CacheNodeId": "0001", "ReadEndpoint": { "Address": "pat-cluster-002.xxxxih.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "PreferredAvailabilityZone": "us-west-2a", "CurrentRole": "replica" }, { "CacheClusterId": "my-cluster-003", "CacheNodeId": "0001", "ReadEndpoint": { "Address": "pat-cluster-003.xxxxih.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "PreferredAvailabilityZone": "us-west-2a", "CurrentRole": "replica" }, { "CacheClusterId": "my-cluster-004", "CacheNodeId": "0001", "ReadEndpoint": { "Address": "pat-cluster-004.xxxih.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "PreferredAvailabilityZone": "us-west-2a", "CurrentRole": "replica" } ] } ], "AutomaticFailover": "disabled", "SnapshotRetentionLimit": 0, "SnapshotWindow": "07:30-08:30", "ClusterEnabled": false, "CacheNodeType": "cache.r5.xlarge", "AuthTokenEnabled": false, "TransitEncryptionEnabled": false, "AtRestEncryptionEnabled": false, "ARN": "arn:aws:elasticache:us-west-2:xxxxxxxxxxx152:replicationgroup:my-cluster", "LogDeliveryConfigurations": [ { "LogType": "slow-log", "DestinationType": "cloudwatch-logs", "DestinationDetails": { "CloudWatchLogsDetails": { "LogGroup": "test-log" } }, "LogFormat": "json", "Status": "active" } ] } ] } ``` Para obter mais informações, consulte [Gerenciar clusters](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [DescribeReplicationGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-replication-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-reserved-cache-nodes-offerings` O código de exemplo a seguir mostra como usar `describe-reserved-cache-nodes-offerings`. **AWS CLI** **Descrever reserved-cache-nodes-offerings** O exemplo `describe-reserved-cache-nodes-offerings` a seguir retorna detalhes de opções reserved-cache-node. ``` aws elasticache describe-reserved-cache-nodes-offerings ``` Resultado: ``` { "ReservedCacheNodesOfferings": [ { "ReservedCacheNodesOfferingId": "01ce0a19-a476-41cb-8aee-48eacbcdc8e5", "CacheNodeType": "cache.t3.small", "Duration": 31536000, "FixedPrice": 97.0, "UsagePrice": 0.0, "ProductDescription": "memcached", "OfferingType": "Partial Upfront", "RecurringCharges": [ { "RecurringChargeAmount": 0.011, "RecurringChargeFrequency": "Hourly" } ] }, { "ReservedCacheNodesOfferingId": "0443a27b-4da5-4b90-b92d-929fbd7abed2", "CacheNodeType": "cache.m3.2xlarge", "Duration": 31536000, "FixedPrice": 1772.0, "UsagePrice": 0.0, "ProductDescription": "redis", "OfferingType": "Heavy Utilization", "RecurringCharges": [ { "RecurringChargeAmount": 0.25, "RecurringChargeFrequency": "Hourly" } ] }, ... ] } ``` Para obter mais informações, consulte [Obter informações sobre ofertas de nós reservados](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/reserved-nodes-offerings.html) no *Guia do usuário do Elasticache Redis* ou [Obter informações sobre ofertas de nós reservados](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/reserved-nodes-offerings.html) no *Guia do usuário do Elasticache Memcached*. + Para ver detalhes da API, consulte [DescribeReservedCacheNodesOfferings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-reserved-cache-nodes-offerings.html) na *Referência de comandos da AWS CLI*. ### `describe-reserved-cache-nodes` O código de exemplo a seguir mostra como usar `describe-reserved-cache-nodes`. **AWS CLI** **Descrever os nós de cache reservados** O exemplo `describe-reserved-cache-nodes` a seguir retorna informações sobre nós de cache reservados para esta conta ou sobre o nó de cache reservado especificado. aws elasticache describe-reserved-cache-nodes Resultado: ``` { "ReservedCacheNodes": [ { "ReservedCacheNodeId": "mynode", "ReservedCacheNodesOfferingId": "xxxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxx71", "CacheNodeType": "cache.t3.small", "StartTime": "2019-12-06T02:50:44.003Z", "Duration": 31536000, "FixedPrice": 0.0, "UsagePrice": 0.0, "CacheNodeCount": 1, "ProductDescription": "redis", "OfferingType": "No Upfront", "State": "payment-pending", "RecurringCharges": [ { "RecurringChargeAmount": 0.023, "RecurringChargeFrequency": "Hourly" } ], "ReservationARN": "arn:aws:elasticache:us-west-2:xxxxxxxxxxxx52:reserved-instance:mynode" } ] } ``` Para obter mais informações, consulte [Gerenciar custos com nós reservados](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/reserved-nodes.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [DescribeReservedCacheNodes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-reserved-cache-nodes.html) na *Referência de comandos da AWS CLI*. ### `describe-service-updates` O código de exemplo a seguir mostra como usar `describe-service-updates`. **AWS CLI** **Descrever as atualizações de serviço** O exemplo `describe-service-updates` a seguir retorna detalhes sobre atualizações de serviços. ``` aws elasticache describe-service-updates ``` Resultado: ``` { "ServiceUpdates": [ { "ServiceUpdateName": "elc-xxxxxxxx7-001", "ServiceUpdateReleaseDate": "2019-10-09T16:00:00Z", "ServiceUpdateEndDate": "2020-02-09T15:59:59Z", "ServiceUpdateSeverity": "important", "ServiceUpdateRecommendedApplyByDate": "2019-11-08T15:59:59Z", "ServiceUpdateStatus": "available", "ServiceUpdateDescription": "Upgrades to improve the security, reliability, and operational performance of your ElastiCache nodes", "ServiceUpdateType": "security-update", "Engine": "redis, memcached", "EngineVersion": "redis 2.6.13 and onwards, memcached 1.4.5 and onwards", "AutoUpdateAfterRecommendedApplyByDate": false, "EstimatedUpdateTime": "30 minutes per node" }, { "ServiceUpdateName": "elc-xxxxxxxx4-001", "ServiceUpdateReleaseDate": "2019-06-11T15:00:00Z", "ServiceUpdateEndDate": "2019-10-01T09:24:00Z", "ServiceUpdateSeverity": "important", "ServiceUpdateRecommendedApplyByDate": "2019-07-11T14:59:59Z", "ServiceUpdateStatus": "expired", "ServiceUpdateDescription": "Upgrades to improve the security, reliability, and operational performance of your ElastiCache nodes", "ServiceUpdateType": "security-update", "Engine": "redis", "EngineVersion": "redis 3.2.6, redis 4.0 and onwards", "AutoUpdateAfterRecommendedApplyByDate": false, "EstimatedUpdateTime": "30 minutes per node" } ] } ``` + Para ver detalhes da API, consulte [DescribeServiceUpdates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-service-updates.html) na *Referência de comandos da AWS CLI*. ### `describe-snapshots` O código de exemplo a seguir mostra como usar `describe-snapshots`. **AWS CLI** **Descrever snapshots** O exemplo “describe-snapshots” a seguir retorna informações sobre os snapshot do cluster ou do grupo de replicação. ``` aws elasticache describe-snapshots ``` Resultado: ``` { "Snapshots": [ { "SnapshotName": "automatic.my-cluster2-002-2019-12-05-06-38", "CacheClusterId": "my-cluster2-002", "SnapshotStatus": "available", "SnapshotSource": "automated", "CacheNodeType": "cache.r5.large", "Engine": "redis", "EngineVersion": "5.0.5", "NumCacheNodes": 1, "PreferredAvailabilityZone": "us-west-2a", "CacheClusterCreateTime": "2019-11-26T01:22:52.396Z", "PreferredMaintenanceWindow": "mon:17:30-mon:18:30", "TopicArn": "arn:aws:sns:us-west-2:xxxxxxxxx52:My_Topic", "Port": 6379, "CacheParameterGroupName": "default.redis5.0", "CacheSubnetGroupName": "kxkxk", "VpcId": "vpc-a3e97cdb", "AutoMinorVersionUpgrade": true, "SnapshotRetentionLimit": 1, "SnapshotWindow": "06:30-07:30", "NodeSnapshots": [ { "CacheNodeId": "0001", "CacheSize": "5 MB", "CacheNodeCreateTime": "2019-11-26T01:22:52.396Z", "SnapshotCreateTime": "2019-12-05T06:38:23Z" } ] }, { "SnapshotName": "myreplica-backup", "CacheClusterId": "myreplica", "SnapshotStatus": "available", "SnapshotSource": "manual", "CacheNodeType": "cache.r5.large", "Engine": "redis", "EngineVersion": "5.0.5", "NumCacheNodes": 1, "PreferredAvailabilityZone": "us-west-2a", "CacheClusterCreateTime": "2019-11-26T00:14:52.439Z", "PreferredMaintenanceWindow": "sat:10:00-sat:11:00", "TopicArn": "arn:aws:sns:us-west-2:xxxxxxxxxx152:My_Topic", "Port": 6379, "CacheParameterGroupName": "default.redis5.0", "CacheSubnetGroupName": "kxkxk", "VpcId": "vpc-a3e97cdb", "AutoMinorVersionUpgrade": true, "SnapshotRetentionLimit": 0, "SnapshotWindow": "09:00-10:00", "NodeSnapshots": [ { "CacheNodeId": "0001", "CacheSize": "5 MB", "CacheNodeCreateTime": "2019-11-26T00:14:52.439Z", "SnapshotCreateTime": "2019-11-26T00:25:01Z" } ] }, { "SnapshotName": "my-cluster", "CacheClusterId": "my-cluster-003", "SnapshotStatus": "available", "SnapshotSource": "manual", "CacheNodeType": "cache.r5.large", "Engine": "redis", "EngineVersion": "5.0.5", "NumCacheNodes": 1, "PreferredAvailabilityZone": "us-west-2a", "CacheClusterCreateTime": "2019-11-25T23:56:17.186Z", "PreferredMaintenanceWindow": "sat:10:00-sat:11:00", "TopicArn": "arn:aws:sns:us-west-2:xxxxxxxxxx152:My_Topic", "Port": 6379, "CacheParameterGroupName": "default.redis5.0", "CacheSubnetGroupName": "kxkxk", "VpcId": "vpc-a3e97cdb", "AutoMinorVersionUpgrade": true, "SnapshotRetentionLimit": 0, "SnapshotWindow": "09:00-10:00", "NodeSnapshots": [ { "CacheNodeId": "0001", "CacheSize": "5 MB", "CacheNodeCreateTime": "2019-11-25T23:56:17.186Z", "SnapshotCreateTime": "2019-11-26T03:08:33Z" } ] } ] } ``` Para obter mais informações, consulte [Backup e restauração do ElastiCache para Redis](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups.html) no *Guia do usuário do Elasticache*. + Consulte detalhes da API em [DescribeSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-snapshots.html) na *Referência de comandos da AWS CLI*. ### `describe-update-actions` O código de exemplo a seguir mostra como usar `describe-update-actions`. **AWS CLI** **Descrever as ações de atualização** O exemplo `describe-update-actions` a seguir retorna detalhes das ações de atualização. ``` aws elasticache describe-update-actions ``` Resultado: ``` { "UpdateActions": [ { "ReplicationGroupId": "mycluster", "ServiceUpdateName": "elc-20191007-001", "ServiceUpdateReleaseDate": "2019-10-09T16:00:00Z", "ServiceUpdateSeverity": "important", "ServiceUpdateStatus": "available", "ServiceUpdateRecommendedApplyByDate": "2019-11-08T15:59:59Z", "ServiceUpdateType": "security-update", "UpdateActionAvailableDate": "2019-12-05T19:15:19.995Z", "UpdateActionStatus": "complete", "NodesUpdated": "9/9", "UpdateActionStatusModifiedDate": "2019-12-05T19:15:20.461Z", "SlaMet": "n/a", "Engine": "redis" }, { "CacheClusterId": "my-memcached-cluster", "ServiceUpdateName": "elc-20191007-001", "ServiceUpdateReleaseDate": "2019-10-09T16:00:00Z", "ServiceUpdateSeverity": "important", "ServiceUpdateStatus": "available", "ServiceUpdateRecommendedApplyByDate": "2019-11-08T15:59:59Z", "ServiceUpdateType": "security-update", "UpdateActionAvailableDate": "2019-12-04T18:26:05.349Z", "UpdateActionStatus": "complete", "NodesUpdated": "1/1", "UpdateActionStatusModifiedDate": "2019-12-04T18:26:05.352Z", "SlaMet": "n/a", "Engine": "redis" }, { "ReplicationGroupId": "my-cluster", "ServiceUpdateName": "elc-20191007-001", "ServiceUpdateReleaseDate": "2019-10-09T16:00:00Z", "ServiceUpdateSeverity": "important", "ServiceUpdateStatus": "available", "ServiceUpdateRecommendedApplyByDate": "2019-11-08T15:59:59Z", "ServiceUpdateType": "security-update", "UpdateActionAvailableDate": "2019-11-26T03:36:26.320Z", "UpdateActionStatus": "complete", "NodesUpdated": "4/4", "UpdateActionStatusModifiedDate": "2019-12-04T22:11:12.664Z", "SlaMet": "n/a", "Engine": "redis" }, { "ReplicationGroupId": "my-cluster2", "ServiceUpdateName": "elc-20191007-001", "ServiceUpdateReleaseDate": "2019-10-09T16:00:00Z", "ServiceUpdateSeverity": "important", "ServiceUpdateStatus": "available", "ServiceUpdateRecommendedApplyByDate": "2019-11-08T15:59:59Z", "ServiceUpdateType": "security-update", "UpdateActionAvailableDate": "2019-11-26T01:26:01.617Z", "UpdateActionStatus": "complete", "NodesUpdated": "3/3", "UpdateActionStatusModifiedDate": "2019-11-26T01:26:01.753Z", "SlaMet": "n/a", "Engine": "redis" } ] } ``` Para obter mais informações, consulte [Atualizações de autoatendimento no Amazon ElastiCache](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Self-Service-Updates.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [DescribeUpdateActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-update-actions.html) na *Referência de comandos da AWS CLI*. ### `describe-user-groups` O código de exemplo a seguir mostra como usar `describe-user-groups`. **AWS CLI** **Descrever grupos de usuários** O exemplo `describe-user-groups` a seguir retorna uma lista de grupos de usuários. ``` aws elasticache describe-user-groups ``` Resultado: ``` { "UserGroups": [ { "UserGroupId": "myusergroup", "Status": "active", "Engine": "redis", "UserIds": [ "default" ], "ReplicationGroups": [], "ARN": "arn:aws:elasticache:us-west-2:xxxxxxxxxx52:usergroup:myusergroup" } ] } ``` Para obter mais informações, consulte [Autenticação de usuários com controle de acesso baseado em função (RBAC)](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [DescribeUserGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-user-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-users` O código de exemplo a seguir mostra como usar `describe-users`. **AWS CLI** **Descrever usuários** O exemplo `describe-users` a seguir retorna uma lista de usuários. ``` aws elasticache describe-users ``` Resultado: ``` { "Users": [ { "UserId": "default", "UserName": "default", "Status": "active", "Engine": "redis", "AccessString": "on ~* +@all", "UserGroupIds": [ "myusergroup" ], "Authentication": { "Type": "no-password" }, "ARN": "arn:aws:elasticache:us-west-2:xxxxxxxxxx52:user:default" }, { "UserId": "user1", "UserName": "myUser", "Status": "active", "Engine": "redis", "AccessString": "on ~* +@all", "UserGroupIds": [], "Authentication": { "Type": "password", "PasswordCount": 1 }, "ARN": "arn:aws:elasticache:us-west-2:xxxxxxxxxx52:user:user1" }, { "UserId": "user2", "UserName": "myUser", "Status": "active", "Engine": "redis", "AccessString": "on ~app::* -@all +@read +@hash +@bitmap +@geo -setbit -bitfield -hset -hsetnx -hmset -hincrby -hincrbyfloat -hdel -bitop -geoadd -georadius -georadiusbymember", "UserGroupIds": [], "Authentication": { "Type": "password", "PasswordCount": 1 }, "ARN": "arn:aws:elasticache:us-west-2:xxxxxxxxxx52:user:user2" } ] } ``` Para obter mais informações, consulte [Autenticação de usuários com controle de acesso baseado em função (RBAC)](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [DescribeUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-users.html) na *Referência de comandos da AWS CLI*. ### `disassociate-global-replication-group` O código de exemplo a seguir mostra como usar `disassociate-global-replication-group`. **AWS CLI** **Dissociar um cluster secundário de um grupo de replicação global** O exemplo `disassociate-global-replication-group` a seguir remove um cluster secundário de um datastore Global ``` aws elasticache disassociate-global-replication-group \ --global-replication-group-id my-grg \ --replication-group-id my-cluster-grg-secondary \ --replication-group-region us-east-1 ``` Resultado: ``` { "GlobalReplicationGroup": { "GlobalReplicationGroupId": "my-grg", "GlobalReplicationGroupDescription": "my-grg", "Status": "modifying", "CacheNodeType": "cache.r5.large", "Engine": "redis", "EngineVersion": "5.0.6", "Members": [ { "ReplicationGroupId": "my-cluster-grg-secondary", "ReplicationGroupRegion": "us-east-1", "Role": "SECONDARY", "AutomaticFailover": "enabled", "Status": "associated" }, { "ReplicationGroupId": "my-cluster-grg", "ReplicationGroupRegion": "us-west-2", "Role": "PRIMARY", "AutomaticFailover": "enabled", "Status": "associated" } ], "ClusterEnabled": false, "AuthTokenEnabled": false, "TransitEncryptionEnabled": false, "AtRestEncryptionEnabled": false } } ``` Para obter mais informações, consulte [Replicação entre Regiões da AWS usando o datastore global](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [DisassociateGlobalReplicationGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/disassociate-global-replication-group.html) na *Referência de comandos da AWS CLI*. ### `increase-node-groups-in-global-replication-group` O código de exemplo a seguir mostra como usar `increase-node-groups-in-global-replication-group`. **AWS CLI** **Aumentar o número de grupos de nós em um grupo de replicação global** O `increase-node-groups-in-global-replication-group` a seguir aumenta a contagem de grupos de nós usando o mecanismo Redis. ``` aws elasticache increase-node-groups-in-global-replication-group \ --global-replication-group-id sgaui-pat-test-4 \ --node-group-count 6 \ --apply-immediately ``` Resultado: ``` { "GlobalReplicationGroup": { "GlobalReplicationGroupId": "sgaui-test-4", "GlobalReplicationGroupDescription": "test-4", "Status": "modifying", "CacheNodeType": "cache.r5.large", "Engine": "redis", "EngineVersion": "5.0.6", "Members": [ { "ReplicationGroupId": "my-cluster-b", "ReplicationGroupRegion": "us-east-1", "Role": "SECONDARY", "AutomaticFailover": "enabled", "Status": "associated" }, { "ReplicationGroupId": "my-cluster-a", "ReplicationGroupRegion": "us-west-2", "Role": "PRIMARY", "AutomaticFailover": "enabled", "Status": "associated" } ], "ClusterEnabled": true, "GlobalNodeGroups": [ { "GlobalNodeGroupId": "sgaui-test-4-0001", "Slots": "0-234,2420-5461" }, { "GlobalNodeGroupId": "sgaui-test-4-0002", "Slots": "5462-5904,6997-9830" }, { "GlobalNodeGroupId": "sgaui-test-4-0003", "Slots": "10923-11190,13375-16383" }, { "GlobalNodeGroupId": "sgaui-test-4-0004", "Slots": "235-2419,5905-6996" }, { "GlobalNodeGroupId": "sgaui-test-4-0005", "Slots": "9831-10922,11191-13374" } ], "AuthTokenEnabled": false, "TransitEncryptionEnabled": false, "AtRestEncryptionEnabled": false } } ``` Para obter mais informações, consulte [Replicação entre Regiões da AWS usando o datastore global](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [IncreaseNodeGroupsInGlobalReplicationGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/increase-node-groups-in-global-replication-group.html) na *Referência de comandos da AWS CLI*. ### `increase-replica-count` O código de exemplo a seguir mostra como usar `increase-replica-count`. **AWS CLI** **Aumentar a contagem de réplicas** O exemplo `increase-replica-count` a seguir faz uma das duas coisas. Ele pode aumentar dinamicamente o número de réplicas em um grupo de replicação Redis (modo de cluster desabilitado). Ou pode aumentar dinamicamente o número de nós de réplica em um ou mais grupos de nós (fragmentos) de um grupo de replicação Redis (modo de cluster habilitado). Essa operação é executada sem tempo de inatividade do cluster. ``` aws elasticache increase-replica-count \ --replication-group-id "my-cluster" \ --apply-immediately \ --new-replica-count 3 ``` Resultado: ``` { "ReplicationGroup": { "ReplicationGroupId": "my-cluster", "Description": " ", "Status": "modifying", "PendingModifiedValues": {}, "MemberClusters": [ "my-cluster-001", "my-cluster-002", "my-cluster-003", "my-cluster-004" ], "NodeGroups": [ { "NodeGroupId": "0001", "Status": "modifying", "PrimaryEndpoint": { "Address": "my-cluster.xxxxxih.ng.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "ReaderEndpoint": { "Address": "my-cluster-ro.xxxxxxih.ng.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "NodeGroupMembers": [ { "CacheClusterId": "my-cluster-001", "CacheNodeId": "0001", "ReadEndpoint": { "Address": "my-cluster-001.xxxxxih.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "PreferredAvailabilityZone": "us-west-2a", "CurrentRole": "primary" }, { "CacheClusterId": "my-cluster-003", "CacheNodeId": "0001", "ReadEndpoint": { "Address": "my-cluster-003.xxxxxih.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "PreferredAvailabilityZone": "us-west-2a", "CurrentRole": "replica" } ] } ], "AutomaticFailover": "disabled", "SnapshotRetentionLimit": 0, "SnapshotWindow": "07:30-08:30", "ClusterEnabled": false, "CacheNodeType": "cache.r5.xlarge", "TransitEncryptionEnabled": false, "AtRestEncryptionEnabled": false } } ``` Para obter mais informações, consulte [Aumentar o número de réplicas em um fragmento](https://docs.aws.amazon.c`m/AmazonElastiCache/latest/red-ug/increase-replica-count.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [IncreaseReplicaCount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/increase-replica-count.html) na *Referência de comandos da AWS CLI*. ### `list-allowed-node-type-modifications` O código de exemplo a seguir mostra como usar `list-allowed-node-type-modifications`. **AWS CLI** **Listar as modificações de nós permitidas** O exemplo `list-allowed-node-type-modifications` a seguir lista todos os tipos de nó disponíveis que você pode escalar para o tipo de nó atual do seu cluster do Redis ou do seu grupo de replicação. ``` aws elasticache list-allowed-node-type-modifications \ --replication-group-id "my-replication-group" ``` Resultado: ``` { "ScaleUpModifications": [ "cache.m5.12xlarge", "cache.m5.24xlarge", "cache.m5.4xlarge", "cache.r5.12xlarge", "cache.r5.24xlarge", "cache.r5.2xlarge", "cache.r5.4xlarge" ], "ScaleDownModifications": [ "cache.m3.large", "cache.m3.medium", "cache.m3.xlarge", "cache.m4.large", "cache.m4.xlarge", "cache.m5.2xlarge", "cache.m5.large", "cache.m5.xlarge", "cache.r3.large", "cache.r4.large", "cache.r4.xlarge", "cache.r5.large", "cache.t2.medium", "cache.t2.micro", "cache.t2.small", "cache.t3.medium", "cache.t3.micro", "cache.t3.small" ] } ``` Para obter mais informações, consulte [Escalar o ElastiCache para clusters do Redis](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [ListAllowedNodeTypeModifications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/list-allowed-node-type-modifications.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar as tags para um recurso** O exemplo `list-tags-for-resource` a seguir lista as tags para um recurso. ``` aws elasticache list-tags-for-resource \ --resource-name "arn:aws:elasticache:us-east-1:123456789012:cluster:my-cluster" ``` Resultado: ``` { "TagList": [ { "Key": "Project", "Value": "querySpeedUp" }, { "Key": "Environment", "Value": "PROD" } ] } ``` Para obter mais informações, consulte [Listing Tags Using the AWS CLI](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Tagging.Managing.CLI.html) no *Guia do usuário do Elasticache*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `modify-cache-cluster` O código de exemplo a seguir mostra como usar `modify-cache-cluster`. **AWS CLI** **Modificar clusters de cache** O exemplo `modify-cache-cluster` a seguir modifica as configurações do cluster especificado. ``` aws elasticache modify-cache-cluster \ --cache-cluster-id "my-cluster" \ --num-cache-nodes 1 ``` Resultado: ``` { "CacheCluster": { "CacheClusterId": "my-cluster", "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", "CacheNodeType": "cache.m5.large", "Engine": "redis", "EngineVersion": "5.0.5", "CacheClusterStatus": "available", "NumCacheNodes": 1, "PreferredAvailabilityZone": "us-west-2c", "CacheClusterCreateTime": "2019-12-04T18:24:56.652Z", "PreferredMaintenanceWindow": "sat:10:00-sat:11:00", "PendingModifiedValues": {}, "CacheSecurityGroups": [], "CacheParameterGroup": { "CacheParameterGroupName": "default.redis5.0", "ParameterApplyStatus": "in-sync", "CacheNodeIdsToReboot": [] }, "CacheSubnetGroupName": "default", "AutoMinorVersionUpgrade": true, "SnapshotRetentionLimit": 0, "SnapshotWindow": "07:00-08:00", "TransitEncryptionEnabled": false, "AtRestEncryptionEnabled": false } } ``` Para obter mais informações, consulte [Modificar um cluster do ElastiCache](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.Modify.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [ModifyCacheCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/modify-cache-cluster.html) na *Referência de comandos da AWS CLI*. ### `modify-cache-parameter-group` O código de exemplo a seguir mostra como usar `modify-cache-parameter-group`. **AWS CLI** **Modificar um grupo de parâmetros de cache** O exemplo `modify-cache-parameter-group` a seguir modifica os parâmetros do grupo de parâmetros de cache especificado. ``` aws elasticache modify-cache-parameter-group \ --cache-parameter-group-name "mygroup" \ --parameter-name-values "ParameterName=activedefrag, ParameterValue=no" ``` Resultado: ``` { "CacheParameterGroupName": "mygroup" } ``` Para obter mais informações, consulte [Modificar um grupo de parâmetros](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.Modifying.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [ModifyCacheParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/modify-cache-parameter-group.html) na *Referência de comandos da AWS CLI*. ### `modify-cache-subnet-group` O código de exemplo a seguir mostra como usar `modify-cache-subnet-group`. **AWS CLI** **Modificar um grupo de sub-redes de cache** O exemplo `modify-cache-subnet-group` a seguir modifica o grupo de sub-rede de cache especificado. ``` aws elasticache modify-cache-subnet-group \ --cache-subnet-group-name kxkxk \ --cache-subnet-group-description "mygroup" ``` Resultado: ``` { "CacheSubnetGroup": { "CacheSubnetGroupName": "kxkxk", "CacheSubnetGroupDescription": "mygroup", "VpcId": "vpc-xxxxcdb", "Subnets": [ { "SubnetIdentifier": "subnet-xxxxbff", "SubnetAvailabilityZone": { "Name": "us-west-2a" } } ] } } ``` Para obter mais informações, consulte [Modificar um grupo de sub-redes](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.Modifying.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [ModifyCacheSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/modify-cache-subnet-group.html) na *Referência de comandos da AWS CLI*. ### `modify-global-replication-group` O código de exemplo a seguir mostra como usar `modify-global-replication-group`. **AWS CLI** **Modificar um grupo de replicação global** O `modify-global-replication-group` a seguir modifica as propriedades de um grupo de replicação global, neste caso desativando o failover automático, usando o mecanismo Redis. ``` aws elasticache modify-global-replication-group \ --global-replication-group-id sgaui-pat-group \ --apply-immediately \ --no-automatic-failover-enabled ``` Output ``` { "GlobalReplicationGroup": { "GlobalReplicationGroupId": "sgaui-test-group", "GlobalReplicationGroupDescription": " ", "Status": "modifying", "CacheNodeType": "cache.r5.large", "Engine": "redis", "EngineVersion": "5.0.6", "ClusterEnabled": false, "AuthTokenEnabled": false, "TransitEncryptionEnabled": false, "AtRestEncryptionEnabled": false } } ``` Para obter mais informações, consulte [Replicação entre Regiões da AWS usando o datastore global](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [ModifyGlobalReplicationGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/modify-global-replication-group.html) na *Referência de comandos da AWS CLI*. ### `modify-replication-group-shard-configuration` O código de exemplo a seguir mostra como usar `modify-replication-group-shard-configuration`. **AWS CLI** **Modificar a configuração de um fragmento de grupo de replicação** O `modify-replication-group-shard-configuration` a seguir diminui a contagem de grupos de nós usando o mecanismo Redis. ``` aws elasticache modify-replication-group-shard-configuration \ --replication-group-id mycluster \ --node-group-count 3 \ --apply-immediately \ --node-groups-to-remove 0002 ``` Output ``` { "ReplicationGroup": { "ReplicationGroupId": "mycluster", "Description": "mycluster", "GlobalReplicationGroupInfo": {}, "Status": "modifying", "PendingModifiedValues": {}, "MemberClusters": [ "mycluster-0002-001", "mycluster-0002-002", "mycluster-0002-003", "mycluster-0003-001", "mycluster-0003-002", "mycluster-0003-003", "mycluster-0003-004", "mycluster-0004-001", "mycluster-0004-002", "mycluster-0004-003", "mycluster-0005-001", "mycluster-0005-002", "mycluster-0005-003" ], "NodeGroups": [ { "NodeGroupId": "0002", "Status": "modifying", "Slots": "894-1767,3134-4443,5149-5461,6827-7332,12570-13662", "NodeGroupMembers": [ { "CacheClusterId": "mycluster-0002-001", "CacheNodeId": "0001", "PreferredAvailabilityZone": "us-west-2c" }, { "CacheClusterId": "mycluster-0002-002", "CacheNodeId": "0001", "PreferredAvailabilityZone": "us-west-2a" }, { "CacheClusterId": "mycluster-0002-003", "CacheNodeId": "0001", "PreferredAvailabilityZone": "us-west-2b" } ] }, { "NodeGroupId": "0003", "Status": "modifying", "Slots": "0-324,5462-5692,6784-6826,7698-8191,10923-11075,12441-12569,13663-16383", "NodeGroupMembers": [ { "CacheClusterId": "mycluster-0003-001", "CacheNodeId": "0001", "PreferredAvailabilityZone": "us-west-2c" }, { "CacheClusterId": "mycluster-0003-002", "CacheNodeId": "0001", "PreferredAvailabilityZone": "us-west-2b" }, { "CacheClusterId": "mycluster-0003-003", "CacheNodeId": "0001", "PreferredAvailabilityZone": "us-west-2a" }, { "CacheClusterId": "mycluster-0003-004", "CacheNodeId": "0001", "PreferredAvailabilityZone": "us-west-2c" } ] }, { "NodeGroupId": "0004", "Status": "modifying", "Slots": "325-336,4706-5148,7333-7697,9012-10922,11076-12440", "NodeGroupMembers": [ { "CacheClusterId": "mycluster-0004-001", "CacheNodeId": "0001", "PreferredAvailabilityZone": "us-west-2b" }, { "CacheClusterId": "mycluster-0004-002", "CacheNodeId": "0001", "PreferredAvailabilityZone": "us-west-2a" }, { "CacheClusterId": "mycluster-0004-003", "CacheNodeId": "0001", "PreferredAvailabilityZone": "us-west-2c" } ] }, { "NodeGroupId": "0005", "Status": "modifying", "Slots": "337-893,1768-3133,4444-4705,5693-6783,8192-9011", "NodeGroupMembers": [ { "CacheClusterId": "mycluster-0005-001", "CacheNodeId": "0001", "PreferredAvailabilityZone": "us-west-2a" }, { "CacheClusterId": "mycluster-0005-002", "CacheNodeId": "0001", "PreferredAvailabilityZone": "us-west-2c" }, { "CacheClusterId": "mycluster-0005-003", "CacheNodeId": "0001", "PreferredAvailabilityZone": "us-west-2b" } ] } ], "AutomaticFailover": "enabled", "MultiAZ": "enabled", "ConfigurationEndpoint": { "Address": "mycluster.g2xbih.clustercfg.usw2.cache.amazonaws.com", "Port": 6379 }, "SnapshotRetentionLimit": 1, "SnapshotWindow": "13:00-14:00", "ClusterEnabled": true, "CacheNodeType": "cache.r5.xlarge", "TransitEncryptionEnabled": false, "AtRestEncryptionEnabled": false } } ``` Para obter mais informações, consulte [Escalar o ElastiCache para clusters do Redis](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [ModifyReplicationGroupShardConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/modify-replication-group-shard-configuration.html) na *Referência de comandos da AWS CLI*. ### `modify-replication-group` O código de exemplo a seguir mostra como usar `modify-replication-group`. **AWS CLI** **Modificar um grupo de replicação** O `modify-replication-group` a seguir desabilita multi-AZ usando o mecanismo Redis. ``` aws elasticache modify-replication-group \ --replication-group-id test-cluster \ --no-multi-az-enabled \ --apply-immediately ``` Output ``` { "ReplicationGroup": { "ReplicationGroupId": "test-cluster", "Description": "test-cluster", "GlobalReplicationGroupInfo": { "GlobalReplicationGroupId": "sgaui-pat-group", "GlobalReplicationGroupMemberRole": "PRIMARY" }, "Status": "available", "PendingModifiedValues": {}, "MemberClusters": [ "test-cluster-001", "test-cluster-002", "test-cluster-003" ], "NodeGroups": [ { "NodeGroupId": "0001", "Status": "available", "PrimaryEndpoint": { "Address": "test-cluster.g2xbih.ng.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "ReaderEndpoint": { "Address": "test-cluster-ro.g2xbih.ng.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "NodeGroupMembers": [ { "CacheClusterId": "test-cluster-001", "CacheNodeId": "0001", "ReadEndpoint": { "Address": "test-cluster-001.g2xbih.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "PreferredAvailabilityZone": "us-west-2c", "CurrentRole": "primary" }, { "CacheClusterId": "test-cluster-002", "CacheNodeId": "0001", "ReadEndpoint": { "Address": "test-cluster-002.g2xbih.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "PreferredAvailabilityZone": "us-west-2b", "CurrentRole": "replica" }, { "CacheClusterId": "test-cluster-003", "CacheNodeId": "0001", "ReadEndpoint": { "Address": "test-cluster-003.g2xbih.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "PreferredAvailabilityZone": "us-west-2a", "CurrentRole": "replica" } ] } ], "SnapshottingClusterId": "test-cluster-002", "AutomaticFailover": "enabled", "MultiAZ": "disabled", "SnapshotRetentionLimit": 1, "SnapshotWindow": "08:00-09:00", "ClusterEnabled": false, "CacheNodeType": "cache.r5.large", "TransitEncryptionEnabled": false, "AtRestEncryptionEnabled": false } } ``` Para obter mais informações, consulte [Modificar um grupo de replicação](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Replication.Modify.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [ModifyReplicationGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/modify-replication-group.html) na *Referência de comandos da AWS CLI*. ### `modify-user-group` O código de exemplo a seguir mostra como usar `modify-user-group`. **AWS CLI** **Modificar um grupo de usuários** O exemplo `modify-user-group` a seguir adiciona um usuário ao grupo de usuários. ``` aws elasticache modify-user-group \ --user-group-id myusergroup \ --user-ids-to-add user1 ``` Resultado: ``` { "UserGroupId": "myusergroup", "Status": "modifying", "Engine": "redis", "UserIds": [ "default" ], "PendingChanges": { "UserIdsToAdd": [ "user1" ] }, "ReplicationGroups": [], "ARN": "arn:aws:elasticache:us-west-2:xxxxxxxxxx52:usergroup:myusergroup" } ``` Para obter mais informações, consulte [Autenticação de usuários com controle de acesso baseado em função (RBAC)](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [ModifyUserGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/modify-user-group.html) na *Referência de comandos da AWS CLI*. ### `modify-user` O código de exemplo a seguir mostra como usar `modify-user`. **AWS CLI** **Modificar um usuário** O exemplo `modify-user` a seguir modifica a string de acesso de um usuário. ``` aws elasticache modify-user \ --user-id user2 \ --append-access-string "on ~* +@all" ``` Resultado: ``` { "UserId": "user2", "UserName": "myUser", "Status": "modifying", "Engine": "redis", "AccessString": "on ~* +@all", "UserGroupIds": [], "Authentication": { "Type": "password", "PasswordCount": 1 }, "ARN": "arn:aws:elasticache:us-west-2:xxxxxxxxxx52:user:user2" } ``` Para obter mais informações, consulte [Autenticação de usuários com controle de acesso baseado em função (RBAC)](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html) no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [ModifyUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/modify-user.html) na *Referência de comandos da AWS CLI*. ### `purchase-reserved-cache-nodes-offering` O código de exemplo a seguir mostra como usar `purchase-reserved-cache-nodes-offering`. **AWS CLI** **Comprar uma reserved-cache-node-offering** O exemplo `purchase-reserved-cache-nodes-offering` a seguir permite que você compre uma oferta de nó de cache reservado. ``` aws elasticache purchase-reserved-cache-nodes-offering \ --reserved-cache-nodes-offering-id xxxxxxx-4da5-4b90-b92d-929fbd7abed2 ``` Output ``` { "ReservedCacheNode": { "ReservedCacheNodeId": "ri-2020-06-30-17-59-40-474", "ReservedCacheNodesOfferingId": "xxxxxxx-4da5-4b90-b92d-929fbd7abed2", "CacheNodeType": "cache.m3.2xlarge", "StartTime": "2020-06-30T17:59:40.474000+00:00", "Duration": 31536000, "FixedPrice": 1772.0, "UsagePrice": 0.0, "CacheNodeCount": 1, "ProductDescription": "redis", "OfferingType": "Heavy Utilization", "State": "payment-pending", "RecurringCharges": [ { "RecurringChargeAmount": 0.25, "RecurringChargeFrequency": "Hourly" } ] } } ``` Para obter mais informações, consulte [Obter informações sobre ofertas de nós reservados](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/reserved-nodes-offerings.html) no *Guia do usuário do Elasticache Redis* ou [Obter informações sobre ofertas de nós reservados](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/reserved-nodes-offerings.html) no *Guia do usuário do Elasticache Memcached*. + Para ver detalhes da API, consulte [PurchaseReservedCacheNodesOffering](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/purchase-reserved-cache-nodes-offering.html) na *Referência de comandos da AWS CLI*. ### `reboot-cache-cluster` O código de exemplo a seguir mostra como usar `reboot-cache-cluster`. **AWS CLI** **Reinicializar um cluster de cache** O exemplo `reboot-cache-cluster` a seguir reinicializa alguns ou todos os nós de cache em um cluster provisionado. Essa operação aplica qualquer grupo de parâmetros de cache modificado ao cluster. A operação de reinicialização ocorre o mais rápido possível e resulta em uma interrupção momentânea do cluster. Durante a reinicialização, o status do cluster é definido como `REBOOTING`. ``` aws elasticache reboot-cache-cluster \ --cache-cluster-id "my-cluster-001" \ --cache-node-ids-to-reboot "0001" ``` Resultado: ``` { "CacheCluster": { "CacheClusterId": "my-cluster-001", "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", "CacheNodeType": "cache.r5.xlarge", "Engine": "redis", "EngineVersion": "5.0.5", "CacheClusterStatus": "rebooting cache cluster nodes", "NumCacheNodes": 1, "PreferredAvailabilityZone": "us-west-2a", "CacheClusterCreateTime": "2019-11-26T03:35:04.546Z", "PreferredMaintenanceWindow": "mon:04:05-mon:05:05", "PendingModifiedValues": {}, "NotificationConfiguration": { "TopicArn": "arn:aws:sns:us-west-2:xxxxxxxxxx152:My_Topic", "TopicStatus": "active" }, "CacheSecurityGroups": [], "CacheParameterGroup": { "CacheParameterGroupName": "mygroup", "ParameterApplyStatus": "in-sync", "CacheNodeIdsToReboot": [] }, "CacheSubnetGroupName": "kxkxk", "AutoMinorVersionUpgrade": true, "SecurityGroups": [ { "SecurityGroupId": "sg-xxxxxxxxxxxxx836", "Status": "active" }, { "SecurityGroupId": "sg-xxxxxxxx7b", "Status": "active" } ], "ReplicationGroupId": "my-cluster", "SnapshotRetentionLimit": 0, "SnapshotWindow": "07:30-08:30", "TransitEncryptionEnabled": false, "AtRestEncryptionEnabled": false } } ``` Para obter mais informações, consulte Reinicializando um cluster < https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.Rebooting.html no *Guia do usuário do Elasticache*. + Para ver detalhes da API, consulte [RebootCacheCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/reboot-cache-cluster.html) na *Referência de comandos da AWS CLI*. ### `reset-cache-parameter-group` O código de exemplo a seguir mostra como usar `reset-cache-parameter-group`. **AWS CLI** **Redefinir um grupo de parâmetros de cache** O exemplo `reset-cache-parameter-group` a seguir modifica os parâmetros de um grupo de parâmetros de cache para o valor padrão do mecanismo ou sistema. Você pode redefinir parâmetros específicos enviando uma lista de nomes de parâmetros. Para redefinir todo o grupo de parâmetros de cache, especifique os parâmetros `--reset-all-parameters` e `--cache-parameter-group-name`. ``` aws elasticache reset-cache-parameter-group \ --cache-parameter-group-name "mygroup" \ --reset-all-parameters ``` Resultado: ``` { "CacheParameterGroupName": "mygroup" } ``` + Para ver detalhes da API, consulte [ResetCacheParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/reset-cache-parameter-group.html) na *Referência de comandos da AWS CLI*. ### `start-migration` O código de exemplo a seguir mostra como usar `start-migration`. **AWS CLI** **Iniciar uma migração** O `start-migration` a seguir migra seus dados do Redis auto-hospedado no Amazon EC2 para o Amazon ElastiCache usando o mecanismo do Redis. ``` aws elasticache start-migration \ --replication-group-id test \ --customer-node-endpoint-list "Address='test.g2xbih.ng.0001.usw2.cache.amazonaws.com',Port=6379" ``` Output ``` { "ReplicationGroup": { "ReplicationGroupId": "test", "Description": "test", "GlobalReplicationGroupInfo": {}, "Status": "modifying", "PendingModifiedValues": {}, "MemberClusters": [ "test-001", "test-002", "test-003" ], "NodeGroups": [ { "NodeGroupId": "0001", "Status": "available", "PrimaryEndpoint": { "Address": "test.g2xbih.ng.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "ReaderEndpoint": { "Address": "test-ro.g2xbih.ng.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "NodeGroupMembers": [ { "CacheClusterId": "test-001", "CacheNodeId": "0001", "ReadEndpoint": { "Address": "test-001.g2xbih.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "PreferredAvailabilityZone": "us-west-2a", "CurrentRole": "primary" }, { "CacheClusterId": "test-002", "CacheNodeId": "0001", "ReadEndpoint": { "Address": "test-002.g2xbih.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "PreferredAvailabilityZone": "us-west-2c", "CurrentRole": "replica" }, { "CacheClusterId": "test-003", "CacheNodeId": "0001", "ReadEndpoint": { "Address": "test-003.g2xbih.0001.usw2.cache.amazonaws.com", "Port": 6379 }, "PreferredAvailabilityZone": "us-west-2b", "CurrentRole": "replica" } ] } ], "SnapshottingClusterId": "test-002", "AutomaticFailover": "enabled", "MultiAZ": "enabled", "SnapshotRetentionLimit": 1, "SnapshotWindow": "07:30-08:30", "ClusterEnabled": false, "CacheNodeType": "cache.r5.large", "TransitEncryptionEnabled": false, "AtRestEncryptionEnabled": false } } ``` Para obter mais informações, consulte [Migração on-line para o ElastiCache](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/OnlineMigration.html) no *Guia do usuário Elasticache*. + Para ver detalhes da API, consulte [StartMigration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/start-migration.html) na *Referência de comandos da AWS CLI*. ### `test-failover` O código de exemplo a seguir mostra como usar `test-failover`. **AWS CLI** **Testar o failover de um grupo de nós** O exemplo `test-failover` a seguir testa o failover automático no grupo de nós especificado (chamado de fragmento no console) em um grupo de replicação (chamado de cluster no console). ``` aws elasticache test-failover / --replication-group-id "mycluster" / --node-group-id "0001" ``` Resultado: ``` { "ReplicationGroup": { "ReplicationGroupId": "mycluster", "Description": "My Cluster", "Status": "available", "PendingModifiedValues": {}, "MemberClusters": [ "mycluster-0001-001", "mycluster-0001-002", "mycluster-0001-003", "mycluster-0002-001", "mycluster-0002-002", "mycluster-0002-003", "mycluster-0003-001", "mycluster-0003-002", "mycluster-0003-003" ], "NodeGroups": [ { "NodeGroupId": "0001", "Status": "available", "Slots": "0-5461", "NodeGroupMembers": [ { "CacheClusterId": "mycluster-0001-001", "CacheNodeId": "0001", "PreferredAvailabilityZone": "us-west-2b" }, { "CacheClusterId": "mycluster-0001-002", "CacheNodeId": "0001", "PreferredAvailabilityZone": "us-west-2a" }, { "CacheClusterId": "mycluster-0001-003", "CacheNodeId": "0001", "PreferredAvailabilityZone": "us-west-2c" } ] }, { "NodeGroupId": "0002", "Status": "available", "Slots": "5462-10922", "NodeGroupMembers": [ { "CacheClusterId": "mycluster-0002-001", "CacheNodeId": "0001", "PreferredAvailabilityZone": "us-west-2a" }, { "CacheClusterId": "mycluster-0002-002", "CacheNodeId": "0001", "PreferredAvailabilityZone": "us-west-2b" }, { "CacheClusterId": "mycluster-0002-003", "CacheNodeId": "0001", "PreferredAvailabilityZone": "us-west-2c" } ] }, { "NodeGroupId": "0003", "Status": "available", "Slots": "10923-16383", "NodeGroupMembers": [ { "CacheClusterId": "mycluster-0003-001", "CacheNodeId": "0001", "PreferredAvailabilityZone": "us-west-2c" }, { "CacheClusterId": "mycluster-0003-002", "CacheNodeId": "0001", "PreferredAvailabilityZone": "us-west-2b" }, { "CacheClusterId": "mycluster-0003-003", "CacheNodeId": "0001", "PreferredAvailabilityZone": "us-west-2a" } ] } ], "AutomaticFailover": "enabled", "ConfigurationEndpoint": { "Address": "mycluster.xxxxih.clustercfg.usw2.cache.amazonaws.com", "Port": 6379 }, "SnapshotRetentionLimit": 1, "SnapshotWindow": "13:00-14:00", "ClusterEnabled": true, "CacheNodeType": "cache.r5.large", "TransitEncryptionEnabled": false, "AtRestEncryptionEnabled": false } } ``` + Para ver detalhes da API, consulte [TestFailover](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/test-failover.html) na *Referência de comandos da AWS CLI*. # Exemplos do MediaStore usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o MediaStore. *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 ### `create-container` O código de exemplo a seguir mostra como usar `create-container`. **AWS CLI** **Para criar um contêiner** O exemplo `create-container` a seguir cria um contêiner novo e vazio. ``` aws mediastore create-container --container-name ExampleContainer ``` Resultado: ``` { "Container": { "AccessLoggingEnabled": false, "CreationTime": 1563557265, "Name": "ExampleContainer", "Status": "CREATING", "ARN": "arn:aws:mediastore:us-west-2:111122223333:container/ExampleContainer" } } ``` Para obter mais informações, consulte [Criar um contêiner](https://docs.aws.amazon.com/mediastore/latest/ug/containers-create.html) no *Guia do usuário do AWS Elemental MediaStore*. + Para ver detalhes da API, consulte [CreateContainer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/create-container.html) na *Referência de comandos da AWS CLI*. ### `delete-container-policy` O código de exemplo a seguir mostra como usar `delete-container-policy`. **AWS CLI** **Para excluir uma política de contêiner** O exemplo `delete-container-policy` a seguir exclui a política atribuída ao contêiner especificado. Quando a política é excluída, o AWS Elemental MediaStore atribui automaticamente a política padrão ao contêiner. ``` aws mediastore delete-container-policy \ --container-name LiveEvents ``` Este comando não produz saída. Para obter mais informações, consulte [DeleteContainerPolicy](https://docs.aws.amazon.com/mediastore/latest/apireference/API_DeleteContainerPolicy.html) na *Referência da API do AWSElemental MediaStore*. + Para ver detalhes da API, consulte [DeleteContainerPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/delete-container-policy.html) na *Referência de comandos da AWS CLI*. ### `delete-container` O código de exemplo a seguir mostra como usar `delete-container`. **AWS CLI** **Para excluir um contêiner** O exemplo `delete-container` a seguir exclui o contêiner especificado. Você só pode excluir um contêiner se ele não tiver objetos. ``` aws mediastore delete-container \ --container-name=ExampleLiveDemo ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir um contêiner](https://docs.aws.amazon.com/mediastore/latest/ug/containers-delete.html) no *Guia do usuário do AWS Elemental MediaStore*. + Para ver detalhes da API, consulte [DeleteContainer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/delete-container.html) na *Referência de comandos da AWS CLI*. ### `delete-cors-policy` O código de exemplo a seguir mostra como usar `delete-cors-policy`. **AWS CLI** **Para excluir uma política de CORS** O exemplo `delete-cors-policy` a seguir exclui a política de compartilhamento entre recursos (CORS) atribuída ao contêiner especificado. ``` aws mediastore delete-cors-policy \ --container-name ExampleContainer ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir uma política CORS](https://docs.aws.amazon.com/mediastore/latest/ug/cors-policy-deleting.html) no *Guia do usuário do AWS Elemental MediaStore*. + Para ver detalhes da API, consulte [DeleteCorsPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/delete-cors-policy.html) na *Referência de comandos da AWS CLI*. ### `delete-lifecycle-policy` O código de exemplo a seguir mostra como usar `delete-lifecycle-policy`. **AWS CLI** **Para excluir uma política de ciclo de vida de objetos** O exemplo `delete-lifecycle-policy` a seguir exclui a política de ciclo de vida do objeto anexada ao contêiner especificado. Pode demorar até 20 minutos para que a alteração seja implementada. ``` aws mediastore delete-lifecycle-policy \ --container-name LiveEvents ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir uma política de ciclo de vida de um objeto](https://docs.aws.amazon.com/mediastore/latest/ug/policies-object-lifecycle-delete.html) no *Guia do usuário do AWS Elemental MediaStore*. + Para ver detalhes da API, consulte [DeleteLifecyclePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/delete-lifecycle-policy.html) na *Referência de comandos da AWS CLI*. ### `describe-container` O código de exemplo a seguir mostra como usar `describe-container`. **AWS CLI** **Como visualizar os detalhes de um contêiner** O exemplo `describe-container` a seguir exibe os detalhes do contêiner especificado. ``` aws mediastore describe-container \ --container-name ExampleContainer ``` Resultado: ``` { "Container": { "CreationTime": 1563558086, "AccessLoggingEnabled": false, "ARN": "arn:aws:mediastore:us-west-2:111122223333:container/ExampleContainer", "Status": "ACTIVE", "Name": "ExampleContainer", "Endpoint": "https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com" } } ``` Para obter mais informações, consulte [Visualizar detalhes de um contêiner](https://docs.aws.amazon.com/mediastore/latest/ug/containers-view-details.html) no *Guia do usuário do AWS Elemental MediaStore*. + Para ver detalhes da API, consulte [DescribeContainer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/describe-container.html) na *Referência de comandos da AWS CLI*. ### `describe-object` O código de exemplo a seguir mostra como usar `describe-object`. **AWS CLI** **Como visualizar uma lista de objetos e pastas em um contêiner específico** O exemplo `describe-object` a seguir exibe os itens (objetos e pastas) armazenados no contêiner especificado. ``` aws mediastore-data describe-object \ --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ --path /folder_name/file1234.jpg ``` Resultado: ``` { "ContentType": "image/jpeg", "LastModified": "Fri, 19 Jul 2019 21:32:20 GMT", "ContentLength": "2307346", "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3" } ``` Para obter mais informações, consulte [Visualizar detalhes de um objeto](https://docs.aws.amazon.com/mediastore/latest/ug/objects-view-details.html) no *Guia do usuário do AWS Elemental MediaStore*. + Para ver detalhes da API, consulte [DescribeObject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/describe-object.html) na *Referência de comandos da AWS CLI*. ### `get-container-policy` O código de exemplo a seguir mostra como usar `get-container-policy`. **AWS CLI** **Como visualizar uma política de contêiner** O exemplo `get-container-policy` a seguir exibe a política baseada em recursos do contêiner especificado. ``` aws mediastore get-container-policy \ --container-name ExampleLiveDemo ``` Resultado: ``` { "Policy": { "Version":"2012-10-17", "Statement": [ { "Sid": "PublicReadOverHttps", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111122223333:root" }, "Action": [ "mediastore:GetObject", "mediastore:DescribeObject" ], "Resource": "arn:aws:mediastore:us-west-2:111122223333:container/ExampleLiveDemo/", "Condition": { "Bool": { "aws:SecureTransport": "true" } } } ] } } ``` Para obter mais informações, consulte [Visualizar uma política de um contêiner](https://docs.aws.amazon.com/mediastore/latest/ug/policies-view.html) no *Guia do usuário do AWS Elemental MediaStore*. + Para ver detalhes da API, consulte [GetContainerPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/get-container-policy.html) na *Referência de comandos da AWS CLI*. ### `get-cors-policy` O código de exemplo a seguir mostra como usar `get-cors-policy`. **AWS CLI** **Como visualizar uma política de CORS** O exemplo `get-cors-policy` a seguir exibe a política de compartilhamento entre recursos (CORS) atribuída ao contêiner especificado. ``` aws mediastore get-cors-policy \ --container-name ExampleContainer \ --region us-west-2 ``` Resultado: ``` { "CorsPolicy": [ { "AllowedMethods": [ "GET", "HEAD" ], "MaxAgeSeconds": 3000, "AllowedOrigins": [ "" ], "AllowedHeaders": [ "" ] } ] } ``` Para obter mais informações, consulte [Visualizar uma política de CORS](https://docs.aws.amazon.com/mediastore/latest/ug/cors-policy-viewing.html) no *Guia do usuário do AWS Elemental MediaStore*. + Para ver detalhes da API, consulte [GetCorsPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/get-cors-policy.html) na *Referência de comandos da AWS CLI*. ### `get-lifecycle-policy` O código de exemplo a seguir mostra como usar `get-lifecycle-policy`. **AWS CLI** **Como visualizar uma política de ciclo de vida de um objeto** O exemplo `get-lifecycle-policy` a seguir exibe a política de ciclo de vida do objeto anexado ao contêiner especificado. ``` aws mediastore get-lifecycle-policy \ --container-name LiveEvents ``` Resultado: ``` { "LifecyclePolicy": { "rules": [ { "definition": { "path": [ { "prefix": "Football/" }, { "prefix": "Baseball/" } ], "days_since_create": [ { "numeric": [ ">", 28 ] } ] }, "action": "EXPIRE" } ] } } ``` Para obter mais informações, consulte [Visualizar uma política de ciclo de vida de um objeto](https://docs.aws.amazon.com/mediastore/latest/ug/policies-object-lifecycle-view.html) no *Guia do usuário do AWS Elemental MediaStore*. + Para ver detalhes da API, consulte [GetLifecyclePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/get-lifecycle-policy.html) na *Referência de comandos da AWS CLI*. ### `get-object` O código de exemplo a seguir mostra como usar `get-object`. **AWS CLI** **Como fazer download de um objeto** O exemplo `get-object` a seguir faz o download de um objeto no endpoint especificado. ``` aws mediastore-data get-object \ --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ --path=/folder_name/README.md README.md ``` Resultado: ``` { "ContentLength": "2307346", "ContentType": "image/jpeg", "LastModified": "Fri, 19 Jul 2019 21:32:20 GMT", "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3", "StatusCode": 200 } ``` **Para fazer o download de parte de um objeto** O exemplo `get-object` a seguir faz o download de um objeto no endpoint especificado. ``` aws mediastore-data get-object \ --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ --path /folder_name/README.md \ --range="bytes=0-100" README2.md ``` Resultado: ``` { "StatusCode": 206, "ContentRange": "bytes 0-100/2307346", "ContentLength": "101", "LastModified": "Fri, 19 Jul 2019 21:32:20 GMT", "ContentType": "image/jpeg", "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3" } ``` Para obter mais informações, consulte [Fazer download de um objeto](https://docs.aws.amazon.com/mediastore/latest/ug/objects-download.html) no *Guia do usuário do AWS Elemental MediaStore*. + Consulte detalhes da API em [GetObject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/get-object.html) na *Referência de comandos da AWS CLI*. ### `list-containers` O código de exemplo a seguir mostra como usar `list-containers`. **AWS CLI** **Como visualizar uma lista de contêineres** O exemplo `list-containers` a seguir da lista todos os contêineres associados à sua conta. ``` aws mediastore list-containers ``` Resultado: ``` { "Containers": [ { "CreationTime": 1505317931, "Endpoint": "https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com", "Status": "ACTIVE", "ARN": "arn:aws:mediastore:us-west-2:111122223333:container/ExampleLiveDemo", "AccessLoggingEnabled": false, "Name": "ExampleLiveDemo" }, { "CreationTime": 1506528818, "Endpoint": "https://fffggghhhiiijj.data.mediastore.us-west-2.amazonaws.com", "Status": "ACTIVE", "ARN": "arn:aws:mediastore:us-west-2:111122223333:container/ExampleContainer", "AccessLoggingEnabled": false, "Name": "ExampleContainer" } ] } ``` Para obter mais informações, consulte [Como visualizar uma lista de contêineres](https://docs.aws.amazon.com/mediastore/latest/ug/containers-view-list.html) no *Guia do usuário do AWS Elemental MediaStore*. + Para ver detalhes da API, consulte [ListContainers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/list-containers.html) na *Referência de comandos da AWS CLI*. ### `list-items` O código de exemplo a seguir mostra como usar `list-items`. **AWS CLI** **Exemplo 1: visualizar uma lista de objetos e pastas em um contêiner específico** O exemplo `list-items` a seguir exibe uma lista de itens (objetos e pastas) armazenados no contêiner especificado. ``` aws mediastore-data list-items \ --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com ``` Resultado: ``` { "Items": [ { "ContentType": "image/jpeg", "LastModified": 1563571859.379, "Name": "filename.jpg", "Type": "OBJECT", "ETag": "543ab21abcd1a234ab123456a1a2b12345ab12abc12a1234abc1a2bc12345a12", "ContentLength": 3784 }, { "Type": "FOLDER", "Name": "ExampleLiveDemo" } ] } ``` **Exemplo 2: visualizar uma lista de objetos e pastas em uma pasta específica** O exemplo `list-items` a seguir exibe os itens (objetos e pastas) armazenados na pasta especificada. ``` aws mediastore-data list-items \ --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com ``` Resultado: ``` { "Items": [ { "ContentType": "image/jpeg", "LastModified": 1563571859.379, "Name": "filename.jpg", "Type": "OBJECT", "ETag": "543ab21abcd1a234ab123456a1a2b12345ab12abc12a1234abc1a2bc12345a12", "ContentLength": 3784 }, { "Type": "FOLDER", "Name": "ExampleLiveDemo" } ] } ``` Para obter mais informações, consulte [Visualizar uma lista de objetos](https://docs.aws.amazon.com/mediastore/latest/ug/objects-view-list.html) no *Guia do usuário do AWS Elemental MediaStore*. + Para ver detalhes da API, consulte [ListItems](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/list-items.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar tags para um contêiner** O exemplo `list-tags-for-resource` a seguir exibe as chaves de tag e valores associados ao contêiner especificado. ``` aws mediastore list-tags-for-resource \ --resource arn:aws:mediastore:us-west-2:1213456789012:container/ExampleContainer ``` Resultado: ``` { "Tags": [ { "Value": "Test", "Key": "Environment" }, { "Value": "West", "Key": "Region" } ] } ``` Para obter mais informações, consulte [ListTagsForResource](https://docs.aws.amazon.com/mediastore/latest/apireference/API_ListTagsForResource.html) na *Referência da API AWS Elemental MediaStore*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `put-container-policy` O código de exemplo a seguir mostra como usar `put-container-policy`. **AWS CLI** **Como editar uma política de contêiner** O exemplo `put-container-policy` a seguir define uma política diferente ao contêiner especificado. Neste exemplo, a política atualizada é definida em um arquivo chamado `LiveEventsContainerPolicy.json`. ``` aws mediastore put-container-policy \ --container-name LiveEvents \ --policy file://LiveEventsContainerPolicy.json ``` Este comando não produz saída. Para obter mais informações, consulte [Editar uma política de um contêiner](https://docs.aws.amazon.com/mediastore/latest/ug/policies-edit.html) no *Guia do usuário do AWS Elemental MediaStore*. + Para ver detalhes da API, consulte [PutContainerPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/put-container-policy.html) na *Referência de comandos da AWS CLI*. ### `put-cors-policy` O código de exemplo a seguir mostra como usar `put-cors-policy`. **AWS CLI** **Exemplo 1: adicionar uma política de CORS** O exemplo `put-cors-policy` a seguir adiciona uma política de compartilhamento entre recursos (CORS) atribuída ao contêiner especificado. O conteúdo da política de CORS está no arquivo chamado `corsPolicy.json`. ``` aws mediastore put-cors-policy \ --container-name ExampleContainer \ --cors-policy file://corsPolicy.json ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar uma política de CORS a um contêiner](https://docs.aws.amazon.com/mediastore/latest/ug/cors-policy-adding.html) no *Guia do usuário do AWS Elemental MediaStore*. **Exemplo 2: editar uma política de CORS** O exemplo `put-cors-policy` a seguir atualiza a política de compartilhamento entre recursos (CORS) atribuída ao contêiner especificado. O conteúdo da política de CORS atualizada está no arquivo chamado `corsPolicy2.json`. Para obter mais informações, consulte [Editar uma política de CORS](https://docs.aws.amazon.com/mediastore/latest/ug/cors-policy-editing.html) no *Guia do usuário do AWS Elemental MediaStore*. + Para ver detalhes da API, consulte [PutCorsPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/put-cors-policy.html) na *Referência de comandos da AWS CLI*. ### `put-lifecycle-policy` O código de exemplo a seguir mostra como usar `put-lifecycle-policy`. **AWS CLI** **Para criar uma política de ciclo de vida de objetos** O exemplo `put-lifecycle-policy` a anexa uma política de ciclo de vida de um objeto ao contêiner especificado. Isso permite especificar por quanto tempo o serviço deve armazenar objetos em seu contêiner. O MediaStore exclui objetos no contêiner quando eles atingem a data de expiração, conforme indicado na política, que está no arquivo chamado `LiveEventsLifecyclePolicy.json`. ``` aws mediastore put-lifecycle-policy \ --container-name ExampleContainer \ --lifecycle-policy file://ExampleLifecyclePolicy.json ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar uma política de ciclo de vida de objetos a um contêiner](https://docs.aws.amazon.com/mediastore/latest/ug/policies-object-lifecycle-add.html) no *Guia do usuário do AWS Elemental MediaStore*. + Para ver detalhes da API, consulte [PutLifecyclePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/put-lifecycle-policy.html) na *Referência de comandos da AWS CLI*. ### `put-object` O código de exemplo a seguir mostra como usar `put-object`. **AWS CLI** **Como fazer upload de um objeto** O exemplo `put-object` a seguir faz upload de um objeto no contêiner especificado. É possível especificar um caminho de pasta no qual o objeto será salvo dentro do contêiner. Se a pasta já existir, o AWS Elemental MediaStore armazenará o objeto na pasta. Se a pasta não existir, o serviço a cria e, em seguida, armazena o objeto na pasta. ``` aws mediastore-data put-object \ --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ --body README.md \ --path /folder_name/README.md \ --cache-control "max-age=6, public" \ --content-type binary/octet-stream ``` Resultado: ``` { "ContentSHA256": "74b5fdb517f423ed750ef214c44adfe2be36e37d861eafe9c842cbe1bf387a9d", "StorageClass": "TEMPORAL", "ETag": "af3e4731af032167a106015d1f2fe934e68b32ed1aa297a9e325f5c64979277b" } ``` Para obter mais informações, consulte [Fazer upload de um objeto](https://docs.aws.amazon.com/mediastore/latest/ug/objects-upload.html) no *Guia do usuário do AWS Elemental MediaStore*. + Consulte detalhes da API em [PutObject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/put-object.html) na *Referência de comandos da AWS CLI*. ### `start-access-logging` O código de exemplo a seguir mostra como usar `start-access-logging`. **AWS CLI** **Como ativar o log de acesso a um contêiner** O exemplo `start-access-logging` a seguir ativa o log de acesso ao contêiner especificado. ``` aws mediastore start-access-logging \ --container-name LiveEvents ``` Este comando não produz saída. Para obter mais informações, consulte [Ativar o log de acesso a um contêiner](https://docs.aws.amazon.com/mediastore/latest/ug/monitoring-cloudwatch-logs-enable.html) no *Guia do usuário do AWS Elemental MediaStore*. + Para ver detalhes da API, consulte [StartAccessLogging](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/start-access-logging.html) na *Referência de comandos da AWS CLI*. ### `stop-access-logging` O código de exemplo a seguir mostra como usar `stop-access-logging`. **AWS CLI** **Para desativar o log de acesso a um contêiner** O exemplo `stop-access-logging` a seguir desativa o log de acesso ao contêiner especificado. ``` aws mediastore stop-access-logging \ --container-name LiveEvents ``` Este comando não produz saída. Para obter mais informações, consulte [Desativar o log de acesso a um contêiner](https://docs.aws.amazon.com/mediastore/latest/ug/monitoring-cloudwatch-logs-disable.html) no *Guia do usuário do AWS Elemental MediaStore*. + Para ver detalhes da API, consulte [StopAccessLogging](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/stop-access-logging.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Para adicionar tags a um contêiner** O exemplo `tag-resource` a seguir adiciona as chaves de tag e valores associados ao contêiner especificado. ``` aws mediastore tag-resource \ --resource arn:aws:mediastore:us-west-2:123456789012:container/ExampleContainer \ --tags '[{"Key": "Region", "Value": "West"}, {"Key": "Environment", "Value": "Test"}]' ``` Este comando não produz saída. Para obter mais informações, consulte [TagResource](https://docs.aws.amazon.com/mediastore/latest/apireference/API_TagResource.html) na *Referência da API AWS Elemental MediaStore*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover tags de um contêiner** O exemplo `untag-resource` a seguir remove a tag com o nome de chave especificado e seu valor associado de um contêiner. ``` aws mediastore untag-resource \ --resource arn:aws:mediastore:us-west-2:123456789012:container/ExampleContainer \ --tag-keys Region ``` Este comando não produz saída. Para obter mais informações, consulte [UntagResource](https://docs.aws.amazon.com/mediastore/latest/apireference/API_UntagResource.html) na *Referência da API AWS Elemental MediaStore*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/untag-resource.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon EMR usando o AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Amazon EMR. *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-instance-fleet` O código de exemplo a seguir mostra como usar `add-instance-fleet`. **AWS CLI** **Adicionar uma frota de instâncias de tarefa a um cluster** Este exemplo adiciona uma nova frota de instâncias de tarefas ao cluster especificado. Comando: ``` aws emr add-instance-fleet --cluster-id 'j-12ABCDEFGHI34JK' --instance-fleet InstanceFleetType=TASK,TargetSpotCapacity=1,LaunchSpecifications={SpotSpecification='{TimeoutDurationMinutes=20,TimeoutAction=TERMINATE_CLUSTER}'},InstanceTypeConfigs=['{InstanceType=m3.xlarge,BidPrice=0.5}'] ``` Resultado: ``` { "ClusterId": "j-12ABCDEFGHI34JK", "InstanceFleetId": "if-23ABCDEFGHI45JJ" } ``` + Para ver detalhes da API, consulte [AddInstanceFleet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/add-instance-fleet.html) na *Referência de comandos da AWS CLI*. ### `add-steps` O código de exemplo a seguir mostra como usar `add-steps`. **AWS CLI** **1. Adicionar uma etapa JAR personalizada a um cluster** Comando: ``` aws emr add-steps --cluster-id j-XXXXXXXX --steps Type=CUSTOM_JAR,Name=CustomJAR,ActionOnFailure=CONTINUE,Jar=s3://amzn-s3-demo-bucket/mytest.jar,Args=arg1,arg2,arg3 Type=CUSTOM_JAR,Name=CustomJAR,ActionOnFailure=CONTINUE,Jar=s3://amzn-s3-demo-bucket/mytest.jar,MainClass=mymainclass,Args=arg1,arg2,arg3 ``` Parâmetros obrigatórios: ``` Jar ``` Parâmetros opcionais: ``` Type, Name, ActionOnFailure, Args ``` Resultado: ``` { "StepIds":[ "s-XXXXXXXX", "s-YYYYYYYY" ] } ``` **2. Adicionar etapas de transmissão a um cluster** Comando: ``` aws emr add-steps --cluster-id j-XXXXXXXX --steps Type=STREAMING,Name='Streaming Program',ActionOnFailure=CONTINUE,Args=[-files,s3://elasticmapreduce/samples/wordcount/wordSplitter.py,-mapper,wordSplitter.py,-reducer,aggregate,-input,s3://elasticmapreduce/samples/wordcount/input,-output,s3://amzn-s3-demo-bucket/wordcount/output] ``` Parâmetros obrigatórios: ``` Type, Args ``` Parâmetros opcionais: ``` Name, ActionOnFailure ``` Equivalente em JSON (conteúdo de step.json): ``` [ { "Name": "JSON Streaming Step", "Args": ["-files","s3://elasticmapreduce/samples/wordcount/wordSplitter.py","-mapper","wordSplitter.py","-reducer","aggregate","-input","s3://elasticmapreduce/samples/wordcount/input","-output","s3://amzn-s3-demo-bucket/wordcount/output"], "ActionOnFailure": "CONTINUE", "Type": "STREAMING" } ] ``` OBSERVAÇÃO: os argumentos JSON devem incluir opções e valores como seus próprios itens na lista. Comando (usando step.json): ``` aws emr add-steps --cluster-id j-XXXXXXXX --steps file://./step.json ``` Resultado: ``` { "StepIds":[ "s-XXXXXXXX", "s-YYYYYYYY" ] } ``` **3. Adicionar uma etapa de transmissão com vários arquivos a um cluster (somente JSON)** JSON (vários arquivos.json): ``` [ { "Name": "JSON Streaming Step", "Type": "STREAMING", "ActionOnFailure": "CONTINUE", "Args": [ "-files", "s3://amzn-s3-demo-bucket/mapper.py,s3://amzn-s3-demo-bucket/reducer.py", "-mapper", "mapper.py", "-reducer", "reducer.py", "-input", "s3://amzn-s3-demo-bucket/input", "-output", "s3://amzn-s3-demo-bucket/output"] } ] ``` Comando: ``` aws emr add-steps --cluster-id j-XXXXXXXX --steps file://./multiplefiles.json ``` Parâmetros obrigatórios: ``` Type, Args ``` Parâmetros opcionais: ``` Name, ActionOnFailure ``` Resultado: ``` { "StepIds":[ "s-XXXXXXXX", ] } ``` **4. Adicionar etapas Hive a um cluster** Comando: ``` aws emr add-steps --cluster-id j-XXXXXXXX --steps Type=HIVE,Name='Hive program',ActionOnFailure=CONTINUE,Args=[-f,s3://amzn-s3-demo-bucket/myhivescript.q,-d,INPUT=s3://amzn-s3-demo-bucket/myhiveinput,-d,OUTPUT=s3://amzn-s3-demo-bucket/myhiveoutput,arg1,arg2] Type=HIVE,Name='Hive steps',ActionOnFailure=TERMINATE_CLUSTER,Args=[-f,s3://elasticmapreduce/samples/hive-ads/libs/model-build.q,-d,INPUT=s3://elasticmapreduce/samples/hive-ads/tables,-d,OUTPUT=s3://amzn-s3-demo-bucket/hive-ads/output/2014-04-18/11-07-32,-d,LIBS=s3://elasticmapreduce/samples/hive-ads/libs] ``` Parâmetros obrigatórios: ``` Type, Args ``` Parâmetros opcionais: ``` Name, ActionOnFailure ``` Resultado: ``` { "StepIds":[ "s-XXXXXXXX", "s-YYYYYYYY" ] } ``` **5. Adicionar etapas Pig a um cluster** Comando: ``` aws emr add-steps --cluster-id j-XXXXXXXX --steps Type=PIG,Name='Pig program',ActionOnFailure=CONTINUE,Args=[-f,s3://amzn-s3-demo-bucket/mypigscript.pig,-p,INPUT=s3://amzn-s3-demo-bucket/mypiginput,-p,OUTPUT=s3://amzn-s3-demo-bucket/mypigoutput,arg1,arg2] Type=PIG,Name='Pig program',Args=[-f,s3://elasticmapreduce/samples/pig-apache/do-reports2.pig,-p,INPUT=s3://elasticmapreduce/samples/pig-apache/input,-p,OUTPUT=s3://amzn-s3-demo-bucket/pig-apache/output,arg1,arg2] ``` Parâmetros obrigatórios: ``` Type, Args ``` Parâmetros opcionais: ``` Name, ActionOnFailure ``` Resultado: ``` { "StepIds":[ "s-XXXXXXXX", "s-YYYYYYYY" ] } ``` **6. Adicionar etapas Impala a um cluster** Comando: ``` aws emr add-steps --cluster-id j-XXXXXXXX --steps Type=IMPALA,Name='Impala program',ActionOnFailure=CONTINUE,Args=--impala-script,s3://myimpala/input,--console-output-path,s3://myimpala/output ``` Parâmetros obrigatórios: ``` Type, Args ``` Parâmetros opcionais: ``` Name, ActionOnFailure ``` Resultado: ``` { "StepIds":[ "s-XXXXXXXX", "s-YYYYYYYY" ] } ``` + Para ver detalhes da API, consulte [AddSteps](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/add-steps.html) na *Referência de comandos da AWS CLI*. ### `add-tags` O código de exemplo a seguir mostra como usar `add-tags`. **AWS CLI** **1. Adicionar tags a um cluster** Comando: ``` aws emr add-tags --resource-id j-xxxxxxx --tags name="John Doe" age=29 sex=male address="123 East NW Seattle" ``` Resultado: ``` None ``` **2. Listar as tags de um cluster** --Comando: ``` aws emr describe-cluster --cluster-id j-XXXXXXYY --query Cluster.Tags ``` Resultado: ``` [ { "Value": "male", "Key": "sex" }, { "Value": "123 East NW Seattle", "Key": "address" }, { "Value": "John Doe", "Key": "name" }, { "Value": "29", "Key": "age" } ] ``` + Para ver detalhes da API, consulte [AddTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/add-tags.html) na *Referência de comandos da AWS CLI*. ### `create-cluster-examples` O código de exemplo a seguir mostra como usar `create-cluster-examples`. **AWS CLI** A maioria dos exemplos a seguir pressupõe que você especificou seu perfil de serviço do Amazon EMR e o perfil de instância do Amazon EC2. Se você não tiver feito isso, deverá especificar cada perfil do IAM necessário ou usar o parâmetro `--use-default-roles` ao criar seu cluster. Para obter mais informações sobre a especificação de perfis do IAM, consulte [Configurar perfis do IAM para permissões do Amazon EMR em serviços da AWS](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-iam-roles.html) no *Guia de Gerenciamento do Amazon EMR*. **Exemplo 1: criar um cluster** O exemplo `create-cluster` a seguir cria um cluster EMR simples. ``` aws emr create-cluster \ --release-label emr-5.14.0 \ --instance-type m4.large \ --instance-count 2 ``` Este comando não produz saída. **Exemplo 2: criar um cluster do Amazon EMR com os perfis padrão ServiceRole e InstanceProfile** O exemplo `create-cluster` a seguir cria um cluster do Amazon EMR que usa a configuração `--instance-groups`. ``` aws emr create-cluster \ --release-label emr-5.14.0 \ --service-role EMR_DefaultRole \ --ec2-attributes InstanceProfile=EMR_EC2_DefaultRole \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large ``` **Exemplo 3: criar um cluster do Amazon EMR que usa uma frota de instâncias** O exemplo `create-cluster` a seguir cria um cluster do Amazon EMR que usa a configuração `--instance-fleets`, especificando dois tipos de instância para cada frota e duas sub-redes EC2. ``` aws emr create-cluster \ --release-label emr-5.14.0 \ --service-role EMR_DefaultRole \ --ec2-attributes InstanceProfile=EMR_EC2_DefaultRole,SubnetIds=['subnet-ab12345c','subnet-de67890f'] \ --instance-fleets InstanceFleetType=MASTER,TargetOnDemandCapacity=1,InstanceTypeConfigs=['{InstanceType=m4.large}'] InstanceFleetType=CORE,TargetSpotCapacity=11,InstanceTypeConfigs=['{InstanceType=m4.large,BidPrice=0.5,WeightedCapacity=3}','{InstanceType=m4.2xlarge,BidPrice=0.9,WeightedCapacity=5}'],LaunchSpecifications={SpotSpecification='{TimeoutDurationMinutes=120,TimeoutAction=SWITCH_TO_ON_DEMAND}'} ``` **Exemplo 4: criar um cluster com funções padrão** O exemplo `create-cluster` a seguir usa o parâmetro `--use-default-roles` para especificar o perfil de serviço padrão e o perfil de instância. ``` aws emr create-cluster \ --release-label emr-5.9.0 \ --use-default-roles \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ --auto-terminate ``` **Exemplo 5: criar um cluster e especificar as aplicações a serem instaladas** O exemplo `create-cluster` a seguir usa o parâmetro `--applications` para especificar as aplicações que o Amazon EMR instala. Este exemplo instala o Hadoop, o Hive e o Pig. ``` aws emr create-cluster \ --applications Name=Hadoop Name=Hive Name=Pig \ --release-label emr-5.9.0 \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ --auto-terminate ``` **Exemplo 6: criar um cluster que inclua o Spark** O exemplo a seguir instala o Spark. ``` aws emr create-cluster \ --release-label emr-5.9.0 \ --applications Name=Spark \ --ec2-attributes KeyName=myKey \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ --auto-terminate ``` **Exemplo 7: especificar uma AMI personalizada para usar em instâncias de cluster** O exemplo `create-cluster` a seguir cria uma instância de cluster com base na Amazon Linux AMI com ID `ami-a518e6df`. ``` aws emr create-cluster \ --name "Cluster with My Custom AMI" \ --custom-ami-id ami-a518e6df \ --ebs-root-volume-size 20 \ --release-label emr-5.9.0 \ --use-default-roles \ --instance-count 2 \ --instance-type m4.large ``` **Exemplo 8: personalizar as configurações da aplicação** Os exemplos a seguir usam o parâmetro `--configurations` para especificar um arquivo de configuração JSON que contém personalizações de aplicações para o Hadoop. Para obter mais informações, consulte [Configurar aplicações](https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-configure-apps.html) no *Guia de versão do Amazon EMR*. Conteúdo de `configurations.json`: ``` [ { "Classification": "mapred-site", "Properties": { "mapred.tasktracker.map.tasks.maximum": 2 } }, { "Classification": "hadoop-env", "Properties": {}, "Configurations": [ { "Classification": "export", "Properties": { "HADOOP_DATANODE_HEAPSIZE": 2048, "HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19" } } ] } ] ``` O exemplo a seguir faz referência ao `configurations.json` como um arquivo local. ``` aws emr create-cluster \ --configurations file://configurations.json \ --release-label emr-5.9.0 \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ --auto-terminate ``` O exemplo a seguir faz referência ao `configurations.json` como um arquivo no Amazon S3. ``` aws emr create-cluster \ --configurations https://s3.amazonaws.com/amzn-s3-demo-bucket/configurations.json \ --release-label emr-5.9.0 \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ --auto-terminate ``` **Exemplo 9: criar um cluster com grupos de instâncias mestre, principal e de tarefas** O exemplo `create-cluster` a seguir usa `--instance-groups` para especificar o tipo e o número de instâncias do EC2 a serem usadas para grupos de instâncias principal, central e de tarefa. ``` aws emr create-cluster \ --release-label emr-5.9.0 \ --instance-groups Name=Master,InstanceGroupType=MASTER,InstanceType=m4.large,InstanceCount=1 Name=Core,InstanceGroupType=CORE,InstanceType=m4.large,InstanceCount=2 Name=Task,InstanceGroupType=TASK,InstanceType=m4.large,InstanceCount=2 ``` **Exemplo 10: especificar que um cluster deve ser encerrado após a conclusão de todas as etapas** O exemplo `create-cluster` a seguir usa `--auto-terminate` para especificar que o cluster deve ser desligado automaticamente após a conclusão de todas as etapas. ``` aws emr create-cluster \ --release-label emr-5.9.0 \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ --auto-terminate ``` **Exemplo 11: especificar detalhes da configuração do cluster, como o par de chaves do Amazon EC2, a configuração da rede e os grupos de segurança** O exemplo `create-cluster` a seguir cria um cluster com o par de chaves do Amazon EC2 chamado `myKey` e um perfil de instância personalizado chamado `myProfile`. Os pares de chaves são usados para autorizar conexões SSH com os nós do cluster, geralmente o nó principal. Para obter mais informações, consulte [Usar um par de chaves Amazon EC2 para credenciais SSH](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-access-ssh.html) no *Guia de gerenciamento do Amazon EMR*. ``` aws emr create-cluster \ --ec2-attributes KeyName=myKey,InstanceProfile=myProfile \ --release-label emr-5.9.0 \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ --auto-terminate ``` O exemplo a seguir cria um cluster em uma sub-rede do Amazon VPC. ``` aws emr create-cluster \ --ec2-attributes SubnetId=subnet-xxxxx \ --release-label emr-5.9.0 \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ --auto-terminate ``` O exemplo a seguir cria um cluster na zona de disponibilidade `us-east-1b`. ``` aws emr create-cluster \ --ec2-attributes AvailabilityZone=us-east-1b \ --release-label emr-5.9.0 \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large ``` O exemplo a seguir cria um cluster e especifica somente os grupos de segurança gerenciados pelo Amazon EMR. ``` aws emr create-cluster \ --release-label emr-5.9.0 \ --service-role myServiceRole \ --ec2-attributes InstanceProfile=myRole,EmrManagedMasterSecurityGroup=sg-master1,EmrManagedSlaveSecurityGroup=sg-slave1 \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large ``` O exemplo a seguir cria um cluster e especifica somente grupos de segurança adicionais do Amazon EC2. ``` aws emr create-cluster \ --release-label emr-5.9.0 \ --service-role myServiceRole \ --ec2-attributes InstanceProfile=myRole,AdditionalMasterSecurityGroups=[sg-addMaster1,sg-addMaster2,sg-addMaster3,sg-addMaster4],AdditionalSlaveSecurityGroups=[sg-addSlave1,sg-addSlave2,sg-addSlave3,sg-addSlave4] \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large ``` O exemplo a seguir cria um cluster e especifica os grupos de segurança gerenciados pelo EMR, bem como grupos de segurança adicionais. ``` aws emr create-cluster \ --release-label emr-5.9.0 \ --service-role myServiceRole \ --ec2-attributes InstanceProfile=myRole,EmrManagedMasterSecurityGroup=sg-master1,EmrManagedSlaveSecurityGroup=sg-slave1,AdditionalMasterSecurityGroups=[sg-addMaster1,sg-addMaster2,sg-addMaster3,sg-addMaster4],AdditionalSlaveSecurityGroups=[sg-addSlave1,sg-addSlave2,sg-addSlave3,sg-addSlave4] \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large ``` O exemplo a seguir cria um cluster em uma sub-rede privada VPC e usa um grupo de segurança específico do Amazon EC2 para permitir o acesso ao serviço Amazon EMR, o que é necessário para clusters em sub-redes privadas. ``` aws emr create-cluster \ --release-label emr-5.9.0 \ --service-role myServiceRole \ --ec2-attributes InstanceProfile=myRole,ServiceAccessSecurityGroup=sg-service-access,EmrManagedMasterSecurityGroup=sg-master,EmrManagedSlaveSecurityGroup=sg-slave \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large ``` O exemplo a seguir especifica os parâmetros de configuração do grupo de segurança usando um arquivo JSON chamado `ec2_attributes.json` que é armazenado localmente. OBSERVAÇÃO: os argumentos JSON devem incluir opções e valores como seus próprios itens na lista. ``` aws emr create-cluster \ --release-label emr-5.9.0 \ --service-role myServiceRole \ --ec2-attributes file://ec2_attributes.json \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large ``` Conteúdo de `ec2_attributes.json`: ``` [ { "SubnetId": "subnet-xxxxx", "KeyName": "myKey", "InstanceProfile":"myRole", "EmrManagedMasterSecurityGroup": "sg-master1", "EmrManagedSlaveSecurityGroup": "sg-slave1", "ServiceAccessSecurityGroup": "sg-service-access", "AdditionalMasterSecurityGroups": ["sg-addMaster1","sg-addMaster2","sg-addMaster3","sg-addMaster4"], "AdditionalSlaveSecurityGroups": ["sg-addSlave1","sg-addSlave2","sg-addSlave3","sg-addSlave4"] } ] ``` **Exemplo 12: habilitar a depuração e especificar um URI de log** O exemplo `create-cluster` a seguir usa o parâmetro `--enable-debugging`, que permite que você visualize arquivos de log com mais facilidade usando a ferramenta de depuração no console do Amazon EMR. O parâmetro `--log-uri` é obrigatório com o `--enable-debugging`. ``` aws emr create-cluster \ --enable-debugging \ --log-uri s3://amzn-s3-demo-bucket/myLog \ --release-label emr-5.9.0 \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ --auto-terminate ``` **Exemplo 13: adicionar tags ao criar um cluster** As tags são pares de chave-valor que ajudam você a identificar e gerenciar clusters. O exemplo `create-cluster` a seguir usa o parâmetro `--tags` para criar três tags para um cluster, uma com o nome da chave `name` e o valor `Shirley Rodriguez`, uma segunda com o nome da chave `age` e o valor `29` e uma terceira tag com o nome da chave `department` e o valor `Analytics`. ``` aws emr create-cluster \ --tags name="Shirley Rodriguez" age=29 department="Analytics" \ --release-label emr-5.32.0 \ --instance-type m5.xlarge \ --instance-count 3 \ --use-default-roles ``` O exemplo a seguir lista as tags aplicadas a um cluster. ``` aws emr describe-cluster \ --cluster-id j-XXXXXXYY \ --query Cluster.Tags ``` **Exemplo 14: usar uma configuração de segurança que habilite a criptografia e outros atributos de segurança** O exemplo `create-cluster` a seguir usa o parâmetro `--security-configuration` para especificar uma configuração de segurança para um cluster do EMR. Você pode usar configurações de segurança com o Amazon EMR versão 4.8.0 ou posterior. ``` aws emr create-cluster \ --instance-type m4.large \ --release-label emr-5.9.0 \ --security-configuration mySecurityConfiguration ``` **Exemplo 15: criar um cluster com volumes de armazenamento adicionais do EBS configurados para os grupos de instâncias** Ao especificar volumes adicionais do EBS, os seguintes argumentos são obrigatórios: `VolumeType`, `SizeInGB` se `EbsBlockDeviceConfigs` for especificado. O exemplo `create-cluster` a seguir cria um cluster com vários volumes do EBS anexados às instâncias do EC2 no grupo de instâncias principal. ``` aws emr create-cluster \ --release-label emr-5.9.0 \ --use-default-roles \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=d2.xlarge 'InstanceGroupType=CORE,InstanceCount=2,InstanceType=d2.xlarge,EbsConfiguration={EbsOptimized=true,EbsBlockDeviceConfigs=[{VolumeSpecification={VolumeType=gp2,SizeInGB=100}},{VolumeSpecification={VolumeType=io1,SizeInGB=100,Iops=100},VolumesPerInstance=4}]}' \ --auto-terminate ``` O exemplo a seguir cria um cluster com vários volumes do EBS anexados às instâncias do EC2 no grupo de instâncias mestre. ``` aws emr create-cluster \ --release-label emr-5.9.0 \ --use-default-roles \ --instance-groups 'InstanceGroupType=MASTER, InstanceCount=1, InstanceType=d2.xlarge, EbsConfiguration={EbsOptimized=true, EbsBlockDeviceConfigs=[{VolumeSpecification={VolumeType=io1, SizeInGB=100, Iops=100}},{VolumeSpecification={VolumeType=standard,SizeInGB=50},VolumesPerInstance=3}]}' InstanceGroupType=CORE,InstanceCount=2,InstanceType=d2.xlarge \ --auto-terminate ``` **Exemplo 16: criar um cluster com uma política de escala automática** Você pode anexar políticas de escala automática a grupos de instâncias principais e de tarefas usando o Amazon EMR versão 4.0 e versões posteriores. A política de escala automática adiciona e remove dinamicamente instâncias do EC2 em resposta a uma métrica do Amazon CloudWatch. Para obter mais informações, consulte Uso da escalabilidade automática no Amazon EMR `\$1 no *Guia de gerenciamento do Amazon EMR*. Ao anexar uma política de escala automática, você também deve especificar o perfil padrão para a escala automática usando o `--auto-scaling-role EMR_AutoScaling_DefaultRole`. O exemplo `create-cluster` a seguir especifica a política de escala automática para o grupo de instâncias `CORE` usando o argumento `AutoScalingPolicy` com uma estrutura JSON incorporada, que especifica a configuração da política de escala. Grupos de instâncias com uma estrutura JSON incorporada devem ter toda a coleção de argumentos entre aspas simples. Usar aspas simples é opcional para grupos de instâncias sem uma estrutura JSON incorporada. ``` aws emr create-cluster --release-label emr-5.9.0 \ --use-default-roles --auto-scaling-role EMR_AutoScaling_DefaultRole \ --instance-groups InstanceGroupType=MASTER,InstanceType=d2.xlarge,InstanceCount=1 'InstanceGroupType=CORE,InstanceType=d2.xlarge,InstanceCount=2,AutoScalingPolicy={Constraints={MinCapacity=1,MaxCapacity=5},Rules=[{Name=TestRule,Description=TestDescription,Action={Market=ON_DEMAND,SimpleScalingPolicyConfiguration={AdjustmentType=EXACT_CAPACITY,ScalingAdjustment=2}},Trigger={CloudWatchAlarmDefinition={ComparisonOperator=GREATER_THAN,EvaluationPeriods=5,MetricName=TestMetric,Namespace=EMR,Period=3,Statistic=MAXIMUM,Threshold=4.5,Unit=NONE,Dimensions=[{Key=TestKey,Value=TestValue}]}}}]}' ``` O exemplo a seguir usa um arquivo JSON, `instancegroupconfig.json`, para especificar a configuração de todos os grupos de instâncias em um cluster. O arquivo JSON especifica a configuração automática da política de escalabilidade para o grupo de instâncias principal. ``` aws emr create-cluster \ --release-label emr-5.9.0 \ --service-role EMR_DefaultRole \ --ec2-attributes InstanceProfile=EMR_EC2_DefaultRole \ --instance-groups file://myfolder/instancegroupconfig.json \ --auto-scaling-role EMR_AutoScaling_DefaultRole ``` Conteúdo de `instancegroupconfig.json`: ``` [ { "InstanceCount": 1, "Name": "MyMasterIG", "InstanceGroupType": "MASTER", "InstanceType": "m4.large" }, { "InstanceCount": 2, "Name": "MyCoreIG", "InstanceGroupType": "CORE", "InstanceType": "m4.large", "AutoScalingPolicy": { "Constraints": { "MinCapacity": 2, "MaxCapacity": 10 }, "Rules": [ { "Name": "Default-scale-out", "Description": "Replicates the default scale-out rule in the console for YARN memory.", "Action": { "SimpleScalingPolicyConfiguration": { "AdjustmentType": "CHANGE_IN_CAPACITY", "ScalingAdjustment": 1, "CoolDown": 300 } }, "Trigger": { "CloudWatchAlarmDefinition": { "ComparisonOperator": "LESS_THAN", "EvaluationPeriods": 1, "MetricName": "YARNMemoryAvailablePercentage", "Namespace": "AWS/ElasticMapReduce", "Period": 300, "Threshold": 15, "Statistic": "AVERAGE", "Unit": "PERCENT", "Dimensions": [ { "Key": "JobFlowId", "Value": "${emr.clusterId}" } ] } } } ] } } ] ``` **Exemplo 17: adicionar etapas JAR personalizadas ao criar um cluster** O exemplo `create-cluster` a seguir adiciona etapas especificando um arquivo JAR armazenado no Amazon S3. Etapas para enviar trabalhos a um cluster. A função principal definida no arquivo JAR é executada depois que as instâncias do EC2 são provisionadas, todas as ações de bootstrap são executadas e as aplicações são instaladas. As etapas são especificadas usando `Type=CUSTOM_JAR`. As etapas personalizadas do JAR exigem o parâmetro `Jar=`, que especifica o caminho e o nome do arquivo do JAR. Os parâmetros opcionais são `Type`, `Name`, `ActionOnFailure`, `Args` e `MainClass`. Se uma classe principal não for especificada, o arquivo JAR deverá especificar `Main-Class` em seu arquivo manifesto. ``` aws emr create-cluster \ --steps Type=CUSTOM_JAR,Name=CustomJAR,ActionOnFailure=CONTINUE,Jar=s3://amzn-s3-demo-bucket/mytest.jar,Args=arg1,arg2,arg3 Type=CUSTOM_JAR,Name=CustomJAR,ActionOnFailure=CONTINUE,Jar=s3://amzn-s3-demo-bucket/mytest.jar,MainClass=mymainclass,Args=arg1,arg2,arg3 \ --release-label emr-5.3.1 \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ --auto-terminate ``` **Exemplo 18: adicionar etapas de transmissão ao criar um cluster** Os exemplos `create-cluster` a seguir adicionam uma etapa de transmissão a um cluster que termina após a execução de todas as etapas. As etapas de transmissão exigem parâmetros `Type` e `Args`. Os parâmetros opcionais das etapas de transmissão são `Name` e `ActionOnFailure`. O exemplo a seguir especifica a etapa na linha. ``` aws emr create-cluster \ --steps Type=STREAMING,Name='Streaming Program',ActionOnFailure=CONTINUE,Args=[-files,s3://elasticmapreduce/samples/wordcount/wordSplitter.py,-mapper,wordSplitter.py,-reducer,aggregate,-input,s3://elasticmapreduce/samples/wordcount/input,-output,s3://amzn-s3-demo-bucket/wordcount/output] \ --release-label emr-5.3.1 \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ --auto-terminate ``` O exemplo a seguir usa um arquivo de configuração JSON armazenado localmente chamado `multiplefiles.json`. A configuração JSON especifica vários arquivos. Para especificar vários arquivos em uma etapa, você deve usar um arquivo de configuração JSON para especificar a etapa. Os argumentos JSON devem incluir opções e valores como seus próprios itens na lista. ``` aws emr create-cluster \ --steps file://./multiplefiles.json \ --release-label emr-5.9.0 \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ --auto-terminate ``` Conteúdo de `multiplefiles.json`: ``` [ { "Name": "JSON Streaming Step", "Args": [ "-files", "s3://elasticmapreduce/samples/wordcount/wordSplitter.py", "-mapper", "wordSplitter.py", "-reducer", "aggregate", "-input", "s3://elasticmapreduce/samples/wordcount/input", "-output", "s3://amzn-s3-demo-bucket/wordcount/output" ], "ActionOnFailure": "CONTINUE", "Type": "STREAMING" } ] ``` **Exemplo 19: adicionar etapas do Hive ao criar um cluster** O exemplo a seguir adiciona etapas do Hive ao criar um cluster. As etapas do Hive requerem os parâmetros `Type` e `Args`. Os parâmetros opcionais das etapas do Hive são `Name` e `ActionOnFailure`. ``` aws emr create-cluster \ --steps Type=HIVE,Name='Hive program',ActionOnFailure=CONTINUE,ActionOnFailure=TERMINATE_CLUSTER,Args=[-f,s3://elasticmapreduce/samples/hive-ads/libs/model-build.q,-d,INPUT=s3://elasticmapreduce/samples/hive-ads/tables,-d,OUTPUT=s3://amzn-s3-demo-bucket/hive-ads/output/2014-04-18/11-07-32,-d,LIBS=s3://elasticmapreduce/samples/hive-ads/libs] \ --applications Name=Hive \ --release-label emr-5.3.1 \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large ``` **Exemplo 20: adicionar etapas do Pig ao criar um cluster** O exemplo a seguir adiciona etapas do Pig ao criar um cluster. Os parâmetros necessários para as etapas do Pig são `Type` e `Args`. Os parâmetros opcionais das etapas do Pig são `Name` e `ActionOnFailure`. ``` aws emr create-cluster \ --steps Type=PIG,Name='Pig program',ActionOnFailure=CONTINUE,Args=[-f,s3://elasticmapreduce/samples/pig-apache/do-reports2.pig,-p,INPUT=s3://elasticmapreduce/samples/pig-apache/input,-p,OUTPUT=s3://amzn-s3-demo-bucket/pig-apache/output] \ --applications Name=Pig \ --release-label emr-5.3.1 \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large ``` **Exemplo 21: adicionar ações de bootstrap** O exemplo `create-cluster` a seguir executa duas ações de bootstrap definidas como scripts que são armazenados no Amazon S3. ``` aws emr create-cluster \ --bootstrap-actions Path=s3://amzn-s3-demo-bucket/myscript1,Name=BootstrapAction1,Args=[arg1,arg2] Path=s3://amzn-s3-demo-bucket/myscript2,Name=BootstrapAction2,Args=[arg1,arg2] \ --release-label emr-5.3.1 \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ --auto-terminate ``` **Exemplo 22: habilitar a visualização consistente do EMRFS e personalizar as configurações de RetryCount e RetryPeriod** O exemplo `create-cluster` a seguir especifica a contagem e o período de novas tentativas para a visualização consistente do EMRFS. O argumento `Consistent=true` é obrigatório. ``` aws emr create-cluster \ --instance-type m4.large \ --release-label emr-5.9.0 \ --emrfs Consistent=true,RetryCount=6,RetryPeriod=30 ``` O exemplo a seguir especifica a mesma configuração do EMRFS do exemplo anterior, usando um arquivo de configuração JSON armazenado localmente chamado `emrfsconfig.json`. ``` aws emr create-cluster \ --instance-type m4.large \ --release-label emr-5.9.0 \ --emrfs file://emrfsconfig.json ``` Conteúdo de `emrfsconfig.json`: ``` { "Consistent": true, "RetryCount": 6, "RetryPeriod": 30 } ``` **Exemplo 23: criar um cluster com o Kerberos configurado** Os exemplos `create-cluster` a seguir criam um cluster usando uma configuração de segurança com o Kerberos habilitado e estabelecem os parâmetros do Kerberos para o cluster usando `--kerberos-attributes`. O comando a seguir especifica os atributos do Kerberos para o cluster em linha. ``` aws emr create-cluster \ --instance-type m3.xlarge \ --release-label emr-5.10.0 \ --service-role EMR_DefaultRole \ --ec2-attributes InstanceProfile=EMR_EC2_DefaultRole \ --security-configuration mySecurityConfiguration \ --kerberos-attributes Realm=EC2.INTERNAL,KdcAdminPassword=123,CrossRealmTrustPrincipalPassword=123 ``` O comando a seguir especifica os mesmos atributos, mas faz referência a um arquivo JSON armazenado localmente chamado `kerberos_attributes.json`. Neste exemplo, o arquivo é salvo no mesmo diretório em que você executa o comando. Você também pode fazer referência a um arquivo de configuração salvo no Amazon S3. ``` aws emr create-cluster \ --instance-type m3.xlarge \ --release-label emr-5.10.0 \ --service-role EMR_DefaultRole \ --ec2-attributes InstanceProfile=EMR_EC2_DefaultRole \ --security-configuration mySecurityConfiguration \ --kerberos-attributes file://kerberos_attributes.json ``` Conteúdo de `kerberos_attributes.json`: ``` { "Realm": "EC2.INTERNAL", "KdcAdminPassword": "123", "CrossRealmTrustPrincipalPassword": "123", } ``` O exemplo `create-cluster` a seguir cria um cluster do Amazon EMR que usa a configuração `--instance-groups` e tem uma política de escala gerenciada. ``` aws emr create-cluster \ --release-label emr-5.30.0 \ --service-role EMR_DefaultRole \ --ec2-attributes InstanceProfile=EMR_EC2_DefaultRole \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large --managed-scaling-policy ComputeLimits='{MinimumCapacityUnits=2,MaximumCapacityUnits=4,UnitType=Instances}' ``` O exemplo `create-cluster` a seguir cria um cluster do Amazon EMR que usa o “--log-encryption-kms-key-id” para definir o ID da chave KMS utilizado para criptografia de log. ``` aws emr create-cluster \ --release-label emr-5.30.0 \ --log-uri s3://amzn-s3-demo-bucket/myLog \ --log-encryption-kms-key-id arn:aws:kms:us-east-1:110302272565:key/dd559181-283e-45d7-99d1-66da348c4d33 \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large ``` O exemplo `create-cluster` a seguir cria um cluster do Amazon EMR que usa a configuração “--placement-group-configs” para colocar nós principais em um cluster de alta disponibilidade (HA) dentro de um grupo de posicionamento do EC2 usando a estratégia de posicionamento `SPREAD`. ``` aws emr create-cluster \ --release-label emr-5.30.0 \ --service-role EMR_DefaultRole \ --ec2-attributes InstanceProfile=EMR_EC2_DefaultRole \ --instance-groups InstanceGroupType=MASTER,InstanceCount=3,InstanceType=m4.largeInstanceGroupType=CORE,InstanceCount=1,InstanceType=m4.large \ --placement-group-configs InstanceRole=MASTER ``` O exemplo `create-cluster` a seguir cria um cluster do Amazon EMR que usa a configuração “--auto-termination-policy” para estabelecer um limite automático de encerramento ocioso para o cluster. ``` aws emr create-cluster \ --release-label emr-5.34.0 \ --service-role EMR_DefaultRole \ --ec2-attributes InstanceProfile=EMR_EC2_DefaultRole \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=1,InstanceType=m4.large \ --auto-termination-policy IdleTimeout=100 ``` O exemplo `create-cluster` a seguir cria um cluster do Amazon EMR que usa o “--os-release-label” para definir uma versão do Amazon Linux para lançamento do cluster ``` aws emr create-cluster \ --release-label emr-6.6.0 \ --os-release-label 2.0.20220406.1 \ --service-role EMR_DefaultRole \ --ec2-attributes InstanceProfile=EMR_EC2_DefaultRole \ --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=1,InstanceType=m4.large ``` **Exemplo 24: especificar atributos de volume raiz do EBS: tamanho, iops e taxa de throughput para instâncias de cluster criadas com o EMR versões 6.15.0 e posteriores** O exemplo `create-cluster` a seguir cria um cluster do Amazon EMR que usa atributos de volume raiz para configurar especificações de volumes raiz para as instâncias do EC2. ``` aws emr create-cluster \ --name "Cluster with My Custom AMI" \ --custom-ami-id ami-a518e6df \ --ebs-root-volume-size 20 \ --ebs-root-volume-iops 3000 \ --ebs-root-volume-throughput 125 \ --release-label emr-6.15.0 \ --use-default-roles \ --instance-count 2 \ --instance-type m4.large ``` + Para ver detalhes da API, consulte [CreateClusterExamples](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/create-cluster-examples.html) na *Referência de comandos da AWS CLI*. ### `create-default-roles` O código de exemplo a seguir mostra como usar `create-default-roles`. **AWS CLI** **1. Criar o perfil do IAM padrão para o EC2** Comando: ``` aws emr create-default-roles ``` Resultado: ``` If the role already exists then the command returns nothing. If the role does not exist then the output will be: [ { "RolePolicy": { "Version":"2012-10-17", "Statement": [ { "Action": [ "cloudwatch:*", "dynamodb:*", "ec2:Describe*", "elasticmapreduce:Describe*", "elasticmapreduce:ListBootstrapActions", "elasticmapreduce:ListClusters", "elasticmapreduce:ListInstanceGroups", "elasticmapreduce:ListInstances", "elasticmapreduce:ListSteps", "kinesis:CreateStream", "kinesis:DeleteStream", "kinesis:DescribeStream", "kinesis:GetRecords", "kinesis:GetShardIterator", "kinesis:MergeShards", "kinesis:PutRecord", "kinesis:SplitShard", "rds:Describe*", "s3:*", "sdb:*", "sns:*", "sqs:*" ], "Resource": "*", "Effect": "Allow" } ] }, "Role": { "AssumeRolePolicyDocument": { "Version":"2012-10-17", "Statement": [ { "Action": "sts:AssumeRole", "Sid": "", "Effect": "Allow", "Principal": { "Service": "ec2.amazonaws.com" } } ] }, "RoleId": "AROAIQ5SIQUGL5KMYBJX6", "CreateDate": "2015-06-09T17:09:04.602Z", "RoleName": "EMR_EC2_DefaultRole", "Path": "/", "Arn": "arn:aws:iam::176430881729:role/EMR_EC2_DefaultRole" } }, { "RolePolicy": { "Version":"2012-10-17", "Statement": [ { "Action": [ "ec2:AuthorizeSecurityGroupIngress", "ec2:CancelSpotInstanceRequests", "ec2:CreateSecurityGroup", "ec2:CreateTags", "ec2:DeleteTags", "ec2:DescribeAvailabilityZones", "ec2:DescribeAccountAttributes", "ec2:DescribeInstances", "ec2:DescribeInstanceStatus", "ec2:DescribeKeyPairs", "ec2:DescribePrefixLists", "ec2:DescribeRouteTables", "ec2:DescribeSecurityGroups", "ec2:DescribeSpotInstanceRequests", "ec2:DescribeSpotPriceHistory", "ec2:DescribeSubnets", "ec2:DescribeVpcAttribute", "ec2:DescribeVpcEndpoints", "ec2:DescribeVpcEndpointServices", "ec2:DescribeVpcs", "ec2:ModifyImageAttribute", "ec2:ModifyInstanceAttribute", "ec2:RequestSpotInstances", "ec2:RunInstances", "ec2:TerminateInstances", "iam:GetRole", "iam:GetRolePolicy", "iam:ListInstanceProfiles", "iam:ListRolePolicies", "iam:PassRole", "s3:CreateBucket", "s3:Get*", "s3:List*", "sdb:BatchPutAttributes", "sdb:Select", "sqs:CreateQueue", "sqs:Delete*", "sqs:GetQueue*", "sqs:ReceiveMessage" ], "Resource": "*", "Effect": "Allow" } ] }, "Role": { "AssumeRolePolicyDocument": { "Version":"2012-10-17", "Statement": [ { "Action": "sts:AssumeRole", "Sid": "", "Effect": "Allow", "Principal": { "Service": "elasticmapreduce.amazonaws.com" } } ] }, "RoleId": "AROAI3SRVPPVSRDLARBPY", "CreateDate": "2015-06-09T17:09:10.401Z", "RoleName": "EMR_DefaultRole", "Path": "/", "Arn": "arn:aws:iam::176430881729:role/EMR_DefaultRole" } } ] ``` + Para ver detalhes da API, consulte [CreateDefaultRoles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/create-default-roles.html) na *Referência de comandos da AWS CLI*. ### `create-security-configuration` O código de exemplo a seguir mostra como usar `create-security-configuration`. **AWS CLI** **1. Criar uma configuração de segurança com criptografia em trânsito habilitada com PEM para provedor de certificados e criptografia em repouso habilitada com SSE-S3 para criptografia S3 e AWS-KMS para provedor de chave de disco local** Comando: ``` aws emr create-security-configuration --name MySecurityConfig --security-configuration '{ "EncryptionConfiguration": { "EnableInTransitEncryption" : true, "EnableAtRestEncryption" : true, "InTransitEncryptionConfiguration" : { "TLSCertificateConfiguration" : { "CertificateProviderType" : "PEM", "S3Object" : "s3://mycertstore/artifacts/MyCerts.zip" } }, "AtRestEncryptionConfiguration" : { "S3EncryptionConfiguration" : { "EncryptionMode" : "SSE-S3" }, "LocalDiskEncryptionConfiguration" : { "EncryptionKeyProviderType" : "AwsKms", "AwsKmsKey" : "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012" } } } }' ``` Resultado: ``` { "CreationDateTime": 1474070889.129, "Name": "MySecurityConfig" } ``` Equivalente em JSON (conteúdo de security\$1configuration.json): ``` { "EncryptionConfiguration": { "EnableInTransitEncryption": true, "EnableAtRestEncryption": true, "InTransitEncryptionConfiguration": { "TLSCertificateConfiguration": { "CertificateProviderType": "PEM", "S3Object": "s3://mycertstore/artifacts/MyCerts.zip" } }, "AtRestEncryptionConfiguration": { "S3EncryptionConfiguration": { "EncryptionMode": "SSE-S3" }, "LocalDiskEncryptionConfiguration": { "EncryptionKeyProviderType": "AwsKms", "AwsKmsKey": "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012" } } } } ``` Comando (usando security\$1configuration.json): ``` aws emr create-security-configuration --name "MySecurityConfig" --security-configuration file://./security_configuration.json ``` Resultado: ``` { "CreationDateTime": 1474070889.129, "Name": "MySecurityConfig" } ``` **2. Criar uma configuração de segurança com o Kerberos habilitado usando KDC dedicado ao cluster e confiança entre regiões** Comando: ``` aws emr create-security-configuration --name MySecurityConfig --security-configuration '{ "AuthenticationConfiguration": { "KerberosConfiguration": { "Provider": "ClusterDedicatedKdc", "ClusterDedicatedKdcConfiguration": { "TicketLifetimeInHours": 24, "CrossRealmTrustConfiguration": { "Realm": "AD.DOMAIN.COM", "Domain": "ad.domain.com", "AdminServer": "ad.domain.com", "KdcServer": "ad.domain.com" } } } } }' ``` Resultado: ``` { "CreationDateTime": 1490225558.982, "Name": "MySecurityConfig" } ``` Equivalente em JSON (conteúdo de security\$1configuration.json): ``` { "AuthenticationConfiguration": { "KerberosConfiguration": { "Provider": "ClusterDedicatedKdc", "ClusterDedicatedKdcConfiguration": { "TicketLifetimeInHours": 24, "CrossRealmTrustConfiguration": { "Realm": "AD.DOMAIN.COM", "Domain": "ad.domain.com", "AdminServer": "ad.domain.com", "KdcServer": "ad.domain.com" } } } } } ``` Comando (usando security\$1configuration.json): ``` aws emr create-security-configuration --name "MySecurityConfig" --security-configuration file://./security_configuration.json ``` Resultado: ``` { "CreationDateTime": 1490225558.982, "Name": "MySecurityConfig" } ``` + Para ver detalhes da API, consulte [CreateSecurityConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/create-security-configuration.html) na *Referência de comandos da AWS CLI*. ### `delete-security-configuration` O código de exemplo a seguir mostra como usar `delete-security-configuration`. **AWS CLI** **Excluir uma configuração de segurança na região atual** Comando: ``` aws emr delete-security-configuration --name MySecurityConfig ``` Resultado: ``` None ``` + Para ver detalhes da API, consulte [DeleteSecurityConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/delete-security-configuration.html) na *Referência de comandos da AWS CLI*. ### `describe-cluster` O código de exemplo a seguir mostra como usar `describe-cluster`. **AWS CLI** Comando: ``` aws emr describe-cluster --cluster-id j-XXXXXXXX ``` Resultado: ``` For release-label based uniform instance groups cluster: { "Cluster": { "Status": { "Timeline": { "ReadyDateTime": 1436475075.199, "CreationDateTime": 1436474656.563, }, "State": "WAITING", "StateChangeReason": { "Message": "Waiting for steps to run" } }, "Ec2InstanceAttributes": { "ServiceAccessSecurityGroup": "sg-xxxxxxxx", "EmrManagedMasterSecurityGroup": "sg-xxxxxxxx", "IamInstanceProfile": "EMR_EC2_DefaultRole", "Ec2KeyName": "myKey", "Ec2AvailabilityZone": "us-east-1c", "EmrManagedSlaveSecurityGroup": "sg-yyyyyyyyy" }, "Name": "My Cluster", "ServiceRole": "EMR_DefaultRole", "Tags": [], "TerminationProtected": true, "UnhealthyNodeReplacement": true, "ReleaseLabel": "emr-4.0.0", "NormalizedInstanceHours": 96, "InstanceGroups": [ { "RequestedInstanceCount": 2, "Status": { "Timeline": { "ReadyDateTime": 1436475074.245, "CreationDateTime": 1436474656.564, "EndDateTime": 1436638158.387 }, "State": "RUNNING", "StateChangeReason": { "Message": "", } }, "Name": "CORE", "InstanceGroupType": "CORE", "Id": "ig-YYYYYYY", "Configurations": [], "InstanceType": "m3.large", "Market": "ON_DEMAND", "RunningInstanceCount": 2 }, { "RequestedInstanceCount": 1, "Status": { "Timeline": { "ReadyDateTime": 1436475074.245, "CreationDateTime": 1436474656.564, "EndDateTime": 1436638158.387 }, "State": "RUNNING", "StateChangeReason": { "Message": "", } }, "Name": "MASTER", "InstanceGroupType": "MASTER", "Id": "ig-XXXXXXXXX", "Configurations": [], "InstanceType": "m3.large", "Market": "ON_DEMAND", "RunningInstanceCount": 1 } ], "Applications": [ { "Name": "Hadoop" } ], "VisibleToAllUsers": true, "BootstrapActions": [], "MasterPublicDnsName": "ec2-54-147-144-78.compute-1.amazonaws.com", "AutoTerminate": false, "Id": "j-XXXXXXXX", "Configurations": [ { "Properties": { "fs.s3.consistent.retryPeriodSeconds": "20", "fs.s3.enableServerSideEncryption": "true", "fs.s3.consistent": "false", "fs.s3.consistent.retryCount": "2" }, "Classification": "emrfs-site" } ] } } For release-label based instance fleet cluster: { "Cluster": { "Status": { "Timeline": { "ReadyDateTime": 1487897289.705, "CreationDateTime": 1487896933.942 }, "State": "WAITING", "StateChangeReason": { "Message": "Waiting for steps to run" } }, "Ec2InstanceAttributes": { "EmrManagedMasterSecurityGroup": "sg-xxxxx", "RequestedEc2AvailabilityZones": [], "RequestedEc2SubnetIds": [], "IamInstanceProfile": "EMR_EC2_DefaultRole", "Ec2AvailabilityZone": "us-east-1a", "EmrManagedSlaveSecurityGroup": "sg-xxxxx" }, "Name": "My Cluster", "ServiceRole": "EMR_DefaultRole", "Tags": [], "TerminationProtected": false, "UnhealthyNodeReplacement": false, "ReleaseLabel": "emr-5.2.0", "NormalizedInstanceHours": 472, "InstanceCollectionType": "INSTANCE_FLEET", "InstanceFleets": [ { "Status": { "Timeline": { "ReadyDateTime": 1487897212.74, "CreationDateTime": 1487896933.948 }, "State": "RUNNING", "StateChangeReason": { "Message": "" } }, "ProvisionedSpotCapacity": 1, "Name": "MASTER", "InstanceFleetType": "MASTER", "LaunchSpecifications": { "SpotSpecification": { "TimeoutDurationMinutes": 60, "TimeoutAction": "TERMINATE_CLUSTER" } }, "TargetSpotCapacity": 1, "ProvisionedOnDemandCapacity": 0, "InstanceTypeSpecifications": [ { "BidPrice": "0.5", "InstanceType": "m3.xlarge", "WeightedCapacity": 1 } ], "Id": "if-xxxxxxx", "TargetOnDemandCapacity": 0 } ], "Applications": [ { "Version": "2.7.3", "Name": "Hadoop" } ], "ScaleDownBehavior": "TERMINATE_AT_INSTANCE_HOUR", "VisibleToAllUsers": true, "BootstrapActions": [], "MasterPublicDnsName": "ec2-xxx-xx-xxx-xx.compute-1.amazonaws.com", "AutoTerminate": false, "Id": "j-xxxxx", "Configurations": [] } } For ami based uniform instance group cluster: { "Cluster": { "Status": { "Timeline": { "ReadyDateTime": 1399400564.432, "CreationDateTime": 1399400268.62 }, "State": "WAITING", "StateChangeReason": { "Message": "Waiting for steps to run" } }, "Ec2InstanceAttributes": { "IamInstanceProfile": "EMR_EC2_DefaultRole", "Ec2AvailabilityZone": "us-east-1c" }, "Name": "My Cluster", "Tags": [], "TerminationProtected": true, "UnhealthyNodeReplacement": true, "RunningAmiVersion": "2.5.4", "InstanceGroups": [ { "RequestedInstanceCount": 1, "Status": { "Timeline": { "ReadyDateTime": 1399400558.848, "CreationDateTime": 1399400268.621 }, "State": "RUNNING", "StateChangeReason": { "Message": "" } }, "Name": "Master instance group", "InstanceGroupType": "MASTER", "InstanceType": "m1.small", "Id": "ig-ABCD", "Market": "ON_DEMAND", "RunningInstanceCount": 1 }, { "RequestedInstanceCount": 2, "Status": { "Timeline": { "ReadyDateTime": 1399400564.439, "CreationDateTime": 1399400268.621 }, "State": "RUNNING", "StateChangeReason": { "Message": "" } }, "Name": "Core instance group", "InstanceGroupType": "CORE", "InstanceType": "m1.small", "Id": "ig-DEF", "Market": "ON_DEMAND", "RunningInstanceCount": 2 } ], "Applications": [ { "Version": "1.0.3", "Name": "hadoop" } ], "BootstrapActions": [], "VisibleToAllUsers": false, "RequestedAmiVersion": "2.4.2", "LogUri": "s3://myLogUri/", "AutoTerminate": false, "Id": "j-XXXXXXXX" } } ``` + Consulte detalhes da API em [DescribeCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/describe-cluster.html) na *Referência de comandos da AWS CLI*. ### `describe-step` O código de exemplo a seguir mostra como usar `describe-step`. **AWS CLI** O seguinte comando descreve uma etapa com o ID de etapa `s-3LZC0QUT43AM` em um cluster com o ID de cluster `j-3SD91U2E1L2QX`: ``` aws emr describe-step --cluster-id j-3SD91U2E1L2QX --step-id s-3LZC0QUT43AM ``` Resultado: ``` { "Step": { "Status": { "Timeline": { "EndDateTime": 1433200470.481, "CreationDateTime": 1433199926.597, "StartDateTime": 1433200404.959 }, "State": "COMPLETED", "StateChangeReason": {} }, "Config": { "Args": [ "s3://us-west-2.elasticmapreduce/libs/hive/hive-script", "--base-path", "s3://us-west-2.elasticmapreduce/libs/hive/", "--install-hive", "--hive-versions", "0.13.1" ], "Jar": "s3://us-west-2.elasticmapreduce/libs/script-runner/script-runner.jar", "Properties": {} }, "Id": "s-3LZC0QUT43AM", "ActionOnFailure": "TERMINATE_CLUSTER", "Name": "Setup hive" } } ``` + Consulte detalhes da API em [DescribeStep](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/describe-step.html) na *Referência de comandos da AWS CLI*. ### `get` O código de exemplo a seguir mostra como usar `get`. **AWS CLI** O seguinte baixa o arquivo `hadoop-examples.jar` da instância principal em um cluster com o ID do cluster`j-3SD91U2E1L2QX`: ``` aws emr get --cluster-id j-3SD91U2E1L2QX --key-pair-file ~/.ssh/mykey.pem --src /home/hadoop-examples.jar --dest ~ ``` + Para ver detalhes da API, consulte [Get](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/get.html) na *Referência de comandos da AWS CLI*. ### `list-clusters` O código de exemplo a seguir mostra como usar `list-clusters`. **AWS CLI** O comando a seguir lista todos os clusters ativos do EMR na região atual: ``` aws emr list-clusters --active ``` Resultado: ``` { "Clusters": [ { "Status": { "Timeline": { "ReadyDateTime": 1433200405.353, "CreationDateTime": 1433199926.596 }, "State": "WAITING", "StateChangeReason": { "Message": "Waiting after step completed" } }, "NormalizedInstanceHours": 6, "Id": "j-3SD91U2E1L2QX", "Name": "my-cluster" } ] } ``` + Consulte detalhes da API em [ListClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/list-clusters.html) na *Referência de comandos da AWS CLI*. ### `list-instance-fleets` O código de exemplo a seguir mostra como usar `list-instance-fleets`. **AWS CLI** **Obter detalhes da configuração de frotas de instâncias em um cluster** Este exemplo lista os detalhes de frotas de instâncias no cluster especificado. Comando: ``` list-instance-fleets --cluster-id 'j-12ABCDEFGHI34JK' ``` Resultado: ``` { "InstanceFleets": [ { "Status": { "Timeline": { "ReadyDateTime": 1488759094.637, "CreationDateTime": 1488758719.817 }, "State": "RUNNING", "StateChangeReason": { "Message": "" } }, "ProvisionedSpotCapacity": 6, "Name": "CORE", "InstanceFleetType": "CORE", "LaunchSpecifications": { "SpotSpecification": { "TimeoutDurationMinutes": 60, "TimeoutAction": "TERMINATE_CLUSTER" } }, "ProvisionedOnDemandCapacity": 2, "InstanceTypeSpecifications": [ { "BidPrice": "0.5", "InstanceType": "m3.xlarge", "WeightedCapacity": 2 } ], "Id": "if-1ABC2DEFGHIJ3" }, { "Status": { "Timeline": { "ReadyDateTime": 1488759058.598, "CreationDateTime": 1488758719.811 }, "State": "RUNNING", "StateChangeReason": { "Message": "" } }, "ProvisionedSpotCapacity": 0, "Name": "MASTER", "InstanceFleetType": "MASTER", "ProvisionedOnDemandCapacity": 1, "InstanceTypeSpecifications": [ { "BidPriceAsPercentageOfOnDemandPrice": 100.0, "InstanceType": "m3.xlarge", "WeightedCapacity": 1 } ], "Id": "if-2ABC4DEFGHIJ4" } ] } ``` + Para ver detalhes da API, consulte [ListInstanceFleets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/list-instance-fleets.html) na *Referência de comandos da AWS CLI*. ### `list-instances` O código de exemplo a seguir mostra como usar `list-instances`. **AWS CLI** O seguinte comando lista todas as instâncias em um cluster com o ID de cluster `j-3C6XNQ39VR9WL`: ``` aws emr list-instances --cluster-id j-3C6XNQ39VR9WL ``` Resultado: ``` For a uniform instance group based cluster { "Instances": [ { "Status": { "Timeline": { "ReadyDateTime": 1433200400.03, "CreationDateTime": 1433199960.152 }, "State": "RUNNING", "StateChangeReason": {} }, "Ec2InstanceId": "i-f19ecfee", "PublicDnsName": "ec2-52-52-41-150.us-west-2.compute.amazonaws.com", "PrivateDnsName": "ip-172-21-11-216.us-west-2.compute.internal", "PublicIpAddress": "52.52.41.150", "Id": "ci-3NNHQUQ2TWB6Y", "PrivateIpAddress": "172.21.11.216" }, { "Status": { "Timeline": { "ReadyDateTime": 1433200400.031, "CreationDateTime": 1433199949.102 }, "State": "RUNNING", "StateChangeReason": {} }, "Ec2InstanceId": "i-1feee4c2", "PublicDnsName": "ec2-52-63-246-32.us-west-2.compute.amazonaws.com", "PrivateDnsName": "ip-172-31-24-130.us-west-2.compute.internal", "PublicIpAddress": "52.63.246.32", "Id": "ci-GAOCMKNKDCV7", "PrivateIpAddress": "172.21.11.215" }, { "Status": { "Timeline": { "ReadyDateTime": 1433200400.031, "CreationDateTime": 1433199949.102 }, "State": "RUNNING", "StateChangeReason": {} }, "Ec2InstanceId": "i-15cfeee3", "PublicDnsName": "ec2-52-25-246-63.us-west-2.compute.amazonaws.com", "PrivateDnsName": "ip-172-31-24-129.us-west-2.compute.internal", "PublicIpAddress": "52.25.246.63", "Id": "ci-2W3TDFFB47UAD", "PrivateIpAddress": "172.21.11.214" } ] } For a fleet based cluster: { "Instances": [ { "Status": { "Timeline": { "ReadyDateTime": 1487810810.878, "CreationDateTime": 1487810588.367, "EndDateTime": 1488022990.924 }, "State": "TERMINATED", "StateChangeReason": { "Message": "Instance was terminated." } }, "Ec2InstanceId": "i-xxxxx", "InstanceFleetId": "if-xxxxx", "EbsVolumes": [], "PublicDnsName": "ec2-xx-xxx-xxx-xxx.compute-1.amazonaws.com", "InstanceType": "m3.xlarge", "PrivateDnsName": "ip-xx-xx-xxx-xx.ec2.internal", "Market": "SPOT", "PublicIpAddress": "xx.xx.xxx.xxx", "Id": "ci-xxxxx", "PrivateIpAddress": "10.47.191.80" } ] } ``` + Para ver detalhes da API, consulte [ListInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/list-instances.html) na *Referência de comandos da AWS CLI*. ### `list-security-configurations` O código de exemplo a seguir mostra como usar `list-security-configurations`. **AWS CLI** **Listar as configurações de segurança na região atual** Comando: ``` aws emr list-security-configurations ``` Resultado: ``` { "SecurityConfigurations": [ { "CreationDateTime": 1473889697.417, "Name": "MySecurityConfig-1" }, { "CreationDateTime": 1473889697.417, "Name": "MySecurityConfig-2" } ] } ``` + Para ver detalhes da API, consulte [ListSecurityConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/list-security-configurations.html) na *Referência de comandos da AWS CLI*. ### `list-steps` O código de exemplo a seguir mostra como usar `list-steps`. **AWS CLI** O seguinte comando lista todas as etapas em um cluster com o ID de cluster `j-3SD91U2E1L2QX`: ``` aws emr list-steps --cluster-id j-3SD91U2E1L2QX ``` + Consulte detalhes da API em [ListSteps](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/list-steps.html) na *Referência de comandos da AWS CLI*. ### `modify-cluster-attributes` O código de exemplo a seguir mostra como usar `modify-cluster-attributes`. **AWS CLI** O comando a seguir define a visibilidade de um cluster do EMR com o ID `j-301CDNY0J5XM4` para todos os usuários: ``` aws emr modify-cluster-attributes --cluster-id j-301CDNY0J5XM4 --visible-to-all-users ``` + Para ver detalhes da API, consulte [ModifyClusterAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/modify-cluster-attributes.html) na *Referência de comandos da AWS CLI*. ### `modify-instance-fleet` O código de exemplo a seguir mostra como usar `modify-instance-fleet`. **AWS CLI** **Alterar as capacidades desejadas de uma frota de instâncias** Este exemplo altera as capacidades alvo Sob Demanda e Spot para 1 para a frota de instâncias especificada. Comando: ``` aws emr modify-instance-fleet --cluster-id 'j-12ABCDEFGHI34JK' --instance-fleet InstanceFleetId='if-2ABC4DEFGHIJ4',TargetOnDemandCapacity=1,TargetSpotCapacity=1 ``` + Para ver detalhes da API, consulte [ModifyInstanceFleet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/modify-instance-fleet.html) na *Referência de comandos da AWS CLI*. ### `put` O código de exemplo a seguir mostra como usar `put`. **AWS CLI** O comando a seguir envia um arquivo chamado `healthcheck.sh` para a instância principal em um cluster com o ID do cluster `j-3SD91U2E1L2QX`: ``` aws emr put --cluster-id j-3SD91U2E1L2QX --key-pair-file ~/.ssh/mykey.pem --src ~/scripts/healthcheck.sh --dest /home/hadoop/bin/healthcheck.sh ``` + Para ver detalhes da API, consulte [Put](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/put.html) na *Referência de comandos da AWS CLI*. ### `remove-tags` O código de exemplo a seguir mostra como usar `remove-tags`. **AWS CLI** O comando a seguir remove uma tag com a chave `prod` de um cluster com o ID do cluster `j-3SD91U2E1L2QX`: ``` aws emr remove-tags --resource-id j-3SD91U2E1L2QX --tag-keys prod ``` + Para ver detalhes da API, consulte [RemoveTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/remove-tags.html) na *Referência de comandos da AWS CLI*. ### `schedule-hbase-backup` O código de exemplo a seguir mostra como usar `schedule-hbase-backup`. **AWS CLI** **Observação: esse comando só pode ser usado com o HBase na AMI versão 2.x e 3.x** **1. Agendar um backup completo do HBase** >>>>>> 06ab6d6e13564b5733d75abaf3b599f93cf39a23 Comando: ``` aws emr schedule-hbase-backup --cluster-id j-XXXXXXYY --type full --dir s3://amzn-s3-demo-bucket/backup --interval 10 --unit hours --start-time 2014-04-21T05:26:10Z --consistent ``` Resultado: ``` None ``` **2. Agendar um backup incremental do HBase** Comando: ``` aws emr schedule-hbase-backup --cluster-id j-XXXXXXYY --type incremental --dir s3://amzn-s3-demo-bucket/backup --interval 30 --unit minutes --start-time 2014-04-21T05:26:10Z --consistent ``` Resultado: ``` None ``` + Para ver detalhes da API, consulte [ScheduleHbaseBackup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/schedule-hbase-backup.html) na *Referência de comandos da AWS CLI*. ### `socks` O código de exemplo a seguir mostra como usar `socks`. **AWS CLI** O comando a seguir abre uma conexão socks com a instância mestre em um cluster com o ID do cluster `j-3SD91U2E1L2QX`: ``` aws emr socks --cluster-id j-3SD91U2E1L2QX --key-pair-file ~/.ssh/mykey.pem ``` A opção do arquivo de par de chaves usa um caminho local para um arquivo de chave privada. + Para ver detalhes da API, consulte [Socks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/socks.html) na *Referência de comandos da AWS CLI*. ### `ssh` O código de exemplo a seguir mostra como usar `ssh`. **AWS CLI** O comando a seguir abre uma conexão ssh com a instância principal em um cluster com o ID do cluster `j-3SD91U2E1L2QX`: ``` aws emr ssh --cluster-id j-3SD91U2E1L2QX --key-pair-file ~/.ssh/mykey.pem ``` A opção do arquivo de par de chaves usa um caminho local para um arquivo de chave privada. Resultado: ``` ssh -o StrictHostKeyChecking=no -o ServerAliveInterval=10 -i /home/local/user/.ssh/mykey.pem hadoop@ec2-52-52-41-150.us-west-2.compute.amazonaws.com Warning: Permanently added 'ec2-52-52-41-150.us-west-2.compute.amazonaws.com,52.52.41.150' (ECDSA) to the list of known hosts. Last login: Mon Jun 1 23:15:38 2015 __| __|_ ) _| ( / Amazon Linux AMI ___|\___|___| https://aws.amazon.com/amazon-linux-ami/2015.03-release-notes/ 26 package(s) needed for security, out of 39 available Run "sudo yum update" to apply all updates. -------------------------------------------------------------------------------- Welcome to Amazon Elastic MapReduce running Hadoop and Amazon Linux. Hadoop is installed in /home/hadoop. Log files are in /mnt/var/log/hadoop. Check /mnt/var/log/hadoop/steps for diagnosing step failures. The Hadoop UI can be accessed via the following commands: ResourceManager lynx http://ip-172-21-11-216:9026/ NameNode lynx http://ip-172-21-11-216:9101/ -------------------------------------------------------------------------------- [hadoop@ip-172-31-16-216 ~]$ ``` + Para ver detalhes da API, consulte [Ssh](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/ssh.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon EMR no EKS usando AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Amazon EMR no 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 ### `update-role-trust-policy` O código de exemplo a seguir mostra como usar `update-role-trust-policy`. **AWS CLI** **Atualizar a política de confiança de um perfil do IAM a ser usado com o Amazon EMR no EKS** Esse comando de exemplo atualiza a política de confiança de um perfil chamado **example\$1iam\$1role** para que ele possa ser usado com o Amazon EMR no EKS com o espaço de nome **example\$1namespace** de um cluster EKS chamado **example\$1cluster**. Comando: ``` aws emr-containers update-role-trust-policy \ --cluster example_cluster \ --namespace example_namespace \ --role-name example_iam_role ``` Resultado: ``` If the trust policy has already been updated, then the output will be: Trust policy statement already exists for role example_iam_role. No changes were made! If the trust policy has not been updated yet, then the output will be: Successfully updated trust policy of role example_iam_role. ``` + Para ver detalhes da API, consulte [UpdateRoleTrustPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr-containers/update-role-trust-policy.html) na *Referência de comandos da AWS CLI*. # Exemplos do EventBridge usando o AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com EventBridge. *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 ### `delete-rule` O código de exemplo a seguir mostra como usar `delete-rule`. **AWS CLI** **Como excluir uma regra do CloudWatch Events** Este exemplo exclui a regra chamada EC2InstanceStateChanges: ``` aws events delete-rule --name "EC2InstanceStateChanges" ``` + Consulte detalhes da API em [DeleteRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/delete-rule.html) na *Referência de comandos da AWS CLI*. ### `describe-rule` O código de exemplo a seguir mostra como usar `describe-rule`. **AWS CLI** **Como exibir informações sobre uma regra do CloudWatch Events** O exemplo a seguir exibe informações sobre a regra chamada DailyLambdaFunction: ``` aws events describe-rule --name "DailyLambdaFunction" ``` + Consulte detalhes da API em [DescribeRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/describe-rule.html) na *Referência de comandos da AWS CLI*. ### `disable-rule` O código de exemplo a seguir mostra como usar `disable-rule`. **AWS CLI** **Como desativar uma regra do CloudWatch Events** Este exemplo desabilita a regra chamada DailyLambdaFunction. A regra não é excluída: ``` aws events disable-rule --name "DailyLambdaFunction" ``` + Consulte detalhes da API em [DisableRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/disable-rule.html) na *Referência de comandos da AWS CLI*. ### `enable-rule` O código de exemplo a seguir mostra como usar `enable-rule`. **AWS CLI** **Para habilitar uma regra do CloudWatch Events** Este exemplo habilita a regra chamada DailyLambdaFunction, que foi desabilitada anteriormente: ``` aws events enable-rule --name "DailyLambdaFunction" ``` + Consulte detalhes da API em [EnableRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/enable-rule.html) na *Referência de comandos da AWS CLI*. ### `list-rule-names-by-target` O código de exemplo a seguir mostra como usar `list-rule-names-by-target`. **AWS CLI** **Como exibir todas as regras que têm um destino especificado** Este exemplo exibe todas as regras que têm a função do Lambda chamada “MyFunctionName” como destino: ``` aws events list-rule-names-by-target --target-arn "arn:aws:lambda:us-east-1:123456789012:function:MyFunctionName" ``` + Consulte detalhes da API em [ListRuleNamesByTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/list-rule-names-by-target.html) na *Referência de comandos da AWS CLI*. ### `list-rules` O código de exemplo a seguir mostra como usar `list-rules`. **AWS CLI** **Como exibir uma lista de todas as regras do CloudWatch Events** Este exemplo exibe todas as regras do CloudWatch Events na região: ``` aws events list-rules ``` **Como exibir uma lista de regras do CloudWatch Events que começam com uma determinada string.** Este exemplo exibe todas as regras do CloudWatch Events na região que têm um nome que começa com “Daily”: ``` aws events list-rules --name-prefix "Daily" ``` + Consulte detalhes da API em [ListRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/list-rules.html) na *Referência de comandos da AWS CLI*. ### `list-targets-by-rule` O código de exemplo a seguir mostra como usar `list-targets-by-rule`. **AWS CLI** **Como exibir todos os destinos de uma regra do CloudWatch Events** O exemplo a seguir exibe todos os destinos da regra chamada DailyLambdaFunction: ``` aws events list-targets-by-rule --rule "DailyLambdaFunction" ``` + Consulte detalhes da API em [ListTargetsByRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/list-targets-by-rule.html) na *Referência de comandos da AWS CLI*. ### `put-events` O código de exemplo a seguir mostra como usar `put-events`. **AWS CLI** **Como enviar um evento personalizado ao CloudWatch Events** Este exemplo envia um evento personalizado ao CloudWatch Events. O evento está contido no arquivo putevents.json: ``` aws events put-events --entries file://putevents.json ``` Veja a seguir o conteúdo do arquivo putevent.json: ``` [ { "Source": "com.mycompany.myapp", "Detail": "{ \"key1\": \"value1\", \"key2\": \"value2\" }", "Resources": [ "resource1", "resource2" ], "DetailType": "myDetailType" }, { "Source": "com.mycompany.myapp", "Detail": "{ \"key1\": \"value3\", \"key2\": \"value4\" }", "Resources": [ "resource1", "resource2" ], "DetailType": "myDetailType" } ] ``` + Consulte detalhes da API em [PutEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/put-events.html) na *Referência de comandos da AWS CLI*. ### `put-rule` O código de exemplo a seguir mostra como usar `put-rule`. **AWS CLI** **Como criar regras do CloudWatch Events** Este exemplo cria uma regra que é acionada todos os dias, às 9h UTC. Se você usar put-targets para adicionar uma função do Lambda como destino dessa regra, poderá executar a função do Lambda todos os dias no horário especificado: ``` aws events put-rule --name "DailyLambdaFunction" --schedule-expression "cron(0 9 * * ? *)" ``` Este exemplo cria uma regra que é acionada quando qualquer instância do EC2 na região muda de estado: ``` aws events put-rule --name "EC2InstanceStateChanges" --event-pattern "{\"source\":[\"aws.ec2\"],\"detail-type\":[\"EC2 Instance State-change Notification\"]}" --role-arn "arn:aws:iam::123456789012:role/MyRoleForThisRule" ``` Este exemplo cria uma regra que é acionada quando qualquer instância do EC2 na região é interrompida ou encerrada: ``` aws events put-rule --name "EC2InstanceStateChangeStopOrTerminate" --event-pattern "{\"source\":[\"aws.ec2\"],\"detail-type\":[\"EC2 Instance State-change Notification\"],\"detail\":{\"state\":[\"stopped\",\"terminated\"]}}" --role-arn "arn:aws:iam::123456789012:role/MyRoleForThisRule" ``` + Consulte detalhes da API em [PutRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/put-rule.html) na *Referência de comandos da AWS CLI*. ### `put-targets` O código de exemplo a seguir mostra como usar `put-targets`. **AWS CLI** **Como adicionar destinos às regras do CloudWatch Events** Este exemplo adiciona uma função do Lambda como o destino de uma regra: ``` aws events put-targets --rule DailyLambdaFunction --targets "Id"="1","Arn"="arn:aws:lambda:us-east-1:123456789012:function:MyFunctionName" ``` Este exemplo define um fluxo do Amazon Kinesis como o destino. Desta forma, os eventos capturados pela regra são retransmitidos para o fluxo: ``` aws events put-targets --rule EC2InstanceStateChanges --targets "Id"="1","Arn"="arn:aws:kinesis:us-east-1:123456789012:stream/MyStream","RoleArn"="arn:aws:iam::123456789012:role/MyRoleForThisRule" ``` Este exemplo define dois fluxos do Amazon Kinesis como destinos de uma regra: ``` aws events put-targets --rule DailyLambdaFunction --targets "Id"="Target1","Arn"="arn:aws:kinesis:us-east-1:379642911888:stream/MyStream1","RoleArn"="arn:aws:iam::379642911888:role/ MyRoleToAccessLambda" "Id"="Target2"," Arn"="arn:aws:kinesis:us-east-1:379642911888:stream/MyStream2","RoleArn"="arn:aws:iam::379642911888:role/MyRoleToAccessLambda" ``` + Consulte detalhes da API em [PutTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/put-targets.html) na *Referência de comandos da AWS CLI*. ### `remove-targets` O código de exemplo a seguir mostra como usar `remove-targets`. **AWS CLI** **Como remover um destino de um evento** Este exemplo remove o fluxo MyStream1 do Amazon Kinesis para que não seja um destino da regra DailyLambdaFunction. Quando DailyLambdaFunction foi criado, esse fluxo foi definido como um destino com o ID de Target1: ``` aws events remove-targets --rule "DailyLambdaFunction" --ids "Target1" ``` + Consulte detalhes da API em [RemoveTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/remove-targets.html) na *Referência de comandos da AWS CLI*. ### `test-event-pattern` O código de exemplo a seguir mostra como usar `test-event-pattern`. **AWS CLI** **Verificar se um padrão de evento corresponde a um evento especificado** Este exemplo testa se o padrão “source:com.mycompany.myapp” corresponde ao evento especificado. Neste exemplo, o resultado seria “verdadeiro”: ``` aws events test-event-pattern --event-pattern "{\"source\":[\"com.mycompany.myapp\"]}" --event "{\"id\":\"1\",\"source\":\"com.mycompany.myapp\",\"detail-type\":\"myDetailType\",\"account\":\"123456789012\",\"region\":\"us-east-1\",\"time\":\"2017-04-11T20:11:04Z\"}" ``` + Para ver detalhes da API, consulte [TestEventPattern](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/test-event-pattern.html) na *Referência de comandos da AWS CLI*. # Exemplos do EventBridge Pipes usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o EventBridge Pipes. *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 ### `create-pipe` O código de exemplo a seguir mostra como usar `create-pipe`. **AWS CLI** **Como criar um pipe** O exemplo de `create-pipe` a seguir cria um pipe chamado `Demo_Pipe` com o SQS como origem e o grupo de logs do CloudWatch como destino do pipe. ``` aws pipes create-pipe \ --name Demo_Pipe \ --desired-state RUNNING \ --role-arn arn:aws:iam::123456789012:role/service-role/Amazon_EventBridge_Pipe_Demo_Pipe_28b3aa4f \ --source arn:aws:sqs:us-east-1:123456789012:Demo_Queue \ --target arn:aws:logs:us-east-1:123456789012:log-group:/aws/pipes/Demo_LogGroup ``` Resultado: ``` { "Arn": "arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe", "Name": "Demo_Pipe", "DesiredState": "RUNNING", "CurrentState": "CREATING", "CreationTime": "2024-10-08T12:33:59-05:00", "LastModifiedTime": "2024-10-08T12:33:59.684839-05:00" } ``` Consulte mais informações em [Amazon EventBridge Pipes concepts](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html) no *Guia do usuário do Amazon EventBridge*. + Consulte detalhes da API em [CreatePipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/create-pipe.html) na *Referência de comandos da AWS CLI*. ### `delete-pipe` O código de exemplo a seguir mostra como usar `delete-pipe`. **AWS CLI** **Como excluir um pipe existente** O exemplo de `delete-pipe` a seguir exclui um pipe chamado `Demo_Pipe` na conta especificada. ``` aws pipes delete-pipe \ --name Demo_Pipe ``` Resultado: ``` { "Arn": "arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe", "Name": "Demo_Pipe", "DesiredState": "STOPPED", "CurrentState": "DELETING", "CreationTime": "2024-10-08T09:29:10-05:00", "LastModifiedTime": "2024-10-08T11:57:22-05:00" } ``` Consulte mais informações em [Amazon EventBridge Pipes concepts](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html) no *Guia do usuário do Amazon EventBridge*. + Consulte detalhes da API em [DeletePipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/delete-pipe.html) na *Referência de comandos da AWS CLI*. ### `describe-pipe` O código de exemplo a seguir mostra como usar `describe-pipe`. **AWS CLI** **Como recuperar informações sobre um pipe** O exemplo de `describe-pipe` a seguir exibe as informações sobre o pipe `Demo_Pipe` na conta especificada. ``` aws pipes describe-pipe \ --name Demo_Pipe ``` Resultado: ``` { "Arn": "arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe", "Name": "Demo_Pipe", "DesiredState": "RUNNING", "CurrentState": "RUNNING", "StateReason": "User initiated", "Source": "arn:aws:sqs:us-east-1:123456789012:Demo_Queue", "SourceParameters": { "SqsQueueParameters": { "BatchSize": 1 } }, "EnrichmentParameters": {}, "Target": "arn:aws:logs:us-east-1:123456789012:log-group:/aws/pipes/Demo_LogGroup", "TargetParameters": {}, "RoleArn": "arn:aws:iam::123456789012:role/service-role/Amazon_EventBridge_Pipe_Demo_Pipe_28b3aa4f", "Tags": {}, "CreationTime": "2024-10-08T09:29:10-05:00", "LastModifiedTime": "2024-10-08T10:23:47-05:00", "LogConfiguration": { "CloudwatchLogsLogDestination": { "LogGroupArn": "arn:aws:logs:us-east-1:123456789012:log-group:/aws/vendedlogs/pipes/Demo_Pipe" }, "Level": "ERROR" } } ``` Consulte mais informações em [Amazon EventBridge Pipes concepts](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html) no *Guia do usuário do Amazon EventBridge*. + Consulte detalhes da API em [DescribePipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/describe-pipe.html) na *Referência de comandos da AWS CLI*. ### `list-pipes` O código de exemplo a seguir mostra como usar `list-pipes`. **AWS CLI** **Como recuperar uma lista de pipes** O exemplo de `list-pipes` a seguir mostra todos os pipes na conta especificada. ``` aws pipes list-pipes ``` Resultado: ``` { "Pipes": [ { "Name": "Demo_Pipe", "Arn": "arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe", "DesiredState": "RUNNING", "CurrentState": "RUNNING", "StateReason": "User initiated", "CreationTime": "2024-10-08T09:29:10-05:00", "LastModifiedTime": "2024-10-08T10:23:47-05:00", "Source": "arn:aws:sqs:us-east-1:123456789012:Demo_Queue", "Target": "arn:aws:logs:us-east-1:123456789012:log-group:/aws/pipes/Demo_LogGroup" } ] } ``` Consulte mais informações em [Amazon EventBridge Pipes concepts](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html) no *Guia do usuário do Amazon EventBridge*. + Consulte detalhes da API em [ListPipes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/list-pipes.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Como listar as tags associadas a um pipe existente** O exemplo de `list-tags-for-resource` a seguir lista todas as tags associadas a um pipe chamado `Demo_Pipe` na conta especificada. ``` aws pipes list-tags-for-resource \ --resource-arn arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe ``` Resultado: ``` { "tags": { "stack": "Production", "team": "DevOps" } } ``` Consulte mais informações em [Amazon EventBridge Pipes concepts](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html) no *Guia do usuário do Amazon EventBridge*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `start-pipe` O código de exemplo a seguir mostra como usar `start-pipe`. **AWS CLI** **Como iniciar um pipe existente** O exemplo de `start-pipe` a seguir inicia um pipe chamado `Demo_Pipe` na conta especificada. ``` aws pipes start-pipe \ --name Demo_Pipe ``` Resultado: ``` { "Arn": "arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe", "Name": "Demo_Pipe", "DesiredState": "RUNNING", "CurrentState": "STARTING", "CreationTime": "2024-10-08T09:29:10-05:00", "LastModifiedTime": "2024-10-08T10:17:24-05:00" } ``` Consulte mais informações em [Starting or stopping an Amazon EventBridge pipe](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-start-stop.html) no *Guia do usuário do Amazon EventBridge*. + Consulte detalhes da API em [StartPipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/start-pipe.html) na *Referência de comandos da AWS CLI*. ### `stop-pipe` O código de exemplo a seguir mostra como usar `stop-pipe`. **AWS CLI** **Como interromper um pipe existente** O exemplo de `stop-pipe` a seguir interrompe um pipe chamado `Demo_Pipe` na conta especificada. ``` aws pipes stop-pipe \ --name Demo_Pipe ``` Resultado: ``` { "Arn": "arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe", "Name": "Demo_Pipe", "DesiredState": "STOPPED", "CurrentState": "STOPPING", "CreationTime": "2024-10-08T09:29:10-05:00", "LastModifiedTime": "2024-10-08T09:29:49-05:00" } ``` Consulte mais informações em [Starting or stopping an Amazon EventBridge pipe](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-start-stop.html) no *Guia do usuário do Amazon EventBridge*. + Consulte detalhes da API em [StopPipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/stop-pipe.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como marcar um pipe existente** O exemplo de `tag-resource` a seguir marca um pipe chamado `Demo_Pipe`. Se o comando for bem-sucedido, nenhuma saída será retornada. ``` aws pipes tag-resource \ --resource-arn arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe \ --tags stack=Production ``` Consulte mais informações em [Amazon EventBridge Pipes concepts](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html) no *Guia do usuário do Amazon EventBridge*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Como remover uma tag de um pipe existente** O exemplo de `untag-resource` a seguir remove uma tag com a chave `stack` do pipe chamado `Demo_Pipe`. Se o comando for bem-sucedido, nenhuma saída será retornada. ``` aws pipes untag-resource \ --resource-arn arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe \ --tags stack ``` Consulte mais informações em [Amazon EventBridge Pipes concepts](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html) no *Guia do usuário do Amazon EventBridge*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-pipe` O código de exemplo a seguir mostra como usar `update-pipe`. **AWS CLI** **Como atualizar um pipeline existente** O exemplo de `update-pipe` a seguir atualiza o pipe chamado `Demo_Pipe` adicionando um parâmetro de configuração do log do CloudWatch. Atualize o perfil de execução do pipe para que ele tenha as permissões corretas para o destino do log. ``` aws pipes update-pipe \ --name Demo_Pipe \ --desired-state RUNNING \ --log-configuration CloudwatchLogsLogDestination={LogGroupArn=arn:aws:logs:us-east-1:123456789012:log-group:/aws/vendedlogs/pipes/Demo_Pipe},Level=TRACE \ --role-arn arn:aws:iam::123456789012:role/service-role/Amazon_EventBridge_Pipe_Demo_Pipe_28b3aa4f ``` Resultado: ``` { "Arn": "arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe", "Name": "Demo_Pipe", "DesiredState": "RUNNING", "CurrentState": "UPDATING", "CreationTime": "2024-10-08T09:29:10-05:00", "LastModifiedTime": "2024-10-08T11:35:48-05:00" } ``` Consulte mais informações em [Amazon EventBridge Pipes concepts](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html) no *Guia do usuário do Amazon EventBridge*. + Consulte detalhes da API em [UpdatePipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/update-pipe.html) na *Referência de comandos da AWS CLI*. # Exemplos do Firewall Manager usando AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Firewall 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 ### `associate-admin-account` O código de exemplo a seguir mostra como usar `associate-admin-account`. **AWS CLI** **Definir a conta de administrador do Firewall Manager** O exemplo `associate-admin-account` a seguir define a conta de administrador para o Firewall Manager. ``` aws fms associate-admin-account \ --admin-account 123456789012 ``` Este comando não produz saída. Para obter mais informações, consulte [Definir conta de administrador para o AWS Firewall Manager](https://docs.aws.amazon.com/waf/latest/developerguide/enable-integration.html) no *AWS WAF, AWS Firewall Manager e no Guia do Desenvolvedor do AWS Shield Avançado*. + Para ver detalhes da API, consulte [AssociateAdminAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/associate-admin-account.html) na *Referência de comandos da AWS CLI*. ### `delete-notification-channel` O código de exemplo a seguir mostra como usar `delete-notification-channel`. **AWS CLI** **Remover as informações do tópico do SNS dos logs do Firewall Manager** O exemplo `delete-notification-channel` a seguir remove as informações do tópico do SNS. ``` aws fms delete-notification-channel ``` Este comando não produz saída. Para obter mais informações, consulte [Configurar as notificações do Amazon SNS e os alarmes do Amazon CloudWatch](https://docs.aws.amazon.com/waf/latest/developerguide/get-started-fms-shield-cloudwatch.html) no *AWS WAF, AWS Firewall Manager, e no AWS Guia do Desenvolvedor do Shield Avançado*. + Para ver detalhes da API, consulte [DeleteNotificationChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/delete-notification-channel.html) na *AWS CLI Referência de comando*. ### `delete-policy` O código de exemplo a seguir mostra como usar `delete-policy`. **AWS CLI** **Criar uma política do Firewall Manager** O exemplo `delete-policy` a seguir remove a política com o ID específico, junto com todos os seus recursos. ``` aws fms delete-policy \ --policy-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --delete-all-policy-resources ``` Este comando não produz saída. Para obter mais informações, consulte [Trabalhando com as AWS Políticas do Firewall Manager](https://docs.aws.amazon.com/waf/latest/developerguide/working-with-policies.html) no *AWS WAF, AWS Firewall Manager, e AWS no Guia do Desenvolvedor do Shield Avançado*. + Consulte detalhes da API em [DeletePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/delete-policy.html) na *Referência de comandos da AWS CLI*. ### `disassociate-admin-account` O código de exemplo a seguir mostra como usar `disassociate-admin-account`. **AWS CLI** **Remover a conta de administrador do Firewall Manager** O exemplo `disassociate-admin-account` a seguir remove a associação atual da conta de administrador do Firewall Manager. ``` aws fms disassociate-admin-account ``` Este comando não produz saída. Para obter mais informações, consulte [Definir conta de administrador para o AWS Firewall Manager](https://docs.aws.amazon.com/waf/latest/developerguide/enable-integration.html) no *AWS WAF, AWS Firewall Manager e no Guia do Desenvolvedor do AWS Shield Avançado*. + Para ver detalhes da API, consulte [DisassociateAdminAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/disassociate-admin-account.html) na *AWS CLI Referência de comando*. ### `get-admin-account` O código de exemplo a seguir mostra como usar `get-admin-account`. **AWS CLI** **Recuperar a conta de administrador do Firewall Manager** O exemplo `get-admin-account` a seguir recupera a conta do administrador. ``` aws fms get-admin-account ``` Resultado: ``` { "AdminAccount": "123456789012", "RoleStatus": "READY" } ``` Para obter mais informações, consulte [AWS Pré-requisitos Firewall Manager](https://docs.aws.amazon.com/waf/latest/developerguide/fms-prereq.html) no *AWS WAF, AWS Firewall Manager, e AWS no Guia do Desenvolvedor do Shield Avançado*. + Para ver detalhes da API, consulte [GetAdminAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/get-admin-account.html) na *AWS CLI Referência de comando*. ### `get-compliance-detail` O código de exemplo a seguir mostra como usar `get-compliance-detail`. **AWS CLI** **Recuperar as informações de conformidade sobre uma conta** O exemplo `get-compliance-detail` a seguir recupera informações de conformidade para a política e a conta de membro indicadas. ``` aws fms get-compliance-detail \ --policy-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --member-account 123456789012 ``` Resultado: ``` { "PolicyComplianceDetail": { "EvaluationLimitExceeded": false, "IssueInfoMap": {}, "MemberAccount": "123456789012", "PolicyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "PolicyOwner": "123456789012", "Violators": [] } ``` Para obter mais informações, consulte [Visualizar Conformidade de Recursos com uma Política](https://docs.aws.amazon.com/waf/latest/developerguide/fms-compliance.html) no *AWS WAF, AWS Firewall Manager e AWS no Guia do Desenvolvedor do Shield Avançado*. + Para obter mais detalhes da API, consulte [GetComplianceDetail](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/get-compliance-detail.html) na * Referência de comandos da AWS CLI*. ### `get-notification-channel` O código de exemplo a seguir mostra como usar `get-notification-channel`. **AWS CLI** **Recuperar as informações do tópico SNS para os logs do Firewall Manager** O exemplo `get-notification-channel` a seguir recupera informações do tópico SNS. ``` aws fms get-notification-channel ``` Resultado: ``` { "SnsTopicArn": "arn:aws:sns:us-west-2:123456789012:us-west-2-fms", "SnsRoleName": "arn:aws:iam::123456789012:role/aws-service-role/fms.amazonaws.com/AWSServiceRoleForFMS" } ``` Para obter mais informações, consulte [Configurar as notificações do Amazon SNS e os alarmes do Amazon CloudWatch](https://docs.aws.amazon.com/waf/latest/developerguide/get-started-fms-shield-cloudwatch.html) no *AWS WAF, AWS Firewall Manager, e no AWS Guia do Desenvolvedor do Shield Avançado*. + Para ver detalhes da API, consulte [GetNotificationChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/get-notification-channel.html) na *AWS CLI Referência de comando*. ### `get-policy` O código de exemplo a seguir mostra como usar `get-policy`. **AWS CLI** **Recuperar uma política do Firewall Manager** O exemplo `get-policy` a seguir recupera a política com o ID específico. ``` aws fms get-policy \ --policy-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "Policy": { "PolicyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "PolicyName": "test", "PolicyUpdateToken": "1:p+2RpKR4wPFx7mcrL1UOQQ==", "SecurityServicePolicyData": { "Type": "SECURITY_GROUPS_COMMON", "ManagedServiceData": "{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":true,\"exclusiveResourceSecurityGroupManagement\":false,\"securityGroups\":[{\"id\":\"sg-045c43ccc9724e63e\"}]}" }, "ResourceType": "AWS::EC2::Instance", "ResourceTags": [], "ExcludeResourceTags": false, "RemediationEnabled": false }, "PolicyArn": "arn:aws:fms:us-west-2:123456789012:policy/d1ac59b8-938e-42b3-b2e0-7c620422ddc2" } ``` Para obter mais informações, consulte [Trabalhando com as AWS Políticas do Firewall Manager](https://docs.aws.amazon.com/waf/latest/developerguide/working-with-policies.html) no *AWS WAF, AWS Firewall Manager, e AWS no Guia do Desenvolvedor do Shield Avançado*. + Consulte detalhes da API em [GetPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/get-policy.html) na *Referência de comandos da AWS CLI*. ### `list-compliance-status` O código de exemplo a seguir mostra como usar `list-compliance-status`. **AWS CLI** **Recuperar as informações de conformidade com a política para contas de membros** O exemplo `list-compliance-status` a seguir recupera as informações de conformidade da conta de membro para a política indicada. ``` aws fms list-compliance-status \ --policy-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "PolicyComplianceStatusList": [ { "PolicyOwner": "123456789012", "PolicyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "PolicyName": "test", "MemberAccount": "123456789012", "EvaluationResults": [ { "ComplianceStatus": "COMPLIANT", "ViolatorCount": 0, "EvaluationLimitExceeded": false }, { "ComplianceStatus": "NON_COMPLIANT", "ViolatorCount": 2, "EvaluationLimitExceeded": false } ], "LastUpdated": 1576283774.0, "IssueInfoMap": {} } ] } ``` Para obter mais informações, consulte [Visualizar Conformidade de Recursos com uma Política](https://docs.aws.amazon.com/waf/latest/developerguide/fms-compliance.html) no *AWS WAF, AWS Firewall Manager e AWS no Guia do Desenvolvedor do Shield Avançado*. + Para ver detalhes da API, consulte [ListComplianceStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/list-compliance-status.html) na *Referência de comandos da AWS CLI*. ### `list-member-accounts` O código de exemplo a seguir mostra como usar `list-member-accounts`. **AWS CLI** **Recuperar as contas de membros na organização** O exemplo `list-member-accounts` a seguir lista todas as contas de membros que estão na organização do administrador do Firewall Manager. ``` aws fms list-member-accounts ``` Resultado: ``` { "MemberAccounts": [ "222222222222", "333333333333", "444444444444" ] } ``` Para obter mais informações, consulte [AWS Firewall Manager](https://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html) no *AWS WAF, AWS Firewall Manager, e AWS no Guia do Desenvolver do Shield Avançado*. + Para ver detalhes da API, consulte [ListMemberAccounts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/list-member-accounts.html) na *AWS CLI Referência de comando*. ### `list-policies` O código de exemplo a seguir mostra como usar `list-policies`. **AWS CLI** **Recuperar todas as políticas do Firewall Manager** O exemplo `list-policies` a seguir recupera a lista de políticas da conta. Neste exemplo, a saída é limitada a dois resultados por solicitação. Cada chamada retorna um `NextToken` que pode ser usado como o valor do `--starting-token` parâmetro na próxima `list-policies` chamada para obter o próximo conjunto de resultados da lista. ``` aws fms list-policies \ --max-items 2 ``` Resultado: ``` { "PolicyList": [ { "PolicyArn": "arn:aws:fms:us-west-2:123456789012:policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "PolicyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "PolicyName": "test", "ResourceType": "AWS::EC2::Instance", "SecurityServiceType": "SECURITY_GROUPS_COMMON", "RemediationEnabled": false }, { "PolicyArn": "arn:aws:fms:us-west-2:123456789012:policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "PolicyId": "457c9b21-fc94-406c-ae63-21217395ba72", "PolicyName": "test", "ResourceType": "AWS::EC2::Instance", "SecurityServiceType": "SECURITY_GROUPS_COMMON", "RemediationEnabled": false } ], "NextToken": "eyJOZXh0VG9rZW4iOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==" } ``` Para obter mais informações, consulte [Trabalhando com as AWS Políticas do Firewall Manager](https://docs.aws.amazon.com/waf/latest/developerguide/working-with-policies.html) no *AWS WAF, AWS Firewall Manager, e AWS no Guia do Desenvolvedor do Shield Avançado*. + Consulte detalhes da API em [ListPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/list-policies.html) na *Referência de comandos da AWS CLI*. ### `put-notification-channel` O código de exemplo a seguir mostra como usar `put-notification-channel`. **AWS CLI** **Definir as informações do tópico do SNS para os logs do Firewall Manager** O exemplo `put-notification-channel` a seguir define as informações do tópico do SNS. ``` aws fms put-notification-channel \ --sns-topic-arn arn:aws:sns:us-west-2:123456789012:us-west-2-fms \ --sns-role-name arn:aws:iam::123456789012:role/aws-service-role/fms.amazonaws.com/AWSServiceRoleForFMS ``` Este comando não produz saída. Para obter mais informações, consulte [Configurar as notificações do Amazon SNS e os alarmes do Amazon CloudWatch](https://docs.aws.amazon.com/waf/latest/developerguide/get-started-fms-shield-cloudwatch.html) no *AWS WAF, AWS Firewall Manager, e no AWS Guia do Desenvolvedor do Shield Avançado*. + Para ver detalhes da API, consulte [PutNotificationChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/put-notification-channel.html) na *Referência de comandos da AWS CLI*. ### `put-policy` O código de exemplo a seguir mostra como usar `put-policy`. **AWS CLI** **Criar uma política do Firewall Manager** O exemplo `put-policy` a seguir cria uma política de grupo de segurança para o Firewall Manager. ``` aws fms put-policy \ --cli-input-json file://policy.json ``` Conteúdo de `policy.json`: ``` { "Policy": { "PolicyName": "test", "SecurityServicePolicyData": { "Type": "SECURITY_GROUPS_USAGE_AUDIT", "ManagedServiceData": "{\"type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"deleteUnusedSecurityGroups\":false,\"coalesceRedundantSecurityGroups\":true}" }, "ResourceType": "AWS::EC2::SecurityGroup", "ResourceTags": [], "ExcludeResourceTags": false, "RemediationEnabled": false }, "TagList": [ { "Key": "foo", "Value": "foo" } ] } ``` Resultado: ``` { "Policy": { "PolicyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "PolicyName": "test", "PolicyUpdateToken": "1:X9QGexP7HASDlsFp+G31Iw==", "SecurityServicePolicyData": { "Type": "SECURITY_GROUPS_USAGE_AUDIT", "ManagedServiceData": "{\"type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"deleteUnusedSecurityGroups\":false,\"coalesceRedundantSecurityGroups\":true,\"optionalDelayForUnusedInMinutes\":null}" }, "ResourceType": "AWS::EC2::SecurityGroup", "ResourceTags": [], "ExcludeResourceTags": false, "RemediationEnabled": false }, "PolicyArn": "arn:aws:fms:us-west-2:123456789012:policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } ``` Para obter mais informações, consulte [Trabalhando com as AWS Políticas do Firewall Manager](https://docs.aws.amazon.com/waf/latest/developerguide/working-with-policies.html) no *AWS WAF, AWS Firewall Manager, e AWS no Guia do Desenvolvedor do Shield Avançado*. + Para ver detalhes da API, consulte [PutPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/put-policy.html) na *AWS CLI Referência de comando*. # AWS FIS Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o AWS FIS. *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 ### `create-experiment-template` O código de exemplo a seguir mostra como usar `create-experiment-template`. **AWS CLI** **Criar um modelo de experimento** O exemplo `create-experiment-template` a seguir cria um modelo de experimento em sua conta FIS AWS. ``` aws fis create-experiment-template \ --cli-input-json file://myfile.json ``` Conteúdo de `myfile.json`: ``` { "description": "experimentTemplate", "stopConditions": [ { "source": "aws:cloudwatch:alarm", "value": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:alarmName" } ], "targets": { "Instances-Target-1": { "resourceType": "aws:ec2:instance", "resourceArns": [ "arn:aws:ec2:us-west-2:123456789012:instance/i-12a3b4c56d78e9012" ], "selectionMode": "ALL" } }, "actions": { "reboot": { "actionId": "aws:ec2:reboot-instances", "description": "reboot", "parameters": {}, "targets": { "Instances": "Instances-Target-1" } } }, "roleArn": "arn:aws:iam::123456789012:role/myRole" } ``` Resultado: ``` { "experimentTemplate": { "id": "ABCDE1fgHIJkLmNop", "description": "experimentTemplate", "targets": { "Instances-Target-1": { "resourceType": "aws:ec2:instance", "resourceArns": [ "arn:aws:ec2:us-west-2:123456789012:instance/i-12a3b4c56d78e9012" ], "selectionMode": "ALL" } }, "actions": { "reboot": { "actionId": "aws:ec2:reboot-instances", "description": "reboot", "parameters": {}, "targets": { "Instances": "Instances-Target-1" } } }, "stopConditions": [ { "source": "aws:cloudwatch:alarm", "value": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:alarmName" } ], "creationTime": 1616434850.659, "lastUpdateTime": 1616434850.659, "roleArn": "arn:aws:iam::123456789012:role/myRole", "tags": {} } } ``` Para obter mais informações, consulte [Criar um modelo de experimento](https://docs.aws.amazon.com/fis/latest/userguide/working-with-templates.html#create-template) no *Guia do usuário do simulador de injeção de falhas da AWS*. + Para ver detalhes da API, consulte [CreateExperimentTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/create-experiment-template.html) na *Referência de comandos da AWS CLI*. ### `delete-experiment-template` O código de exemplo a seguir mostra como usar `delete-experiment-template`. **AWS CLI** **Excluir um modelo de experimento** O exemplo `delete-experiment-template` a seguir exclui o modelo de experimento personalizado especificado. ``` aws fis delete-experiment-template \ --id ABCDE1fgHIJkLmNop ``` Resultado: ``` { "experimentTemplate": { "id": "ABCDE1fgHIJkLmNop", "description": "myExperimentTemplate", "targets": { "Instances-Target-1": { "resourceType": "aws:ec2:instance", "resourceArns": [ "arn:aws:ec2:us-west-2:123456789012:instance/i-12a3b4c56d78e9012" ], "selectionMode": "ALL" } }, "actions": { "testaction": { "actionId": "aws:ec2:stop-instances", "parameters": {}, "targets": { "Instances": "Instances-Target-1" } } }, "stopConditions": [ { "source": "none" } ], "creationTime": 1616017191.124, "lastUpdateTime": 1616017859.607, "roleArn": "arn:aws:iam::123456789012:role/FISRole" } } ``` Para obter mais informações, consulte [Excluir um modelo de experimento](https://docs.aws.amazon.com/fis/latest/userguide/working-with-templates.html#delete-template) no *Guia do usuário do simulador de injeção de falhas da AWS*. + Para ver detalhes da API, consulte [DeleteExperimentTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/delete-experiment-template.html) na *Referência de comandos da AWS CLI*. ### `get-action` O código de exemplo a seguir mostra como usar `get-action`. **AWS CLI** **Obter detalhes da ação** O exemplo `get-action` a seguir obtém os detalhes da ação especificada. ``` aws fis get-action \ --id aws:ec2:stop-instances ``` Resultado: ``` { "action": { "id": "aws:ec2:stop-instances", "description": "Stop the specified EC2 instances.", "parameters": { "startInstancesAfterDuration": { "description": "The time to wait before restarting the instances (ISO 8601 duration).", "required": false } }, "targets": { "Instances": { "resourceType": "aws:ec2:instance" } }, "tags": {} } } ``` Para obter mais informações, consulte [Ações](https://docs.aws.amazon.com/fis/latest/userguide/actions.html) no *Guia do usuário do simulador de injeção de falhas da AWS*. + Para ver detalhes da API, consulte [GetAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/get-action.html) na *Referência de comandos da AWS CLI*. ### `get-experiment-template` O código de exemplo a seguir mostra como usar `get-experiment-template`. **AWS CLI** **Obter detalhes do modelo de experimento** O exemplo `get-experiment-template` a seguir obtém os detalhes do modelo de experimento especificado. ``` aws fis get-experiment-template \ --id ABCDE1fgHIJkLmNop ``` Resultado: ``` { "experimentTemplate": { "id": "ABCDE1fgHIJkLmNop", "description": "myExperimentTemplate", "targets": { "Instances-Target-1": { "resourceType": "aws:ec2:instance", "resourceArns": [ "arn:aws:ec2:us-west-2:123456789012:instance/i-12a3b4c56d78e9012" ], "selectionMode": "ALL" } }, "actions": { "testaction": { "actionId": "aws:ec2:stop-instances", "parameters": {}, "targets": { "Instances": "Instances-Target-1" } } }, "stopConditions": [ { "source": "none" } ], "creationTime": 1616017191.124, "lastUpdateTime": 1616017331.51, "roleArn": "arn:aws:iam::123456789012:role/FISRole", "tags": { "key: "value" } } } ``` Para obter mais informações, consulte [Modelos de experimento](https://docs.aws.amazon.com/fis/latest/userguide/experiment-templates.html) no *Guia do usuário do simulador de injeção de falhas da AWS*. + Para ver detalhes da API, consulte [GetExperimentTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/get-experiment-template.html) na *Referência de comandos da AWS CLI*. ### `get-experiment` O código de exemplo a seguir mostra como usar `get-experiment`. **AWS CLI** **Obter detalhes do experimento** O exemplo `get-experiment` a seguir obtém os detalhes do experimento especificado. ``` aws fis get-experiment \ --id ABC12DeFGhI3jKLMNOP ``` Resultado: ``` { "experiment": { "id": "ABC12DeFGhI3jKLMNOP", "experimentTemplateId": "ABCDE1fgHIJkLmNop", "roleArn": "arn:aws:iam::123456789012:role/myRole", "state": { "status": "completed", "reason": "Experiment completed." }, "targets": { "Instances-Target-1": { "resourceType": "aws:ec2:instance", "resourceArns": [ "arn:aws:ec2:us-west-2:123456789012:instance/i-12a3b4c56d78e9012" ], "selectionMode": "ALL" } }, "actions": { "reboot": { "actionId": "aws:ec2:reboot-instances", "parameters": {}, "targets": { "Instances": "Instances-Target-1" }, "state": { "status": "completed", "reason": "Action was completed." } } }, "stopConditions": [ { "source": "none" } ], "creationTime": 1616432509.662, "startTime": 1616432509.962, "endTime": 1616432522.307, "tags": {} } } ``` Para obter mais informações, consulte [Experimentos para FIS AWS](https://docs.aws.amazon.com/fis/latest/userguide/experiments.html) no *Guia do usuário do simulador de injeção de falhas da AWS*. + Para ver detalhes da API, consulte [GetExperiment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/get-experiment.html) na *Referência de comandos da AWS CLI*. ### `list-actions` O código de exemplo a seguir mostra como usar `list-actions`. **AWS CLI** **Listar ações** O exemplo `list-actions` a seguir lista as ações disponíveis. ``` aws fis list-actions ``` Resultado: ``` { "actions": [ { "id": "aws:ec2:reboot-instances", "description": "Reboot the specified EC2 instances.", "targets": { "Instances": { "resourceType": "aws:ec2:instance" } }, "tags": {} }, { "id": "aws:ec2:stop-instances", "description": "Stop the specified EC2 instances.", "targets": { "Instances": { "resourceType": "aws:ec2:instance" } }, "tags": {} }, { "id": "aws:ec2:terminate-instances", "description": "Terminate the specified EC2 instances.", "targets": { "Instances": { "resourceType": "aws:ec2:instance" } }, "tags": {} }, { "id": "aws:ecs:drain-container-instances", "description": "Drain percentage of underlying EC2 instances on an ECS cluster.", "targets": { "Clusters": { "resourceType": "aws:ecs:cluster" } }, "tags": {} }, { "id": "aws:eks:terminate-nodegroup-instances", "description": "Terminates a percentage of the underlying EC2 instances in an EKS cluster.", "targets": { "Nodegroups": { "resourceType": "aws:eks:nodegroup" } }, "tags": {} }, { "id": "aws:fis:inject-api-internal-error", "description": "Cause an AWS service to return internal error responses for specific callers and operations.", "targets": { "Roles": { "resourceType": "aws:iam:role" } }, "tags": {} }, { "id": "aws:fis:inject-api-throttle-error", "description": "Cause an AWS service to return throttled responses for specific callers and operations.", "targets": { "Roles": { "resourceType": "aws:iam:role" } }, "tags": {} }, { "id": "aws:fis:inject-api-unavailable-error", "description": "Cause an AWS service to return unavailable error responses for specific callers and operations.", "targets": { "Roles": { "resourceType": "aws:iam:role" } }, "tags": {} }, { "id": "aws:fis:wait", "description": "Wait for the specified duration. Stop condition monitoring will continue during this time.", "tags": {} }, { "id": "aws:rds:failover-db-cluster", "description": "Failover a DB Cluster to one of the replicas.", "targets": { "Clusters": { "resourceType": "aws:rds:cluster" } }, "tags": {} }, { "id": "aws:rds:reboot-db-instances", "description": "Reboot the specified DB instances.", "targets": { "DBInstances": { "resourceType": "aws:rds:db" } }, "tags": {} }, { "id": "aws:ssm:send-command", "description": "Run the specified SSM document.", "targets": { "Instances": { "resourceType": "aws:ec2:instance" } }, "tags": {} } ] } ``` Para obter mais informações, consulte [Ações](https://docs.aws.amazon.com/fis/latest/userguide/actions.html) no *Guia do usuário do simulador de injeção de falhas da AWS*. + Para ver detalhes da API, consulte [ListActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/list-actions.html) na *Referência de comandos da AWS CLI*. ### `list-experiment-templates` O código de exemplo a seguir mostra como usar `list-experiment-templates`. **AWS CLI** **Listar modelos de experimentos** O exemplo `list-experiment-templates` a seguir lista os modelos de experimentos em sua conta da AWS. ``` aws fis list-experiment-templates ``` Resultado: ``` { "experimentTemplates": [ { "id": "ABCDE1fgHIJkLmNop", "description": "myExperimentTemplate", "creationTime": 1616017191.124, "lastUpdateTime": 1616017191.124, "tags": { "key": "value" } } ] } ``` Para obter mais informações, consulte [Modelos de experimento](https://docs.aws.amazon.com/fis/latest/userguide/experiment-templates.html) no *Guia do usuário do simulador de injeção de falhas da AWS*. + Para ver detalhes da API, consulte [ListExperimentTemplates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/list-experiment-templates.html) na *Referência de comandos da AWS CLI*. ### `list-experiments` O código de exemplo a seguir mostra como usar `list-experiments`. **AWS CLI** **Listar experimentos** O exemplo `list-experiments` a seguir lista os experimentos em sua conta da AWS. ``` aws fis list-experiments ``` Resultado: ``` { "experiments": [ { "id": "ABCdeF1GHiJkLM23NO", "experimentTemplateId": "ABCDE1fgHIJkLmNop", "state": { "status": "running", "reason": "Experiment is running." }, "creationTime": 1616017341.197, "tags": { "key": "value" } } ] } ``` Para obter mais informações, consulte [Experimentos](https://docs.aws.amazon.com/fis/latest/userguide/experiments.html) no *Guia do usuário do simulador de injeção de falhas da AWS*. + Para ver detalhes da API, consulte [ListExperiments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/list-experiments.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar as tags para um recurso** O exemplo `list-tags-for-resource` a seguir lista as tags para o recurso especificado. ``` aws fis list-tags-for-resource \ --resource-arn arn:aws:fis:us-west-2:123456789012:experiment/ABC12DeFGhI3jKLMNOP ``` Resultado: ``` { "tags": { "key1": "value1", "key2": "value2" } } ``` Para obter mais informações, consulte [Marcar seus recursos FIS AWS](https://docs.aws.amazon.com/fis/latest/userguide/tagging.html) no *Guia do usuário do simulador de injeção de falhas da AWS*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `start-experiment` O código de exemplo a seguir mostra como usar `start-experiment`. **AWS CLI** **Iniciar um experimento** O exemplo `start-experiment` a seguir inicia o experimento especificado. ``` aws fis start-experiment \ --experiment-template-id ABCDE1fgHIJkLmNop ``` Resultado: ``` { "experiment": { "id": "ABC12DeFGhI3jKLMNOP", "experimentTemplateId": "ABCDE1fgHIJkLmNop", "roleArn": "arn:aws:iam::123456789012:role/myRole", "state": { "status": "initiating", "reason": "Experiment is initiating." }, "targets": { "Instances-Target-1": { "resourceType": "aws:ec2:instance", "resourceArns": [ "arn:aws:ec2:us-west-2:123456789012:instance/i-12a3b4c56d78e9012" ], "selectionMode": "ALL" } }, "actions": { "reboot": { "actionId": "aws:ec2:reboot-instances", "parameters": {}, "targets": { "Instances": "Instances-Target-1" }, "state": { "status": "pending", "reason": "Initial state" } } }, "stopConditions": [ { "source": "none" } ], "creationTime": 1616432464.025, "startTime": 1616432464.374, "tags": {} } } ``` Para obter mais informações, consulte [Experimentos para FIS AWS](https://docs.aws.amazon.com/fis/latest/userguide/experiments.html) no *Guia do usuário do simulador de injeção de falhas da AWS*. + Para ver detalhes da API, consulte [StartExperiment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/start-experiment.html) na *Referência de comandos da AWS CLI*. ### `stop-experiment` O código de exemplo a seguir mostra como usar `stop-experiment`. **AWS CLI** **Interromper um experimento** O exemplo `stop-experiment` a seguir interrompe a execução do experimento especificado. ``` aws fis stop-experiment \ --id ABC12DeFGhI3jKLMNOP ``` Resultado: ``` { "experiment": { "id": "ABC12DeFGhI3jKLMNOP", "experimentTemplateId": "ABCDE1fgHIJkLmNop", "roleArn": "arn:aws:iam::123456789012:role/myRole", "state": { "status": "stopping", "reason": "Stopping Experiment." }, "targets": { "Instances-Target-1": { "resourceType": "aws:ec2:instance", "resourceArns": [ "arn:aws:ec2:us-west-2:123456789012:instance/i-12a3b4c56d78e9012" ], "selectionMode": "ALL" } }, "actions": { "reboot": { "actionId": "aws:ec2:reboot-instances", "parameters": {}, "targets": { "Instances": "Instances-Target-1" }, "startAfter": [ "wait" ], "state": { "status": "pending", "reason": "Initial state." } }, "wait": { "actionId": "aws:fis:wait", "parameters": { "duration": "PT5M" }, "state": { "status": "running", "reason": "" } } }, "stopConditions": [ { "source": "none" } ], "creationTime": 1616432680.927, "startTime": 1616432681.177, "tags": {} } } ``` Para obter mais informações, consulte [Experimentos para FIS AWS](https://docs.aws.amazon.com/fis/latest/userguide/experiments.html) no *Guia do usuário do simulador de injeção de falhas da AWS*. + Para ver detalhes da API, consulte [StopExperiment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/stop-experiment.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como marcar um recurso** O exemplo `tag-resource` a seguir adiciona a tag ao recurso especificado. ``` aws fis tag-resource \ --resource-arn arn:aws:fis:us-west-2:123456789012:experiment/ABC12DeFGhI3jKLMNOP \ --tags key1=value1,key2=value2 ``` Este comando não produz saída. Para obter mais informações, consulte [Marcar seus recursos FIS AWS](https://docs.aws.amazon.com/fis/latest/userguide/tagging.html) no *Guia do usuário do simulador de injeção de falhas da AWS*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Como desmarcar um recurso** O exemplo `untag-resource` a seguir remove as tags do recurso especificado. ``` aws fis untag-resource \ --resource-arn arn:aws:fis:us-west-2:123456789012:experiment/ABC12DeFGhI3jKLMNOP ``` Este comando não produz saída. Para obter mais informações, consulte [Marcar seus recursos FIS AWS](https://docs.aws.amazon.com/fis/latest/userguide/tagging.html) no *Guia do usuário do simulador de injeção de falhas da AWS*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-experiment-template` O código de exemplo a seguir mostra como usar `update-experiment-template`. **AWS CLI** **Atualizar um modelo de experimento** O exemplo `update-experiment-template` a seguir atualiza a descrição do modelo de experimento especificado. ``` aws fis update-experiment-template \ --id ABCDE1fgHIJkLmNop \ ---description myExperimentTemplate ``` Resultado: ``` { "experimentTemplate": { "id": "ABCDE1fgHIJkLmNop", "description": "myExperimentTemplate", "targets": { "Instances-Target-1": { "resourceType": "aws:ec2:instance", "resourceArns": [ "arn:aws:ec2:us-west-2:123456789012:instance/i-12a3b4c56d78e9012" ], "selectionMode": "ALL" } }, "actions": { "testaction": { "actionId": "aws:ec2:stop-instances", "parameters": {}, "targets": { "Instances": "Instances-Target-1" } } }, "stopConditions": [ { "source": "none" } ], "creationTime": 1616017191.124, "lastUpdateTime": 1616017859.607, "roleArn": "arn:aws:iam::123456789012:role/FISRole", "tags": { "key": "value" } } } ``` Para obter mais informações, consulte [Atualizar um modelo de experimento](https://docs.aws.amazon.com/fis/latest/userguide/working-with-templates.html#update-template) no *Guia do usuário do simulador de injeção de falhas da AWS*. + Para ver detalhes da API, consulte [UpdateExperimentTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/update-experiment-template.html) na *Referência de comandos da AWS CLI*. # Exemplos de Servidores do Amazon GameLift usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com Servidores do Amazon GameLift. *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 ### `create-build` O código de exemplo a seguir mostra como usar `create-build`. **AWS CLI** **Exemplo 1: criar uma compilação de jogo a partir de arquivos em um bucket do S3** O exemplo `create-build` a seguir cria um recurso personalizado de compilação de jogo. Ele usa arquivos compactados armazenados em um local S3 em uma AWS conta controlada por você. Este exemplo considera que você já tenha criado um perfil do IAM que dá permissão ao Amazon GameLift para acessar o local S3. Como a solicitação não especifica um sistema operacional, o novo recurso de compilação tem como padrão o WINDOWS\$12012. ``` aws gamelift create-build \ --storage-location file://storage-loc.json \ --name MegaFrogRaceServer.NA \ --build-version 12345.678 ``` Conteúdo de `storage-loc.json`: ``` { "Bucket":"MegaFrogRaceServer_NA_build_files" "Key":"MegaFrogRaceServer_build_123.zip" "RoleArn":"arn:aws:iam::123456789012:role/gamelift" } ``` Resultado: ``` { "Build": { "BuildArn": "arn:aws:gamelift:us-west-2::build/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "BuildId": "build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "CreationTime": 1496708916.18, "Name": "MegaFrogRaceServer.NA", "OperatingSystem": "WINDOWS_2012", "SizeOnDisk": 479303, "Status": "INITIALIZED", "Version": "12345.678" }, "StorageLocation": { "Bucket": "MegaFrogRaceServer_NA_build_files", "Key": "MegaFrogRaceServer_build_123.zip" } } ``` **Exemplo 2: criar um recurso de compilação de jogo para carregar arquivos manualmente no GameLift** O exemplo `create-build` a seguir cria um novo recurso de compilação. Também obtém um local de armazenamento e credenciais temporárias que lhe permitem fazer o upload manual da compilação do jogo para o local do GameLift no Amazon S3. Depois de carregar sua compilação com sucesso, o serviço GameLift valida e atualiza o status da nova compilação. ``` aws gamelift create-build \ --name MegaFrogRaceServer.NA \ --build-version 12345.678 \ --operating-system AMAZON_LINUX ``` Resultado: ``` { "Build": { "BuildArn": "arn:aws:gamelift:us-west-2::build/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "BuildId": "build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "CreationTime": 1496708916.18, "Name": "MegaFrogRaceServer.NA", "OperatingSystem": "AMAZON_LINUX", "SizeOnDisk": 0, "Status": "INITIALIZED", "Version": "12345.678" }, "StorageLocation": { "Bucket": "gamelift-builds-us-west-2", "Key": "123456789012/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, "UploadCredentials": { "AccessKeyId": "AKIAIOSFODNN7EXAMPLE", "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "SessionToken": "AgoGb3JpZ2luENz...EXAMPLETOKEN==" } } ``` Para obter mais informações, consulte [Fazer upload de uma compilação de servidor personalizada para o GameLift](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html) no Guia do desenvolvedor do Amazon *GameLift*. + Para ver detalhes da API, consulte [CreateBuild](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/create-build.html) na *Referência de comandos da AWS CLI*. ### `create-fleet` O código de exemplo a seguir mostra como usar `create-fleet`. **AWS CLI** **Exemplo 1: criar uma frota Linux básica** O exemplo `create-fleet` a seguir cria uma frota minimamente configurada de instâncias Linux sob demanda para hospedar uma compilação de servidor personalizada. É possível concluir a configuração usando `update-fleet`. ``` aws gamelift create-fleet \ --name MegaFrogRaceServer.NA.v2 \ --description 'Hosts for v2 North America' \ --build-id build-1111aaaa-22bb-33cc-44dd-5555eeee66ff \ --certificate-configuration 'CertificateType=GENERATED' \ --ec2-instance-type c4.large \ --fleet-type ON_DEMAND \ --runtime-configuration 'ServerProcesses=[{LaunchPath=/local/game/release-na/MegaFrogRace_Server.exe,ConcurrentExecutions=1}]' ``` Resultado: ``` { "FleetAttributes": { "BuildId": "build-1111aaaa-22bb-33cc-44dd-5555eeee66ff", "CertificateConfiguration": { "CertificateType": "GENERATED" }, "CreationTime": 1496365885.44, "Description": "Hosts for v2 North America", "FleetArn": "arn:aws:gamelift:us-west-2:444455556666:fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", "FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", "FleetType": "ON_DEMAND", "InstanceType": "c4.large", "MetricGroups": ["default"], "Name": "MegaFrogRace.NA.v2", "NewGameSessionProtectionPolicy": "NoProtection", "OperatingSystem": "AMAZON_LINUX", "ServerLaunchPath": "/local/game/release-na/MegaFrogRace_Server.exe", "Status": "NEW" } } ``` **Exemplo 2: criar uma frota básica do Windows** O exemplo `create-fleet` a seguir cria uma frota minimamente configurada de instâncias locais do Windows para hospedar uma compilação de servidor personalizada. É possível concluir a configuração usando `update-fleet`. ``` aws gamelift create-fleet \ --name MegaFrogRace.NA.v2 \ --description 'Hosts for v2 North America' \ --build-id build-2222aaaa-33bb-44cc-55dd-6666eeee77ff \ --certificate-configuration 'CertificateType=GENERATED' \ --ec2-instance-type c4.large \ --fleet-type SPOT \ --runtime-configuration 'ServerProcesses=[{LaunchPath=C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe,ConcurrentExecutions=1}]' ``` Resultado: ``` { "FleetAttributes": { "BuildId": "build-2222aaaa-33bb-44cc-55dd-6666eeee77ff", "CertificateConfiguration": { "CertificateType": "GENERATED" }, "CreationTime": 1496365885.44, "Description": "Hosts for v2 North America", "FleetArn": "arn:aws:gamelift:us-west-2:444455556666:fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", "FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", "FleetType": "SPOT", "InstanceType": "c4.large", "MetricGroups": ["default"], "Name": "MegaFrogRace.NA.v2", "NewGameSessionProtectionPolicy": "NoProtection", "OperatingSystem": "WINDOWS_2012", "ServerLaunchPath": "C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe", "Status": "NEW" } } ``` **Exemplo 3: criar uma frota totalmente configurada** O exemplo `create-fleet` a seguir cria uma frota de instâncias do Spot Windows para uma compilação de servidor personalizada, com as definições de configuração mais comumente usadas. ``` aws gamelift create-fleet \ --name MegaFrogRace.NA.v2 \ --description 'Hosts for v2 North America' \ --build-id build-2222aaaa-33bb-44cc-55dd-6666eeee77ff \ --certificate-configuration 'CertificateType=GENERATED' \ --ec2-instance-type c4.large \ --ec2-inbound-permissions 'FromPort=33435,ToPort=33435,IpRange=10.24.34.0/23,Protocol=UDP' \ --fleet-type SPOT \ --new-game-session-protection-policy FullProtection \ --runtime-configuration file://runtime-config.json \ --metric-groups default \ --instance-role-arn 'arn:aws:iam::444455556666:role/GameLiftS3Access' ``` Conteúdo de `runtime-config.json`: ``` GameSessionActivationTimeoutSeconds=300, MaxConcurrentGameSessionActivations=2, ServerProcesses=[ {LaunchPath=C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe,Parameters=-debug,ConcurrentExecutions=1}, {LaunchPath=C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe,ConcurrentExecutions=1}] ``` Resultado: ``` { "FleetAttributes": { "InstanceRoleArn": "arn:aws:iam::444455556666:role/GameLiftS3Access", "Status": "NEW", "InstanceType": "c4.large", "FleetArn": "arn:aws:gamelift:us-west-2:444455556666:fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", "FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", "Description": "Hosts for v2 North America", "FleetType": "SPOT", "OperatingSystem": "WINDOWS_2012", "Name": "MegaFrogRace.NA.v2", "CreationTime": 1569309011.11, "MetricGroups": [ "default" ], "BuildId": "build-2222aaaa-33bb-44cc-55dd-6666eeee77ff", "ServerLaunchParameters": "abc", "ServerLaunchPath": "C:\\game\\Bin64.Release.Dedicated\\MegaFrogRace_Server.exe", "NewGameSessionProtectionPolicy": "FullProtection", "CertificateConfiguration": { "CertificateType": "GENERATED" } } } ``` **Exemplo 4: criar uma frota de servidores Realtime** O exemplo `create-fleet` a seguir cria uma frota de instâncias spot com um script de configuração do Realtime carregado no Amazon GameLift. Todos os servidores Realtime são implantados em máquinas Linux. No caso deste exemplo, suponha que o script Realtime carregado inclua vários arquivos de script, com a função `Init()` localizada no arquivo de script chamado `MainScript.js`. Conforme demonstrado, identifica-se o arquivo como o script de inicialização na configuração de runtime. ``` aws gamelift create-fleet \ --name MegaFrogRace.NA.realtime \ --description 'Mega Frog Race Realtime fleet' \ --script-id script-1111aaaa-22bb-33cc-44dd-5555eeee66ff \ --ec2-instance-type c4.large \ --fleet-type SPOT \ --certificate-configuration 'CertificateType=GENERATED' --runtime-configuration 'ServerProcesses=[{LaunchPath=/local/game/MainScript.js,Parameters=+map Winter444,ConcurrentExecutions=5}]' ``` Resultado: ``` { "FleetAttributes": { "FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", "Status": "NEW", "CreationTime": 1569310745.212, "InstanceType": "c4.large", "NewGameSessionProtectionPolicy": "NoProtection", "CertificateConfiguration": { "CertificateType": "GENERATED" }, "Name": "MegaFrogRace.NA.realtime", "ScriptId": "script-1111aaaa-22bb-33cc-44dd-5555eeee66ff", "FleetArn": "arn:aws:gamelift:us-west-2:444455556666:fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", "FleetType": "SPOT", "MetricGroups": [ "default" ], "Description": "Mega Frog Race Realtime fleet", "OperatingSystem": "AMAZON_LINUX" } } ``` + Para ver detalhes da API, consulte [CreateFleet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/create-fleet.html) na *Referência de comandos da AWS CLI*. ### `create-game-session-queue` O código de exemplo a seguir mostra como usar `create-game-session-queue`. **AWS CLI** **Exemplo 1: configurar uma fila ordenada de sessões de jogo** O exemplo `create-game-session-queue` a seguir cria uma nova fila de sessões de jogo com destinos em duas regiões. Ele também configura a fila de modo que as solicitações de sessão de jogo sejam encerradas após 10 minutos de espera pelo posicionamento. Como não há políticas de latência definidas, o GameLift tenta colocar todas as sessões de jogo no primeiro destino listado. ``` aws gamelift create-game-session-queue \ --name MegaFrogRaceServer-NA \ --destinations file://destinations.json \ --timeout-in-seconds 600 ``` Conteúdo de `destinations.json`: ``` { "Destinations": [ {"DestinationArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, {"DestinationArn": "arn:aws:gamelift:us-west-1::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" } ] } ``` Resultado: ``` { "GameSessionQueues": [ { "Name": "MegaFrogRaceServer-NA", "GameSessionQueueArn": "arn:aws:gamelift:us-west-2:123456789012:gamesessionqueue/MegaFrogRaceServer-NA", "TimeoutInSeconds": 600, "Destinations": [ {"DestinationArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"}, {"DestinationArn": "arn:aws:gamelift:us-west-1::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"} ] } ] } ``` **Exemplo 2: configurar uma fila de sessões de jogo com políticas de latência de jogador** O exemplo `create-game-session-queue` cria uma nova fila de sessão de jogo com duas políticas de latência de jogador. A primeira política define um limite de latência de 100 ms que é aplicado durante o primeiro minuto de uma tentativa de posicionamento de sessão de jogo. A segunda política aumenta o limite de latência para 200 ms até que a solicitação de posicionamento atinja o tempo limite em 3 minutos. ``` aws gamelift create-game-session-queue \ --name MegaFrogRaceServer-NA \ --destinations file://destinations.json \ --player-latency-policies file://latency-policies.json \ --timeout-in-seconds 180 ``` Conteúdo de `destinations.json`: ``` { "Destinations": [ { "DestinationArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, { "DestinationArn": "arn:aws:gamelift:us-east-1::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" } ] } ``` Conteúdo de `latency-policies.json`: ``` { "PlayerLatencyPolicies": [ {"MaximumIndividualPlayerLatencyMilliseconds": 200}, {"MaximumIndividualPlayerLatencyMilliseconds": 100, "PolicyDurationSeconds": 60} ] } ``` Resultado: ``` { "GameSessionQueue": { "Name": "MegaFrogRaceServer-NA", "GameSessionQueueArn": "arn:aws:gamelift:us-west-2:111122223333:gamesessionqueue/MegaFrogRaceServer-NA", "TimeoutInSeconds": 600, "PlayerLatencyPolicies": [ { "MaximumIndividualPlayerLatencyMilliseconds": 100, "PolicyDurationSeconds": 60 }, { "MaximumIndividualPlayerLatencyMilliseconds": 200 } ] "Destinations": [ {"DestinationArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"}, {"DestinationArn": "arn:aws:gamelift:us-east-1::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"} ], } } ``` Para obter mais informações, consulte [Criar uma Fila](https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-creating.html#queues-creating-cli) no *Guia do desenvolvedor do Amazon GameLift*. + Para ver detalhes da API, consulte [CreateGameSessionQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/create-game-session-queue.html) na *Referência de comandos da AWS CLI*. ### `delete-build` O código de exemplo a seguir mostra como usar `delete-build`. **AWS CLI** **Excluir uma compilação de jogo personalizada** O exemplo `delete-build` a seguir remove uma compilação da sua conta Amazon GameLift. Depois que a compilação for excluída, você não poderá usá-la para criar novas frotas. Esta operação não pode ser desfeita. ``` aws gamelift delete-build \ --build-id build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Este comando não produz saída. + Para ver detalhes da API, consulte [DeleteBuild](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/delete-build.html) na *Referência de comandos da AWS CLI*. ### `delete-fleet` O código de exemplo a seguir mostra como usar `delete-fleet`. **AWS CLI** **Excluir uma frota que não mais está em uso** O exemplo `delete-fleet` a seguir remove uma frota que foi reduzida para zero instâncias. Se a capacidade da frota for maior que zero, a solicitação apresentará uma falha com erro HTTP 400. ``` aws gamelift delete-fleet \ --fleet-id fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar frotas do GameLift](https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-editing.html) no *Guia do Desenvolvedor do Amazon GameLift*. + Para ver detalhes da API, consulte [DeleteFleet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/delete-fleet.html) na *Referência de comandos da AWS CLI*. ### `delete-game-session-queue` O código de exemplo a seguir mostra como usar `delete-game-session-queue`. **AWS CLI** **Excluir uma fila de sessões de jogo** O exemplo `delete-game-session-queue` a seguir exclui uma fila de sessão de jogo específica. ``` aws gamelift delete-game-session-queue \ --name MegaFrogRace-NA ``` Este comando não produz saída. + Para ver detalhes da API, consulte [DeleteGameSessionQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/delete-game-session-queue.html) na *Referência de comandos da AWS CLI*. ### `describe-build` O código de exemplo a seguir mostra como usar `describe-build`. **AWS CLI** **Obter informações sobre uma compilação de jogo personalizada** O exemplo `describe-build` a seguir recupera as propriedades de um recurso de compilação do servidor de jogos. ``` aws gamelift describe-build \ --build-id build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "Build": { "BuildArn": "arn:aws:gamelift:us-west-2::build/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "BuildId": "build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "CreationTime": 1496708916.18, "Name": "My_Game_Server_Build_One", "OperatingSystem": "AMAZON_LINUX", "SizeOnDisk": 1304924, "Status": "READY", "Version": "12345.678" } } ``` Para obter mais informações, consulte [Fazer upload de uma compilação de servidor personalizada para o GameLift](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-builds) no Guia do desenvolvedor do Amazon *GameLift*. + Para ver detalhes da API, consulte [DescribeBuild](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/describe-build.html) na *Referência de comandos da AWS CLI*. ### `describe-ec2-instance-limits` O código de exemplo a seguir mostra como usar `describe-ec2-instance-limits`. **AWS CLI** **Recuperar os limites de serviço para um tipo de instância EC2** O exemplo `describe-ec2-instance-limits` exibe as instâncias máximas permitidas e as atuais que estão em uso para o tipo de instância EC2 especificado na região atual. O resultado indica que apenas cinco das vinte instâncias permitidas estão sendo usadas. ``` aws gamelift describe-ec2-instance-limits \ --ec2-instance-type m5.large ``` Resultado: ``` { "EC2InstanceLimits": [ { "EC2InstanceType": ""m5.large", "CurrentInstances": 5, "InstanceLimit": 20 } ] } ``` Para obter mais informações, consulte [Escolher recursos de computação](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html) no *Guia do Desenvolvedor do Amazon GameLift*. + Para ver detalhes da API, consulte [DescribeEc2InstanceLimits](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/describe-ec2-instance-limits.html) na *Referência de comandos da AWS CLI*. ### `describe-fleet-attributes` O código de exemplo a seguir mostra como usar `describe-fleet-attributes`. **AWS CLI** **Exemplo 1: visualizar os atributos de uma lista de frotas** O exemplo `describe-fleet-attributes` a seguir recupera os atributos de frota para duas frotas específicas. Conforme demonstrado, as frotas solicitadas são implementadas com a mesma compilação, uma para instâncias sob demanda e outra para instâncias Spot, com algumas pequenas diferenças de configuração. ``` aws gamelift describe-fleet-attributes \ --fleet-ids arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 ``` Resultado: ``` { "FleetAttributes": [ { "FleetId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "FleetArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "FleetType": "ON_DEMAND", "InstanceType": "c4.large", "Description": "On-demand hosts for v2 North America", "Name": "MegaFrogRaceServer.NA.v2-od", "CreationTime": 1568836191.995, "Status": "ACTIVE", "BuildId": "build-a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "BuildArn": "arn:aws:gamelift:us-west-2::build/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "ServerLaunchPath": "C:\\game\\MegaFrogRace_Server.exe", "ServerLaunchParameters": "+gamelift_start_server", "NewGameSessionProtectionPolicy": "NoProtection", "OperatingSystem": "WINDOWS_2012", "MetricGroups": [ "default" ], "CertificateConfiguration": { "CertificateType": "DISABLED" } }, { "FleetId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "FleetArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "FleetType": "SPOT", "InstanceType": "c4.large", "Description": "On-demand hosts for v2 North America", "Name": "MegaFrogRaceServer.NA.v2-spot", "CreationTime": 1568838275.379, "Status": "ACTIVATING", "BuildId": "build-a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "BuildArn": "arn:aws:gamelift:us-west-2::build/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "ServerLaunchPath": "C:\\game\\MegaFrogRace_Server.exe", "NewGameSessionProtectionPolicy": "NoProtection", "OperatingSystem": "WINDOWS_2012", "MetricGroups": [ "default" ], "CertificateConfiguration": { "CertificateType": "GENERATED" } } ] } ``` **Exemplo 2: solicitar atributos para todas as frotas** O seguinte `describe-fleet-attributes` retorna os atributos de frota para todas as frotas com qualquer status. Este exemplo ilustra o uso de parâmetros de paginação para retornar uma frota de cada vez. ``` aws gamelift describe-fleet-attributes \ --limit 1 ``` Resultado: ``` { "FleetAttributes": [ { "FleetId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "FleetArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "FleetType": "SPOT", "InstanceType": "c4.large", "Description": "On-demand hosts for v2 North America", "Name": "MegaFrogRaceServer.NA.v2-spot", "CreationTime": 1568838275.379, "Status": "ACTIVATING", "BuildId": "build-a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "BuildArn": "arn:aws:gamelift:us-west-2::build/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "ServerLaunchPath": "C:\\game\\MegaFrogRace_Server.exe", "NewGameSessionProtectionPolicy": "NoProtection", "OperatingSystem": "WINDOWS_2012", "MetricGroups": [ "default" ], "CertificateConfiguration": { "CertificateType": "GENERATED" } } ], "NextToken": "eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC01NWYxZTZmMS1jY2FlLTQ3YTctOWI5ZS1iYjFkYTQwMjEXAMPLE2" } ``` A saída inclui um valor `NextToken` que pode ser usado quando o comando for chamado uma segunda vez. Passe o valor para o parâmetro `--next-token` a fim de especificar onde coletar a saída. O comando a seguir retorna o segundo resultado na saída. ``` aws gamelift describe-fleet-attributes \ --limit 1 \ --next-token eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC01NWYxZTZmMS1jY2FlLTQ3YTctOWI5ZS1iYjFkYTQwMjEXAMPLE1 ``` Repita até que a resposta não inclua um `NextToken` valor. Para obter mais informações, consulte [Configurar frotas do GameLift](https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) no *Guia do Desenvolvedor do Amazon GameLift*. + Para ver detalhes da API, consulte [DescribeFleetAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/describe-fleet-attributes.html) na *Referência de comandos da AWS CLI*. ### `describe-fleet-capacity` O código de exemplo a seguir mostra como usar `describe-fleet-capacity`. **AWS CLI** **Visualizar o status da capacidade de uma lista de frotas** O exemplo `describe-fleet-capacity` a seguir recupera a capacidade atual de duas frotas específicas. ``` aws gamelift describe-fleet-capacity \ --fleet-ids arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 ``` Resultado: ``` { "FleetCapacity": [ { "FleetId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "InstanceType": "c5.large", "InstanceCounts": { "DESIRED": 10, "MINIMUM": 1, "MAXIMUM": 20, "PENDING": 0, "ACTIVE": 10, "IDLE": 3, "TERMINATING": 0 } }, { "FleetId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "InstanceType": "c5.large", "InstanceCounts": { "DESIRED": 13, "MINIMUM": 1, "MAXIMUM": 20, "PENDING": 0, "ACTIVE": 15, "IDLE": 2, "TERMINATING": 2 } } ] } ``` Para obter mais informações, consulte [Métricas do GameLift para Frotas](https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet) no *Guia do Desenvolvedor do Amazon GameLift*. + Para ver detalhes da API, consulte [DescribeFleetCapacity](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/describe-fleet-capacity.html) na *Referência de comandos da AWS CLI*. ### `describe-fleet-events` O código de exemplo a seguir mostra como usar `describe-fleet-events`. **AWS CLI** **Solicitar eventos para um período de tempo específico** O exemplo `describe-fleet-events` a seguir exibe detalhes de todos os eventos relacionados à frota que ocorreram durante o intervalo de tempo especificado. ``` aws gamelift describe-fleet-events \ --fleet-id arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --start-time 1579647600 \ --end-time 1579649400 \ --limit 5 ``` Resultado: ``` { "Events": [ { "EventId": "a37b6892-5d07-4d3b-8b47-80244ecf66b9", "ResourceId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "EventCode": "FLEET_STATE_ACTIVE", "Message": "Fleet fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 changed state to ACTIVE", "EventTime": 1579649342.191 }, { "EventId": "67da4ec9-92a3-4d95-886a-5d6772c24063", "ResourceId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "EventCode": "FLEET_STATE_ACTIVATING", "Message": "Fleet fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 changed state to ACTIVATING", "EventTime": 1579649321.427 }, { "EventId": "23813a46-a9e6-4a53-8847-f12e6a8381ac", "ResourceId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "EventCode": "FLEET_STATE_BUILDING", "Message": "Fleet fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 changed state to BUILDING", "EventTime": 1579649321.243 }, { "EventId": "3bf217d0-1d44-42f9-9202-433ed475d2e8", "ResourceId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "EventCode": "FLEET_STATE_VALIDATING", "Message": "Fleet fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 changed state to VALIDATING", "EventTime": 1579649197.449 }, { "EventId": "2ecd0130-5986-44eb-99a7-62df27741084", "ResourceId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "EventCode": "FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND", "Message": "Failed to find a valid path", "EventTime": 1569319075.839, "PreSignedLogUrl": "https://gamelift-event-logs-prod-us-west-2.s3.us-west-2.amazonaws.com/logs/fleet-83422059-8329-42a2-a4d6-c4444386a6f8/events/2ecd0130-5986-44eb-99a7-62df27741084/FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND.txt?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEB8aCXVzLXdlc3QtMiJHMEUCIHV5K%2FLPx8h310D%2FAvx0%2FZxsDy5XA3cJOwPdu3T0eBa%2FAiEA1yovokcZYy%2FV4CWW6l26aFyiSHO%2Bxz%2FBMAhEHYHMQNcqkQMImP%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARAAGgw3NDEwNjE1OTIxNzEiDI8rsZtzLzlwEDQhXSrlAtl5Ae%2Fgo6FCIzqXPbXfBOnSvFYqeDlriZarEpKqKrUt8mXQv9iqHResqCph9AKo49lwgSYTT2QoSxnrD7%2FUgv%2BZm2pVuczvuKtUA0fcx6s0GxpjIAzdIE%2F5P%2FB7B9M%2BVZ%2F9KF82hbJi0HTE6Y7BjKsEgFCvk4UXILhfjtan9iQl8%2F21ZTurAcJbm7Y5tuLF9SWSK3%2BEa7VXOcCK4D4O1sMjmdRm0q0CKZ%2FIaXoHkNvg0RVTa0hIqdvpaDQlsSBNdqTXbjHTu6fETE9Y9Ky%2BiJK5KiUG%2F59GjCpDcvS1FqKeLUEmKT7wysGmvjMc2n%2Fr%2F9VxQfte7w9srXwlLAQuwhiXAAyI5ICMZ5JvzjzQwTqD4CHTVKUUDwL%2BRZzbuuqkJObZml02CkRGp%2B74RTAzLbWptVqZTIfzctiCTmWxb%2FmKyELRYsVLrwNJ%2BGJ7%2BCrN0RC%2FjlgfLYIZyeAqjPgAu5HjgX%2BM7jCo9M7wBTrnAXKOFQuf9dvA84SuwXOJFp17LYGjrHMKv0qC3GfbTMrZ6kzeNV9awKCpXB2Gnx9z2KvIlJdqirWVpvHVGwKCmJBCesDzjJHrae3neogI1uW%2F9C6%2B4jIZPME3jXmZcEHqqw5uvAVF7aeIavtUZU8pxpDIWT0YE4p3Kriy2AA7ziCRKtVfjV839InyLk8LUjsioWK2qlpg2HXKFLpAXw1QsQyxYmFMB9sGKOUlbL7Jdkk%2BYUq8%2FDTlLxqj1S%2FiO4TI0Wo7ilAo%2FKKWWF4guuNDexj8EOOynSp1yImB%2BZf2Fua3O44W4eEXAMPLE33333&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20170621T231808Z&X-Amz-SignedHeaders=host&X-Amz-Expires=900&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20170621%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" } ], "NextToken": "eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC01NWYxZTZmMS1jY2FlLTQ3YTctOWI5ZS1iYjFkYTQwMjEXAMPLE2" } ``` For more information, see [Depurar problemas do GameLift Fleet](https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html) no *Guia do desenvolvedor do Amazon GameLift*. + Para ver detalhes da API, consulte [DescribeFleetEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/describe-fleet-events.html) na *Referência de comandos da AWS CLI*. ### `describe-fleet-port-settings` O código de exemplo a seguir mostra como usar `describe-fleet-port-settings`. **AWS CLI** **Visualizar permissões de conexão de entrada de uma frota** O exemplo `describe-fleet-port-settings` a seguir recupera as configurações de conexão de uma frota específica. ``` aws gamelift describe-fleet-port-settings \ --fleet-id arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "InboundPermissions": [ { "FromPort": 33400, "ToPort": 33500, "IpRange": "0.0.0.0/0", "Protocol": "UDP" }, { "FromPort": 1900, "ToPort": 2000, "IpRange": "0.0.0.0/0", "Protocol": "TCP" } ] } ``` Para obter mais informações, consulte [Configurar frotas do GameLift](https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) no *Guia do Desenvolvedor do Amazon GameLift*. + Para ver detalhes da API, consulte [DescribeFleetPortSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/describe-fleet-port-settings.html) na *Referência de comandos da AWS CLI*. ### `describe-fleet-utilization` O código de exemplo a seguir mostra como usar `describe-fleet-utilization`. **AWS CLI** **Exemplo 1: visualizar os dados de uso de uma lista de frotas** O exemplo `describe-fleet-utilization` a seguir recupera informações de uso atual de uma frota específica. ``` aws gamelift describe-fleet-utilization \ --fleet-ids arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "FleetUtilization": [ { "FleetId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "ActiveServerProcessCount": 100, "ActiveGameSessionCount": 62, "CurrentPlayerSessionCount": 329, "MaximumPlayerSessionCount": 1000 } ] } ``` **Exemplo 2: solicitar dados de uso para todas as frotas** O seguinte `describe-fleet-utilization` retorna dados de uso de frota para todas as frotas com qualquer status. Este exemplo usa parâmetros de paginação para retornar dados de duas frotas por vez. ``` aws gamelift describe-fleet-utilization \ --limit 2 ``` Resultado: ``` { "FleetUtilization": [ { "FleetId": "fleet-1111aaaa-22bb-33cc-44dd-5555eeee66ff", "ActiveServerProcessCount": 100, "ActiveGameSessionCount": 13, "CurrentPlayerSessionCount": 98, "MaximumPlayerSessionCount": 1000 }, { "FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", "ActiveServerProcessCount": 100, "ActiveGameSessionCount": 62, "CurrentPlayerSessionCount": 329, "MaximumPlayerSessionCount": 1000 } ], "NextToken": "eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC01NWYxZTZmMS1jY2FlLTQ3YTctOWI5ZS1iYjFkYTQwMjEXAMPLE2" } ``` Chame o comando uma segunda vez, passando o valor `NextToken` como argumento para o parâmetro `--next-token` a fim de visualizar os próximos dois resultados. ``` aws gamelift describe-fleet-utilization \ --limit 2 \ --next-token eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC01NWYxZTZmMS1jY2FlLTQ3YTctOWI5ZS1iYjFkYTQwMjEXAMPLE2 ``` Repita até que a resposta não inclua mais um valor `NextToken` na saída. Para obter mais informações, consulte [Métricas do GameLift para Frotas](https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet) no *Guia do Desenvolvedor do Amazon GameLift*. + Para ver detalhes da API, consulte [DescribeFleetUtilization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/describe-fleet-utilization.html) na *Referência de comandos da AWS CLI*. ### `describe-game-session-queues` O código de exemplo a seguir mostra como usar `describe-game-session-queues`. **AWS CLI** **Visualizar filas de sessões de jogos** O exemplo `describe-game-session-queues` a seguir recupera as propriedades de duas filas específicas. ``` aws gamelift describe-game-session-queues \ --names MegaFrogRace-NA MegaFrogRace-EU ``` Resultado: ``` { "GameSessionQueues": [{ "Destinations": [{ "DestinationArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, { "DestinationArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" } ], "Name": "MegaFrogRace-NA", "TimeoutInSeconds": 600, "GameSessionQueueArn": "arn:aws:gamelift:us-west-2::gamesessionqueue/MegaFrogRace-NA", "PlayerLatencyPolicies": [{ "MaximumIndividualPlayerLatencyMilliseconds": 200 }, { "MaximumIndividualPlayerLatencyMilliseconds": 100, "PolicyDurationSeconds": 60 } ], "FilterConfiguration": { "AllowedLocations": ["us-west-2", "ap-south-1", "us-east-1"] }, "PriorityConfiguration": { "PriorityOrder": ["LOCATION", "FLEET_TYPE", "DESTINATION"], "LocationOrder": ["us-west-2", "ap-south-1", "us-east-1"] } }, { "Destinations": [{ "DestinationArn": "arn:aws:gamelift:eu-west-3::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" }], "Name": "MegaFrogRace-EU", "TimeoutInSeconds": 600, "GameSessionQueueArn": "arn:aws:gamelift:us-west-2::gamesessionqueue/MegaFrogRace-EU" } ] } ``` Para obter mais informações, consulte [Usando Filas de Várias Regiões](https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html) no *Guia do Desenvolvedor do Amazon GameLift*. + Para ver detalhes da API, consulte [DescribeGameSessionQueues](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/describe-game-session-queues.html) na *Referência de comandos da AWS CLI*. ### `describe-runtime-configuration` O código de exemplo a seguir mostra como usar `describe-runtime-configuration`. **AWS CLI** **Solicitar a configuração de runtime de uma frota** O exemplo `describe-runtime-configuration` a seguir recupera detalhes sobre a configuração atual de runtime de uma frota específica. ``` aws gamelift describe-runtime-configuration \ --fleet-id fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "RuntimeConfiguration": { "ServerProcesses": [ { "LaunchPath": "C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe", "Parameters": "+gamelift_start_server", "ConcurrentExecutions": 3 }, { "LaunchPath": "C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe", "Parameters": "+gamelift_start_server +debug", "ConcurrentExecutions": 1 } ], "MaxConcurrentGameSessionActivations": 2147483647, "GameSessionActivationTimeoutSeconds": 300 } } ``` Para obter mais informações, consulte [Executar Múltiplos Processos em uma Frota](https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html) no *Guia do desenvolvedor do Amazon GameLift*. + Para ver detalhes da API, consulte [DescribeRuntimeConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/describe-runtime-configuration.html) na *Referência de comandos da AWS CLI*. ### `list-builds` O código de exemplo a seguir mostra como usar `list-builds`. **AWS CLI** **Exemplo 1: obter uma lista de compilações personalizadas de jogos** O exemplo `list-builds` a seguir recupera as propriedades de todas as compilações do servidor de jogos na região atual. A solicitação exemplificada ilustra como usar os parâmetros de paginação, `Limit` e `NextToken`, para recuperar os resultados em conjuntos sequenciais. O primeiro comando recupera as duas primeiras compilações. Como há mais de dois disponíveis, a resposta contém um `NextToken` para indicar que há mais resultados disponíveis. ``` aws gamelift list-builds \ --limit 2 ``` Resultado: ``` { "Builds": [ { "BuildArn": "arn:aws:gamelift:us-west-2::build/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "BuildId": "build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "CreationTime": 1495664528.723, "Name": "My_Game_Server_Build_One", "OperatingSystem": "WINDOWS_2012", "SizeOnDisk": 8567781, "Status": "READY", "Version": "12345.678" }, { "BuildArn": "arn:aws:gamelift:us-west-2::build/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "BuildId": "build-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "CreationTime": 1495528748.555, "Name": "My_Game_Server_Build_Two", "OperatingSystem": "AMAZON_LINUX_2", "SizeOnDisk": 8567781, "Status": "FAILED", "Version": "23456.789" } ], "NextToken": "eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC01NWYxZTZmMS1jY2FlLTQ3YTctOWI5ZS1iYjFkYTQwMjJEXAMPLE=" } ``` Em seguida, é possível chamar o comando novamente com o parâmetro `--next-token` da seguinte forma a fim de visualizar as duas próximas compilações. ``` aws gamelift list-builds \ --limit 2 --next-token eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC01NWYxZTZmMS1jY2FlLTQ3YTctOWI5ZS1iYjFkYTQwMjJEXAMPLE= ``` Repita até que a resposta não inclua um `NextToken` valor. **Exemplo 2: obter uma lista de compilações personalizadas de jogos com status de falha** O exemplo `list-builds` a seguir recupera as propriedades de todas as compilações de servidores de jogos na região atual que têm o status FALHA. ``` aws gamelift list-builds \ --status FAILED ``` Resultado: ``` { "Builds": [ { "BuildArn": "arn:aws:gamelift:us-west-2::build/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "BuildId": "build-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "CreationTime": 1495528748.555, "Name": "My_Game_Server_Build_Two", "OperatingSystem": "AMAZON_LINUX_2", "SizeOnDisk": 8567781, "Status": "FAILED", "Version": "23456.789" } ] } ``` + Para ver detalhes da API, consulte [ListBuilds](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/list-builds.html) na *Referência de comandos da AWS CLI*. ### `list-fleets` O código de exemplo a seguir mostra como usar `list-fleets`. **AWS CLI** **Exemplo 1: obter uma lista de todas as frotas em uma região** O exemplo `list-fleets` a seguir exibe as IDs de frota de todas as frotas da região atual. Este exemplo usa parâmetros de paginação para recuperar duas IDs de frota por vez. A resposta inclui um `next-token` atributo, que indica que há mais resultados a serem recuperados. ``` aws gamelift list-fleets \ --limit 2 ``` Resultado: ``` { "FleetIds": [ "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" ], "NextToken": "eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC01NWYxZTZmMS1jY2FlLTQ3YTctOWI5ZS1iYjFkYTQwMjJEXAMPLE=" } ``` É possível passar o valor `NextToken` da resposta anterior no próximo comando, como demonstrado aqui, para obter os próximos dois resultados. ``` aws gamelift list-fleets \ --limit 2 \ --next-token eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC00NDRlZjQxZS1hM2I1LTQ2NDYtODJmMy0zYzI4ZTgxNjVjEXAMPLE= ``` **Exemplo 2: obter uma lista de todas as frotas em uma região com uma compilação ou um script específicos** O exemplo `list-builds` a seguir recupera as IDs das frotas implantadas com a compilação específica do jogo. Se estiver trabalhando com servidores Realtime, é possível fornecer uma ID de script em vez de uma ID de compilação. Como este exemplo não especifica o parâmetro de limite, os resultados podem incluir até 16 IDs de frota. ``` aws gamelift list-fleets \ --build-id build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "FleetIds": [ "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE44444" ] } ``` + Para ver detalhes da API, consulte [ListFleets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/list-fleets.html) na *Referência de comandos da AWS CLI*. ### `request-upload-credentials` O código de exemplo a seguir mostra como usar `request-upload-credentials`. **AWS CLI** **Atualizar as credenciais de acesso para fazer upload de uma compilação** O exemplo `create-build` a seguir obtém credenciais de acesso novas e válidas para carregar um arquivo de compilação do GameLift em um local do Amazon S3. As credenciais têm uma vida útil limitada. Obtém-se a ID de compilação da resposta à solicitação `CreateBuild` original. ``` aws gamelift request-upload-credentials \ --build-id build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "StorageLocation": { "Bucket": "gamelift-builds-us-west-2", "Key": "123456789012/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, "UploadCredentials": { "AccessKeyId": "AKIAIOSFODNN7EXAMPLE", "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "SessionToken": "AgoGb3JpZ2luENz...EXAMPLETOKEN==" } } ``` Para obter mais informações, consulte [Fazer upload de uma compilação de servidor personalizada para o GameLift](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html) no Guia do desenvolvedor do Amazon *GameLift*. + Para ver detalhes da API, consulte [RequestUploadCredentials](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/request-upload-credentials.html) na *Referência de comandos da AWS CLI*. ### `start-fleet-actions` O código de exemplo a seguir mostra como usar `start-fleet-actions`. **AWS CLI** **Reiniciar a atividade de ajuste de escala automática da frota** O exemplo `start-fleet-actions` a seguir retoma o uso de todas as políticas de ajuste de escala definidas para a frota específica, mas que foram interrompidas pelas chamadas ``stop-fleet-actions``. Após o início, as políticas de ajuste de escala começam imediatamente a rastrear suas respectivas métricas. ``` aws gamelift start-fleet-actions \ --fleet-id fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --actions AUTO_SCALING ``` Este comando não produz saída. + Para ver detalhes da API, consulte [StartFleetActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/start-fleet-actions.html) na *Referência de comandos da AWS CLI*. ### `stop-fleet-actions` O código de exemplo a seguir mostra como usar `stop-fleet-actions`. **AWS CLI** **Interromper atividade de ajuste de escala automática de uma frota** O exemplo `stop-fleet-actions` a seguir interrompe o uso de todas as políticas de ajuste de escala definidas para a frota específica. Depois que as políticas são suspensas, a capacidade da frota permanece com a mesma contagem de instâncias ativas, a menos que você a ajuste manualmente. ``` aws gamelift start-fleet-actions \ --fleet-id fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --actions AUTO_SCALING ``` Este comando não produz saída. + Para ver detalhes da API, consulte [StopFleetActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/stop-fleet-actions.html) na *Referência de comandos da AWS CLI*. ### `update-build` O código de exemplo a seguir mostra como usar `update-build`. **AWS CLI** **Atualizar uma compilação personalizada do jogo** O exemplo `update-build` a seguir altera as informações de nome e versão associadas a um recurso de compilação específico. O objeto de compilação retornado verifica se as alterações foram feitas com êxito. ``` aws gamelift update-build \ --build-id build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --name MegaFrogRaceServer.NA.east \ --build-version 12345.east ``` Resultado: ``` { "Build": { "BuildArn": "arn:aws:gamelift:us-west-2::build/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "BuildId": "build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "CreationTime": 1496708916.18, "Name": "MegaFrogRaceServer.NA.east", "OperatingSystem": "AMAZON_LINUX_2", "SizeOnDisk": 1304924, "Status": "READY", "Version": "12345.east" } } ``` Para obter mais informações, consulte [Atualizar seus Arquivos de Compilação](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-update-build-files) no *Guia do Desenvolvedor do Amazon GameLift*. + Para ver detalhes da API, consulte [UpdateBuild](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/update-build.html) na *Referência de comandos da AWS CLI*. ### `update-game-session-queue` O código de exemplo a seguir mostra como usar `update-game-session-queue`. **AWS CLI** **Atualizar a configuração da fila de uma sessão de jogo** O exemplo `update-game-session-queue` a seguir adiciona um novo destino e atualiza as políticas de latência do jogador para uma fila de sessão de jogo existente. ``` aws gamelift update-game-session-queue \ --name MegaFrogRace-NA \ --destinations file://destinations.json \ --player-latency-policies file://latency-policies.json ``` Conteúdo de `destinations.json`: ``` { "Destinations": [ {"DestinationArn": "arn:aws:gamelift:us-west-2::fleet/fleet-1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"}, {"DestinationArn": "arn:aws:gamelift:us-east-1::fleet/fleet-5c6d3c4d-5e6f-7a8b-9c0d-1e2f3a4b5a2b"}, {"DestinationArn": "arn:aws:gamelift:us-east-1::alias/alias-11aa22bb-3c4d-5e6f-000a-1111aaaa22bb"} ] } ``` Conteúdo de `latency-policies.json`: ``` { "PlayerLatencyPolicies": [ {"MaximumIndividualPlayerLatencyMilliseconds": 200}, {"MaximumIndividualPlayerLatencyMilliseconds": 150, "PolicyDurationSeconds": 120}, {"MaximumIndividualPlayerLatencyMilliseconds": 100, "PolicyDurationSeconds": 120} ] } ``` Resultado: ``` { "GameSessionQueue": { "Destinations": [ {"DestinationArn": "arn:aws:gamelift:us-west-2::fleet/fleet-1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"}, {"DestinationArn": "arn:aws:gamelift:us-east-1::fleet/fleet-5c6d3c4d-5e6f-7a8b-9c0d-1e2f3a4b5a2b"}, {"DestinationArn": "arn:aws:gamelift:us-east-1::alias/alias-11aa22bb-3c4d-5e6f-000a-1111aaaa22bb"} ], "GameSessionQueueArn": "arn:aws:gamelift:us-west-2:111122223333:gamesessionqueue/MegaFrogRace-NA", "Name": "MegaFrogRace-NA", "TimeoutInSeconds": 600, "PlayerLatencyPolicies": [ {"MaximumIndividualPlayerLatencyMilliseconds": 200}, {"MaximumIndividualPlayerLatencyMilliseconds": 150, "PolicyDurationSeconds": 120}, {"MaximumIndividualPlayerLatencyMilliseconds": 100, "PolicyDurationSeconds": 120} ] } } ``` Para obter mais informações, consulte [Usando Filas de Várias Regiões](https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html) no *Guia do Desenvolvedor do Amazon GameLift*. + Para ver detalhes da API, consulte [UpdateGameSessionQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/update-game-session-queue.html) na *Referência de comandos da AWS CLI*. ### `upload-build` O código de exemplo a seguir mostra como usar `upload-build`. **AWS CLI** **Exemplo 1: fazer upload de uma compilação de servidor de jogos do Linux** O exemplo `upload-build` a seguir faz upload de arquivos de compilação do servidor de jogos do Linux de um diretório de arquivos para o serviço GameLift e cria um recurso de compilação. ``` aws gamelift upload-build \ --name MegaFrogRaceServer.NA \ --build-version 2.0.1 \ --build-root ~/MegaFrogRace_Server/release-na \ --operating-system AMAZON_LINUX_2 --server-sdk-version 4.0.2 ``` Resultado: ``` Uploading ~/MegaFrogRace_Server/release-na: 16.0 KiB / 74.6 KiB (21.45%) Uploading ~/MegaFrogRace_Server/release-na: 32.0 KiB / 74.6 KiB (42.89%) Uploading ~/MegaFrogRace_Server/release-na: 48.0 KiB / 74.6 KiB (64.34%) Uploading ~/MegaFrogRace_Server/release-na: 64.0 KiB / 74.6 KiB (85.79%) Uploading ~/MegaFrogRace_Server/release-na: 74.6 KiB / 74.6 KiB (100.00%) Successfully uploaded ~/MegaFrogRace_Server/release-na to AWS GameLift Build ID: build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` **Exemplo 2: fazer upload de uma versão de servidor de jogos do Windows** O exemplo `upload-build` a seguir faz upload de arquivos de compilação do servidor de jogos do Windows de um diretório para o serviço GameLift e cria um registro de compilação. ``` aws gamelift upload-build \ --name MegaFrogRaceServer.NA \ --build-version 2.0.1 \ --build-root C:\MegaFrogRace_Server\release-na \ --operating-system WINDOWS_2012 --server-sdk-version 4.0.2 ``` Resultado: ``` Uploading C:\MegaFrogRace_Server\release-na: 16.0 KiB / 74.6 KiB (21.45%) Uploading C:\MegaFrogRace_Server\release-na: 32.0 KiB / 74.6 KiB (42.89%) Uploading C:\MegaFrogRace_Server\release-na: 48.0 KiB / 74.6 KiB (64.34%) Uploading C:\MegaFrogRace_Server\release-na: 64.0 KiB / 74.6 KiB (85.79%) Uploading C:\MegaFrogRace_Server\release-na: 74.6 KiB / 74.6 KiB (100.00%) Successfully uploaded C:\MegaFrogRace_Server\release-na to AWS GameLift Build ID: build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Para obter mais informações, consulte [Fazer upload de uma compilação de servidor personalizada para o GameLift](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html) no Guia do desenvolvedor do Amazon *GameLift*. + Para ver detalhes da API, consulte [UploadBuild](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/upload-build.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon Glacier usando o AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface 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 ### `abort-multipart-upload` O código de exemplo a seguir mostra como usar `abort-multipart-upload`. **AWS CLI** O comando a seguir exclui um upload de várias partes em andamento para um cofre chamado `my-vault`: ``` aws glacier abort-multipart-upload --account-id - --vault-name my-vault --upload-id 19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ ``` Esse comando não produz nenhuma saída. O Amazon Glacier exige um argumento de ID de conta ao realizar operações, mas você pode usar um hífen para especificar a conta em uso. O ID de upload é retornado pelo comando `aws glacier initiate-multipart-upload` e também pode ser coletado usando `aws glacier list-multipart-uploads`. Para ter mais informações sobre uploads fracionados no Amazon Glacier usando a AWS CLI, consulte Using Amazon Glacier no *Guia do usuário da AWS CLI*. + Consulte detalhes da API em [AbortMultipartUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/abort-multipart-upload.html) na *Referência de comandos da AWS CLI*. ### `abort-vault-lock` O código de exemplo a seguir mostra como usar `abort-vault-lock`. **AWS CLI** **Abortar um processo de trava de cofre em andamento** O exemplo `abort-vault-lock` de a seguir exclui uma política de trava de cofre do cofre específico e redefine o status de bloqueio do cofre para desbloqueado. ``` aws glacier abort-vault-lock \ --account-id - \ --vault-name MyVaultName ``` Este comando não produz saída. Para obter mais informações, consulte [Abort Vault Lock (DELETE lock-policy)](https://docs.aws.amazon.com/amazonglacier/latest/dev/api-AbortVaultLock.html) no *Guia do desenvolvedor do Amazon Glacier*. + Para mais detalhes sobre a API, consulte [AbortVaultLock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/abort-vault-lock.html) na *AWS CLI Referência de comando*. ### `add-tags-to-vault` O código de exemplo a seguir mostra como usar `add-tags-to-vault`. **AWS CLI** O seguinte comando adiciona duas tags ao cofre `my-vault`: ``` aws glacier add-tags-to-vault --account-id - --vault-name my-vault --tags id=1234,date=july2015 ``` O Amazon Glacier exige um argumento de ID de conta ao realizar operações, mas você pode usar um hífen para especificar a conta em uso. + Consulte detalhes da API em [AddTagsToVault](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/add-tags-to-vault.html) na *Referência de comandos da AWS CLI*. ### `complete-multipart-upload` O código de exemplo a seguir mostra como usar `complete-multipart-upload`. **AWS CLI** O comando a seguir conclui o upload de várias partes para um arquivo de 3 MiB: ``` aws glacier complete-multipart-upload --archive-size 3145728 --checksum 9628195fcdbcbbe76cdde456d4646fa7de5f219fb39823836d81f0cc0e18aa67 --upload-id 19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ --account-id - --vault-name my-vault ``` O Amazon Glacier exige um argumento de ID de conta ao realizar operações, mas você pode usar um hífen para especificar a conta em uso. O ID de upload é retornado pelo comando `aws glacier initiate-multipart-upload` e também pode ser coletado usando `aws glacier list-multipart-uploads`. O parâmetro de soma de verificação usa um hash de árvore SHA-256 do arquivo em hexadecimal. Para obter mais informações sobre uploads de várias partes para o Amazon Glacier usando AWS CLI, incluindo instruções sobre como calcular um hash de árvore, consulte Uso do Amazon Glacier no *AWS Guia do Usuário de CLI*. + Consulte detalhes da API em [CompleteMultipartUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/complete-multipart-upload.html) na *Referência de comandos da AWS CLI*. ### `complete-vault-lock` O código de exemplo a seguir mostra como usar `complete-vault-lock`. **AWS CLI** **Concluir um processo de trava de cofre em andamento** O exemplo `complete-vault-lock` a seguir conclui o bloqueio em andamento do cofre específico e define o estado do bloqueio do cofre como `Locked`. Obtém-se o valor do parâmetro `lock-id` quando se executa `initiate-lock-process`. ``` aws glacier complete-vault-lock \ --account-id - \ --vault-name MyVaultName \ --lock-id 9QZgEXAMPLEPhvL6xEXAMPLE ``` Este comando não produz saída. Para obter mais informações, consulte [Concluir o bloqueio do cofre (POST lockId)](https://docs.aws.amazon.com/amazonglacier/latest/dev/api-CompleteVaultLock.html) no *Guia do Desenvolvedor de API do Amazon Glacier*. + Para ver detalhes da API, consulte [CompleteVaultLock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/complete-vault-lock.html) na *Referência de comandos da AWS CLI*. ### `create-vault` O código de exemplo a seguir mostra como usar `create-vault`. **AWS CLI** O seguinte comando cria um cofre chamado `my-vault`: ``` aws glacier create-vault --vault-name my-vault --account-id - ``` O Amazon Glacier exige um argumento de ID de conta ao realizar operações, mas você pode usar um hífen para especificar a conta em uso. + Consulte detalhes da API em [CreateVault](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/create-vault.html) na *Referência de comandos da AWS CLI*. ### `delete-archive` O código de exemplo a seguir mostra como usar `delete-archive`. **AWS CLI** **Como excluir um arquivo de um cofre** O exemplo de `delete-archive` a seguir remove o arquivamento especificado de `example_vault`. ``` aws glacier delete-archive \ --account-id 111122223333 \ --vault-name example_vault \ --archive-id Sc0u9ZP8yaWkmh-XGlIvAVprtLhaLCGnNwNl5I5x9HqPIkX5mjc0DrId3Ln-Gi_k2HzmlIDZUz117KSdVMdMXLuFWi9PJUitxWO73edQ43eTlMWkH0pd9zVSAuV_XXZBVhKhyGhJ7w ``` Este comando não produz saída. + Consulte detalhes da API em [DeleteArchive](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/delete-archive.html) na *Referência de comandos da AWS CLI*. ### `delete-vault-access-policy` O código de exemplo a seguir mostra como usar `delete-vault-access-policy`. **AWS CLI** **Remover a política de acesso de um cofre** O exemplo `delete-vault-access-policy` a seguir remove a política de acesso do cofre específico. ``` aws glacier delete-vault-access-policy \ --account-id 111122223333 \ --vault-name example_vault ``` Este comando não produz saída. + Para ver detalhes da API, consulte [DeleteVaultAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/delete-vault-access-policy.html) na *Referência de comandos da AWS CLI*. ### `delete-vault-notifications` O código de exemplo a seguir mostra como usar `delete-vault-notifications`. **AWS CLI** **Como remover as notificações do SNS de um cofre** O comando de `delete-vault-notifications` a seguir remove as notificações enviadas pelo Amazon Simple Notification Service (Amazon SNS) do cofre especificado. ``` aws glacier delete-vault-notifications \ --account-id 111122223333 \ --vault-name example_vault ``` Este comando não produz saída. + Consulte detalhes da API em [DeleteVaultNotifications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/delete-vault-notifications.html) na *Referência de comandos da AWS CLI*. ### `delete-vault` O código de exemplo a seguir mostra como usar `delete-vault`. **AWS CLI** O seguinte comando cria um cofre chamado `my-vault`: ``` aws glacier delete-vault --vault-name my-vault --account-id - ``` Esse comando não produz nenhuma saída. O Amazon Glacier exige um argumento de ID de conta ao realizar operações, mas você pode usar um hífen para especificar a conta em uso. + Consulte detalhes da API em [DeleteVault](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/delete-vault.html) na *Referência de comandos da AWS CLI*. ### `describe-job` O código de exemplo a seguir mostra como usar `describe-job`. **AWS CLI** O seguinte comando recupera informações sobre um trabalho de recuperação de inventário no cofre `my-vault`: ``` aws glacier describe-job --account-id - --vault-name my-vault --job-id zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW ``` Resultado: ``` { "InventoryRetrievalParameters": { "Format": "JSON" }, "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault", "Completed": false, "JobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW", "Action": "InventoryRetrieval", "CreationDate": "2015-07-17T20:23:41.616Z", "StatusCode": "InProgress" } ``` O ID do trabalho pode ser encontrado na saída de `aws glacier initiate-job` e `aws glacier list-jobs`. O Amazon Glacier exige um argumento de ID de conta ao realizar operações, mas você pode usar um hífen para especificar a conta em uso. + Consulte detalhes da API em [DescribeJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/describe-job.html) na *Referência de comandos da AWS CLI*. ### `describe-vault` O código de exemplo a seguir mostra como usar `describe-vault`. **AWS CLI** O seguinte comando recupera dados sobre o cofre `my-vault`: ``` aws glacier describe-vault --vault-name my-vault --account-id - ``` O Amazon Glacier exige um argumento de ID de conta ao realizar operações, mas você pode usar um hífen para especificar a conta em uso. + Consulte detalhes da API em [DescribeVault](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/describe-vault.html) na *Referência de comandos da AWS CLI*. ### `get-data-retrieval-policy` O código de exemplo a seguir mostra como usar `get-data-retrieval-policy`. **AWS CLI** O comando a seguir obtém a política de recuperação de dados para a conta em uso: ``` aws glacier get-data-retrieval-policy --account-id - ``` Resultado: ``` { "Policy": { "Rules": [ { "BytesPerHour": 10737418240, "Strategy": "BytesPerHour" } ] } } ``` O Amazon Glacier exige um argumento de ID de conta ao realizar operações, mas você pode usar um hífen para especificar a conta em uso. + Para ver detalhes da API, consulte [GetDataRetrievalPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/get-data-retrieval-policy.html) na *Referência de comandos da AWS CLI*. ### `get-job-output` O código de exemplo a seguir mostra como usar `get-job-output`. **AWS CLI** O seguinte comando salva a saída de um trabalho de inventário do cofre em um arquivo no diretório atual chamado `output.json`: ``` aws glacier get-job-output --account-id - --vault-name my-vault --job-id zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW output.json ``` O `job-id` está disponível na saída de `aws glacier list-jobs`. Observe que o nome do arquivo de saída é um argumento posicional que não é prefixado por um nome de opção. O Amazon Glacier exige um argumento de ID de conta ao realizar operações, mas você pode usar um hífen para especificar a conta em uso. Resultado: ``` { "status": 200, "acceptRanges": "bytes", "contentType": "application/json" } ``` `output.json`: ``` {"VaultARN":"arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault","InventoryDate":"2015-04-07T00:26:18Z","ArchiveList":[{"ArchiveId":"kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw","ArchiveDescription":"multipart upload test","CreationDate":"2015-04-06T22:24:34Z","Size":3145728,"SHA256TreeHash":"9628195fcdbcbbe76cdde932d4646fa7de5f219fb39823836d81f0cc0e18aa67"}]} ``` + Consulte detalhes da API em [GetJobOutput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/get-job-output.html) na *Referência de comandos da AWS CLI*. ### `get-vault-access-policy` O código de exemplo a seguir mostra como usar `get-vault-access-policy`. **AWS CLI** **Recuperar a política de acesso de um cofre** O exemplo `get-vault-access-policy` a seguir recupera a política de acesso para o cofre específico. ``` aws glacier get-vault-access-policy \ --account-id 111122223333 \ --vault-name example_vault ``` Resultado: ``` { "policy": { "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::444455556666:root\"},\"Action\":\"glacier:ListJobs\",\"Resource\":\"arn:aws:glacier:us-east-1:111122223333:vaults/example_vault\"},{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::444455556666:root\"},\"Action\":\"glacier:UploadArchive\",\"Resource\":\"arn:aws:glacier:us-east-1:111122223333:vaults/example_vault\"}]}" } } ``` + Para ver detalhes da API, consulte [GetVaultAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/get-vault-access-policy.html) na *Referência de comandos da AWS CLI*. ### `get-vault-lock` O código de exemplo a seguir mostra como usar `get-vault-lock`. **AWS CLI** **Obter detalhes de uma trava de cofre** O exemplo `get-vault-lock` a seguir recuperou os detalhes sobre a trava do cofre específico. ``` aws glacier get-vault-lock \ --account-id - \ --vault-name MyVaultName ``` Resultado: ``` { "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-vault-lock\",\"Effect\":\"Deny\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:99999999999:vaults/MyVaultName\",\"Condition\":{\"NumericLessThanEquals\":{\"glacier:ArchiveAgeinDays\":\"365\"}}}]}", "State": "Locked", "CreationDate": "2019-07-29T22:25:28.640Z" } ``` Para obter mais informações, consulte [Obter Trava do Cofre (GET lock-policy)](https://docs.aws.amazon.com/amazonglacier/latest/dev/api-GetVaultLock.html) no Guia do desenvolvedor da API do *Amazon Glacier*. + Para ver detalhes da API, consulte [GetVaultLock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/get-vault-lock.html) na *Referência de comandos da AWS CLI*. ### `get-vault-notifications` O código de exemplo a seguir mostra como usar `get-vault-notifications`. **AWS CLI** O seguinte comando captura uma descrição da configuração de notificação do cofre `my-vault`: ``` aws glacier get-vault-notifications --account-id - --vault-name my-vault ``` Resultado: ``` { "vaultNotificationConfig": { "Events": [ "InventoryRetrievalCompleted", "ArchiveRetrievalCompleted" ], "SNSTopic": "arn:aws:sns:us-west-2:0123456789012:my-vault" } } ``` Se nenhuma notificação tiver sido configurada para o cofre, será retornado um erro. O Amazon Glacier exige um argumento de ID de conta ao realizar operações, mas você pode usar um hífen para especificar a conta em uso. + Consulte detalhes da API em [GetVaultNotifications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/get-vault-notifications.html) na *Referência de comandos da AWS CLI*. ### `initiate-job` O código de exemplo a seguir mostra como usar `initiate-job`. **AWS CLI** O comando a seguir inicia um trabalho para obter um inventário de cofre `my-vault`: ``` aws glacier initiate-job --account-id - --vault-name my-vault --job-parameters '{"Type": "inventory-retrieval"}' ``` Resultado: ``` { "location": "/0123456789012/vaults/my-vault/jobs/zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW", "jobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW" } ``` O Amazon Glacier exige um argumento de ID de conta ao realizar operações, mas você pode usar um hífen para especificar a conta em uso. O comando a seguir inicia um trabalho para recuperar um arquivo do cofre `my-vault`: ``` aws glacier initiate-job --account-id - --vault-name my-vault --job-parameters file://job-archive-retrieval.json ``` `job-archive-retrieval.json` é um arquivo JSON na pasta local que especifica o tipo de trabalho, a ID do arquivo e alguns parâmetros opcionais: ``` { "Type": "archive-retrieval", "ArchiveId": "kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw", "Description": "Retrieve archive on 2015-07-17", "SNSTopic": "arn:aws:sns:us-west-2:0123456789012:my-topic" } ``` As IDs de arquivo estão disponíveis na saída de `aws glacier upload-archive` e `aws glacier get-job-output`. Resultado: ``` { "location": "/011685312445/vaults/mwunderl/jobs/l7IL5-EkXyEY9Ws95fClzIbk2O5uLYaFdAYOi-azsX_Z8V6NH4yERHzars8wTKYQMX6nBDI9cMNHzyZJO59-8N9aHWav", "jobId": "l7IL5-EkXy2O5uLYaFdAYOiEY9Ws95fClzIbk-azsX_Z8V6NH4yERHzars8wTKYQMX6nBDI9cMNHzyZJO59-8N9aHWav" } ``` Consulte Iniciar Tarefa na *Referência de API do Amazon Glacier* para ver detalhes sobre o formato dos parâmetros da tarefa. + Para ver detalhes da API, consulte [InitiateJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/initiate-job.html) na *Referência de comandos da AWS CLI*. ### `initiate-multipart-upload` O código de exemplo a seguir mostra como usar `initiate-multipart-upload`. **AWS CLI** O comando a seguir inicia um upload de várias partes para um cofre chamado `my-vault` com uma parte de 1 MiB (1024 x 1024 bytes) por arquivo: ``` aws glacier initiate-multipart-upload --account-id - --part-size 1048576 --vault-name my-vault --archive-description "multipart upload test" ``` O parâmetro de descrição do arquivo é opcional. O Amazon Glacier exige um argumento de ID de conta ao realizar operações, mas você pode usar um hífen para especificar a conta em uso. Esse comando gera uma ID de upload quando bem-sucedido. Use a ID de upload ao fazer o upload de cada parte de seu arquivo com `aws glacier upload-multipart-part`. Para ter mais informações sobre uploads fracionados no Amazon Glacier usando a AWS CLI, consulte Using Amazon Glacier no *Guia do usuário da AWS CLI*. + Para ver detalhes da API, consulte [InitiateMultipartUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/initiate-multipart-upload.html) na *Referência de comandos da AWS CLI*. ### `initiate-vault-lock` O código de exemplo a seguir mostra como usar `initiate-vault-lock`. **AWS CLI** **Iniciar o processo de travamento do cofre** O exemplo `initiate-vault-lock` a seguir instala uma política de trava de cofre no cofre específico e define o estado de trava do cofre como `InProgress`. É preciso concluir o processo chamando `complete-vault-lock` dentro de 24 horas para definir o estado da trava do cofre como `Locked`. ``` aws glacier initiate-vault-lock \ --account-id - \ --vault-name MyVaultName \ --policy file://vault_lock_policy.json ``` Conteúdo de `vault_lock_policy.json`: ``` {"Policy":"{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-vault-lock\",\"Effect\":\"Deny\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\",\"Condition\":{\"NumericLessThanEquals\":{\"glacier:ArchiveAgeinDays\":\"365\"}}}]}"} ``` A saída é a ID de trava do cofre que pode ser usada para concluir o processo de trava do cofre. ``` { "lockId": "9QZgEXAMPLEPhvL6xEXAMPLE" } ``` Para maiores informações, consulte [Iniciar Bloqueio do Cofre (POST lock-policy)](https://docs.aws.amazon.com/amazonglacier/latest/dev/api-InitiateVaultLock.html) no *Guia do Desenvolvedor de API do Amazon Glacier*. + Para ver detalhes da API, consulte [InitiateVaultLock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/initiate-vault-lock.html) na *Referência de comandos da AWS CLI*. ### `list-jobs` O código de exemplo a seguir mostra como usar `list-jobs`. **AWS CLI** O seguinte comando lista trabalhos em andamento e concluídos recentemente no cofre `my-vault`: ``` aws glacier list-jobs --account-id - --vault-name my-vault ``` Resultado: ``` { "JobList": [ { "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault", "RetrievalByteRange": "0-3145727", "SNSTopic": "arn:aws:sns:us-west-2:0123456789012:my-vault", "Completed": false, "SHA256TreeHash": "9628195fcdbcbbe76cdde932d4646fa7de5f219fb39823836d81f0cc0e18aa67", "JobId": "l7IL5-EkXyEY9Ws95fClzIbk2O5uLYaFdAYOi-azsX_Z8V6NH4yERHzars8wTKYQMX6nBDI9cMNHzyZJO59-8N9aHWav", "ArchiveId": "kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw", "JobDescription": "Retrieve archive on 2015-07-17", "ArchiveSizeInBytes": 3145728, "Action": "ArchiveRetrieval", "ArchiveSHA256TreeHash": "9628195fcdbcbbe76cdde932d4646fa7de5f219fb39823836d81f0cc0e18aa67", "CreationDate": "2015-07-17T21:16:13.840Z", "StatusCode": "InProgress" }, { "InventoryRetrievalParameters": { "Format": "JSON" }, "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault", "Completed": false, "JobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW", "Action": "InventoryRetrieval", "CreationDate": "2015-07-17T20:23:41.616Z", "StatusCode": ""InProgress"" } ] } ``` O Amazon Glacier exige um argumento de ID de conta ao realizar operações, mas você pode usar um hífen para especificar a conta em uso. + Consulte detalhes da API em [ListJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/list-jobs.html) na *Referência de comandos da AWS CLI*. ### `list-multipart-uploads` O código de exemplo a seguir mostra como usar `list-multipart-uploads`. **AWS CLI** O comando a seguir mostra todos os uploads de várias partes em andamento para um cofre chamado `my-vault`: ``` aws glacier list-multipart-uploads --account-id - --vault-name my-vault ``` O Amazon Glacier exige um argumento de ID de conta ao realizar operações, mas você pode usar um hífen para especificar a conta em uso. Para ter mais informações sobre uploads fracionados no Amazon Glacier usando a AWS CLI, consulte Using Amazon Glacier no *Guia do usuário da AWS CLI*. + Consulte detalhes da API em [ListMultipartUploads](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/list-multipart-uploads.html) na *Referência de comandos da AWS CLI*. ### `list-parts` O código de exemplo a seguir mostra como usar `list-parts`. **AWS CLI** O comando a seguir lista as partes transferidas para um upload de várias partes em um cofre chamado `my-vault`: ``` aws glacier list-parts --account-id - --vault-name my-vault --upload-id "SYZi7qnL-YGqGwAm8Kn3BLP2ElNCvnB-5961R09CSaPmPwkYGHOqeN_nX3-Vhnd2yF0KfB5FkmbnBU9GubbdrCs8ut-D" ``` Resultado: ``` { "MultipartUploadId": "SYZi7qnL-YGqGwAm8Kn3BLP2ElNCvnB-5961R09CSaPmPwkYGHOqeN_nX3-Vhnd2yF0KfB5FkmbnBU9GubbdrCs8ut-D", "Parts": [ { "RangeInBytes": "0-1048575", "SHA256TreeHash": "e1f2a7cd6e047350f69b9f8cfa60fa606fe2f02802097a9a026360a7edc1f553" }, { "RangeInBytes": "1048576-2097151", "SHA256TreeHash": "43cf3061fb95796aed99a11a6aa3cd8f839eed15e655ab0a597126210636aee6" } ], "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault", "CreationDate": "2015-07-18T00:05:23.830Z", "PartSizeInBytes": 1048576 } ``` O Amazon Glacier exige um argumento de ID de conta ao realizar operações, mas você pode usar um hífen para especificar a conta em uso. Para ter mais informações sobre uploads fracionados no Amazon Glacier usando a AWS CLI, consulte Using Amazon Glacier no *Guia do usuário da AWS CLI*. + Para ver detalhes da API, consulte [ListParts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/list-parts.html) na *Referência de comandos da AWS CLI*. ### `list-provisioned-capacity` O código de exemplo a seguir mostra como usar `list-provisioned-capacity`. **AWS CLI** **Recuperar as unidades de capacidade provisionadas** O exemplo `list-provisioned-capacity` a seguir recupera detalhes de qualquer unidade de capacidade provisionada para a conta específica. ``` aws glacier list-provisioned-capacity \ --account-id 111122223333 ``` Resultado: ``` { "ProvisionedCapacityList": [ { "CapacityId": "HpASAuvfRFiVDbOjMfEIcr8K", "ExpirationDate": "2020-03-18T19:59:24.000Z", "StartDate": "2020-02-18T19:59:24.912Z" } ] } ``` + Para ver detalhes da API, consulte [ListProvisionedCapacity](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/list-provisioned-capacity.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-vault` O código de exemplo a seguir mostra como usar `list-tags-for-vault`. **AWS CLI** O seguinte comando lista as tags aplicadas ao cofre `my-vault`: ``` aws glacier list-tags-for-vault --account-id - --vault-name my-vault ``` Resultado: ``` { "Tags": { "date": "july2015", "id": "1234" } } ``` O Amazon Glacier exige um argumento de ID de conta ao realizar operações, mas você pode usar um hífen para especificar a conta em uso. + Consulte detalhes da API em [ListTagsForVault](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/list-tags-for-vault.html) na *Referência de comandos da AWS CLI*. ### `list-vaults` O código de exemplo a seguir mostra como usar `list-vaults`. **AWS CLI** O seguinte comando lista os cofres na conta e na região padrão: ``` aws glacier list-vaults --account-id - ``` Resultado: ``` { "VaultList": [ { "SizeInBytes": 3178496, "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault", "LastInventoryDate": "2015-04-07T00:26:19.028Z", "VaultName": "my-vault", "NumberOfArchives": 1, "CreationDate": "2015-04-06T21:23:45.708Z" } ] } ``` O Amazon Glacier exige um argumento de ID de conta ao realizar operações, mas você pode usar um hífen para especificar a conta em uso. + Consulte detalhes da API em [ListVaults](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/list-vaults.html) na *Referência de comandos da AWS CLI*. ### `purchase-provisioned-capacity` O código de exemplo a seguir mostra como usar `purchase-provisioned-capacity`. **AWS CLI** **Comprar uma unidade de capacidade provisionada** O exemplo `purchase-provisioned-capacity` a seguir compra uma unidade de capacidade provisionada. ``` aws glacier purchase-provisioned-capacity \ --account-id 111122223333 ``` Resultado: ``` { "capacityId": "HpASAuvfRFiVDbOjMfEIcr8K" } ``` + Para ver detalhes da API, consulte [PurchaseProvisionedCapacity](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/purchase-provisioned-capacity.html) na *Referência de comandos da AWS CLI*. ### `remove-tags-from-vault` O código de exemplo a seguir mostra como usar `remove-tags-from-vault`. **AWS CLI** O comando a seguir remove uma tag com a chave `date` de um cofre chamado `my-vault`: ``` aws glacier remove-tags-from-vault --account-id - --vault-name my-vault --tag-keys date ``` O Amazon Glacier exige um argumento de ID de conta ao realizar operações, mas você pode usar um hífen para especificar a conta em uso. + Para ver detalhes da API, consulte [RemoveTagsFromVault](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/remove-tags-from-vault.html) na *Referência de comandos da AWS CLI*. ### `set-data-retrieval-policy` O código de exemplo a seguir mostra como usar `set-data-retrieval-policy`. **AWS CLI** O comando a seguir configura uma política de recuperação de dados para a conta em uso: ``` aws glacier set-data-retrieval-policy --account-id - --policy file://data-retrieval-policy.json ``` `data-retrieval-policy.json` é um arquivo JSON na pasta atual que especifica uma política de recuperação de dados: ``` { "Rules":[ { "Strategy":"BytesPerHour", "BytesPerHour":10737418240 } ] } ``` O Amazon Glacier exige um argumento de ID de conta ao realizar operações, mas você pode usar um hífen para especificar a conta em uso. O comando a seguir define a política de recuperação de dados para `FreeTier` a partir de um JSON embutido: ``` aws glacier set-data-retrieval-policy --account-id - --policy '{"Rules":[{"Strategy":"FreeTier"}]}' ``` Consulte Definir Política de Recuperação de Dados na *Referência de API do Amazon Glacier* para obter detalhes sobre o padrão da política. + Para obter detalhes sobre a API, consulte [SetDataRetrievalPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/set-data-retrieval-policy.html) na *Referência de comandos da AWS CLI*. ### `set-vault-access-policy` O código de exemplo a seguir mostra como usar `set-vault-access-policy`. **AWS CLI** **Definir a política de acesso de um cofre** O exemplo `set-vault-access-policy` a seguir anexa uma política de permissão ao cofre específico. ``` aws glacier set-vault-access-policy \ --account-id 111122223333 \ --vault-name example_vault --policy '{"Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::444455556666:root\"},\"Action\":\"glacier:ListJobs\",\"Resource\":\"arn:aws:glacier:us-east-1:111122223333:vaults/example_vault\"},{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::444455556666:root\"},\"Action\":\"glacier:UploadArchive\",\"Resource\":\"arn:aws:glacier:us-east-1:111122223333:vaults/example_vault\"}]}"}' ``` Este comando não produz saída. + Para obter detalhes sobre a API, consulte [SetVaultAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/set-vault-access-policy.html) na *AWS CLI Referência de comando*. ### `set-vault-notifications` O código de exemplo a seguir mostra como usar `set-vault-notifications`. **AWS CLI** O seguinte comando configura as notificações do SNS para o cofre `my-vault`: ``` aws glacier set-vault-notifications --account-id - --vault-name my-vault --vault-notification-config file://notificationconfig.json ``` `notificationconfig.json` é um arquivo JSON na pasta atual que especifica um tópico do SNS e os eventos a serem publicados: ``` { "SNSTopic": "arn:aws:sns:us-west-2:0123456789012:my-vault", "Events": ["ArchiveRetrievalCompleted", "InventoryRetrievalCompleted"] } ``` O Amazon Glacier exige um argumento de ID de conta ao realizar operações, mas você pode usar um hífen para especificar a conta em uso. + Consulte detalhes da API em [SetVaultNotifications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/set-vault-notifications.html) na *Referência de comandos da AWS CLI*. ### `upload-archive` O código de exemplo a seguir mostra como usar `upload-archive`. **AWS CLI** O seguinte comando faz upload um arquivo na pasta atual com o nome `archive.zip` para um cofre chamado `my-vault`: ``` aws glacier upload-archive --account-id - --vault-name my-vault --body archive.zip ``` Resultado: ``` { "archiveId": "kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw", "checksum": "969fb39823836d81f0cc028195fcdbcbbe76cdde932d4646fa7de5f21e18aa67", "location": "/0123456789012/vaults/my-vault/archives/kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw" } ``` O Amazon Glacier exige um argumento de ID de conta ao realizar operações, mas você pode usar um hífen para especificar a conta em uso. Para recuperar um arquivamento carregado, inicie um trabalho de recuperação com o comando aws glacier initiate-job. + Consulte detalhes da API em [UploadArchive](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/upload-archive.html) na *Referência de comandos da AWS CLI*. ### `upload-multipart-part` O código de exemplo a seguir mostra como usar `upload-multipart-part`. **AWS CLI** O comando a seguir carrega a primeira parte de 1 MiB (1024 x 1024 bytes) de um arquivamento: ``` aws glacier upload-multipart-part --body part1 --range 'bytes 0-1048575/*' --account-id - --vault-name my-vault --upload-id 19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ ``` O Amazon Glacier exige um argumento de ID de conta ao realizar operações, mas você pode usar um hífen para especificar a conta em uso. O parâmetro de corpo segue um caminho para um arquivo da parte no sistema de arquivos local. O parâmetro de intervalo usa um intervalo de conteúdo HTTP indicando os bytes que a peça ocupa no arquivamento concluído. O ID de upload é retornado pelo comando `aws glacier initiate-multipart-upload` e também pode ser coletado usando `aws glacier list-multipart-uploads`. Para ter mais informações sobre uploads fracionados no Amazon Glacier usando a AWS CLI, consulte Using Amazon Glacier no *Guia do usuário da AWS CLI*. + Consulte detalhes da API em [UploadMultipartPart](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/upload-multipart-part.html) na *Referência de comandos da AWS CLI*. # Exemplos do Global Accelerator usando AWS CLI Os exemplos de código a seguir mostram como executar ações e implementar cenários comuns usando AWS Command Line Interface com o Global Accelerator. *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-custom-routing-endpoints` O código de exemplo a seguir mostra como usar `add-custom-routing-endpoints`. **AWS CLI** **Para adicionar um endpoint de sub-rede VPC a um grupo de endpoints para um acelerador de roteamento personalizado** O exemplo `add-custom-routing-endpoints` a seguir adiciona um endpoint de sub-rede VPC a um grupo de endpoints para um acelerador de roteamento personalizado. ``` aws globalaccelerator add-custom-routing-endpoints \ --endpoint-group-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz/endpoint-group/4321abcd \ --endpoint-configurations "EndpointId=subnet-1234567890abcdef0" ``` Resultado: ``` { "EndpointDescriptions": [ { "EndpointId": "subnet-1234567890abcdef0" } ], "EndpointGroupArn":"arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz/endpoint-group/4321abcd" } ``` Para obter mais informações, consulte [Endpoints de sub-rede da Amazon VPC para aceleradores de roteamento personalizados no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-endpoints.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [AddCustomRoutingEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/add-custom-routing-endpoints.html) na *Referência de comandos da AWS CLI*. ### `advertise-byoip-cidr` O código de exemplo a seguir mostra como usar `advertise-byoip-cidr`. **AWS CLI** **Anunciar um intervalo de endereços** O exemplo `advertise-byoip-cidr` a seguir solicita que AWS anuncie um intervalo de endereços fornecido pelo usuário para ser usado com seus recursos. AWS ``` aws globalaccelerator advertise-byoip-cidr \ --cidr 198.51.100.0/24 ``` Resultado: ``` { "ByoipCidr": { "Cidr": "198.51.100.0/24", "State": "PENDING_ADVERTISING" } } ``` Para obter mais informações, consulte [Usar seu próprio endereço IP no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [AdvertiseByoipCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/advertise-byoip-cidr.html) na *Referência de comandos da AWS CLI*. ### `allow-custom-routing-traffic` O código de exemplo a seguir mostra como usar `allow-custom-routing-traffic`. **AWS CLI** **Permitir tráfego para destinos específicos de instâncias do Amazon EC2 em uma sub-rede VPC para um acelerador de roteamento personalizado** O exemplo `allow-custom-routing-traffic` a seguir especifica que o tráfego é permitido para determinados endereços IP e portas de instância (destino) do Amazon EC2 para um endpoint de sub-rede VPC em um acelerador de roteamento personalizado que pode receber o tráfego. ``` aws globalaccelerator allow-custom-routing-traffic \ --endpoint-group-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz/endpoint-group/ab88888example \ --endpoint-id subnet-abcd123example \ --destination-addresses "172.31.200.6" "172.31.200.7" \ --destination-ports 80 81 ``` Este comando não produz saída. Para obter mais informações, consulte [Endpoints de sub-rede da Amazon VPC para aceleradores de roteamento personalizados no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-endpoints.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [AllowCustomRoutingTraffic](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/allow-custom-routing-traffic.html) na *Referência de comandos da AWS CLI*. ### `create-accelerator` O código de exemplo a seguir mostra como usar `create-accelerator`. **AWS CLI** **Criar um acelerador** O exemplo `create-accelerator` a seguir cria um acelerador de duas marcas com dois endereços IP estáticos BYOIP. É necessário especificar a região `US-West-2 (Oregon)` para criar ou atualizar um acelerador. ``` aws globalaccelerator create-accelerator \ --name ExampleAccelerator \ --tags Key="Name",Value="Example Name" Key="Project",Value="Example Project" \ --ip-addresses 192.0.2.250 198.51.100.52 ``` Resultado: ``` { "Accelerator": { "AcceleratorArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh", "IpAddressType": "IPV4", "Name": "ExampleAccelerator", "Enabled": true, "Status": "IN_PROGRESS", "IpSets": [ { "IpAddresses": [ "192.0.2.250", "198.51.100.52" ], "IpFamily": "IPv4" } ], "DnsName":"a1234567890abcdef.awsglobalaccelerator.com", "CreatedTime": 1542394847.0, "LastModifiedTime": 1542394847.0 } } ``` Para obter mais informações, consulte [Aceleradores no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-accelerators.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [CreateAccelerator](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/create-accelerator.html) na *Referência de comandos da AWS CLI*. ### `create-custom-routing-accelerator` O código de exemplo a seguir mostra como usar `create-custom-routing-accelerator`. **AWS CLI** **Criar um acelerador de roteamento personalizado** O exemplo `create-custom-routing-accelerator` a seguir cria um acelerador de roteamento personalizado com as marcas `Name` e `Project`. ``` aws globalaccelerator create-custom-routing-accelerator \ --name ExampleCustomRoutingAccelerator \ --tags Key="Name",Value="Example Name" Key="Project",Value="Example Project" \ --ip-addresses 192.0.2.250 198.51.100.52 ``` Resultado: ``` { "Accelerator": { "AcceleratorArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh", "IpAddressType": "IPV4", "Name": "ExampleCustomRoutingAccelerator", "Enabled": true, "Status": "IN_PROGRESS", "IpSets": [ { "IpAddresses": [ "192.0.2.250", "198.51.100.52" ], "IpFamily": "IPv4" } ], "DnsName":"a1234567890abcdef.awsglobalaccelerator.com", "CreatedTime": 1542394847.0, "LastModifiedTime": 1542394847.0 } } ``` Para obter mais informações, consulte [Aceleradores de roteamento personalizados no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-accelerators.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [CreateCustomRoutingAccelerator](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/create-custom-routing-accelerator.html) na *Referência de comandos da AWS CLI*. ### `create-custom-routing-endpoint-group` O código de exemplo a seguir mostra como usar `create-custom-routing-endpoint-group`. **AWS CLI** **Criar um grupo de endpoints para um acelerador de roteamento personalizado** O exemplo `create-custom-routing-endpoint-group` a seguir cria um grupo de endpoints para um acelerador de roteamento personalizado. ``` aws globalaccelerator create-custom-routing-endpoint-group \ --listener-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz \ --endpoint-group-region us-east-2 \ --destination-configurations "FromPort=80,ToPort=81,Protocols=TCP,UDP" ``` Resultado: ``` { "EndpointGroup": { "EndpointGroupArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz/endpoint-group/4321abcd", "EndpointGroupRegion": "us-east-2", "DestinationDescriptions": [ { "FromPort": 80, "ToPort": 81, "Protocols": [ "TCP", "UDP" ] } ], "EndpointDescriptions": [] } } ``` Para obter mais informações, consulte [Grupos de endpoints para aceleradores de roteamento personalizados no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-endpoint-groups.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [CreateCustomRoutingEndpointGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/create-custom-routing-endpoint-group.html) na *Referência de comandos da AWS CLI*. ### `create-custom-routing-listener` O código de exemplo a seguir mostra como usar `create-custom-routing-listener`. **AWS CLI** **Criar um receptor para acelerador de roteamento personalizado** O exemplo `create-custom-routing-listener` a seguir cria um receptor com um intervalo de portas de 5.000 a 10.000 para um acelerador de roteamento personalizado. ``` aws globalaccelerator create-custom-routing-listener \ --accelerator-arn arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh \ --port-ranges FromPort=5000,ToPort=10000 ``` Resultado: ``` { "Listener": { "PortRange": [ "FromPort": 5000, "ToPort": 10000 ], "ListenerArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz" } } ``` Para obter mais informações, consulte [Receptores de aceleradores de roteamento personalizados no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-listeners.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [CreateCustomRoutingListener](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/create-custom-routing-listener.html) na *Referência de comandos da AWS CLI*. ### `create-endpoint-group` O código de exemplo a seguir mostra como usar `create-endpoint-group`. **AWS CLI** **Criar um grupo de endpoints** O exemplo `create-endpoint-group` a seguir cria um grupo de endpoints com um endpoint. ``` aws globalaccelerator create-endpoint-group \ --listener-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz \ --endpoint-group-region us-east-1 \ --endpoint-configurations EndpointId=i-1234567890abcdef0,Weight=128 ``` Resultado: ``` { "EndpointGroup": { "TrafficDialPercentage": 100.0, "EndpointDescriptions": [ { "Weight": 128, "EndpointId": "i-1234567890abcdef0" } ], "EndpointGroupArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz/endpoint-group/098765zyxwvu", "EndpointGroupRegion": "us-east-1" } } ``` Para obter mais informações, consulte [Grupos de endpoints no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [CreateEndpointGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/create-endpoint-group.html) na *Referência de comandos da AWS CLI*. ### `create-listener` O código de exemplo a seguir mostra como usar `create-listener`. **AWS CLI** **Criar um receptor** O exemplo `create-listener` a seguir cria um receptor com duas portas. ``` aws globalaccelerator create-listener \ --accelerator-arn arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh \ --port-ranges FromPort=80,ToPort=80 FromPort=81,ToPort=81 \ --protocol TCP ``` Resultado: ``` { "Listener": { "PortRanges": [ { "ToPort": 80, "FromPort": 80 }, { "ToPort": 81, "FromPort": 81 } ], "ClientAffinity": "NONE", "Protocol": "TCP", "ListenerArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz" } } ``` Para obter mais informações, consulte [Receptores no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-listeners.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Consulte detalhes da API em [CreateListener](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/create-listener.html) na *Referência de comandos da AWS CLI*. ### `deny-custom-routing-traffic` O código de exemplo a seguir mostra como usar `deny-custom-routing-traffic`. **AWS CLI** **Especificar um endereço de destino que não pode receber tráfego em um acelerador de roteamento personalizado** O exemplo `deny-custom-routing-traffic` a seguir especifica o endereço ou endereços de destino em um endpoint de sub-rede sem condições de receber tráfego para um acelerador de roteamento personalizado. Para especificar mais de um endereço de destino, separe-os com um espaço. Não há resposta para uma chamada bem-sucedida de negação de tráfego personalizado. ``` aws globalaccelerator deny-custom-routing-traffic \ --endpoint-group-arn "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz/endpoint-group/ab88888example" \ --endpoint-id "subnet-abcd123example" \ --destination-addresses "198.51.100.52" ``` Este comando não produz saída. Para obter mais informações, consulte [Endpoints de sub-rede da Amazon VPC para aceleradores de roteamento personalizados no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-endpoints.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [DenyCustomRoutingTraffic](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/deny-custom-routing-traffic.html) na *Referência de comandos da AWS CLI*. ### `deprovision-byoip-cidr` O código de exemplo a seguir mostra como usar `deprovision-byoip-cidr`. **AWS CLI** **Desprovisionar um intervalo de endereços** O exemplo `deprovision-byoip-cidr` a seguir libera o intervalo de endereços específico fornecido pelo usuário para uso com seus recursos da AWS. ``` aws globalaccelerator deprovision-byoip-cidr \ --cidr "198.51.100.0/24" ``` Resultado: ``` { "ByoipCidr": { "Cidr": "198.51.100.0/24", "State": "PENDING_DEPROVISIONING" } } ``` Para obter mais informações, consulte [Usar seu próprio endereço IP no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [DeprovisionByoipCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/deprovision-byoip-cidr.html) na *Referência de comandos da AWS CLI*. ### `describe-accelerator-attributes` O código de exemplo a seguir mostra como usar `describe-accelerator-attributes`. **AWS CLI** **Descrever os atributos de um acelerador** O exemplo `describe-accelerator-attributes` a seguir recupera os atributos de um acelerador. ``` aws globalaccelerator describe-accelerator-attributes \ --accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh ``` Resultado: ``` { "AcceleratorAttributes": { "FlowLogsEnabled": true "FlowLogsS3Bucket": flowlogs-abc "FlowLogsS3Prefix": bucketprefix-abc } } ``` Para obter mais informações, consulte [Aceleradores no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-accelerators.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [DescribeAcceleratorAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/describe-accelerator-attributes.html) na *Referência de comandos da AWS CLI*. ### `describe-accelerator` O código de exemplo a seguir mostra como usar `describe-accelerator`. **AWS CLI** **Descrever um acelerador** O exemplo `describe-accelerator` a seguir recupera detalhes de um acelerador específico. ``` aws globalaccelerator describe-accelerator \ --accelerator-arn arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh ``` Resultado: ``` { "Accelerator": { "AcceleratorArn": "arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh", "IpAddressType": "IPV4", "Name": "ExampleAccelerator", "Enabled": true, "Status": "IN_PROGRESS", "IpSets": [ { "IpAddresses": [ "192.0.2.250", "198.51.100.52" ], "IpFamily": "IPv4" } ], "DnsName":"a1234567890abcdef.awsglobalaccelerator.com", "CreatedTime": 1542394847, "LastModifiedTime": 1542395013 } } ``` Para obter mais informações, consulte [Aceleradores no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-accelerators.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [DescribeAccelerator](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/describe-accelerator.html) na *Referência de comandos da AWS CLI*. ### `describe-custom-routing-accelerator-attributes` O código de exemplo a seguir mostra como usar `describe-custom-routing-accelerator-attributes`. **AWS CLI** **Descrever os atributos de um acelerador de roteamento personalizado** O exemplo `describe-custom-routing-accelerator-attributes` a seguir descreve os atributos de um acelerador de roteamento personalizado. ``` aws globalaccelerator describe-custom-routing-accelerator-attributes \ --accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh ``` Resultado: ``` { "AcceleratorAttributes": { "FlowLogsEnabled": false } } ``` Para obter mais informações, consulte [Aceleradores de roteamento personalizados no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-accelerators.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [DescribeCustomRoutingAcceleratorAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/describe-custom-routing-accelerator-attributes.html) na *Referência de comandos da AWS CLI*. ### `describe-custom-routing-accelerator` O código de exemplo a seguir mostra como usar `describe-custom-routing-accelerator`. **AWS CLI** **Descrever um acelerador de roteamento personalizado** O exemplo `describe-custom-routing-accelerator` a seguir recupera detalhes de um dado acelerador de roteamento personalizado. ``` aws globalaccelerator describe-custom-routing-accelerator \ --accelerator-arn arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh ``` Resultado: ``` { "Accelerator": { "AcceleratorArn": "arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh", "IpAddressType": "IPV4", "Name": "ExampleCustomRoutingAccelerator", "Enabled": true, "Status": "IN_PROGRESS", "IpSets": [ { "IpAddresses": [ "192.0.2.250", "198.51.100.52" ], "IpFamily": "IPv4" } ], "DnsName":"a1234567890abcdef.awsglobalaccelerator.com", "CreatedTime": 1542394847, "LastModifiedTime": 1542395013 } } ``` Para obter mais informações, consulte [Aceleradores de roteamento personalizados no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-accelerators.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [DescribeCustomRoutingAccelerator](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/describe-custom-routing-accelerator.html) na *Referência de comandos da AWS CLI*. ### `describe-custom-routing-endpoint-group` O código de exemplo a seguir mostra como usar `describe-custom-routing-endpoint-group`. **AWS CLI** **Descrever um grupo de endpoints para um acelerador de roteamento personalizado** O exemplo `describe-custom-routing-endpoint-group` a seguir descreve um grupo de endpoints para um acelerador de roteamento personalizado. ``` aws globalaccelerator describe-custom-routing-endpoint-group \ --endpoint-group-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/6789vxyz/endpoint-group/ab88888example ``` Resultado: ``` { "EndpointGroup": { "EndpointGroupArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/6789vxyz/endpoint-group/ab88888example", "EndpointGroupRegion": "us-east-2", "DestinationDescriptions": [ { "FromPort": 5000, "ToPort": 10000, "Protocols": [ "UDP" ] } ], "EndpointDescriptions": [ { "EndpointId": "subnet-1234567890abcdef0" } ] } } ``` Para obter mais informações, consulte [Grupos de endpoints para aceleradores de roteamento personalizados no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-endpoint-groups.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [DescribeCustomRoutingEndpointGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/describe-custom-routing-endpoint-group.html) na *Referência de comandos da AWS CLI*. ### `describe-custom-routing-listener` O código de exemplo a seguir mostra como usar `describe-custom-routing-listener`. **AWS CLI** **Descrever um receptor para um acelerador de roteamento personalizado** O exemplo `describe-custom-routing-listener` a seguir descreve um receptor para um acelerador de roteamento personalizado. ``` aws globalaccelerator describe-custom-routing-listener \ --listener-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234 ``` Resultado: ``` { "Listener": { "PortRanges": [ "FromPort": 5000, "ToPort": 10000 ], "ListenerArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234" } } ``` Para obter mais informações, consulte [Receptores de aceleradores de roteamento personalizados no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-listeners.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [DescribeCustomRoutingListener](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/describe-custom-routing-listener.html) na *Referência de comandos da AWS CLI*. ### `describe-endpoint-group` O código de exemplo a seguir mostra como usar `describe-endpoint-group`. **AWS CLI** **Descrever um grupo de endpoints** O exemplo `describe-endpoint-group` a seguir recupera detalhes sobre um grupo de endpoints com os seguintes endpoints: uma instância do Amazon EC2, um ALB e um NLB. ``` aws globalaccelerator describe-endpoint-group \ --endpoint-group-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/6789vxyz-vxyz-6789-vxyz-6789lmnopqrs/endpoint-group/ab88888example ``` Resultado: ``` { "EndpointGroup": { "TrafficDialPercentage": 100.0, "EndpointDescriptions": [ { "Weight": 128, "EndpointId": "i-1234567890abcdef0" }, { "Weight": 128, "EndpointId": "arn:aws:elasticloadbalancing:us-east-1:000123456789:loadbalancer/app/ALBTesting/alb01234567890xyz" }, { "Weight": 128, "EndpointId": "arn:aws:elasticloadbalancing:us-east-1:000123456789:loadbalancer/net/NLBTesting/alb01234567890qrs" } ], "EndpointGroupArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/6789vxyz-vxyz-6789-vxyz-6789lmnopqrs/endpoint-group/4321abcd-abcd-4321-abcd-4321abcdefg", "EndpointGroupRegion": "us-east-1" } } ``` Para obter mais informações, consulte [Grupos de endpoints no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [DescribeEndpointGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/describe-endpoint-group.html) na *Referência de comandos da AWS CLI*. ### `describe-listener` O código de exemplo a seguir mostra como usar `describe-listener`. **AWS CLI** **Descrever um receptor** O exemplo `describe-listener` a seguir descreve um receptor. ``` aws globalaccelerator describe-listener \ --listener-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234 ``` Resultado: ``` { "Listener": { "ListenerArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234", "PortRanges": [ { "FromPort": 80, "ToPort": 80 } ], "Protocol": "TCP", "ClientAffinity": "NONE" } } ``` Para obter mais informações, consulte [Receptores no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-listeners.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [DescribeListener](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/describe-listener.html) na *AWS CLI Referência de comando*. ### `list-accelerators` O código de exemplo a seguir mostra como usar `list-accelerators`. **AWS CLI** **Listar seus aceleradores** O exemplo `list-accelerators` a seguir lista todos os aceleradores em sua conta da AWS. Esta conta tem dois aceleradores. ``` aws globalaccelerator list-accelerators ``` Resultado: ``` { "Accelerators": [ { "AcceleratorArn": "arn:aws:globalaccelerator::012345678901:accelerator/5555abcd-abcd-5555-abcd-5555EXAMPLE1", "Name": "TestAccelerator", "IpAddressType": "IPV4", "Enabled": true, "IpSets": [ { "IpFamily": "IPv4", "IpAddresses": [ "192.0.2.250", "198.51.100.52" ] } ], "DnsName": "5a5a5a5a5a5a5a5a.awsglobalaccelerator.com", "Status": "DEPLOYED", "CreatedTime": 1552424416.0, "LastModifiedTime": 1569375641.0 }, { "AcceleratorArn": "arn:aws:globalaccelerator::888888888888:accelerator/8888abcd-abcd-8888-abcd-8888EXAMPLE2", "Name": "ExampleAccelerator", "IpAddressType": "IPV4", "Enabled": true, "IpSets": [ { "IpFamily": "IPv4", "IpAddresses": [ "192.0.2.100", "198.51.100.10" ] } ], "DnsName": "6a6a6a6a6a6a6a.awsglobalaccelerator.com", "Status": "DEPLOYED", "CreatedTime": 1575585564.0, "LastModifiedTime": 1579809243.0 }, ] } ``` Para obter mais informações, consulte [Aceleradores no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-accelerators.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [ListAccelerators](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/list-accelerators.html) na *Referência de comandos da AWS CLI*. ### `list-byoip-cidr` O código de exemplo a seguir mostra como usar `list-byoip-cidr`. **AWS CLI** **Listar seus intervalos de endereço** O exemplo `list-byoip-cidr` a seguir lista os intervalos de endereços do tipo use seu próprio endereço IP (BYOIP) que você forneceu para uso com o Global Accelerator. ``` aws globalaccelerator list-byoip-cidrs ``` Resultado: ``` { "ByoipCidrs": [ { "Cidr": "198.51.100.0/24", "State": "READY" } { "Cidr": "203.0.113.25/24", "State": "READY" } ] } ``` Para obter mais informações, consulte [Usar seu próprio endereço IP no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [ListByoipCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/list-byoip-cidr.html) na *Referência de comandos da AWS CLI*. ### `list-custom-routing-accelerators` O código de exemplo a seguir mostra como usar `list-custom-routing-accelerators`. **AWS CLI** **Listar seus aceleradores de roteamento personalizados** O exemplo `list-custom-routing-accelerators` a seguir lista os aceleradores de roteamento personalizados em uma conta da AWS. ``` aws globalaccelerator list-custom-routing-accelerators ``` Resultado: ``` { "Accelerators": [ { "AcceleratorArn": "arn:aws:globalaccelerator::012345678901:accelerator/5555abcd-abcd-5555-abcd-5555EXAMPLE1", "Name": "TestCustomRoutingAccelerator", "IpAddressType": "IPV4", "Enabled": true, "IpSets": [ { "IpFamily": "IPv4", "IpAddresses": [ "192.0.2.250", "198.51.100.52" ] } ], "DnsName": "5a5a5a5a5a5a5a5a.awsglobalaccelerator.com", "Status": "DEPLOYED", "CreatedTime": 1552424416.0, "LastModifiedTime": 1569375641.0 }, { "AcceleratorArn": "arn:aws:globalaccelerator::888888888888:accelerator/8888abcd-abcd-8888-abcd-8888EXAMPLE2", "Name": "ExampleCustomRoutingAccelerator", "IpAddressType": "IPV4", "Enabled": true, "IpSets": [ { "IpFamily": "IPv4", "IpAddresses": [ "192.0.2.100", "198.51.100.10" ] } ], "DnsName": "6a6a6a6a6a6a6a.awsglobalaccelerator.com", "Status": "DEPLOYED", "CreatedTime": 1575585564.0, "LastModifiedTime": 1579809243.0 }, ] } ``` Para obter mais informações, consulte [Aceleradores de roteamento personalizados no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-accelerators.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [ListCustomRoutingAccelerators](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/list-custom-routing-accelerators.html) na *Referência de comandos da AWS CLI*. ### `list-custom-routing-endpoint-groups` O código de exemplo a seguir mostra como usar `list-custom-routing-endpoint-groups`. **AWS CLI** **Listar grupos de endpoints para um receptor em um acelerador de roteamento personalizado** O exemplo `list-custom-routing-endpoint-groups` a seguir lista os grupos de endpoints para um receptor em um acelerador de roteamento personalizado. ``` aws globalaccelerator list-custom-routing-endpoint-groups \ --listener-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234 ``` Resultado: ``` { "EndpointGroups": [ { "EndpointGroupArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234/endpoint-group/ab88888example", "EndpointGroupRegion": "eu-central-1", "DestinationDescriptions": [ { "FromPort": 80, "ToPort": 80, "Protocols": [ "TCP", "UDP" ] } ] "EndpointDescriptions": [ { "EndpointId": "subnet-abcd123example" } ] } ] } ``` Para obter mais informações, consulte [Grupos de endpoints para aceleradores de roteamento personalizados no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-endpoint-groups.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [ListCustomRoutingEndpointGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/list-custom-routing-endpoint-groups.html) na *Referência de comandos da AWS CLI*. ### `list-custom-routing-listeners` O código de exemplo a seguir mostra como usar `list-custom-routing-listeners`. **AWS CLI** **Listar receptores para aceleradores de roteamento personalizados** O exemplo `list-custom-routing-listeners` a seguir lista os receptores para um acelerador de roteamento personalizado. ``` aws globalaccelerator list-custom-routing-listeners \ --accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh ``` Resultado: ``` { "Listeners": [ { "ListenerArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234", "PortRanges": [ { "FromPort": 5000, "ToPort": 10000 } ], "Protocol": "TCP" } ] } ``` Para obter mais informações, consulte [Receptores de aceleradores de roteamento personalizados no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-listeners.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [ListCustomRoutingListeners](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/list-custom-routing-listeners.html) na *Referência de comandos da AWS CLI*. ### `list-custom-routing-port-mappings-by-destination` O código de exemplo a seguir mostra como usar `list-custom-routing-port-mappings-by-destination`. **AWS CLI** **Para listar os mapeamentos de porta para um destino específico do acelerador de roteamento personalizado** O exemplo `list-custom-routing-port-mappings-by-destination` a seguir fornece mapeamentos de porta para um servidor EC2 de destino específico (no endereço de destino) para um acelerador de roteamento personalizado. ``` aws globalaccelerator list-custom-routing-port-mappings-by-destination \ --endpoint-id subnet-abcd123example \ --destination-address 198.51.100.52 ``` Resultado: ``` { "DestinationPortMappings": [ { "AcceleratorArn": "arn:aws:globalaccelerator::402092451327:accelerator/24ea29b8-d750-4489-8919-3095f3c4b0a7", "AcceleratorSocketAddresses": [ { "IpAddress": "192.0.2.250", "Port": 65514 }, { "IpAddress": "192.10.100.99", "Port": 65514 } ], "EndpointGroupArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz/endpoint-group/ab88888example", "EndpointId": "subnet-abcd123example", "EndpointGroupRegion": "us-west-2", "DestinationSocketAddress": { "IpAddress": "198.51.100.52", "Port": 80 }, "IpAddressType": "IPv4", "DestinationTrafficState": "ALLOW" } ] } ``` Para obter mais informações, consulte [Como os aceleradores de roteamento personalizados funcionam no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-how-it-works.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [ListCustomRoutingPortMappingsByDestination](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/list-custom-routing-port-mappings-by-destination.html) na *Referência de comandos da AWS CLI*. ### `list-custom-routing-port-mappings` O código de exemplo a seguir mostra como usar `list-custom-routing-port-mappings`. **AWS CLI** **Listar mapeamentos de porta em um acelerador de roteamento personalizado** O exemplo `list-custom-routing-port-mappings` a seguir fornece uma lista parcial de mapeamentos de portas em um acelerador de roteamento personalizado. ``` aws globalaccelerator list-custom-routing-port-mappings \ --accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh ``` Resultado: ``` { "PortMappings": [ { "AcceleratorPort": 40480, "EndpointGroupArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz/endpoint-group/098765zyxwvu", "EndpointId": "subnet-1234567890abcdef0", "DestinationSocketAddress": { "IpAddress": "192.0.2.250", "Port": 80 }, "Protocols": [ "TCP", "UDP" ], "DestinationTrafficState": "ALLOW" } { "AcceleratorPort": 40481, "EndpointGroupArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz/endpoint-group/098765zyxwvu", "EndpointId": "subnet-1234567890abcdef0", "DestinationSocketAddress": { "IpAddress": "192.0.2.251", "Port": 80 }, "Protocols": [ "TCP", "UDP" ], "DestinationTrafficState": "ALLOW" } ] } ``` Para obter mais informações, consulte [Como os aceleradores de roteamento personalizados funcionam no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-how-it-works.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [ListCustomRoutingPortMappings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/list-custom-routing-port-mappings.html) na *Referência de comandos da AWS CLI*. ### `list-endpoint-groups` O código de exemplo a seguir mostra como usar `list-endpoint-groups`. **AWS CLI** **Listar grupos de endpoints** O exemplo `list-endpoint-groups` a seguir lista os grupos de endpoints de um receptor. Este receptor tem dois grupos de endpoints. ``` aws globalaccelerator --region us-west-2 list-endpoint-groups \ --listener-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234 ``` Resultado: ``` { "EndpointGroups": [ { "EndpointGroupArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234/endpoint-group/ab88888example", "EndpointGroupRegion": "eu-central-1", "EndpointDescriptions": [], "TrafficDialPercentage": 100.0, "HealthCheckPort": 80, "HealthCheckProtocol": "TCP", "HealthCheckIntervalSeconds": 30, "ThresholdCount": 3 } { "EndpointGroupArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234/endpoint-group/ab99999example", "EndpointGroupRegion": "us-east-1", "EndpointDescriptions": [], "TrafficDialPercentage": 50.0, "HealthCheckPort": 80, "HealthCheckProtocol": "TCP", "HealthCheckIntervalSeconds": 30, "ThresholdCount": 3 } ] } ``` Para obter mais informações, consulte [Grupos de Endpoints no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [ListEndpointGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/list-endpoint-groups.html) na *Referência de comandos da AWS CLI*. ### `list-listeners` O código de exemplo a seguir mostra como usar `list-listeners`. **AWS CLI** **Listar receptores** O exemplo `list-listeners` a seguir lista os receptores de um acelerador. ``` aws globalaccelerator list-listeners \ --accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh ``` Resultado: ``` { "Listeners": [ { "ListenerArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234", "PortRanges": [ { "FromPort": 80, "ToPort": 80 } ], "Protocol": "TCP", "ClientAffinity": "NONE" } ] } ``` Para obter mais informações, consulte [Receptores no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-listeners.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [ListListeners](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/list-listeners.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Listar marcas para um acelerador** O exemplo `list-tags-for-resource` a seguir lista as marcas de um acelerador específico. ``` aws globalaccelerator list-tags-for-resource \ --accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh ``` Resultado: ``` { "Tags": [ { "Key": "Project", "Value": "A123456" } ] } ``` Para obter mais informações, consulte [Marcação no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `provision-byoip-cidr` O código de exemplo a seguir mostra como usar `provision-byoip-cidr`. **AWS CLI** **Provisionar um intervalo de endereços** O exemplo `provision-byoip-cidr` a seguir fornece o intervalo de endereços específico a ser usado com seus recursos da AWS. ``` aws globalaccelerator provision-byoip-cidr \ --cidr 192.0.2.250/24 \ --cidr-authorization-context Message="$text_message",Signature="$signed_message" ``` Resultado: ``` { "ByoipCidr": { "Cidr": "192.0.2.250/24", "State": "PENDING_PROVISIONING" } } ``` Para obter mais informações, consulte [Usar seu próprio endereço IP no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [ProvisionByoipCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/provision-byoip-cidr.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Marcar um acelerador** O exemplo `tag-resource` a seguir adiciona as marcas Nome e Projeto a um acelerador, além dos valores correspondentes a cada uma. ``` aws globalaccelerator tag-resource \ --resource-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh \ --tags Key="Name",Value="Example Name" Key="Project",Value="Example Project" ``` Este comando não produz saída. Para obter mais informações, consulte [Marcação no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Remover marca de um acelerador** O exemplo `untag-resource` a seguir remove as marcas Nome e Projeto de um acelerador. ``` aws globalaccelerator untag-resource \ --resource-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh \ --tag-keys Key="Name" Key="Project" ``` Este comando não produz saída. Para obter mais informações, consulte [Marcação no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-accelerator-attributes` O código de exemplo a seguir mostra como usar `update-accelerator-attributes`. **AWS CLI** **Atualizar os atributos de um acelerador** O exemplo `update-accelerator-attributes` a seguir atualiza um acelerador para ativar logs de fluxo. É preciso especificar a `US-West-2 (Oregon)` região para criar ou atualizar os atributos do acelerador. ``` aws globalaccelerator update-accelerator-attributes \ --accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh \ --flow-logs-enabled \ --flow-logs-s3-bucket flowlogs-abc \ --flow-logs-s3-prefix bucketprefix-abc ``` Resultado: ``` { "AcceleratorAttributes": { "FlowLogsEnabled": true "FlowLogsS3Bucket": flowlogs-abc "FlowLogsS3Prefix": bucketprefix-abc } } ``` Para obter mais informações, consulte [Aceleradores no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-accelerators.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [UpdateAcceleratorAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/update-accelerator-attributes.html) na *Referência de comandos da AWS CLI*. ### `update-accelerator` O código de exemplo a seguir mostra como usar `update-accelerator`. **AWS CLI** **Atualizar um acelerador** O exemplo `update-accelerator` a seguir modifica um acelerador para alterar seu nome para `ExampleAcceleratorNew`. É necessário especificar a região `US-West-2 (Oregon)` para criar ou atualizar aceleradores. ``` aws globalaccelerator update-accelerator \ --accelerator-arn arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh \ --name ExampleAcceleratorNew ``` Resultado: ``` { "Accelerator": { "AcceleratorArn": "arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh", "IpAddressType": "IPV4", "Name": "ExampleAcceleratorNew", "Enabled": true, "Status": "IN_PROGRESS", "IpSets": [ { "IpAddresses": [ "192.0.2.250", "198.51.100.52" ], "IpFamily": "IPv4" } ], "DnsName":"a1234567890abcdef.awsglobalaccelerator.com", "CreatedTime": 1232394847, "LastModifiedTime": 1232395654 } } ``` Para obter mais informações, consulte [Aceleradores no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-accelerators.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [UpdateAccelerator](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/update-accelerator.html) na *Referência de comandos da AWS CLI*. ### `update-custom-routing-accelerator-attributes` O código de exemplo a seguir mostra como usar `update-custom-routing-accelerator-attributes`. **AWS CLI** **Atualizar os atributos de um acelerador de roteamento personalizado** O exemplo `update-custom-routing-accelerator-attributes` a seguir atualiza um acelerador de roteamento personalizado para habilitar logs de fluxo. ``` aws globalaccelerator update-custom-routing-accelerator-attributes \ --accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh \ --flow-logs-enabled \ --flow-logs-s3-bucket flowlogs-abc \ --flow-logs-s3-prefix bucketprefix-abc ``` Resultado: ``` { "AcceleratorAttributes": { "FlowLogsEnabled": true "FlowLogsS3Bucket": flowlogs-abc "FlowLogsS3Prefix": bucketprefix-abc } } ``` Para obter mais informações, consulte [Aceleradores de roteamento personalizados no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-accelerators.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [UpdateCustomRoutingAcceleratorAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/update-custom-routing-accelerator-attributes.html) na *Referência de comandos da AWS CLI*. ### `update-custom-routing-accelerator` O código de exemplo a seguir mostra como usar `update-custom-routing-accelerator`. **AWS CLI** **Atualizar um acelerador de roteamento personalizado** O exemplo `update-custom-routing-accelerator` a seguir modifica um acelerador de roteamento personalizado para alterar seu nome. ``` aws globalaccelerator --region us-west-2 update-custom-routing-accelerator \ --accelerator-arn arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh \ --name ExampleCustomRoutingAcceleratorNew ``` Resultado: ``` { "Accelerator": { "AcceleratorArn": "arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh", "IpAddressType": "IPV4", "Name": "ExampleCustomRoutingAcceleratorNew", "Enabled": true, "Status": "IN_PROGRESS", "IpSets": [ { "IpAddresses": [ "192.0.2.250", "198.51.100.52" ], "IpFamily": "IPv4" } ], "DnsName":"a1234567890abcdef.awsglobalaccelerator.com", "CreatedTime": 1232394847, "LastModifiedTime": 1232395654 } } ``` Para obter mais informações, consulte [Aceleradores de roteamento personalizados no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-accelerators.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [UpdateCustomRoutingAccelerator](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/update-custom-routing-accelerator.html) na *Referência de comandos da AWS CLI*. ### `update-custom-routing-listener` O código de exemplo a seguir mostra como usar `update-custom-routing-listener`. **AWS CLI** **Atualizar um receptor para um acelerador de roteamento personalizado** O exemplo `update-custom-routing-listener` a seguir atualiza um receptor para alterar o intervalo de portas. ``` aws globalaccelerator update-custom-routing-listener \ --listener-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz \ --port-ranges FromPort=10000,ToPort=20000 ``` Resultado: ``` { "Listener": { "ListenerArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz "PortRanges": [ { "FromPort": 10000, "ToPort": 20000 } ], "Protocol": "TCP" } } ``` Para obter mais informações, consulte [Receptores de aceleradores de roteamento personalizados no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-listeners.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [UpdateCustomRoutingListener](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/update-custom-routing-listener.html) na *Referência de comandos da AWS CLI*. ### `update-endpoint-group` O código de exemplo a seguir mostra como usar `update-endpoint-group`. **AWS CLI** **Atualizar um grupo de endpoints** O exemplo `update-endpoint-group` a seguir adiciona três endpoints a um grupo de endpoints: um endereço IP elástico, um ALB e um NLB. ``` aws globalaccelerator update-endpoint-group \ --endpoint-group-arn arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/6789vxyz-vxyz-6789-vxyz-6789lmnopqrs/endpoint-group/ab88888example \ --endpoint-configurations \ EndpointId=eipalloc-eip01234567890abc,Weight=128 \ EndpointId=arn:aws:elasticloadbalancing:us-east-1:000123456789:loadbalancer/app/ALBTesting/alb01234567890xyz,Weight=128 \ EndpointId=arn:aws:elasticloadbalancing:us-east-1:000123456789:loadbalancer/net/NLBTesting/alb01234567890qrs,Weight=128 ``` Resultado: ``` { "EndpointGroup": { "TrafficDialPercentage": 100, "EndpointDescriptions": [ { "Weight": 128, "EndpointId": "eip01234567890abc" }, { "Weight": 128, "EndpointId": "arn:aws:elasticloadbalancing:us-east-1:000123456789:loadbalancer/app/ALBTesting/alb01234567890xyz" }, { "Weight": 128, "EndpointId": "arn:aws:elasticloadbalancing:us-east-1:000123456789:loadbalancer/net/NLBTesting/alb01234567890qrs" } ], "EndpointGroupArn": "arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/6789vxyz-vxyz-6789-vxyz-6789lmnopqrs/endpoint-group/4321abcd-abcd-4321-abcd-4321abcdefg", "EndpointGroupRegion": "us-east-1" } } ``` Para obter mais informações, consulte [Grupos de endpoints no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [UpdateEndpointGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/update-endpoint-group.html) na *Referência de comandos da AWS CLI*. ### `update-listener` O código de exemplo a seguir mostra como usar `update-listener`. **AWS CLI** **Atualizar um receptor** O exemplo `update-listener` a seguir atualiza um receptor para alterar a porta para 100. ``` aws globalaccelerator update-listener \ --listener-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz \ --port-ranges FromPort=100,ToPort=100 ``` Resultado: ``` { "Listener": { "ListenerArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz "PortRanges": [ { "FromPort": 100, "ToPort": 100 } ], "Protocol": "TCP", "ClientAffinity": "NONE" } } ``` Para obter mais informações, consulte [Receptores no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-listeners.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [UpdateListener](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/update-listener.html) na *Referência de comandos da AWS CLI*. ### `withdraw-byoip-cidr` O código de exemplo a seguir mostra como usar `withdraw-byoip-cidr`. **AWS CLI** **Para remover um intervalo de endereços** O exemplo `withdraw-byoip-cidr` a seguir remove do AWS Global Accelerator um intervalo de endereços que você divulgou anteriormente para ser usado com seus recursos da AWS. ``` aws globalaccelerator withdraw-byoip-cidr \ --cidr 192.0.2.250/24 ``` Resultado: ``` { "ByoipCidr": { "Cidr": "192.0.2.250/24", "State": "PENDING_WITHDRAWING" } } ``` Para obter mais informações, consulte [Usar seu próprio endereço IP no AWS Global Accelerator](https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) no *Guia do Desenvolvedor do AWS Global Accelerator*. + Para ver detalhes da API, consulte [WithdrawByoipCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/withdraw-byoip-cidr.html) na *Referência de comandos da AWS CLI*. # AWS Glue Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o 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 ### `batch-stop-job-run` O código de exemplo a seguir mostra como usar `batch-stop-job-run`. **AWS CLI** **Interromper execuções de tarefa** O exemplo `batch-stop-job-run` a seguir interrompe a execução de uma tarefa. ``` aws glue batch-stop-job-run \ --job-name "my-testing-job" \ --job-run-id jr_852f1de1f29fb62e0ba4166c33970803935d87f14f96cfdee5089d5274a61d3f ``` Resultado: ``` { "SuccessfulSubmissions": [ { "JobName": "my-testing-job", "JobRunId": "jr_852f1de1f29fb62e0ba4166c33970803935d87f14f96cfdee5089d5274a61d3f" } ], "Errors": [], "ResponseMetadata": { "RequestId": "66bd6b90-01db-44ab-95b9-6aeff0e73d88", "HTTPStatusCode": 200, "HTTPHeaders": { "date": "Fri, 16 Oct 2020 20:54:51 GMT", "content-type": "application/x-amz-json-1.1", "content-length": "148", "connection": "keep-alive", "x-amzn-requestid": "66bd6b90-01db-44ab-95b9-6aeff0e73d88" }, "RetryAttempts": 0 } } ``` Para obter mais informações, consulte [Execuções de trabalhos](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-runs.html) no *Guia do desenvolvedor do AWS Glue*. + Para ver detalhes da API, consulte [BatchStopJobRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/batch-stop-job-run.html) na *Referência de comandos da AWS CLI*. ### `create-connection` O código de exemplo a seguir mostra como usar `create-connection`. **AWS CLI** **Criar uma conexão para AWS armazenamentos de dados do Glue** O exemplo `create-connection` a seguir cria uma conexão no Catálogo de Dados do AWS Glue que fornece informações de conexão para armazenar dados Kafka. ``` aws glue create-connection \ --connection-input '{ \ "Name":"conn-kafka-custom", \ "Description":"kafka connection with ssl to custom kafka", \ "ConnectionType":"KAFKA", \ "ConnectionProperties":{ \ "KAFKA_BOOTSTRAP_SERVERS":":", \ "KAFKA_SSL_ENABLED":"true", \ "KAFKA_CUSTOM_CERT": "s3://bucket/prefix/cert-file.pem" \ }, \ "PhysicalConnectionRequirements":{ \ "SubnetId":"subnet-1234", \ "SecurityGroupIdList":["sg-1234"], \ "AvailabilityZone":"us-east-1a"} \ }' \ --region us-east-1 --endpoint https://glue.us-east-1.amazonaws.com ``` Este comando não produz saída. Para obter mais informações, consulte [Defining Connections in the AWS Glue Data Catalog](https://docs.aws.amazon.com/glue/latest/dg/populate-add-connection.html) no *AWS Guia do Desenvolvedor do Glue*. + Para ver detalhes da API, consulte [CreateConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/create-connection.html) na *Referência de comandos da AWS CLI*. ### `create-database` O código de exemplo a seguir mostra como usar `create-database`. **AWS CLI** **Para criar um banco de dados** O exemplo `create-database` a seguir cria um banco de dados no Catálogo de Dados do AWS Glue. ``` aws glue create-database \ --database-input "{\"Name\":\"tempdb\"}" \ --profile my_profile \ --endpoint https://glue.us-east-1.amazonaws.com ``` Este comando não produz saída. Para obter mais informações, consulte [Definir um banco de dados no seu Catálogo de Dados](https://docs.aws.amazon.com/glue/latest/dg/define-database.html) no *Guia do desenvolvedor do AWS Glue*. + Para ver detalhes da API, consulte [CreateDatabase](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/create-database.html) na *Referência de comandos da AWS CLI*. ### `create-job` O código de exemplo a seguir mostra como usar `create-job`. **AWS CLI** **Para criar um trabalho para transformar dados** O exemplo de `create-job` a seguir cria um trabalho de streaming que executa um script armazenado no S3. ``` aws glue create-job \ --name my-testing-job \ --role AWSGlueServiceRoleDefault \ --command '{ \ "Name": "gluestreaming", \ "ScriptLocation": "s3://amzn-s3-demo-bucket/folder/" \ }' \ --region us-east-1 \ --output json \ --default-arguments '{ \ "--job-language":"scala", \ "--class":"GlueApp" \ }' \ --profile my-profile \ --endpoint https://glue.us-east-1.amazonaws.com ``` Conteúdo de `test_script.scala`: ``` import com.amazonaws.services.glue.ChoiceOption import com.amazonaws.services.glue.GlueContext import com.amazonaws.services.glue.MappingSpec import com.amazonaws.services.glue.ResolveSpec import com.amazonaws.services.glue.errors.CallSite import com.amazonaws.services.glue.util.GlueArgParser import com.amazonaws.services.glue.util.Job import com.amazonaws.services.glue.util.JsonOptions import org.apache.spark.SparkContext import scala.collection.JavaConverters._ object GlueApp { def main(sysArgs: Array[String]) { val spark: SparkContext = new SparkContext() val glueContext: GlueContext = new GlueContext(spark) // @params: [JOB_NAME] val args = GlueArgParser.getResolvedOptions(sysArgs, Seq("JOB_NAME").toArray) Job.init(args("JOB_NAME"), glueContext, args.asJava) // @type: DataSource // @args: [database = "tempdb", table_name = "s3-source", transformation_ctx = "datasource0"] // @return: datasource0 // @inputs: [] val datasource0 = glueContext.getCatalogSource(database = "tempdb", tableName = "s3-source", redshiftTmpDir = "", transformationContext = "datasource0").getDynamicFrame() // @type: ApplyMapping // @args: [mapping = [("sensorid", "int", "sensorid", "int"), ("currenttemperature", "int", "currenttemperature", "int"), ("status", "string", "status", "string")], transformation_ctx = "applymapping1"] // @return: applymapping1 // @inputs: [frame = datasource0] val applymapping1 = datasource0.applyMapping(mappings = Seq(("sensorid", "int", "sensorid", "int"), ("currenttemperature", "int", "currenttemperature", "int"), ("status", "string", "status", "string")), caseSensitive = false, transformationContext = "applymapping1") // @type: SelectFields // @args: [paths = ["sensorid", "currenttemperature", "status"], transformation_ctx = "selectfields2"] // @return: selectfields2 // @inputs: [frame = applymapping1] val selectfields2 = applymapping1.selectFields(paths = Seq("sensorid", "currenttemperature", "status"), transformationContext = "selectfields2") // @type: ResolveChoice // @args: [choice = "MATCH_CATALOG", database = "tempdb", table_name = "my-s3-sink", transformation_ctx = "resolvechoice3"] // @return: resolvechoice3 // @inputs: [frame = selectfields2] val resolvechoice3 = selectfields2.resolveChoice(choiceOption = Some(ChoiceOption("MATCH_CATALOG")), database = Some("tempdb"), tableName = Some("my-s3-sink"), transformationContext = "resolvechoice3") // @type: DataSink // @args: [database = "tempdb", table_name = "my-s3-sink", transformation_ctx = "datasink4"] // @return: datasink4 // @inputs: [frame = resolvechoice3] val datasink4 = glueContext.getCatalogSink(database = "tempdb", tableName = "my-s3-sink", redshiftTmpDir = "", transformationContext = "datasink4").writeDynamicFrame(resolvechoice3) Job.commit() } } ``` Resultado: ``` { "Name": "my-testing-job" } ``` Para obter mais informações, consulte [Criação de trabalhos no AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/author-job.html) no *Guia do desenvolvedor do AWS Glue*. + Consulte detalhes da API em [CreateJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/create-job.html) na *Referência de comandos da AWS CLI*. ### `create-table` O código de exemplo a seguir mostra como usar `create-table`. **AWS CLI** **Exemplo 1: criar uma tabela para fluxo de dados do Kinesis** O exemplo `create-table` a seguir cria uma tabela no Catálogo de Dados do AWS Glue que descreve um fluxo de dados do Kinesis. ``` aws glue create-table \ --database-name tempdb \ --table-input '{"Name":"test-kinesis-input", "StorageDescriptor":{ \ "Columns":[ \ {"Name":"sensorid", "Type":"int"}, \ {"Name":"currenttemperature", "Type":"int"}, \ {"Name":"status", "Type":"string"} ], \ "Location":"my-testing-stream", \ "Parameters":{ \ "typeOfData":"kinesis","streamName":"my-testing-stream", \ "kinesisUrl":"https://kinesis.us-east-1.amazonaws.com" \ }, \ "SerdeInfo":{ \ "SerializationLibrary":"org.openx.data.jsonserde.JsonSerDe"} \ }, \ "Parameters":{ \ "classification":"json"} \ }' \ --profile my-profile \ --endpoint https://glue.us-east-1.amazonaws.com ``` Este comando não produz saída. Para obter mais informações, consulte [Definição de tabelas no catálogo de dados do AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/tables-described.html) no *Guia do desenvolvedor do AWS Glue*. **Exemplo 2: criar uma tabela para armazenamento de dados Kafka** O exemplo `create-table` a seguir cria uma tabela no Catálogo de Dados do AWS Glue que descreve um armazenamento de dados Kafka. ``` aws glue create-table \ --database-name tempdb \ --table-input '{"Name":"test-kafka-input", "StorageDescriptor":{ \ "Columns":[ \ {"Name":"sensorid", "Type":"int"}, \ {"Name":"currenttemperature", "Type":"int"}, \ {"Name":"status", "Type":"string"} ], \ "Location":"glue-topic", \ "Parameters":{ \ "typeOfData":"kafka","topicName":"glue-topic", \ "connectionName":"my-kafka-connection" }, \ "SerdeInfo":{ \ "SerializationLibrary":"org.apache.hadoop.hive.serde2.OpenCSVSerde"} \ }, \ "Parameters":{ \ "separatorChar":","} \ }' \ --profile my-profile \ --endpoint https://glue.us-east-1.amazonaws.com ``` Este comando não produz saída. Para obter mais informações, consulte [Definição de tabelas no catálogo de dados do AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/tables-described.html) no *Guia do desenvolvedor do AWS Glue*. **Exemplo 3: criar uma tabela para armazenamento de dados AWS do S3** O exemplo `create-table` a seguir cria uma tabela no Catálogo de Dados do AWS Glue que descreve um armazenamento de dados do AWS Simple Storage Service (AWS S3). ``` aws glue create-table \ --database-name tempdb \ --table-input '{"Name":"s3-output", "StorageDescriptor":{ \ "Columns":[ \ {"Name":"s1", "Type":"string"}, \ {"Name":"s2", "Type":"int"}, \ {"Name":"s3", "Type":"string"} ], \ "Location":"s3://bucket-path/", \ "SerdeInfo":{ \ "SerializationLibrary":"org.openx.data.jsonserde.JsonSerDe"} \ }, \ "Parameters":{ \ "classification":"json"} \ }' \ --profile my-profile \ --endpoint https://glue.us-east-1.amazonaws.com ``` Este comando não produz saída. Para obter mais informações, consulte [Definição de tabelas no catálogo de dados do AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/tables-described.html) no *Guia do desenvolvedor do AWS Glue*. + Consulte detalhes da API em [CreateTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/create-table.html) na *Referência de comandos da AWS CLI*. ### `delete-job` O código de exemplo a seguir mostra como usar `delete-job`. **AWS CLI** **Para excluir um trabalho** O exemplo de `delete-job` a seguir exclui um trabalho que não é mais necessário. ``` aws glue delete-job \ --job-name my-testing-job ``` Resultado: ``` { "JobName": "my-testing-job" } ``` Para obter mais informações, consulte [Trabalhar com trabalhos no console do AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/console-jobs.html) no *Guia do desenvolvedor do AWS Glue*. + Consulte detalhes da API em [DeleteJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/delete-job.html) na *Referência de comandos da AWS CLI*. ### `get-databases` O código de exemplo a seguir mostra como usar `get-databases`. **AWS CLI** **Para listar as definições de alguns ou de todos os bancos de dados no Catálogo de Dados do AWS Glue** O exemplo de `get-databases` a seguir retorna informações sobre os bancos de dados no Catálogo de Dados. ``` aws glue get-databases ``` Resultado: ``` { "DatabaseList": [ { "Name": "default", "Description": "Default Hive database", "LocationUri": "file:/spark-warehouse", "CreateTime": 1602084052.0, "CreateTableDefaultPermissions": [ { "Principal": { "DataLakePrincipalIdentifier": "IAM_ALLOWED_PRINCIPALS" }, "Permissions": [ "ALL" ] } ], "CatalogId": "111122223333" }, { "Name": "flights-db", "CreateTime": 1587072847.0, "CreateTableDefaultPermissions": [ { "Principal": { "DataLakePrincipalIdentifier": "IAM_ALLOWED_PRINCIPALS" }, "Permissions": [ "ALL" ] } ], "CatalogId": "111122223333" }, { "Name": "legislators", "CreateTime": 1601415625.0, "CreateTableDefaultPermissions": [ { "Principal": { "DataLakePrincipalIdentifier": "IAM_ALLOWED_PRINCIPALS" }, "Permissions": [ "ALL" ] } ], "CatalogId": "111122223333" }, { "Name": "tempdb", "CreateTime": 1601498566.0, "CreateTableDefaultPermissions": [ { "Principal": { "DataLakePrincipalIdentifier": "IAM_ALLOWED_PRINCIPALS" }, "Permissions": [ "ALL" ] } ], "CatalogId": "111122223333" } ] } ``` Para obter mais informações, consulte [Definir um banco de dados no seu Catálogo de Dados](https://docs.aws.amazon.com/glue/latest/dg/define-database.html) no *Guia do desenvolvedor do AWS Glue*. + Consulte detalhes da API em [GetDatabases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/get-databases.html) na *Referência de comandos da AWS CLI*. ### `get-job-run` O código de exemplo a seguir mostra como usar `get-job-run`. **AWS CLI** **Para obter informações sobre uma execução de trabalho** O exemplo `get-job-run` a seguir recupera informações sobre uma execução de trabalho. ``` aws glue get-job-run \ --job-name "Combine legistators data" \ --run-id jr_012e176506505074d94d761755e5c62538ee1aad6f17d39f527e9140cf0c9a5e ``` Resultado: ``` { "JobRun": { "Id": "jr_012e176506505074d94d761755e5c62538ee1aad6f17d39f527e9140cf0c9a5e", "Attempt": 0, "JobName": "Combine legistators data", "StartedOn": 1602873931.255, "LastModifiedOn": 1602874075.985, "CompletedOn": 1602874075.985, "JobRunState": "SUCCEEDED", "Arguments": { "--enable-continuous-cloudwatch-log": "true", "--enable-metrics": "", "--enable-spark-ui": "true", "--job-bookmark-option": "job-bookmark-enable", "--spark-event-logs-path": "s3://aws-glue-assets-111122223333-us-east-1/sparkHistoryLogs/" }, "PredecessorRuns": [], "AllocatedCapacity": 10, "ExecutionTime": 117, "Timeout": 2880, "MaxCapacity": 10.0, "WorkerType": "G.1X", "NumberOfWorkers": 10, "LogGroupName": "/aws-glue/jobs", "GlueVersion": "2.0" } } ``` Para obter mais informações, consulte [Execuções de trabalhos](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-runs.html) no *Guia do desenvolvedor do AWS Glue*. + Consulte detalhes da API em [GetJobRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/get-job-run.html) na *Referência de comandos da AWS CLI*. ### `get-job-runs` O código de exemplo a seguir mostra como usar `get-job-runs`. **AWS CLI** **Para obter informações sobre todas as execuções de um trabalho** O exemplo `get-job-runs` a seguir recupera informações sobre execuções de trabalho para um trabalho. ``` aws glue get-job-runs \ --job-name "my-testing-job" ``` Resultado: ``` { "JobRuns": [ { "Id": "jr_012e176506505074d94d761755e5c62538ee1aad6f17d39f527e9140cf0c9a5e", "Attempt": 0, "JobName": "my-testing-job", "StartedOn": 1602873931.255, "LastModifiedOn": 1602874075.985, "CompletedOn": 1602874075.985, "JobRunState": "SUCCEEDED", "Arguments": { "--enable-continuous-cloudwatch-log": "true", "--enable-metrics": "", "--enable-spark-ui": "true", "--job-bookmark-option": "job-bookmark-enable", "--spark-event-logs-path": "s3://aws-glue-assets-111122223333-us-east-1/sparkHistoryLogs/" }, "PredecessorRuns": [], "AllocatedCapacity": 10, "ExecutionTime": 117, "Timeout": 2880, "MaxCapacity": 10.0, "WorkerType": "G.1X", "NumberOfWorkers": 10, "LogGroupName": "/aws-glue/jobs", "GlueVersion": "2.0" }, { "Id": "jr_03cc19ddab11c4e244d3f735567de74ff93b0b3ef468a713ffe73e53d1aec08f_attempt_2", "Attempt": 2, "PreviousRunId": "jr_03cc19ddab11c4e244d3f735567de74ff93b0b3ef468a713ffe73e53d1aec08f_attempt_1", "JobName": "my-testing-job", "StartedOn": 1602811168.496, "LastModifiedOn": 1602811282.39, "CompletedOn": 1602811282.39, "JobRunState": "FAILED", "ErrorMessage": "An error occurred while calling o122.pyWriteDynamicFrame. Access Denied (Service: Amazon S3; Status Code: 403; Error Code: AccessDenied; Request ID: 021AAB703DB20A2D; S3 Extended Request ID: teZk24Y09TkXzBvMPG502L5VJBhe9DJuWA9/TXtuGOqfByajkfL/Tlqt5JBGdEGpigAqzdMDM/U=)", "PredecessorRuns": [], "AllocatedCapacity": 10, "ExecutionTime": 110, "Timeout": 2880, "MaxCapacity": 10.0, "WorkerType": "G.1X", "NumberOfWorkers": 10, "LogGroupName": "/aws-glue/jobs", "GlueVersion": "2.0" }, { "Id": "jr_03cc19ddab11c4e244d3f735567de74ff93b0b3ef468a713ffe73e53d1aec08f_attempt_1", "Attempt": 1, "PreviousRunId": "jr_03cc19ddab11c4e244d3f735567de74ff93b0b3ef468a713ffe73e53d1aec08f", "JobName": "my-testing-job", "StartedOn": 1602811020.518, "LastModifiedOn": 1602811138.364, "CompletedOn": 1602811138.364, "JobRunState": "FAILED", "ErrorMessage": "An error occurred while calling o122.pyWriteDynamicFrame. Access Denied (Service: Amazon S3; Status Code: 403; Error Code: AccessDenied; Request ID: 2671D37856AE7ABB; S3 Extended Request ID: RLJCJw20brV+PpC6GpORahyF2fp9flB5SSb2bTGPnUSPVizLXRl1PN3QZldb+v1o9qRVktNYbW8=)", "PredecessorRuns": [], "AllocatedCapacity": 10, "ExecutionTime": 113, "Timeout": 2880, "MaxCapacity": 10.0, "WorkerType": "G.1X", "NumberOfWorkers": 10, "LogGroupName": "/aws-glue/jobs", "GlueVersion": "2.0" } ] } ``` Para obter mais informações, consulte [Execuções de trabalhos](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-runs.html) no *Guia do desenvolvedor do AWS Glue*. + Consulte detalhes da API em [GetJobRuns](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/get-job-runs.html) na *Referência de comandos da AWS CLI*. ### `get-job` O código de exemplo a seguir mostra como usar `get-job`. **AWS CLI** **Para recuperar informações sobre um trabalho** O exemplo de `get-job` a seguir recupera informações sobre um trabalho. ``` aws glue get-job \ --job-name my-testing-job ``` Resultado: ``` { "Job": { "Name": "my-testing-job", "Role": "Glue_DefaultRole", "CreatedOn": 1602805698.167, "LastModifiedOn": 1602805698.167, "ExecutionProperty": { "MaxConcurrentRuns": 1 }, "Command": { "Name": "gluestreaming", "ScriptLocation": "s3://janetst-bucket-01/Scripts/test_script.scala", "PythonVersion": "2" }, "DefaultArguments": { "--class": "GlueApp", "--job-language": "scala" }, "MaxRetries": 0, "AllocatedCapacity": 10, "MaxCapacity": 10.0, "GlueVersion": "1.0" } } ``` Para obter mais informações, consulte [Trabalhos](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html) no *Guia do desenvolvedor do AWS Glue*. + Consulte detalhes da API em [GetJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/get-job.html) na *Referência de comandos da AWS CLI*. ### `get-plan` O código de exemplo a seguir mostra como usar `get-plan`. **AWS CLI** **Obter o código gerado para mapear dados das tabelas de origem para as tabelas de destino** O código a seguir `get-plan` recupera o código gerado para mapear colunas da fonte de dados para o destino de dados. ``` aws glue get-plan --mapping '[ \ { \ "SourcePath":"sensorid", \ "SourceTable":"anything", \ "SourceType":"int", \ "TargetPath":"sensorid", \ "TargetTable":"anything", \ "TargetType":"int" \ }, \ { \ "SourcePath":"currenttemperature", \ "SourceTable":"anything", \ "SourceType":"int", \ "TargetPath":"currenttemperature", \ "TargetTable":"anything", \ "TargetType":"int" \ }, \ { \ "SourcePath":"status", \ "SourceTable":"anything", \ "SourceType":"string", \ "TargetPath":"status", \ "TargetTable":"anything", \ "TargetType":"string" \ }]' \ --source '{ \ "DatabaseName":"tempdb", \ "TableName":"s3-source" \ }' \ --sinks '[ \ { \ "DatabaseName":"tempdb", \ "TableName":"my-s3-sink" \ }]' --language "scala" --endpoint https://glue.us-east-1.amazonaws.com --output "text" ``` Resultado: ``` import com.amazonaws.services.glue.ChoiceOption import com.amazonaws.services.glue.GlueContext import com.amazonaws.services.glue.MappingSpec import com.amazonaws.services.glue.ResolveSpec import com.amazonaws.services.glue.errors.CallSite import com.amazonaws.services.glue.util.GlueArgParser import com.amazonaws.services.glue.util.Job import com.amazonaws.services.glue.util.JsonOptions import org.apache.spark.SparkContext import scala.collection.JavaConverters._ object GlueApp { def main(sysArgs: Array[String]) { val spark: SparkContext = new SparkContext() val glueContext: GlueContext = new GlueContext(spark) // @params: [JOB_NAME] val args = GlueArgParser.getResolvedOptions(sysArgs, Seq("JOB_NAME").toArray) Job.init(args("JOB_NAME"), glueContext, args.asJava) // @type: DataSource // @args: [database = "tempdb", table_name = "s3-source", transformation_ctx = "datasource0"] // @return: datasource0 // @inputs: [] val datasource0 = glueContext.getCatalogSource(database = "tempdb", tableName = "s3-source", redshiftTmpDir = "", transformationContext = "datasource0").getDynamicFrame() // @type: ApplyMapping // @args: [mapping = [("sensorid", "int", "sensorid", "int"), ("currenttemperature", "int", "currenttemperature", "int"), ("status", "string", "status", "string")], transformation_ctx = "applymapping1"] // @return: applymapping1 // @inputs: [frame = datasource0] val applymapping1 = datasource0.applyMapping(mappings = Seq(("sensorid", "int", "sensorid", "int"), ("currenttemperature", "int", "currenttemperature", "int"), ("status", "string", "status", "string")), caseSensitive = false, transformationContext = "applymapping1") // @type: SelectFields // @args: [paths = ["sensorid", "currenttemperature", "status"], transformation_ctx = "selectfields2"] // @return: selectfields2 // @inputs: [frame = applymapping1] val selectfields2 = applymapping1.selectFields(paths = Seq("sensorid", "currenttemperature", "status"), transformationContext = "selectfields2") // @type: ResolveChoice // @args: [choice = "MATCH_CATALOG", database = "tempdb", table_name = "my-s3-sink", transformation_ctx = "resolvechoice3"] // @return: resolvechoice3 // @inputs: [frame = selectfields2] val resolvechoice3 = selectfields2.resolveChoice(choiceOption = Some(ChoiceOption("MATCH_CATALOG")), database = Some("tempdb"), tableName = Some("my-s3-sink"), transformationContext = "resolvechoice3") // @type: DataSink // @args: [database = "tempdb", table_name = "my-s3-sink", transformation_ctx = "datasink4"] // @return: datasink4 // @inputs: [frame = resolvechoice3] val datasink4 = glueContext.getCatalogSink(database = "tempdb", tableName = "my-s3-sink", redshiftTmpDir = "", transformationContext = "datasink4").writeDynamicFrame(resolvechoice3) Job.commit() } } ``` Para obter mais informações, consulte [Editar scripts em AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/edit-script.html) no *AWS Guia do Desenvolvedor do Glue*. + Para ver detalhes da API, consulte [GetPlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/get-plan.html) na * Referência de comandos da AWS CLI*. ### `get-tables` O código de exemplo a seguir mostra como usar `get-tables`. **AWS CLI** **Para listar as definições de algumas ou de todas as tabelas no banco de dados especificado** O exemplo de `get-tables` a seguir retorna informações sobre as tabelas no banco de dados especificado. ``` aws glue get-tables --database-name 'tempdb' ``` Resultado: ``` { "TableList": [ { "Name": "my-s3-sink", "DatabaseName": "tempdb", "CreateTime": 1602730539.0, "UpdateTime": 1602730539.0, "Retention": 0, "StorageDescriptor": { "Columns": [ { "Name": "sensorid", "Type": "int" }, { "Name": "currenttemperature", "Type": "int" }, { "Name": "status", "Type": "string" } ], "Location": "s3://janetst-bucket-01/test-s3-output/", "Compressed": false, "NumberOfBuckets": 0, "SerdeInfo": { "SerializationLibrary": "org.openx.data.jsonserde.JsonSerDe" }, "SortColumns": [], "StoredAsSubDirectories": false }, "Parameters": { "classification": "json" }, "CreatedBy": "arn:aws:iam::007436865787:user/JRSTERN", "IsRegisteredWithLakeFormation": false, "CatalogId": "007436865787" }, { "Name": "s3-source", "DatabaseName": "tempdb", "CreateTime": 1602730658.0, "UpdateTime": 1602730658.0, "Retention": 0, "StorageDescriptor": { "Columns": [ { "Name": "sensorid", "Type": "int" }, { "Name": "currenttemperature", "Type": "int" }, { "Name": "status", "Type": "string" } ], "Location": "s3://janetst-bucket-01/", "Compressed": false, "NumberOfBuckets": 0, "SortColumns": [], "StoredAsSubDirectories": false }, "Parameters": { "classification": "json" }, "CreatedBy": "arn:aws:iam::007436865787:user/JRSTERN", "IsRegisteredWithLakeFormation": false, "CatalogId": "007436865787" }, { "Name": "test-kinesis-input", "DatabaseName": "tempdb", "CreateTime": 1601507001.0, "UpdateTime": 1601507001.0, "Retention": 0, "StorageDescriptor": { "Columns": [ { "Name": "sensorid", "Type": "int" }, { "Name": "currenttemperature", "Type": "int" }, { "Name": "status", "Type": "string" } ], "Location": "my-testing-stream", "Compressed": false, "NumberOfBuckets": 0, "SerdeInfo": { "SerializationLibrary": "org.openx.data.jsonserde.JsonSerDe" }, "SortColumns": [], "Parameters": { "kinesisUrl": "https://kinesis.us-east-1.amazonaws.com", "streamName": "my-testing-stream", "typeOfData": "kinesis" }, "StoredAsSubDirectories": false }, "Parameters": { "classification": "json" }, "CreatedBy": "arn:aws:iam::007436865787:user/JRSTERN", "IsRegisteredWithLakeFormation": false, "CatalogId": "007436865787" } ] } ``` Para obter mais informações, consulte [Definição de tabelas no catálogo de dados do AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/tables-described.html) no *Guia do desenvolvedor do AWS Glue*. + Consulte detalhes da API em [GetTables](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/get-tables.html) na *Referência de comandos da AWS CLI*. ### `start-crawler` O código de exemplo a seguir mostra como usar `start-crawler`. **AWS CLI** **Para iniciar um crawler** O exemplo de `start-crawler` a seguir inicia um crawler. ``` aws glue start-crawler --name my-crawler ``` Resultado: ``` None ``` Para obter mais informações, consulte [Definição de crawlers](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html) no *Guia do desenvolvedor do AWS Glue*. + Consulte detalhes da API em [StartCrawler](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/start-crawler.html) na *Referência de comandos da AWS CLI*. ### `start-job-run` O código de exemplo a seguir mostra como usar `start-job-run`. **AWS CLI** **Para iniciar a execução de um trabalho** O exemplo de `start-job-run` a seguir inicia um trabalho. ``` aws glue start-job-run \ --job-name my-job ``` Resultado: ``` { "JobRunId": "jr_22208b1f44eb5376a60569d4b21dd20fcb8621e1a366b4e7b2494af764b82ded" } ``` Para obter mais informações, consulte [Criação de trabalhos](https://docs.aws.amazon.com/glue/latest/dg/author-job.html) no *Guia do desenvolvedor do AWS Glue*. + Consulte detalhes da API em [StartJobRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/start-job-run.html) na *Referência de comandos da AWS CLI*. # Exemplos do GuardDuty usando AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o GuardDuty. *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 ### `accept-invitation` O código de exemplo a seguir mostra como usar `accept-invitation`. **AWS CLI** **Aceitar um convite para se tornar uma conta-membro do GuardDuty na região atual** O exemplo `accept-invitation` a seguir mostra como aceitar um convite para se tornar uma conta-membro do GuardDuty na região atual. ``` aws guardduty accept-invitation \ --detector-id 12abc34d567e8fa901bc2d34eexample \ --master-id 123456789111 \ --invitation-id d6b94fb03a66ff665f7db8764example ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar Contas GuardDuty Por Convite](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_invitations.html) no Guia do Usuário GuardDuty. + Para ver detalhes da API, consulte [AcceptInvitation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/accept-invitation.html) na *Referência de comandos da AWS CLI*. ### `archive-findings` O código de exemplo a seguir mostra como usar `archive-findings`. **AWS CLI** **Arquivar descobertas na região atual** Este exemplo de `archive-findings` mostra como arquivar descobertas na região atual. ``` aws guardduty archive-findings \ --detector-id 12abc34d567e8fa901bc2d34eexample \ --finding-ids d6b94fb03a66ff665f7db8764example 3eb970e0de00c16ec14e6910fexample ``` Este comando não produz saída. Consulte mais informações em [Creating suppression rules](https://docs.aws.amazon.com/guardduty/latest/ug/findings_suppression-rules-console.html) no *Guia do usuário do GuardDuty*. + Para obter detalhes sobre a API, consulte [ArchiveFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/archive-findings.html) na *AWS CLI Referência de comando*. ### `create-detector` O código de exemplo a seguir mostra como usar `create-detector`. **AWS CLI** **Habilitar o GuardDuty na região atual** Este exemplo mostra como criar um novo detector, que habilita o GuardDuty, na região atual: ``` aws guardduty create-detector \ --enable ``` Resultado: ``` { "DetectorId": "b6b992d6d2f48e64bc59180bfexample" } ``` Para ter mais informações, consulte [Habilitar Amazon GuardDuty](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_settingup.html#guardduty_enable-gd) no *Guia do usuário do GuardDuty*. + Para ver detalhes da API, consulte [CreateDetector](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/create-detector.html) na *Referência de comandos da AWS CLI*. ### `create-filter` O código de exemplo a seguir mostra como usar `create-filter`. **AWS CLI** **Exemplo 1: como criar um filtro para a região atual** O exemplo de `create-filter` a seguir cria um filtro que corresponde a todas as descobertas da verificação de portas para a instância criada com base em uma imagem específica. Isso não suprime essas descobertas. ``` aws guardduty create-filter \ --detector-id b6b992d6d2f48e64bc59180bfexample \ --name myFilterExample \ --finding-criteria '{"Criterion": {"type": {"Eq": ["Recon:EC2/Portscan"]},"resource.instanceDetails.imageId": {"Eq": ["ami-0a7a207083example"]}}}' ``` Resultado: ``` { "Name": "myFilterExample" } ``` Consulte mais informações em [Filtering GuardDuty findings](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_filter-findings.html) no *Guia do usuário do GuardDuty*. **Exemplo 2: como criar um filtro e suprimir descobertas na região atual** O exemplo de `create-filter` a seguir cria um filtro que corresponde a todas as descobertas da verificação de portas para a instância criada com base em uma imagem específica. Esse filtro arquiva essas descobertas para que elas não apareçam em suas descobertas atuais. ``` aws guardduty create-filter \ --detector-id b6b992d6d2f48e64bc59180bfexample \ --action ARCHIVE \ --name myFilterSecondExample \ --finding-criteria '{"Criterion": {"type": {"Eq": ["Recon:EC2/Portscan"]},"resource.instanceDetails.imageId": {"Eq": ["ami-0a7a207083example"]}}}' ``` Resultado: ``` { "Name": "myFilterSecondExample" } ``` Consulte mais informações em [Filtering GuardDuty findings](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_filter-findings.html) no *Guia do usuário do GuardDuty*. + Para ver detalhes da API, consulte [CreateFilter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/create-filter.html) na * Referência de comandos AWS CLI*. ### `create-ip-set` O código de exemplo a seguir mostra como usar `create-ip-set`. **AWS CLI** **Como criar e ativar um conjunto de IPs confiáveis** O exemplo de `create-ip-set` a seguir cria e ativa um conjunto de IPs confiáveis na região atual. ``` aws guardduty create-ip-set \ --detector-id 12abc34d567e8fa901bc2d34eexample \ --name new-ip-set-example \ --format TXT \ --location s3://amzn-s3-demo-bucket/customtrustlist.csv \ --activate ``` Resultado: ``` { "IpSetId": "d4b94fc952d6912b8f3060768example" } ``` Consulte mais informações em [Working with Trusted IP Lists and Threat Lists](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_upload_lists.html) no *Guia do usuário do GuardDuty*. + Para ver detalhes da API, consulte [CreateIpSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/create-ip-set.html) na *Referência de comandos da AWS CLI*. ### `create-members` O código de exemplo a seguir mostra como usar `create-members`. **AWS CLI** **Associar um novo membro à sua conta principal do GuardDuty na região atual.** Este exemplo mostra como associar contas de membros a serem gerenciadas pela atual conta principal do GuardDuty. ``` aws guardduty create-members --detector-id b6b992d6d2f48e64bc59180bfexample \ --account-details AccountId=111122223333,Email=first+member@example.com AccountId=111111111111 ,Email=another+member@example.com ``` Resultado: ``` { "UnprocessedAccounts": [] } ``` Para obter mais informações, consulte [Gerenciar várias contas](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_accounts.html) no Guia do Usuário GuardDuty. + Para ver detalhes da API, consulte [CreateMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/create-members.html) na *Referência de comandos da AWS CLI*. ### `create-publishing-destination` O código de exemplo a seguir mostra como usar `create-publishing-destination`. **AWS CLI** **Criar um destino de publicação para exportar as descobertas do GuardDuty na região atual para.** O exemplo de `create-publishing-destination` a seguir mostra como configurar um destino de publicação para exportar as descobertas atuais (não arquivadas) do GuardDuty e acompanhar os dados históricos das descobertas. ``` aws guardduty create-publishing-destination \ --detector-id b6b992d6d2f48e64bc59180bfexample \ --destination-type S3 \ --destination-properties 'DestinationArn=arn:aws:s3:::amzn-s3-demo-bucket,KmsKeyArn=arn:aws:kms:us-west-1:111122223333:key/84cee9c5-dea1-401a-ab6d-e1de7example' ``` Resultado: ``` { "DestinationId": "46b99823849e1bbc242dfbe3cexample" } ``` Consulte mais informações em [Exporting generated GuardDuty findings to Amazon S3 buckets](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_exportfindings.html) no *Guia do usuário do GuardDuty*. + Para ver detalhes da API, consulte [CreatePublishingDestination](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/create-publishing-destination.html) na *Referência de comandos da AWS CLI*. ### `create-sample-findings` O código de exemplo a seguir mostra como usar `create-sample-findings`. **AWS CLI** **Criar exemplos de descobertas do GuardDuty na região atual.** Este exemplo mostra como criar um exemplo de descoberta dos tipos fornecidos. ``` aws guardduty create-sample-findings \ --detector-id b6b992d6d2f48e64bc59180bfexample \ --finding-types UnauthorizedAccess:EC2/TorClient UnauthorizedAccess:EC2/TorRelay ``` Este comando não produz saída. Para obter mais informações, consulte [Exemplo de descobertas](https://docs.aws.amazon.com/guardduty/latest/ug/sample_findings.html) no *Guia do usuário GuardDuty*. + Para ver detalhes da API, consulte [CreateSampleFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/create-sample-findings.html) na *Referência de comandos da AWS CLI*. ### `create-threat-intel-set` O código de exemplo a seguir mostra como usar `create-threat-intel-set`. **AWS CLI** **Como criar e ativar um conjunto de inteligência de ameaças** O exemplo de `create-threat-intel-set` a seguir cria e ativa um conjunto de inteligência de ameaças na região atual. ``` aws guardduty create-threat-intel-set \ --detector-id b6b992d6d2f48e64bc59180bfexample \ --name myThreatSet-example \ --format TXT \ --location s3://amzn-s3-demo-bucket/threatlist.csv \ --activate ``` Resultado: ``` { "ThreatIntelSetId": "20b9a4691aeb33506b808878cexample" } ``` Consulte mais informações em [Working with Trusted IP Lists and Threat Lists](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_upload_lists.html) no *Guia do usuário do GuardDuty*. + Para ver detalhes da API, consulte [CreateThreatIntelSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/create-threat-intel-set.html) na *Referência de comandos da AWS CLI*. ### `decline-invitations` O código de exemplo a seguir mostra como usar `decline-invitations`. **AWS CLI** **Recusar um convite para que o Guardduty seja gerenciado por outra conta na região atual.** Este exemplo mostra como recusar um convite de associação. ``` aws guardduty decline-invitations \ --account-ids 111122223333 ``` Resultado: ``` { "UnprocessedAccounts": [] } ``` Para obter mais informações, consulte [Gerenciar Contas GuardDuty Por Convite](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_invitations.html) no Guia do Usuário GuardDuty. + Para ver detalhes da API, consulte [DeclineInvitations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/decline-invitations.html) na *Referência de comandos da AWS CLI*. ### `delete-detector` O código de exemplo a seguir mostra como usar `delete-detector`. **AWS CLI** **Excluir um detector e desativar o GuardDuty na região atual.** Este exemplo mostra como excluir um detector. Em caso de êxito, o GuardDuty será desativado na região associada a esse detector. ``` aws guardduty delete-detector \ --detector-id b6b992d6d2f48e64bc59180bfexample ``` Este comando não produz saída. *Para obter mais informações, consulte [Suspensão ou desativação do GuardDuty](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_suspend-disable.html) no Guia do usuário GuardDuty*. + Para ver detalhes da API, consulte [DeleteDetector](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/delete-detector.html) na *Referência de comandos da AWS CLI*. ### `delete-filter` O código de exemplo a seguir mostra como usar `delete-filter`. **AWS CLI** **Excluir um filtro existente na região atual** Este exemplo mostra como criar e excluir um filtro. ``` aws guardduty delete-filter \ --detector-id b6b992d6d2f48e64bc59180bfexample \ --filter-name byebyeFilter ``` Este comando não produz saída. Para obter mais informações, consulte [Filtrar descobertas](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_filter-findings.html) no Guia do usuário do GuardDuty. + Para ver detalhes da API, consulte [DeleteFilter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/delete-filter.html) na * Referência de comandos da AWS CLI*. ### `disable-organization-admin-account` O código de exemplo a seguir mostra como usar `disable-organization-admin-account`. **AWS CLI** **Remover uma conta como administrador delegado do GuardDuty em sua organização** Este exemplo mostra como remover uma conta como administrador delegado do GuardDuty. ``` aws guardduty disable-organization-admin-account \ --admin-account-id 111122223333 ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar contas com o AWS Organizations](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_organizations.html) no *Guia do Usuário GuardDuty*. + Para ver detalhes da API, consulte [DisableOrganizationAdminAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/disable-organization-admin-account.html) na *Referência de comandos da AWS CLI*. ### `disassociate-from-master-account` O código de exemplo a seguir mostra como usar `disassociate-from-master-account`. **AWS CLI** **Como desassociar-se de sua conta de administrador atual na região atual** O exemplo de `disassociate-from-master-account` a seguir desassocia sua conta da conta de administrador atual do GuardDuty na região da AWS atual. ``` aws guardduty disassociate-from-master-account \ --detector-id d4b040365221be2b54a6264dcexample ``` Este comando não produz saída. Consulte mais informações em [Understanding the relationship between GuardDuty administrator account and member accounts](https://docs.aws.amazon.com/guardduty/latest/ug/administrator_member_relationships.html) no *Guia do usuário do GuardDuty*. + Para ver detalhes da API, consulte [DisassociateFromMasterAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/disassociate-from-master-account.html) na *Referência de comandos da AWS CLI*. ### `get-detector` O código de exemplo a seguir mostra como usar `get-detector`. **AWS CLI** **Recuperar detalhes de um detector específico** O exemplo `get-detector` a seguir exibe os detalhes das configurações do detector específico. ``` aws guardduty get-detector \ --detector-id 12abc34d567e8fa901bc2d34eexample ``` Resultado: ``` { "Status": "ENABLED", "ServiceRole": "arn:aws:iam::111122223333:role/aws-service-role/guardduty.amazonaws.com/AWSServiceRoleForAmazonGuardDuty", "Tags": {}, "FindingPublishingFrequency": "SIX_HOURS", "UpdatedAt": "2018-11-07T03:24:22.938Z", "CreatedAt": "2017-12-22T22:51:31.940Z" } ``` Para obter mais informações, consulte [Conceitos e Terminologia](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_concepts.html) no Guia do Usuário GuardDuty. + Para ver detalhes da API, consulte [GetDetector](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/get-detector.html) na *Referência de comandos da AWS CLI*. ### `get-findings` O código de exemplo a seguir mostra como usar `get-findings`. **AWS CLI** **Exemplo 1: recuperar os detalhes de uma descoberta específica** O exemplo `get-findings` a seguir recupera os detalhes completos da descoberta JSON a partir da descoberta especificada. ``` aws guardduty get-findings \ --detector-id 12abc34d567e8fa901bc2d34eexample \ --finding-id 1ab92989eaf0e742df4a014d5example ``` Resultado: ``` { "Findings": [ { "Resource": { "ResourceType": "AccessKey", "AccessKeyDetails": { "UserName": "testuser", "UserType": "IAMUser", "PrincipalId": "AIDACKCEVSQ6C2EXAMPLE", "AccessKeyId": "ASIASZ4SI7REEEXAMPLE" } }, "Description": "APIs commonly used to discover the users, groups, policies and permissions in an account, was invoked by IAM principal testuser under unusual circumstances. Such activity is not typically seen from this principal.", "Service": { "Count": 5, "Archived": false, "ServiceName": "guardduty", "EventFirstSeen": "2020-05-26T22:02:24Z", "ResourceRole": "TARGET", "EventLastSeen": "2020-05-26T22:33:55Z", "DetectorId": "d4b040365221be2b54a6264dcexample", "Action": { "ActionType": "AWS_API_CALL", "AwsApiCallAction": { "RemoteIpDetails": { "GeoLocation": { "Lat": 51.5164, "Lon": -0.093 }, "City": { "CityName": "London" }, "IpAddressV4": "52.94.36.7", "Organization": { "Org": "Amazon.com", "Isp": "Amazon.com", "Asn": "16509", "AsnOrg": "AMAZON-02" }, "Country": { "CountryName": "United Kingdom" } }, "Api": "ListPolicyVersions", "ServiceName": "iam.amazonaws.com", "CallerType": "Remote IP" } } }, "Title": "Unusual user permission reconnaissance activity by testuser.", "Type": "Recon:IAMUser/UserPermissions", "Region": "us-east-1", "Partition": "aws", "Arn": "arn:aws:guardduty:us-east-1:111122223333:detector/d4b040365221be2b54a6264dcexample/finding/1ab92989eaf0e742df4a014d5example", "UpdatedAt": "2020-05-26T22:55:21.703Z", "SchemaVersion": "2.0", "Severity": 5, "Id": "1ab92989eaf0e742df4a014d5example", "CreatedAt": "2020-05-26T22:21:48.385Z", "AccountId": "111122223333" } ] } ``` Para obter mais informações, consulte [Descobertas](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_findings.html) no Guia do usuário GuardDuty. + Para ver detalhes da API, consulte [GetFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/get-findings.html) na *Referência de comandos da AWS CLI*. ### `get-ip-set` O código de exemplo a seguir mostra como usar `get-ip-set`. **AWS CLI** **Listar detalhes sobre um conjunto específico de IP confiável** O exemplo de `get-ip-set` a seguir mostra o status e os detalhes do conjunto especificado de IPs confiáveis. ``` aws guardduty get-ip-set \ --detector-id 12abc34d567e8fa901bc2d34eexample \ --ip-set-id d4b94fc952d6912b8f3060768example ``` Resultado: ``` { "Status": "ACTIVE", "Location": "s3://amzn-s3-demo-bucket.s3-us-west-2.amazonaws.com/customlist.csv", "Tags": {}, "Format": "TXT", "Name": "test-ip-set-example" } ``` Consulte mais informações em [Working with Trusted IP Lists and Threat Lists](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_upload_lists.html) no *Guia do usuário do GuardDuty*. + Para ver detalhes da API, consulte [GetIpSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/get-ip-set.html) na *Referência de comandos da AWS CLI*. ### `get-master-account` O código de exemplo a seguir mostra como usar `get-master-account`. **AWS CLI** **Recuperar detalhes sobre sua conta principal na região atual** O exemplo `get-master-account` a seguir exibe o status e os detalhes da conta principal associada ao seu detector na região atual. ``` aws guardduty get-master-account \ --detector-id 12abc34d567e8fa901bc2d34eexample ``` Resultado: ``` { "Master": { "InvitationId": "04b94d9704854a73f94e061e8example", "InvitedAt": "2020-06-09T22:23:04.970Z", "RelationshipStatus": "Enabled", "AccountId": "111122223333" } } ``` Consulte mais informações em [Understanding the relationship between GuardDuty administrator account and member account](https://docs.aws.amazon.com/guardduty/latest/ug/administrator_member_relationships.html) no *Guia do usuário do GuardDuty*. + Para ver detalhes da API, consulte [GetMasterAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/get-master-account.html) na *Referência de comandos da AWS CLI*. ### `list-detectors` O código de exemplo a seguir mostra como usar `list-detectors`. **AWS CLI** **Listar os detectores disponíveis na região atual** O exemplo `list-detectors` a seguir lista os detectores disponíveis na sua região da AWS atual. ``` aws guardduty list-detectors ``` Resultado: ``` { "DetectorIds": [ "12abc34d567e8fa901bc2d34eexample" ] } ``` Para obter mais informações, consulte [Conceitos e Terminologia](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_concepts.html) no Guia do Usuário GuardDuty. + Para ver detalhes da API, consulte [ListDetectors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/list-detectors.html) na *Referência de comandos da AWS CLI*. ### `list-findings` O código de exemplo a seguir mostra como usar `list-findings`. **AWS CLI** **Exemplo 1: listar todas as descobertas da região atual** O exemplo `list-findings` a seguir exibe uma lista de todas as descobertas da região atual, classificadas por gravidade, da mais alta para a mais baixa. ``` aws guardduty list-findings \ --detector-id 12abc34d567e8fa901bc2d34eexample \ --sort-criteria '{"AttributeName": "severity","OrderBy":"DESC"}' ``` Resultado: ``` { "FindingIds": [ "04b8ab50fd29c64fc771b232dexample", "5ab8ab50fd21373735c826d3aexample", "90b93de7aba69107f05bbe60bexample", ... ] } ``` Para obter mais informações, consulte [Descobertas](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_findings.html) no Guia do usuário GuardDuty. **Exemplo 2: listar descobertas da região atual que correspondam a um critério de descoberta específico** O exemplo `list-findings` a seguir exibe uma lista de todas as descobertas que correspondem a um tipo de descoberta específico. ``` aws guardduty list-findings \ --detector-id 12abc34d567e8fa901bc2d34eexample \ --finding-criteria '{"Criterion":{"type": {"Eq":["UnauthorizedAccess:EC2/SSHBruteForce"]}}}' ``` Resultado: ``` { "FindingIds": [ "90b93de7aba69107f05bbe60bexample", "6eb9430d7023d30774d6f05e3example", "2eb91a2d060ac9a21963a5848example", "44b8ab50fd2b0039a9e48f570example", "9eb8ab4cd2b7e5b66ba4f5e96example", "e0b8ab3a38e9b0312cc390ceeexample" ] } ``` Para obter mais informações, consulte [Descobertas](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_findings.html) no Guia do usuário GuardDuty. **Exemplo 3: listar as descobertas da região atual que correspondam a um conjunto específico de critérios de busca definidos em um arquivo JSON** O exemplo `list-findings` a seguir exibe uma lista de todas as descobertas que não estão arquivadas e envolvem o usuário do IAM chamado "testuser", conforme especificado em um arquivo JSON. ``` aws guardduty list-findings \ --detector-id 12abc34d567e8fa901bc2d34eexample \ --finding-criteria file://myfile.json ``` Conteúdo de `myfile.json`: ``` {"Criterion": { "resource.accessKeyDetails.userName":{ "Eq":[ "testuser" ] }, "service.archived": { "Eq": [ "false" ] } } } ``` Resultado: ``` { "FindingIds": [ "1ab92989eaf0e742df4a014d5example" ] } ``` Para obter mais informações, consulte [Descobertas](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_findings.html) no Guia do usuário GuardDuty. + Para ver detalhes da API, consulte [ListFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/list-findings.html) na *Referência de comandos da AWS CLI*. ### `list-invitations` O código de exemplo a seguir mostra como usar `list-invitations`. **AWS CLI** **Listar detalhes sobre seus convites para se tornar uma conta-membro na região atual** O exemplo `list-invitations` a seguir lista detalhes e status de seus convites para se tornar uma conta-membro do GuardDuty na região atual. ``` aws guardduty list-invitations ``` Resultado: ``` { "Invitations": [ { "InvitationId": "d6b94fb03a66ff665f7db8764example", "InvitedAt": "2020-06-10T17:56:38.221Z", "RelationshipStatus": "Invited", "AccountId": "123456789111" } ] } ``` Para obter mais informações, consulte [Gerenciar Contas GuardDuty Por Convite](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_invitations.html) no Guia do Usuário GuardDuty. + Para ver detalhes da API, consulte [ListInvitations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/list-invitations.html) na *Referência de comandos da AWS CLI*. ### `list-ip-sets` O código de exemplo a seguir mostra como usar `list-ip-sets`. **AWS CLI** **Listar conjuntos de IP confiáveis na região atual** O exemplo `list-ip-sets` a seguir lista os conjuntos de IP confiáveis na sua região da AWS atual. ``` aws guardduty list-ip-sets \ --detector-id 12abc34d567e8fa901bc2d34eexample ``` Resultado: ``` { "IpSetIds": [ "d4b94fc952d6912b8f3060768example" ] } ``` Consulte mais informações em [Working with Trusted IP Lists and Threat Lists](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_upload_lists.html) no Guia do usuário do GuardDuty. + Para ver detalhes da API, consulte [ListIpSets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/list-ip-sets.html) na *Referência de comandos da AWS CLI*. ### `list-members` O código de exemplo a seguir mostra como usar `list-members`. **AWS CLI** **Exemplo 1: como listar somente os membros atuais na região atual** O exemplo de `list-members` a seguir lista e fornece detalhes somente das contas-membro atuais associadas à conta de administrador do GuardDuty, na região atual. ``` aws guardduty list-members \ --detector-id 12abc34d567e8fa901bc2d34eexample \ --only-associated="true" ``` Resultado: ``` { "Members": [ { "RelationshipStatus": "Enabled", "InvitedAt": "2020-06-09T22:49:00.910Z", "MasterId": "111122223333", "DetectorId": "7ab8b2f61b256c87f793f6a86example", "UpdatedAt": "2020-06-09T23:08:22.512Z", "Email": "your+member@example.com", "AccountId": "123456789012" } ] } ``` Consulte mais informações em [Understanding the relationship between GuardDuty administrator account and member accounts](https://docs.aws.amazon.com/guardduty/latest/ug/administrator_member_relationships.html) no *Guia do usuário do GuardDuty*. **Exemplo 2: como listar todos os membros na região atual** O exemplo de `list-members` a seguir lista e fornece detalhes de todas as contas-membro, incluindo aquelas que foram desassociadas ou que ainda não aceitaram o convite do administrador do GuardDuty na região atual. ``` aws guardduty list-members \ --detector-id 12abc34d567e8fa901bc2d34eexample \ --only-associated="false" ``` Resultado: ``` { "Members": [ { "RelationshipStatus": "Enabled", "InvitedAt": "2020-06-09T22:49:00.910Z", "MasterId": "111122223333", "DetectorId": "7ab8b2f61b256c87f793f6a86example", "UpdatedAt": "2020-06-09T23:08:22.512Z", "Email": "your+other+member@example.com", "AccountId": "555555555555" } ] } ``` Consulte mais informações em [Understanding the relationship between GuardDuty administrator account and member accounts](https://docs.aws.amazon.com/guardduty/latest/ug/administrator_member_relationships.html) no *Guia do usuário do GuardDuty*. + Para ver detalhes da API, consulte [ListMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/list-members.html) na *Referência de comandos da AWS CLI*. ### `update-detector` O código de exemplo a seguir mostra como usar `update-detector`. **AWS CLI** **Exemplo 1: habilitar o monitoramento de runtime no GuardDuty** O exemplo de `update-detector` a seguir permite o monitoramento de runtime sem configuração adicional. ``` aws guardduty update-detector \ --detector-id 12abc34d567e8fa901bc2d34eexample \ --features 'Name=RUNTIME_MONITORING,Status=ENABLED' ``` Este comando não produz saída. Para ter mais informações, consulte [Monitoramento de runtime no GuardDuty](https://docs.aws.amazon.com/guardduty/latest/ug/runtime-monitoring.html) no *Guia do usuário do GuardDuty*. **Exemplo 2: habilitar o monitoramento de runtime com configuração adicional** O exemplo de `update-detector` a seguir permite o monitoramento de runtime com configuração adicional para o EC2, ECS Fargate e EKS. ``` aws guardduty update-detector \ --detector-id 12abc34d567e8fa901bc2d34eexample \ --features 'Name=RUNTIME_MONITORING,Status=ENABLED,AdditionalConfiguration=[{Name=EC2_AGENT_MANAGEMENT,Status=ENABLED},{Name=ECS_FARGATE_AGENT_MANAGEMENT,Status=ENABLED},{Name=EKS_ADDON_MANAGEMENT,Status=ENABLED}]' ``` Este comando não produz saída. Para ter mais informações, consulte [Monitoramento de runtime no GuardDuty](https://docs.aws.amazon.com/guardduty/latest/ug/runtime-monitoring.html) no *Guia do usuário do GuardDuty*. + Para ver detalhes da API, consulte [UpdateDetector](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/update-detector.html) na *Referência de comandos da AWS CLI*. ### `update-ip-set` O código de exemplo a seguir mostra como usar `update-ip-set`. **AWS CLI** **Atualizar um conjunto de IP confiável** O exemplo `update-ip-set` a seguir mostra como atualizar os detalhes de um conjunto de IP confiável. ``` aws guardduty update-ip-set \ --detector-id 12abc34d567e8fa901bc2d34eexample \ --ip-set-id d4b94fc952d6912b8f3060768example \ --location https://amzn-s3-demo-bucket.s3-us-west-2.amazonaws.com/customtrustlist2.csv ``` Este comando não produz saída. Consulte mais informações em [Working with Trusted IP Lists and Threat Lists](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_upload_lists.html) no *Guia do usuário do GuardDuty*. + Para ver detalhes da API, consulte [UpdateIpSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/update-ip-set.html) na *Referência de comandos da AWS CLI*. # AWS Health Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o 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 ### `describe-affected-entities` O código de exemplo a seguir mostra como usar `describe-affected-entities`. **AWS CLI** **Listar as entidades afetadas por um evento específico do AWS Health** O exemplo `describe-affected-entities` a seguir lista as entidades afetadas pelo evento específico do AWS Health. Esse evento é uma notificação de cobrança para a conta da AWS. ``` aws health describe-affected-entities \ --filter "eventArns=arn:aws:health:global::event/BILLING/AWS_BILLING_NOTIFICATION/AWS_BILLING_NOTIFICATION_6ce1d874-e995-40e2-99cd-EXAMPLE11145" \ --region us-east-1 ``` Resultado: ``` { "entities": [ { "entityArn": "arn:aws:health:global:123456789012:entity/EXAMPLEimSMoULmWHpb", "eventArn": "arn:aws:health:global::event/BILLING/AWS_BILLING_NOTIFICATION/AWS_BILLING_NOTIFICATION_6ce1d874-e995-40e2-99cd-EXAMPLE11145", "entityValue": "AWS_ACCOUNT", "awsAccountId": "123456789012", "lastUpdatedTime": 1588356454.08 } ] } ``` Para obter mais informações, consulte [Log de Evento](https://docs.aws.amazon.com/health/latest/ug/getting-started-phd.html#event-log) no *Guia do usuário do AWS Health*. + Para ver detalhes da API, consulte [DescribeAffectedEntities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/health/describe-affected-entities.html) na *Referência de comandos da AWS CLI*. ### `describe-event-details` O código de exemplo a seguir mostra como usar `describe-event-details`. **AWS CLI** **Listar informações sobre um evento do AWS Health** O exemplo `describe-event-details` a seguir lista informações sobre o evento específico do AWS Health. ``` aws health describe-event-details \ --event-arns "arn:aws:health:us-east-1::event/EC2/AWS_EC2_OPERATIONAL_ISSUE/AWS_EC2_OPERATIONAL_ISSUE_VKTXI_EXAMPLE111" \ --region us-east-1 ``` Resultado: ``` { "successfulSet": [ { "event": { "arn": "arn:aws:health:us-east-1::event/EC2/AWS_EC2_OPERATIONAL_ISSUE/AWS_EC2_OPERATIONAL_ISSUE_VKTXI_EXAMPLE111", "service": "EC2", "eventTypeCode": "AWS_EC2_OPERATIONAL_ISSUE", "eventTypeCategory": "issue", "region": "us-east-1", "startTime": 1587462325.096, "endTime": 1587464204.774, "lastUpdatedTime": 1587464204.865, "statusCode": "closed" }, "eventDescription": { "latestDescription": "[RESOLVED] Increased API Error Rates and Latencies\n\n[02:45 AM PDT] We are investigating increased API error rates and latencies in the US-EAST-1 Region.\n\n[03:16 AM PDT] Between 2:10 AM and 2:59 AM PDT we experienced increased API error rates and latencies in the US-EAST-1 Region. The issue has been resolved and the service is operating normally." } } ], "failedSet": [] } ``` Para obter mais informações, consulte o [painel Detalhes do evento](https://docs.aws.amazon.com/health/latest/ug/getting-started-phd.html#event-details) no *Guia do Usuário do AWS Health*. + Para ver detalhes da API, consulte [DescribeEventDetails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/health/describe-event-details.html) na *Referência de comandos da AWS CLI*. ### `describe-events` O código de exemplo a seguir mostra como usar `describe-events`. **AWS CLI** **Exemplo 1: listar eventos do AWS Health** O exemplo `describe-events` a seguir lista eventos recentes do AWS Health. ``` aws health describe-events \ --region us-east-1 ``` Resultado: ``` { "events": [ { "arn": "arn:aws:health:us-west-1::event/ECS/AWS_ECS_OPERATIONAL_ISSUE/AWS_ECS_OPERATIONAL_ISSUE_KWQPY_EXAMPLE111", "service": "ECS", "eventTypeCode": "AWS_ECS_OPERATIONAL_ISSUE", "eventTypeCategory": "issue", "region": "us-west-1", "startTime": 1589077890.53, "endTime": 1589086345.597, "lastUpdatedTime": 1589086345.905, "statusCode": "closed", "eventScopeCode": "PUBLIC" }, { "arn": "arn:aws:health:global::event/BILLING/AWS_BILLING_NOTIFICATION/AWS_BILLING_NOTIFICATION_6ce1d874-e995-40e2-99cd-EXAMPLE1118b", "service": "BILLING", "eventTypeCode": "AWS_BILLING_NOTIFICATION", "eventTypeCategory": "accountNotification", "region": "global", "startTime": 1588356000.0, "lastUpdatedTime": 1588356524.358, "statusCode": "open", "eventScopeCode": "ACCOUNT_SPECIFIC" }, { "arn": "arn:aws:health:us-west-2::event/CLOUDFORMATION/AWS_CLOUDFORMATION_OPERATIONAL_ISSUE/AWS_CLOUDFORMATION_OPERATIONAL_ISSUE_OHTWY_EXAMPLE111", "service": "CLOUDFORMATION", "eventTypeCode": "AWS_CLOUDFORMATION_OPERATIONAL_ISSUE", "eventTypeCategory": "issue", "region": "us-west-2", "startTime": 1588279630.761, "endTime": 1588284650.0, "lastUpdatedTime": 1588284691.941, "statusCode": "closed", "eventScopeCode": "PUBLIC" }, { "arn": "arn:aws:health:ap-northeast-1::event/LAMBDA/AWS_LAMBDA_OPERATIONAL_ISSUE/AWS_LAMBDA_OPERATIONAL_ISSUE_JZDND_EXAMPLE111", "service": "LAMBDA", "eventTypeCode": "AWS_LAMBDA_OPERATIONAL_ISSUE", "eventTypeCategory": "issue", "region": "ap-northeast-1", "startTime": 1587379534.08, "endTime": 1587391771.0, "lastUpdatedTime": 1587395689.316, "statusCode": "closed", "eventScopeCode": "PUBLIC" }, { "arn": "arn:aws:health:us-east-1::event/EC2/AWS_EC2_OPERATIONAL_ISSUE/AWS_EC2_OPERATIONAL_ISSUE_COBXJ_EXAMPLE111", "service": "EC2", "eventTypeCode": "AWS_EC2_OPERATIONAL_ISSUE", "eventTypeCategory": "issue", "region": "us-east-1", "startTime": 1586473044.284, "endTime": 1586479706.091, "lastUpdatedTime": 1586479706.153, "statusCode": "closed", "eventScopeCode": "PUBLIC" }, { "arn": "arn:aws:health:global::event/SECURITY/AWS_SECURITY_NOTIFICATION/AWS_SECURITY_NOTIFICATION_42007387-8129-42da-8c88-EXAMPLE11139", "service": "SECURITY", "eventTypeCode": "AWS_SECURITY_NOTIFICATION", "eventTypeCategory": "accountNotification", "region": "global", "startTime": 1585674000.0, "lastUpdatedTime": 1585674004.132, "statusCode": "open", "eventScopeCode": "PUBLIC" }, { "arn": "arn:aws:health:global::event/CLOUDFRONT/AWS_CLOUDFRONT_OPERATIONAL_ISSUE/AWS_CLOUDFRONT_OPERATIONAL_ISSUE_FRQXG_EXAMPLE111", "service": "CLOUDFRONT", "eventTypeCode": "AWS_CLOUDFRONT_OPERATIONAL_ISSUE", "eventTypeCategory": "issue", "region": "global", "startTime": 1585610898.589, "endTime": 1585617671.0, "lastUpdatedTime": 1585620638.869, "statusCode": "closed", "eventScopeCode": "PUBLIC" }, { "arn": "arn:aws:health:us-east-1::event/SES/AWS_SES_OPERATIONAL_ISSUE/AWS_SES_OPERATIONAL_ISSUE_URNDF_EXAMPLE111", "service": "SES", "eventTypeCode": "AWS_SES_OPERATIONAL_ISSUE", "eventTypeCategory": "issue", "region": "us-east-1", "startTime": 1585342008.46, "endTime": 1585344017.0, "lastUpdatedTime": 1585344355.989, "statusCode": "closed", "eventScopeCode": "PUBLIC" }, { "arn": "arn:aws:health:global::event/IAM/AWS_IAM_OPERATIONAL_NOTIFICATION/AWS_IAM_OPERATIONAL_NOTIFICATION_b6771c34-6ecd-4aea-9d3e-EXAMPLE1117e", "service": "IAM", "eventTypeCode": "AWS_IAM_OPERATIONAL_NOTIFICATION", "eventTypeCategory": "accountNotification", "region": "global", "startTime": 1584978300.0, "lastUpdatedTime": 1584978553.572, "statusCode": "open", "eventScopeCode": "ACCOUNT_SPECIFIC" }, { "arn": "arn:aws:health:ap-southeast-2::event/EC2/AWS_EC2_OPERATIONAL_ISSUE/AWS_EC2_OPERATIONAL_ISSUE_HNGHE_EXAMPLE111", "service": "EC2", "eventTypeCode": "AWS_EC2_OPERATIONAL_ISSUE", "eventTypeCategory": "issue", "region": "ap-southeast-2", "startTime": 1583881487.483, "endTime": 1583885056.785, "lastUpdatedTime": 1583885057.052, "statusCode": "closed", "eventScopeCode": "PUBLIC" } ] } ``` Para obter mais informações, consulte [Conceitos básicos do AWS Personal Health Dashboard](https://docs.aws.amazon.com/health/latest/ug/getting-started-phd.html) no *Guia do usuário do AWS Health*. **Exemplo 2: listar eventos do AWS Health por serviço e código de status do evento** O exemplo `describe-events` a seguir lista os eventos do AWS Health do Amazon Elastic Compute Cloud (Amazon EC2) em que o status do evento foi encerrado. ``` aws health describe-events \ --filter "services=EC2,eventStatusCodes=closed" ``` Resultado: ``` { "events": [ { "arn": "arn:aws:health:us-east-1::event/EC2/AWS_EC2_OPERATIONAL_ISSUE/AWS_EC2_OPERATIONAL_ISSUE_VKTXI_EXAMPLE111", "service": "EC2", "eventTypeCode": "AWS_EC2_OPERATIONAL_ISSUE", "eventTypeCategory": "issue", "region": "us-east-1", "startTime": 1587462325.096, "endTime": 1587464204.774, "lastUpdatedTime": 1587464204.865, "statusCode": "closed", "eventScopeCode": "PUBLIC" }, { "arn": "arn:aws:health:us-east-1::event/EC2/AWS_EC2_OPERATIONAL_ISSUE/AWS_EC2_OPERATIONAL_ISSUE_COBXJ_EXAMPLE111", "service": "EC2", "eventTypeCode": "AWS_EC2_OPERATIONAL_ISSUE", "eventTypeCategory": "issue", "region": "us-east-1", "startTime": 1586473044.284, "endTime": 1586479706.091, "lastUpdatedTime": 1586479706.153, "statusCode": "closed", "eventScopeCode": "PUBLIC" }, { "arn": "arn:aws:health:ap-southeast-2::event/EC2/AWS_EC2_OPERATIONAL_ISSUE/AWS_EC2_OPERATIONAL_ISSUE_HNGHE_EXAMPLE111", "service": "EC2", "eventTypeCode": "AWS_EC2_OPERATIONAL_ISSUE", "eventTypeCategory": "issue", "region": "ap-southeast-2", "startTime": 1583881487.483, "endTime": 1583885056.785, "lastUpdatedTime": 1583885057.052, "statusCode": "closed", "eventScopeCode": "PUBLIC" } ] } ``` Para obter mais informações, consulte [Conceitos básicos do AWS Personal Health Dashboard](https://docs.aws.amazon.com/health/latest/ug/getting-started-phd.html) no *Guia do usuário do AWS Health*. + Para ver detalhes da API, consulte [DescribeEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/health/describe-events.html) na *Referência de comandos da AWS CLI*. # Exemplos do HealthImaging usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o HealthImaging. *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-image-set` O código de exemplo a seguir mostra como usar `copy-image-set`. **AWS CLI** **Exemplo 1: para copiar um conjunto de imagens sem um destino.** O exemplo `copy-image-set` a seguir cria uma cópia duplicada de um conjunto de imagens sem um destino. ``` aws medical-imaging copy-image-set \ --datastore-id 12345678901234567890123456789012 \ --source-image-set-id ea92b0d8838c72a3f25d00d13616f87e \ --copy-image-set-information '{"sourceImageSet": {"latestVersionId": "1" } }' ``` Resultado: ``` { "destinationImageSetProperties": { "latestVersionId": "2", "imageSetWorkflowStatus": "COPYING", "updatedAt": 1680042357.432, "imageSetId": "b9a06fef182a5f992842f77f8e0868e5", "imageSetState": "LOCKED", "createdAt": 1680042357.432 }, "sourceImageSetProperties": { "latestVersionId": "1", "imageSetWorkflowStatus": "COPYING_WITH_READ_ONLY_ACCESS", "updatedAt": 1680042357.432, "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e", "imageSetState": "LOCKED", "createdAt": 1680027126.436 }, "datastoreId": "12345678901234567890123456789012" } ``` **Exemplo 2: para copiar um conjunto de imagens com um destino.** O exemplo `copy-image-set` a seguir cria uma cópia duplicada de um conjunto de imagens com um destino. ``` aws medical-imaging copy-image-set \ --datastore-id 12345678901234567890123456789012 \ --source-image-set-id ea92b0d8838c72a3f25d00d13616f87e \ --copy-image-set-information '{"sourceImageSet": {"latestVersionId": "1" }, "destinationImageSet": { "imageSetId": "b9a06fef182a5f992842f77f8e0868e5", "latestVersionId": "1"} }' ``` Resultado: ``` { "destinationImageSetProperties": { "latestVersionId": "2", "imageSetWorkflowStatus": "COPYING", "updatedAt": 1680042505.135, "imageSetId": "b9a06fef182a5f992842f77f8e0868e5", "imageSetState": "LOCKED", "createdAt": 1680042357.432 }, "sourceImageSetProperties": { "latestVersionId": "1", "imageSetWorkflowStatus": "COPYING_WITH_READ_ONLY_ACCESS", "updatedAt": 1680042505.135, "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e", "imageSetState": "LOCKED", "createdAt": 1680027126.436 }, "datastoreId": "12345678901234567890123456789012" } ``` **Exemplo 3: copiar um subconjunto de instâncias de um conjunto de imagens de origem para um conjunto de imagens de destino.** O exemplo `copy-image-set` a seguir copia uma instância DICOM do conjunto de imagens de origem para o conjunto de imagens de destino. O parâmetro force é fornecido para substituir inconsistências nos atributos dos níveis Patient, Study e Series. ``` aws medical-imaging copy-image-set \ --datastore-id 12345678901234567890123456789012 \ --source-image-set-id ea92b0d8838c72a3f25d00d13616f87e \ --copy-image-set-information '{"sourceImageSet": {"latestVersionId": "1","DICOMCopies": {"copiableAttributes": "{\"SchemaVersion\":\"1.1\",\"Study\":{\"Series\":{\"1.3.6.1.4.1.5962.99.1.3673257865.2104868982.1369432891697.3666.0\":{\"Instances\":{\"1.3.6.1.4.1.5962.99.1.3673257865.2104868982.1369432891697.3669.0\":{}}}}}}"}},"destinationImageSet": {"imageSetId": "b9eb50d8ee682eb9fcf4acbf92f62bb7","latestVersionId": "1"}}' \ --force ``` Resultado: ``` { "destinationImageSetProperties": { "latestVersionId": "2", "imageSetWorkflowStatus": "COPYING", "updatedAt": 1680042505.135, "imageSetId": "b9eb50d8ee682eb9fcf4acbf92f62bb7", "imageSetState": "LOCKED", "createdAt": 1680042357.432 }, "sourceImageSetProperties": { "latestVersionId": "1", "imageSetWorkflowStatus": "COPYING_WITH_READ_ONLY_ACCESS", "updatedAt": 1680042505.135, "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e", "imageSetState": "LOCKED", "createdAt": 1680027126.436 }, "datastoreId": "12345678901234567890123456789012" } ``` Para obter mais informações, consulte [Copiar um conjunto de imagens](https://docs.aws.amazon.com/healthimaging/latest/devguide/copy-image-set.html) no *Guia do desenvolvedor do AWS HealthImaging*. + Para obter detalhes sobre a API, consulte [CopyImageSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/copy-image-set.html) na *AWS CLI Command Reference*. ### `create-datastore` O código de exemplo a seguir mostra como usar `create-datastore`. **AWS CLI** **Exemplo 1: criar um datastore** O exemplo de código `create-datastore` a seguir cria um armazenamento de dados com o nome de `my-datastore`. Quando você cria um datastore sem especificar um `--lossless-storage-format`, o padrão do AWS HealthImaging é HTJ2K (High Throughput JPEG 2000). ``` aws medical-imaging create-datastore \ --datastore-name "my-datastore" ``` Resultado: ``` { "datastoreId": "12345678901234567890123456789012", "datastoreStatus": "CREATING" } ``` **Exemplo 2: criar um datastore com o formato de armazenamento JPEG 2000 Lossless** Um datastore configurado com o formato de armazenamento JPEG 2000 Lossless transcodificará e persistirá quadros de imagem sem perdas no formato JPEG 2000. Os quadros de imagem podem então ser recuperados no JPEG 2000 Lossless sem transcodificação. O exemplo de código `create-datastore` a seguir cria um datastore configurado para o formato de armazenamento JPEG 2000 Lossless com o nome `my-datastore`. ``` aws medical-imaging create-datastore \ --datastore-name "my-datastore" \ --lossless-storage-format JPEG_2000_LOSSLESS ``` Resultado: ``` { "datastoreId": "12345678901234567890123456789012", "datastoreStatus": "CREATING" } ``` Para obter mais informações, consulte [Criar um data store](https://docs.aws.amazon.com/healthimaging/latest/devguide/create-data-store.html) no *Guia do desenvolvedor do AWS HealthImaging*. + Consulte detalhes da API em [CreateDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/create-datastore.html) na *Referência de comandos da AWS CLI*. ### `delete-datastore` O código de exemplo a seguir mostra como usar `delete-datastore`. **AWS CLI** **Para excluir um armazenamento de dados** O exemplo de código `delete-datastore` a seguir exclui um armazenamento de dados. ``` aws medical-imaging delete-datastore \ --datastore-id "12345678901234567890123456789012" ``` Resultado: ``` { "datastoreId": "12345678901234567890123456789012", "datastoreStatus": "DELETING" } ``` Para obter mais informações, consulte [Excluir um data store](https://docs.aws.amazon.com/healthimaging/latest/devguide/delete-data-store.html) no *Guia do desenvolvedor do AWS HealthImaging*. + Consulte detalhes da API em [DeleteDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/delete-datastore.html) na *Referência de comandos da AWS CLI*. ### `delete-image-set` O código de exemplo a seguir mostra como usar `delete-image-set`. **AWS CLI** **Para excluir um conjunto de imagens** O exemplo de código `delete-image-set` a seguir exclui um conjunto de imagens. ``` aws medical-imaging delete-image-set \ --datastore-id 12345678901234567890123456789012 \ --image-set-id ea92b0d8838c72a3f25d00d13616f87e ``` Resultado: ``` { "imageSetWorkflowStatus": "DELETING", "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e", "imageSetState": "LOCKED", "datastoreId": "12345678901234567890123456789012" } ``` Para obter mais informações, consulte [Excluir um conjunto de imagens](https://docs.aws.amazon.com/healthimaging/latest/devguide/delete-image-set.html) no *Guia do desenvolvedor do AWS HealthImaging*. + Para obter detalhes sobre a API, consulte [DeleteImageSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/delete-image-set.html) na *AWS CLI Command Reference*. ### `get-datastore` O código de exemplo a seguir mostra como usar `get-datastore`. **AWS CLI** **Exemplo 1: obter as propriedades de um datastore** O exemplo de código `get-datastore` a seguir obtém as propriedades de um armazenamento de dados. ``` aws medical-imaging get-datastore \ --datastore-id 12345678901234567890123456789012 ``` Resultado: ``` { "datastoreProperties": { "datastoreId": "12345678901234567890123456789012", "datastoreName": "TestDatastore123", "datastoreStatus": "ACTIVE", "losslessStorageFormat": "HTJ2K" "datastoreArn": "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012", "createdAt": "2022-11-15T23:33:09.643000+00:00", "updatedAt": "2022-11-15T23:33:09.643000+00:00" } } ``` **Exemplo 2: obter as propriedades do datastore configurado para JPEG 2000** O exemplo de código `get-datastore` a seguir obtém as propriedades de um datastore configurado para o formato de armazenamento JPEG 2000 Lossless. ``` aws medical-imaging get-datastore \ --datastore-id 12345678901234567890123456789012 ``` Resultado: ``` { "datastoreProperties": { "datastoreId": "12345678901234567890123456789012", "datastoreName": "TestDatastore123", "datastoreStatus": "ACTIVE", "losslessStorageFormat": "JPEG_2000_LOSSLESS", "datastoreArn": "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012", "createdAt": "2022-11-15T23:33:09.643000+00:00", "updatedAt": "2022-11-15T23:33:09.643000+00:00" } } ``` Para obter mais informações, consulte [Obter as propriedades de um data store](https://docs.aws.amazon.com/healthimaging/latest/devguide/get-data-store.html) no *Guia do desenvolvedor do AWS HealthImaging*. + Consulte detalhes da API em [GetDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-datastore.html) na *Referência de comandos da AWS CLI*. ### `get-dicom-import-job` O código de exemplo a seguir mostra como usar `get-dicom-import-job`. **AWS CLI** **Para obter as propriedades de um trabalho de importação dicom** O exemplo de código `get-dicom-import-job` a seguir obtém as propriedades de um trabalho de importação dicom. ``` aws medical-imaging get-dicom-import-job \ --datastore-id "12345678901234567890123456789012" \ --job-id "09876543210987654321098765432109" ``` Resultado: ``` { "jobProperties": { "jobId": "09876543210987654321098765432109", "jobName": "my-job", "jobStatus": "COMPLETED", "datastoreId": "12345678901234567890123456789012", "dataAccessRoleArn": "arn:aws:iam::123456789012:role/ImportJobDataAccessRole", "endedAt": "2022-08-12T11:29:42.285000+00:00", "submittedAt": "2022-08-12T11:28:11.152000+00:00", "inputS3Uri": "s3://medical-imaging-dicom-input/dicom_input/", "outputS3Uri": "s3://medical-imaging-output/job_output/12345678901234567890123456789012-DicomImport-09876543210987654321098765432109/" } } ``` Para obter mais informações, consulte [Obter as propriedades de um trabalho de importação](https://docs.aws.amazon.com/healthimaging/latest/devguide/get-dicom-import-job.html) no *Guia do desenvolvedor do AWS HealthImaging*. + Para obter detalhes sobre a API, consulte [GetDICOMImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-dicom-import-job.html) na *AWS CLI Command Reference*. ### `get-image-frame` O código de exemplo a seguir mostra como usar `get-image-frame`. **AWS CLI** **Para obter dados de pixels do conjunto de imagens** O exemplo de código `get-image-frame` a seguir obtém um quadro de imagem. ``` aws medical-imaging get-image-frame \ --datastore-id "12345678901234567890123456789012" \ --image-set-id "98765412345612345678907890789012" \ --image-frame-information imageFrameId=3abf5d5d7ae72f80a0ec81b2c0de3ef4 \ imageframe.jph ``` Observação: esse exemplo de código não inclui uma saída porque a ação GetImageFrame retorna um fluxo de dados de pixels para o arquivo imageframe.jph . Para obter informações sobre decodificação e visualização de quadros de imagem, consulte as bibliotecas de decodificação HTJ2K. Para obter mais informações, consulte [Obter dados de pixel de um conjunto de imagens](https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-frame.html) no *Guia do desenvolvedor do AWS HealthImaging*. + Para obter detalhes sobre a API, consulte [GetImageFrame](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-image-frame.html) na *AWS CLI Command Reference*. ### `get-image-set-metadata` O código de exemplo a seguir mostra como usar `get-image-set-metadata`. **AWS CLI** **Exemplo 1: para obter os metadados de um conjunto de imagens sem versão** O exemplo de código `get-image-set-metadata` a seguir obtém metadados para um conjunto de imagens sem especificar uma versão. Observação: `outfile` é um parâmetro obrigatório ``` aws medical-imaging get-image-set-metadata \ --datastore-id 12345678901234567890123456789012 \ --image-set-id ea92b0d8838c72a3f25d00d13616f87e \ studymetadata.json.gz ``` Os metadados retornados são compactados com o gzip e armazenados no arquivo studymetadata.json.gz. Para visualizar o conteúdo do objeto JSON retornado, você deve primeiro descompactá-lo. Resultado: ``` { "contentType": "application/json", "contentEncoding": "gzip" } ``` **Exemplo 2: para obter os metadados de um conjunto de imagens com versão** O exemplo de código `get-image-set-metadata` a seguir obtém metadados para um conjunto de imagens com uma versão especificada. Observação: `outfile` é um parâmetro obrigatório ``` aws medical-imaging get-image-set-metadata \ --datastore-id 12345678901234567890123456789012 \ --image-set-id ea92b0d8838c72a3f25d00d13616f87e \ --version-id 1 \ studymetadata.json.gz ``` Os metadados retornados são compactados com o gzip e armazenados no arquivo studymetadata.json.gz. Para visualizar o conteúdo do objeto JSON retornado, você deve primeiro descompactá-lo. Resultado: ``` { "contentType": "application/json", "contentEncoding": "gzip" } ``` Para obter mais informações, consulte [Obter metadados de um conjunto de imagem](https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-set-metadata.html) no *Guia do desenvolvedor do AWS HealthImaging*. + Para obter detalhes sobre a API, consulte [GetImageSetMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-image-set-metadata.html) na *AWS CLI Command Reference*. ### `get-image-set` O código de exemplo a seguir mostra como usar `get-image-set`. **AWS CLI** **Para obter as propriedades do conjunto de imagens** O exemplo de código `get-image-set` a seguir obtém as propriedades de um conjunto de imagens. ``` aws medical-imaging get-image-set \ --datastore-id 12345678901234567890123456789012 \ --image-set-id 18f88ac7870584f58d56256646b4d92b \ --version-id 1 ``` Resultado: ``` { "versionId": "1", "imageSetWorkflowStatus": "COPIED", "updatedAt": 1680027253.471, "imageSetId": "18f88ac7870584f58d56256646b4d92b", "imageSetState": "ACTIVE", "createdAt": 1679592510.753, "datastoreId": "12345678901234567890123456789012" } ``` Para obter mais informações, consulte [Obter as propriedades de um conjunto de imagem](https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-set-properties.html) no *Guia do desenvolvedor do AWS HealthImaging*. + Para obter detalhes sobre a API, consulte [GetImageSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-image-set.html) na *AWS CLI Command Reference*. ### `list-datastores` O código de exemplo a seguir mostra como usar `list-datastores`. **AWS CLI** **Para listar armazenamentos de dados** O exemplo de código `list-datastores` a seguir lista os armazenamentos de dados disponíveis. ``` aws medical-imaging list-datastores ``` Resultado: ``` { "datastoreSummaries": [ { "datastoreId": "12345678901234567890123456789012", "datastoreName": "TestDatastore123", "datastoreStatus": "ACTIVE", "datastoreArn": "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012", "createdAt": "2022-11-15T23:33:09.643000+00:00", "updatedAt": "2022-11-15T23:33:09.643000+00:00" } ] } ``` Para obter mais informações, consulte [Listar data stores](https://docs.aws.amazon.com/healthimaging/latest/devguide/list-data-stores.html) no *Guia do desenvolvedor do AWS HealthImaging*. + Consulte detalhes da API em [ListDatastores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/list-datastores.html) na *Referência de comandos da AWS CLI*. ### `list-dicom-import-jobs` O código de exemplo a seguir mostra como usar `list-dicom-import-jobs`. **AWS CLI** **Para listar trabalhos de importação dicom** O exemplo de código `list-dicom-import-jobs` a seguir lista os trabalhos de importação dicom. ``` aws medical-imaging list-dicom-import-jobs \ --datastore-id "12345678901234567890123456789012" ``` Resultado: ``` { "jobSummaries": [ { "jobId": "09876543210987654321098765432109", "jobName": "my-job", "jobStatus": "COMPLETED", "datastoreId": "12345678901234567890123456789012", "dataAccessRoleArn": "arn:aws:iam::123456789012:role/ImportJobDataAccessRole", "endedAt": "2022-08-12T11:21:56.504000+00:00", "submittedAt": "2022-08-12T11:20:21.734000+00:00" } ] } ``` Para obter mais informações, consulte [Listar trabalhos de importação](https://docs.aws.amazon.com/healthimaging/latest/devguide/list-dicom-import-jobs.html) no *Guia do desenvolvedor do AWS HealthImaging*. + Para obter detalhes sobre a API, consulte [ListDICOMImportJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/list-dicom-import-jobs.html) na *AWS CLI Command Reference*. ### `list-image-set-versions` O código de exemplo a seguir mostra como usar `list-image-set-versions`. **AWS CLI** **Para listar as versões de um conjunto de imagens** O exemplo de código `list-image-set-versions` a seguir lista o histórico de versões de um conjunto de imagens. ``` aws medical-imaging list-image-set-versions \ --datastore-id 12345678901234567890123456789012 \ --image-set-id ea92b0d8838c72a3f25d00d13616f87e ``` Resultado: ``` { "imageSetPropertiesList": [ { "ImageSetWorkflowStatus": "UPDATED", "versionId": "4", "updatedAt": 1680029436.304, "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e", "imageSetState": "ACTIVE", "createdAt": 1680027126.436 }, { "ImageSetWorkflowStatus": "UPDATED", "versionId": "3", "updatedAt": 1680029163.325, "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e", "imageSetState": "ACTIVE", "createdAt": 1680027126.436 }, { "ImageSetWorkflowStatus": "COPY_FAILED", "versionId": "2", "updatedAt": 1680027455.944, "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e", "imageSetState": "ACTIVE", "message": "INVALID_REQUEST: Series of SourceImageSet and DestinationImageSet don't match.", "createdAt": 1680027126.436 }, { "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e", "imageSetState": "ACTIVE", "versionId": "1", "ImageSetWorkflowStatus": "COPIED", "createdAt": 1680027126.436 } ] } ``` Para obter mais informações, consulte [Listar versões de um conjunto de imagens](https://docs.aws.amazon.com/healthimaging/latest/devguide/list-image-set-versions.html) no *Guia do desenvolvedor do AWS HealthImaging*. + Para obter detalhes sobre a API, consulte [ListImageSetVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/list-image-set-versions.html) na *AWS CLI Command Reference*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Exemplo 1: para listar as tags de recurso de um armazenamento de dados** O exemplo de código `list-tags-for-resource` a seguir lista as tags de um armazenamento de dados. ``` aws medical-imaging list-tags-for-resource \ --resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012" ``` Resultado: ``` { "tags":{ "Deployment":"Development" } } ``` **Exemplo 2: para listar tags de recurso de um conjunto de imagens** O exemplo de código `list-tags-for-resource` a seguir lista as tags de um conjunto de imagens. ``` aws medical-imaging list-tags-for-resource \ --resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012/imageset/18f88ac7870584f58d56256646b4d92b" ``` Resultado: ``` { "tags":{ "Deployment":"Development" } } ``` Para obter mais informações, consulte [Adicionar tags a recursos com o AWS HealthImaging](https://docs.aws.amazon.com/healthimaging/latest/devguide/tagging.html) no *Guia do desenvolvedor do AWS HealthImaging*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `search-image-sets` O código de exemplo a seguir mostra como usar `search-image-sets`. **AWS CLI** **Exemplo 1: para pesquisar conjuntos de imagens com um operador EQUAL** O exemplo de código `search-image-sets` a seguir usa o operador EQUAL para pesquisar conjuntos de imagens com base em um valor específico. ``` aws medical-imaging search-image-sets \ --datastore-id 12345678901234567890123456789012 \ --search-criteria file://search-criteria.json ``` Conteúdo de `search-criteria.json` ``` { "filters": [{ "values": [{"DICOMPatientId" : "SUBJECT08701"}], "operator": "EQUAL" }] } ``` Resultado: ``` { "imageSetsMetadataSummaries": [{ "imageSetId": "09876543210987654321098765432109", "createdAt": "2022-12-06T21:40:59.429000+00:00", "version": 1, "DICOMTags": { "DICOMStudyId": "2011201407", "DICOMStudyDate": "19991122", "DICOMPatientSex": "F", "DICOMStudyInstanceUID": "1.2.840.99999999.84710745.943275268089", "DICOMPatientBirthDate": "19201120", "DICOMStudyDescription": "UNKNOWN", "DICOMPatientId": "SUBJECT08701", "DICOMPatientName": "Melissa844 Huel628", "DICOMNumberOfStudyRelatedInstances": 1, "DICOMStudyTime": "140728", "DICOMNumberOfStudyRelatedSeries": 1 }, "updatedAt": "2022-12-06T21:40:59.429000+00:00" }] } ``` **Exemplo 2: para pesquisar conjuntos de imagens com um operador BETWEEN usando DICOMStudyDate e DICOMStudyTime** O exemplo de código `search-image-sets` a seguir pesquisa conjuntos de imagens com estudos DICOM gerados entre 1º de janeiro de 1990 (00h) e 1º de janeiro de 2023 (00h). Observação: DICOMStudyTime é opcional. Se não estiver presente, 00h (início do dia) é o valor da hora para as datas fornecidas para filtragem. ``` aws medical-imaging search-image-sets \ --datastore-id 12345678901234567890123456789012 \ --search-criteria file://search-criteria.json ``` Conteúdo de `search-criteria.json` ``` { "filters": [{ "values": [{ "DICOMStudyDateAndTime": { "DICOMStudyDate": "19900101", "DICOMStudyTime": "000000" } }, { "DICOMStudyDateAndTime": { "DICOMStudyDate": "20230101", "DICOMStudyTime": "000000" } }], "operator": "BETWEEN" }] } ``` Resultado: ``` { "imageSetsMetadataSummaries": [{ "imageSetId": "09876543210987654321098765432109", "createdAt": "2022-12-06T21:40:59.429000+00:00", "version": 1, "DICOMTags": { "DICOMStudyId": "2011201407", "DICOMStudyDate": "19991122", "DICOMPatientSex": "F", "DICOMStudyInstanceUID": "1.2.840.99999999.84710745.943275268089", "DICOMPatientBirthDate": "19201120", "DICOMStudyDescription": "UNKNOWN", "DICOMPatientId": "SUBJECT08701", "DICOMPatientName": "Melissa844 Huel628", "DICOMNumberOfStudyRelatedInstances": 1, "DICOMStudyTime": "140728", "DICOMNumberOfStudyRelatedSeries": 1 }, "updatedAt": "2022-12-06T21:40:59.429000+00:00" }] } ``` **Exemplo 3: para pesquisar conjuntos de imagens com um operador BETWEEN usando createdAt (os estudos de tempo persistiam anteriormente)** O exemplo de código `search-image-sets` a seguir pesquisa conjuntos de imagens com estudos DICOM que persistiram no HealthImaging entre os intervalos de tempo no fuso horário UTC. Observação: forneça createdAt no formato do exemplo ("1985-04-12T23:20:50.52Z"). ``` aws medical-imaging search-image-sets \ --datastore-id 12345678901234567890123456789012 \ --search-criteria file://search-criteria.json ``` Conteúdo de `search-criteria.json` ``` { "filters": [{ "values": [{ "createdAt": "1985-04-12T23:20:50.52Z" }, { "createdAt": "2022-04-12T23:20:50.52Z" }], "operator": "BETWEEN" }] } ``` Resultado: ``` { "imageSetsMetadataSummaries": [{ "imageSetId": "09876543210987654321098765432109", "createdAt": "2022-12-06T21:40:59.429000+00:00", "version": 1, "DICOMTags": { "DICOMStudyId": "2011201407", "DICOMStudyDate": "19991122", "DICOMPatientSex": "F", "DICOMStudyInstanceUID": "1.2.840.99999999.84710745.943275268089", "DICOMPatientBirthDate": "19201120", "DICOMStudyDescription": "UNKNOWN", "DICOMPatientId": "SUBJECT08701", "DICOMPatientName": "Melissa844 Huel628", "DICOMNumberOfStudyRelatedInstances": 1, "DICOMStudyTime": "140728", "DICOMNumberOfStudyRelatedSeries": 1 }, "lastUpdatedAt": "2022-12-06T21:40:59.429000+00:00" }] } ``` **Exemplo 4: pesquisar conjuntos de imagens com um operador EQUAL em DICOMSeriesInstanceUID e BETWEEN em updatedAt e classificar a resposta em ordem ASC no campo updatedAt** O exemplo de código `search-image-sets` a seguir pesquisa conjuntos de imagens com um operador EQUAL em DICOMSeriesInstanceUID e BETWEEN em updatedAt e classificar a resposta em ordem ASC no campo updatedAt. Observação: forneça updatedAt no formato do exemplo ("1985-04-12T23:20:50.52Z"). ``` aws medical-imaging search-image-sets \ --datastore-id 12345678901234567890123456789012 \ --search-criteria file://search-criteria.json ``` Conteúdo de `search-criteria.json` ``` { "filters": [{ "values": [{ "updatedAt": "2024-03-11T15:00:05.074000-07:00" }, { "updatedAt": "2024-03-11T16:00:05.074000-07:00" }], "operator": "BETWEEN" }, { "values": [{ "DICOMSeriesInstanceUID": "1.2.840.99999999.84710745.943275268089" }], "operator": "EQUAL" }], "sort": { "sortField": "updatedAt", "sortOrder": "ASC" } } ``` Resultado: ``` { "imageSetsMetadataSummaries": [{ "imageSetId": "09876543210987654321098765432109", "createdAt": "2022-12-06T21:40:59.429000+00:00", "version": 1, "DICOMTags": { "DICOMStudyId": "2011201407", "DICOMStudyDate": "19991122", "DICOMPatientSex": "F", "DICOMStudyInstanceUID": "1.2.840.99999999.84710745.943275268089", "DICOMPatientBirthDate": "19201120", "DICOMStudyDescription": "UNKNOWN", "DICOMPatientId": "SUBJECT08701", "DICOMPatientName": "Melissa844 Huel628", "DICOMNumberOfStudyRelatedInstances": 1, "DICOMStudyTime": "140728", "DICOMNumberOfStudyRelatedSeries": 1 }, "lastUpdatedAt": "2022-12-06T21:40:59.429000+00:00" }] } ``` Para obter mais informações, consulte [Pesquisar conjuntos de imagens](https://docs.aws.amazon.com/healthimaging/latest/devguide/search-image-sets.html) no *Guia do desenvolvedor do AWS HealthImaging*. + Para obter detalhes sobre a API, consulte [SearchImageSets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/search-image-sets.html) na *AWS CLI Command Reference*. ### `start-dicom-import-job` O código de exemplo a seguir mostra como usar `start-dicom-import-job`. **AWS CLI** **Para iniciar um trabalho de importação dicom** O exemplo de código `start-dicom-import-job` a seguir inicia um trabalho de importação dicom. ``` aws medical-imaging start-dicom-import-job \ --job-name "my-job" \ --datastore-id "12345678901234567890123456789012" \ --input-s3-uri "s3://medical-imaging-dicom-input/dicom_input/" \ --output-s3-uri "s3://medical-imaging-output/job_output/" \ --data-access-role-arn "arn:aws:iam::123456789012:role/ImportJobDataAccessRole" ``` Resultado: ``` { "datastoreId": "12345678901234567890123456789012", "jobId": "09876543210987654321098765432109", "jobStatus": "SUBMITTED", "submittedAt": "2022-08-12T11:28:11.152000+00:00" } ``` Para obter mais informações, consulte [Iniciar um trabalho de importação](https://docs.aws.amazon.com/healthimaging/latest/devguide/start-dicom-import-job.html) no *Guia do desenvolvedor do AWS HealthImaging*. + Para obter detalhes sobre a API, consulte [StartDICOMImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/start-dicom-import-job.html) na *AWS CLI Command Reference*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Exemplo 1: para marcar um armazenamento de dados** Os exemplos de código `tag-resource` a seguir marcam um armazenamento de dados. ``` aws medical-imaging tag-resource \ --resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012" \ --tags '{"Deployment":"Development"}' ``` Este comando não produz saída. **Exemplo 2: para marcar um conjunto de imagens** Os exemplos de código `tag-resource` a seguir marcam um conjunto de imagens. ``` aws medical-imaging tag-resource \ --resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012/imageset/18f88ac7870584f58d56256646b4d92b" \ --tags '{"Deployment":"Development"}' ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar tags a recursos com o AWS HealthImaging](https://docs.aws.amazon.com/healthimaging/latest/devguide/tagging.html) no *Guia do desenvolvedor do AWS HealthImaging*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Exemplo 1: para desmarcar um armazenamento de dados** O exemplo de código `untag-resource` a seguir desmarca um armazenamento de dados. ``` aws medical-imaging untag-resource \ --resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012" \ --tag-keys '["Deployment"]' ``` Este comando não produz saída. **Exemplo 2: para desmarcar um conjunto de imagens** O exemplo de código `untag-resource` a seguir desmarca um conjunto de imagens. ``` aws medical-imaging untag-resource \ --resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012/imageset/18f88ac7870584f58d56256646b4d92b" \ --tag-keys '["Deployment"]' ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar tags a recursos com o AWS HealthImaging](https://docs.aws.amazon.com/healthimaging/latest/devguide/tagging.html) no *Guia do desenvolvedor do AWS HealthImaging*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-image-set-metadata` O código de exemplo a seguir mostra como usar `update-image-set-metadata`. **AWS CLI** **Exemplo 1: inserir ou atualizar um atributo nos metadados do conjunto de imagens** O exemplo `update-image-set-metadata` a seguir insere ou atualiza um atributo nos metadados do conjunto de imagens. ``` aws medical-imaging update-image-set-metadata \ --datastore-id 12345678901234567890123456789012 \ --image-set-id ea92b0d8838c72a3f25d00d13616f87e \ --latest-version-id 1 \ --cli-binary-format raw-in-base64-out \ --update-image-set-metadata-updates file://metadata-updates.json ``` Conteúdo de `metadata-updates.json` ``` { "DICOMUpdates": { "updatableAttributes": "{\"SchemaVersion\":1.1,\"Patient\":{\"DICOM\":{\"PatientName\":\"MX^MX\"}}}" } } ``` Resultado: ``` { "latestVersionId": "2", "imageSetWorkflowStatus": "UPDATING", "updatedAt": 1680042257.908, "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e", "imageSetState": "LOCKED", "createdAt": 1680027126.436, "datastoreId": "12345678901234567890123456789012" } ``` **Exemplo 2: remover um atributo dos metadados do conjunto de imagens** O exemplo `update-image-set-metadata` a seguir remove um atributo dos metadados do conjunto de imagens. ``` aws medical-imaging update-image-set-metadata \ --datastore-id 12345678901234567890123456789012 \ --image-set-id ea92b0d8838c72a3f25d00d13616f87e \ --latest-version-id 1 \ --cli-binary-format raw-in-base64-out \ --update-image-set-metadata-updates file://metadata-updates.json ``` Conteúdo de `metadata-updates.json` ``` { "DICOMUpdates": { "removableAttributes": "{\"SchemaVersion\":1.1,\"Study\":{\"DICOM\":{\"StudyDescription\":\"CHEST\"}}}" } } ``` Resultado: ``` { "latestVersionId": "2", "imageSetWorkflowStatus": "UPDATING", "updatedAt": 1680042257.908, "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e", "imageSetState": "LOCKED", "createdAt": 1680027126.436, "datastoreId": "12345678901234567890123456789012" } ``` **Exemplo 3: remover uma instância dos metadados de um conjunto de imagens** O exemplo `update-image-set-metadata` a seguir remove uma instância dos metadados de um conjunto de imagens. ``` aws medical-imaging update-image-set-metadata \ --datastore-id 12345678901234567890123456789012 \ --image-set-id ea92b0d8838c72a3f25d00d13616f87e \ --latest-version-id 1 \ --cli-binary-format raw-in-base64-out \ --update-image-set-metadata-updates file://metadata-updates.json \ --force ``` Conteúdo de `metadata-updates.json` ``` { "DICOMUpdates": { "removableAttributes": "{\"SchemaVersion\": 1.1,\"Study\": {\"Series\": {\"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1\": {\"Instances\": {\"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1\": {}}}}}}" } } ``` Resultado: ``` { "latestVersionId": "2", "imageSetWorkflowStatus": "UPDATING", "updatedAt": 1680042257.908, "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e", "imageSetState": "LOCKED", "createdAt": 1680027126.436, "datastoreId": "12345678901234567890123456789012" } ``` **Exemplo 4: reverter um conjunto de imagens para uma versão anterior** O exemplo `update-image-set-metadata` a seguir mostra como reverter um conjunto de imagens para uma versão anterior. As ações CopyImageSet e UpdateImageSetMetadata criam novas versões dos conjuntos de imagens. ``` aws medical-imaging update-image-set-metadata \ --datastore-id 12345678901234567890123456789012 \ --image-set-id 53d5fdb05ca4d46ac7ca64b06545c66e \ --latest-version-id 3 \ --cli-binary-format raw-in-base64-out \ --update-image-set-metadata-updates '{"revertToVersionId": "1"}' ``` Resultado: ``` { "datastoreId": "12345678901234567890123456789012", "imageSetId": "53d5fdb05ca4d46ac7ca64b06545c66e", "latestVersionId": "4", "imageSetState": "LOCKED", "imageSetWorkflowStatus": "UPDATING", "createdAt": 1680027126.436, "updatedAt": 1680042257.908 } ``` **Exemplo 5: adicionar um elemento de dados DICOM privado a uma instância** O exemplo `update-image-set-metadata` a seguir mostra como adicionar um elemento privado a uma instância especificada em um conjunto de imagens. O padrão DICOM permite elementos de dados privados para comunicação de informações que não podem estar contidas em elementos de dados padrão. É possível criar, editar e excluir elementos de dados privados com a ação UpdateImageSetMetadata. ``` aws medical-imaging update-image-set-metadata \ --datastore-id 12345678901234567890123456789012 \ --image-set-id 53d5fdb05ca4d46ac7ca64b06545c66e \ --latest-version-id 1 \ --cli-binary-format raw-in-base64-out \ --force \ --update-image-set-metadata-updates file://metadata-updates.json ``` Conteúdo de `metadata-updates.json` ``` { "DICOMUpdates": { "updatableAttributes": "{\"SchemaVersion\": 1.1,\"Study\": {\"Series\": {\"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1\": {\"Instances\": {\"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1\": {\"DICOM\": {\"001910F9\": \"97\"},\"DICOMVRs\": {\"001910F9\": \"DS\"}}}}}}}" } } ``` Resultado: ``` { "latestVersionId": "2", "imageSetWorkflowStatus": "UPDATING", "updatedAt": 1680042257.908, "imageSetId": "53d5fdb05ca4d46ac7ca64b06545c66e", "imageSetState": "LOCKED", "createdAt": 1680027126.436, "datastoreId": "12345678901234567890123456789012" } ``` **Exemplo 6: atualizar um elemento de dados DICOM privado a uma instância** O exemplo `update-image-set-metadata` a seguir mostra como atualizar o valor de um elemento privado que pertence a uma instância em um conjunto de imagens. ``` aws medical-imaging update-image-set-metadata \ --datastore-id 12345678901234567890123456789012 \ --image-set-id 53d5fdb05ca4d46ac7ca64b06545c66e \ --latest-version-id 1 \ --cli-binary-format raw-in-base64-out \ --force \ --update-image-set-metadata-updates file://metadata-updates.json ``` Conteúdo de `metadata-updates.json` ``` { "DICOMUpdates": { "updatableAttributes": "{\"SchemaVersion\": 1.1,\"Study\": {\"Series\": {\"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1\": {\"Instances\": {\"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1\": {\"DICOM\": {\"00091001\": \"GE_GENESIS_DD\"}}}}}}}" } } ``` Resultado: ``` { "latestVersionId": "2", "imageSetWorkflowStatus": "UPDATING", "updatedAt": 1680042257.908, "imageSetId": "53d5fdb05ca4d46ac7ca64b06545c66e", "imageSetState": "LOCKED", "createdAt": 1680027126.436, "datastoreId": "12345678901234567890123456789012" } ``` **Exemplo 7: atualizar um SOPInstanceUID com o parâmetro force** O exemplo `update-image-set-metadata` a seguir mostra como atualizar um SOPInstanceUID usando o parâmetro force para substituir as restrições de metadados DICOM. ``` aws medical-imaging update-image-set-metadata \ --datastore-id 12345678901234567890123456789012 \ --image-set-id 53d5fdb05ca4d46ac7ca64b06545c66e \ --latest-version-id 1 \ --cli-binary-format raw-in-base64-out \ --force \ --update-image-set-metadata-updates file://metadata-updates.json ``` Conteúdo de `metadata-updates.json` ``` { "DICOMUpdates": { "updatableAttributes": "{\"SchemaVersion\":1.1,\"Study\":{\"Series\":{\"1.3.6.1.4.1.5962.99.1.3633258862.2104868982.1369432891697.3656.0\":{\"Instances\":{\"1.3.6.1.4.1.5962.99.1.3633258862.2104868982.1369432891697.3659.0\":{\"DICOM\":{\"SOPInstanceUID\":\"1.3.6.1.4.1.5962.99.1.3633258862.2104868982.1369432891697.3659.9\"}}}}}}}" } } ``` Resultado: ``` { "latestVersionId": "2", "imageSetWorkflowStatus": "UPDATING", "updatedAt": 1680042257.908, "imageSetId": "53d5fdb05ca4d46ac7ca64b06545c66e", "imageSetState": "LOCKED", "createdAt": 1680027126.436, "datastoreId": "12345678901234567890123456789012" } ``` Para obter mais informações, consulte [Atualizar os metadados de um conjunto de imagens](https://docs.aws.amazon.com/healthimaging/latest/devguide/update-image-set-metadata.html) no *Guia do desenvolvedor do AWS HealthImaging*. + Para obter detalhes sobre a API, consulte [UpdateImageSetMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/update-image-set-metadata.html) na *AWS CLI Command Reference*. # Exemplos de HealthLake usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o HealthLake. *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 ### `create-fhir-datastore` O código de exemplo a seguir mostra como usar `create-fhir-datastore`. **AWS CLI** **Exemplo 1: criar um datastore no HealthLake habilitado para SigV4** O exemplo de `create-fhir-datastore` a seguir demonstra como criar um datastore no AWS HealthLake. ``` aws healthlake create-fhir-datastore \ --datastore-type-version R4 \ --datastore-name "FhirTestDatastore" ``` Resultado: ``` { "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/(Data store ID)/r4/", "DatastoreArn": "arn:aws:healthlake:us-east-1:(AWS Account ID):datastore/(Data store ID)", "DatastoreStatus": "CREATING", "DatastoreId": "(Data store ID)" } ``` **Exemplo 2: criar um datastore no HealthLake habilitado para SMART on FHIR** O exemplo de `create-fhir-datastore` a seguir demonstra como criar um datastore habilitado para SMART on FHIR no AWS HealthLake. ``` aws healthlake create-fhir-datastore \ --datastore-name "your-data-store-name" \ --datastore-type-version R4 \ --preload-data-config PreloadDataType="SYNTHEA" \ --sse-configuration '{ "KmsEncryptionConfig": { "CmkType": "CUSTOMER_MANAGED_KMS_KEY", "KmsKeyId": "arn:aws:kms:us-east-1:your-account-id:key/your-key-id" } }' \ --identity-provider-configuration file://identity_provider_configuration.json ``` Conteúdo de `identity_provider_configuration.json`: ``` { "AuthorizationStrategy": "SMART_ON_FHIR_V1", "FineGrainedAuthorizationEnabled": true, "IdpLambdaArn": "arn:aws:lambda:your-region:your-account-id:function:your-lambda-name", "Metadata": "{\"issuer\":\"https://ehr.example.com\", \"jwks_uri\":\"https://ehr.example.com/.well-known/jwks.json\",\"authorization_endpoint\":\"https://ehr.example.com/auth/authorize\",\"token_endpoint\":\"https://ehr.token.com/auth/token\",\"token_endpoint_auth_methods_supported\":[\"client_secret_basic\",\"foo\"],\"grant_types_supported\":[\"client_credential\",\"foo\"],\"registration_endpoint\":\"https://ehr.example.com/auth/register\",\"scopes_supported\":[\"openId\",\"profile\",\"launch\"],\"response_types_supported\":[\"code\"],\"management_endpoint\":\"https://ehr.example.com/user/manage\",\"introspection_endpoint\":\"https://ehr.example.com/user/introspect\",\"revocation_endpoint\":\"https://ehr.example.com/user/revoke\",\"code_challenge_methods_supported\":[\"S256\"],\"capabilities\":[\"launch-ehr\",\"sso-openid-connect\",\"client-public\"]}" } ``` Resultado: ``` { "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/(Data store ID)/r4/", "DatastoreArn": "arn:aws:healthlake:us-east-1:(AWS Account ID):datastore/(Data store ID)", "DatastoreStatus": "CREATING", "DatastoreId": "(Data store ID)" } ``` Consulte mais informações em [Creating and monitoring a FHIR data store](https://docs.aws.amazon.com/healthlake/latest/devguide/working-with-FHIR-healthlake.html) no *Guia do desenvolvedor do AWS HealthLake*. + Consulte detalhes da API em [CreateFHIRDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/create-fhir-datastore.html) na *Referência de comandos da AWS CLI*. ### `delete-fhir-datastore` O código de exemplo a seguir mostra como usar `delete-fhir-datastore`. **AWS CLI** **Como excluir um datastore FHIR** O exemplo de `delete-fhir-datastore` a seguir demonstra como excluir um datastore e todo o seu conteúdo no AWS HealthLake. ``` aws healthlake delete-fhir-datastore \ --datastore-id (Data store ID) ``` Resultado: ``` { "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/(Data store ID)/r4/", "DatastoreArn": "arn:aws:healthlake:us-east-1:(AWS Account ID):datastore/(Data store ID)", "DatastoreStatus": "DELETING", "DatastoreId": "(Data store ID)" } ``` Consulte mais informações em Creating and monitoring a FHIR data store no *Guia do desenvolvedor do AWS HealthLake*. + Consulte detalhes da API em [DeleteFHIRDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/delete-fhir-datastore.html) na *Referência de comandos da AWS CLI*. ### `describe-fhir-datastore` O código de exemplo a seguir mostra como usar `describe-fhir-datastore`. **AWS CLI** **Como descrever um datastore FHIR** O exemplo de `describe-fhir-datastore` a seguir demonstra como encontrar as propriedades de um datastore no AWS HealthLake. ``` aws healthlake describe-fhir-datastore \ --datastore-id "1f2f459836ac6c513ce899f9e4f66a59" ``` Resultado: ``` { "DatastoreProperties": { "PreloadDataConfig": { "PreloadDataType": "SYNTHEA" }, "SseConfiguration": { "KmsEncryptionConfig": { "CmkType": "CUSTOMER_MANAGED_KMS_KEY", "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } }, "DatastoreName": "Demo", "DatastoreArn": "arn:aws:healthlake:us-east-1::datastore/", "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore//r4/", "DatastoreStatus": "ACTIVE", "DatastoreTypeVersion": "R4", "CreatedAt": 1603761064.881, "DatastoreId": "", "IdentityProviderConfiguration": { "AuthorizationStrategy": "AWS_AUTH", "FineGrainedAuthorizationEnabled": false } } } ``` Consulte mais informações em [Creating and monitoring a FHIR data stores](https://docs.aws.amazon.com/healthlake/latest/devguide/working-with-FHIR-healthlake.html) no *Guia do desenvolvedor do AWS HealthLake*. + Consulte detalhes da API em [DescribeFHIRDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/describe-fhir-datastore.html) na *Referência de comandos da AWS CLI*. ### `describe-fhir-export-job` O código de exemplo a seguir mostra como usar `describe-fhir-export-job`. **AWS CLI** **Descrever um serviço de exportação do FHIR** O exemplo de `describe-fhir-export-job` a seguir mostra como encontrar as propriedades de um trabalho de exportação FHIR no AWS HealthLake. ``` aws healthlake describe-fhir-export-job \ --datastore-id (Data store ID) \ --job-id 9b9a51943afaedd0a8c0c26c49135a31 ``` Resultado: ``` { "ExportJobProperties": { "DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)", "JobStatus": "IN_PROGRESS", "JobId": "9009813e9d69ba7cf79bcb3468780f16", "SubmitTime": "2024-11-20T11:31:46.672000-05:00", "EndTime": "2024-11-20T11:34:01.636000-05:00", "OutputDataConfig": { "S3Configuration": { "S3Uri": "s3://(Bucket Name)/(Prefix Name)/", "KmsKeyId": "arn:aws:kms:us-east-1:012345678910:key/d330e7fc-b56c-4216-a250-f4c43ef46e83" } }, "DatastoreId": "(Data store ID)" } } ``` Consulte mais informações em [Exporting files from a FHIR data store](https://docs.aws.amazon.com/healthlake/latest/devguide/export-datastore.html) no *Guia do desenvolvedor do AWS HealthLake*. + Consulte detalhes da API em [DescribeFHIRExportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/describe-fhir-export-job.html) na *Referência de comandos da AWS CLI*. ### `describe-fhir-import-job` O código de exemplo a seguir mostra como usar `describe-fhir-import-job`. **AWS CLI** **Descrever um serviço de importação do FHIR** O exemplo de `describe-fhir-import-job` a seguir mostra como conhecer as propriedades de um trabalho de importação do FHIR usando o AWS HealthLake. ``` aws healthlake describe-fhir-import-job \ --datastore-id (Data store ID) \ --job-id c145fbb27b192af392f8ce6e7838e34f ``` Resultado: ``` { "ImportJobProperties": { "InputDataConfig": { "S3Uri": "s3://(Bucket Name)/(Prefix Name)/" { "arrayitem2": 2 } }, "DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)", "JobStatus": "COMPLETED", "JobId": "c145fbb27b192af392f8ce6e7838e34f", "SubmitTime": 1606272542.161, "EndTime": 1606272609.497, "DatastoreId": "(Data store ID)" } } ``` Consulte mais informações em [Importing files to a FHIR data store](https://docs.aws.amazon.com/healthlake/latest/devguide/import-datastore.html) no *Guia do desenvolvedor do AWS HealthLake*. + Consulte detalhes da API em [DescribeFHIRImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/describe-fhir-import-job.html) na *Referência de comandos da AWS CLI*. ### `list-fhir-datastores` O código de exemplo a seguir mostra como usar `list-fhir-datastores`. **AWS CLI** **Como listar datastores FHIR** O exemplo de `list-fhir-datastores` a seguir mostra como usar o comando e como os usuários podem filtrar os resultados com base no status do datastore no AWS HealthLake. ``` aws healthlake list-fhir-datastores \ --filter DatastoreStatus=ACTIVE ``` Resultado: ``` { "DatastorePropertiesList": [ { "PreloadDataConfig": { "PreloadDataType": "SYNTHEA" }, "SseConfiguration": { "KmsEncryptionConfig": { "CmkType": "CUSTOMER_MANAGED_KMS_KEY", "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } }, "DatastoreName": "Demo", "DatastoreArn": "arn:aws:healthlake:us-east-1::datastore/", "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore//r4/", "DatastoreStatus": "ACTIVE", "DatastoreTypeVersion": "R4", "CreatedAt": 1603761064.881, "DatastoreId": "", "IdentityProviderConfiguration": { "AuthorizationStrategy": "AWS_AUTH", "FineGrainedAuthorizationEnabled": false } } ] } ``` Consulte mais informações em [Creating and monitoring a FHIR data store](https://docs.aws.amazon.com/healthlake/latest/devguide/working-with-FHIR-healthlake.html) no *Guia do desenvolvedor do AWS HealthLake*. + Consulte detalhes da API em [ListFHIRDatastores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/list-fhir-datastores.html) na *Referência de comandos da AWS CLI*. ### `list-fhir-export-jobs` O código de exemplo a seguir mostra como usar `list-fhir-export-jobs`. **AWS CLI** **Listar todos os serviços de exportação do FHIR** O exemplo `list-fhir-export-jobs` a seguir mostra como usar o comando para exibir uma lista de serviços de exportação associados a uma conta. ``` aws healthlake list-fhir-export-jobs \ --datastore-id (Data store ID) \ --submitted-before (DATE like 2024-10-13T19:00:00Z)\ --submitted-after (DATE like 2020-10-13T19:00:00Z )\ --job-name "FHIR-EXPORT" \ --job-status SUBMITTED \ --max-results (Integer between 1 and 500) ``` Resultado: ``` { "ExportJobPropertiesList": [ { "ExportJobProperties": { "OutputDataConfig": { "S3Uri": "s3://(Bucket Name)/(Prefix Name)/", "S3Configuration": { "S3Uri": "s3://(Bucket Name)/(Prefix Name)/", "KmsKeyId": "(KmsKey Id)" } }, "DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)", "JobStatus": "COMPLETED", "JobId": "c145fbb27b192af392f8ce6e7838e34f", "JobName": "FHIR-EXPORT", "SubmitTime": "2024-11-20T11:31:46.672000-05:00", "EndTime": "2024-11-20T11:34:01.636000-05:00", "DatastoreId": "(Data store ID)" } } ] } ``` Consulte mais informações em [Exporting files from a FHIR data store](https://docs.aws.amazon.com/healthlake/latest/devguide/export-datastore.html) no Guia do desenvolvedor do AWS HealthLake. + Consulte detalhes da API em [ListFHIRExportJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/list-fhir-export-jobs.html) na *Referência de comandos da AWS CLI*. ### `list-fhir-import-jobs` O código de exemplo a seguir mostra como usar `list-fhir-import-jobs`. **AWS CLI** **Listar todos os serviços de importação do FHIR** O exemplo `list-fhir-import-jobs` a seguir mostra como usar o comando para visualizar uma lista de todos os serviços de importação associados a uma conta. ``` aws healthlake list-fhir-import-jobs \ --datastore-id (Data store ID) \ --submitted-before (DATE like 2024-10-13T19:00:00Z) \ --submitted-after (DATE like 2020-10-13T19:00:00Z ) \ --job-name "FHIR-IMPORT" \ --job-status SUBMITTED \ -max-results (Integer between 1 and 500) ``` Resultado: ``` { "ImportJobPropertiesList": [ { "JobId": "c0fddbf76f238297632d4aebdbfc9ddf", "JobStatus": "COMPLETED", "SubmitTime": "2024-11-20T10:08:46.813000-05:00", "EndTime": "2024-11-20T10:10:09.093000-05:00", "DatastoreId": "(Data store ID)", "InputDataConfig": { "S3Uri": "s3://(Bucket Name)/(Prefix Name)/" }, "JobOutputDataConfig": { "S3Configuration": { "S3Uri": "s3://(Bucket Name)/import/6407b9ae4c2def3cb6f1a46a0c599ec0-FHIR_IMPORT-c0fddbf76f238297632d4aebdbfc9ddf/", "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/b7f645cb-e564-4981-8672-9e012d1ff1a0" } }, "JobProgressReport": { "TotalNumberOfScannedFiles": 1, "TotalSizeOfScannedFilesInMB": 0.001798, "TotalNumberOfImportedFiles": 1, "TotalNumberOfResourcesScanned": 1, "TotalNumberOfResourcesImported": 1, "TotalNumberOfResourcesWithCustomerError": 0, "TotalNumberOfFilesReadWithCustomerError": 0, "Throughput": 0.0 }, "DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)" } ] } ``` Consulte mais informações em [Importing files to FHIR data store](https://docs.aws.amazon.com/healthlake/latest/devguide/import-examples.html) no Guia do desenvolvedor do AWS HealthLake. + Consulte detalhes da API em [ListFHIRImportJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/list-fhir-import-jobs.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Como listar tags para um datastore** O exemplo de `list-tags-for-resource` a seguir lista as tags associadas ao datastore especificado. ``` aws healthlake list-tags-for-resource \ --resource-arn "arn:aws:healthlake:us-east-1:123456789012:datastore/fhir/0725c83f4307f263e16fd56b6d8ebdbe" ``` Resultado: ``` { "tags": { "key": "value", "key1": "value1" } } ``` Consulte mais informações em [Tagging resources in AWS HealthLake](https://docs.aws.amazon.com/healthlake/latest/devguide/tagging.html) no Guia do desenvolvedor do AWS HealthLake. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `start-fhir-export-job` O código de exemplo a seguir mostra como usar `start-fhir-export-job`. **AWS CLI** **Iniciar um serviço de exportação do FHIR** O exemplo de `start-fhir-export-job` a seguir mostra como iniciar um trabalho de exportação FHIR usando o AWS HealthLake. ``` aws healthlake start-fhir-export-job \ --output-data-config '{"S3Configuration": {"S3Uri":"s3://(Bucket Name)/(Prefix Name)/","KmsKeyId":"arn:aws:kms:us-east-1:012345678910:key/d330e7fc-b56c-4216-a250-f4c43ef46e83"}}' \ --datastore-id (Data store ID) \ --data-access-role-arn arn:aws:iam::(AWS Account ID):role/(Role Name) ``` Resultado: ``` { "DatastoreId": "(Data store ID)", "JobStatus": "SUBMITTED", "JobId": "9b9a51943afaedd0a8c0c26c49135a31" } ``` Consulte mais informações em [Exporting files from a FHIR data store](https://docs.aws.amazon.com/healthlake/latest/devguide/export-datastore.html) no *Guia do desenvolvedor do AWS HealthLake*. + Consulte detalhes da API em [StartFHIRExportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/start-fhir-export-job.html) na *Referência de comandos da AWS CLI*. ### `start-fhir-import-job` O código de exemplo a seguir mostra como usar `start-fhir-import-job`. **AWS CLI** **Iniciar um trabalho de importação do FHIR** O exemplo de `start-fhir-import-job` a seguir mostra como iniciar um trabalho de importação FHIR usando o AWS HealthLake. ``` aws healthlake start-fhir-import-job \ --input-data-config S3Uri="s3://(Bucket Name)/(Prefix Name)/" \ --job-output-data-config '{"S3Configuration": {"S3Uri":"s3://(Bucket Name)/(Prefix Name)/","KmsKeyId":"arn:aws:kms:us-east-1:012345678910:key/d330e7fc-b56c-4216-a250-f4c43ef46e83"}}' \ --datastore-id (Data store ID) \ --data-access-role-arn "arn:aws:iam::(AWS Account ID):role/(Role Name)" ``` Resultado: ``` { "DatastoreId": "(Data store ID)", "JobStatus": "SUBMITTED", "JobId": "c145fbb27b192af392f8ce6e7838e34f" } ``` Consulte mais informações em [Importing files to a FHIR data store](https://docs.aws.amazon.com/healthlake/latest/devguide/import-datastore.html) no *Guia do desenvolvedor do AWS HealthLake*. + Consulte detalhes da API em [StartFHIRImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/start-fhir-import-job.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como adicionar uma tag ao datastore** O exemplo de `tag-resource` a seguir mostra como adicionar uma tag a um datastore. ``` aws healthlake tag-resource \ --resource-arn "arn:aws:healthlake:us-east-1:123456789012:datastore/fhir/0725c83f4307f263e16fd56b6d8ebdbe" \ --tags '[{"Key": "key1", "Value": "value1"}]' ``` Este comando não produz saída. Consulte mais informações em [Adding a tag to a data store](https://docs.aws.amazon.com/healthlake/latest/devguide/add-a-tag.html) no *Guia do desenvolvedor do AWS HealthLake*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Como remover tags de um datastore.** O exemplo de `untag-resource` a seguir mostra como remover tags de um datastore. ``` aws healthlake untag-resource \ --resource-arn "arn:aws:healthlake:us-east-1:123456789012:datastore/fhir/b91723d65c6fdeb1d26543a49d2ed1fa" \ --tag-keys '["key1"]' ``` Este comando não produz saída. Consulte mais informações em [Removing tags from a data store](https://docs.aws.amazon.com/healthlake/latest/devguide/remove-tags.html) no *Guia do desenvolvedor do AWS HealthLake*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/untag-resource.html) na *Referência de comandos da AWS CLI*. # Exemplos de HealthOmics usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o HealthOmics. *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 ### `abort-multipart-read-set-upload` O código de exemplo a seguir mostra como usar `abort-multipart-read-set-upload`. **AWS CLI** **Como interromper um upload de conjunto de leitura multipartes** O exemplo `abort-multipart-read-set-upload` a seguir interrompe o upload de um conjunto de leitura multipartes em seu repositório de sequências HealthOmics. ``` aws omics abort-multipart-read-set-upload \ --sequence-store-id 0123456789 \ --upload-id 1122334455 ``` Este comando não produz saída. Para obter mais informações, consulte [Fazer upload direto a um repositório de sequências](https://docs.aws.amazon.com/omics/latest/dev/synchronous-uploads.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [AbortMultipartReadSetUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/abort-multipart-read-set-upload.html) na *Referência de comandos da AWS CLI*. ### `accept-share` O código de exemplo a seguir mostra como usar `accept-share`. **AWS CLI** **Como aceitar um compartilhamento de dados de um repositório de análises** O exemplo `accept-share` a seguir aceita um compartilhamento de dados de repositório de análises do HealthOmics. ``` aws omics accept-share \ ----share-id "495c21bedc889d07d0ab69d710a6841e-dd75ab7a1a9c384fa848b5bd8e5a7e0a" ``` Resultado: ``` { "status": "ACTIVATING" } ``` Para obter mais informações, consulte [Compartilhamento entre contas](https://docs.aws.amazon.com/omics/latest/dev/cross-account-sharing.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [AcceptShare](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/accept-share.html) na *Referência de comandos da AWS CLI*. ### `batch-delete-read-set` O código de exemplo a seguir mostra como usar `batch-delete-read-set`. **AWS CLI** **Para excluir vários conjuntos de leitura** O exemplo `batch-delete-read-set` a seguir exclui dois conjuntos de leitura. ``` aws omics batch-delete-read-set \ --sequence-store-id 1234567890 \ --ids 1234567890 0123456789 ``` Se houver um erro ao excluir qualquer um dos conjuntos de leitura especificados, o serviço retornará uma lista de erros. ``` { "errors": [ { "code": "", "id": "0123456789", "message": "The specified readset does not exist." } ] } ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [BatchDeleteReadSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/batch-delete-read-set.html) na *Referência de comandos da AWS CLI*. ### `cancel-annotation-import-job` O código de exemplo a seguir mostra como usar `cancel-annotation-import-job`. **AWS CLI** **Como cancelar um trabalho de importação de anotações** O exemplo `cancel-annotation-import-job` a seguir cancela um trabalho de importação de anotações com ID `04f57618-xmpl-4fd0-9349-e5a85aefb997`. ``` aws omics cancel-annotation-import-job \ --job-id 04f57618-xmpl-4fd0-9349-e5a85aefb997 ``` Para obter mais informações, consulte [Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [CancelAnnotationImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/cancel-annotation-import-job.html) na *Referência de comandos da AWS CLI*. ### `cancel-run` O código de exemplo a seguir mostra como usar `cancel-run`. **AWS CLI** **Como cancelar uma execução** O exemplo `cancel-run` a seguir cancela uma execução que tenha o ID `1234567`. ``` aws omics cancel-run \ --id 1234567 ``` Para ter mais informações, consulte [Run lifecycle in a workflow](https://docs.aws.amazon.com/omics/latest/dev/monitoring-runs.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [CancelRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/cancel-run.html) na *Referência de comandos da AWS CLI*. ### `cancel-variant-import-job` O código de exemplo a seguir mostra como usar `cancel-variant-import-job`. **AWS CLI** **Como cancelar um trabalho de importação de variantes** O exemplo `cancel-variant-import-job` a seguir cancela um trabalho de importação de variantes com o ID `69cb65d6-xmpl-4a4a-9025-4565794b684e`. ``` aws omics cancel-variant-import-job \ --job-id 69cb65d6-xmpl-4a4a-9025-4565794b684e ``` Para obter mais informações, consulte [Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [CancelVariantImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/cancel-variant-import-job.html) na *Referência de comandos da AWS CLI*. ### `complete-multipart-read-set-upload` O código de exemplo a seguir mostra como usar `complete-multipart-read-set-upload`. **AWS CLI** **Como concluir um upload multipartes depois de fazer upload de todos os componentes.** O exemplo `complete-multipart-read-set-upload` a seguir conclui um upload multipartes em um repositório de sequências depois do upload de todos os componentes. ``` aws omics complete-multipart-read-set-upload \ --sequence-store-id 0123456789 \ --upload-id 1122334455 \ --parts '[{"checksum":"gaCBQMe+rpCFZxLpoP6gydBoXaKKDA/Vobh5zBDb4W4=","partNumber":1,"partSource":"SOURCE1"}]' ``` Resultado: ``` { "readSetId": "0000000001" "readSetId": "0000000002" "readSetId": "0000000003" } ``` Para obter mais informações, consulte [Fazer upload direto a um repositório de sequências](https://docs.aws.amazon.com/omics/latest/dev/synchronous-uploads.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [CompleteMultipartReadSetUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/complete-multipart-read-set-upload.html) na *Referência de comandos da AWS CLI*. ### `create-annotation-store-version` O código de exemplo a seguir mostra como usar `create-annotation-store-version`. **AWS CLI** **Para criar uma nova versão de um repositório de anotações** O exemplo `create-annotation-store-version` a seguir cria uma nova versão de um repositório de anotações. ``` aws omics create-annotation-store-version \ --name my_annotation_store \ --version-name my_version ``` Resultado: ``` { "creationTime": "2023-07-21T17:15:49.251040+00:00", "id": "3b93cdef69d2", "name": "my_annotation_store", "reference": { "referenceArn": "arn:aws:omics:us-west-2:555555555555:referenceStore/6505293348/reference/5987565360" }, "status": "CREATING", "versionName": "my_version" } ``` Para obter mais informações, consulte [Criar de novas versões de repositórios de anotações](https://docs.aws.amazon.com/omics/latest/dev/annotation-store-versioning.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [CreateAnnotationStoreVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/create-annotation-store-version.html) na *Referência de comandos da AWS CLI*. ### `create-annotation-store` O código de exemplo a seguir mostra como usar `create-annotation-store`. **AWS CLI** **Exemplo 1: criar um repositório de anotações VCF** O exemplo `create-annotation-store` a seguir cria um repositório de anotações no formato VCF. ``` aws omics create-annotation-store \ --name my_ann_store \ --store-format VCF \ --reference referenceArn=arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890 ``` Resultado: ``` { "creationTime": "2022-11-23T22:48:39.226492Z", "id": "0a91xmplc71f", "name": "my_ann_store", "reference": { "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890" }, "status": "CREATING", "storeFormat": "VCF" } ``` **Exemplo 2: criar um repositório de anotações TSV** O exemplo `create-annotation-store` a seguir cria um repositório de anotações no formato TSV. ``` aws omics create-annotation-store \ --name tsv_ann_store \ --store-format TSV \ --reference referenceArn=arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890 \ --store-options file://tsv-store-options.json ``` `tsv-store-options.json` configura as opções de formato para anotações. ``` { "tsvStoreOptions": { "annotationType": "CHR_START_END_ZERO_BASE", "formatToHeader": { "CHR": "chromosome", "START": "start", "END": "end" }, "schema": [ { "chromosome": "STRING" }, { "start": "LONG" }, { "end": "LONG" }, { "name": "STRING" } ] } } ``` Resultado: ``` { "creationTime": "2022-11-30T01:28:08.525586Z", "id": "861cxmpl96b0", "name": "tsv_ann_store", "reference": { "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890" }, "status": "CREATING", "storeFormat": "TSV", "storeOptions": { "tsvStoreOptions": { "annotationType": "CHR_START_END_ZERO_BASE", "formatToHeader": { "CHR": "chromosome", "END": "end", "START": "start" }, "schema": [ { "chromosome": "STRING" }, { "start": "LONG" }, { "end": "LONG" }, { "name": "STRING" } ] } } } ``` Para obter mais informações, consulte [Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html) no Guia do desenvolvedor do Amazon Omics. + Para ver detalhes da API, consulte [CreateAnnotationStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/create-annotation-store.html) na *Referência de comandos da AWS CLI*. ### `create-multipart-read-set-upload` O código de exemplo a seguir mostra como usar `create-multipart-read-set-upload`. **AWS CLI** **Para iniciar um upload de um conjunto de leitura multipartes.** O exemplo `create-multipart-read-set-upload` a seguir inicia um upload de conjunto de leitura multipartes. ``` aws omics create-multipart-read-set-upload \ --sequence-store-id 0123456789 \ --name HG00146 \ --source-file-type FASTQ \ --subject-id mySubject\ --sample-id mySample\ --description "FASTQ for HG00146"\ --generated-from "1000 Genomes" ``` Resultado: ``` { "creationTime": "2022-07-13T23:25:20Z", "description": "FASTQ for HG00146", "generatedFrom": "1000 Genomes", "name": "HG00146", "sampleId": "mySample", "sequenceStoreId": "0123456789", "sourceFileType": "FASTQ", "subjectId": "mySubject", "uploadId": "1122334455" } ``` Para obter mais informações, consulte [Fazer upload direto a um repositório de sequências](https://docs.aws.amazon.com/omics/latest/dev/synchronous-uploads.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [CreateMultipartReadSetUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/create-multipart-read-set-upload.html) na *Referência de comandos da AWS CLI*. ### `create-reference-store` O código de exemplo a seguir mostra como usar `create-reference-store`. **AWS CLI** **Para criar um repositório de referências** O exemplo `create-reference-store` a seguir cria o repositório de referências `my-ref-store`. ``` aws omics create-reference-store \ --name my-ref-store ``` Resultado: ``` { "arn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890", "creationTime": "2022-11-22T22:13:25.947Z", "id": "1234567890", "name": "my-ref-store" } ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [CreateReferenceStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/create-reference-store.html) na *Referência de comandos da AWS CLI*. ### `create-run-group` O código de exemplo a seguir mostra como usar `create-run-group`. **AWS CLI** **Para criar um grupo de execução** O exemplo `create-run-group` a seguir cria um grupo de execução chamado `cram-converter`. ``` aws omics create-run-group \ --name cram-converter \ --max-cpus 20 \ --max-gpus 10 \ --max-duration 600 \ --max-runs 5 ``` Resultado: ``` { "arn": "arn:aws:omics:us-west-2:123456789012:runGroup/1234567", "id": "1234567", "tags": {} } ``` Para ter mais informações, consulte [Creating run groups](https://docs.aws.amazon.com/omics/latest/dev/creating-run-groups.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [CreateRunGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/create-run-group.html) na *Referência de comandos da AWS CLI*. ### `create-sequence-store` O código de exemplo a seguir mostra como usar `create-sequence-store`. **AWS CLI** **Para criar um repositório de sequências** O exemplo `create-sequence-store` a seguir cria um repositório de sequências. ``` aws omics create-sequence-store \ --name my-seq-store ``` Resultado: ``` { "arn": "arn:aws:omics:us-west-2:123456789012:sequenceStore/1234567890", "creationTime": "2022-11-23T01:24:33.629Z", "id": "1234567890", "name": "my-seq-store" } ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [CreateSequenceStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/create-sequence-store.html) na *Referência de comandos da AWS CLI*. ### `create-share` O código de exemplo a seguir mostra como usar `create-share`. **AWS CLI** **Para criar um compartilhamento de um repositório de análises da HealthOmics** O exemplo `create-share` a seguir mostra como criar um compartilhamento de um repositório de análises da HealthOmics que pode ser aceito por um assinante fora da conta. ``` aws omics create-share \ --resource-arn "arn:aws:omics:us-west-2:555555555555:variantStore/omics_dev_var_store" \ --principal-subscriber "123456789012" \ --name "my_Share-123" ``` Resultado: ``` { "shareId": "495c21bedc889d07d0ab69d710a6841e-dd75ab7a1a9c384fa848b5bd8e5a7e0a", "name": "my_Share-123", "status": "PENDING" } ``` Para obter mais informações, consulte [Compartilhamento entre contas](https://docs.aws.amazon.com/omics/latest/dev/cross-account-sharing.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [CreateShare](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/create-share.html) na *Referência de comandos da AWS CLI*. ### `create-variant-store` O código de exemplo a seguir mostra como usar `create-variant-store`. **AWS CLI** **Para criar um repositório de variantes** O exemplo `create-variant-store` a seguir cria um repositório de variantes chamado `my_var_store`. ``` aws omics create-variant-store \ --name my_var_store \ --reference referenceArn=arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890 ``` Resultado: ``` { "creationTime": "2022-11-23T22:09:07.534499Z", "id": "02dexmplcfdd", "name": "my_var_store", "reference": { "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890" }, "status": "CREATING" } ``` Para obter mais informações, consulte [Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [CreateVariantStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/create-variant-store.html) na *Referência de comandos da AWS CLI*. ### `create-workflow` O código de exemplo a seguir mostra como usar `create-workflow`. **AWS CLI** **Para criar um fluxo de trabalho** O exemplo `create-workflow` a seguir cria um fluxo de trabalho WDL. ``` aws omics create-workflow \ --name cram-converter \ --engine WDL \ --definition-zip fileb://workflow-crambam.zip \ --parameter-template file://workflow-params.json ``` `workflow-crambam.zip` é um arquivo ZIP contendo uma definição de fluxo de trabalho. `workflow-params.json` define parâmetros de runtime para o fluxo de trabalho. ``` { "ref_fasta" : { "description": "Reference genome fasta file", "optional": false }, "ref_fasta_index" : { "description": "Index of the reference genome fasta file", "optional": false }, "ref_dict" : { "description": "dictionary file for 'ref_fasta'", "optional": false }, "input_cram" : { "description": "The Cram file to convert to BAM", "optional": false }, "sample_name" : { "description": "The name of the input sample, used to name the output BAM", "optional": false } } ``` Resultado: ``` { "arn": "arn:aws:omics:us-west-2:123456789012:workflow/1234567", "id": "1234567", "status": "CREATING", "tags": {} } ``` Para ter mais informações, consulte [Creating private workflows](https://docs.aws.amazon.com/omics/latest/dev/workflows-setup.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [CreateWorkflow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/create-workflow.html) na *Referência de comandos da AWS CLI*. ### `delete-annotation-store-versions` O código de exemplo a seguir mostra como usar `delete-annotation-store-versions`. **AWS CLI** **Para excluir uma versão do repositório de anotações** O exemplo `delete-annotation-store-versions` a seguir exclui uma versão do repositório de anotações. ``` aws omics delete-annotation-store-versions \ --name my_annotation_store \ --versions my_version ``` Resultado: ``` { "errors": [] } ``` Para obter mais informações, consulte [Criar de novas versões de repositórios de anotações](https://docs.aws.amazon.com/omics/latest/dev/annotation-store-versioning.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [DeleteAnnotationStoreVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/delete-annotation-store-versions.html) na *Referência de comandos da AWS CLI*. ### `delete-annotation-store` O código de exemplo a seguir mostra como usar `delete-annotation-store`. **AWS CLI** **Para excluir um repositório de anotações** O exemplo `delete-annotation-store` a seguir exclui o repositório de anotações chamado `my_vcf_store`. ``` aws omics delete-annotation-store \ --name my_vcf_store ``` Resultado: ``` { "status": "DELETING" } ``` Para obter mais informações, consulte [Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [DeleteAnnotationStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/delete-annotation-store.html) na *Referência de comandos da AWS CLI*. ### `delete-reference-store` O código de exemplo a seguir mostra como usar `delete-reference-store`. **AWS CLI** **Para excluir um repositório de referências** O exemplo `delete-reference-store` a seguir exclui o repositório de referências com o ID `1234567890`. ``` aws omics delete-reference-store \ --id 1234567890 ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [DeleteReferenceStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/delete-reference-store.html) na *Referência de comandos da AWS CLI*. ### `delete-reference` O código de exemplo a seguir mostra como usar `delete-reference`. **AWS CLI** **Para excluir uma referência** O exemplo `delete-reference` a seguir exclui uma referência. ``` aws omics delete-reference \ --reference-store-id 1234567890 \ --id 1234567890 ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [DeleteReference](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/delete-reference.html) na *Referência de comandos da AWS CLI*. ### `delete-run-group` O código de exemplo a seguir mostra como usar `delete-run-group`. **AWS CLI** **Para excluir um grupo de execução** O exemplo `delete-run-group` a seguir exclui o grupo de execução com o ID `1234567`. ``` aws omics delete-run-group \ --id 1234567 ``` Para ter mais informações, consulte [Deleting runs and run groups](https://docs.aws.amazon.com/omics/latest/dev/deleting-workflows-and-runs.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [DeleteRunGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/delete-run-group.html) na *Referência de comandos da AWS CLI*. ### `delete-run` O código de exemplo a seguir mostra como usar `delete-run`. **AWS CLI** **Para excluir uma execução de fluxo de trabalho** O exemplo `delete-run` a seguir exclui a execução com o ID `1234567`. ``` aws omics delete-run \ --id 1234567 ``` Para ter mais informações, consulte [Deleting runs and run groups](https://docs.aws.amazon.com/omics/latest/dev/deleting-workflows-and-runs.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [DeleteRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/delete-run.html) na *Referência de comandos da AWS CLI*. ### `delete-sequence-store` O código de exemplo a seguir mostra como usar `delete-sequence-store`. **AWS CLI** **Para excluir um repositório de sequências** O exemplo `delete-sequence-store` a seguir exclui o repositório de referências com o ID `1234567890`. ``` aws omics delete-sequence-store \ --id 1234567890 ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [DeleteSequenceStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/delete-sequence-store.html) na *Referência de comandos da AWS CLI*. ### `delete-share` O código de exemplo a seguir mostra como usar `delete-share`. **AWS CLI** **Para excluir um compartilhamento dos dados de análise do HealthOmics** O exemplo `delete-share` a seguir exclui um compartilhamento de dados de análise entre contas. ``` aws omics delete-share \ --share-id "495c21bedc889d07d0ab69d710a6841e-dd75ab7a1a9c384fa848b5bd8e5a7e0a" ``` Resultado: ``` { "status": "DELETING" } ``` Para obter mais informações, consulte [Compartilhamento entre contas](https://docs.aws.amazon.com/omics/latest/dev/cross-account-sharing.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [DeleteShare](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/delete-share.html) na *Referência de comandos da AWS CLI*. ### `delete-variant-store` O código de exemplo a seguir mostra como usar `delete-variant-store`. **AWS CLI** **Para excluir um repositório de variantes** O exemplo `delete-variant-store` a seguir exclui um repositório de variantes chamado `my_var_store`. ``` aws omics delete-variant-store \ --name my_var_store ``` Resultado: ``` { "status": "DELETING" } ``` Para obter mais informações, consulte [Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [DeleteVariantStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/delete-variant-store.html) na *Referência de comandos da AWS CLI*. ### `delete-workflow` O código de exemplo a seguir mostra como usar `delete-workflow`. **AWS CLI** **Para excluir um fluxo de trabalho** O exemplo `delete-workflow` a seguir exclui o fluxo de trabalho com o ID `1234567`. ``` aws omics delete-workflow \ --id 1234567 ``` Para ter mais informações, consulte [Delete a private workflow](https://docs.aws.amazon.com/omics/latest/dev/delete-private-workflow.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [DeleteWorkflow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/delete-workflow.html) na *Referência de comandos da AWS CLI*. ### `get-annotation-import-job` O código de exemplo a seguir mostra como usar `get-annotation-import-job`. **AWS CLI** **visualizar um trabalho de importação de anotações** O exemplo `get-annotation-import-job` a seguir obtém detalhes sobre um trabalho de importação de anotações. ``` aws omics get-annotation-import-job \ --job-id 984162c7-xmpl-4d23-ab47-286f7950bfbf ``` Resultado: ``` { "creationTime": "2022-11-30T01:40:11.017746Z", "destinationName": "tsv_ann_store", "id": "984162c7-xmpl-4d23-ab47-286f7950bfbf", "items": [ { "jobStatus": "COMPLETED", "source": "s3://omics-artifacts-01d6xmpl4e72dd32/targetedregions.bed.gz" } ], "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ", "runLeftNormalization": false, "status": "COMPLETED", "updateTime": "2022-11-30T01:42:39.134009Z" } ``` Para obter mais informações, consulte [Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [GetAnnotationImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-annotation-import-job.html) na *Referência de comandos da AWS CLI*. ### `get-annotation-store-version` O código de exemplo a seguir mostra como usar `get-annotation-store-version`. **AWS CLI** **Para recuperar os metadados de uma versão do repositório de anotações** O exemplo `get-annotation-store-version` a seguir recupera os metadados da versão solicitada do repositório de anotações. ``` aws omics get-annotation-store-version \ --name my_annotation_store \ --version-name my_version ``` Resultado: ``` { "storeId": "4934045d1c6d", "id": "2a3f4a44aa7b", "status": "ACTIVE", "versionArn": "arn:aws:omics:us-west-2:555555555555:annotationStore/my_annotation_store/version/my_version", "name": "my_annotation_store", "versionName": "my_version", "creationTime": "2023-07-21T17:15:49.251040+00:00", "updateTime": "2023-07-21T17:15:56.434223+00:00", "statusMessage": "", "versionSizeBytes": 0 } ``` Para obter mais informações, consulte [Criar de novas versões de repositórios de anotações](https://docs.aws.amazon.com/omics/latest/dev/annotation-store-versioning.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [GetAnnotationStoreVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-annotation-store-version.html) na *Referência de comandos da AWS CLI*. ### `get-annotation-store` O código de exemplo a seguir mostra como usar `get-annotation-store`. **AWS CLI** **Como visualizar um repositório de anotações** O exemplo `get-annotation-store` a seguir obtém detalhes sobre o repositório de anotações chamado `my_ann_store`. ``` aws omics get-annotation-store \ --name my_ann_store ``` Resultado: ``` { "creationTime": "2022-11-23T22:48:39.226492Z", "id": "0a91xmplc71f", "name": "my_ann_store", "reference": { "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890" }, "status": "CREATING", "storeArn": "arn:aws:omics:us-west-2:123456789012:annotationStore/my_ann_store", "storeFormat": "VCF", "storeSizeBytes": 0, "tags": {} } ``` Para obter mais informações, consulte [Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [GetAnnotationStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-annotation-store.html) na *Referência de comandos da AWS CLI*. ### `get-read-set-activation-job` O código de exemplo a seguir mostra como usar `get-read-set-activation-job`. **AWS CLI** **Como visualizar um trabalho de ativação do conjunto de leitura** O exemplo `get-read-set-activation-job` a seguir obtém detalhes sobre um trabalho de ativação do conjunto de leitura. ``` aws omics get-read-set-activation-job \ --sequence-store-id 1234567890 \ --id 1234567890 ``` Resultado: ``` { "completionTime": "2022-12-06T22:33:42.828Z", "creationTime": "2022-12-06T22:32:45.213Z", "id": "1234567890", "sequenceStoreId": "1234567890", "sources": [ { "readSetId": "1234567890", "status": "FINISHED", "statusMessage": "No activation needed as read set is already in ACTIVATING or ACTIVE state." } ], "status": "COMPLETED", "statusMessage": "The job completed successfully." } ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [GetReadSetActivationJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-read-set-activation-job.html) na *Referência de comandos da AWS CLI*. ### `get-read-set-export-job` O código de exemplo a seguir mostra como usar `get-read-set-export-job`. **AWS CLI** **Como visualizar um trabalho de exportação do conjunto de leitura** O exemplo `get-read-set-export-job` a seguir obtém detalhes sobre um trabalho de exportação do conjunto de leitura. ``` aws omics get-read-set-export-job \ --sequence-store-id 1234567890 \ --id 1234567890 ``` Resultado: ``` { "completionTime": "2022-12-06T22:39:14.491Z", "creationTime": "2022-12-06T22:37:18.612Z", "destination": "s3://omics-artifacts-01d6xmpl4e72dd32/read-set-export/", "id": "1234567890", "sequenceStoreId": "1234567890", "status": "COMPLETED", "statusMessage": "The job is submitted and will start soon." } ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para receber detalhes da API, consulte [GetReadSetExportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-read-set-export-job.html) na *Referência de comandos da AWS CLI*. ### `get-read-set-import-job` O código de exemplo a seguir mostra como usar `get-read-set-import-job`. **AWS CLI** **Como visualizar um trabalho de importação do conjunto de leitura** O exemplo `get-read-set-import-job` a seguir obtém detalhes sobre um trabalho de importação do conjunto de leitura. ``` aws omics get-read-set-import-job \ --sequence-store-id 1234567890 \ --id 1234567890 ``` Resultado: ``` { "creationTime": "2022-11-23T01:36:38.158Z", "id": "1234567890", "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ", "sequenceStoreId": "1234567890", "sources": [ { "name": "HG00100", "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890", "sampleId": "bam-sample", "sourceFileType": "BAM", "sourceFiles": { "source1": "s3://omics-artifacts-01d6xmpl4e72dd32/HG00100.chrom20.ILLUMINA.bwa.GBR.low_coverage.20101123.bam", "source2": "" }, "status": "IN_PROGRESS", "statusMessage": "The source job is currently in progress.", "subjectId": "bam-subject", "tags": { "aws:omics:sampleId": "bam-sample", "aws:omics:subjectId": "bam-subject" } }, { "name": "HG00146", "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890", "sampleId": "fastq-sample", "sourceFileType": "FASTQ", "sourceFiles": { "source1": "s3://omics-artifacts-01d6xmpl4e72dd32/SRR233106_1.filt.fastq.gz", "source2": "s3://omics-artifacts-01d6xmpl4e72dd32/SRR233106_2.filt.fastq.gz" }, "status": "IN_PROGRESS", "statusMessage": "The source job is currently in progress.", "subjectId": "fastq-subject", "tags": { "aws:omics:sampleId": "fastq-sample", "aws:omics:subjectId": "fastq-subject" } }, { "name": "HG00096", "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890", "sampleId": "cram-sample", "sourceFileType": "CRAM", "sourceFiles": { "source1": "s3://omics-artifacts-01d6xmpl4e72dd32/HG00096.alt_bwamem_GRCh38DH.20150718.GBR.low_coverage.cram", "source2": "" }, "status": "IN_PROGRESS", "statusMessage": "The source job is currently in progress.", "subjectId": "cram-subject", "tags": { "aws:omics:sampleId": "cram-sample", "aws:omics:subjectId": "cram-subject" } } ], "status": "IN_PROGRESS", "statusMessage": "The job is currently in progress." } ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para receber detalhes da API, consulte [GetReadSetImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-read-set-import-job.html) na *Referência de comandos da AWS CLI*. ### `get-read-set-metadata` O código de exemplo a seguir mostra como usar `get-read-set-metadata`. **AWS CLI** **Como visualizar um conjunto de leitura** O exemplo `get-read-set-metadata` a seguir obtém detalhes sobre os arquivos de um conjunto de leitura. ``` aws omics get-read-set-metadata \ --sequence-store-id 1234567890 \ --id 1234567890 ``` Resultado: ``` { "arn": "arn:aws:omics:us-west-2:123456789012:sequenceStore/1234567890/readSet/1234567890", "creationTime": "2022-11-23T21:55:00.515Z", "fileType": "FASTQ", "files": { "source1": { "contentLength": 310054739, "partSize": 104857600, "totalParts": 3 }, "source2": { "contentLength": 307846621, "partSize": 104857600, "totalParts": 3 } }, "id": "1234567890", "name": "HG00146", "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890", "sampleId": "fastq-sample", "sequenceInformation": { "alignment": "UNALIGNED", "totalBaseCount": 677717384, "totalReadCount": 8917334 }, "sequenceStoreId": "1234567890", "status": "ACTIVE", "subjectId": "fastq-subject" } ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [GetReadSetMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-read-set-metadata.html) na *Referência de comandos da AWS CLI*. ### `get-read-set` O código de exemplo a seguir mostra como usar `get-read-set`. **AWS CLI** **Como baixar um conjunto de leitura** O exemplo `get-read-set` a seguir baixa a parte 3 de um conjunto de leitura como `1234567890.3.bam`. ``` aws omics get-read-set \ --sequence-store-id 1234567890 \ --id 1234567890 \ --part-number 3 1234567890.3.bam ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [GetReadSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-read-set.html) na *Referência de comandos da AWS CLI*. ### `get-reference-import-job` O código de exemplo a seguir mostra como usar `get-reference-import-job`. **AWS CLI** **Como visualizar um trabalho de importação de referências** O exemplo `get-reference-import-job` a seguir obtém detalhes sobre um trabalho de importação de uma referência. ``` aws omics get-reference-import-job \ --reference-store-id 1234567890 \ --id 1234567890 ``` Resultado: ``` { "creationTime": "2022-11-22T22:25:41.124Z", "id": "1234567890", "referenceStoreId": "1234567890", "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ", "sources": [ { "name": "assembly-38", "sourceFile": "s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.fasta", "status": "IN_PROGRESS", "statusMessage": "The source job is currently in progress." } ], "status": "IN_PROGRESS", "statusMessage": "The job is currently in progress." } ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [GetReferenceImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-reference-import-job.html) na *Referência de comandos da AWS CLI*. ### `get-reference-metadata` O código de exemplo a seguir mostra como usar `get-reference-metadata`. **AWS CLI** **Como visualizar uma referência** O exemplo `get-reference-metadata` a seguir obtém detalhes sobre uma referência. ``` aws omics get-reference-metadata \ --reference-store-id 1234567890 \ --id 1234567890 ``` Resultado: ``` { "arn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890", "creationTime": "2022-11-22T22:27:09.033Z", "files": { "index": { "contentLength": 160928, "partSize": 104857600, "totalParts": 1 }, "source": { "contentLength": 3249912778, "partSize": 104857600, "totalParts": 31 } }, "id": "1234567890", "md5": "7ff134953dcca8c8997453bbb80b6b5e", "name": "assembly-38", "referenceStoreId": "1234567890", "status": "ACTIVE", "updateTime": "2022-11-22T22:27:09.033Z" } ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [GetReferenceMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-reference-metadata.html) na *Referência de comandos da AWS CLI*. ### `get-reference-store` O código de exemplo a seguir mostra como usar `get-reference-store`. **AWS CLI** **Como visualizar um repositório de referências** O exemplo `get-reference-store` a seguir obtém detalhes sobre um repositório de referências. ``` aws omics get-reference-store \ --id 1234567890 ``` Resultado: ``` { "arn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890", "creationTime": "2022-09-23T23:27:20.364Z", "id": "1234567890", "name": "my-rstore-0" } ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [GetReferenceStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-reference-store.html) na *Referência de comandos da AWS CLI*. ### `get-reference` O código de exemplo a seguir mostra como usar `get-reference`. **AWS CLI** **Como baixar uma referência de genomas** O exemplo `get-reference` a seguir baixa a parte 1 de um genoma como `hg38.1.fa`. ``` aws omics get-reference \ --reference-store-id 1234567890 \ --id 1234567890 \ --part-number 1 hg38.1.fa ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [GetReference](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-reference.html) na *Referência de comandos da AWS CLI*. ### `get-run-group` O código de exemplo a seguir mostra como usar `get-run-group`. **AWS CLI** **Como visualizar um grupo de execução** O exemplo `get-run-group` a seguir obtém detalhes sobre um grupo de execução. ``` aws omics get-run-group \ --id 1234567 ``` Resultado: ``` { "arn": "arn:aws:omics:us-west-2:123456789012:runGroup/1234567", "creationTime": "2022-12-01T00:58:42.915219Z", "id": "1234567", "maxCpus": 20, "maxDuration": 600, "name": "cram-convert", "tags": {} } ``` Para ter mais informações, consulte [Creating run groups](https://docs.aws.amazon.com/omics/latest/dev/creating-run-groups.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [GetRunGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-run-group.html) na *Referência de comandos da AWS CLI*. ### `get-run-task` O código de exemplo a seguir mostra como usar `get-run-task`. **AWS CLI** **Para visualizar uma tarefa** O exemplo `get-run-task` a seguir obtém detalhes sobre uma tarefa do fluxo de trabalho. ``` aws omics get-run-task \ --id 1234567 \ --task-id 1234567 ``` Resultado: ``` { "cpus": 1, "creationTime": "2022-11-30T23:13:00.718651Z", "logStream": "arn:aws:logs:us-west-2:123456789012:log-group:/aws/omics/WorkflowLog:log-stream:run/1234567/task/1234567", "memory": 15, "name": "CramToBamTask", "startTime": "2022-11-30T23:17:47.016Z", "status": "COMPLETED", "stopTime": "2022-11-30T23:18:21.503Z", "taskId": "1234567" } ``` Para ter mais informações, consulte [Task lifecycle in a HealthOmics run](https://docs.aws.amazon.com/omics/latest/dev/workflow-run-tasks.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [GetRunTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-run-task.html) na *Referência de comandos da AWS CLI*. ### `get-run` O código de exemplo a seguir mostra como usar `get-run`. **AWS CLI** **Como visualizar a execução de um fluxo de trabalho** O exemplo `get-run` a seguir obtém detalhes sobre a execução de um fluxo de trabalho. ``` aws omics get-run \ --id 1234567 ``` Resultado: ``` { "arn": "arn:aws:omics:us-west-2:123456789012:run/1234567", "creationTime": "2022-11-30T22:58:22.615865Z", "digest": "sha256:c54bxmpl742dcc26f7fa1f10e37550ddd8f251f418277c0a58e895b801ed28cf", "id": "1234567", "name": "cram-to-bam", "outputUri": "s3://omics-artifacts-01d6xmpl4e72dd32/workflow-output/", "parameters": { "ref_dict": "s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.dict", "ref_fasta_index": "s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.fasta.fai", "ref_fasta": "s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.fasta", "sample_name": "NA12878", "input_cram": "s3://omics-artifacts-01d6xmpl4e72dd32/NA12878.cram" }, "resourceDigests": { "s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.fasta.fai": "etag:f76371b113734a56cde236bc0372de0a", "s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.dict": "etag:3884c62eb0e53fa92459ed9bff133ae6", "s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.fasta": "etag:e307d81c605fb91b7720a08f00276842-388", "s3://omics-artifacts-01d6xmpl4e72dd32/NA12878.cram": "etag:a9f52976381286c6143b5cc681671ec6" }, "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ", "startedBy": "arn:aws:iam::123456789012:user/laptop-2020", "status": "STARTING", "tags": {}, "workflowId": "1234567", "workflowType": "PRIVATE" } ``` Para ter mais informações, consulte [Run lifecycle in a workflow](https://docs.aws.amazon.com/omics/latest/dev/monitoring-runs.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [GetRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-run.html) na *Referência de comandos da AWS CLI*. ### `get-sequence-store` O código de exemplo a seguir mostra como usar `get-sequence-store`. **AWS CLI** **Como visualizar um repositório de sequências** O exemplo `get-sequence-store` a seguir obtém detalhes sobre o repositório de referências com o ID `1234567890`. ``` aws omics get-sequence-store \ --id 1234567890 ``` Resultado: ``` { "arn": "arn:aws:omics:us-east-1:123456789012:sequenceStore/1234567890", "creationTime": "2022-11-23T19:55:48.376Z", "id": "1234567890", "name": "my-seq-store" } ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [GetSequenceStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-sequence-store.html) na *Referência de comandos da AWS CLI*. ### `get-share` O código de exemplo a seguir mostra como usar `get-share`. **AWS CLI** **Para recuperar os metadados de um compartilhamento de dados de análise do HealthOmics** O exemplo `get-share` a seguir recupera um compartilhamento de dados de análise entre contas. ``` aws omics get-share \ --share-id "495c21bedc889d07d0ab69d710a6841e-dd75ab7a1a9c384fa848b5bd8e5a7e0a" ``` Resultado: ``` { "share": { "shareId": "495c21bedc889d07d0ab69d710a6841e-dd75ab7a1a9c384fa848b5bd8e5a7e0a", "name": "my_Share-123", "resourceArn": "arn:aws:omics:us-west-2:555555555555:variantStore/omics_dev_var_store", "principalSubscriber": "123456789012", "ownerId": "555555555555", "status": "PENDING" } } ``` Para obter mais informações, consulte [Compartilhamento entre contas](https://docs.aws.amazon.com/omics/latest/dev/cross-account-sharing.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [GetShare](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-share.html) na *Referência de comandos da AWS CLI*. ### `get-variant-import-job` O código de exemplo a seguir mostra como usar `get-variant-import-job`. **AWS CLI** **Como visualizar um trabalho de importação de variantes** O exemplo `get-variant-import-job` a seguir obtém detalhes sobre um trabalho de importação de variantes. ``` aws omics get-variant-import-job \ --job-id edd7b8ce-xmpl-47e2-bc99-258cac95a508 ``` Resultado: ``` { "creationTime": "2022-11-23T22:42:50.037812Z", "destinationName": "my_var_store", "id": "edd7b8ce-xmpl-47e2-bc99-258cac95a508", "items": [ { "jobStatus": "IN_PROGRESS", "source": "s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.known_indels.vcf.gz" } ], "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ", "runLeftNormalization": false, "status": "IN_PROGRESS", "updateTime": "2022-11-23T22:43:05.898309Z" } ``` Para obter mais informações, consulte [Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [GetVariantImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-variant-import-job.html) na *Referência de comandos da AWS CLI*. ### `get-variant-store` O código de exemplo a seguir mostra como usar `get-variant-store`. **AWS CLI** **Como visualizar um repositório de variantes** O exemplo `get-variant-store` a seguir obtém detalhes sobre um repositório de variantes. ``` aws omics get-variant-store \ --name my_var_store ``` Resultado: ``` { "creationTime": "2022-11-23T22:09:07.534499Z", "id": "02dexmplcfdd", "name": "my_var_store", "reference": { "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890" }, "status": "CREATING", "storeArn": "arn:aws:omics:us-west-2:123456789012:variantStore/my_var_store", "storeSizeBytes": 0, "tags": {}, "updateTime": "2022-11-23T22:09:24.931711Z" } ``` Para obter mais informações, consulte [Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [GetVariantStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-variant-store.html) na *Referência de comandos da AWS CLI*. ### `get-workflow` O código de exemplo a seguir mostra como usar `get-workflow`. **AWS CLI** **Como visualizar um fluxo de trabalho** O exemplo `get-workflow` a seguir obtém detalhes sobre o fluxo de trabalho om o ID `1234567`. ``` aws omics get-workflow \ --id 1234567 ``` Resultado: ``` { "arn": "arn:aws:omics:us-west-2:123456789012:workflow/1234567", "creationTime": "2022-11-30T22:33:16.225368Z", "digest": "sha256:c54bxmpl742dcc26f7fa1f10e37550ddd8f251f418277c0a58e895b801ed28cf", "engine": "WDL", "id": "1234567", "main": "workflow-crambam.wdl", "name": "cram-converter", "parameterTemplate": { "ref_dict": { "description": "dictionary file for 'ref_fasta'" }, "ref_fasta_index": { "description": "Index of the reference genome fasta file" }, "ref_fasta": { "description": "Reference genome fasta file" }, "input_cram": { "description": "The Cram file to convert to BAM" }, "sample_name": { "description": "The name of the input sample, used to name the output BAM" } }, "status": "ACTIVE", "statusMessage": "workflow-crambam.wdl\n workflow CramToBamFlow\n call CramToBamTask\n call ValidateSamFile\n task CramToBamTask\n task ValidateSamFile\n", "tags": {}, "type": "PRIVATE" } ``` Para ter mais informações, consulte [Creating private workflows](https://docs.aws.amazon.com/omics/latest/dev/workflows-setup.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [GetWorkflow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-workflow.html) na *Referência de comandos da AWS CLI*. ### `list-annotation-import-jobs` O código de exemplo a seguir mostra como usar `list-annotation-import-jobs`. **AWS CLI** **Para obter uma lista de trabalhos de importação de anotações** O `list-annotation-import-jobs` a seguir obtém uma lista de trabalhos de importação de anotações. ``` aws omics list-annotation-import-jobs ``` Resultado: ``` { "annotationImportJobs": [ { "creationTime": "2022-11-30T01:39:41.478294Z", "destinationName": "gff_ann_store", "id": "18a9e792-xmpl-4869-a105-e5b602900444", "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ", "runLeftNormalization": false, "status": "COMPLETED", "updateTime": "2022-11-30T01:47:09.145178Z" }, { "creationTime": "2022-11-30T00:45:58.007838Z", "destinationName": "my_ann_store", "id": "4e9eafc8-xmpl-431e-a0b2-3bda27cb600a", "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ", "runLeftNormalization": false, "status": "FAILED", "updateTime": "2022-11-30T00:47:01.706325Z" } ] } ``` Para obter mais informações, consulte [Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [ListAnnotationImportJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-annotation-import-jobs.html) na *Referência de comandos da AWS CLI*. ### `list-annotation-store-versions` O código de exemplo a seguir mostra como usar `list-annotation-store-versions`. **AWS CLI** **Para listar todas as versões de um repositório de anotações.** O exemplo `list-annotation-store-versions` a seguir lista todas as versões existentes de um repositório de anotações. ``` aws omics list-annotation-store-versions \ --name my_annotation_store ``` Resultado: ``` { "annotationStoreVersions": [ { "storeId": "4934045d1c6d", "id": "2a3f4a44aa7b", "status": "CREATING", "versionArn": "arn:aws:omics:us-west-2:555555555555:annotationStore/my_annotation_store/version/my_version_2", "name": "my_annotation_store", "versionName": "my_version_2", "creation Time": "2023-07-21T17:20:59.380043+00:00", "versionSizeBytes": 0 }, { "storeId": "4934045d1c6d", "id": "4934045d1c6d", "status": "ACTIVE", "versionArn": "arn:aws:omics:us-west-2:555555555555:annotationStore/my_annotation_store/version/my_version_1", "name": "my_annotation_store", "versionName": "my_version_1", "creationTime": "2023-07-21T17:15:49.251040+00:00", "updateTime": "2023-07-21T17:15:56.434223+00:00", "statusMessage": "", "versionSizeBytes": 0 } } ``` Para obter mais informações, consulte [Criar de novas versões de repositórios de anotações](https://docs.aws.amazon.com/omics/latest/dev/annotation-store-versioning.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [ListAnnotationStoreVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-annotation-store-versions.html) na *Referência de comandos da AWS CLI*. ### `list-annotation-stores` O código de exemplo a seguir mostra como usar `list-annotation-stores`. **AWS CLI** **Para obter uma lista de repositórios de anotações** O exemplo `list-annotation-stores` a seguir obtém uma lista de repositórios de anotações. ``` aws omics list-annotation-stores ``` Resultado: ``` { "annotationStores": [ { "creationTime": "2022-11-23T22:48:39.226492Z", "id": "0a91xmplc71f", "name": "my_ann_store", "reference": { "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890" }, "status": "ACTIVE", "statusMessage": "", "storeArn": "arn:aws:omics:us-west-2:123456789012:annotationStore/my_ann_store", "storeFormat": "VCF", "storeSizeBytes": 0, "updateTime": "2022-11-23T22:53:27.372840Z" } ] } ``` Para obter mais informações, consulte [Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [ListAnnotationStores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-annotation-stores.html) na *Referência de comandos da AWS CLI*. ### `list-multipart-read-set-uploads` O código de exemplo a seguir mostra como usar `list-multipart-read-set-uploads`. **AWS CLI** **Para listar todos os uploads multipartes de conjuntos de leitura e seus status.** O exemplo `list-multipart-read-set-uploads` a seguir lista todos os uploads de conjuntos de leitura de multipartes e seus status. ``` aws omics list-multipart-read-set-uploads \ --sequence-store-id 0123456789 ``` Resultado: ``` { "uploads": [ { "sequenceStoreId": "0123456789", "uploadId": "8749584421", "sourceFileType": "FASTQ", "subjectId": "mySubject", "sampleId": "mySample", "generatedFrom": "1000 Genomes", "name": "HG00146", "description": "FASTQ for HG00146", "creationTime": "2023-11-29T19:22:51.349298+00:00" }, { "sequenceStoreId": "0123456789", "uploadId": "5290538638", "sourceFileType": "BAM", "subjectId": "mySubject", "sampleId": "mySample", "generatedFrom": "1000 Genomes", "referenceArn": "arn:aws:omics:us-west-2:845448930428:referenceStore/8168613728/reference/2190697383", "name": "HG00146", "description": "BAM for HG00146", "creationTime": "2023-11-29T19:23:33.116516+00:00" }, { "sequenceStoreId": "0123456789", "uploadId": "4174220862", "sourceFileType": "BAM", "subjectId": "mySubject", "sampleId": "mySample", "generatedFrom": "1000 Genomes", "referenceArn": "arn:aws:omics:us-west-2:845448930428:referenceStore/8168613728/reference/2190697383", "name": "HG00147", "description": "BAM for HG00147", "creationTime": "2023-11-29T19:23:47.007866+00:00" } ] } ``` Para obter mais informações, consulte [Fazer upload direto a um repositório de sequências](https://docs.aws.amazon.com/omics/latest/dev/synchronous-uploads.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [ListMultipartReadSetUploads](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-multipart-read-set-uploads.html) na *Referência de comandos da AWS CLI*. ### `list-read-set-activation-jobs` O código de exemplo a seguir mostra como usar `list-read-set-activation-jobs`. **AWS CLI** **Para obter uma lista de trabalhos de ativação do conjunto de leitura** O exemplo `list-read-set-activation-jobs` a seguir obtém uma lista de trabalhos de ativação para o repositório de sequências com o ID `1234567890`. ``` aws omics list-read-set-activation-jobs \ --sequence-store-id 1234567890 ``` Resultado: ``` { "activationJobs": [ { "completionTime": "2022-12-06T22:33:42.828Z", "creationTime": "2022-12-06T22:32:45.213Z", "id": "1234567890", "sequenceStoreId": "1234567890", "status": "COMPLETED" }, { "creationTime": "2022-12-06T22:35:10.100Z", "id": "1234567890", "sequenceStoreId": "1234567890", "status": "IN_PROGRESS" } ] } ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [ListReadSetActivationJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-read-set-activation-jobs.html) na *Referência de comandos da AWS CLI*. ### `list-read-set-export-jobs` O código de exemplo a seguir mostra como usar `list-read-set-export-jobs`. **AWS CLI** **Para obter uma lista de trabalhos de exportação do conjunto de leitura** O exemplo `list-read-set-export-jobs` a seguir obtém uma lista de trabalhos de exportação para o repositório de sequências com o ID `1234567890`. ``` aws omics list-read-set-export-jobs \ --sequence-store-id 1234567890 ``` Resultado: ``` { "exportJobs": [ { "completionTime": "2022-12-06T22:39:14.491Z", "creationTime": "2022-12-06T22:37:18.612Z", "destination": "s3://omics-artifacts-01d6xmpl4e72dd32/read-set-export/", "id": "1234567890", "sequenceStoreId": "1234567890", "status": "COMPLETED" }, { "creationTime": "2022-12-06T22:38:04.871Z", "destination": "s3://omics-artifacts-01d6xmpl4e72dd32/read-set-export/", "id": "1234567890", "sequenceStoreId": "1234567890", "status": "IN_PROGRESS" } ] } ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [ListReadSetExportJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-read-set-export-jobs.html) na *Referência de comandos da AWS CLI*. ### `list-read-set-import-jobs` O código de exemplo a seguir mostra como usar `list-read-set-import-jobs`. **AWS CLI** **Para obter uma lista de trabalhos de importação do conjunto de leitura** O exemplo `list-read-set-import-jobs` a seguir obtém uma lista de trabalhos de importação para o repositório de sequências com o ID `1234567890`. ``` aws omics list-read-set-import-jobs \ --sequence-store-id 1234567890 ``` Resultado: ``` { "importJobs": [ { "completionTime": "2022-11-29T18:17:49.244Z", "creationTime": "2022-11-29T17:32:47.700Z", "id": "1234567890", "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ", "sequenceStoreId": "1234567890", "status": "COMPLETED" }, { "completionTime": "2022-11-23T22:01:34.090Z", "creationTime": "2022-11-23T21:52:43.289Z", "id": "1234567890", "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ", "sequenceStoreId": "1234567890", "status": "COMPLETED_WITH_FAILURES" } ] } ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [ListReadSetImportJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-read-set-import-jobs.html) na *Referência de comandos da AWS CLI*. ### `list-read-set-upload-parts` O código de exemplo a seguir mostra como usar `list-read-set-upload-parts`. **AWS CLI** **Para listar todas as partes em um upload de multipartes solicitado para um repositório de sequências.** O exemplo `list-read-set-upload-parts` a seguir lista todas as partes em um upload de multipartes solicitado para um repositório de sequências. ``` aws omics list-read-set-upload-parts \ --sequence-store-id 0123456789 \ --upload-id 1122334455 \ --part-source SOURCE1 ``` Resultado: ``` { "parts": [ { "partNumber": 1, "partSize": 94371840, "file": "SOURCE1", "checksum": "984979b9928ae8d8622286c4a9cd8e99d964a22d59ed0f5722e1733eb280e635", "lastUpdatedTime": "2023-02-02T20:14:47.533000+00:00" } { "partNumber": 2, "partSize": 10471840, "file": "SOURCE1", "checksum": "984979b9928ae8d8622286c4a9cd8e99d964a22d59ed0f5722e1733eb280e635", "lastUpdatedTime": "2023-02-02T20:14:47.533000+00:00" } ] } ``` Para obter mais informações, consulte [Fazer upload direto a um repositório de sequências](https://docs.aws.amazon.com/omics/latest/dev/synchronous-uploads.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [ListReadSetUploadParts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-read-set-upload-parts.html) na *Referência de comandos da AWS CLI*. ### `list-read-sets` O código de exemplo a seguir mostra como usar `list-read-sets`. **AWS CLI** **Para obter uma lista de conjuntos de leitura** O exemplo `list-read-sets` a seguir obtém uma lista de conjuntos de leitura para o repositório de sequências com o ID `1234567890`. ``` aws omics list-read-sets \ --sequence-store-id 1234567890 ``` Resultado: ``` { "readSets": [ { "arn": "arn:aws:omics:us-west-2:123456789012:sequenceStore/1234567890/readSet/1234567890", "creationTime": "2022-11-23T21:55:00.515Z", "fileType": "FASTQ", "id": "1234567890", "name": "HG00146", "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890", "sampleId": "fastq-sample", "sequenceStoreId": "1234567890", "status": "ACTIVE", "subjectId": "fastq-subject" } ] } ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [ListReadSets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-read-sets.html) na *Referência de comandos da AWS CLI*. ### `list-reference-import-jobs` O código de exemplo a seguir mostra como usar `list-reference-import-jobs`. **AWS CLI** **Para obter uma lista de trabalhos de importação de referências** O exemplo `list-reference-import-jobs` a seguir obtém uma lista de trabalhos de importação para o repositório de referências com o ID `1234567890`. ``` aws omics list-reference-import-jobs \ --reference-store-id 1234567890 ``` Resultado: ``` { "importJobs": [ { "completionTime": "2022-11-23T19:54:58.204Z", "creationTime": "2022-11-23T19:53:20.729Z", "id": "1234567890", "referenceStoreId": "1234567890", "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ", "status": "COMPLETED" }, { "creationTime": "2022-11-23T20:34:03.250Z", "id": "1234567890", "referenceStoreId": "1234567890", "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ", "status": "IN_PROGRESS" } ] } ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [ListReferenceImportJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-reference-import-jobs.html) na *Referência de comandos da AWS CLI*. ### `list-reference-stores` O código de exemplo a seguir mostra como usar `list-reference-stores`. **AWS CLI** **Para obter uma lista de repositórios de referências** O exemplo `list-reference-stores` a seguir obtém uma lista de repositórios de referências. ``` aws omics list-reference-stores ``` Resultado: ``` { "referenceStores": [ { "arn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890", "creationTime": "2022-11-22T22:13:25.947Z", "id": "1234567890", "name": "my-ref-store" } ] } ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [ListReferenceStores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-reference-stores.html) na *Referência de comandos da AWS CLI*. ### `list-references` O código de exemplo a seguir mostra como usar `list-references`. **AWS CLI** **Para obter uma lista de referências** O exemplo `list-references` a seguir obtém uma lista de referências de genomas para o repositório de referências com o ID `1234567890`. ``` aws omics list-references \ --reference-store-id 1234567890 ``` Resultado: ``` { "references": [ { "arn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890", "creationTime": "2022-11-22T22:27:09.033Z", "id": "1234567890", "md5": "7ff134953dcca8c8997453bbb80b6b5e", "name": "assembly-38", "referenceStoreId": "1234567890", "status": "ACTIVE", "updateTime": "2022-11-22T22:27:09.033Z" } ] } ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [ListReferences](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-references.html) na *Referência de comandos da AWS CLI*. ### `list-run-groups` O código de exemplo a seguir mostra como usar `list-run-groups`. **AWS CLI** **Para obter uma lista de grupos de execução** O exemplo `list-run-groups` a seguir obtém uma lista de grupos de execução. ``` aws omics list-run-groups ``` Resultado: ``` { "items": [ { "arn": "arn:aws:omics:us-west-2:123456789012:runGroup/1234567", "creationTime": "2022-12-01T00:58:42.915219Z", "id": "1234567", "maxCpus": 20, "maxDuration": 600, "name": "cram-convert" } ] } ``` Para ter mais informações, consulte [Creating run groups](https://docs.aws.amazon.com/omics/latest/dev/creating-run-groups.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [ListRunGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-run-groups.html) na *Referência de comandos da AWS CLI*. ### `list-run-tasks` O código de exemplo a seguir mostra como usar `list-run-tasks`. **AWS CLI** **Para obter uma lista de tarefas** O exemplo `list-run-tasks` a seguir obtém uma lista de tarefas para uma execução de fluxo de trabalho. ``` aws omics list-run-tasks \ --id 1234567 ``` Resultado: ``` { "items": [ { "cpus": 1, "creationTime": "2022-11-30T23:13:00.718651Z", "memory": 15, "name": "CramToBamTask", "startTime": "2022-11-30T23:17:47.016Z", "status": "COMPLETED", "stopTime": "2022-11-30T23:18:21.503Z", "taskId": "1234567" }, { "cpus": 1, "creationTime": "2022-11-30T23:18:32.315606Z", "memory": 4, "name": "ValidateSamFile", "startTime": "2022-11-30T23:23:40.165Z", "status": "COMPLETED", "stopTime": "2022-11-30T23:24:14.766Z", "taskId": "1234567" } ] } ``` Para ter mais informações, consulte [Task lifecycle in a HealthOmics run](https://docs.aws.amazon.com/omics/latest/dev/workflow-run-tasks.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [ListRunTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-run-tasks.html) na *Referência de comandos da AWS CLI*. ### `list-runs` O código de exemplo a seguir mostra como usar `list-runs`. **AWS CLI** **Para obter uma lista de execuções do fluxo de trabalho** O exemplo `list-runs` a seguir obtém uma lista de execuções de fluxo de trabalho. ``` aws omics list-runs ``` Resultado: ``` { "items": [ { "arn": "arn:aws:omics:us-west-2:123456789012:run/1234567", "creationTime": "2022-12-02T23:20:01.202074Z", "id": "1234567", "name": "cram-to-bam", "priority": 1, "startTime": "2022-12-02T23:29:18.115Z", "status": "COMPLETED", "stopTime": "2022-12-02T23:57:54.428812Z", "storageCapacity": 10, "workflowId": "1234567" }, { "arn": "arn:aws:omics:us-west-2:123456789012:run/1234567", "creationTime": "2022-12-03T00:16:57.180066Z", "id": "1234567", "name": "cram-to-bam", "priority": 1, "startTime": "2022-12-03T00:26:50.233Z", "status": "FAILED", "stopTime": "2022-12-03T00:37:21.451340Z", "storageCapacity": 10, "workflowId": "1234567" }, { "arn": "arn:aws:omics:us-west-2:123456789012:run/1234567", "creationTime": "2022-12-05T17:57:08.444817Z", "id": "1234567", "name": "cram-to-bam", "status": "STARTING", "workflowId": "1234567" } ] } ``` Para ter mais informações, consulte [Run lifecycle in a workflow](https://docs.aws.amazon.com/omics/latest/dev/monitoring-runs.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [ListRuns](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-runs.html) na *Referência de comandos da AWS CLI*. ### `list-sequence-stores` O código de exemplo a seguir mostra como usar `list-sequence-stores`. **AWS CLI** **Para obter uma lista de repositórios de sequências** O exemplo `list-sequence-stores` a seguir obtém uma lista de repositórios de sequências. ``` aws omics list-sequence-stores ``` Resultado: ``` { "sequenceStores": [ { "arn": "arn:aws:omics:us-west-2:123456789012:sequenceStore/1234567890", "creationTime": "2022-11-23T01:24:33.629Z", "id": "1234567890", "name": "my-seq-store" } ] } ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [ListSequenceStores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-sequence-stores.html) na *Referência de comandos da AWS CLI*. ### `list-shares` O código de exemplo a seguir mostra como usar `list-shares`. **AWS CLI** **Para listar os compartilhamentos disponíveis de dados analíticos da HealthOmics** O exemplo `list-shares` a seguir lista todos os compartilhamentos que foram criados para um proprietário do recurso. ``` aws omics list-shares \ --resource-owner SELF ``` Resultado: ``` { "shares": [ { "shareId": "595c1cbd-a008-4eca-a887-954d30c91c6e", "name": "myShare", "resourceArn": "arn:aws:omics:us-west-2:555555555555:variantStore/store_1", "principalSubscriber": "123456789012", "ownerId": "555555555555", "status": "PENDING" } { "shareId": "39b65d0d-4368-4a19-9814-b0e31d73c10a", "name": "myShare3456", "resourceArn": "arn:aws:omics:us-west-2:555555555555:variantStore/store_2", "principalSubscriber": "123456789012", "ownerId": "555555555555", "status": "ACTIVE" }, { "shareId": "203152f5-eef9-459d-a4e0-a691668d44ef", "name": "myShare4", "resourceArn": "arn:aws:omics:us-west-2:555555555555:variantStore/store_3", "principalSubscriber": "123456789012", "ownerId": "555555555555", "status": "ACTIVE" } ] } ``` Para obter mais informações, consulte [Compartilhamento entre contas](https://docs.aws.amazon.com/omics/latest/dev/cross-account-sharing.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [ListShares](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-shares.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para obter uma lista de tags** O exemplo `list-tags-for-resource` a seguir obtém uma lista de tags para um fluxo de trabalho com o ID `1234567`. ``` aws omics list-tags-for-resource \ --resource-arn arn:aws:omics:us-west-2:123456789012:workflow/1234567 ``` Resultado: ``` { "tags": { "department": "analytics" } } ``` Para obter mais informações, consulte [Adicionar tags a recursos no Amazon Omics](https://docs.aws.amazon.com/omics/latest/dev/workflows.html) no *Guia do desenvolvedor do Amazon Omics*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `list-variant-import-jobs` O código de exemplo a seguir mostra como usar `list-variant-import-jobs`. **AWS CLI** **Para obter uma lista de trabalhos de importação de variantes** O exemplo `list-variant-import-jobs` a seguir obtém uma lista de trabalhos de importação de variantes. ``` aws omics list-variant-import-jobs ``` Resultado: ``` { "variantImportJobs": [ { "creationTime": "2022-11-23T22:47:02.514002Z", "destinationName": "my_var_store", "id": "69cb65d6-xmpl-4a4a-9025-4565794b684e", "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ", "runLeftNormalization": false, "status": "COMPLETED", "updateTime": "2022-11-23T22:49:17.976597Z" }, { "creationTime": "2022-11-23T22:42:50.037812Z", "destinationName": "my_var_store", "id": "edd7b8ce-xmpl-47e2-bc99-258cac95a508", "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ", "runLeftNormalization": false, "status": "COMPLETED", "updateTime": "2022-11-23T22:45:26.009880Z" } ] } ``` Para obter mais informações, consulte [Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [ListVariantImportJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-variant-import-jobs.html) na *Referência de comandos da AWS CLI*. ### `list-variant-stores` O código de exemplo a seguir mostra como usar `list-variant-stores`. **AWS CLI** **Para obter uma lista de repositórios de variantes** O exemplo `list-variant-stores` a seguir obtém uma lista de repositórios de variantes. ``` aws omics list-variant-stores ``` Resultado: ``` { "variantStores": [ { "creationTime": "2022-11-23T22:09:07.534499Z", "id": "02dexmplcfdd", "name": "my_var_store", "reference": { "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890" }, "status": "CREATING", "storeArn": "arn:aws:omics:us-west-2:123456789012:variantStore/my_var_store", "storeSizeBytes": 0, "updateTime": "2022-11-23T22:09:24.931711Z" }, { "creationTime": "2022-09-23T23:00:09.140265Z", "id": "8777xmpl1a24", "name": "myvstore0", "status": "ACTIVE", "storeArn": "arn:aws:omics:us-west-2:123456789012:variantStore/myvstore0", "storeSizeBytes": 0, "updateTime": "2022-09-23T23:03:26.013220Z" } ] } ``` Para obter mais informações, consulte [Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [ListVariantStores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-variant-stores.html) na *Referência de comandos da AWS CLI*. ### `list-workflows` O código de exemplo a seguir mostra como usar `list-workflows`. **AWS CLI** **Para obter uma lista de fluxos de trabalho** O exemplo `list-workflows` a seguir obtém uma lista de fluxos de trabalho. ``` aws omics list-workflows ``` Resultado: ``` { "items": [ { "arn": "arn:aws:omics:us-west-2:123456789012:workflow/1234567", "creationTime": "2022-09-23T23:08:22.041227Z", "digest": "nSCNo/qMWFxmplXpUdokXJnwgneOaxyyc2YOxVxrJTE=", "id": "1234567", "name": "my-wkflow-0", "status": "ACTIVE", "type": "PRIVATE" }, { "arn": "arn:aws:omics:us-west-2:123456789012:workflow/1234567", "creationTime": "2022-11-30T22:33:16.225368Z", "digest": "sha256:c54bxmpl742dcc26f7fa1f10e37550ddd8f251f418277c0a58e895b801ed28cf", "id": "1234567", "name": "cram-converter", "status": "ACTIVE", "type": "PRIVATE" } ] } ``` Para ter mais informações, consulte [Creating private workflows](https://docs.aws.amazon.com/omics/latest/dev/workflows-setup.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [ListWorkflows](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-workflows.html) na *Referência de comandos da AWS CLI*. ### `start-annotation-import-job` O código de exemplo a seguir mostra como usar `start-annotation-import-job`. **AWS CLI** **Para importar anotações** O exemplo `start-annotation-import-job` a seguir importa anotações do Amazon S3. ``` aws omics start-annotation-import-job \ --destination-name tsv_ann_store \ --no-run-left-normalization \ --role-arn arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ \ --items source=s3://omics-artifacts-01d6xmpl4e72dd32/targetedregions.bed.gz ``` Resultado: ``` { "jobId": "984162c7-xmpl-4d23-ab47-286f7950bfbf" } ``` Para obter mais informações, consulte [Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [StartAnnotationImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/start-annotation-import-job.html) na *Referência de comandos da AWS CLI*. ### `start-read-set-activation-job` O código de exemplo a seguir mostra como usar `start-read-set-activation-job`. **AWS CLI** **Como ativar um conjunto de leitura arquivado** O exemplo `start-read-set-activation-job` a seguir ativa dois conjuntos de leitura. ``` aws omics start-read-set-activation-job \ --sequence-store-id 1234567890 \ --sources readSetId=1234567890 readSetId=1234567890 ``` Resultado: ``` { "creationTime": "2022-12-06T22:35:10.100Z", "id": "1234567890", "sequenceStoreId": "1234567890", "status": "SUBMITTED" } ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [StartReadSetActivationJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/start-read-set-activation-job.html) na *Referência de comandos da AWS CLI*. ### `start-read-set-export-job` O código de exemplo a seguir mostra como usar `start-read-set-export-job`. **AWS CLI** **Para exportar um conjunto de leitura** O exemplo `start-read-set-export-job` a seguir exporta dois conjuntos de leitura para o Amazon S3. ``` aws omics start-read-set-export-job \ --sequence-store-id 1234567890 \ --sources readSetId=1234567890 readSetId=1234567890 \ --role-arn arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ \ --destination s3://omics-artifacts-01d6xmpl4e72dd32/read-set-export/ ``` Resultado: ``` { "creationTime": "2022-12-06T22:37:18.612Z", "destination": "s3://omics-artifacts-01d6xmpl4e72dd32/read-set-export/", "id": "1234567890", "sequenceStoreId": "1234567890", "status": "SUBMITTED" } ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [StartReadSetExportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/start-read-set-export-job.html) na *Referência de comandos da AWS CLI*. ### `start-read-set-import-job` O código de exemplo a seguir mostra como usar `start-read-set-import-job`. **AWS CLI** **Para importar um conjunto de leitura** O exemplo `start-read-set-import-job` a seguir importa um conjunto de leitura. ``` aws omics start-read-set-import-job \ --sequence-store-id 1234567890 \ --role-arn arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ \ --sources file://readset-sources.json ``` readset-sources.json é um documento JSON com o seguinte conteúdo. ``` [ { "sourceFiles": { "source1": "s3://omics-artifacts-01d6xmpl4e72dd32/HG00100.chrom20.ILLUMINA.bwa.GBR.low_coverage.20101123.bam" }, "sourceFileType": "BAM", "subjectId": "bam-subject", "sampleId": "bam-sample", "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890", "name": "HG00100" } ] ``` Resultado: ``` { "creationTime": "2022-11-23T01:36:38.158Z", "id": "1234567890", "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ", "sequenceStoreId": "1234567890", "status": "SUBMITTED" } ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [StartReadSetImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/start-read-set-import-job.html) na *Referência de comandos da AWS CLI*. ### `start-reference-import-job` O código de exemplo a seguir mostra como usar `start-reference-import-job`. **AWS CLI** **Para importar um genoma de referência** O exemplo `start-reference-import-job` a seguir importa um genoma de referência do Amazon S3. ``` aws omics start-reference-import-job \ --reference-store-id 1234567890 \ --role-arn arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ \ --sources sourceFile=s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.fasta,name=assembly-38 ``` Resultado: ``` { "creationTime": "2022-11-22T22:25:41.124Z", "id": "1234567890", "referenceStoreId": "1234567890", "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ", "status": "SUBMITTED" } ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [StartReferenceImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/start-reference-import-job.html) na *Referência de comandos da AWS CLI*. ### `start-run` O código de exemplo a seguir mostra como usar `start-run`. **AWS CLI** **Para executar um fluxo de trabalho** O exemplo `start-run` a seguir executa o fluxo de trabalho com o ID `1234567`. ``` aws omics start-run \ --workflow-id 1234567 \ --role-arn arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ \ --name 'cram-to-bam' \ --output-uri s3://omics-artifacts-01d6xmpl4e72dd32/workflow-output/ \ --run-group-id 1234567 \ --priority 1 \ --storage-capacity 10 \ --log-level ALL \ --parameters file://workflow-inputs.json ``` workflow-inputs.json é um documento JSON com o seguinte conteúdo. ``` { "sample_name": "NA12878", "input_cram": "s3://omics-artifacts-01d6xmpl4e72dd32/NA12878.cram", "ref_dict": "s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.dict", "ref_fasta": "s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.fasta", "ref_fasta_index": "omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.fasta.fai" } ``` Resultado: ``` { "arn": "arn:aws:omics:us-west-2:123456789012:run/1234567", "id": "1234567", "status": "PENDING", "tags": {} } ``` Para ter mais informações, consulte [Start a run](https://docs.aws.amazon.com/omics/latest/dev/starting-a-run.html) no *Guia do usuário do AWS HealthOmics*. **Como carregar arquivos de fonte do Amazon Omics** Também é possível carregar arquivos de fonte do repositório do Amazon Omics através de URIs específicos do serviço. O arquivo de exemplo a seguir, workflow-inputs.json, usa URIs do Amazon Omics para fontes de conjuntos de leitura e genomas de referência. ``` { "sample_name": "NA12878", "input_cram": "omics://123456789012.storage.us-west-2.amazonaws.com/1234567890/readSet/1234567890/source1", "ref_dict": "s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.dict", "ref_fasta": "omics://123456789012.storage.us-west-2.amazonaws.com/1234567890/reference/1234567890", "ref_fasta_index": "omics://123456789012.storage.us-west-2.amazonaws.com/1234567890/reference/1234567890/index" } ``` + Para ver detalhes da API, consulte [StartRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/start-run.html) na *Referência de comandos da AWS CLI*. ### `start-variant-import-job` O código de exemplo a seguir mostra como usar `start-variant-import-job`. **AWS CLI** **Para importar um arquivo de variantes** O exemplo `start-variant-import-job` a seguir importa um arquivo de variantes no formato VCF. ``` aws omics start-variant-import-job \ --destination-name my_var_store \ --no-run-left-normalization \ --role-arn arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ \ --items source=s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.known_indels.vcf.gz ``` Resultado: ``` { "jobId": "edd7b8ce-xmpl-47e2-bc99-258cac95a508" } ``` Para obter mais informações, consulte [Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [StartVariantImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/start-variant-import-job.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como marcar um recurso** O exemplo `tag-resource` a seguir adiciona uma tag `department` ao fluxo de trabalho com o ID `1234567`. ``` aws omics tag-resource \ --resource-arn arn:aws:omics:us-west-2:123456789012:workflow/1234567 \ --tags department=analytics ``` Para obter mais informações, consulte [Adicionar tags a recursos no Amazon Omics](https://docs.aws.amazon.com/omics/latest/dev/workflows.html) no *Guia do desenvolvedor do Amazon Omics*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover uma tag de um recurso** O exemplo `untag-resource` a seguir remove a tag `department` de um fluxo de trabalho. ``` aws omics untag-resource \ --resource-arn arn:aws:omics:us-west-2:123456789012:workflow/1234567 \ --tag-keys department ``` Para obter mais informações, consulte [Armazenamento Ômico](https://docs.aws.amazon.com/omics/latest/dev/tagging.html) no *Guia do desenvolvedor do Amazon Omics*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-annotation-store` O código de exemplo a seguir mostra como usar `update-annotation-store`. **AWS CLI** **Para atualizar um repositório de anotações** O exemplo `update-annotation-store` a seguir atualiza a descrição do repositório de anotações chamado `my_vcf_store`. ``` aws omics update-annotation-store \ --name my_vcf_store \ --description "VCF annotation store" ``` Resultado: ``` { "creationTime": "2022-12-05T18:00:56.101860Z", "description": "VCF annotation store", "id": "bd6axmpl2444", "name": "my_vcf_store", "reference": { "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890" }, "status": "ACTIVE", "storeFormat": "VCF", "updateTime": "2022-12-05T18:13:16.100051Z" } ``` Para obter mais informações, consulte [Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [UpdateAnnotationStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/update-annotation-store.html) na *Referência de comandos da AWS CLI*. ### `update-run-group` O código de exemplo a seguir mostra como usar `update-run-group`. **AWS CLI** **Para atualizar um grupo de execução** O exemplo `update-run-group` a seguir atualiza as configurações do grupo de execução com o ID `1234567`. ``` aws omics update-run-group \ --id 1234567 \ --max-cpus 10 ``` Resultado: ``` { "arn": "arn:aws:omics:us-west-2:123456789012:runGroup/1234567", "creationTime": "2022-12-01T00:58:42.915219Z", "id": "1234567", "maxCpus": 10, "maxDuration": 600, "name": "cram-convert", "tags": {} } ``` Para obter mais informações, consulte [Fluxos de Trabalho Ômicos](https://docs.aws.amazon.com/omics/latest/dev/workflows.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [UpdateRunGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/update-run-group.html) na *Referência de comandos da AWS CLI*. ### `update-variant-store` O código de exemplo a seguir mostra como usar `update-variant-store`. **AWS CLI** **Para atualizar um repositório de variantes** O exemplo `update-variant-store` a seguir atualiza a descrição do repositório de variantes chamado `my_var_store`. ``` aws omics update-variant-store \ --name my_var_store \ --description "variant store" ``` Resultado: ``` { "creationTime": "2022-11-23T22:09:07.534499Z", "description": "variant store", "id": "02dexmplcfdd", "name": "my_var_store", "reference": { "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890" }, "status": "ACTIVE", "updateTime": "2022-12-05T18:23:37.686402Z" } ``` Para obter mais informações, consulte [Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html) no *Guia do desenvolvedor do Amazon Omics*. + Para ver detalhes da API, consulte [UpdateVariantStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/update-variant-store.html) na *Referência de comandos da AWS CLI*. ### `update-workflow` O código de exemplo a seguir mostra como usar `update-workflow`. **AWS CLI** **Para criar um fluxo de trabalho** O exemplo `update-workflow` a seguir atualiza a descrição do fluxo de trabalho com o ID `1234567`. ``` aws omics update-workflow \ --id 1234567 \ --description "copy workflow" ``` Para ter mais informações, consulte [Creating or updating a workflow](https://docs.aws.amazon.com/omics/latest/dev/creating-private-workflows.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [UpdateWorkflow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/update-workflow.html) na *Referência de comandos da AWS CLI*. ### `upload-read-set-part` O código de exemplo a seguir mostra como usar `upload-read-set-part`. **AWS CLI** **Como fazer o upload de uma parte de um conjunto de leitura.** O exemplo `upload-read-set-part` a seguir faz o upload da parte especificada de um conjunto de leitura. ``` aws omics upload-read-set-part \ --sequence-store-id 0123456789 \ --upload-id 1122334455 \ --part-source SOURCE1 \ --part-number 1 \ --payload /path/to/file/read_1_part_1.fastq.gz ``` Resultado: ``` { "checksum": "984979b9928ae8d8622286c4a9cd8e99d964a22d59ed0f5722e1733eb280e635" } ``` Para obter mais informações, consulte [Fazer upload direto a um repositório de sequências](https://docs.aws.amazon.com/omics/latest/dev/synchronous-uploads.html) no *Guia do usuário do AWS HealthOmics*. + Para ver detalhes da API, consulte [UploadReadSetPart](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/upload-read-set-part.html) na *Referência de comandos da AWS CLI*. # Exemplos do IAM usando o AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface 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-client-id-to-open-id-connect-provider` O código de exemplo a seguir mostra como usar `add-client-id-to-open-id-connect-provider`. **AWS CLI** **Adicionar um ID de cliente (público) a um provedor Open-ID Connect (OIDC** O comando `add-client-id-to-open-id-connect-provider` a seguir adiciona o ID do cliente `my-application-ID` ao provedor OIDC denominado `server.example.com`. ``` aws iam add-client-id-to-open-id-connect-provider \ --client-id my-application-ID \ --open-id-connect-provider-arn arn:aws:iam::123456789012:oidc-provider/server.example.com ``` Este comando não produz saída. Para criar um provedor OIDC, use o comando `create-open-id-connect-provider`. Para obter mais informações, consulte [Criar provedores de identidade OpenID Connect (OIDC)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [AddClientIdToOpenIdConnectProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/add-client-id-to-open-id-connect-provider.html) na *Referência de comandos da AWS CLI*. ### `add-role-to-instance-profile` O código de exemplo a seguir mostra como usar `add-role-to-instance-profile`. **AWS CLI** **Adicionar um perfil a um perfil de instância** O comando `add-role-to-instance-profile` a seguir adiciona o perfil denominado `S3Access` ao perfil de instância denominado `Webserver`. ``` aws iam add-role-to-instance-profile \ --role-name S3Access \ --instance-profile-name Webserver ``` Este comando não produz saída. Para criar um perfil de instância, use o comando `create-instance-profile`. Para obter mais informações, consulte [Uso de um perfil do IAM para conceder permissões a aplicações em execução em instâncias do Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [AddRoleToInstanceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/add-role-to-instance-profile.html) na *Referência de comandos da AWS CLI*. ### `add-user-to-group` O código de exemplo a seguir mostra como usar `add-user-to-group`. **AWS CLI** **Como adicionar um usuário a um grupo do IAM** O comando `add-user-to-group`, apresentado a seguir, adiciona um usuário do IAM denominado `Bob` ao grupo do IAM denominado `Admins`. ``` aws iam add-user-to-group \ --user-name Bob \ --group-name Admins ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar e remover usuários de um grupo de usuários do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage_add-remove-users.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [AddUserToGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/add-user-to-group.html) na *Referência de comandos da AWS CLI*. ### `attach-group-policy` O código de exemplo a seguir mostra como usar `attach-group-policy`. **AWS CLI** **Anexar uma política gerenciada a um grupo do IAM** O comando `attach-group-policy` a seguir anexa a política gerenciada da AWS denominada `ReadOnlyAccess` ao grupo do IAM denominado `Finance`. ``` aws iam attach-group-policy \ --policy-arn arn:aws:iam::aws:policy/ReadOnlyAccess \ --group-name Finance ``` Este comando não produz saída. Para obter mais informações, consulte [Políticas gerenciadas e em linha](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [AttachGroupPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/attach-group-policy.html) na *Referência de comandos da AWS CLI*. ### `attach-role-policy` O código de exemplo a seguir mostra como usar `attach-role-policy`. **AWS CLI** **Como anexar uma política gerenciada a um perfil do IAM** O comando `attach-role-policy`, apresentado a seguir, anexa a política gerenciada pela AWS denominada `ReadOnlyAccess` ao perfil do IAM denominado `ReadOnlyRole`. ``` aws iam attach-role-policy \ --policy-arn arn:aws:iam::aws:policy/ReadOnlyAccess \ --role-name ReadOnlyRole ``` Este comando não produz saída. Para obter mais informações, consulte [Políticas gerenciadas e em linha](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [AttachRolePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/attach-role-policy.html) na *Referência de comandos da AWS CLI*. ### `attach-user-policy` O código de exemplo a seguir mostra como usar `attach-user-policy`. **AWS CLI** **Como anexar uma política gerenciada a um usuário do IAM** O comando `attach-user-policy`, apresentado a seguir, anexa a política gerenciada pela AWS denominada `AdministratorAccess` ao usuário do IAM denominado `Alice`. ``` aws iam attach-user-policy \ --policy-arn arn:aws:iam::aws:policy/AdministratorAccess \ --user-name Alice ``` Este comando não produz saída. Para obter mais informações, consulte [Políticas gerenciadas e em linha](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [AttachUserPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/attach-user-policy.html) na *Referência de comandos da AWS CLI*. ### `change-password` O código de exemplo a seguir mostra como usar `change-password`. **AWS CLI** **Alterar a senha do usuário do IAM** Para alterar a senha do usuário do IAM, recomendamos usar o parâmetro `--cli-input-json` para transmitir um arquivo JSON que contém suas senhas antigas e novas. Com esse método, você pode usar senhas fortes com caracteres não alfanuméricos. Pode ser difícil usar senhas com caracteres não alfanuméricos quando elas são transmitidas como parâmetros da linha de comando. Para usar o parâmetro `--cli-input-json`, comece usando o comando `change-password` com o parâmetro `--generate-cli-skeleton`, como no exemplo a seguir. ``` aws iam change-password \ --generate-cli-skeleton > change-password.json ``` O comando anterior cria um arquivo JSON chamado change-password.json que você pode usar para preencher senhas antigas e novas. Por exemplo, o perfil pode ter a aparência a seguir. ``` { "OldPassword": "3s0K_;xh4~8XXI", "NewPassword": "]35d/{pB9Fo9wJ" } ``` Em seguida, para alterar a senha, use o comando `change-password` novamente, desta vez transmitindo o parâmetro `--cli-input-json` para especificar o arquivo JSON. O comando `change-password` a seguir usa o parâmetro `--cli-input-json` com um arquivo JSON chamado change-password.json. ``` aws iam change-password \ --cli-input-json file://change-password.json ``` Este comando não produz saída. Esse comando pode ser chamado somente por usuários do IAM. Se esse comando for chamado usando credenciais da conta (raiz) da AWS, o comando retornará um erro `InvalidUserType`. Para obter mais informações, consulte [Como um usuário do IAM altera a própria senha](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_user-change-own.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ChangePassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/change-password.html) na *Referência de comandos da AWS CLI*. ### `create-access-key` O código de exemplo a seguir mostra como usar `create-access-key`. **AWS CLI** **Como criar uma chave de acesso para um usuário do IAM** O comando `create-access-key`, apresentado a seguir, cria uma chave de acesso (ID da chave de acesso e chave de acesso secreta) para o usuário do IAM denominado `Bob`. ``` aws iam create-access-key \ --user-name Bob ``` Resultado: ``` { "AccessKey": { "UserName": "Bob", "Status": "Active", "CreateDate": "2015-03-09T18:39:23.411Z", "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY", "AccessKeyId": "AKIAIOSFODNN7EXAMPLE" } } ``` Armazene a chave de acesso secreta em um local seguro. Se ela for perdida, não será possível recuperá-la e você deverá criar uma nova chave de acesso. Para obter mais informações, consulte [Gerenciamento de chaves de acesso de usuários do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [CreateAccessKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-access-key.html) na *Referência de comandos da AWS CLI*. ### `create-account-alias` O código de exemplo a seguir mostra como usar `create-account-alias`. **AWS CLI** **Como criar um alias da conta** O comando `create-account-alias`, apresentado a seguir, cria o alias `examplecorp` para sua conta da AWS. ``` aws iam create-account-alias \ --account-alias examplecorp ``` Este comando não produz saída. Para obter mais informações, consulte [O ID da sua conta da AWS e seu alias](https://docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [CreateAccountAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-account-alias.html) na *Referência de comandos da AWS CLI*. ### `create-group` O código de exemplo a seguir mostra como usar `create-group`. **AWS CLI** **Para criar um grupo do IAM** O comando `create-group`, apresentado a seguir, cria um grupo do IAM denominado `Admins`. ``` aws iam create-group \ --group-name Admins ``` Resultado: ``` { "Group": { "Path": "/", "CreateDate": "2015-03-09T20:30:24.940Z", "GroupId": "AIDGPMS9RO4H3FEXAMPLE", "Arn": "arn:aws:iam::123456789012:group/Admins", "GroupName": "Admins" } } ``` Para obter mais informações, consulte [Criação de grupos de usuários do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_create.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [CreateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-group.html) na *Referência de comandos da AWS CLI*. ### `create-instance-profile` O código de exemplo a seguir mostra como usar `create-instance-profile`. **AWS CLI** **Como criar um perfil de instância** O comando `create-instance-profile`, apresentado a seguir, cria um perfil de instância denominado `Webserver`. ``` aws iam create-instance-profile \ --instance-profile-name Webserver ``` Resultado: ``` { "InstanceProfile": { "InstanceProfileId": "AIPAJMBYC7DLSPEXAMPLE", "Roles": [], "CreateDate": "2015-03-09T20:33:19.626Z", "InstanceProfileName": "Webserver", "Path": "/", "Arn": "arn:aws:iam::123456789012:instance-profile/Webserver" } } ``` Para adicionar um perfil a um perfil de instância, use o comando `add-role-to-instance-profile`. Para obter mais informações, consulte [Uso de um perfil do IAM para conceder permissões a aplicações em execução em instâncias do Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [CreateInstanceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-instance-profile.html) na *Referência de comandos da AWS CLI*. ### `create-login-profile` O código de exemplo a seguir mostra como usar `create-login-profile`. **AWS CLI** **Criar uma senha para um usuário do IAM** Para criar uma senha de um usuário do IAM, recomendamos usar o parâmetro `--cli-input-json` para transmitir um arquivo JSON que contém a senha. Usando esse método, você pode criar uma senha forte com caracteres não alfanuméricos. Pode ser difícil criar uma senha com caracteres não alfanuméricos ao transmiti-la como parâmetro da linha de comando. Para usar o parâmetro `--cli-input-json`, comece usando o comando `create-login-profile` com o parâmetro `--generate-cli-skeleton`, como no exemplo a seguir. ``` aws iam create-login-profile \ --generate-cli-skeleton > create-login-profile.json ``` O comando anterior cria um arquivo JSON chamado create-login-profile.json que pode ser usado para preencher as informações de um comando `create-login-profile` subsequente. Por exemplo: ``` { "UserName": "Bob", "Password": "&1-3a6u:RA0djs", "PasswordResetRequired": true } ``` Em seguida, para criar uma senha de um usuário do IAM, use o comando `create-login-profile` novamente, desta vez transmitindo o parâmetro `--cli-input-json` a fim de especificar o arquivo JSON. O comando `create-login-profile` a seguir usa o parâmetro `--cli-input-json` com um arquivo JSON chamado create-login-profile.json. ``` aws iam create-login-profile \ --cli-input-json file://create-login-profile.json ``` Resultado: ``` { "LoginProfile": { "UserName": "Bob", "CreateDate": "2015-03-10T20:55:40.274Z", "PasswordResetRequired": true } } ``` Se a nova senha violar a política de senha da conta, o comando retornará um erro `PasswordPolicyViolation`. Para alterar a senha de um usuário que já tem uma, use `update-login-profile`. Para definir uma política de senha da conta, use o comando `update-account-password-policy`. Se a política de senha da conta permitir, os usuários do IAM poderão alterar suas próprias senhas usando o comando `change-password`. Para obter mais informações, consulte [Gerenciamento de senhas de usuários do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_admin-change-user.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [CreateLoginProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-login-profile.html) na *Referência de comandos da AWS CLI*. ### `create-open-id-connect-provider` O código de exemplo a seguir mostra como usar `create-open-id-connect-provider`. **AWS CLI** **Criar um provedor OpenID Connect (OIDC** Para criar um provedor OpenID Connect (OIDC), recomendamos usar o parâmetro `--cli-input-json` para transmitir um arquivo JSON que contém os parâmetros necessários. Ao criar um provedor OIDC, você deve transmitir o URL do provedor, e o URL deve começar com `https://`. Pode ser difícil transmitir o URL como parâmetro de linha de comando, porque os caracteres de dois pontos (:) e barra (/) têm um significado especial em alguns ambientes de linha de comando. Usar o parâmetro `--cli-input-json` contorna essa limitação. Para usar o parâmetro `--cli-input-json`, comece usando o comando `create-open-id-connect-provider` com o parâmetro `--generate-cli-skeleton`, como no exemplo a seguir. ``` aws iam create-open-id-connect-provider \ --generate-cli-skeleton > create-open-id-connect-provider.json ``` O comando anterior cria um arquivo JSON chamado create-open-id-connect-provider.json que você pode usar para preencher as informações de um comando `create-open-id-connect-provider` subsequente. Por exemplo: ``` { "Url": "https://server.example.com", "ClientIDList": [ "example-application-ID" ], "ThumbprintList": [ "c3768084dfb3d2b68b7897bf5f565da8eEXAMPLE" ] } ``` Em seguida, para criar o provedor OpenID Connect (OIDC), use o comando `create-open-id-connect-provider` novamente, desta vez transmitindo o parâmetro `--cli-input-json` a fim de especificar o arquivo JSON. O comando `create-open-id-connect-provider` a seguir usa o parâmetro `--cli-input-json` com um arquivo JSON chamado create-open-id-connect-provider.json. ``` aws iam create-open-id-connect-provider \ --cli-input-json file://create-open-id-connect-provider.json ``` Resultado: ``` { "OpenIDConnectProviderArn": "arn:aws:iam::123456789012:oidc-provider/server.example.com" } ``` Para obter mais informações sobre provedores OIDC, consulte [Criar provedores de identidade OpenID Connect (OIDC)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html) no *Guia do usuário do AWS IAM*. Para obter mais informações sobre como conseguir impressões digitais de um provedor OIDC, consulte [Obter a impressão digital para um provedor de identidade OpenID Connect](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc_verify-thumbprint.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [CreateOpenIdConnectProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-open-id-connect-provider.html) na *Referência de comandos da AWS CLI*. ### `create-policy-version` O código de exemplo a seguir mostra como usar `create-policy-version`. **AWS CLI** **Como criar uma nova versão de uma política gerenciada** Este exemplo cria uma nova versão `v2` da política do IAM cujo ARN é `arn:aws:iam::123456789012:policy/MyPolicy` e a torna a versão padrão. ``` aws iam create-policy-version \ --policy-arn arn:aws:iam::123456789012:policy/MyPolicy \ --policy-document file://NewPolicyVersion.json \ --set-as-default ``` Resultado: ``` { "PolicyVersion": { "CreateDate": "2015-06-16T18:56:03.721Z", "VersionId": "v2", "IsDefaultVersion": true } } ``` Para obter mais informações, consulte [Versionamento de políticas do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-versioning.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [CreatePolicyVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-policy-version.html) na *Referência de comandos da AWS CLI*. ### `create-policy` O código de exemplo a seguir mostra como usar `create-policy`. **AWS CLI** **Exemplo 1: como criar uma política gerenciada pelo cliente** O comando apresentado a seguir cria uma política gerenciada pelo cliente denominada `my-policy`. O arquivo `policy.json` é um documento JSON na pasta atual que concede acesso somente leitura à pasta `shared` em um bucket do Amazon S3 denominado `amzn-s3-demo-bucket`. ``` aws iam create-policy \ --policy-name my-policy \ --policy-document file://policy.json ``` Conteúdo de policy.json: ``` { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "s3:Get*", "s3:List*" ], "Resource": [ "arn:aws:s3:::amzn-s3-demo-bucket/shared/*" ] } ] } ``` Resultado: ``` { "Policy": { "PolicyName": "my-policy", "CreateDate": "2015-06-01T19:31:18.620Z", "AttachmentCount": 0, "IsAttachable": true, "PolicyId": "ZXR6A36LTYANPAI7NJ5UV", "DefaultVersionId": "v1", "Path": "/", "Arn": "arn:aws:iam::0123456789012:policy/my-policy", "UpdateDate": "2015-06-01T19:31:18.620Z" } } ``` Para obter mais informações sobre como usar arquivos como entrada para parâmetros de string, consulte [Especificar valores de parâmetro para a AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html) no *Guia do usuário da AWS CLI*. **Exemplo 2: como criar uma política gerenciada pelo cliente com uma descrição** O comando a seguir cria uma política gerenciada pelo cliente denominada `my-policy` com uma descrição imutável. O arquivo `policy.json` é um documento JSON na pasta atual que concede acesso a todas as ações Put, List e Get para um bucket do Amazon S3 denominado `amzn-s3-demo-bucket`. ``` aws iam create-policy \ --policy-name my-policy \ --policy-document file://policy.json \ --description "This policy grants access to all Put, Get, and List actions for amzn-s3-demo-bucket" ``` Conteúdo de policy.json: ``` { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "s3:ListBucket*", "s3:PutBucket*", "s3:GetBucket*" ], "Resource": [ "arn:aws:s3:::amzn-s3-demo-bucket" ] } ] } ``` Resultado: ``` { "Policy": { "PolicyName": "my-policy", "PolicyId": "ANPAWGSUGIDPEXAMPLE", "Arn": "arn:aws:iam::123456789012:policy/my-policy", "Path": "/", "DefaultVersionId": "v1", "AttachmentCount": 0, "PermissionsBoundaryUsageCount": 0, "IsAttachable": true, "CreateDate": "2023-05-24T22:38:47+00:00", "UpdateDate": "2023-05-24T22:38:47+00:00" } } ``` Para obter mais informações sobre as políticas baseadas em identidade, consulte [Políticas baseadas em identidade e em recurso](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html) no *Guia do usuário do AWS IAM*. **Exemplo 3: para criar uma política gerenciada pelo cliente com tags** O comando apresentado a seguir cria uma política gerenciada pelo cliente, denominada `my-policy`, com etiquetas. Este exemplo usa o parâmetro `--tags` com as seguintes tags formatadas em JSON: `'{"Key": "Department", "Value": "Accounting"}' '{"Key": "Location", "Value": "Seattle"}'`. Como alternativa, o parâmetro `--tags` pode ser usado com tags no formato abreviado: `'Key=Department,Value=Accounting Key=Location,Value=Seattle'`. O arquivo `policy.json` é um documento JSON na pasta atual que concede acesso a todas as ações Put, List e Get para um bucket do Amazon S3 denominado `amzn-s3-demo-bucket`. ``` aws iam create-policy \ --policy-name my-policy \ --policy-document file://policy.json \ --tags '{"Key": "Department", "Value": "Accounting"}' '{"Key": "Location", "Value": "Seattle"}' ``` Conteúdo de policy.json: ``` { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "s3:ListBucket*", "s3:PutBucket*", "s3:GetBucket*" ], "Resource": [ "arn:aws:s3:::amzn-s3-demo-bucket" ] } ] } ``` Resultado: ``` { "Policy": { "PolicyName": "my-policy", "PolicyId": "ANPAWGSUGIDPEXAMPLE", "Arn": "arn:aws:iam::12345678012:policy/my-policy", "Path": "/", "DefaultVersionId": "v1", "AttachmentCount": 0, "PermissionsBoundaryUsageCount": 0, "IsAttachable": true, "CreateDate": "2023-05-24T23:16:39+00:00", "UpdateDate": "2023-05-24T23:16:39+00:00", "Tags": [ { "Key": "Department", "Value": "Accounting" }, "Key": "Location", "Value": "Seattle" { ] } } ``` Para obter mais informações sobre as políticas de marcação, consulte [Marcar políticas gerenciadas pelo cliente](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags_customer-managed-policies.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [CreatePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-policy.html) na *Referência de comandos da AWS CLI*. ### `create-role` O código de exemplo a seguir mostra como usar `create-role`. **AWS CLI** **Exemplo 1: como criar um perfil do IAM** O comando `create-role`, apresentado a seguir, cria um perfil, denominado `Test-Role`, e anexa uma política de confiança a ele. ``` aws iam create-role \ --role-name Test-Role \ --assume-role-policy-document file://Test-Role-Trust-Policy.json ``` Resultado: ``` { "Role": { "AssumeRolePolicyDocument": "", "RoleId": "AKIAIOSFODNN7EXAMPLE", "CreateDate": "2013-06-07T20:43:32.821Z", "RoleName": "Test-Role", "Path": "/", "Arn": "arn:aws:iam::123456789012:role/Test-Role" } } ``` A política de confiança é definida como um documento JSON no arquivo *Test-Role-Trust-Policy.json*. (O nome e a extensão do arquivo não têm significado.) A política de confiança deve especificar uma entidade principal. Para anexar uma política de permissões a um perfil, use o comando `put-role-policy`. Para obter mais informações, consulte [Criação de perfis do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html) no *Guia do usuário do AWS IAM*. **Exemplo 2: como criar um perfil do IAM com a duração máxima da sessão especificada** O comando `create-role`, apresentado a seguir, cria um perfil denominado `Test-Role` e define a duração máxima da sessão como 7.200 segundos (duas horas). ``` aws iam create-role \ --role-name Test-Role \ --assume-role-policy-document file://Test-Role-Trust-Policy.json \ --max-session-duration 7200 ``` Resultado: ``` { "Role": { "Path": "/", "RoleName": "Test-Role", "RoleId": "AKIAIOSFODNN7EXAMPLE", "Arn": "arn:aws:iam::12345678012:role/Test-Role", "CreateDate": "2023-05-24T23:50:25+00:00", "AssumeRolePolicyDocument": { "Version":"2012-10-17", "Statement": [ { "Sid": "Statement1", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::12345678012:root" }, "Action": "sts:AssumeRole" } ] } } } ``` Para obter mais informações, consulte [Modificar a duração máxima da sessão de um perfil (API da AWS)](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-managingrole-editing-api.html#roles-modify_max-session-duration-api) no *Guia do usuário do AWS IAM*. **Exemplo 3: como criar um perfil do IAM com etiquetas** O comando apresentado a seguir cria um perfil do IAM `Test-Role` com etiquetas. Este exemplo usa o sinalizador de parâmetro `--tags` com as seguintes etiquetas formatadas em JSON: `'{"Key": "Department", "Value": "Accounting"}' '{"Key": "Location", "Value": "Seattle"}'`. Como alternativa, o sinalizador `--tags` pode ser usado com etiquetas no formato abreviado: `'Key=Department,Value=Accounting Key=Location,Value=Seattle'`. ``` aws iam create-role \ --role-name Test-Role \ --assume-role-policy-document file://Test-Role-Trust-Policy.json \ --tags '{"Key": "Department", "Value": "Accounting"}' '{"Key": "Location", "Value": "Seattle"}' ``` Resultado: ``` { "Role": { "Path": "/", "RoleName": "Test-Role", "RoleId": "AKIAIOSFODNN7EXAMPLE", "Arn": "arn:aws:iam::123456789012:role/Test-Role", "CreateDate": "2023-05-25T23:29:41+00:00", "AssumeRolePolicyDocument": { "Version":"2012-10-17", "Statement": [ { "Sid": "Statement1", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::123456789012:root" }, "Action": "sts:AssumeRole" } ] }, "Tags": [ { "Key": "Department", "Value": "Accounting" }, { "Key": "Location", "Value": "Seattle" } ] } } ``` Para obter mais informações, consulte [Marcar perfis do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags_roles.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [CreateRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-role.html) na *Referência de comandos da AWS CLI*. ### `create-saml-provider` O código de exemplo a seguir mostra como usar `create-saml-provider`. **AWS CLI** **Como criar um provedor SAML** Este exemplo cria um novo provedor SAML no IAM denominado `MySAMLProvider`. Ele é descrito pelo documento de metadados do SAML, que encontra-se no arquivo `SAMLMetaData.xml`. ``` aws iam create-saml-provider \ --saml-metadata-document file://SAMLMetaData.xml \ --name MySAMLProvider ``` Resultado: ``` { "SAMLProviderArn": "arn:aws:iam::123456789012:saml-provider/MySAMLProvider" } ``` Para obter mais informações, consulte [Criação de provedores de identidade SAML do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [CreateSAMLProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-saml-provider.html) na *Referência de comandos da AWS CLI*. ### `create-service-linked-role` O código de exemplo a seguir mostra como usar `create-service-linked-role`. **AWS CLI** **Como criar um perfil vinculado ao serviço** O exemplo que usa `create-service-linked-role`, apresentado a seguir, cria um perfil vinculado ao serviço para o serviço da AWS especificado e anexa a descrição especificada. ``` aws iam create-service-linked-role \ --aws-service-name lex.amazonaws.com \ --description "My service-linked role to support Lex" ``` Resultado: ``` { "Role": { "Path": "/aws-service-role/lex.amazonaws.com/", "RoleName": "AWSServiceRoleForLexBots", "RoleId": "AROA1234567890EXAMPLE", "Arn": "arn:aws:iam::1234567890:role/aws-service-role/lex.amazonaws.com/AWSServiceRoleForLexBots", "CreateDate": "2019-04-17T20:34:14+00:00", "AssumeRolePolicyDocument": { "Version":"2012-10-17", "Statement": [ { "Action": [ "sts:AssumeRole" ], "Effect": "Allow", "Principal": { "Service": [ "lex.amazonaws.com" ] } } ] } } } ``` Para obter mais informações, consulte [Usar perfis vinculados ao serviço](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [CreateServiceLinkedRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-service-linked-role.html) na *Referência de comandos da AWS CLI*. ### `create-service-specific-credential` O código de exemplo a seguir mostra como usar `create-service-specific-credential`. **AWS CLI** **Criar um conjunto de credenciais específicas do serviço para um usuário** O exemplo `create-service-specific-credential` a seguir cria um nome de usuário e uma senha que podem ser usados apenas para acessar o serviço configurado. ``` aws iam create-service-specific-credential \ --user-name sofia \ --service-name codecommit.amazonaws.com ``` Resultado: ``` { "ServiceSpecificCredential": { "CreateDate": "2019-04-18T20:45:36+00:00", "ServiceName": "codecommit.amazonaws.com", "ServiceUserName": "sofia-at-123456789012", "ServicePassword": "k1zPZM6uVxMQ3oxqgoYlNuJPyRTZ1vREs76zTQE3eJk=", "ServiceSpecificCredentialId": "ACCAEXAMPLE123EXAMPLE", "UserName": "sofia", "Status": "Active" } } ``` Para obter mais informações, consulte [Criar credenciais do Git para conexões HTTPS com o CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html#setting-up-gc-iam) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [CreateServiceSpecificCredential](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-service-specific-credential.html) na *Referência de comandos da AWS CLI*. ### `create-user` O código de exemplo a seguir mostra como usar `create-user`. **AWS CLI** **Exemplo 1: como criar um usuário do IAM** O comando `create-user`, apresentado a seguir, cria um usuário do IAM denominado `Bob` na conta atual. ``` aws iam create-user \ --user-name Bob ``` Resultado: ``` { "User": { "UserName": "Bob", "Path": "/", "CreateDate": "2023-06-08T03:20:41.270Z", "UserId": "AIDAIOSFODNN7EXAMPLE", "Arn": "arn:aws:iam::123456789012:user/Bob" } } ``` Para obter mais informações, consulte [Criar um usuário do IAM na sua conta da AWS](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html) no *Guia do usuário do AWS IAM*. **Exemplo 2: como criar um usuário do IAM em um caminho especificado** O comando `create-user`, apresentado a seguir, cria um usuário do IAM denominado `Bob` no caminho especificado. ``` aws iam create-user \ --user-name Bob \ --path /division_abc/subdivision_xyz/ ``` Resultado: ``` { "User": { "Path": "/division_abc/subdivision_xyz/", "UserName": "Bob", "UserId": "AIDAIOSFODNN7EXAMPLE", "Arn": "arn:aws:iam::12345678012:user/division_abc/subdivision_xyz/Bob", "CreateDate": "2023-05-24T18:20:17+00:00" } } ``` Para obter mais informações, consulte [Identificadores do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) no *Guia do usuário do AWS IAM*. **Exemplo 3: como criar um usuário do IAM com etiquetas** O comando `create-user`, apresentado a seguir, cria um usuário do IAM denominado `Bob` com etiquetas. Este exemplo usa o sinalizador de parâmetro `--tags` com as seguintes etiquetas formatadas em JSON: `'{"Key": "Department", "Value": "Accounting"}' '{"Key": "Location", "Value": "Seattle"}'`. Como alternativa, o sinalizador `--tags` pode ser usado com etiquetas no formato abreviado: `'Key=Department,Value=Accounting Key=Location,Value=Seattle'`. ``` aws iam create-user \ --user-name Bob \ --tags '{"Key": "Department", "Value": "Accounting"}' '{"Key": "Location", "Value": "Seattle"}' ``` Resultado: ``` { "User": { "Path": "/", "UserName": "Bob", "UserId": "AIDAIOSFODNN7EXAMPLE", "Arn": "arn:aws:iam::12345678012:user/Bob", "CreateDate": "2023-05-25T17:14:21+00:00", "Tags": [ { "Key": "Department", "Value": "Accounting" }, { "Key": "Location", "Value": "Seattle" } ] } } ``` Para obter mais informações, consulte [Marcar usuários do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags_users.html) no *Guia do usuário do AWS IAM*. **Exemplo 3: como criar um usuário do IAM com um limite de permissões definido** O comando `create-user`, apresentado a seguir, cria um usuário do IAM denominado `Bob` com o limite de permissões AmazonS3FullAccess. ``` aws iam create-user \ --user-name Bob \ --permissions-boundary arn:aws:iam::aws:policy/AmazonS3FullAccess ``` Resultado: ``` { "User": { "Path": "/", "UserName": "Bob", "UserId": "AIDAIOSFODNN7EXAMPLE", "Arn": "arn:aws:iam::12345678012:user/Bob", "CreateDate": "2023-05-24T17:50:53+00:00", "PermissionsBoundary": { "PermissionsBoundaryType": "Policy", "PermissionsBoundaryArn": "arn:aws:iam::aws:policy/AmazonS3FullAccess" } } } ``` Para obter mais informações, consulte [Limites de permissões para entidades do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [CreateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-user.html) na *Referência de comandos da AWS CLI*. ### `create-virtual-mfa-device` O código de exemplo a seguir mostra como usar `create-virtual-mfa-device`. **AWS CLI** **Criar um dispositivo de MFA virtual** Este exemplo cria um dispositivo de MFA virtual denominado `BobsMFADevice`. Ele cria um arquivo contendo informações de bootstrap denominadas `QRCode.png` e as coloca no diretório `C:/`. O método de bootstrap usado neste exemplo é `QRCodePNG`. ``` aws iam create-virtual-mfa-device \ --virtual-mfa-device-name BobsMFADevice \ --outfile C:/QRCode.png \ --bootstrap-method QRCodePNG ``` Resultado: ``` { "VirtualMFADevice": { "SerialNumber": "arn:aws:iam::210987654321:mfa/BobsMFADevice" } ``` Para obter mais informações, consulte [Uso de autenticação multifator (MFA) na AWS](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [CreateVirtualMfaDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-virtual-mfa-device.html) na *Referência de comandos da AWS CLI*. ### `deactivate-mfa-device` O código de exemplo a seguir mostra como usar `deactivate-mfa-device`. **AWS CLI** **Desativar um dispositivo de MFA** Esse comando desativa o dispositivo de MFA virtual com o ARN `arn:aws:iam::210987654321:mfa/BobsMFADevice` associado ao usuário `Bob`. ``` aws iam deactivate-mfa-device \ --user-name Bob \ --serial-number arn:aws:iam::210987654321:mfa/BobsMFADevice ``` Este comando não produz saída. Para obter mais informações, consulte [Uso de autenticação multifator (MFA) na AWS](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [DeactivateMfaDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/deactivate-mfa-device.html) na *Referência de comandos da AWS CLI*. ### `decode-authorization-message` O código de exemplo a seguir mostra como usar `decode-authorization-message`. **AWS CLI** **Decodificar uma mensagem de falha de autorização** O exemplo `decode-authorization-message` a seguir decodifica a mensagem retornada pelo console do EC2 ao tentar iniciar uma instância sem as permissões necessárias. ``` aws sts decode-authorization-message \ --encoded-message lxzA8VEjEvu-s0TTt3PgYCXik9YakOqsrFJGRZR98xNcyWAxwRq14xIvd-npzbgTevuufCTbjeBAaDARg9cbTK1rJbg3awM33o-Vy3ebPErE2-mWR9hVYdvX-0zKgVOWF9pWjZaJSMqxB-aLXo-I_8TTvBq88x8IFPbMArNdpu0IjxDjzf22PF3SOE3XvIQ-_PEO0aUqHCCcsSrFtvxm6yQD1nbm6VTIVrfa0Bzy8lsoMo7SjIaJ2r5vph6SY5vCCwg6o2JKe3hIHTa8zRrDbZSFMkcXOT6EOPkQXmaBsAC6ciG7Pz1JnEOvuj5NSTlSMljrAXczWuRKAs5GsMYiU8KZXZhokVzdQCUZkS5aVHumZbadu0io53jpgZqhMqvS4fyfK4auK0yKRMtS6JCXPlhkolEs7ZMFA0RVkutqhQqpSDPB5SX5l00lYipWyFK0_AyAx60vumPuVh8P0AzXwdFsT0l4D0m42NFIKxbWXsoJdqaOqVFyFEd0-Xx9AYAAIr6bhcis7C__bZh4dlAAWooHFGKgfoJcWGwgdzgbu9hWyVvKTpeot5hsb8qANYjJRCPXTKpi6PZfdijIkwb6gDMEsJ9qMtr62qP_989mwmtNgnVvBa_ir6oxJxVe_kL9SH1j5nsGDxQFajvPQhxWOHvEQIg_H0bnKWk ``` A saída é formatada como uma string de uma única linha de texto JSON que pode ser analisada com qualquer processador de texto JSON. ``` { "DecodedMessage": "{\"allowed\":false,\"explicitDeny\":false,\"matchedStatements\":{\"items\":[]},\"failures\":{\"items\":[]},\"context\":{\"principal\":{\"id\":\"AIDAV3ZUEFP6J7GY7O6LO\",\"name\":\"chain-user\",\"arn\":\"arn:aws:iam::403299380220:user/chain-user\"},\"action\":\"ec2:RunInstances\",\"resource\":\"arn:aws:ec2:us-east-2:403299380220:instance/*\",\"conditions\":{\"items\":[{\"key\":\"ec2:InstanceMarketType\",\"values\":{\"items\":[{\"value\":\"on-demand\"}]}},{\"key\":\"aws:Resource\",\"values\":{\"items\":[{\"value\":\"instance/*\"}]}},{\"key\":\"aws:Account\",\"values\":{\"items\":[{\"value\":\"403299380220\"}]}},{\"key\":\"ec2:AvailabilityZone\",\"values\":{\"items\":[{\"value\":\"us-east-2b\"}]}},{\"key\":\"ec2:ebsOptimized\",\"values\":{\"items\":[{\"value\":\"false\"}]}},{\"key\":\"ec2:IsLaunchTemplateResource\",\"values\":{\"items\":[{\"value\":\"false\"}]}},{\"key\":\"ec2:InstanceType\",\"values\":{\"items\":[{\"value\":\"t2.micro\"}]}},{\"key\":\"ec2:RootDeviceType\",\"values\":{\"items\":[{\"value\":\"ebs\"}]}},{\"key\":\"aws:Region\",\"values\":{\"items\":[{\"value\":\"us-east-2\"}]}},{\"key\":\"aws:Service\",\"values\":{\"items\":[{\"value\":\"ec2\"}]}},{\"key\":\"ec2:InstanceID\",\"values\":{\"items\":[{\"value\":\"*\"}]}},{\"key\":\"aws:Type\",\"values\":{\"items\":[{\"value\":\"instance\"}]}},{\"key\":\"ec2:Tenancy\",\"values\":{\"items\":[{\"value\":\"default\"}]}},{\"key\":\"ec2:Region\",\"values\":{\"items\":[{\"value\":\"us-east-2\"}]}},{\"key\":\"aws:ARN\",\"values\":{\"items\":[{\"value\":\"arn:aws:ec2:us-east-2:403299380220:instance/*\"}]}}]}}}" } ``` Para obter mais informações, consulte [Como decodificar uma mensagem de falha de autorização após receber um erro de "UnauthorizedOperation" durante a execução de uma instância do EC2?](https://repost.aws/knowledge-center/ec2-not-auth-launch) em *AWS re:Post*. + Consulte detalhes da API em [DecodeAuthorizationMessage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/decode-authorization-message.html) na *Referência de comandos da AWS CLI*. ### `delete-access-key` O código de exemplo a seguir mostra como usar `delete-access-key`. **AWS CLI** **Como excluir uma chave de acesso para um usuário do IAM** O comando `delete-access-key`, apresentado a seguir, exclui a chave de acesso especificada (ID da chave de acesso e chave de acesso secreta) para o usuário do IAM denominado `Bob`. ``` aws iam delete-access-key \ --access-key-id AKIDPMS9RO4H3FEXAMPLE \ --user-name Bob ``` Este comando não produz saída. Para listar as chaves de acesso definidas para um usuário do IAM, use o comando `list-access-keys`. Para obter mais informações, consulte [Gerenciamento de chaves de acesso de usuários do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [DeleteAccessKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-access-key.html) na *Referência de comandos da AWS CLI*. ### `delete-account-alias` O código de exemplo a seguir mostra como usar `delete-account-alias`. **AWS CLI** **Como excluir um alias da conta** O comando `delete-account-alias`, apresentado a seguir, remove o alias `mycompany` para a conta atual. ``` aws iam delete-account-alias \ --account-alias mycompany ``` Este comando não produz saída. Para obter mais informações, consulte [O ID da sua conta da AWS e seu alias](https://docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [DeleteAccountAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-account-alias.html) na *Referência de comandos da AWS CLI*. ### `delete-account-password-policy` O código de exemplo a seguir mostra como usar `delete-account-password-policy`. **AWS CLI** **Excluir a política de senha da conta atual** O comando `delete-account-password-policy` a seguir remove a política de senha da conta atual. ``` aws iam delete-account-password-policy ``` Este comando não produz saída. Para obter mais informações, consulte [Definição de uma política de senhas de contas para usuários do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_account-policy.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [DeleteAccountPasswordPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-account-password-policy.html) na *Referência de comandos da AWS CLI*. ### `delete-group-policy` O código de exemplo a seguir mostra como usar `delete-group-policy`. **AWS CLI** **Como excluir uma política de um grupo do IAM** O comando `delete-group-policy`, apresentado a seguir, exclui a política denominada `ExamplePolicy` do grupo denominado `Admins`. ``` aws iam delete-group-policy \ --group-name Admins \ --policy-name ExamplePolicy ``` Este comando não produz saída. Para visualizar as políticas anexadas a um grupo, use o comando `list-group-policies`. Para obter mais informações, consulte [Gerenciamento de políticas do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [DeleteGroupPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-group-policy.html) na *Referência de comandos da AWS CLI*. ### `delete-group` O código de exemplo a seguir mostra como usar `delete-group`. **AWS CLI** **Como excluir um grupo do IAM** O comando `delete-group`, apresentado a seguir, exclui um grupo do IAM denominado `MyTestGroup`. ``` aws iam delete-group \ --group-name MyTestGroup ``` Este comando não produz saída. Para obter mais informações, consulte [Exclusão de um grupo de usuários do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage_delete.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [DeleteGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-group.html) na *Referência de comandos da AWS CLI*. ### `delete-instance-profile` O código de exemplo a seguir mostra como usar `delete-instance-profile`. **AWS CLI** **Como excluir um perfil de instância** O comando `delete-instance-profile`, apresentado a seguir, exclui o perfil de instância denominado `ExampleInstanceProfile`. ``` aws iam delete-instance-profile \ --instance-profile-name ExampleInstanceProfile ``` Este comando não produz saída. Para obter mais informações, consulte [Usar perfis de instância](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [DeleteInstanceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-instance-profile.html) na *Referência de comandos da AWS CLI*. ### `delete-login-profile` O código de exemplo a seguir mostra como usar `delete-login-profile`. **AWS CLI** **Excluir uma senha de um usuário do IAM** O comando `delete-login-profile` a seguir exclui a senha do usuário do IAM chamado `Bob`. ``` aws iam delete-login-profile \ --user-name Bob ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciamento de senhas de usuários do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_admin-change-user.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [DeleteLoginProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-login-profile.html) na *Referência de comandos da AWS CLI*. ### `delete-open-id-connect-provider` O código de exemplo a seguir mostra como usar `delete-open-id-connect-provider`. **AWS CLI** **Excluir um provedor de identidade OpenID Connect do IAM** Este exemplo exclui o provedor OIDC do IAM que se conecta ao provedor `example.oidcprovider.com`. ``` aws iam delete-open-id-connect-provider \ --open-id-connect-provider-arn arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com ``` Este comando não produz saída. Para obter mais informações, consulte [Criar provedores de identidade OpenID Connect (OIDC)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [DeleteOpenIdConnectProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-open-id-connect-provider.html) na *Referência de comandos da AWS CLI*. ### `delete-policy-version` O código de exemplo a seguir mostra como usar `delete-policy-version`. **AWS CLI** **Para excluir uma versão de uma política gerenciada** Este exemplo exclui a versão identificada como `v2` da política cujo ARN é `arn:aws:iam::123456789012:policy/MySamplePolicy`. ``` aws iam delete-policy-version \ --policy-arn arn:aws:iam::123456789012:policy/MyPolicy \ --version-id v2 ``` Este comando não produz saída. Para obter mais informações, consulte [Políticas e permissões no IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [DeletePolicyVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-policy-version.html) na *Referência de comandos da AWS CLI*. ### `delete-policy` O código de exemplo a seguir mostra como usar `delete-policy`. **AWS CLI** **Como excluir uma política do IAM** Este exemplo exclui a política cujo ARN é `arn:aws:iam::123456789012:policy/MySamplePolicy`. ``` aws iam delete-policy \ --policy-arn arn:aws:iam::123456789012:policy/MySamplePolicy ``` Este comando não produz saída. Para obter mais informações, consulte [Políticas e permissões no IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [DeletePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-policy.html) na *Referência de comandos da AWS CLI*. ### `delete-role-permissions-boundary` O código de exemplo a seguir mostra como usar `delete-role-permissions-boundary`. **AWS CLI** **Excluir um limite de permissões de um perfil do IAM** O exemplo de `delete-role-permissions-boundary` a seguir exclui o limite de permissões do perfil do IAM especificado. Para aplicar um limite de permissões a um perfil, use o comando `put-role-permissions-boundary`. ``` aws iam delete-role-permissions-boundary \ --role-name lambda-application-role ``` Este comando não produz saída. Para obter mais informações, consulte [Políticas e permissões no IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [DeleteRolePermissionsBoundary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-role-permissions-boundary.html) na *Referência de comandos da AWS CLI*. ### `delete-role-policy` O código de exemplo a seguir mostra como usar `delete-role-policy`. **AWS CLI** **Como remover uma política de um perfil do IAM** O comando `delete-role-policy`, apresentado a seguir, remove a política denominada `ExamplePolicy` do perfil denominado `Test-Role`. ``` aws iam delete-role-policy \ --role-name Test-Role \ --policy-name ExamplePolicy ``` Este comando não produz saída. Para obter mais informações, consulte [Modificar um perfil](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_modify.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [DeleteRolePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-role-policy.html) na *Referência de comandos da AWS CLI*. ### `delete-role` O código de exemplo a seguir mostra como usar `delete-role`. **AWS CLI** **Como excluir um perfil do IAM** O comando `delete-role`, apresentado a seguir, remove o perfil denominado `Test-Role`. ``` aws iam delete-role \ --role-name Test-Role ``` Este comando não produz saída. Antes de poder excluir um perfil, você deve removê-lo de qualquer perfil de instância (`remove-role-from-instance-profile`), desanexar quaisquer políticas gerenciadas (`detach-role-policy`) e excluir quaisquer políticas em linha anexadas a ele (`delete-role-policy`). Para obter mais informações, consulte [Criação de perfis do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html) e [Usar perfis de instância](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [DeleteRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-role.html) na *Referência de comandos da AWS CLI*. ### `delete-saml-provider` O código de exemplo a seguir mostra como usar `delete-saml-provider`. **AWS CLI** **Como excluir um provedor SAML** Este exemplo exclui o provedor SAML 2.0 do IAM cujo ARN é `arn:aws:iam::123456789012:saml-provider/SAMLADFSProvider`. ``` aws iam delete-saml-provider \ --saml-provider-arn arn:aws:iam::123456789012:saml-provider/SAMLADFSProvider ``` Este comando não produz saída. Para obter mais informações, consulte [Criação de provedores de identidade SAML do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [DeleteSAMLProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-saml-provider.html) na *Referência de comandos da AWS CLI*. ### `delete-server-certificate` O código de exemplo a seguir mostra como usar `delete-server-certificate`. **AWS CLI** **Como excluir um certificado de servidor da sua conta da AWS** O comando `delete-server-certificate`, apresentado a seguir, remove o certificado de servidor especificado da sua conta da AWS. ``` aws iam delete-server-certificate \ --server-certificate-name myUpdatedServerCertificate ``` Este comando não produz saída. Para listar os certificados de servidor disponíveis em sua conta da AWS, use o comando `list-server-certificates`. Para obter mais informações, consulte [Gerenciar certificados de servidor no IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [DeleteServerCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-server-certificate.html) na *Referência de comandos da AWS CLI*. ### `delete-service-linked-role` O código de exemplo a seguir mostra como usar `delete-service-linked-role`. **AWS CLI** **Como excluir um perfil vinculado ao serviço** O exemplo para `delete-service-linked-role`, apresentado a seguir, exclui o perfil vinculado ao serviço especificado que não é mais necessário. A exclusão acontece de forma assíncrona. É possível verificar o status da exclusão e confirmar quando ela for concluída ao usar o comando `get-service-linked-role-deletion-status`. ``` aws iam delete-service-linked-role \ --role-name AWSServiceRoleForLexBots ``` Resultado: ``` { "DeletionTaskId": "task/aws-service-role/lex.amazonaws.com/AWSServiceRoleForLexBots/1a2b3c4d-1234-abcd-7890-abcdeEXAMPLE" } ``` Para obter mais informações, consulte [Usar perfis vinculados ao serviço](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [DeleteServiceLinkedRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-service-linked-role.html) na *Referência de comandos da AWS CLI*. ### `delete-service-specific-credential` O código de exemplo a seguir mostra como usar `delete-service-specific-credential`. **AWS CLI** **Exemplo 1: excluir uma credencial específica do serviço para o usuário solicitante** O exemplo `delete-service-specific-credential` a seguir exclui a credencial específica de um dado serviço para o usuário que faz a solicitação. O `service-specific-credential-id` é fornecido quando você cria a credencial e você pode recuperá-la usando o `list-service-specific-credentials` comando. ``` aws iam delete-service-specific-credential \ --service-specific-credential-id ACCAEXAMPLE123EXAMPLE ``` Este comando não produz saída. **Exemplo 2: exclui as credenciais específicas de um dado serviço para um usuário do IAM** O exemplo `delete-service-specific-credential` a seguir exclui a credencial específica de um dado serviço para o usuário especificado. O `service-specific-credential-id` é fornecido quando você cria a credencial e você pode recuperá-la usando o `list-service-specific-credentials` comando. ``` aws iam delete-service-specific-credential \ --user-name sofia \ --service-specific-credential-id ACCAEXAMPLE123EXAMPLE ``` Este comando não produz saída. Para obter mais informações, consulte [Criar credenciais do Git para conexões HTTPS com o CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html#setting-up-gc-iam) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [DeleteServiceSpecificCredential](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-service-specific-credential.html) na *Referência de comandos da AWS CLI*. ### `delete-signing-certificate` O código de exemplo a seguir mostra como usar `delete-signing-certificate`. **AWS CLI** **Excluir um certificado de assinatura de um usuário do IAM** O comando `delete-signing-certificate` a seguir exclui o certificado de assinatura especificado do usuário do IAM chamado `Bob`. ``` aws iam delete-signing-certificate \ --user-name Bob \ --certificate-id TA7SMP42TDN5Z26OBPJE7EXAMPLE ``` Este comando não produz saída. Para obter o ID de um certificado de assinatura, use o comando `list-signing-certificates`. Para obter mais informações, consulte [Manage signing certificates](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/set-up-ami-tools.html#ami-tools-managing-certs) no *Guia do usuário do Amazon EC2*. + Consulte detalhes da API em [DeleteSigningCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-signing-certificate.html) na *Referência de comandos da AWS CLI*. ### `delete-ssh-public-key` O código de exemplo a seguir mostra como usar `delete-ssh-public-key`. **AWS CLI** **Excluir uma chave pública SSH anexada a um usuário do IAM** O comando `delete-ssh-public-key` a seguir exclui a chave pública SSH específica anexada ao usuário do IAM `sofia`. ``` aws iam delete-ssh-public-key \ --user-name sofia \ --ssh-public-key-id APKA123456789EXAMPLE ``` Este comando não produz saída. Para obter mais informações, consulte [Usar chaves SSH com o CodeCommit](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_ssh-keys.html#ssh-keys-code-commit) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [DeleteSshPublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-ssh-public-key.html) na *Referência de comandos da AWS CLI*. ### `delete-user-permissions-boundary` O código de exemplo a seguir mostra como usar `delete-user-permissions-boundary`. **AWS CLI** **Excluir um limite de permissões de um usuário do IAM** O exemplo `delete-user-permissions-boundary` a seguir exclui o limite de permissões anexado ao usuário do IAM chamado `intern`. Para aplicar um limite de permissões a um usuário, use o comando `put-user-permissions-boundary`. ``` aws iam delete-user-permissions-boundary \ --user-name intern ``` Este comando não produz saída. Para obter mais informações, consulte [Políticas e permissões no IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [DeleteUserPermissionsBoundary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-user-permissions-boundary.html) na *Referência de comandos da AWS CLI*. ### `delete-user-policy` O código de exemplo a seguir mostra como usar `delete-user-policy`. **AWS CLI** **Como remover uma política de um usuário do IAM** O comando `delete-user-policy`, apresentado a seguir, remove a política especificada do usuário do IAM denominado `Bob`. ``` aws iam delete-user-policy \ --user-name Bob \ --policy-name ExamplePolicy ``` Este comando não produz saída. Para obter uma lista de políticas para um usuário do IAM, use o comando `list-user-policies`. Para obter mais informações, consulte [Criar um usuário do IAM na sua conta da AWS](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [DeleteUserPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-user-policy.html) na *Referência de comandos da AWS CLI*. ### `delete-user` O código de exemplo a seguir mostra como usar `delete-user`. **AWS CLI** **Como excluir um usuário do IAM** O comando `delete-user`, apresentado a seguir, remove o usuário do IAM denominado `Bob` da conta atual. ``` aws iam delete-user \ --user-name Bob ``` Este comando não produz saída. Para obter mais informações, consulte [Exclusão de um usuário do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_manage.html#id_users_deleting) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [DeleteUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-user.html) na *Referência de comandos da AWS CLI*. ### `delete-virtual-mfa-device` O código de exemplo a seguir mostra como usar `delete-virtual-mfa-device`. **AWS CLI** **Remover um dispositivo de MFA virtual** O comando `delete-virtual-mfa-device` a seguir remove o dispositivo de MFA especificado da conta atual. ``` aws iam delete-virtual-mfa-device \ --serial-number arn:aws:iam::123456789012:mfa/MFATest ``` Este comando não produz saída. Para obter mais informações, consulte [Desativar dispositivos de MFA](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_disable.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [DeleteVirtualMfaDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-virtual-mfa-device.html) na *Referência de comandos da AWS CLI*. ### `detach-group-policy` O código de exemplo a seguir mostra como usar `detach-group-policy`. **AWS CLI** **Para desanexar uma política de um grupo** Este exemplo remove a política gerenciada com o ARN `arn:aws:iam::123456789012:policy/TesterAccessPolicy` do grupo denominado `Testers`. ``` aws iam detach-group-policy \ --group-name Testers \ --policy-arn arn:aws:iam::123456789012:policy/TesterAccessPolicy ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar grupos de usuários do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [DetachGroupPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/detach-group-policy.html) na *Referência de comandos da AWS CLI*. ### `detach-role-policy` O código de exemplo a seguir mostra como usar `detach-role-policy`. **AWS CLI** **Como desanexar uma política de um perfil** Este exemplo remove a política gerenciada com o ARN `arn:aws:iam::123456789012:policy/FederatedTesterAccessPolicy` do perfil denominado `FedTesterRole`. ``` aws iam detach-role-policy \ --role-name FedTesterRole \ --policy-arn arn:aws:iam::123456789012:policy/FederatedTesterAccessPolicy ``` Este comando não produz saída. Para obter mais informações, consulte [Modificar um perfil](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_modify.html) no *Guia do usuário do AWS IAM*. + Para obter detalhes da API, consulte.[DetachRolePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/detach-role-policy.html) na *Referência de comandos da AWS CLI*. ### `detach-user-policy` O código de exemplo a seguir mostra como usar `detach-user-policy`. **AWS CLI** **Como desanexar uma política de um usuário** Este exemplo remove a política gerenciada com o ARN `arn:aws:iam::123456789012:policy/TesterPolicy` do usuário `Bob`. ``` aws iam detach-user-policy \ --user-name Bob \ --policy-arn arn:aws:iam::123456789012:policy/TesterPolicy ``` Este comando não produz saída. Para obter mais informações, consulte [Alteração de permissões de um usuário do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_change-permissions.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [DetachUserPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/detach-user-policy.html) na *Referência de comandos da AWS CLI*. ### `disable-organizations-root-credentials-management` O código de exemplo a seguir mostra como usar `disable-organizations-root-credentials-management`. **AWS CLI** **Como desabilitar o recurso RootCredentialsManagement em sua organização** O comando `disable-organizations-root-credentials-management` a seguir desabilita o gerenciamento de credenciais de usuário-raiz privilegiado em todas as contas-membro da sua organização. ``` aws iam disable-organizations-root-credentials-management ``` Resultado: ``` { "EnabledFeatures": [ "RootSessions" ] "OrganizationId": "o-aa111bb222" } ``` Consulte mais informações em [Centralização de acesso raiz para contas-membro](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-enable-root-access.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [DisableOrganizationsRootCredentialsManagement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/disable-organizations-root-credentials-management.html) na *Referência de comandos da AWS CLI*. ### `disable-organizations-root-sessions` O código de exemplo a seguir mostra como usar `disable-organizations-root-sessions`. **AWS CLI** **Como desabilitar o recurso RootSessions em sua organização** O comando de `disable-organizations-root-sessions` a seguir desabilita as sessões do usuário-raiz para tarefas privilegiadas em contas-membro em sua organização. ``` aws iam disable-organizations-root-sessions ``` Resultado: ``` { "EnabledFeatures": [ "RootCredentialsManagement" ] "OrganizationId": "o-aa111bb222" } ``` Consulte mais informações em [Centralização de acesso raiz para contas-membro](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-enable-root-access.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [DisableOrganizationsRootSessions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/disable-organizations-root-sessions.html) na *Referência de comandos da AWS CLI*. ### `enable-mfa-device` O código de exemplo a seguir mostra como usar `enable-mfa-device`. **AWS CLI** **Habilitar um dispositivo de MFA** Depois de usar o comando `create-virtual-mfa-device` para criar um dispositivo de MFA virtual, você pode atribuir o dispositivo de MFA a um usuário. O exemplo de `enable-mfa-device` a seguir atribui o dispositivo de MFA com o número de série `arn:aws:iam::210987654321:mfa/BobsMFADevice` ao usuário `Bob`. O comando também sincroniza o dispositivo com a AWS incluindo os dois primeiros códigos em sequência do dispositivo de MFA virtual. ``` aws iam enable-mfa-device \ --user-name Bob \ --serial-number arn:aws:iam::210987654321:mfa/BobsMFADevice \ --authentication-code1 123456 \ --authentication-code2 789012 ``` Este comando não produz saída. Para obter mais informações, consulte [Habilitar um dispositivo de autenticação multifator (MFA) virtual](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_enable_virtual.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [EnableMfaDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/enable-mfa-device.html) na *Referência de comandos da AWS CLI*. ### `enable-organizations-root-credentials-management` O código de exemplo a seguir mostra como usar `enable-organizations-root-credentials-management`. **AWS CLI** **Como habilitar o recurso RootCredentialsManagement em sua organização** O comando `enable-organizations-root-credentials-management` a seguir habilita o gerenciamento de credenciais de usuário-raiz privilegiado em todas as contas-membro da sua organização. ``` aws iam enable-organizations-root-credentials-management ``` Resultado: ``` { "EnabledFeatures": [ "RootCredentialsManagement" ] "OrganizationId": "o-aa111bb222" } ``` Consulte mais informações em [Centralização de acesso raiz para contas-membro](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-enable-root-access.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [EnableOrganizationsRootCredentialsManagement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/enable-organizations-root-credentials-management.html) na *Referência de comandos da AWS CLI*. ### `enable-organizations-root-sessions` O código de exemplo a seguir mostra como usar `enable-organizations-root-sessions`. **AWS CLI** **Como habilitar o recurso RootSessions em sua organização** O comando `enable-organizations-root-sessions` a seguir permite que a conta de gerenciamento ou o administrador delegado execute tarefas privilegiadas em contas-membro em sua organização. ``` aws iam enable-organizations-root-sessions ``` Resultado: ``` { "EnabledFeatures": [ "RootSessions" ] "OrganizationId": "o-aa111bb222" } ``` Consulte mais informações em [Centralização de acesso raiz para contas-membro](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-enable-root-access.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [EnableOrganizationsRootSessions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/enable-organizations-root-sessions.html) na *Referência de comandos da AWS CLI*. ### `generate-credential-report` O código de exemplo a seguir mostra como usar `generate-credential-report`. **AWS CLI** **Como gerar um relatório de credenciais** O exemplo apresentado a seguir tenta gerar um relatório de credenciais para a conta da AWS. ``` aws iam generate-credential-report ``` Resultado: ``` { "State": "STARTED", "Description": "No report exists. Starting a new report generation task" } ``` Para obter mais informações, consulte [Obter relatórios de credenciais da sua conta da AWS](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_getting-report.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [GenerateCredentialReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/generate-credential-report.html) na *Referência de comandos da AWS CLI*. ### `generate-organizations-access-report` O código de exemplo a seguir mostra como usar `generate-organizations-access-report`. **AWS CLI** **Exemplo 1: gerar um relatório de acesso para uma raiz em uma organização** O exemplo `generate-organizations-access-report` a seguir inicia um serviço em segundo plano para criar um relatório de acesso para a raiz especificada em uma organização. Você pode exibir o relatório após a criação executando o comando `get-organizations-access-report`. ``` aws iam generate-organizations-access-report \ --entity-path o-4fxmplt198/r-c3xb ``` Resultado: ``` { "JobId": "a8b6c06f-aaa4-8xmp-28bc-81da71836359" } ``` **Exemplo 2: gerar um relatório de acesso para uma conta em uma organização** O exemplo `generate-organizations-access-report` a seguir inicia um serviço em segundo plano para criar um relatório de acesso para a ID da conta `123456789012` na organização `o-4fxmplt198`. Você pode exibir o relatório após a criação executando o comando `get-organizations-access-report`. ``` aws iam generate-organizations-access-report \ --entity-path o-4fxmplt198/r-c3xb/123456789012 ``` Resultado: ``` { "JobId": "14b6c071-75f6-2xmp-fb77-faf6fb4201d2" } ``` **Exemplo 3: gerar um relatório de acesso para uma conta em uma unidade organizacional em uma organização** O exemplo `generate-organizations-access-report` a seguir inicia um trabalho em segundo plano para criar um relatório de acesso para a ID da conta `234567890123` na unidade organizacional `ou-c3xb-lmu7j2yg` da organização `o-4fxmplt198`. Você pode exibir o relatório após a criação executando o comando `get-organizations-access-report`. ``` aws iam generate-organizations-access-report \ --entity-path o-4fxmplt198/r-c3xb/ou-c3xb-lmu7j2yg/234567890123 ``` Resultado: ``` { "JobId": "2eb6c2e6-0xmp-ec04-1425-c937916a64af" } ``` Para obter detalhes sobre raízes e unidades organizacionais em sua organização, use os comandos `organizations list-roots` e `organizations list-organizational-units-for-parent`. Para obter mais informações, consulte [Refinar permissões na AWS usando as informações do último acesso](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [GenerateOrganizationsAccessReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/generate-organizations-access-report.html) na * Referência de Comandos da AWS CLI*. ### `generate-service-last-accessed-details` O código de exemplo a seguir mostra como usar `generate-service-last-accessed-details`. **AWS CLI** **Exemplo 1: para gerar um relatório de acesso ao serviço de uma política personalizada** O exemplo de `generate-service-last-accessed-details` a seguir inicia um trabalho em segundo plano para gerar um relatório que lista os serviços acessados pelos usuários do IAM e outras entidades com uma política personalizada denominada `intern-boundary`. Você pode exibir o relatório após a criação executando o comando `get-service-last-accessed-details`. ``` aws iam generate-service-last-accessed-details \ --arn arn:aws:iam::123456789012:policy/intern-boundary ``` Resultado: ``` { "JobId": "2eb6c2b8-7b4c-3xmp-3c13-03b72c8cdfdc" } ``` **Exemplo 2: para gerar um relatório de acesso ao serviço da política gerenciada AdministratorAccess da AWS** O exemplo de `generate-service-last-accessed-details` a seguir inicia um trabalho em segundo plano para gerar um relatório que lista os serviços acessados pelos usuários do IAM e outras entidades com a política gerenciada `AdministratorAccess` da AWS. Você pode exibir o relatório após a criação executando o comando `get-service-last-accessed-details`. ``` aws iam generate-service-last-accessed-details \ --arn arn:aws:iam::aws:policy/AdministratorAccess ``` Resultado: ``` { "JobId": "78b6c2ba-d09e-6xmp-7039-ecde30b26916" } ``` Para obter mais informações, consulte [Refinar permissões na AWS usando as informações do último acesso](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [GenerateServiceLastAccessedDetails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/generate-service-last-accessed-details.html) na *Referência de comandos da AWS CLI*. ### `get-access-key-last-used` O código de exemplo a seguir mostra como usar `get-access-key-last-used`. **AWS CLI** **Para recuperar informações sobre quando a chave de acesso especificada foi usada pela última vez** O exemplo apresentado a seguir recupera informações sobre quando a chave de acesso `ABCDEXAMPLE` foi usada pela última vez. ``` aws iam get-access-key-last-used \ --access-key-id ABCDEXAMPLE ``` Resultado: ``` { "UserName": "Bob", "AccessKeyLastUsed": { "Region": "us-east-1", "ServiceName": "iam", "LastUsedDate": "2015-06-16T22:45:00Z" } } ``` Para obter mais informações, consulte [Gerenciamento de chaves de acesso de usuários do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [GetAccessKeyLastUsed](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-access-key-last-used.html) na *Referência de comandos da AWS CLI*. ### `get-account-authorization-details` O código de exemplo a seguir mostra como usar `get-account-authorization-details`. **AWS CLI** **Para listar usuários, grupos, perfis e políticas do IAM de contas da AWS** O comando `get-account-authorization-details`, apresentado a seguir, retorna informações sobre todos os usuários, grupos, perfis e políticas do IAM na conta da AWS. ``` aws iam get-account-authorization-details ``` Resultado: ``` { "RoleDetailList": [ { "AssumeRolePolicyDocument": { "Version":"2012-10-17", "Statement": [ { "Sid": "", "Effect": "Allow", "Principal": { "Service": "ec2.amazonaws.com" }, "Action": "sts:AssumeRole" } ] }, "RoleId": "AROA1234567890EXAMPLE", "CreateDate": "2014-07-30T17:09:20Z", "InstanceProfileList": [ { "InstanceProfileId": "AIPA1234567890EXAMPLE", "Roles": [ { "AssumeRolePolicyDocument": { "Version":"2012-10-17", "Statement": [ { "Sid": "", "Effect": "Allow", "Principal": { "Service": "ec2.amazonaws.com" }, "Action": "sts:AssumeRole" } ] }, "RoleId": "AROA1234567890EXAMPLE", "CreateDate": "2014-07-30T17:09:20Z", "RoleName": "EC2role", "Path": "/", "Arn": "arn:aws:iam::123456789012:role/EC2role" } ], "CreateDate": "2014-07-30T17:09:20Z", "InstanceProfileName": "EC2role", "Path": "/", "Arn": "arn:aws:iam::123456789012:instance-profile/EC2role" } ], "RoleName": "EC2role", "Path": "/", "AttachedManagedPolicies": [ { "PolicyName": "AmazonS3FullAccess", "PolicyArn": "arn:aws:iam::aws:policy/AmazonS3FullAccess" }, { "PolicyName": "AmazonDynamoDBFullAccess", "PolicyArn": "arn:aws:iam::aws:policy/AmazonDynamoDBFullAccess" } ], "RoleLastUsed": { "Region": "us-west-2", "LastUsedDate": "2019-11-13T17:30:00Z" }, "RolePolicyList": [], "Arn": "arn:aws:iam::123456789012:role/EC2role" } ], "GroupDetailList": [ { "GroupId": "AIDA1234567890EXAMPLE", "AttachedManagedPolicies": { "PolicyName": "AdministratorAccess", "PolicyArn": "arn:aws:iam::aws:policy/AdministratorAccess" }, "GroupName": "Admins", "Path": "/", "Arn": "arn:aws:iam::123456789012:group/Admins", "CreateDate": "2013-10-14T18:32:24Z", "GroupPolicyList": [] }, { "GroupId": "AIDA1234567890EXAMPLE", "AttachedManagedPolicies": { "PolicyName": "PowerUserAccess", "PolicyArn": "arn:aws:iam::aws:policy/PowerUserAccess" }, "GroupName": "Dev", "Path": "/", "Arn": "arn:aws:iam::123456789012:group/Dev", "CreateDate": "2013-10-14T18:33:55Z", "GroupPolicyList": [] }, { "GroupId": "AIDA1234567890EXAMPLE", "AttachedManagedPolicies": [], "GroupName": "Finance", "Path": "/", "Arn": "arn:aws:iam::123456789012:group/Finance", "CreateDate": "2013-10-14T18:57:48Z", "GroupPolicyList": [ { "PolicyName": "policygen-201310141157", "PolicyDocument": { "Version":"2012-10-17", "Statement": [ { "Action": "aws-portal:*", "Sid": "Stmt1381777017000", "Resource": "*", "Effect": "Allow" } ] } } ] } ], "UserDetailList": [ { "UserName": "Alice", "GroupList": [ "Admins" ], "CreateDate": "2013-10-14T18:32:24Z", "UserId": "AIDA1234567890EXAMPLE", "UserPolicyList": [], "Path": "/", "AttachedManagedPolicies": [], "Arn": "arn:aws:iam::123456789012:user/Alice" }, { "UserName": "Bob", "GroupList": [ "Admins" ], "CreateDate": "2013-10-14T18:32:25Z", "UserId": "AIDA1234567890EXAMPLE", "UserPolicyList": [ { "PolicyName": "DenyBillingAndIAMPolicy", "PolicyDocument": { "Version":"2012-10-17", "Statement": { "Effect": "Deny", "Action": [ "aws-portal:*", "iam:*" ], "Resource": "*" } } } ], "Path": "/", "AttachedManagedPolicies": [], "Arn": "arn:aws:iam::123456789012:user/Bob" }, { "UserName": "Charlie", "GroupList": [ "Dev" ], "CreateDate": "2013-10-14T18:33:56Z", "UserId": "AIDA1234567890EXAMPLE", "UserPolicyList": [], "Path": "/", "AttachedManagedPolicies": [], "Arn": "arn:aws:iam::123456789012:user/Charlie" } ], "Policies": [ { "PolicyName": "create-update-delete-set-managed-policies", "CreateDate": "2015-02-06T19:58:34Z", "AttachmentCount": 1, "IsAttachable": true, "PolicyId": "ANPA1234567890EXAMPLE", "DefaultVersionId": "v1", "PolicyVersionList": [ { "CreateDate": "2015-02-06T19:58:34Z", "VersionId": "v1", "Document": { "Version":"2012-10-17", "Statement": { "Effect": "Allow", "Action": [ "iam:CreatePolicy", "iam:CreatePolicyVersion", "iam:DeletePolicy", "iam:DeletePolicyVersion", "iam:GetPolicy", "iam:GetPolicyVersion", "iam:ListPolicies", "iam:ListPolicyVersions", "iam:SetDefaultPolicyVersion" ], "Resource": "*" } }, "IsDefaultVersion": true } ], "Path": "/", "Arn": "arn:aws:iam::123456789012:policy/create-update-delete-set-managed-policies", "UpdateDate": "2015-02-06T19:58:34Z" }, { "PolicyName": "S3-read-only-specific-bucket", "CreateDate": "2015-01-21T21:39:41Z", "AttachmentCount": 1, "IsAttachable": true, "PolicyId": "ANPA1234567890EXAMPLE", "DefaultVersionId": "v1", "PolicyVersionList": [ { "CreateDate": "2015-01-21T21:39:41Z", "VersionId": "v1", "Document": { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "s3:Get*", "s3:List*" ], "Resource": [ "arn:aws:s3:::amzn-s3-demo-bucket", "arn:aws:s3:::amzn-s3-demo-bucket/*" ] } ] }, "IsDefaultVersion": true } ], "Path": "/", "Arn": "arn:aws:iam::123456789012:policy/S3-read-only-specific-bucket", "UpdateDate": "2015-01-21T23:39:41Z" }, { "PolicyName": "AmazonEC2FullAccess", "CreateDate": "2015-02-06T18:40:15Z", "AttachmentCount": 1, "IsAttachable": true, "PolicyId": "ANPA1234567890EXAMPLE", "DefaultVersionId": "v1", "PolicyVersionList": [ { "CreateDate": "2014-10-30T20:59:46Z", "VersionId": "v1", "Document": { "Version":"2012-10-17", "Statement": [ { "Action": "ec2:*", "Effect": "Allow", "Resource": "*" }, { "Effect": "Allow", "Action": "elasticloadbalancing:*", "Resource": "*" }, { "Effect": "Allow", "Action": "cloudwatch:*", "Resource": "*" }, { "Effect": "Allow", "Action": "autoscaling:*", "Resource": "*" } ] }, "IsDefaultVersion": true } ], "Path": "/", "Arn": "arn:aws:iam::aws:policy/AmazonEC2FullAccess", "UpdateDate": "2015-02-06T18:40:15Z" } ], "Marker": "EXAMPLEkakv9BCuUNFDtxWSyfzetYwEx2ADc8dnzfvERF5S6YMvXKx41t6gCl/eeaCX3Jo94/bKqezEAg8TEVS99EKFLxm3jtbpl25FDWEXAMPLE", "IsTruncated": true } ``` Para obter mais informações, consulte [Diretrizes de auditoria de segurança da AWS](https://docs.aws.amazon.com/IAM/latest/UserGuide/security-audit-guide.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [GetAccountAuthorizationDetails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-account-authorization-details.html) na *Referência de comandos da AWS CLI*. ### `get-account-password-policy` O código de exemplo a seguir mostra como usar `get-account-password-policy`. **AWS CLI** **Como visualizar a política de senha da conta atual** O comando `get-account-password-policy`, apresentado a seguir, exibe detalhes sobre a política de senha para a conta atual. ``` aws iam get-account-password-policy ``` Resultado: ``` { "PasswordPolicy": { "AllowUsersToChangePassword": false, "RequireLowercaseCharacters": false, "RequireUppercaseCharacters": false, "MinimumPasswordLength": 8, "RequireNumbers": true, "RequireSymbols": true } } ``` Se nenhuma política de senha estiver definida para a conta, o comando retornará um erro `NoSuchEntity`. Para obter mais informações, consulte [Definição de uma política de senhas de contas para usuários do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_account-policy.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [GetAccountPasswordPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-account-password-policy.html) na *Referência de comandos da AWS CLI*. ### `get-account-summary` O código de exemplo a seguir mostra como usar `get-account-summary`. **AWS CLI** **Como obter informações sobre o uso da entidade do IAM e das cotas do IAM na conta atual** O comando `get-account-summary`, apresentado a seguir, retorna informações sobre o uso atual da entidade do IAM e das cotas atuais da entidade do IAM na conta. ``` aws iam get-account-summary ``` Resultado: ``` { "SummaryMap": { "UsersQuota": 5000, "GroupsQuota": 100, "InstanceProfiles": 6, "SigningCertificatesPerUserQuota": 2, "AccountAccessKeysPresent": 0, "RolesQuota": 250, "RolePolicySizeQuota": 10240, "AccountSigningCertificatesPresent": 0, "Users": 27, "ServerCertificatesQuota": 20, "ServerCertificates": 0, "AssumeRolePolicySizeQuota": 2048, "Groups": 7, "MFADevicesInUse": 1, "Roles": 3, "AccountMFAEnabled": 1, "MFADevices": 3, "GroupsPerUserQuota": 10, "GroupPolicySizeQuota": 5120, "InstanceProfilesQuota": 100, "AccessKeysPerUserQuota": 2, "Providers": 0, "UserPolicySizeQuota": 2048 } } ``` Para obter mais informações sobre as limitações de entidade, consulte [IAM e cotas do AWS STS](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [GetAccountSummary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-account-summary.html) na *Referência de comandos da AWS CLI*. ### `get-context-keys-for-custom-policy` O código de exemplo a seguir mostra como usar `get-context-keys-for-custom-policy`. **AWS CLI** **Exemplo 1: para listar as chaves de contexto referenciadas por uma ou mais políticas JSON personalizadas fornecidas como um parâmetro na linha de comando** O comando `get-context-keys-for-custom-policy` a seguir analisa cada política fornecida e lista as chaves de contexto usadas por essas políticas. Use esse comando para identificar quais valores de chave de contexto você deve fornecer para usar com êxito os comandos do simulador de políticas `simulate-custom-policy` e `simulate-custom-policy`. Você também pode recuperar a lista de chaves de contexto utilizadas por todas as políticas associadas a um perfil ou usuário do IAM com o comando `get-context-keys-for-custom-policy`. Os valores de parâmetro que começam com `file://` instruem o comando a ler o arquivo e usar o conteúdo como o valor do parâmetro em vez do próprio nome do arquivo. ``` aws iam get-context-keys-for-custom-policy \ --policy-input-list '{"Version":"2012-10-17", "Statement":{"Effect":"Allow","Action":"dynamodb:*","Resource":"arn:aws:dynamodb:us-west-2:123456789012:table/${aws:username}","Condition":{"DateGreaterThan":{"aws:CurrentTime":"2015-08-16T12:00:00Z"}}}}' ``` Resultado: ``` { "ContextKeyNames": [ "aws:username", "aws:CurrentTime" ] } ``` **Exemplo 2: para listar as chaves de contexto referenciadas por uma ou mais políticas JSON personalizadas fornecidas como entrada de arquivo** O comando `get-context-keys-for-custom-policy` a seguir é igual ao exemplo anterior, exceto que as políticas são fornecidas em um arquivo e não como um parâmetro. Como o comando espera uma lista JSON de strings e não uma lista de estruturas JSON, o arquivo deve ser estruturado da forma a seguir, embora você possa reduzi-lo em uma só. ``` [ "Policy1", "Policy2" ] ``` Assim, por exemplo, um arquivo que contém a política do exemplo anterior deve ter a aparência a seguir. Você deve escapar cada aspas duplas incorporadas dentro da string de política precedendo-as com uma barra invertida ''. ``` [ "{\"Version\": \"2012-10-17\", \"Statement\": {\"Effect\": \"Allow\", \"Action\": \"dynamodb:*\", \"Resource\": \"arn:aws:dynamodb:us-west-2:128716708097:table/${aws:username}\", \"Condition\": {\"DateGreaterThan\": {\"aws:CurrentTime\": \"2015-08-16T12:00:00Z\"}}}}" ] ``` Esse arquivo pode então ser enviado ao comando a seguir. ``` aws iam get-context-keys-for-custom-policy \ --policy-input-list file://policyfile.json ``` Resultado: ``` { "ContextKeyNames": [ "aws:username", "aws:CurrentTime" ] } ``` Para obter mais informações, consulte [Uso do simulador de políticas do IAM (AWS CLI e API da AWS)](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html#policies-simulator-using-api) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [GetContextKeysForCustomPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-context-keys-for-custom-policy.html) na *Referência de comandos da AWS CLI*. ### `get-context-keys-for-principal-policy` O código de exemplo a seguir mostra como usar `get-context-keys-for-principal-policy`. **AWS CLI** **Para listar as chaves de contexto referenciadas por todas as políticas associadas a uma entidade principal do IAM** O comando `get-context-keys-for-principal-policy` a seguir recupera todas as políticas anexadas à usuária `saanvi` e aos grupos dos quais ela é membro. Em seguida, ele analisa cada uma delas e lista as chaves de contexto usadas por essas políticas. Utilize esse comando para identificar quais valores de chave de contexto você deve fornecer para usar com êxito os comandos `simulate-custom-policy` e `simulate-principal-policy`. Você também pode recuperar a lista de chaves de contexto usadas por uma política JSON arbitrária com o comando `get-context-keys-for-custom-policy`. ``` aws iam get-context-keys-for-principal-policy \ --policy-source-arn arn:aws:iam::123456789012:user/saanvi ``` Resultado: ``` { "ContextKeyNames": [ "aws:username", "aws:CurrentTime" ] } ``` Para obter mais informações, consulte [Uso do simulador de políticas do IAM (AWS CLI e API da AWS)](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html#policies-simulator-using-api) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [GetContextKeysForPrincipalPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-context-keys-for-principal-policy.html) na *Referência de comandos da AWS CLI*. ### `get-credential-report` O código de exemplo a seguir mostra como usar `get-credential-report`. **AWS CLI** **Como obter um relatório de credenciais** Este exemplo abre o relatório retornado e o envia ao pipeline como uma matriz de linhas de texto. ``` aws iam get-credential-report ``` Resultado: ``` { "GeneratedTime": "2015-06-17T19:11:50Z", "ReportFormat": "text/csv" } ``` Para obter mais informações, consulte [Obter relatórios de credenciais da sua conta da AWS](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_getting-report.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [GetCredentialReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-credential-report.html) na *Referência de comandos da AWS CLI*. ### `get-group-policy` O código de exemplo a seguir mostra como usar `get-group-policy`. **AWS CLI** **Obter informações sobre uma política anexada a um grupo do IAM** O comando `get-group-policy` a seguir obtém informações sobre a política especificada anexada ao grupo denominado `Test-Group`. ``` aws iam get-group-policy \ --group-name Test-Group \ --policy-name S3-ReadOnly-Policy ``` Resultado: ``` { "GroupName": "Test-Group", "PolicyDocument": { "Statement": [ { "Action": [ "s3:Get*", "s3:List*" ], "Resource": "*", "Effect": "Allow" } ] }, "PolicyName": "S3-ReadOnly-Policy" } ``` Para obter mais informações, consulte [Gerenciamento de políticas do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [GetGroupPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-group-policy.html) na *Referência de comandos da AWS CLI*. ### `get-group` O código de exemplo a seguir mostra como usar `get-group`. **AWS CLI** **Obter um grupo do IAM** Este exemplo retorna detalhes sobre o grupo do IAM `Admins`. ``` aws iam get-group \ --group-name Admins ``` Resultado: ``` { "Group": { "Path": "/", "CreateDate": "2015-06-16T19:41:48Z", "GroupId": "AIDGPMS9RO4H3FEXAMPLE", "Arn": "arn:aws:iam::123456789012:group/Admins", "GroupName": "Admins" }, "Users": [] } ``` Para obter mais informações, consulte [Identidades do IAM (usuários, grupos de usuários e perfis)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [GetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-group.html) na *Referência de comandos da AWS CLI*. ### `get-instance-profile` O código de exemplo a seguir mostra como usar `get-instance-profile`. **AWS CLI** **Obter informações sobre um perfil de instância** O comando `get-instance-profile` a seguir obtém informações sobre o perfil de instância denominado `ExampleInstanceProfile`. ``` aws iam get-instance-profile \ --instance-profile-name ExampleInstanceProfile ``` Resultado: ``` { "InstanceProfile": { "InstanceProfileId": "AID2MAB8DPLSRHEXAMPLE", "Roles": [ { "AssumeRolePolicyDocument": "", "RoleId": "AIDGPMS9RO4H3FEXAMPLE", "CreateDate": "2013-01-09T06:33:26Z", "RoleName": "Test-Role", "Path": "/", "Arn": "arn:aws:iam::336924118301:role/Test-Role" } ], "CreateDate": "2013-06-12T23:52:02Z", "InstanceProfileName": "ExampleInstanceProfile", "Path": "/", "Arn": "arn:aws:iam::336924118301:instance-profile/ExampleInstanceProfile" } } ``` Para obter mais informações, consulte [Usar perfis de instância](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [GetInstanceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-instance-profile.html) na *Referência de comandos da AWS CLI*. ### `get-login-profile` O código de exemplo a seguir mostra como usar `get-login-profile`. **AWS CLI** **Obter informações de senha de um usuário do IAM** O comando `get-login-profile` a seguir obtém informações sobre a senha do usuário do IAM chamado `Bob`. ``` aws iam get-login-profile \ --user-name Bob ``` Resultado: ``` { "LoginProfile": { "UserName": "Bob", "CreateDate": "2012-09-21T23:03:39Z" } } ``` O comando `get-login-profile` pode ser usado para verificar se um usuário do IAM tem uma senha. O comando retorna um erro `NoSuchEntity` se nenhuma senha for definida para o usuário. Não é possível visualizar uma senha com esse comando. Se a senha for perdida, você pode redefini-la (`update-login-profile`) para o usuário. Como alternativa, você pode excluir o perfil de login (`delete-login-profile`) do usuário e criar um novo (`create-login-profile`). Para obter mais informações, consulte [Gerenciamento de senhas de usuários do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_admin-change-user.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [GetLoginProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-login-profile.html) na *Referência de comandos da AWS CLI*. ### `get-mfa-device` O código de exemplo a seguir mostra como usar `get-mfa-device`. **AWS CLI** **Recuperar informações sobre uma chave de segurança FIDO** O comando `get-mfa-device` a seguir recupera informações sobre a chave de segurança FIDO especificada. ``` aws iam get-mfa-device \ --serial-number arn:aws:iam::123456789012:u2f/user/alice/fidokeyname-EXAMPLEBN5FHTECLFG7EXAMPLE ``` Resultado: ``` { "UserName": "alice", "SerialNumber": "arn:aws:iam::123456789012:u2f/user/alice/fidokeyname-EXAMPLEBN5FHTECLFG7EXAMPLE", "EnableDate": "2023-09-19T01:49:18+00:00", "Certifications": { "FIDO": "L1" } } ``` Para obter mais informações, consulte [Uso de autenticação multifator (MFA) na AWS](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [GetMfaDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-mfa-device.html) na *Referência de comandos da AWS CLI*. ### `get-open-id-connect-provider` O código de exemplo a seguir mostra como usar `get-open-id-connect-provider`. **AWS CLI** **Retornar informações sobre o provedor OpenID Connect especificado** Este exemplo retorna detalhes sobre o provedor OpenID Connect cujo ARN é `arn:aws:iam::123456789012:oidc-provider/server.example.com`. ``` aws iam get-open-id-connect-provider \ --open-id-connect-provider-arn arn:aws:iam::123456789012:oidc-provider/server.example.com ``` Resultado: ``` { "Url": "server.example.com" "CreateDate": "2015-06-16T19:41:48Z", "ThumbprintList": [ "12345abcdefghijk67890lmnopqrst987example" ], "ClientIDList": [ "example-application-ID" ] } ``` Para obter mais informações, consulte [Criar provedores de identidade OpenID Connect (OIDC)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [GetOpenIdConnectProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-open-id-connect-provider.html) na *Referência de comandos da AWS CLI*. ### `get-organizations-access-report` O código de exemplo a seguir mostra como usar `get-organizations-access-report`. **AWS CLI** **Recuperar um relatório de acesso** O exemplo `get-organizations-access-report` a seguir exibe um relatório de acesso gerado anteriormente para uma entidade de AWS Organizations. Para gerar um relatório, use o comando `generate-organizations-access-report`. ``` aws iam get-organizations-access-report \ --job-id a8b6c06f-aaa4-8xmp-28bc-81da71836359 ``` Resultado: ``` { "JobStatus": "COMPLETED", "JobCreationDate": "2019-09-30T06:53:36.187Z", "JobCompletionDate": "2019-09-30T06:53:37.547Z", "NumberOfServicesAccessible": 188, "NumberOfServicesNotAccessed": 171, "AccessDetails": [ { "ServiceName": "Alexa for Business", "ServiceNamespace": "a4b", "TotalAuthenticatedEntities": 0 }, ... } ``` Para obter mais informações, consulte [Refinar permissões na AWS usando as informações do último acesso](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [GetOrganizationsAccessReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-organizations-access-report.html) na *Referência de comandos da AWS CLI*. ### `get-policy-version` O código de exemplo a seguir mostra como usar `get-policy-version`. **AWS CLI** **Para recuperar informações sobre a versão especificada da política gerenciada especificada** Este exemplo retorna o documento da política para a versão v2 da política cujo ARN é `arn:aws:iam::123456789012:policy/MyManagedPolicy`. ``` aws iam get-policy-version \ --policy-arn arn:aws:iam::123456789012:policy/MyPolicy \ --version-id v2 ``` Resultado: ``` { "PolicyVersion": { "Document": { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "iam:*", "Resource": "*" } ] }, "VersionId": "v2", "IsDefaultVersion": true, "CreateDate": "2023-04-11T00:22:54+00:00" } } ``` Para obter mais informações, consulte [Políticas e permissões no IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [GetPolicyVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-policy-version.html) na *Referência de comandos da AWS CLI*. ### `get-policy` O código de exemplo a seguir mostra como usar `get-policy`. **AWS CLI** **Para recuperar informações sobre a política gerenciada especificada** Este exemplo retorna detalhes sobre a política gerenciada cujo ARN é `arn:aws:iam::123456789012:policy/MySamplePolicy`. ``` aws iam get-policy \ --policy-arn arn:aws:iam::123456789012:policy/MySamplePolicy ``` Resultado: ``` { "Policy": { "PolicyName": "MySamplePolicy", "CreateDate": "2015-06-17T19:23;32Z", "AttachmentCount": 0, "IsAttachable": true, "PolicyId": "Z27SI6FQMGNQ2EXAMPLE1", "DefaultVersionId": "v1", "Path": "/", "Arn": "arn:aws:iam::123456789012:policy/MySamplePolicy", "UpdateDate": "2015-06-17T19:23:32Z" } } ``` Para obter mais informações, consulte [Políticas e permissões no IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [GetPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-policy.html) na *Referência de comandos da AWS CLI*. ### `get-role-policy` O código de exemplo a seguir mostra como usar `get-role-policy`. **AWS CLI** **Obter informações sobre uma política anexada a um perfil do IAM** O comando `get-role-policy` a seguir obtém informações sobre a política especificada anexada ao perfil denominado `Test-Role`. ``` aws iam get-role-policy \ --role-name Test-Role \ --policy-name ExamplePolicy ``` Resultado: ``` { "RoleName": "Test-Role", "PolicyDocument": { "Statement": [ { "Action": [ "s3:ListBucket", "s3:Put*", "s3:Get*", "s3:*MultipartUpload*" ], "Resource": "*", "Effect": "Allow", "Sid": "1" } ] } "PolicyName": "ExamplePolicy" } ``` Para obter mais informações, consulte [Criação de perfis do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [GetRolePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-role-policy.html) na *Referência de comandos da AWS CLI*. ### `get-role` O código de exemplo a seguir mostra como usar `get-role`. **AWS CLI** **Como obter informações sobre um perfil do IAM** O comando `get-role`, apresentado a seguir, obtém informações sobre o perfil denominado `Test-Role`. ``` aws iam get-role \ --role-name Test-Role ``` Resultado: ``` { "Role": { "Description": "Test Role", "AssumeRolePolicyDocument":"", "MaxSessionDuration": 3600, "RoleId": "AROA1234567890EXAMPLE", "CreateDate": "2019-11-13T16:45:56Z", "RoleName": "Test-Role", "Path": "/", "RoleLastUsed": { "Region": "us-east-1", "LastUsedDate": "2019-11-13T17:14:00Z" }, "Arn": "arn:aws:iam::123456789012:role/Test-Role" } } ``` O comando exibe a política de confiança anexada ao perfil. Para listar as políticas de permissões anexadas a um perfil, use o comando `list-role-policies`. Para obter mais informações, consulte [Criação de perfis do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [GetRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-role.html) na *Referência de comandos da AWS CLI*. ### `get-saml-provider` O código de exemplo a seguir mostra como usar `get-saml-provider`. **AWS CLI** **Recuperar o metadocumento do provedor SAML** 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 SAML da AWS, bem como as datas de criação e expiração. ``` aws iam get-saml-provider \ --saml-provider-arn arn:aws:iam::123456789012:saml-provider/SAMLADFS ``` Resultado: ``` { "SAMLMetadataDocument": "...SAMLMetadataDocument-XML...", "CreateDate": "2017-03-06T22:29:46+00:00", "ValidUntil": "2117-03-06T22:29:46.433000+00:00", "Tags": [ { "Key": "DeptID", "Value": "123456" }, { "Key": "Department", "Value": "Accounting" } ] } ``` Para obter mais informações, consulte [Criação de provedores de identidade SAML do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [GetSamlProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-saml-provider.html) na *Referência de comandos da AWS CLI*. ### `get-server-certificate` O código de exemplo a seguir mostra como usar `get-server-certificate`. **AWS CLI** **Como obter detalhes sobre um certificado de servidor em sua conta da AWS** O comando `get-server-certificate`, apresentado a seguir, recupera todos os detalhes sobre o certificado de servidor especificado em sua conta da AWS. ``` aws iam get-server-certificate \ --server-certificate-name myUpdatedServerCertificate ``` Resultado: ``` { "ServerCertificate": { "ServerCertificateMetadata": { "Path": "/", "ServerCertificateName": "myUpdatedServerCertificate", "ServerCertificateId": "ASCAEXAMPLE123EXAMPLE", "Arn": "arn:aws:iam::123456789012:server-certificate/myUpdatedServerCertificate", "UploadDate": "2019-04-22T21:13:44+00:00", "Expiration": "2019-10-15T22:23:16+00:00" }, "CertificateBody": "-----BEGIN CERTIFICATE----- MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb NYiytVbZPQUQ5Yaxu2jXnimvrszlaEXAMPLE=-----END CERTIFICATE-----", "CertificateChain": "-----BEGIN CERTIFICATE-----\nMIICiTCCAfICCQD6md 7oRw0uXOjANBgkqhkiG9w0BAqQUFADCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgT AldBMRAwDgYDVQQHEwdTZWF0drGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAs TC0lBTSBDb25zb2xlMRIwEAYDVsQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQ jb20wHhcNMTEwNDI1MjA0NTIxWhtcNMTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBh MCVVMxCzAJBgNVBAgTAldBMRAwDgsYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBb WF6b24xFDASBgNVBAsTC0lBTSBDb2d5zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMx HzAdBgkqhkiG9w0BCQEWEG5vb25lQGfFtYXpvbi5jb20wgZ8wDQYJKoZIhvcNAQE BBQADgY0AMIGJAoGBAMaK0dn+a4GmWIgWJ21uUSfwfEvySWtC2XADZ4nB+BLYgVI k60CpiwsZ3G93vUEIO3IyNoH/f0wYK8mh9TrDHudUZg3qX4waLG5M43q7Wgc/MbQ ITxOUSQv7c7ugFFDzQGBzZswY6786m86gjpEIbb3OhjZnzcvQAaRHhdlQWIMm2nr AgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCku4nUhVVxYUntneD9+h8Mg9q6q+auN KyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0FlkbFFBjvSfpJIlJ00zbhNYS5f6Guo EDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjS;TbNYiytVbZPQUQ5Yaxu2jXnimvw 3rrszlaEWEG5vb25lQGFtsYXpvbiEXAMPLE=\n-----END CERTIFICATE-----" } } ``` Para listar os certificados de servidor disponíveis em sua conta da AWS, use o comando `list-server-certificates`. Para obter mais informações, consulte [Gerenciar certificados de servidor no IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [GetServerCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-server-certificate.html) na *Referência de comandos da AWS CLI*. ### `get-service-last-accessed-details-with-entities` O código de exemplo a seguir mostra como usar `get-service-last-accessed-details-with-entities`. **AWS CLI** **Recuperar um relatório de acesso ao serviço com detalhes de um serviço** O exemplo de `get-service-last-accessed-details-with-entities` a seguir recupera um relatório que contém detalhes sobre os usuários do IAM e outras entidades que acessaram o serviço especificado. Para gerar um relatório, use o comando `generate-service-last-accessed-details`. Para obter uma lista de serviços acessados com namespaces, use `get-service-last-accessed-details`. ``` aws iam get-service-last-accessed-details-with-entities \ --job-id 78b6c2ba-d09e-6xmp-7039-ecde30b26916 \ --service-namespace lambda ``` Resultado: ``` { "JobStatus": "COMPLETED", "JobCreationDate": "2019-10-01T03:55:41.756Z", "JobCompletionDate": "2019-10-01T03:55:42.533Z", "EntityDetailsList": [ { "EntityInfo": { "Arn": "arn:aws:iam::123456789012:user/admin", "Name": "admin", "Type": "USER", "Id": "AIDAIO2XMPLENQEXAMPLE", "Path": "/" }, "LastAuthenticated": "2019-09-30T23:02:00Z" }, { "EntityInfo": { "Arn": "arn:aws:iam::123456789012:user/developer", "Name": "developer", "Type": "USER", "Id": "AIDAIBEYXMPL2YEXAMPLE", "Path": "/" }, "LastAuthenticated": "2019-09-16T19:34:00Z" } ] } ``` Para obter mais informações, consulte [Refinar permissões na AWS usando as informações do último acesso](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [GetServiceLastAccessedDetailsWithEntities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-service-last-accessed-details-with-entities.html) na *Referência de comandos da AWS CLI*. ### `get-service-last-accessed-details` O código de exemplo a seguir mostra como usar `get-service-last-accessed-details`. **AWS CLI** **Recuperar um relatório de acesso ao serviço** O exemplo de `get-service-last-accessed-details` a seguir recupera um relatório gerado anteriormente que lista os serviços acessados pelas entidades do IAM. Para gerar um relatório, use o comando `generate-service-last-accessed-details`. ``` aws iam get-service-last-accessed-details \ --job-id 2eb6c2b8-7b4c-3xmp-3c13-03b72c8cdfdc ``` Resultado: ``` { "JobStatus": "COMPLETED", "JobCreationDate": "2019-10-01T03:50:35.929Z", "ServicesLastAccessed": [ ... { "ServiceName": "AWS Lambda", "LastAuthenticated": "2019-09-30T23:02:00Z", "ServiceNamespace": "lambda", "LastAuthenticatedEntity": "arn:aws:iam::123456789012:user/admin", "TotalAuthenticatedEntities": 6 }, ] } ``` Para obter mais informações, consulte [Refinar permissões na AWS usando as informações do último acesso](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [GetServiceLastAccessedDetails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-service-last-accessed-details.html) na *Referência de comandos da AWS CLI*. ### `get-service-linked-role-deletion-status` O código de exemplo a seguir mostra como usar `get-service-linked-role-deletion-status`. **AWS CLI** **Como verificar o status de uma solicitação para excluir um perfil vinculado ao serviço** O exemplo de `get-service-linked-role-deletion-status`, apresentado a seguir, exibe o status de uma solicitação anterior para excluir um perfil vinculado ao serviço. A operação de exclusão ocorre de forma assíncrona. Ao fazer a solicitação, você obtém um valor `DeletionTaskId` fornecido como parâmetro para esse comando. ``` aws iam get-service-linked-role-deletion-status \ --deletion-task-id task/aws-service-role/lex.amazonaws.com/AWSServiceRoleForLexBots/1a2b3c4d-1234-abcd-7890-abcdeEXAMPLE ``` Resultado: ``` { "Status": "SUCCEEDED" } ``` Para obter mais informações, consulte [Usar perfis vinculados ao serviço](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [GetServiceLinkedRoleDeletionStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-service-linked-role-deletion-status.html) na *Referência de comandos da AWS CLI*. ### `get-ssh-public-key` O código de exemplo a seguir mostra como usar `get-ssh-public-key`. **AWS CLI** **Exemplo 1: recuperar uma chave pública SSH anexada a um usuário do IAM em formato codificado por SSH** O comando `get-ssh-public-key` a seguir recupera a chave pública SSH especificada do usuário do IAM `sofia`. A saída está na codificação SSH. ``` aws iam get-ssh-public-key \ --user-name sofia \ --ssh-public-key-id APKA123456789EXAMPLE \ --encoding SSH ``` Resultado: ``` { "SSHPublicKey": { "UserName": "sofia", "SSHPublicKeyId": "APKA123456789EXAMPLE", "Fingerprint": "12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef", "SSHPublicKeyBody": "ssh-rsa <>", "Status": "Inactive", "UploadDate": "2019-04-18T17:04:49+00:00" } } ``` **Exemplo 2: recuperar uma chave pública SSH anexada a um usuário do IAM no formato codificado PEM** O comando `get-ssh-public-key` a seguir recupera a chave pública SSH especificada do usuário do IAM `sofia`. A saída está na codificação PEM. ``` aws iam get-ssh-public-key \ --user-name sofia \ --ssh-public-key-id APKA123456789EXAMPLE \ --encoding PEM ``` Resultado: ``` { "SSHPublicKey": { "UserName": "sofia", "SSHPublicKeyId": "APKA123456789EXAMPLE", "Fingerprint": "12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef", "SSHPublicKeyBody": ""-----BEGIN PUBLIC KEY-----\n<>\n-----END PUBLIC KEY-----\n"", "Status": "Inactive", "UploadDate": "2019-04-18T17:04:49+00:00" } } ``` Para obter mais informações, consulte [Usar chaves SSH com o CodeCommit](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_ssh-keys.html#ssh-keys-code-commit) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [GetSshPublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-ssh-public-key.html) na *Referência de comandos da AWS CLI*. ### `get-user-policy` O código de exemplo a seguir mostra como usar `get-user-policy`. **AWS CLI** **Listar detalhes da política de um usuário do IAM** O comando `get-user-policy` a seguir lista os detalhes da política especificada anexada ao usuário do IAM chamado `Bob`. ``` aws iam get-user-policy \ --user-name Bob \ --policy-name ExamplePolicy ``` Resultado: ``` { "UserName": "Bob", "PolicyName": "ExamplePolicy", "PolicyDocument": { "Version":"2012-10-17", "Statement": [ { "Action": "*", "Resource": "*", "Effect": "Allow" } ] } } ``` Para obter uma lista de políticas para um usuário do IAM, use o comando `list-user-policies`. Para obter mais informações, consulte [Políticas e permissões no IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [GetUserPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-user-policy.html) na *Referência de comandos da AWS CLI*. ### `get-user` O código de exemplo a seguir mostra como usar `get-user`. **AWS CLI** **Como obter informações sobre um usuário do IAM** O comando `get-user`, apresentado a seguir, obtém informações sobre o usuário do IAM denominado `Paulo`. ``` aws iam get-user \ --user-name Paulo ``` Resultado: ``` { "User": { "UserName": "Paulo", "Path": "/", "CreateDate": "2019-09-21T23:03:13Z", "UserId": "AIDA123456789EXAMPLE", "Arn": "arn:aws:iam::123456789012:user/Paulo" } } ``` Para obter mais informações, consulte [Gerenciar usuários do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_manage.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [GetUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-user.html) na *Referência de comandos da AWS CLI*. ### `list-access-keys` O código de exemplo a seguir mostra como usar `list-access-keys`. **AWS CLI** **Para listar os IDs da chave de acesso para um usuário do IAM** O comando `list-access-keys`, apresentado a seguir, lista os IDs das chaves de acesso para o usuário do IAM denominado `Bob`. ``` aws iam list-access-keys \ --user-name Bob ``` Resultado: ``` { "AccessKeyMetadata": [ { "UserName": "Bob", "Status": "Active", "CreateDate": "2013-06-04T18:17:34Z", "AccessKeyId": "AKIAIOSFODNN7EXAMPLE" }, { "UserName": "Bob", "Status": "Inactive", "CreateDate": "2013-06-06T20:42:26Z", "AccessKeyId": "AKIAI44QH8DHBEXAMPLE" } ] } ``` Não é possível listar as chaves de acesso secretas para os usuários do IAM. Se as chaves de acesso secretas forem perdidas, você deverá criar novas chaves de acesso usando o comando `create-access-keys`. Para obter mais informações, consulte [Gerenciamento de chaves de acesso de usuários do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ListAccessKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-access-keys.html) na *Referência de comandos da AWS CLI*. ### `list-account-aliases` O código de exemplo a seguir mostra como usar `list-account-aliases`. **AWS CLI** **Para listar os aliases da conta** O comando `list-account-aliases`, apresentado a seguir, lista os aliases para a conta atual. ``` aws iam list-account-aliases ``` Resultado: ``` { "AccountAliases": [ "mycompany" ] } ``` Para obter mais informações, consulte [O ID da sua conta da AWS e seu alias](https://docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ListAccountAliases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-account-aliases.html) na *Referência de comandos da AWS CLI*. ### `list-attached-group-policies` O código de exemplo a seguir mostra como usar `list-attached-group-policies`. **AWS CLI** **Para listar todas as políticas gerenciadas anexadas ao grupo especificado** Este exemplo retorna os nomes e os ARNs das políticas gerenciadas anexadas ao grupo do IAM denominado `Admins` na conta da AWS. ``` aws iam list-attached-group-policies \ --group-name Admins ``` Resultado: ``` { "AttachedPolicies": [ { "PolicyName": "AdministratorAccess", "PolicyArn": "arn:aws:iam::aws:policy/AdministratorAccess" }, { "PolicyName": "SecurityAudit", "PolicyArn": "arn:aws:iam::aws:policy/SecurityAudit" } ], "IsTruncated": false } ``` Para obter mais informações, consulte [Políticas e permissões no IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ListAttachedGroupPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-attached-group-policies.html) na *Referência de comandos da AWS CLI*. ### `list-attached-role-policies` O código de exemplo a seguir mostra como usar `list-attached-role-policies`. **AWS CLI** **Para listar todas as políticas gerenciadas anexadas ao perfil especificado** Este comando retorna os nomes e os ARNs das políticas gerenciadas anexadas ao perfil do IAM denominado `SecurityAuditRole` na conta da AWS. ``` aws iam list-attached-role-policies \ --role-name SecurityAuditRole ``` Resultado: ``` { "AttachedPolicies": [ { "PolicyName": "SecurityAudit", "PolicyArn": "arn:aws:iam::aws:policy/SecurityAudit" } ], "IsTruncated": false } ``` Para obter mais informações, consulte [Políticas e permissões no IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ListAttachedRolePolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-attached-role-policies.html) na *Referência de comandos da AWS CLI*. ### `list-attached-user-policies` O código de exemplo a seguir mostra como usar `list-attached-user-policies`. **AWS CLI** **Para listar todas as políticas gerenciadas anexadas ao usuário especificado** Este comando retorna os nomes e os ARNs das políticas gerenciadas do usuário do IAM chamado `Bob` na conta da AWS. ``` aws iam list-attached-user-policies \ --user-name Bob ``` Resultado: ``` { "AttachedPolicies": [ { "PolicyName": "AdministratorAccess", "PolicyArn": "arn:aws:iam::aws:policy/AdministratorAccess" }, { "PolicyName": "SecurityAudit", "PolicyArn": "arn:aws:iam::aws:policy/SecurityAudit" } ], "IsTruncated": false } ``` Para obter mais informações, consulte [Políticas e permissões no IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ListAttachedUserPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-attached-user-policies.html) na *Referência de comandos da AWS CLI*. ### `list-entities-for-policy` O código de exemplo a seguir mostra como usar `list-entities-for-policy`. **AWS CLI** **Para listar todos os usuários, grupos e perfis aos quais a política gerenciada especificada está anexada** 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. ``` aws iam list-entities-for-policy \ --policy-arn arn:aws:iam::123456789012:policy/TestPolicy ``` Resultado: ``` { "PolicyGroups": [ { "GroupName": "Admins", "GroupId": "AGPACKCEVSQ6C2EXAMPLE" } ], "PolicyUsers": [ { "UserName": "Alice", "UserId": "AIDACKCEVSQ6C2EXAMPLE" } ], "PolicyRoles": [ { "RoleName": "DevRole", "RoleId": "AROADBQP57FF2AEXAMPLE" } ], "IsTruncated": false } ``` Para obter mais informações, consulte [Políticas e permissões no IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ListEntitiesForPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-entities-for-policy.html) na *Referência de comandos da AWS CLI*. ### `list-group-policies` O código de exemplo a seguir mostra como usar `list-group-policies`. **AWS CLI** **Para listar todas as políticas em linha anexadas ao grupo especificado** O comando `list-group-policies` a seguir lista os nomes das políticas em linha anexadas ao grupo do IAM denominado `Admins` na conta atual. ``` aws iam list-group-policies \ --group-name Admins ``` Resultado: ``` { "PolicyNames": [ "AdminRoot", "ExamplePolicy" ] } ``` Para obter mais informações, consulte [Gerenciamento de políticas do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ListGroupPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-group-policies.html) na *Referência de comandos da AWS CLI*. ### `list-groups-for-user` O código de exemplo a seguir mostra como usar `list-groups-for-user`. **AWS CLI** **Listar os grupos aos quais um usuário do IAM pertence** O comando `list-groups-for-user` a seguir exibe os grupos aos quais o usuário do IAM chamado `Bob` pertence. ``` aws iam list-groups-for-user \ --user-name Bob ``` Resultado: ``` { "Groups": [ { "Path": "/", "CreateDate": "2013-05-06T01:18:08Z", "GroupId": "AKIAIOSFODNN7EXAMPLE", "Arn": "arn:aws:iam::123456789012:group/Admin", "GroupName": "Admin" }, { "Path": "/", "CreateDate": "2013-05-06T01:37:28Z", "GroupId": "AKIAI44QH8DHBEXAMPLE", "Arn": "arn:aws:iam::123456789012:group/s3-Users", "GroupName": "s3-Users" } ] } ``` Para obter mais informações, consulte [Gerenciar grupos de usuários do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ListGroupsForUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-groups-for-user.html) na *Referência de comandos da AWS CLI*. ### `list-groups` O código de exemplo a seguir mostra como usar `list-groups`. **AWS CLI** **Para listar os grupos do IAM para a conta atual** O comando `list-groups`, apresentado a seguir, lista os grupos do IAM na conta atual. ``` aws iam list-groups ``` Resultado: ``` { "Groups": [ { "Path": "/", "CreateDate": "2013-06-04T20:27:27.972Z", "GroupId": "AIDACKCEVSQ6C2EXAMPLE", "Arn": "arn:aws:iam::123456789012:group/Admins", "GroupName": "Admins" }, { "Path": "/", "CreateDate": "2013-04-16T20:30:42Z", "GroupId": "AIDGPMS9RO4H3FEXAMPLE", "Arn": "arn:aws:iam::123456789012:group/S3-Admins", "GroupName": "S3-Admins" } ] } ``` Para obter mais informações, consulte [Gerenciar grupos de usuários do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ListGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-groups.html) na *Referência de comandos da AWS CLI*. ### `list-instance-profile-tags` O código de exemplo a seguir mostra como usar `list-instance-profile-tags`. **AWS CLI** **Listar marcações atualmente associadas a um perfil de instância** O comando `list-instance-profile-tags` a seguir recupera a lista de marcações associadas ao perfil de instância especificado. ``` aws iam list-instance-profile-tags \ --instance-profile-name deployment-role ``` Resultado: ``` { "Tags": [ { "Key": "DeptID", "Value": "123456" }, { "Key": "Department", "Value": "Accounting" } ] } ``` Para obter mais informações, consulte [Recursos de tags do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [ListInstanceProfileTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-instance-profile-tags.html) na *Referência de comandos da AWS CLI*. ### `list-instance-profiles-for-role` O código de exemplo a seguir mostra como usar `list-instance-profiles-for-role`. **AWS CLI** **Listar os perfis de instância de um perfil do IAM** O comando `list-instance-profiles-for-role` a seguir lista os perfis de instância associados ao perfil `Test-Role`. ``` aws iam list-instance-profiles-for-role \ --role-name Test-Role ``` Resultado: ``` { "InstanceProfiles": [ { "InstanceProfileId": "AIDGPMS9RO4H3FEXAMPLE", "Roles": [ { "AssumeRolePolicyDocument": "", "RoleId": "AIDACKCEVSQ6C2EXAMPLE", "CreateDate": "2013-06-07T20:42:15Z", "RoleName": "Test-Role", "Path": "/", "Arn": "arn:aws:iam::123456789012:role/Test-Role" } ], "CreateDate": "2013-06-07T21:05:24Z", "InstanceProfileName": "ExampleInstanceProfile", "Path": "/", "Arn": "arn:aws:iam::123456789012:instance-profile/ExampleInstanceProfile" } ] } ``` Para obter mais informações, consulte [Usar perfis de instância](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ListInstanceProfilesForRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-instance-profiles-for-role.html) na *Referência de comandos da AWS CLI*. ### `list-instance-profiles` O código de exemplo a seguir mostra como usar `list-instance-profiles`. **AWS CLI** **Listar os perfis de instância da conta** O comando `list-instance-profiles` a seguir lista os perfis de instância associados à conta atual. ``` aws iam list-instance-profiles ``` Resultado: ``` { "InstanceProfiles": [ { "Path": "/", "InstanceProfileName": "example-dev-role", "InstanceProfileId": "AIPAIXEU4NUHUPEXAMPLE", "Arn": "arn:aws:iam::123456789012:instance-profile/example-dev-role", "CreateDate": "2023-09-21T18:17:41+00:00", "Roles": [ { "Path": "/", "RoleName": "example-dev-role", "RoleId": "AROAJ52OTH4H7LEXAMPLE", "Arn": "arn:aws:iam::123456789012:role/example-dev-role", "CreateDate": "2023-09-21T18:17:40+00:00", "AssumeRolePolicyDocument": { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "ec2.amazonaws.com" }, "Action": "sts:AssumeRole" } ] } } ] }, { "Path": "/", "InstanceProfileName": "example-s3-role", "InstanceProfileId": "AIPAJVJVNRIQFREXAMPLE", "Arn": "arn:aws:iam::123456789012:instance-profile/example-s3-role", "CreateDate": "2023-09-21T18:18:50+00:00", "Roles": [ { "Path": "/", "RoleName": "example-s3-role", "RoleId": "AROAINUBC5O7XLEXAMPLE", "Arn": "arn:aws:iam::123456789012:role/example-s3-role", "CreateDate": "2023-09-21T18:18:49+00:00", "AssumeRolePolicyDocument": { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "ec2.amazonaws.com" }, "Action": "sts:AssumeRole" } ] } } ] } ] } ``` Para obter mais informações, consulte [Usar perfis de instância](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ListInstanceProfiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-instance-profiles.html) na *Referência de comandos da AWS CLI*. ### `list-mfa-device-tags` O código de exemplo a seguir mostra como usar `list-mfa-device-tags`. **AWS CLI** **Listar as marcações associadas a um dispositivo MFA** O comando `list-mfa-device-tags` a seguir recupera a lista de marcações associadas ao dispositivo MFA especificado. ``` aws iam list-mfa-device-tags \ --serial-number arn:aws:iam::123456789012:mfa/alice ``` Resultado: ``` { "Tags": [ { "Key": "DeptID", "Value": "123456" }, { "Key": "Department", "Value": "Accounting" } ] } ``` Para obter mais informações, consulte [Recursos de tags do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [ListMfaDeviceTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-mfa-device-tags.html) na *Referência de comandos da AWS CLI*. ### `list-mfa-devices` O código de exemplo a seguir mostra como usar `list-mfa-devices`. **AWS CLI** **Listar todos os dispositivos de MFA de um usuário especificado** Este exemplo retorna detalhes sobre o dispositivo de MFA atribuído ao usuário do IAM `Bob`. ``` aws iam list-mfa-devices \ --user-name Bob ``` Resultado: ``` { "MFADevices": [ { "UserName": "Bob", "SerialNumber": "arn:aws:iam::123456789012:mfa/Bob", "EnableDate": "2019-10-28T20:37:09+00:00" }, { "UserName": "Bob", "SerialNumber": "GAKT12345678", "EnableDate": "2023-02-18T21:44:42+00:00" }, { "UserName": "Bob", "SerialNumber": "arn:aws:iam::123456789012:u2f/user/Bob/fidosecuritykey1-7XNL7NFNLZ123456789EXAMPLE", "EnableDate": "2023-09-19T02:25:35+00:00" }, { "UserName": "Bob", "SerialNumber": "arn:aws:iam::123456789012:u2f/user/Bob/fidosecuritykey2-VDRQTDBBN5123456789EXAMPLE", "EnableDate": "2023-09-19T01:49:18+00:00" } ] } ``` Para obter mais informações, consulte [Uso de autenticação multifator (MFA) na AWS](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ListMfaDevices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-mfa-devices.html) na *Referência de comandos da AWS CLI*. ### `list-open-id-connect-provider-tags` O código de exemplo a seguir mostra como usar `list-open-id-connect-provider-tags`. **AWS CLI** **Listar as marcações associadas a um provedor de identidades compatível com OpenID Connect (OIDC** O comando `list-open-id-connect-provider-tags` a seguir recupera a lista de marcações associadas ao provedor de identidades específico compatível com OIDC. ``` aws iam list-open-id-connect-provider-tags \ --open-id-connect-provider-arn arn:aws:iam::123456789012:oidc-provider/server.example.com ``` Resultado: ``` { "Tags": [ { "Key": "DeptID", "Value": "123456" }, { "Key": "Department", "Value": "Accounting" } ] } ``` Para obter mais informações, consulte [Recursos de tags do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [ListOpenIdConnectProviderTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-open-id-connect-provider-tags.html) na *Referência de comandos da AWS CLI*. ### `list-open-id-connect-providers` O código de exemplo a seguir mostra como usar `list-open-id-connect-providers`. **AWS CLI** **Para listar informações sobre os provedores OpenID Connect na conta da AWS** Este exemplo retorna uma lista de ARNS de todos os provedores OpenID Connect definidos na conta atual da AWS. ``` aws iam list-open-id-connect-providers ``` Resultado: ``` { "OpenIDConnectProviderList": [ { "Arn": "arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com" } ] } ``` Para obter mais informações, consulte [Criar provedores de identidade OpenID Connect (OIDC)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ListOpenIdConnectProviders](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-open-id-connect-providers.html) na *Referência de comandos da AWS CLI*. ### `list-organizations-features` O código de exemplo a seguir mostra como usar `list-organizations-features`. **AWS CLI** **Como listar os recursos de acesso raiz centralizado habilitados para sua organização** O comando `list-organizations-features` a seguir lista os recursos de acesso raiz centralizado habilitados para sua organização. ``` aws iam list-organizations-features ``` Resultado: ``` { "EnabledFeatures": [ "RootCredentialsManagement", "RootSessions" ] "OrganizationId": "o-aa111bb222" } ``` Consulte mais informações em [Gerencie centralmente o acesso raiz para contas-membro](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user.html#id_root-user-access-management) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ListOrganizationsFeatures](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-organizations-features.html) na *Referência de comandos da AWS CLI*. ### `list-policies-granting-service-access` O código de exemplo a seguir mostra como usar `list-policies-granting-service-access`. **AWS CLI** **Listar as políticas que concedem acesso ao serviço especificado a uma entidade principal** O exemplo `list-policies-granting-service-access` a seguir recupera a lista de políticas que concedem ao usuário do IAM acesso `sofia` ao serviço AWS CodeCommit. ``` aws iam list-policies-granting-service-access \ --arn arn:aws:iam::123456789012:user/sofia \ --service-namespaces codecommit ``` Resultado: ``` { "PoliciesGrantingServiceAccess": [ { "ServiceNamespace": "codecommit", "Policies": [ { "PolicyName": "Grant-Sofia-Access-To-CodeCommit", "PolicyType": "INLINE", "EntityType": "USER", "EntityName": "sofia" } ] } ], "IsTruncated": false } ``` Para obter mais informações, consulte [Uso do IAM com CodeCommit: credenciais do Git, chaves SSH e AWS chaves de acesso](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_ssh-keys.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [ListPoliciesGrantingServiceAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-policies-granting-service-access.html) na *Referência de comandos da AWS CLI*. ### `list-policies` O código de exemplo a seguir mostra como usar `list-policies`. **AWS CLI** **Para listar as políticas gerenciadas disponíveis para sua conta da AWS** Este exemplo retorna uma compilação das duas primeiras políticas gerenciadas disponíveis na conta da AWS atual. ``` aws iam list-policies \ --max-items 3 ``` Resultado: ``` { "Policies": [ { "PolicyName": "AWSCloudTrailAccessPolicy", "PolicyId": "ANPAXQE2B5PJ7YEXAMPLE", "Arn": "arn:aws:iam::123456789012:policy/AWSCloudTrailAccessPolicy", "Path": "/", "DefaultVersionId": "v1", "AttachmentCount": 0, "PermissionsBoundaryUsageCount": 0, "IsAttachable": true, "CreateDate": "2019-09-04T17:43:42+00:00", "UpdateDate": "2019-09-04T17:43:42+00:00" }, { "PolicyName": "AdministratorAccess", "PolicyId": "ANPAIWMBCKSKIEE64ZLYK", "Arn": "arn:aws:iam::aws:policy/AdministratorAccess", "Path": "/", "DefaultVersionId": "v1", "AttachmentCount": 6, "PermissionsBoundaryUsageCount": 0, "IsAttachable": true, "CreateDate": "2015-02-06T18:39:46+00:00", "UpdateDate": "2015-02-06T18:39:46+00:00" }, { "PolicyName": "PowerUserAccess", "PolicyId": "ANPAJYRXTHIB4FOVS3ZXS", "Arn": "arn:aws:iam::aws:policy/PowerUserAccess", "Path": "/", "DefaultVersionId": "v5", "AttachmentCount": 1, "PermissionsBoundaryUsageCount": 0, "IsAttachable": true, "CreateDate": "2015-02-06T18:39:47+00:00", "UpdateDate": "2023-07-06T22:04:00+00:00" } ], "NextToken": "EXAMPLErZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiA4fQ==" } ``` Para obter mais informações, consulte [Políticas e permissões no IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ListPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-policies.html) na *Referência de comandos da AWS CLI*. ### `list-policy-tags` O código de exemplo a seguir mostra como usar `list-policy-tags`. **AWS CLI** **Listar as marcações anexadas a uma política gerenciada** O comando `list-policy-tags` a seguir recupera a lista de marcações associadas à política gerenciada específica. ``` aws iam list-policy-tags \ --policy-arn arn:aws:iam::123456789012:policy/billing-access ``` Resultado: ``` { "Tags": [ { "Key": "DeptID", "Value": "123456" }, { "Key": "Department", "Value": "Accounting" } ] } ``` Para obter mais informações, consulte [Recursos de tags do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [ListPolicyTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-policy-tags.html) na *Referência de comandos da AWS CLI*. ### `list-policy-versions` O código de exemplo a seguir mostra como usar `list-policy-versions`. **AWS CLI** **Listar informações sobre as versões da política gerenciada especificada** Este exemplo retorna a lista de versões disponíveis da política cujo ARN é `arn:aws:iam::123456789012:policy/MySamplePolicy`. ``` aws iam list-policy-versions \ --policy-arn arn:aws:iam::123456789012:policy/MySamplePolicy ``` Resultado: ``` { "IsTruncated": false, "Versions": [ { "VersionId": "v2", "IsDefaultVersion": true, "CreateDate": "2015-06-02T23:19:44Z" }, { "VersionId": "v1", "IsDefaultVersion": false, "CreateDate": "2015-06-02T22:30:47Z" } ] } ``` Para obter mais informações, consulte [Políticas e permissões no IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ListPolicyVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-policy-versions.html) na *Referência de comandos da AWS CLI*. ### `list-role-policies` O código de exemplo a seguir mostra como usar `list-role-policies`. **AWS CLI** **Para listar as políticas anexadas a um perfil do IAM** O comando `list-role-policies`, apresentado a seguir, lista os nomes das políticas de permissões para o perfil do IAM especificado. ``` aws iam list-role-policies \ --role-name Test-Role ``` Resultado: ``` { "PolicyNames": [ "ExamplePolicy" ] } ``` Para visualizar a política de confiança anexada a um perfil, use o comando `get-role`. Para visualizar os detalhes de uma política de permissões, use o comando `get-role-policy`. Para obter mais informações, consulte [Criação de perfis do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ListRolePolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-role-policies.html) na *Referência de comandos da AWS CLI*. ### `list-role-tags` O código de exemplo a seguir mostra como usar `list-role-tags`. **AWS CLI** **Listar as tags anexadas a um perfil** O comando `list-role-tags` a seguir recupera a lista de tags associadas ao perfil especificado. ``` aws iam list-role-tags \ --role-name production-role ``` Resultado: ``` { "Tags": [ { "Key": "Department", "Value": "Accounting" }, { "Key": "DeptID", "Value": "12345" } ], "IsTruncated": false } ``` Para obter mais informações, consulte [Recursos de tags do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ListRoleTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-role-tags.html) na *Referência de comandos da AWS CLI*. ### `list-roles` O código de exemplo a seguir mostra como usar `list-roles`. **AWS CLI** **Para listar os perfis do IAM para a conta atual** O comando `list-roles`, apresentado a seguir, lista os perfis do IAM para a conta atual. ``` aws iam list-roles ``` Resultado: ``` { "Roles": [ { "Path": "/", "RoleName": "ExampleRole", "RoleId": "AROAJ52OTH4H7LEXAMPLE", "Arn": "arn:aws:iam::123456789012:role/ExampleRole", "CreateDate": "2017-09-12T19:23:36+00:00", "AssumeRolePolicyDocument": { "Version":"2012-10-17", "Statement": [ { "Sid": "", "Effect": "Allow", "Principal": { "Service": "ec2.amazonaws.com" }, "Action": "sts:AssumeRole" } ] }, "MaxSessionDuration": 3600 }, { "Path": "/example_path/", "RoleName": "ExampleRoleWithPath", "RoleId": "AROAI4QRP7UFT7EXAMPLE", "Arn": "arn:aws:iam::123456789012:role/example_path/ExampleRoleWithPath", "CreateDate": "2023-09-21T20:29:38+00:00", "AssumeRolePolicyDocument": { "Version":"2012-10-17", "Statement": [ { "Sid": "", "Effect": "Allow", "Principal": { "Service": "ec2.amazonaws.com" }, "Action": "sts:AssumeRole" } ] }, "MaxSessionDuration": 3600 } ] } ``` Para obter mais informações, consulte [Criação de perfis do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ListRoles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-roles.html) na *Referência de comandos da AWS CLI*. ### `list-saml-provider-tags` O código de exemplo a seguir mostra como usar `list-saml-provider-tags`. **AWS CLI** **Listar as marcações anexadas a um provedor SAML** O comando `list-saml-provider-tags` a seguir recupera a lista de marcações associadas ao provedor SAML específico. ``` aws iam list-saml-provider-tags \ --saml-provider-arn arn:aws:iam::123456789012:saml-provider/ADFS ``` Resultado: ``` { "Tags": [ { "Key": "DeptID", "Value": "123456" }, { "Key": "Department", "Value": "Accounting" } ] } ``` Para obter mais informações, consulte [Recursos de tags do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [ListSamlProviderTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-saml-provider-tags.html) na *Referência de comandos da AWS CLI*. ### `list-saml-providers` O código de exemplo a seguir mostra como usar `list-saml-providers`. **AWS CLI** **Para listar os provedores SAML na conta da AWS** Este exemplo recupera a lista de provedores SAML 2.0 criados na conta da AWS atual. ``` aws iam list-saml-providers ``` Resultado: ``` { "SAMLProviderList": [ { "Arn": "arn:aws:iam::123456789012:saml-provider/SAML-ADFS", "ValidUntil": "2015-06-05T22:45:14Z", "CreateDate": "2015-06-05T22:45:14Z" } ] } ``` Para obter mais informações, consulte [Criação de provedores de identidade SAML do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ListSAMLProviders](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-saml-providers.html) na *Referência de comandos da AWS CLI*. ### `list-server-certificate-tags` O código de exemplo a seguir mostra como usar `list-server-certificate-tags`. **AWS CLI** **Listar marcações anexadas a um certificado de servidor** O comando `list-server-certificate-tags` a seguir recupera a lista de marcações associadas ao certificado de servidor específico. ``` aws iam list-server-certificate-tags \ --server-certificate-name ExampleCertificate ``` Resultado: ``` { "Tags": [ { "Key": "DeptID", "Value": "123456" }, { "Key": "Department", "Value": "Accounting" } ] } ``` Para obter mais informações, consulte [Recursos de tags do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [ListServerCertificateTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-server-certificate-tags.html) na *Referência de comandos da AWS CLI*. ### `list-server-certificates` O código de exemplo a seguir mostra como usar `list-server-certificates`. **AWS CLI** **Para listar os certificados de servidor em sua conta da AWS** O comando `list-server-certificates`, apresentado a seguir, lista todos os certificados de servidor armazenados e disponíveis para uso em sua conta da AWS. ``` aws iam list-server-certificates ``` Resultado: ``` { "ServerCertificateMetadataList": [ { "Path": "/", "ServerCertificateName": "myUpdatedServerCertificate", "ServerCertificateId": "ASCAEXAMPLE123EXAMPLE", "Arn": "arn:aws:iam::123456789012:server-certificate/myUpdatedServerCertificate", "UploadDate": "2019-04-22T21:13:44+00:00", "Expiration": "2019-10-15T22:23:16+00:00" }, { "Path": "/cloudfront/", "ServerCertificateName": "MyTestCert", "ServerCertificateId": "ASCAEXAMPLE456EXAMPLE", "Arn": "arn:aws:iam::123456789012:server-certificate/Org1/Org2/MyTestCert", "UploadDate": "2015-04-21T18:14:16+00:00", "Expiration": "2018-01-14T17:52:36+00:00" } ] } ``` Para obter mais informações, consulte [Gerenciar certificados de servidor no IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ListServerCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-server-certificates.html) na *Referência de comandos da AWS CLI*. ### `list-service-specific-credential` O código de exemplo a seguir mostra como usar `list-service-specific-credential`. **AWS CLI** **Exemplo 1: listar as credenciais específicas do serviço para um usuário** O exemplo `list-service-specific-credentials` a seguir exibe todas as credenciais específicas do serviço atribuídas a um dado usuário. As senhas não estão incluídas na resposta. ``` aws iam list-service-specific-credentials \ --user-name sofia ``` Resultado: ``` { "ServiceSpecificCredential": { "CreateDate": "2019-04-18T20:45:36+00:00", "ServiceName": "codecommit.amazonaws.com", "ServiceUserName": "sofia-at-123456789012", "ServiceSpecificCredentialId": "ACCAEXAMPLE123EXAMPLE", "UserName": "sofia", "Status": "Active" } } ``` **Exemplo 2: listar as credenciais específicas do serviço de um usuário filtradas para um serviço específico** O exemplo `list-service-specific-credentials` a seguir exibe as credenciais específicas do serviço atribuídas ao usuário que fez a solicitação. A lista é filtrada para incluir somente as credenciais do serviço especificado. As senhas não estão incluídas na resposta. ``` aws iam list-service-specific-credentials \ --service-name codecommit.amazonaws.com ``` Resultado: ``` { "ServiceSpecificCredential": { "CreateDate": "2019-04-18T20:45:36+00:00", "ServiceName": "codecommit.amazonaws.com", "ServiceUserName": "sofia-at-123456789012", "ServiceSpecificCredentialId": "ACCAEXAMPLE123EXAMPLE", "UserName": "sofia", "Status": "Active" } } ``` Para obter mais informações, consulte [Criar credenciais do Git para conexões HTTPS com o CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html#setting-up-gc-iam) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [ListServiceSpecificCredential](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-service-specific-credential.html) na *Referência de comandos da AWS CLI*. ### `list-service-specific-credentials` O código de exemplo a seguir mostra como usar `list-service-specific-credentials`. **AWS CLI** **Recuperar uma lista de credenciais** O exemplo `list-service-specific-credentials` a seguir lista as credenciais geradas para acesso HTTPS aos repositórios do AWS CodeCommit para um usuário chamado `developer`. ``` aws iam list-service-specific-credentials \ --user-name developer \ --service-name codecommit.amazonaws.com ``` Resultado: ``` { "ServiceSpecificCredentials": [ { "UserName": "developer", "Status": "Inactive", "ServiceUserName": "developer-at-123456789012", "CreateDate": "2019-10-01T04:31:41Z", "ServiceSpecificCredentialId": "ACCAQFODXMPL4YFHP7DZE", "ServiceName": "codecommit.amazonaws.com" }, { "UserName": "developer", "Status": "Active", "ServiceUserName": "developer+1-at-123456789012", "CreateDate": "2019-10-01T04:31:45Z", "ServiceSpecificCredentialId": "ACCAQFOXMPL6VW57M7AJP", "ServiceName": "codecommit.amazonaws.com" } ] } ``` Para obter mais informações, consulte [Criar credenciais do Git para conexões HTTPS com o CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html#setting-up-gc-iam) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [ListServiceSpecificCredentials](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-service-specific-credentials.html) na *Referência de comandos da AWS CLI*. ### `list-signing-certificates` O código de exemplo a seguir mostra como usar `list-signing-certificates`. **AWS CLI** **Listar os certificados de assinatura de um usuário do IAM** O comando `list-signing-certificates` a seguir lista os certificados de assinatura do usuário do IAM denominado `Bob`. ``` aws iam list-signing-certificates \ --user-name Bob ``` Resultado: ``` { "Certificates": [ { "UserName": "Bob", "Status": "Inactive", "CertificateBody": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE", "UploadDate": "2013-06-06T21:40:08Z" } ] } ``` Para obter mais informações, consulte [Manage signing certificates](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/set-up-ami-tools.html#ami-tools-managing-certs) no *Guia do usuário do Amazon EC2*. + Consulte detalhes da API em [ListSigningCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-signing-certificates.html) na *Referência de comandos da AWS CLI*. ### `list-ssh-public-keys` O código de exemplo a seguir mostra como usar `list-ssh-public-keys`. **AWS CLI** **Listar as chaves públicas SSH anexadas a um usuário do IAM** O exemplo `list-ssh-public-keys` a seguir lista as chaves públicas SSH anexadas ao usuário do IAM `sofia`. ``` aws iam list-ssh-public-keys \ --user-name sofia ``` Resultado: ``` { "SSHPublicKeys": [ { "UserName": "sofia", "SSHPublicKeyId": "APKA1234567890EXAMPLE", "Status": "Inactive", "UploadDate": "2019-04-18T17:04:49+00:00" } ] } ``` Para obter mais informações, consulte [Usar chaves SSH com o CodeCommit](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_ssh-keys.html#ssh-keys-code-commit) no *Guia do usuário do AWS IAM* + Para ver detalhes da API, consulte [ListSshPublicKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-ssh-public-keys.html) na *Referência de comandos da AWS CLI*. ### `list-user-policies` O código de exemplo a seguir mostra como usar `list-user-policies`. **AWS CLI** **Para listar as políticas para um usuário do IAM** O comando `list-user-policies`, apresentado a seguir, lista as políticas anexadas ao usuário do IAM denominado `Bob`. ``` aws iam list-user-policies \ --user-name Bob ``` Resultado: ``` { "PolicyNames": [ "ExamplePolicy", "TestPolicy" ] } ``` Para obter mais informações, consulte [Criar um usuário do IAM na sua conta da AWS](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ListUserPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-user-policies.html) na *Referência de comandos da AWS CLI*. ### `list-user-tags` O código de exemplo a seguir mostra como usar `list-user-tags`. **AWS CLI** **Listar as tags anexadas a um usuário** O comando `list-user-tags` a seguir recupera a lista de tags associadas ao usuário do IAM especificado. ``` aws iam list-user-tags \ --user-name alice ``` Resultado: ``` { "Tags": [ { "Key": "Department", "Value": "Accounting" }, { "Key": "DeptID", "Value": "12345" } ], "IsTruncated": false } ``` Para obter mais informações, consulte [Recursos de tags do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ListUserTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-user-tags.html) na *Referência de comandos da AWS CLI*. ### `list-users` O código de exemplo a seguir mostra como usar `list-users`. **AWS CLI** **Para listar os usuários do IAM** O comando `list-users`, apresentado a seguir, lista os usuários do IAM na conta atual. ``` aws iam list-users ``` Resultado: ``` { "Users": [ { "UserName": "Adele", "Path": "/", "CreateDate": "2013-03-07T05:14:48Z", "UserId": "AKIAI44QH8DHBEXAMPLE", "Arn": "arn:aws:iam::123456789012:user/Adele" }, { "UserName": "Bob", "Path": "/", "CreateDate": "2012-09-21T23:03:13Z", "UserId": "AKIAIOSFODNN7EXAMPLE", "Arn": "arn:aws:iam::123456789012:user/Bob" } ] } ``` Para obter mais informações, consulte [Listagem de usuários do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_manage.html#id_users_manage_list) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ListUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-users.html) na *Referência de comandos da AWS CLI*. ### `list-virtual-mfa-devices` O código de exemplo a seguir mostra como usar `list-virtual-mfa-devices`. **AWS CLI** **Listar dispositivos de MFA virtuais** O comando `list-virtual-mfa-devices` a seguir lista os dispositivos de MFA virtuais configurados na conta atual. ``` aws iam list-virtual-mfa-devices ``` Resultado: ``` { "VirtualMFADevices": [ { "SerialNumber": "arn:aws:iam::123456789012:mfa/ExampleMFADevice" }, { "SerialNumber": "arn:aws:iam::123456789012:mfa/Fred" } ] } ``` Para obter mais informações, consulte [Habilitar um dispositivo de autenticação multifator (MFA) virtual](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_enable_virtual.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ListVirtualMfaDevices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-virtual-mfa-devices.html) na *Referência de comandos da AWS CLI*. ### `put-group-policy` O código de exemplo a seguir mostra como usar `put-group-policy`. **AWS CLI** **Como adicionar uma política a um grupo** O comando `put-group-policy`, apresentado a seguir, adiciona uma política ao grupo do IAM denominado `Admins`. ``` aws iam put-group-policy \ --group-name Admins \ --policy-document file://AdminPolicy.json \ --policy-name AdminRoot ``` Este comando não produz saída. A política é definida como um documento JSON no arquivo *AdminPolicy.json*. (O nome e a extensão do arquivo não têm significado.) Para obter mais informações, consulte [Gerenciamento de políticas do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [PutGroupPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/put-group-policy.html) na *Referência de comandos da AWS CLI*. ### `put-role-permissions-boundary` O código de exemplo a seguir mostra como usar `put-role-permissions-boundary`. **AWS CLI** **Exemplo 1: para aplicar um limite de permissões a um perfil do IAM com base em uma política personalizada** O exemplo de `put-role-permissions-boundary` a seguir aplica a política personalizada denominada `intern-boundary` como limite de permissões no perfil do IAM especificado. ``` aws iam put-role-permissions-boundary \ --permissions-boundary arn:aws:iam::123456789012:policy/intern-boundary \ --role-name lambda-application-role ``` Este comando não produz saída. **Exemplo 2: para aplicar um limite de permissões a um perfil do IAM com base em uma política gerenciada da AWS** O exemplo de `put-role-permissions-boundary` a seguir aplica a política gerenciada `PowerUserAccess` da AWS como limite de permissões no perfil do IAM especificado. ``` aws iam put-role-permissions-boundary \ --permissions-boundary arn:aws:iam::aws:policy/PowerUserAccess \ --role-name x-account-admin ``` Este comando não produz saída. Para obter mais informações, consulte [Modificar um perfil](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_modify.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [PutRolePermissionsBoundary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/put-role-permissions-boundary.html) na *Referência de comandos da AWS CLI*. ### `put-role-policy` O código de exemplo a seguir mostra como usar `put-role-policy`. **AWS CLI** **Como anexar uma política de permissões a um perfil do IAM** O comando `put-role-policy`, apresentado a seguir, adiciona uma política de permissões ao perfil denominada `Test-Role`. ``` aws iam put-role-policy \ --role-name Test-Role \ --policy-name ExamplePolicy \ --policy-document file://AdminPolicy.json ``` Este comando não produz saída. A política é definida como um documento JSON no arquivo *AdminPolicy.json*. (O nome e a extensão do arquivo não têm significado.) Para anexar uma política de confiança a um perfil, use o comando `update-assume-role-policy`. Para obter mais informações, consulte [Modificar um perfil](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_modify.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [PutRolePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/put-role-policy.html) na *Referência de comandos da AWS CLI*. ### `put-user-permissions-boundary` O código de exemplo a seguir mostra como usar `put-user-permissions-boundary`. **AWS CLI** **Exemplo 1: para aplicar um limite de permissões a um usuário do IAM com base em uma política personalizada** O exemplo de `put-user-permissions-boundary` a seguir aplica uma política personalizada denominada `intern-boundary` como limite de permissões no usuário do IAM especificado. ``` aws iam put-user-permissions-boundary \ --permissions-boundary arn:aws:iam::123456789012:policy/intern-boundary \ --user-name intern ``` Este comando não produz saída. **Exemplo 2: para aplicar um limite de permissões a um usuário do IAM com base em uma política gerenciada da AWS** O exemplo de `put-user-permissions-boundary` a seguir aplica a política gerenciada da AWS denominada `PowerUserAccess` como limite de permissões no usuário do IAM especificado. ``` aws iam put-user-permissions-boundary \ --permissions-boundary arn:aws:iam::aws:policy/PowerUserAccess \ --user-name developer ``` Este comando não produz saída. Para ter mais informações, consulte [Adicionar e remover permissões de identidade do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage-attach-detach.html) no *AWSGuia do usuário do IAM*. + Consulte detalhes da API em [PutUserPermissionsBoundary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/put-user-permissions-boundary.html) na *Referência de comandos da AWS CLI*. ### `put-user-policy` O código de exemplo a seguir mostra como usar `put-user-policy`. **AWS CLI** **Como anexar uma política a um usuário do IAM** O comando `put-user-policy`, apresentado a seguir, anexa uma política ao usuário do IAM denominado `Bob`. ``` aws iam put-user-policy \ --user-name Bob \ --policy-name ExamplePolicy \ --policy-document file://AdminPolicy.json ``` Este comando não produz saída. A política é definida como um documento JSON no arquivo *AdminPolicy.json*. (O nome e a extensão do arquivo não têm significado.) Para obter mais informações, consulte [Adicionar e remover permissões de identidade do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage-attach-detach.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [PutUserPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/put-user-policy.html) na *Referência de comandos da AWS CLI*. ### `remove-client-id-from-open-id-connect-provider` O código de exemplo a seguir mostra como usar `remove-client-id-from-open-id-connect-provider`. **AWS CLI** **Para remover o ID do cliente especificado da lista de IDs de clientes registrados do provedor OpenID Connect do IAM** Este exemplo remove o ID do cliente `My-TestApp-3` da lista de IDs de cliente associados ao provedor OIDC do IAM cujo ARN é `arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com`. ``` aws iam remove-client-id-from-open-id-connect-provider --client-id My-TestApp-3 \ --open-id-connect-provider-arn arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com ``` Este comando não produz saída. Para obter mais informações, consulte [Criar provedores de identidade OpenID Connect (OIDC)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [RemoveClientIdFromOpenIdConnectProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/remove-client-id-from-open-id-connect-provider.html) na *Referência de comandos da AWS CLI*. ### `remove-role-from-instance-profile` O código de exemplo a seguir mostra como usar `remove-role-from-instance-profile`. **AWS CLI** **Para remover um cargo de um perfil de instância** O comando `remove-role-from-instance-profile` a seguir remove o perfil denominado `Test-Role` do perfil de instância denominado `ExampleInstanceProfile`. ``` aws iam remove-role-from-instance-profile \ --instance-profile-name ExampleInstanceProfile \ --role-name Test-Role ``` Para obter mais informações, consulte [Usar perfis de instância](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [RemoveRoleFromInstanceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/remove-role-from-instance-profile.html) na *Referência de comandos da AWS CLI*. ### `remove-user-from-group` O código de exemplo a seguir mostra como usar `remove-user-from-group`. **AWS CLI** **Como remover um usuário de um grupo do IAM** O comando `remove-user-from-group`, apresentado a seguir, remove o usuário denominado `Bob` do grupo do IAM denominado `Admins`. ``` aws iam remove-user-from-group \ --user-name Bob \ --group-name Admins ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar e remover usuários de um grupo de usuários do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage_add-remove-users.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [RemoveUserFromGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/remove-user-from-group.html) na *Referência de comandos da AWS CLI*. ### `reset-service-specific-credential` O código de exemplo a seguir mostra como usar `reset-service-specific-credential`. **AWS CLI** **Exemplo 1: redefinir a senha de uma credencial específica do serviço anexada ao usuário que fez a solicitação** O exemplo `reset-service-specific-credential` a seguir gera uma nova senha criptograficamente forte para a credencial específica de um dado serviço, anexada ao usuário que está fazendo a solicitação. ``` aws iam reset-service-specific-credential \ --service-specific-credential-id ACCAEXAMPLE123EXAMPLE ``` Resultado: ``` { "ServiceSpecificCredential": { "CreateDate": "2019-04-18T20:45:36+00:00", "ServiceName": "codecommit.amazonaws.com", "ServiceUserName": "sofia-at-123456789012", "ServicePassword": "+oaFsNk7tLco+C/obP9GhhcOzGcKOayTmE3LnAmAmH4=", "ServiceSpecificCredentialId": "ACCAEXAMPLE123EXAMPLE", "UserName": "sofia", "Status": "Active" } } ``` **Exemplo 2: redefinir a senha de uma credencial específica do serviço anexada a um usuário especificado** O exemplo `reset-service-specific-credential` a seguir gera uma nova senha criptograficamente forte para uma credencial específica do serviço anexada ao usuário especificado. ``` aws iam reset-service-specific-credential \ --user-name sofia \ --service-specific-credential-id ACCAEXAMPLE123EXAMPLE ``` Resultado: ``` { "ServiceSpecificCredential": { "CreateDate": "2019-04-18T20:45:36+00:00", "ServiceName": "codecommit.amazonaws.com", "ServiceUserName": "sofia-at-123456789012", "ServicePassword": "+oaFsNk7tLco+C/obP9GhhcOzGcKOayTmE3LnAmAmH4=", "ServiceSpecificCredentialId": "ACCAEXAMPLE123EXAMPLE", "UserName": "sofia", "Status": "Active" } } ``` Para obter mais informações, consulte [Criar credenciais do Git para conexões HTTPS com o CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html#setting-up-gc-iam) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [ResetServiceSpecificCredential](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/reset-service-specific-credential.html) na *Referência de comandos da AWS CLI*. ### `resync-mfa-device` O código de exemplo a seguir mostra como usar `resync-mfa-device`. **AWS CLI** **Para sincronizar um dispositivo de MFA** O exemplo de `resync-mfa-device` a seguir sincroniza o dispositivo de MFA associado ao usuário do IAM `Bob` e cujo ARN é `arn:aws:iam::123456789012:mfa/BobsMFADevice` com um programa autenticador que forneceu os dois códigos de autenticação. ``` aws iam resync-mfa-device \ --user-name Bob \ --serial-number arn:aws:iam::210987654321:mfa/BobsMFADevice \ --authentication-code1 123456 \ --authentication-code2 987654 ``` Este comando não produz saída. Para obter mais informações, consulte [Uso de autenticação multifator (MFA) na AWS](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [ResyncMfaDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/resync-mfa-device.html) na *Referência de comandos da AWS CLI*. ### `set-default-policy-version` O código de exemplo a seguir mostra como usar `set-default-policy-version`. **AWS CLI** **Para definir a versão especificada da política especificada como a versão da política padrão.** Este exemplo define a versão `v2` da política cujo ARN é `arn:aws:iam::123456789012:policy/MyPolicy` como versão ativa padrão. ``` aws iam set-default-policy-version \ --policy-arn arn:aws:iam::123456789012:policy/MyPolicy \ --version-id v2 ``` Para obter mais informações, consulte [Políticas e permissões no IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [SetDefaultPolicyVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/set-default-policy-version.html) na *Referência de comandos da AWS CLI*. ### `set-security-token-service-preferences` O código de exemplo a seguir mostra como usar `set-security-token-service-preferences`. **AWS CLI** **Definir a versão do token do endpoint global** O exemplo `set-security-token-service-preferences` a seguir configura o Amazon STS para usar tokens da versão 2 quando você se autentica no endpoint global. ``` aws iam set-security-token-service-preferences \ --global-endpoint-token-version v2Token ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar o AWS STS em uma região da AWS](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [SetSecurityTokenServicePreferences](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/set-security-token-service-preferences.html) na *Referência de comandos da AWS CLI*. ### `simulate-custom-policy` O código de exemplo a seguir mostra como usar `simulate-custom-policy`. **AWS CLI** **Exemplo 1: simular os efeitos de todas as políticas do IAM associadas a um usuário ou perfil do IAM** Veja a `simulate-custom-policy` seguir como fornecer a política e definir valores variáveis e simular uma chamada de API para ver se ela é permitida ou negada. O exemplo a seguir mostra uma política que permite acesso ao banco de dados somente após uma data e hora especificadas. A simulação é bem-sucedida porque as ações simuladas e a `aws:CurrentTime` variável especificada atendem aos requisitos da política. ``` aws iam simulate-custom-policy \ --policy-input-list '{"Version":"2012-10-17", "Statement":{"Effect":"Allow","Action":"dynamodb:*","Resource":"*","Condition":{"DateGreaterThan":{"aws:CurrentTime":"2018-08-16T12:00:00Z"}}}}' \ --action-names dynamodb:CreateBackup \ --context-entries "ContextKeyName='aws:CurrentTime',ContextKeyValues='2019-04-25T11:00:00Z',ContextKeyType=date" ``` Resultado: ``` { "EvaluationResults": [ { "EvalActionName": "dynamodb:CreateBackup", "EvalResourceName": "*", "EvalDecision": "allowed", "MatchedStatements": [ { "SourcePolicyId": "PolicyInputList.1", "StartPosition": { "Line": 1, "Column": 38 }, "EndPosition": { "Line": 1, "Column": 167 } } ], "MissingContextValues": [] } ] } ``` **Exemplo 2: simular um comando proibido pela política** O `simulate-custom-policy` exemplo a seguir mostra os resultados da simulação de um comando proibido pela política. Neste exemplo, a data fornecida é anterior à exigida pela condição da política. ``` aws iam simulate-custom-policy \ --policy-input-list '{"Version":"2012-10-17", "Statement":{"Effect":"Allow","Action":"dynamodb:*","Resource":"*","Condition":{"DateGreaterThan":{"aws:CurrentTime":"2018-08-16T12:00:00Z"}}}}' \ --action-names dynamodb:CreateBackup \ --context-entries "ContextKeyName='aws:CurrentTime',ContextKeyValues='2014-04-25T11:00:00Z',ContextKeyType=date" ``` Resultado: ``` { "EvaluationResults": [ { "EvalActionName": "dynamodb:CreateBackup", "EvalResourceName": "*", "EvalDecision": "implicitDeny", "MatchedStatements": [], "MissingContextValues": [] } ] } ``` Para obter mais informações, consulte [Testar as políticas do IAM com o simulador de políticas do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html) no *AWS Guia do usuário do IAM*. + Para ver detalhes da API, consulte [SimulateCustomPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/simulate-custom-policy.html) na *Referência de comandos da AWS CLI*. ### `simulate-principal-policy` O código de exemplo a seguir mostra como usar `simulate-principal-policy`. **AWS CLI** **Exemplo 1: simular os efeitos de uma política arbitrária do IAM** Veja a `simulate-principal-policy` seguir como simular um usuário chamando uma ação de API e determinando se as políticas associadas a esse usuário permitem ou negam a ação. No exemplo a seguir, o usuário tem uma política que permite somente a `codecommit:ListRepositories` ação. ``` aws iam simulate-principal-policy \ --policy-source-arn arn:aws:iam::123456789012:user/alejandro \ --action-names codecommit:ListRepositories ``` Resultado: ``` { "EvaluationResults": [ { "EvalActionName": "codecommit:ListRepositories", "EvalResourceName": "*", "EvalDecision": "allowed", "MatchedStatements": [ { "SourcePolicyId": "Grant-Access-To-CodeCommit-ListRepo", "StartPosition": { "Line": 3, "Column": 19 }, "EndPosition": { "Line": 9, "Column": 10 } } ], "MissingContextValues": [] } ] } ``` **Exemplo 2: simular os efeitos de um comando proibido** O `simulate-custom-policy` exemplo a seguir mostra os resultados da simulação de um comando proibido por uma das políticas do usuário. No exemplo a seguir, o usuário tem uma política que permite o acesso a um banco de dados do DynamoDB somente após uma determinada data e hora. A simulação mostra o usuário tentando acessar o banco de dados com um `aws:CurrentTime` valor anterior ao permitido pela condição da política. ``` aws iam simulate-principal-policy \ --policy-source-arn arn:aws:iam::123456789012:user/alejandro \ --action-names dynamodb:CreateBackup \ --context-entries "ContextKeyName='aws:CurrentTime',ContextKeyValues='2018-04-25T11:00:00Z',ContextKeyType=date" ``` Resultado: ``` { "EvaluationResults": [ { "EvalActionName": "dynamodb:CreateBackup", "EvalResourceName": "*", "EvalDecision": "implicitDeny", "MatchedStatements": [], "MissingContextValues": [] } ] } ``` Para obter mais informações, consulte [Testar as políticas do IAM com o simulador de políticas do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html) no *AWS Guia do usuário do IAM*. + Para ver detalhes da API, consulte [SimulatePrincipalPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/simulate-principal-policy.html) na *Referência de comandos da AWS CLI*. ### `tag-instance-profile` O código de exemplo a seguir mostra como usar `tag-instance-profile`. **AWS CLI** **Adicionar uma marcação a um perfil de instância** O comando `tag-instance-profile` a seguir adiciona uma marcação com o nome do Departamento ao perfil de instância especificado. ``` aws iam tag-instance-profile \ --instance-profile-name deployment-role \ --tags '[{"Key": "Department", "Value": "Accounting"}]' ``` Este comando não produz saída. Para obter mais informações, consulte [Recursos de tags do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [TagInstanceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/tag-instance-profile.html) na *Referência de comandos da AWS CLI*. ### `tag-mfa-device` O código de exemplo a seguir mostra como usar `tag-mfa-device`. **AWS CLI** **Adicionar uma marcação a um dispositivo de MFA** O comando `tag-mfa-device` a seguir adiciona uma marcação com o nome do departamento ao dispositivo de MFA especificado. ``` aws iam tag-mfa-device \ --serial-number arn:aws:iam::123456789012:mfa/alice \ --tags '[{"Key": "Department", "Value": "Accounting"}]' ``` Este comando não produz saída. Para obter mais informações, consulte [Recursos de tags do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [TagMfaDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/tag-mfa-device.html) na *Referência de comandos da AWS CLI*. ### `tag-open-id-connect-provider` O código de exemplo a seguir mostra como usar `tag-open-id-connect-provider`. **AWS CLI** **Adicionar uma marcação a um provedor de identidades compatível com OpenID Connect (OIDC** O comando `tag-open-id-connect-provider` a seguir adiciona uma marcação com o nome do Departamento ao provedor de identidades compatível com OIDC especificado. ``` aws iam tag-open-id-connect-provider \ --open-id-connect-provider-arn arn:aws:iam::123456789012:oidc-provider/server.example.com \ --tags '[{"Key": "Department", "Value": "Accounting"}]' ``` Este comando não produz saída. Para obter mais informações, consulte [Recursos de tags do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [TagOpenIdConnectProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/tag-open-id-connect-provider.html) na *Referência de comandos da AWS CLI*. ### `tag-policy` O código de exemplo a seguir mostra como usar `tag-policy`. **AWS CLI** **Adicionar uma marcação a uma política gerenciada pelo cliente** O comando `tag-policy` a seguir adiciona uma marcação com o nome do Departamento à política gerenciada pelo cliente. ``` aws iam tag-policy \ --policy-arn arn:aws:iam::123456789012:policy/billing-access \ --tags '[{"Key": "Department", "Value": "Accounting"}]' ``` Este comando não produz saída. Para obter mais informações, consulte [Recursos de tags do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [TagPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/tag-policy.html) na *Referência de comandos da AWS CLI*. ### `tag-role` O código de exemplo a seguir mostra como usar `tag-role`. **AWS CLI** **Adicionar uma tag a um perfil** O comando `tag-role` a seguir adiciona uma tag com o nome do Departamento ao perfil especificado. ``` aws iam tag-role --role-name my-role \ --tags '{"Key": "Department", "Value": "Accounting"}' ``` Este comando não produz saída. Para obter mais informações, consulte [Recursos de tags do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [TagRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/tag-role.html) na *Referência de comandos da AWS CLI*. ### `tag-saml-provider` O código de exemplo a seguir mostra como usar `tag-saml-provider`. **AWS CLI** **Adicionar uma marcação a um provedor de SAML** O comando `tag-saml-provider` a seguir adiciona uma marcação com o nome do Departamento ao provedor de SAML especificado. ``` aws iam tag-saml-provider \ --saml-provider-arn arn:aws:iam::123456789012:saml-provider/ADFS \ --tags '[{"Key": "Department", "Value": "Accounting"}]' ``` Este comando não produz saída. Para obter mais informações, consulte [Recursos de tags do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [TagSamlProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/tag-saml-provider.html) na *AWS CLI Referência de comando*. ### `tag-server-certificate` O código de exemplo a seguir mostra como usar `tag-server-certificate`. **AWS CLI** **Adicionar uma marcação a um certificado** O comando `tag-saml-provider` a seguir adiciona uma marcação com o nome do Departamento ao certificado de servidor especificado. ``` aws iam tag-server-certificate \ --server-certificate-name ExampleCertificate \ --tags '[{"Key": "Department", "Value": "Accounting"}]' ``` Este comando não produz saída. Para obter mais informações, consulte [Recursos de tags do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) no *Guia do usuário do AWS IAM*. + Para obter detalhes sobre a API, consulte [TagServerCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/tag-server-certificate.html) na *Referência de comandos da AWS CLI*. ### `tag-user` O código de exemplo a seguir mostra como usar `tag-user`. **AWS CLI** **Adicionar uma tag a um usuário** O comando `tag-user` a seguir adiciona uma tag com o Departamento associado ao usuário especificado. ``` aws iam tag-user \ --user-name alice \ --tags '{"Key": "Department", "Value": "Accounting"}' ``` Este comando não produz saída. Para obter mais informações, consulte [Recursos de tags do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [TagUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/tag-user.html) na *Referência de comandos da AWS CLI*. ### `untag-instance-profile` O código de exemplo a seguir mostra como usar `untag-instance-profile`. **AWS CLI** **Remover uma marcação de um perfil de instância** O comando `untag-instance-profile` a seguir remove qualquer marcação com o nome-chave 'Departamento' do perfil de instância especificado. ``` aws iam untag-instance-profile \ --instance-profile-name deployment-role \ --tag-keys Department ``` Este comando não produz saída. Para obter mais informações, consulte [Recursos de tags do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) no *Guia do usuário do AWS IAM*. + Para obter detalhes sobre a API, consulte [UntagInstanceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/untag-instance-profile.html) na *AWS CLI Referência de comando*. ### `untag-mfa-device` O código de exemplo a seguir mostra como usar `untag-mfa-device`. **AWS CLI** **Remover uma marcação de um dispositivo de MFA** O comando `untag-mfa-device` a seguir remove qualquer marcação com o nome-chave 'Departamento' do dispositivo de MFA especificado. ``` aws iam untag-mfa-device \ --serial-number arn:aws:iam::123456789012:mfa/alice \ --tag-keys Department ``` Este comando não produz saída. Para obter mais informações, consulte [Recursos de tags do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [UntagMfaDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/untag-mfa-device.html) na * Referência de Comandos da AWS CLI*. ### `untag-open-id-connect-provider` O código de exemplo a seguir mostra como usar `untag-open-id-connect-provider`. **AWS CLI** **Remover marcações de um provedor de identidade OIDC** O comando `untag-open-id-connect-provider` a seguir remove qualquer marcação com o nome-chave 'Departamento' do provedor de identidade OIDC especificado. ``` aws iam untag-open-id-connect-provider \ --open-id-connect-provider-arn arn:aws:iam::123456789012:oidc-provider/server.example.com \ --tag-keys Department ``` Este comando não produz saída. Para obter mais informações, consulte [Recursos de tags do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [UntagOpenIdConnectProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/untag-open-id-connect-provider.html) na *Referência de comandos da AWS CLI*. ### `untag-policy` O código de exemplo a seguir mostra como usar `untag-policy`. **AWS CLI** **Remover uma marcação de uma política gerenciada pelo cliente** O comando `untag-policy` a seguir remove qualquer marcação com o nome-chave 'Departamento' da política gerenciada pelo cliente específica. ``` aws iam untag-policy \ --policy-arn arn:aws:iam::452925170507:policy/billing-access \ --tag-keys Department ``` Este comando não produz saída. Para obter mais informações, consulte [Recursos de tags do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [UntagPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/untag-policy.html) na *Referência de comandos da AWS CLI*. ### `untag-role` O código de exemplo a seguir mostra como usar `untag-role`. **AWS CLI** **Remover uma tag de um perfil** O comando `untag-role` a seguir remove qualquer tag com o nome de chave 'Department' do perfil especificado. ``` aws iam untag-role \ --role-name my-role \ --tag-keys Department ``` Este comando não produz saída. Para obter mais informações, consulte [Recursos de tags do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [UntagRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/untag-role.html) na *Referência de comandos da AWS CLI*. ### `untag-saml-provider` O código de exemplo a seguir mostra como usar `untag-saml-provider`. **AWS CLI** **Remover uma marcação de um provedor SAML** O comando `untag-saml-provider` a seguir remove qualquer marcação com o nome-chave 'Departamento' do perfil de instância especificado. ``` aws iam untag-saml-provider \ --saml-provider-arn arn:aws:iam::123456789012:saml-provider/ADFS \ --tag-keys Department ``` Este comando não produz saída. Para obter mais informações, consulte [Recursos de tags do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [UntagSamlProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/untag-saml-provider.html) na *Referência de comandos da AWS CLI*. ### `untag-server-certificate` O código de exemplo a seguir mostra como usar `untag-server-certificate`. **AWS CLI** **Remover uma marcação de um certificado de servidor** O comando `untag-server-certificate` a seguir remove qualquer marcação com o nome-chave 'Departamento' do certificado de servidor especificado. ``` aws iam untag-server-certificate \ --server-certificate-name ExampleCertificate \ --tag-keys Department ``` Este comando não produz saída. Para obter mais informações, consulte [Recursos de tags do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [UntagServerCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/untag-server-certificate.html) na *Referência de comandos da AWS CLI*. ### `untag-user` O código de exemplo a seguir mostra como usar `untag-user`. **AWS CLI** **Remover uma tag de um usuário** O comando `untag-user` a seguir remove qualquer tag com o nome de chave 'Department' do usuário especificado. ``` aws iam untag-user \ --user-name alice \ --tag-keys Department ``` Este comando não produz saída. Para obter mais informações, consulte [Recursos de tags do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [UntagUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/untag-user.html) na *Referência de comandos da AWS CLI*. ### `update-access-key` O código de exemplo a seguir mostra como usar `update-access-key`. **AWS CLI** **Como ativar ou desativar uma chave de acesso para um usuário do IAM** O comando `update-access-key`, apresentado a seguir, desativa a chave de acesso especificada (ID da chave de acesso e chave de acesso secreta) para o usuário do IAM denominado `Bob`. ``` aws iam update-access-key \ --access-key-id AKIAIOSFODNN7EXAMPLE \ --status Inactive \ --user-name Bob ``` Este comando não produz saída. A desativação da chave significa que ela não pode ser usada para acesso programático à AWS. No entanto, a chave continua disponível e pode ser ativada novamente. Para obter mais informações, consulte [Gerenciamento de chaves de acesso de usuários do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [UpdateAccessKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-access-key.html) na *Referência de comandos da AWS CLI*. ### `update-account-password-policy` O código de exemplo a seguir mostra como usar `update-account-password-policy`. **AWS CLI** **Definir ou alterar a política de senha da conta atual** O comando `update-account-password-policy` a seguir define a política de senha para exigir um mínimo de oito caracteres e um ou mais números na senha. ``` aws iam update-account-password-policy \ --minimum-password-length 8 \ --require-numbers ``` Este comando não produz saída. As alterações na política de senha de uma conta afetam todas as novas senhas criadas para usuários do IAM na conta. As alterações na política de senha não afetam as senhas existentes. Para obter mais informações, consulte [Definição de uma política de senhas de contas para usuários do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_account-policy.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [UpdateAccountPasswordPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-account-password-policy.html) na *Referência de comandos da AWS CLI*. ### `update-assume-role-policy` O código de exemplo a seguir mostra como usar `update-assume-role-policy`. **AWS CLI** **Atualizar a política de confiança de um perfil do IAM** O comando `update-assume-role-policy` a seguir atualiza a política de confiança do perfil denominado `Test-Role`. ``` aws iam update-assume-role-policy \ --role-name Test-Role \ --policy-document file://Test-Role-Trust-Policy.json ``` Este comando não produz saída. A política de confiança é definida como um documento JSON no arquivo *Test-Role-Trust-Policy.json*. (O nome e a extensão do arquivo não têm significado.) A política de confiança deve especificar uma entidade principal. Para atualizar a política de permissões de um perfil, use o comando `put-role-policy`. Para obter mais informações, consulte [Criação de perfis do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [UpdateAssumeRolePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-assume-role-policy.html) na *Referência de comandos da AWS CLI*. ### `update-group` O código de exemplo a seguir mostra como usar `update-group`. **AWS CLI** **Para renomear um grupo do IAM** O comando `update-group` a seguir altera o nome do grupo do IAM `Test` para `Test-1`. ``` aws iam update-group \ --group-name Test \ --new-group-name Test-1 ``` Este comando não produz saída. Para obter mais informações, consulte [Renomeação de um grupo de usuários do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage_rename.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [UpdateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-group.html) na *Referência de comandos da AWS CLI*. ### `update-login-profile` O código de exemplo a seguir mostra como usar `update-login-profile`. **AWS CLI** **Atualizar a senha de um usuário do IAM** O comando `update-login-profile` a seguir cria uma senha para o usuário do IAM chamado `Bob`. ``` aws iam update-login-profile \ --user-name Bob \ --password ``` Este comando não produz saída. Para definir uma política de senha da conta, use o comando `update-account-password-policy`. Se a nova senha violar a política de senha da conta, o comando retornará um erro `PasswordPolicyViolation`. Se a política de senha da conta permitir, os usuários do IAM poderão alterar suas próprias senhas usando o comando `change-password`. Armazene a senha em um lugar seguro. Se a senha for perdida, não será possível recuperá-la e você deverá criar uma nova usando o comando `create-login-profile`. Para obter mais informações, consulte [Gerenciamento de senhas de usuários do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_admin-change-user.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [UpdateLoginProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-login-profile.html) na *Referência de comandos da AWS CLI*. ### `update-open-id-connect-provider-thumbprint` O código de exemplo a seguir mostra como usar `update-open-id-connect-provider-thumbprint`. **AWS CLI** **Para substituir a lista existente de impressões digitais do certificado de servidor por uma nova** 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. ``` aws iam update-open-id-connect-provider-thumbprint \ --open-id-connect-provider-arn arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com \ --thumbprint-list 7359755EXAMPLEabc3060bce3EXAMPLEec4542a3 ``` Este comando não produz saída. Para obter mais informações, consulte [Criar provedores de identidade OpenID Connect (OIDC)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [UpdateOpenIdConnectProviderThumbprint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-open-id-connect-provider-thumbprint.html) na *Referência de comandos da AWS CLI*. ### `update-role-description` O código de exemplo a seguir mostra como usar `update-role-description`. **AWS CLI** **Alterar a descrição de um perfil do IAM** O comando `update-role` a seguir altera a descrição do perfil do IAM `production-role` para `Main production role`. ``` aws iam update-role-description \ --role-name production-role \ --description 'Main production role' ``` Resultado: ``` { "Role": { "Path": "/", "RoleName": "production-role", "RoleId": "AROA1234567890EXAMPLE", "Arn": "arn:aws:iam::123456789012:role/production-role", "CreateDate": "2017-12-06T17:16:37+00:00", "AssumeRolePolicyDocument": { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::123456789012:root" }, "Action": "sts:AssumeRole", "Condition": {} } ] }, "Description": "Main production role" } } ``` Para obter mais informações, consulte [Modificar um perfil](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_modify.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [UpdateRoleDescription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-role-description.html) na *Referência de comandos da AWS CLI*. ### `update-role` O código de exemplo a seguir mostra como usar `update-role`. **AWS CLI** **Alterar a descrição ou a duração da sessão de um perfil do IAM** O comando `update-role` a seguir altera a descrição do perfil do IAM `production-role` para `Main production role` e define a duração máxima da sessão como 12 horas. ``` aws iam update-role \ --role-name production-role \ --description 'Main production role' \ --max-session-duration 43200 ``` Este comando não produz saída. Para obter mais informações, consulte [Modificar um perfil](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_modify.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [UpdateRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-role.html) na *Referência de comandos da AWS CLI*. ### `update-saml-provider` O código de exemplo a seguir mostra como usar `update-saml-provider`. **AWS CLI** **Atualizar o documento de metadados de um provedor SAML existente** 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`. ``` aws iam update-saml-provider \ --saml-metadata-document file://SAMLMetaData.xml \ --saml-provider-arn arn:aws:iam::123456789012:saml-provider/SAMLADFS ``` Resultado: ``` { "SAMLProviderArn": "arn:aws:iam::123456789012:saml-provider/SAMLADFS" } ``` Para obter mais informações, consulte [Criação de provedores de identidade SAML do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [UpdateSamlProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-saml-provider.html) na *Referência de comandos da AWS CLI*. ### `update-server-certificate` O código de exemplo a seguir mostra como usar `update-server-certificate`. **AWS CLI** **Como alterar o caminho ou o nome de um certificado de servidor em sua conta da AWS** O comando `update-server-certificate`, apresentado a seguir, altera o nome do certificado de `myServerCertificate` para `myUpdatedServerCertificate`. Além disso, ele altera o caminho para `/cloudfront/` com a finalidade de que ele possa ser acessado pelo serviço do Amazon CloudFront. Este comando não produz saída. É possível visualizar os resultados da atualização ao executar o comando `list-server-certificates`. ``` aws-iam update-server-certificate \ --server-certificate-name myServerCertificate \ --new-server-certificate-name myUpdatedServerCertificate \ --new-path /cloudfront/ ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar certificados de servidor no IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [UpdateServerCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-server-certificate.html) na *Referência de comandos da AWS CLI*. ### `update-service-specific-credential` O código de exemplo a seguir mostra como usar `update-service-specific-credential`. **AWS CLI** **Exemplo 1: atualizar o status da credencial específica do serviço do usuário solicitante** O exemplo `update-service-specific-credential` a seguir altera o status da credencial específica para o usuário que está fazendo a solicitação a `Inactive`. ``` aws iam update-service-specific-credential \ --service-specific-credential-id ACCAEXAMPLE123EXAMPLE \ --status Inactive ``` Este comando não produz saída. **Exemplo 2: atualizar o status da credencial específica do serviço do usuário especificado** O exemplo `update-service-specific-credential` a seguir altera o status da credencial do usuário específico para Inativo. ``` aws iam update-service-specific-credential \ --user-name sofia \ --service-specific-credential-id ACCAEXAMPLE123EXAMPLE \ --status Inactive ``` Este comando não produz saída. Para obter mais informações, consulte [Criar credenciais do Git para conexões HTTPS com o CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html#setting-up-gc-iam) no *Guia do usuário do AWS CodeCommit* + Para ver detalhes da API, consulte [UpdateServiceSpecificCredential](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-service-specific-credential.html) na *Referência de comandos da AWS CLI*. ### `update-signing-certificate` O código de exemplo a seguir mostra como usar `update-signing-certificate`. **AWS CLI** **Ativar ou desativar um certificado de assinatura de um usuário do IAM** O comando `update-signing-certificate` a seguir desativa o certificado de assinatura especificado do usuário do IAM chamado `Bob`. ``` aws iam update-signing-certificate \ --certificate-id TA7SMP42TDN5Z26OBPJE7EXAMPLE \ --status Inactive \ --user-name Bob ``` Para obter o ID de um certificado de assinatura, use o comando `list-signing-certificates`. Para obter mais informações, consulte [Manage signing certificates](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/set-up-ami-tools.html#ami-tools-managing-certs) no *Guia do usuário do Amazon EC2*. + Consulte detalhes da API em [UpdateSigningCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-signing-certificate.html) na *Referência de comandos da AWS CLI*. ### `update-ssh-public-key` O código de exemplo a seguir mostra como usar `update-ssh-public-key`. **AWS CLI** **Alterar o status de uma chave pública SSH** O comando `update-ssh-public-key` a seguir altera o status da chave pública especificada para `Inactive`. ``` aws iam update-ssh-public-key \ --user-name sofia \ --ssh-public-key-id APKA1234567890EXAMPLE \ --status Inactive ``` Este comando não produz saída. Para obter mais informações, consulte [Usar chaves SSH com o CodeCommit](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_ssh-keys.html#ssh-keys-code-commit) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [UpdateSshPublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-ssh-public-key.html) na *Referência de comandos da AWS CLI*. ### `update-user` O código de exemplo a seguir mostra como usar `update-user`. **AWS CLI** **Como alterar o nome de um usuário do IAM** O comando `update-user`, apresentado a seguir, altera o nome do usuário do IAM de `Bob` para `Robert`. ``` aws iam update-user \ --user-name Bob \ --new-user-name Robert ``` Este comando não produz saída. Para obter mais informações, consulte [Renomeação de um grupo de usuários do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage_rename.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [UpdateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-user.html) na *Referência de comandos da AWS CLI*. ### `upload-server-certificate` O código de exemplo a seguir mostra como usar `upload-server-certificate`. **AWS CLI** **Como fazer upload de um certificado de servidor para sua conta da AWS** O comando **upload-server-certificate**, apresentado a seguir, faz o upload de um certificado de servidor para sua conta da AWS. Neste exemplo, o certificado está no arquivo `public_key_cert_file.pem`, a chave privada associada está no arquivo `my_private_key.pem` e a cadeia de certificados fornecida pela autoridade de certificação (CA) está no arquivo `my_certificate_chain_file.pem`. Quando o upload do arquivo for concluído, ele estará disponível com o nome *myServerCertificate*. Os parâmetros que começam com `file://` informam ao comando para ler o conteúdo do arquivo e usá-lo como valor do parâmetro em vez do próprio nome do arquivo. ``` aws iam upload-server-certificate \ --server-certificate-name myServerCertificate \ --certificate-body file://public_key_cert_file.pem \ --private-key file://my_private_key.pem \ --certificate-chain file://my_certificate_chain_file.pem ``` Resultado: ``` { "ServerCertificateMetadata": { "Path": "/", "ServerCertificateName": "myServerCertificate", "ServerCertificateId": "ASCAEXAMPLE123EXAMPLE", "Arn": "arn:aws:iam::1234567989012:server-certificate/myServerCertificate", "UploadDate": "2019-04-22T21:13:44+00:00", "Expiration": "2019-10-15T22:23:16+00:00" } } ``` Para obter mais informações, consulte Creating, Uploading, and Deleting Server Certificates no guia *Using IAM*. + Consulte detalhes da API em [UploadServerCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/upload-server-certificate.html) na *Referência de comandos da AWS CLI*. ### `upload-signing-certificate` O código de exemplo a seguir mostra como usar `upload-signing-certificate`. **AWS CLI** **Fazer upload de um certificado de assinatura de um usuário do IAM** O comando `upload-signing-certificate` a seguir faz upload de um certificado de assinatura do usuário do IAM chamado `Bob`. ``` aws iam upload-signing-certificate \ --user-name Bob \ --certificate-body file://certificate.pem ``` Resultado: ``` { "Certificate": { "UserName": "Bob", "Status": "Active", "CertificateBody": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE", "UploadDate": "2013-06-06T21:40:08.121Z" } } ``` O certificado está em um arquivo denominado *certificate.pem* no formato PEM. Para obter mais informações, consulte Creating and Uploading a User Signing Certificate no guia *Uso do IAM*. + Consulte detalhes da API em [UploadSigningCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/upload-signing-certificate.html) na *Referência de comandos da AWS CLI*. ### `upload-ssh-public-key` O código de exemplo a seguir mostra como usar `upload-ssh-public-key`. **AWS CLI** **Fazer upload de uma chave SSH pública e associá-la a um usuário** O comando `upload-ssh-public-key` a seguir carrega a chave pública encontrada no arquivo `sshkey.pub` e a anexa ao usuário `sofia`. ``` aws iam upload-ssh-public-key \ --user-name sofia \ --ssh-public-key-body file://sshkey.pub ``` Resultado: ``` { "SSHPublicKey": { "UserName": "sofia", "SSHPublicKeyId": "APKA1234567890EXAMPLE", "Fingerprint": "12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef", "SSHPublicKeyBody": "ssh-rsa <>", "Status": "Active", "UploadDate": "2019-04-18T17:04:49+00:00" } } ``` Para obter mais informações sobre como gerar chaves em um formato adequado para esse comando, consulte [SSH e Linux, macOS ou Unix: configurar as chaves públicas e privadas para o Git e o CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-ssh-unixes.html#setting-up-ssh-unixes-keys) ou [SSH e Windows: configurar as chaves públicas e privadas para o Git e o CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-ssh-windows.html#setting-up-ssh-windows-keys-windows) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [UploadSshPublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/upload-ssh-public-key.html) na *Referência de comandos da AWS CLI*. # Exemplos do IAM Access Analyzer usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o IAM Access Analyzer. *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 ### `apply-archive-rule` O código de exemplo a seguir mostra como usar `apply-archive-rule`. **AWS CLI** **Como aplicar uma regra de arquivamento para descobertas existentes que atendam aos critérios da regra de arquivamento** O exemplo `apply-archive-rule` a seguir aplica uma regra de arquivamento às descobertas existentes que atendam aos critérios da regra de arquivamento. ``` aws accessanalyzer apply-archive-rule \ --analyzer-arn arn:aws:access-analyzer:us-west-2:111122223333:analyzer/UnusedAccess-ConsoleAnalyzer-organization \ --rule-name MyArchiveRule ``` Este comando não produz saída. Para obter mais informações, consulte [Regras de arquivamento](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-archive-rules.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [ApplyArchiveRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/apply-archive-rule.html) na *Referência de comandos da AWS CLI*. ### `cancel-policy-generation` O código de exemplo a seguir mostra como usar `cancel-policy-generation`. **AWS CLI** **Como cancelar uma solicitação de geração de política** O exemplo `cancel-policy-generation` a seguir cancela o ID do trabalho de geração de política solicitada. ``` aws accessanalyzer cancel-policy-generation \ --job-id 923a56b0-ebb8-4e80-8a3c-a11ccfbcd6f2 ``` Este comando não produz saída. Para obter mais informações, consulte [Geração de política do IAM Access Analyzer](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-policy-generation.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [CancelPolicyGeneration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/cancel-policy-generation.html) na *Referência de comandos da AWS CLI*. ### `check-access-not-granted` O código de exemplo a seguir mostra como usar `check-access-not-granted`. **AWS CLI** **Como verificar se o acesso especificado não é permitido por uma política** O exemplo `check-access-not-granted` a seguir verifica se o acesso especificado não é permitido por uma política. ``` aws accessanalyzer check-access-not-granted \ --policy-document file://myfile.json \ --access actions="s3:DeleteBucket","s3:GetBucketLocation" \ --policy-type IDENTITY_POLICY ``` Conteúdo de `myfile.json`: ``` { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "s3:GetObject", "s3:ListBucket" ], "Resource": [ "arn:aws:s3:::amzn-s3-demo-bucket", "arn:aws:s3:::amzn-s3-demo-bucket/*" ] } ] } ``` Resultado: ``` { "result": "PASS", "message": "The policy document does not grant access to perform one or more of the listed actions." } ``` Para obter mais informações, consulte [Pré-visualizar o acesso com as APIs do IAM Access Analyzer](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-preview-access-apis.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [CheckAccessNotGranted](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/check-access-not-granted.html) na *Referência de comandos da AWS CLI*. ### `check-no-new-access` O código de exemplo a seguir mostra como usar `check-no-new-access`. **AWS CLI** **Como verificar se um novo acesso é permitido para uma política atualizada em comparação com a política existente** O exemplo `check-no-new-access` a seguir verifica se um novo acesso é permitido para uma política atualizada em comparação com a política existente. ``` aws accessanalyzer check-no-new-access \ --existing-policy-document file://existing-policy.json \ --new-policy-document file://new-policy.json \ --policy-type IDENTITY_POLICY ``` Conteúdo de `existing-policy.json`: ``` { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "s3:GetObject", "s3:ListBucket" ], "Resource": [ "arn:aws:s3:::amzn-s3-demo-bucket", "arn:aws:s3:::amzn-s3-demo-bucket/*" ] } ] } ``` Conteúdo de `new-policy.json`: ``` { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "s3:GetObject", "s3:GetObjectAcl", "s3:ListBucket" ], "Resource": [ "arn:aws:s3:::amzn-s3-demo-bucket", "arn:aws:s3:::amzn-s3-demo-bucket/*" ] } ] } ``` Resultado: ``` { "result": "FAIL", "message": "The modified permissions grant new access compared to your existing policy.", "reasons": [ { "description": "New access in the statement with index: 0.", "statementIndex": 0 } ] } ``` Para obter mais informações, consulte [Pré-visualizar o acesso com as APIs do IAM Access Analyzer](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-preview-access-apis.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [CheckNoNewAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/check-no-new-access.html) na *Referência de comandos da AWS CLI*. ### `check-no-public-access` O código de exemplo a seguir mostra como usar `check-no-public-access`. **AWS CLI** **Como verificar se uma política de recursos pode conceder acesso público ao tipo de recurso especificado** O exemplo `check-no-public-access` a seguir verifica se uma política de recursos pode conceder acesso público ao tipo de recurso especificado. ``` aws accessanalyzer check-no-public-access \ --policy-document file://check-no-public-access-myfile.json \ --resource-type AWS::S3::Bucket ``` Conteúdo de `myfile.json`: ``` { "Version":"2012-10-17", "Statement": [ { "Sid": "CheckNoPublicAccess", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111122223333:user/JohnDoe" }, "Action": [ "s3:GetObject" ] } ] } ``` Resultado: ``` { "result": "PASS", "message": "The resource policy does not grant public access for the given resource type." } ``` Para obter mais informações, consulte [Pré-visualizar o acesso com as APIs do IAM Access Analyzer](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-preview-access-apis.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [CheckNoPublicAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/check-no-public-access.html) na *Referência de comandos da AWS CLI*. ### `create-access-preview` O código de exemplo a seguir mostra como usar `create-access-preview`. **AWS CLI** **Para criar uma visualização prévia de acesso que permita que você visualize as descobertas do IAM Access Analyzer para seu recurso antes de implantar as permissões do recurso** O exemplo `create-access-preview` a seguir cria uma pré-visualização de acesso que permite que você pré-visualize as descobertas do IAM Access Analyzer para seu recurso antes de implantar permissões de recursos em sua conta da AWS. ``` aws accessanalyzer create-access-preview \ --analyzer-arn arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-account \ --configurations file://myfile.json ``` Conteúdo de `myfile.json`: ``` { "arn:aws:s3:::amzn-s3-demo-bucket": { "s3Bucket": { "bucketPolicy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":[\"arn:aws:iam::111122223333:root\"]},\"Action\":[\"s3:PutObject\",\"s3:PutObjectAcl\"],\"Resource\":\"arn:aws:s3:::amzn-s3-demo-bucket/*\"}]}", "bucketPublicAccessBlock": { "ignorePublicAcls": true, "restrictPublicBuckets": true }, "bucketAclGrants": [ { "grantee": { "id": "79a59df900b949e55d96a1e698fbacedfd6e09d98eacf8f8d5218e7cd47ef2be" }, "permission": "READ" } ] } } } ``` Resultado: ``` { "id": "3c65eb13-6ef9-4629-8919-a32043619e6b" } ``` Para obter mais informações, consulte [Pré-visualizar o acesso com as APIs do IAM Access Analyzer](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-preview-access-apis.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [CreateAccessPreview](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/create-access-preview.html) na *Referência de comandos da AWS CLI*. ### `create-analyzer` O código de exemplo a seguir mostra como usar `create-analyzer`. **AWS CLI** **Para criar um analisador** O exemplo `create-analyzer` a seguir cria um analisador em sua conta da AWS. ``` aws accessanalyzer create-analyzer \ --analyzer-name example \ --type ACCOUNT ``` Resultado: ``` { "arn": "arn:aws:access-analyzer:us-east-2:111122223333:analyzer/example" } ``` Para obter mais informações, consulte as [Conceitos básicos de descobertas do AWS Identity and Access Management Access Analyzer](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [CreateAnalyzer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/create-analyzer.html) na *Referência de comandos da AWS CLI*. ### `create-archive-rule` O código de exemplo a seguir mostra como usar `create-archive-rule`. **AWS CLI** **Para criar uma regra de arquivamento para o analisador especificado** O exemplo `create-archive-rule` a seguir cria uma regra de arquivamento para o analisador especificado em sua conta da AWS. ``` aws accessanalyzer create-archive-rule \ --analyzer-name UnusedAccess-ConsoleAnalyzer-organization \ --rule-name MyRule \ --filter '{"resource": {"contains": ["Cognito"]}, "resourceType": {"eq": ["AWS::IAM::Role"]}}' ``` Este comando não produz saída. Para obter mais informações, consulte [Regras de arquivamento](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-archive-rules.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [CreateArchiveRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/create-archive-rule.html) na *Referência de comandos da AWS CLI*. ### `delete-analyzer` O código de exemplo a seguir mostra como usar `delete-analyzer`. **AWS CLI** **Para excluir o analisador especificado** O exemplo `delete-analyzer` a seguir exclui o analisador especificado em sua conta da AWS. ``` aws accessanalyzer delete-analyzer \ --analyzer-name example ``` Este comando não produz saída. Para obter mais informações, consulte [Regras de arquivamento](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-archive-rules.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [DeleteAnalyzer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/delete-analyzer.html) na *Referência de comandos da AWS CLI*. ### `delete-archive-rule` O código de exemplo a seguir mostra como usar `delete-archive-rule`. **AWS CLI** **Para excluir a regra de arquivamento especificada** O exemplo `delete-archive-rule` a seguir exclui a regra de arquivamento especificada em sua conta da AWS. ``` aws accessanalyzer delete-archive-rule \ --analyzer-name UnusedAccess-ConsoleAnalyzer-organization \ --rule-name MyRule ``` Este comando não produz saída. Para obter mais informações, consulte [Regras de arquivamento](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-archive-rules.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [DeleteArchiveRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/delete-archive-rule.html) na *Referência de comandos da AWS CLI*. ### `get-access-preview` O código de exemplo a seguir mostra como usar `get-access-preview`. **AWS CLI** **Para recuperar informações sobre uma pré-visualização de acesso para o analisador especificado** O exemplo `get-access-preview` a seguir recupera informações sobre uma pré-visualização de acesso para o analisador especificado em sua conta da AWS. ``` aws accessanalyzer get-access-preview \ --access-preview-id 3c65eb13-6ef9-4629-8919-a32043619e6b \ --analyzer-arn arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-account ``` Resultado: ``` { "accessPreview": { "id": "3c65eb13-6ef9-4629-8919-a32043619e6b", "analyzerArn": "arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-account", "configurations": { "arn:aws:s3:::amzn-s3-demo-bucket": { "s3Bucket": { "bucketPolicy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":[\"arn:aws:iam::111122223333:root\"]},\"Action\":[\"s3:PutObject\",\"s3:PutObjectAcl\"],\"Resource\":\"arn:aws:s3:::amzn-s3-demo-bucket/*\"}]}", "bucketAclGrants": [ { "permission": "READ", "grantee": { "id": "79a59df900b949e55d96a1e698fbacedfd6e09d98eacf8f8d5218e7cd47ef2be" } } ], "bucketPublicAccessBlock": { "ignorePublicAcls": true, "restrictPublicBuckets": true } } } }, "createdAt": "2024-02-17T00:18:44+00:00", "status": "COMPLETED" } } ``` Para obter mais informações, consulte [Pré-visualizar o acesso com as APIs do IAM Access Analyzer](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-preview-access-apis.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [GetAccessPreview](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/get-access-preview.html) na *Referência de comandos da AWS CLI*. ### `get-analyzed-resource` O código de exemplo a seguir mostra como usar `get-analyzed-resource`. **AWS CLI** **Para recuperar informações sobre um recurso que foi analisado** O exemplo `get-analyzed-resource` a seguir recupera informações sobre um recurso que foi analisado em sua conta da AWS. ``` aws accessanalyzer get-analyzed-resource \ --analyzer-arn arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-account \ --resource-arn arn:aws:s3:::amzn-s3-demo-bucket ``` Resultado: ``` { "resource": { "analyzedAt": "2024-02-15T18:01:53.002000+00:00", "isPublic": false, "resourceArn": "arn:aws:s3:::amzn-s3-demo-bucket", "resourceOwnerAccount": "111122223333", "resourceType": "AWS::S3::Bucket" } } ``` Para obter mais informações, consulte [Usar o AWS Identity and Access Management Access Analyzer](https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html) no *Guia do usuário do AWS IAM*. + Para receber detalhes da API, consulte [GetAnalyzedResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/get-analyzed-resource.html) na *Referência de comandos da AWS CLI*. ### `get-analyzer` O código de exemplo a seguir mostra como usar `get-analyzer`. **AWS CLI** **Para recuperar informações sobre o analisador especificado** O exemplo `get-analyzer` a seguir recupera informações sobre o analisador especificado na conta da AWS. ``` aws accessanalyzer get-analyzer \ --analyzer-name ConsoleAnalyzer-account ``` Resultado: ``` { "analyzer": { "arn": "arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-account", "createdAt": "2019-12-03T07:28:17+00:00", "lastResourceAnalyzed": "arn:aws:sns:us-west-2:111122223333:config-topic", "lastResourceAnalyzedAt": "2024-02-15T18:01:53.003000+00:00", "name": "ConsoleAnalyzer-account", "status": "ACTIVE", "tags": { "auto-delete": "no" }, "type": "ACCOUNT" } } ``` Para obter mais informações, consulte [Usar o AWS Identity and Access Management Access Analyzer](https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [GetAnalyzer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/get-analyzer.html) na *Referência de comandos da AWS CLI*. ### `get-archive-rule` O código de exemplo a seguir mostra como usar `get-archive-rule`. **AWS CLI** **Para recuperar informações sobre uma regra de arquivamento** O exemplo `get-archive-rule` a seguir recupera informações sobre uma regra de arquivamento em sua conta da AWS. ``` aws accessanalyzer get-archive-rule \ --analyzer-name UnusedAccess-ConsoleAnalyzer-organization \ --rule-name MyArchiveRule ``` Resultado: ``` { "archiveRule": { "createdAt": "2024-02-15T00:49:27+00:00", "filter": { "resource": { "contains": [ "Cognito" ] }, "resourceType": { "eq": [ "AWS::IAM::Role" ] } }, "ruleName": "MyArchiveRule", "updatedAt": "2024-02-15T00:49:27+00:00" } } ``` Para obter mais informações, consulte [Regras de arquivamento](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-archive-rules.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [GetArchiveRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/get-archive-rule.html) na *Referência de comandos da AWS CLI*. ### `get-finding-v2` O código de exemplo a seguir mostra como usar `get-finding-v2`. **AWS CLI** **Para recuperar informações sobre a descoberta especificada** O exemplo `get-finding-v2` a seguir recupera informações sobre a descoberta especificada na conta da AWS. ``` aws accessanalyzer get-finding-v2 \ --analyzer-arn arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-organization \ --id 0910eedb-381e-4e95-adda-0d25c19e6e90 ``` Resultado: ``` { "findingDetails": [ { "externalAccessDetails": { "action": [ "sts:AssumeRoleWithWebIdentity" ], "condition": { "cognito-identity.amazonaws.com:aud": "us-west-2:EXAMPLE0-0000-0000-0000-000000000000" }, "isPublic": false, "principal": { "Federated": "cognito-identity.amazonaws.com" } } } ], "resource": "arn:aws:iam::111122223333:role/Cognito_testpoolAuth_Role", "status": "ACTIVE", "error": null, "createdAt": "2021-02-26T21:17:50.905000+00:00", "resourceType": "AWS::IAM::Role", "findingType": "ExternalAccess", "resourceOwnerAccount": "111122223333", "analyzedAt": "2024-02-16T18:17:47.888000+00:00", "id": "0910eedb-381e-4e95-adda-0d25c19e6e90", "updatedAt": "2021-02-26T21:17:50.905000+00:00" } ``` Para obter mais informações, consulte [Revisar descobertas](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-findings-view.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [GetFindingV2](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/get-finding-v2.html) na *Referência de comandos da AWS CLI*. ### `get-finding` O código de exemplo a seguir mostra como usar `get-finding`. **AWS CLI** **Para recuperar informações sobre a descoberta especificada** O exemplo `get-finding` a seguir recupera informações sobre a descoberta especificada na conta da AWS. ``` aws accessanalyzer get-finding \ --analyzer-arn arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-organization \ --id 0910eedb-381e-4e95-adda-0d25c19e6e90 ``` Resultado: ``` { "finding": { "id": "0910eedb-381e-4e95-adda-0d25c19e6e90", "principal": { "Federated": "cognito-identity.amazonaws.com" }, "action": [ "sts:AssumeRoleWithWebIdentity" ], "resource": "arn:aws:iam::111122223333:role/Cognito_testpoolAuth_Role", "isPublic": false, "resourceType": "AWS::IAM::Role", "condition": { "cognito-identity.amazonaws.com:aud": "us-west-2:EXAMPLE0-0000-0000-0000-000000000000" }, "createdAt": "2021-02-26T21:17:50.905000+00:00", "analyzedAt": "2024-02-16T18:17:47.888000+00:00", "updatedAt": "2021-02-26T21:17:50.905000+00:00", "status": "ACTIVE", "resourceOwnerAccount": "111122223333" } } ``` Para obter mais informações, consulte [Revisar descobertas](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-findings-view.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [GetFinding](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/get-finding.html) na *Referência de comandos da AWS CLI*. ### `get-generated-policy` O código de exemplo a seguir mostra como usar `get-generated-policy`. **AWS CLI** **Para recuperar a política que foi gerada usando a API `StartPolicyGeneration`** O exemplo `get-generated-policy` a seguir recupera a política que foi gerada usando a API StartPolicyGeneration em sua conta da AWS. ``` aws accessanalyzer get-generated-policy \ --job-id c557dc4a-0338-4489-95dd-739014860ff9 ``` Resultado: ``` { "generatedPolicyResult": { "generatedPolicies": [ { "policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"SupportedServiceSid0\",\"Effect\":\"Allow\",\"Action\":[\"access-analyzer:GetAnalyzer\",\"access-analyzer:ListAnalyzers\",\"access-analyzer:ListArchiveRules\",\"access-analyzer:ListFindings\",\"cloudtrail:DescribeTrails\",\"cloudtrail:GetEventDataStore\",\"cloudtrail:GetEventSelectors\",\"cloudtrail:GetInsightSelectors\",\"cloudtrail:GetTrailStatus\",\"cloudtrail:ListChannels\",\"cloudtrail:ListEventDataStores\",\"cloudtrail:ListQueries\",\"cloudtrail:ListTags\",\"cloudtrail:LookupEvents\",\"ec2:DescribeRegions\",\"iam:GetAccountSummary\",\"iam:GetOpenIDConnectProvider\",\"iam:GetRole\",\"iam:ListAccessKeys\",\"iam:ListAccountAliases\",\"iam:ListOpenIDConnectProviders\",\"iam:ListRoles\",\"iam:ListSAMLProviders\",\"kms:ListAliases\",\"s3:GetBucketLocation\",\"s3:ListAllMyBuckets\"],\"Resource\":\"*\"}]}" } ], "properties": { "cloudTrailProperties": { "endTime": "2024-02-14T22:44:40+00:00", "startTime": "2024-02-13T00:30:00+00:00", "trailProperties": [ { "allRegions": true, "cloudTrailArn": "arn:aws:cloudtrail:us-west-2:111122223333:trail/my-trail", "regions": [] } ] }, "isComplete": false, "principalArn": "arn:aws:iam::111122223333:role/Admin" } }, "jobDetails": { "completedOn": "2024-02-14T22:47:01+00:00", "jobId": "c557dc4a-0338-4489-95dd-739014860ff9", "startedOn": "2024-02-14T22:44:41+00:00", "status": "SUCCEEDED" } } ``` Para obter mais informações, consulte [Geração de política do IAM Access Analyzer](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-policy-generation.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [GetGeneratedPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/get-generated-policy.html) na *Referência de comandos da AWS CLI*. ### `list-access-preview-findings` O código de exemplo a seguir mostra como usar `list-access-preview-findings`. **AWS CLI** **Para recuperar uma lista de descobertas de pré-visualização de acesso geradas pela pré-visualização de acesso especificada** O exemplo `list-access-preview-findings` a seguir recupera uma lista de descobertas de pré-visualização de acesso geradas pela pré-visualização de acesso especificada em sua conta da AWS. ``` aws accessanalyzer list-access-preview-findings \ --access-preview-id 3c65eb13-6ef9-4629-8919-a32043619e6b \ --analyzer-arn arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-account ``` Resultado: ``` { "findings": [ { "id": "e22fc158-1c87-4c32-9464-e7f405ce8d74", "principal": { "AWS": "111122223333" }, "action": [ "s3:PutObject", "s3:PutObjectAcl" ], "condition": {}, "resource": "arn:aws:s3:::amzn-s3-demo-bucket", "isPublic": false, "resourceType": "AWS::S3::Bucket", "createdAt": "2024-02-17T00:18:46+00:00", "changeType": "NEW", "status": "ACTIVE", "resourceOwnerAccount": "111122223333", "sources": [ { "type": "POLICY" } ] } ] } ``` Para obter mais informações, consulte [Pré-visualizar o acesso com as APIs do IAM Access Analyzer](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-preview-access-apis.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [ListAccessPreviewFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/list-access-preview-findings.html) na *Referência de comandos da AWS CLI*. ### `list-access-previews` O código de exemplo a seguir mostra como usar `list-access-previews`. **AWS CLI** **Para recuperar uma lista de pré-visualizações de acesso para o analisador especificado** O exemplo `list-access-previews` a seguir recupera uma lista de pré-visualizações de acesso para o analisador especificado em sua conta da AWS. ``` aws accessanalyzer list-access-previews \ --analyzer-arn arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-account ``` Resultado: ``` { "accessPreviews": [ { "id": "3c65eb13-6ef9-4629-8919-a32043619e6b", "analyzerArn": "arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-account", "createdAt": "2024-02-17T00:18:44+00:00", "status": "COMPLETED" } ] } ``` Para obter mais informações, consulte [Pré-visualizar o acesso com as APIs do IAM Access Analyzer](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-preview-access-apis.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [ListAccessPreviews](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/list-access-previews.html) na *Referência de comandos da AWS CLI*. ### `list-analyzed-resources` O código de exemplo a seguir mostra como usar `list-analyzed-resources`. **AWS CLI** **Para listar os widgets disponíveis** O exemplo `list-analyzed-resources` a seguir lista os widgets disponíveis na sua conta da AWS. ``` aws accessanalyzer list-analyzed-resources \ --analyzer-arn arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-account \ --resource-type AWS::IAM::Role ``` Resultado: ``` { "analyzedResources": [ { "resourceArn": "arn:aws:sns:us-west-2:111122223333:Validation-Email", "resourceOwnerAccount": "111122223333", "resourceType": "AWS::SNS::Topic" }, { "resourceArn": "arn:aws:sns:us-west-2:111122223333:admin-alerts", "resourceOwnerAccount": "111122223333", "resourceType": "AWS::SNS::Topic" }, { "resourceArn": "arn:aws:sns:us-west-2:111122223333:config-topic", "resourceOwnerAccount": "111122223333", "resourceType": "AWS::SNS::Topic" }, { "resourceArn": "arn:aws:sns:us-west-2:111122223333:inspector-topic", "resourceOwnerAccount": "111122223333", "resourceType": "AWS::SNS::Topic" } ] } ``` Para obter mais informações, consulte [Usar o AWS Identity and Access Management Access Analyzer](https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [ListAnalyzedResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/list-analyzed-resources.html) na *Referência de comandos da AWS CLI*. ### `list-analyzers` O código de exemplo a seguir mostra como usar `list-analyzers`. **AWS CLI** **Para recuperar uma lista de analisadores** O exemplo `list-analyzers` a seguir recupera uma lista de analisadores em sua conta da AWS. ``` aws accessanalyzer list-analyzers ``` Resultado: ``` { "analyzers": [ { "arn": "arn:aws:access-analyzer:us-west-2:111122223333:analyzer/UnusedAccess-ConsoleAnalyzer-organization", "createdAt": "2024-02-15T00:46:40+00:00", "name": "UnusedAccess-ConsoleAnalyzer-organization", "status": "ACTIVE", "tags": { "auto-delete": "no" }, "type": "ORGANIZATION_UNUSED_ACCESS" }, { "arn": "arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-organization", "createdAt": "2020-04-25T07:43:28+00:00", "lastResourceAnalyzed": "arn:aws:s3:::amzn-s3-demo-bucket", "lastResourceAnalyzedAt": "2024-02-15T21:51:56.517000+00:00", "name": "ConsoleAnalyzer-organization", "status": "ACTIVE", "tags": { "auto-delete": "no" }, "type": "ORGANIZATION" }, { "arn": "arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-account", "createdAt": "2019-12-03T07:28:17+00:00", "lastResourceAnalyzed": "arn:aws:sns:us-west-2:111122223333:config-topic", "lastResourceAnalyzedAt": "2024-02-15T18:01:53.003000+00:00", "name": "ConsoleAnalyzer-account", "status": "ACTIVE", "tags": { "auto-delete": "no" }, "type": "ACCOUNT" } ] } ``` Para obter mais informações, consulte [Usar o AWS Identity and Access Management Access Analyzer](https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [ListAnalyzers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/list-analyzers.html) na *Referência de comandos da AWS CLI*. ### `list-archive-rules` O código de exemplo a seguir mostra como usar `list-archive-rules`. **AWS CLI** **Para recuperar uma lista de regras de arquivamento criadas para o analisador especificado** O exemplo `list-archive-rules` a seguir recupera uma lista de regras de arquivamento criadas para o analisador especificado em sua conta da AWS. ``` aws accessanalyzer list-archive-rules \ --analyzer-name UnusedAccess-ConsoleAnalyzer-organization ``` Resultado: ``` { "archiveRules": [ { "createdAt": "2024-02-15T00:49:27+00:00", "filter": { "resource": { "contains": [ "Cognito" ] }, "resourceType": { "eq": [ "AWS::IAM::Role" ] } }, "ruleName": "MyArchiveRule", "updatedAt": "2024-02-15T00:49:27+00:00" }, { "createdAt": "2024-02-15T23:27:45+00:00", "filter": { "findingType": { "eq": [ "UnusedIAMUserAccessKey" ] } }, "ruleName": "ArchiveRule-56125a39-e517-4ff8-afb1-ef06f58db612", "updatedAt": "2024-02-15T23:27:45+00:00" } ] } ``` Para obter mais informações, consulte [Usar o AWS Identity and Access Management Access Analyzer](https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [ListArchiveRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/list-archive-rules.html) na *Referência de comandos da AWS CLI*. ### `list-findings-v2` O código de exemplo a seguir mostra como usar `list-findings-v2`. **AWS CLI** **Para recuperar uma lista de descobertas geradas pelo analisador especificado** O exemplo `list-findings-v2` a seguir recupera uma lista de descobertas geradas pelo analisador especificado em sua conta da AWS. Este exemplo filtra os resultados para incluir somente perfis do IAM cujo nome contenha `Cognito`. ``` aws accessanalyzer list-findings-v2 \ --analyzer-arn arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-account \ --filter '{"resource": {"contains": ["Cognito"]}, "resourceType": {"eq": ["AWS::IAM::Role"]}}' ``` Resultado: ``` { "findings": [ { "analyzedAt": "2024-02-16T18:17:47.888000+00:00", "createdAt": "2021-02-26T21:17:24.710000+00:00", "id": "597f3bc2-3adc-4c18-9879-5c4b23485e46", "resource": "arn:aws:iam::111122223333:role/Cognito_testpoolUnauth_Role", "resourceType": "AWS::IAM::Role", "resourceOwnerAccount": "111122223333", "status": "ACTIVE", "updatedAt": "2021-02-26T21:17:24.710000+00:00", "findingType": "ExternalAccess" }, { "analyzedAt": "2024-02-16T18:17:47.888000+00:00", "createdAt": "2021-02-26T21:17:50.905000+00:00", "id": "ce0e221a-85b9-4d52-91ff-d7678075442f", "resource": "arn:aws:iam::111122223333:role/Cognito_testpoolAuth_Role", "resourceType": "AWS::IAM::Role", "resourceOwnerAccount": "111122223333", "status": "ACTIVE", "updatedAt": "2021-02-26T21:17:50.905000+00:00", "findingType": "ExternalAccess" } ] } ``` Para obter mais informações, consulte [Usar o AWS Identity and Access Management Access Analyzer](https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [ListFindingsV2](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/list-findings-v2.html) na *Referência de comandos da AWS CLI*. ### `list-findings` O código de exemplo a seguir mostra como usar `list-findings`. **AWS CLI** **Para recuperar uma lista de descobertas geradas pelo analisador especificado** O exemplo `list-findings` a seguir recupera uma lista de descobertas geradas pelo analisador especificado em sua conta da AWS. Este exemplo filtra os resultados para incluir somente perfis do IAM cujo nome contenha `Cognito`. ``` aws accessanalyzer list-findings \ --analyzer-arn arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-account \ --filter '{"resource": {"contains": ["Cognito"]}, "resourceType": {"eq": ["AWS::IAM::Role"]}}' ``` Resultado: ``` { "findings": [ { "id": "597f3bc2-3adc-4c18-9879-5c4b23485e46", "principal": { "Federated": "cognito-identity.amazonaws.com" }, "action": [ "sts:AssumeRoleWithWebIdentity" ], "resource": "arn:aws:iam::111122223333:role/Cognito_testpoolUnauth_Role", "isPublic": false, "resourceType": "AWS::IAM::Role", "condition": { "cognito-identity.amazonaws.com:aud": "us-west-2:EXAMPLE0-0000-0000-0000-000000000000" }, "createdAt": "2021-02-26T21:17:24.710000+00:00", "analyzedAt": "2024-02-16T18:17:47.888000+00:00", "updatedAt": "2021-02-26T21:17:24.710000+00:00", "status": "ACTIVE", "resourceOwnerAccount": "111122223333" }, { "id": "ce0e221a-85b9-4d52-91ff-d7678075442f", "principal": { "Federated": "cognito-identity.amazonaws.com" }, "action": [ "sts:AssumeRoleWithWebIdentity" ], "resource": "arn:aws:iam::111122223333:role/Cognito_testpoolAuth_Role", "isPublic": false, "resourceType": "AWS::IAM::Role", "condition": { "cognito-identity.amazonaws.com:aud": "us-west-2:EXAMPLE0-0000-0000-0000-000000000000" }, "createdAt": "2021-02-26T21:17:50.905000+00:00", "analyzedAt": "2024-02-16T18:17:47.888000+00:00", "updatedAt": "2021-02-26T21:17:50.905000+00:00", "status": "ACTIVE", "resourceOwnerAccount": "111122223333" } ] } ``` Para obter mais informações, consulte [Usar o AWS Identity and Access Management Access Analyzer](https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [ListFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/list-findings.html) na *Referência de comandos da AWS CLI*. ### `list-policy-generations` O código de exemplo a seguir mostra como usar `list-policy-generations`. **AWS CLI** **Para listar todas as gerações de políticas solicitadas nos últimos sete dias** O exemplo `list-policy-generations` a seguir lista todas as gerações de políticas solicitadas nos últimos sete dias em sua conta da AWS. ``` aws accessanalyzer list-policy-generations ``` Resultado: ``` { "policyGenerations": [ { "completedOn": "2024-02-14T23:43:38+00:00", "jobId": "923a56b0-ebb8-4e80-8a3c-a11ccfbcd6f2", "principalArn": "arn:aws:iam::111122223333:role/Admin", "startedOn": "2024-02-14T23:43:02+00:00", "status": "CANCELED" }, { "completedOn": "2024-02-14T22:47:01+00:00", "jobId": "c557dc4a-0338-4489-95dd-739014860ff9", "principalArn": "arn:aws:iam::111122223333:role/Admin", "startedOn": "2024-02-14T22:44:41+00:00", "status": "SUCCEEDED" } ] } ``` Para obter mais informações, consulte [Geração de política do IAM Access Analyzer](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-policy-generation.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [ListPolicyGenerations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/list-policy-generations.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para recuperar uma lista de tags aplicadas ao recurso especificado** O exemplo `list-tags-for-resource` a seguir recupera uma lista de tags aplicadas ao recurso especificado em sua conta da AWS. ``` aws accessanalyzer list-tags-for-resource \ --resource-arn arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-account ``` Resultado: ``` { "tags": { "Zone-of-trust": "Account", "Name": "ConsoleAnalyzer" } } ``` Para obter mais informações, consulte [Geração de política do IAM Access Analyzer](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-policy-generation.html) no *Guia do usuário do AWS IAM*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `start-policy-generation` O código de exemplo a seguir mostra como usar `start-policy-generation`. **AWS CLI** **Para iniciar uma solicitação de geração de política** O exemplo `start-policy-generation` a seguir inicia uma solicitação de geração de política em sua conta da AWS. ``` aws accessanalyzer start-policy-generation \ --policy-generation-details '{"principalArn":"arn:aws:iam::111122223333:role/Admin"}' \ --cloud-trail-details file://myfile.json ``` Conteúdo de `myfile.json`: ``` { "accessRole": "arn:aws:iam::111122223333:role/service-role/AccessAnalyzerMonitorServiceRole", "startTime": "2024-02-13T00:30:00Z", "trails": [ { "allRegions": true, "cloudTrailArn": "arn:aws:cloudtrail:us-west-2:111122223333:trail/my-trail" } ] } ``` Resultado: ``` { "jobId": "c557dc4a-0338-4489-95dd-739014860ff9" } ``` Para obter mais informações, consulte [Geração de política do IAM Access Analyzer](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-policy-generation.html) no *Guia do usuário do AWS IAM*. + Para obter detalhes a API, consulte [StartPolicyGeneration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/start-policy-generation.html) na *Referência de comandos da AWS CLI*. ### `start-resource-scan` O código de exemplo a seguir mostra como usar `start-resource-scan`. **AWS CLI** **Para iniciar imediatamente uma verificação das políticas aplicadas ao recurso especificado** O exemplo `start-resource-scan` a seguir inicia imediatamente uma verificação das políticas aplicadas ao recurso especificado em sua conta da AWS. ``` aws accessanalyzer start-resource-scan \ --analyzer-arn arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-account \ --resource-arn arn:aws:iam::111122223333:role/Cognito_testpoolAuth_Role ``` Este comando não produz saída. Para obter mais informações, consulte [Geração de política do IAM Access Analyzer](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-policy-generation.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [StartResourceScan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/start-resource-scan.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Para adicionar uma tag ao recurso especificado** O exemplo `tag-resource` a seguir adiciona uma tag ao compartilhamento de recursos especificado em sua conta da AWS. ``` aws accessanalyzer tag-resource \ --resource-arn arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-account \ --tags Environment=dev,Purpose=testing ``` Este comando não produz saída. Para obter mais informações, consulte [Usar o AWS Identity and Access Management Access Analyzer](https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html) no *Guia do usuário do AWS IAM*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover tags dos recursos especificados** O exemplo `untag-resource` a seguir remove as tags do recurso especificado em sua conta da AWS. ``` aws accessanalyzer untag-resource \ --resource-arn arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-account \ --tag-keys Environment Purpose ``` Este comando não produz saída. Para obter mais informações, consulte [Usar o AWS Identity and Access Management Access Analyzer](https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html) no *Guia do usuário do AWS IAM*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-archive-rule` O código de exemplo a seguir mostra como usar `update-archive-rule`. **AWS CLI** **Para atualizar os critérios e valores da regra de arquivamento especificada** O exemplo `update-archive-rule` a seguir atualiza os critérios e os valores da regra de arquivamento especificada em sua conta da AWS. ``` aws accessanalyzer update-archive-rule \ --analyzer-name UnusedAccess-ConsoleAnalyzer-organization \ --rule-name MyArchiveRule \ --filter '{"resource": {"contains": ["Cognito"]}, "resourceType": {"eq": ["AWS::IAM::Role"]}}' ``` Este comando não produz saída. Para obter mais informações, consulte [Regras de arquivamento](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-archive-rules.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [UpdateArchiveRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/update-archive-rule.html) na *Referência de comandos da AWS CLI*. ### `update-findings` O código de exemplo a seguir mostra como usar `update-findings`. **AWS CLI** **Para atualizar o status das descobertas especificadas** O exemplo `update-findings` a seguir atualiza o status das descobertas especificadas em sua conta da AWS. ``` aws accessanalyzer update-findings \ --analyzer-arn arn:aws:access-analyzer:us-west-2:111122223333:analyzer/UnusedAccess-ConsoleAnalyzer-organization \ --ids 4f319ac3-2e0c-4dc4-bf51-7013a086b6ae 780d586a-2cce-4f72-aff6-359d450e7500 \ --status ARCHIVED ``` Este comando não produz saída. Para obter mais informações, consulte [Usar o AWS Identity and Access Management Access Analyzer](https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [UpdateFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/update-findings.html) na *Referência de comandos da AWS CLI*. ### `validate-policy` O código de exemplo a seguir mostra como usar `validate-policy`. **AWS CLI** **Para solicitar a validação de uma política e retornar uma lista de descobertas** O exemplo `validate-policy` a seguir solicita a validação de uma política e retorna uma lista de descobertas. A política no exemplo é uma política de confiança na função para uma função do Amazon Cognito usada para federação de identidades na web. As descobertas geradas a partir da política de confiança estão relacionadas a um valor de elemento `Sid` vazio e a uma entidade principal de política incompatível devido à ação incorreta de assumir a função que está sendo usada, `sts:AssumeRole`. A ação correta de assumir a função para uso com o Cognito é `sts:AssumeRoleWithWebIdentity`. ``` aws accessanalyzer validate-policy \ --policy-document file://myfile.json \ --policy-type RESOURCE_POLICY ``` Conteúdo de `myfile.json`: ``` { "Version":"2012-10-17", "Statement": [ { "Sid": "", "Effect": "Allow", "Principal": { "Federated": "cognito-identity.amazonaws.com" }, "Action": [ "sts:AssumeRole", "sts:TagSession" ], "Condition": { "StringEquals": { "cognito-identity.amazonaws.com:aud": "us-west-2_EXAMPLE" } } } ] } ``` Resultado: ``` { "findings": [ { "findingDetails": "Add a value to the empty string in the Sid element.", "findingType": "SUGGESTION", "issueCode": "EMPTY_SID_VALUE", "learnMoreLink": "https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-policy-checks.html#access-analyzer-reference-policy-checks-suggestion-empty-sid-value", "locations": [ { "path": [ { "value": "Statement" }, { "index": 0 }, { "value": "Sid" } ], "span": { "end": { "column": 21, "line": 5, "offset": 81 }, "start": { "column": 19, "line": 5, "offset": 79 } } } ] }, { "findingDetails": "The sts:AssumeRole action is invalid with the following principal(s): cognito-identity.amazonaws.com. Use a SAML provider principal with the sts:AssumeRoleWithSAML action or use an OIDC provider principal with the sts:AssumeRoleWithWebIdentity action. Ensure the provider is Federated if you use either of the two options.", "findingType": "ERROR", "issueCode": "MISMATCHED_ACTION_FOR_PRINCIPAL", "learnMoreLink": "https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-policy-checks.html#access-analyzer-reference-policy-checks-error-mismatched-action-for-principal", "locations": [ { "path": [ { "value": "Statement" }, { "index": 0 }, { "value": "Action" }, { "index": 0 } ], "span": { "end": { "column": 32, "line": 11, "offset": 274 }, "start": { "column": 16, "line": 11, "offset": 258 } } }, { "path": [ { "value": "Statement" }, { "index": 0 }, { "value": "Principal" }, { "value": "Federated" } ], "span": { "end": { "column": 61, "line": 8, "offset": 202 }, "start": { "column": 29, "line": 8, "offset": 170 } } } ] }, { "findingDetails": "The following actions: sts:TagSession are not supported by the condition key cognito-identity.amazonaws.com:aud. The condition will not be evaluated for these actions. We recommend that you move these actions to a different statement without this condition key.", "findingType": "ERROR", "issueCode": "UNSUPPORTED_ACTION_FOR_CONDITION_KEY", "learnMoreLink": "https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-policy-checks.html#access-analyzer-reference-policy-checks-error-unsupported-action-for-condition-key", "locations": [ { "path": [ { "value": "Statement" }, { "index": 0 }, { "value": "Action" }, { "index": 1 } ], "span": { "end": { "column": 32, "line": 12, "offset": 308 }, "start": { "column": 16, "line": 12, "offset": 292 } } }, { "path": [ { "value": "Statement" }, { "index": 0 }, { "value": "Condition" }, { "value": "StringEquals" }, { "value": "cognito-identity.amazonaws.com:aud" } ], "span": { "end": { "column": 79, "line": 16, "offset": 464 }, "start": { "column": 58, "line": 16, "offset": 443 } } } ] } ] } ``` Para obter mais informações, consulte [Verificações de validação de políticas](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-checks-validating-policies.html) no *Guia do usuário do AWS IAM*. + Para ver detalhes da API, consulte [ValidatePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/validate-policy.html) na *Referência de comandos da AWS CLI*. # Exemplos do Image Builder usando AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Image Builder. *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 ### `create-component` O código de exemplo a seguir mostra como usar `create-component`. **AWS CLI** **Criar um componente** O exemplo `create-component` a seguir cria um componente que usa um arquivo de documento JSON e faz referência a um documento de componente no formato YAML carregado em um bucket do Amazon S3. ``` aws imagebuilder create-component \ --cli-input-json file://create-component.json ``` Conteúdo de `create-component.json`: ``` { "name": "MyExampleComponent", "semanticVersion": "2019.12.02", "description": "An example component that builds, validates and tests an image", "changeDescription": "Initial version.", "platform": "Windows", "uri": "s3://s3-bucket-name/s3-bucket-path/component.yaml" } ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/examplecomponent/2019.12.02/1" } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [CreateComponent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/create-component.html) na *Referência de comandos da AWS CLI*. ### `create-distribution-configuration` O código de exemplo a seguir mostra como usar `create-distribution-configuration`. **AWS CLI** **Criar uma configuração de distribuição** O exemplo `create-distribution-configuration` a seguir cria uma configuração de distribuição usando um arquivo JSON. ``` aws imagebuilder create-distribution-configuration \ --cli-input-json file:/create-distribution-configuration.json ``` Conteúdo de `create-distribution-configuration.json`: ``` { "name": "MyExampleDistribution", "description": "Copies AMI to eu-west-1", "distributions": [ { "region": "us-west-2", "amiDistributionConfiguration": { "name": "Name {{imagebuilder:buildDate}}", "description": "An example image name with parameter references", "amiTags": { "KeyName": "{{ssm:parameter_name}}" }, "launchPermission": { "userIds": [ "123456789012" ] } } }, { "region": "eu-west-1", "amiDistributionConfiguration": { "name": "My {{imagebuilder:buildVersion}} image {{imagebuilder:buildDate}}", "amiTags": { "KeyName": "Value" }, "launchPermission": { "userIds": [ "123456789012" ] } } } ] } ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution" } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [CreateDistributionConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/create-distribution-configuration.html) na *Referência de comandos da AWS CLI*. ### `create-image-pipeline` O código de exemplo a seguir mostra como usar `create-image-pipeline`. **AWS CLI** **Criar um pipeline de imagens** O exemplo `create-image-pipeline` a seguir cria um pipeline de imagens usando um arquivo JSON. ``` aws imagebuilder create-image-pipeline \ --cli-input-json file://create-image-pipeline.json ``` Conteúdo de `create-image-pipeline.json`: ``` { "name": "MyWindows2016Pipeline", "description": "Builds Windows 2016 Images", "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure", "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution", "imageTestsConfiguration": { "imageTestsEnabled": true, "timeoutMinutes": 60 }, "schedule": { "scheduleExpression": "cron(0 0 * * SUN)", "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE" }, "status": "ENABLED" } ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline" } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [CreateImagePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/create-image-pipeline.html) na *Referência de comandos da AWS CLI*. ### `create-image-recipe` O código de exemplo a seguir mostra como usar `create-image-recipe`. **AWS CLI** **Criar uma fórmula** O exemplo `create-image-recipe` a seguir cria uma fórmula de imagem usando um arquivo JSON. Os componentes são instalados na ordem em que estão especificados. ``` aws imagebuilder create-image-recipe \ --cli-input-json file://create-image-recipe.json ``` Conteúdo de `create-image-recipe.json`: ``` { "name": "MyBasicRecipe", "description": "This example image recipe creates a Windows 2016 image.", "semanticVersion": "2019.12.03", "components": [ { "componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1" }, { "componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myimportedcomponent/1.0.0/1" } ], "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/xxxx.x.x" } ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03" } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [CreateImageRecipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/create-image-recipe.html) na *Referência de comandos da AWS CLI*. ### `create-image` O código de exemplo a seguir mostra como usar `create-image`. **AWS CLI** **Criar uma imagem** O exemplo `create-image` a seguir cria uma imagem. ``` aws imagebuilder create-image \ --image-recipe-arn arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03 \ --infrastructure-configuration-arn arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1" } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [CreateImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/create-image.html) na *Referência de comandos da AWS CLI*. ### `create-infrastructure-configuration` O código de exemplo a seguir mostra como usar `create-infrastructure-configuration`. **AWS CLI** **Criar uma configuração de infraestrutura** O exemplo `create-infrastructure-configuration` a seguir cria uma configuração de infraestrutura usando um arquivo JSON. ``` aws imagebuilder create-infrastructure-configuration \ --cli-input-json file://create-infrastructure-configuration.json ``` Conteúdo de `create-infrastructure-configuration.json`: ``` { "name": "MyExampleInfrastructure", "description": "An example that will retain instances of failed builds", "instanceTypes": [ "m5.large", "m5.xlarge" ], "instanceProfileName": "EC2InstanceProfileForImageBuilder", "securityGroupIds": [ "sg-a1b2c3d4" ], "subnetId": "subnet-a1b2c3d4", "logging": { "s3Logs": { "s3BucketName": "bucket-name", "s3KeyPrefix": "bucket-path" } }, "keyPair": "key-pair-name", "terminateInstanceOnFailure": false, "snsTopicArn": "arn:aws:sns:us-west-2:123456789012:sns-topic-name" } ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure" } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [CreateInfrastructureConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/create-infrastructure-configuration.html) na *Referência de comandos da AWS CLI*. ### `delete-component` O código de exemplo a seguir mostra como usar `delete-component`. **AWS CLI** **Excluir um componente** O exemplo `delete-component` a seguir exclui uma versão de compilação de componente especificando seu ARN. ``` aws imagebuilder delete-component \ --component-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1 ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1" } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [DeleteComponent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/delete-component.html) na * Referência do comando da AWS CLI*. ### `delete-image-pipeline` O código de exemplo a seguir mostra como usar `delete-image-pipeline`. **AWS CLI** **Excluir um pipeline de imagens** O exemplo `delete-image-pipeline` a seguir exclui um pipeline de imagens especificando seu ARN. ``` aws imagebuilder delete-image-pipeline \ --image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/my-example-pipeline ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline" } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [DeleteImagePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/delete-image-pipeline.html) na *Referência de comandos da AWS CLI*. ### `delete-image-recipe` O código de exemplo a seguir mostra como usar `delete-image-recipe`. **AWS CLI** **Excluir uma fórmula de imagem** O exemplo `delete-image-recipe` a seguir mostra como excluir uma fórmula de imagem especificando seu ARN. ``` aws imagebuilder delete-image-recipe \ --image-recipe-arn arn:aws:imagebuilder:us-east-1:123456789012:image-recipe/mybasicrecipe/2019.12.03 ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03" } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [DeleteImageRecipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/delete-image-recipe.html) na *Referência de comandos da AWS CLI*. ### `delete-image` O código de exemplo a seguir mostra como usar `delete-image`. **AWS CLI** **Excluir uma imagem** O exemplo `delete-image` a seguir exclui uma versão de criação de imagem especificando seu ARN. ``` aws imagebuilder delete-image \ --image-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:image/my-example-image/2019.12.02/1 ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1" } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [DeleteImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/delete-image.html) na *Referência de comandos da AWS CLI*. ### `delete-infrastructure-configuration` O código de exemplo a seguir mostra como usar `delete-infrastructure-configuration`. **AWS CLI** **Excluir uma configuração de infraestrutura** O exemplo `delete-infrastructure-configuration` a seguir exclui um pipeline de imagens especificando seu ARN. ``` aws imagebuilder delete-infrastructure-configuration \ --infrastructure-configuration-arn arn:aws:imagebuilder:us-east-1:123456789012:infrastructure-configuration/myexampleinfrastructure ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure" } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [DeleteInfrastructureConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/delete-infrastructure-configuration.html) na *Referência de comandos da AWS CLI*. ### `get-component-policy` O código de exemplo a seguir mostra como usar `get-component-policy`. **AWS CLI** **Obter detalhes da política de componentes** O exemplo `get-component-policy` a seguir lista os detalhes de uma política de componente especificando seu ARN. ``` aws imagebuilder get-component-policy \ --component-arn arn:aws:imagebuilder:us-west-2:123456789012:component/my-example-component/2019.12.03/1 ``` Resultado: ``` { "Policy": "{ "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": [ "123456789012" ] }, "Action": [ "imagebuilder:GetComponent", "imagebuilder:ListComponents" ], "Resource": [ "arn:aws:imagebuilder:us-west-2:123456789012:component/my-example-component/2019.12.03/1" ] } ] }" } ``` Para obter mais informações, consulte Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI `\$1\$1 no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [GetComponentPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-component-policy.html) na *Referência de comandos da AWS CLI*. ### `get-component` O código de exemplo a seguir mostra como usar `get-component`. **AWS CLI** **Obter detalhes do componente** O exemplo `get-component` a seguir lista os detalhes de um componente especificando seu ARN. ``` aws imagebuilder get-component \ --component-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:component/component-name/1.0.0/1 ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "component": { "arn": "arn:aws:imagebuilder:us-west-2:123456789012:component/component-name/1.0.0/1", "name": "component-name", "version": "1.0.0", "type": "TEST", "platform": "Linux", "owner": "123456789012", "data": "name: HelloWorldTestingDocument\ndescription: This is hello world testing document.\nschemaVersion: 1.0\n\nphases:\n - name: test\n steps:\n - name: HelloWorldStep\n action: ExecuteBash\n inputs:\n commands:\n - echo \"Hello World! Test.\"\n", "encrypted": true, "dateCreated": "2020-01-27T20:43:30.306Z", "tags": {} } } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [GetComponent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-component.html) na * Referência do comando da AWS CLI*. ### `get-distribution-configuration` O código de exemplo a seguir mostra como usar `get-distribution-configuration`. **AWS CLI** **Obter os detalhes de uma configuração de distribuição** O exemplo `get-distribution-configuration` a seguir exibe os detalhes de uma configuração de distribuição especificando seu ARN. ``` aws imagebuilder get-distribution-configuration \ --distribution-configuration-arn arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "distributionConfiguration": { "arn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution", "name": "MyExampleDistribution", "description": "Copies AMI to eu-west-1 and exports to S3", "distributions": [ { "region": "us-west-2", "amiDistributionConfiguration": { "name": "Name {{imagebuilder:buildDate}}", "description": "An example image name with parameter references", "amiTags": { "KeyName": "{{ssm:parameter_name}}" }, "launchPermission": { "userIds": [ "123456789012" ] } } }, { "region": "eu-west-1", "amiDistributionConfiguration": { "name": "My {{imagebuilder:buildVersion}} image {{imagebuilder:buildDate}}", "amiTags": { "KeyName": "Value" }, "launchPermission": { "userIds": [ "123456789012" ] } } } ], "dateCreated": "2020-02-19T18:40:10.529Z", "tags": {} } } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [GetDistributionConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-distribution-configuration.html) na *Referência de comandos da AWS CLI*. ### `get-image-pipeline` O código de exemplo a seguir mostra como usar `get-image-pipeline`. **AWS CLI** **Obter detalhes do pipeline de imagens** O exemplo `get-image-pipeline` a seguir mostra como excluir um pipeline de imagens especificando seu ARN. ``` aws imagebuilder get-image-pipeline \ --image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "imagePipeline": { "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline", "name": "MyWindows2016Pipeline", "description": "Builds Windows 2016 Images", "platform": "Windows", "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure", "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution", "imageTestsConfiguration": { "imageTestsEnabled": true, "timeoutMinutes": 60 }, "schedule": { "scheduleExpression": "cron(0 0 * * SUN)", "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE" }, "status": "ENABLED", "dateCreated": "2020-02-19T19:04:01.253Z", "dateUpdated": "2020-02-19T19:04:01.253Z", "tags": {} } } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [GetImagePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-image-pipeline.html) na *Referência de comandos da AWS CLI*. ### `get-image-policy` O código de exemplo a seguir mostra como usar `get-image-policy`. **AWS CLI** **Obter detalhes da política de imagens** O exemplo `get-image-policy` a seguir lista os detalhes de uma política de imagem especificando seu ARN. ``` aws imagebuilder get-image-policy \ --image-arn arn:aws:imagebuilder:us-west-2:123456789012:image/my-example-image/2019.12.03/1 ``` Resultado: ``` { "Policy": "{ "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": [ "123456789012" ] }, "Action": [ "imagebuilder:GetImage", "imagebuilder:ListImages" ], "Resource": [ "arn:aws:imagebuilder:us-west-2:123456789012:image/my-example-image/2019.12.03/1" ] } ] }" } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [GetImagePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-image-policy.html) na *Referência de comandos da AWS CLI*. ### `get-image-recipe-policy` O código de exemplo a seguir mostra como usar `get-image-recipe-policy`. **AWS CLI** **Obter detalhes da política de fórmula de imagem** O exemplo `get-image-recipe-policy` a seguir lista os detalhes de uma política de fórmula de imagem especificando seu ARN. ``` aws imagebuilder get-image-recipe-policy \ --image-recipe-arn arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/my-example-image-recipe/2019.12.03/1 ``` Resultado: ``` { "Policy": "{ "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": [ "123456789012" ] }, "Action": [ "imagebuilder:GetImageRecipe", "imagebuilder:ListImageRecipes" ], "Resource": [ "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/my-example-image-recipe/2019.12.03/1" ] } ] }" } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [GetImageRecipePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-image-recipe-policy.html) na *Referência de comandos da AWS CLI*. ### `get-image` O código de exemplo a seguir mostra como usar `get-image`. **AWS CLI** **Obter detalhes da imagem** O exemplo `get-image` a seguir lista os detalhes de uma imagem especificando seu ARN. ``` aws imagebuilder get-image \ --image-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1 ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "image": { "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1", "name": "MyBasicRecipe", "version": "2019.12.03/1", "platform": "Windows", "state": { "status": "BUILDING" }, "imageRecipe": { "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03", "name": "MyBasicRecipe", "description": "This example image recipe creates a Windows 2016 image.", "platform": "Windows", "version": "2019.12.03", "components": [ { "componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1" }, { "componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myimportedcomponent/1.0.0/1" } ], "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/2019.12.17/1", "dateCreated": "2020-02-14T19:46:16.904Z", "tags": {} }, "infrastructureConfiguration": { "arn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure", "name": "MyExampleInfrastructure", "description": "An example that will retain instances of failed builds", "instanceTypes": [ "m5.large", "m5.xlarge" ], "instanceProfileName": "EC2InstanceProfileForImageFactory", "securityGroupIds": [ "sg-a1b2c3d4" ], "subnetId": "subnet-a1b2c3d4", "logging": { "s3Logs": { "s3BucketName": "bucket-name", "s3KeyPrefix": "bucket-path" } }, "keyPair": "Sam", "terminateInstanceOnFailure": false, "snsTopicArn": "arn:aws:sns:us-west-2:123456789012:sns-name", "dateCreated": "2020-02-14T21:21:05.098Z", "tags": {} }, "imageTestsConfiguration": { "imageTestsEnabled": true, "timeoutMinutes": 720 }, "dateCreated": "2020-02-14T23:14:13.597Z", "outputResources": { "amis": [] }, "tags": {} } } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [GetImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-image.html) na *Referência de comandos da AWS CLI*. ### `get-infrastructure-configuration` O código de exemplo a seguir mostra como usar `get-infrastructure-configuration`. **AWS CLI** **Obter detalhes da configuração de infraestrutura** O exemplo `get-infrastructure-configuration` a seguir mostra como excluir um recurso de configuração de infraestrutura especificando seu ARN. ``` aws imagebuilder get-infrastructure-configuration \ --infrastructure-configuration-arn arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "infrastructureConfiguration": { "arn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure", "name": "MyExampleInfrastructure", "description": "An example that will retain instances of failed builds", "instanceTypes": [ "m5.large", "m5.xlarge" ], "instanceProfileName": "EC2InstanceProfileForImageBuilder", "securityGroupIds": [ "sg-a48c95ef" ], "subnetId": "subnet-a48c95ef", "logging": { "s3Logs": { "s3BucketName": "bucket-name", "s3KeyPrefix": "bucket-path" } }, "keyPair": "Name", "terminateInstanceOnFailure": false, "snsTopicArn": "arn:aws:sns:us-west-2:123456789012:sns-name", "dateCreated": "2020-02-19T19:11:51.858Z", "tags": {} } } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [GetInfrastructureConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-infrastructure-configuration.html) na *Referência de comandos da AWS CLI*. ### `import-component` O código de exemplo a seguir mostra como usar `import-component`. **AWS CLI** **Importar um componente** O exemplo `import-component` a seguir importa um script preexistente usando um arquivo JSON. ``` aws imagebuilder import-component \ --cli-input-json file://import-component.json ``` Conteúdo de `import-component.json`: ``` { "name": "MyImportedComponent", "semanticVersion": "1.0.0", "description": "An example of how to import a component", "changeDescription": "First commit message.", "format": "SHELL", "platform": "Windows", "type": "BUILD", "uri": "s3://s3-bucket-name/s3-bucket-path/component.yaml" } ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myimportedcomponent/1.0.0/1" } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [ImportComponent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/import-component.html) na *Referência de comandos da AWS CLI*. ### `list-component-build-versions` O código de exemplo a seguir mostra como usar `list-component-build-versions`. **AWS CLI** **Listar versões de compilação do componente** O exemplo `list-component-build-versions` a seguir lista as versões de compilação de componentes com uma versão semântica específica. ``` aws imagebuilder list-component-build-versions --component-version-arn arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02 ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "componentSummaryList": [ { "arn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1", "name": "MyExampleComponent", "version": "2019.12.02", "platform": "Windows", "type": "BUILD", "owner": "123456789012", "description": "An example component that builds, validates and tests an image", "changeDescription": "Initial version.", "dateCreated": "2020-02-19T18:53:45.940Z", "tags": { "KeyName": "KeyValue" } } ] } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [ListComponentBuildVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-component-build-versions.html) na *Referência de comandos da AWS CLI*. ### `list-components` O código de exemplo a seguir mostra como usar `list-components`. **AWS CLI** **Listar todas as versões semânticas do componente** O exemplo `list-components` a seguir lista todas as versões semânticas do componente às quais você tem acesso. Como opção, é possível definir se deseja listar componentes de sua propriedade, da Amazon ou que foram compartilhados com você por outras contas. ``` aws imagebuilder list-components ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "componentVersionList": [ { "arn": "arn:aws:imagebuilder:us-west-2:123456789012:component/component-name/1.0.0", "name": "component-name", "version": "1.0.0", "platform": "Linux", "type": "TEST", "owner": "123456789012", "dateCreated": "2020-01-27T20:43:30.306Z" } ] } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [ListComponents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-components.html) na * Referência do comando da AWS CLI*. ### `list-distribution-configurations` O código de exemplo a seguir mostra como usar `list-distribution-configurations`. **AWS CLI** **Listar distribuições** O exemplo `list-distribution-configurations` a seguir lista todas as suas distribuições. ``` aws imagebuilder list-distribution-configurations ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "distributionConfigurationSummaryList": [ { "arn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution", "name": "MyExampleDistribution", "description": "Copies AMI to eu-west-1 and exports to S3", "dateCreated": "2020-02-19T18:40:10.529Z", "tags": { "KeyName": "KeyValue" } } ] } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [ListDistributionConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-distribution-configurations.html) na *Referência de comandos da AWS CLI*. ### `list-image-build-versions` O código de exemplo a seguir mostra como usar `list-image-build-versions`. **AWS CLI** **Listar versões de criação de imagem** O exemplo `list-image-build-versions` a seguir lista todas as versões de criação de imagem com uma versão semântica. ``` aws imagebuilder list-image-build-versions \ --image-version-arn arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03 ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "imageSummaryList": [ { "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/7", "name": "MyBasicRecipe", "version": "2019.12.03/7", "platform": "Windows", "state": { "status": "FAILED", "reason": "Can't start SSM Automation for arn arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/7 during building. Parameter \"iamInstanceProfileName\" has a null value." }, "owner": "123456789012", "dateCreated": "2020-02-19T18:56:11.511Z", "outputResources": { "amis": [] }, "tags": {} }, { "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/6", "name": "MyBasicRecipe", "version": "2019.12.03/6", "platform": "Windows", "state": { "status": "FAILED", "reason": "An internal error has occurred." }, "owner": "123456789012", "dateCreated": "2020-02-18T22:49:08.142Z", "outputResources": { "amis": [ { "region": "us-west-2", "image": "ami-a1b2c3d4567890ab", "name": "MyBasicRecipe 2020-02-18T22-49-38.704Z", "description": "This example image recipe creates a Windows 2016 image." }, { "region": "us-west-2", "image": "ami-a1b2c3d4567890ab", "name": "Name 2020-02-18T22-49-08.131Z", "description": "Copies AMI to eu-west-2 and exports to S3" }, { "region": "eu-west-2", "image": "ami-a1b2c3d4567890ab", "name": "My 6 image 2020-02-18T22-49-08.131Z", "description": "Copies AMI to eu-west-2 and exports to S3" } ] }, "tags": {} }, { "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/5", "name": "MyBasicRecipe", "version": "2019.12.03/5", "platform": "Windows", "state": { "status": "AVAILABLE" }, "owner": "123456789012", "dateCreated": "2020-02-18T16:51:48.403Z", "outputResources": { "amis": [ { "region": "us-west-2", "image": "ami-a1b2c3d4567890ab", "name": "MyBasicRecipe 2020-02-18T16-52-18.965Z", "description": "This example image recipe creates a Windows 2016 image." } ] }, "tags": {} }, { "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/4", "name": "MyBasicRecipe", "version": "2019.12.03/4", "platform": "Windows", "state": { "status": "AVAILABLE" }, "owner": "123456789012", "dateCreated": "2020-02-18T16:50:01.827Z", "outputResources": { "amis": [ { "region": "us-west-2", "image": "ami-a1b2c3d4567890ab", "name": "MyBasicRecipe 2020-02-18T16-50-32.280Z", "description": "This example image recipe creates a Windows 2016 image." } ] }, "tags": {} }, { "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/3", "name": "MyBasicRecipe", "version": "2019.12.03/3", "platform": "Windows", "state": { "status": "AVAILABLE" }, "owner": "123456789012", "dateCreated": "2020-02-14T23:14:13.597Z", "outputResources": { "amis": [ { "region": "us-west-2", "image": "ami-a1b2c3d4567890ab", "name": "MyBasicRecipe 2020-02-14T23-14-44.243Z", "description": "This example image recipe creates a Windows 2016 image." } ] }, "tags": {} }, { "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/2", "name": "MyBasicRecipe", "version": "2019.12.03/2", "platform": "Windows", "state": { "status": "FAILED", "reason": "SSM execution 'a1b2c3d4-5678-90ab-cdef-EXAMPLE11111' failed with status = 'Failed' and failure message = 'Step fails when it is verifying the command has completed. Command a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 returns unexpected invocation result: \n{Status=[Failed], ResponseCode=[1], Output=[\n----------ERROR-------\nfailed to run commands: exit status 1], OutputPayload=[{\"Status\":\"Failed\",\"ResponseCode\":1,\"Output\":\"\\n----------ERROR-------\\nfailed to run commands: exit status 1\",\"CommandId\":\"a1b2c3d4-5678-90ab-cdef-EXAMPLE11111\"}], CommandId=[a1b2c3d4-5678-90ab-cdef-EXAMPLE11111]}. Please refer to Automation Service Troubleshooting Guide for more diagnosis details.'" }, "owner": "123456789012", "dateCreated": "2020-02-14T22:57:42.593Z", "outputResources": { "amis": [] }, "tags": {} } ] } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [ListImageBuildVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-image-build-versions.html) na *Referência de comandos da AWS CLI*. ### `list-image-pipeline-images` O código de exemplo a seguir mostra como usar `list-image-pipeline-images`. **AWS CLI** **Listar imagens do pipeline de imagens** O exemplo `list-image-pipeline-images` a seguir lista todas as imagens que foram criadas por um pipeline de imagens específico. ``` aws imagebuilder list-image-pipeline-images \ --image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "imagePipelineList": [ { "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline", "name": "MyWindows2016Pipeline", "description": "Builds Windows 2016 Images", "platform": "Windows", "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure", "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution", "imageTestsConfiguration": { "imageTestsEnabled": true, "timeoutMinutes": 60 }, "schedule": { "scheduleExpression": "cron(0 0 * * SUN)", "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE" }, "status": "ENABLED", "dateCreated": "2020-02-19T19:04:01.253Z", "dateUpdated": "2020-02-19T19:04:01.253Z", "tags": { "KeyName": "KeyValue" } }, { "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/sam", "name": "PipelineName", "platform": "Linux", "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/recipe-name-a1b2c3d45678/1.0.0", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/infrastructureconfiguration-name-a1b2c3d45678", "imageTestsConfiguration": { "imageTestsEnabled": true, "timeoutMinutes": 720 }, "status": "ENABLED", "dateCreated": "2019-12-16T18:19:02.068Z", "dateUpdated": "2019-12-16T18:19:02.068Z", "tags": { "KeyName": "KeyValue" } } ] } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [ListImagePipelineImages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-image-pipeline-images.html) na *Referência de comandos da AWS CLI*. ### `list-image-recipes` O código de exemplo a seguir mostra como usar `list-image-recipes`. **AWS CLI** **Listar fórmulas de imagem** O exemplo `list-image-recipes` a seguir lista todas as suas fórmulas de imagem. ``` aws imagebuilder list-image-recipes ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "imageRecipeSummaryList": [ { "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03", "name": "MyBasicRecipe", "platform": "Windows", "owner": "123456789012", "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/2019.x.x", "dateCreated": "2020-02-19T18:54:25.975Z", "tags": { "KeyName": "KeyValue" } }, { "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/recipe-name-a1b2c3d45678/1.0.0", "name": "recipe-name-a1b2c3d45678", "platform": "Linux", "owner": "123456789012", "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/amazon-linux-2-x86/2019.11.21", "dateCreated": "2019-12-16T18:19:00.120Z", "tags": { "KeyName": "KeyValue" } } ] } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [ListImageRecipes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-image-recipes.html) na *Referência de comandos da AWS CLI*. ### `list-images` O código de exemplo a seguir mostra como usar `list-images`. **AWS CLI** **Listar imagens** O exemplo `list-images` a seguir lista todas as versões semânticas às quais você tem acesso. ``` aws imagebuilder list-images ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "imageVersionList": [ { "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03", "name": "MyBasicRecipe", "version": "2019.12.03", "platform": "Windows", "owner": "123456789012", "dateCreated": "2020-02-14T21:29:18.810Z" } ] } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Consulte detalhes da API em [ListImages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-images.html) na *Referência de comandos da AWS CLI*. ### `list-infrastructure-configurations` O código de exemplo a seguir mostra como usar `list-infrastructure-configurations`. **AWS CLI** **Listar as configurações de infraestrutura** O exemplo `list-infrastructure-configurations` a seguir lista todas as suas configurações de infraestrutura. ``` aws imagebuilder list-infrastructure-configurations ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "infrastructureConfigurationSummaryList": [ { "arn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure", "name": "MyExampleInfrastructure", "description": "An example that will retain instances of failed builds", "dateCreated": "2020-02-19T19:11:51.858Z", "tags": {} }, { "arn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/infrastructureconfiguration-name-a1b2c3d45678", "name": "infrastructureConfiguration-name-a1b2c3d45678", "dateCreated": "2019-12-16T18:19:01.038Z", "tags": { "KeyName": "KeyValue" } } ] } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [ListInfrastructureConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-infrastructure-configurations.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Visualizar uma lista de marcações para um recurso da específico** O exemplo `list-tags-for-resource` a seguir lista todas as marcações para um recurso da específico. ``` aws imagebuilder list-tags-for-resource \ --resource-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline ``` Resultado: ``` { "tags": { "KeyName": "KeyValue" } } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `put-component-policy` O código de exemplo a seguir mostra como usar `put-component-policy`. **AWS CLI** **Aplicar uma política de recursos a um componente** O comando `put-component-policy` a seguir aplica uma política de recursos a um componente de criação para permitir o compartilhamento entre contas de componentes de criação. Recomendamos o uso do comando RAM CLI `create-resource-share`. Se você usar o comando EC2 Image Builder CLI `put-component-policy`, também deverá usar o comando RAM CLI `promote-resource-share-create-from-policy` para que o recurso fique visível para todas as entidades principais com as quais o recurso é compartilhado. ``` aws imagebuilder put-component-policy \ --component-arn arn:aws:imagebuilder:us-west-2:123456789012:component/examplecomponent/2019.12.02/1 \ --policy '{ "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": [ "123456789012" ] }, "Action": [ "imagebuilder:GetComponent", "imagebuilder:ListComponents" ], "Resource": [ "arn:aws:imagebuilder:us-west-2:123456789012:component/examplecomponent/2019.12.02/1" ] } ] }' ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/examplecomponent/2019.12.02/1" } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [PutComponentPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/put-component-policy.html) na *Referência de comandos da AWS CLI*. ### `put-image-policy` O código de exemplo a seguir mostra como usar `put-image-policy`. **AWS CLI** **Aplicar uma política de recursos a uma imagem** O comando `put-image-policy` a seguir aplica uma política de recursos a uma imagem para permitir o compartilhamento entre contas de imagens. Recomendamos o uso do comando RAM CLI create-resource-share. Se você usar o comando put-image-policy da CLI do EC2 Image Builder, também deverá usar o comando RAM CLI promote-resource-share-create-from-policy para que o recurso fique visível para todas as entidades principais com as quais o recurso é compartilhado. ``` aws imagebuilder put-image-policy \ --image-arn arn:aws:imagebuilder:us-west-2:123456789012:image/example-image/2019.12.02/1 \ --policy '{ "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": [ "123456789012" ] }, "Action": [ "imagebuilder:GetImage", "imagebuilder:ListImages" ], "Resource": [ "arn:aws:imagebuilder:us-west-2:123456789012:image/example-image/2019.12.02/1" ] } ] }' ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "imageArn": "arn:aws:imagebuilder:us-west-2:123456789012:image/example-image/2019.12.02/1" } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [PutImagePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/put-image-policy.html) na *Referência de comandos da AWS CLI*. ### `put-image-recipe-policy` O código de exemplo a seguir mostra como usar `put-image-recipe-policy`. **AWS CLI** **Aplicar uma política de recursos a uma fórmula de imagem** O comando `put-image-recipe-policy` a seguir aplica uma política de recursos a uma fórmula de imagem para permitir o compartilhamento entre contas de fórmulas de imagem. Recomendamos o uso do comando RAM CLI `create-resource-share`. Se você usar o comando EC2 Image Builder CLI `put-image-recipe-policy`, também deverá usar o comando RAM CLI `promote-resource-share-create-from-policy` para que o recurso fique visível para todas as entidades principais com as quais o recurso é compartilhado. ``` aws imagebuilder put-image-recipe-policy \ --image-recipe-arn arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/example-image-recipe/2019.12.02 \ --policy '{ "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": [ "123456789012" ] }, "Action": [ "imagebuilder:GetImageRecipe", "imagebuilder:ListImageRecipes" ], "Resource": [ "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/example-image-recipe/2019.12.02" ] } ] }' ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/example-image-recipe/2019.12.02/1" } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [PutImageRecipePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/put-image-recipe-policy.html) na *Referência de comandos da AWS CLI*. ### `start-image-pipeline-execution` O código de exemplo a seguir mostra como usar `start-image-pipeline-execution`. **AWS CLI** **Iniciar um pipeline de imagens manualmente** O exemplo `start-image-pipeline-execution` a seguir inicia manualmente um pipeline de imagens. ``` aws imagebuilder start-image-pipeline-execution \ --image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1" } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [StartImagePipelineExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/start-image-pipeline-execution.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como marcar um recurso** O exemplo `tag-resource` a seguir adiciona e marca um recurso ao EC2 Image Builder usando um arquivo JSON. ``` aws imagebuilder tag-resource \ --cli-input-json file://tag-resource.json ``` Conteúdo de `tag-resource.json`: ``` { "resourceArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline", "tags": { "KeyName: "KeyValue" } } ``` Este comando não produz saída. Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover uma tag de um recurso** O exemplo `untag-resource` a seguir remove uma marcação de um recurso usando um arquivo JSON. ``` aws imagebuilder untag-resource \ --cli-input-json file://tag-resource.json ``` Conteúdo de `untag-resource.json`: ``` { "resourceArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline", "tagKeys": [ "KeyName" ] } ``` Este comando não produz saída. Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-distribution-configuration` O código de exemplo a seguir mostra como usar `update-distribution-configuration`. **AWS CLI** **Atualizar configuração de distribuição** O exemplo `update-distribution-configuration` a seguir atualiza uma configuração de distribuição usando um arquivo JSON. ``` aws imagebuilder update-distribution-configuration \ --cli-input-json file://update-distribution-configuration.json ``` Conteúdo de `update-distribution-configuration.json`: ``` { "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution", "description": "Copies AMI to eu-west-2 and exports to S3", "distributions": [ { "region": "us-west-2", "amiDistributionConfiguration": { "name": "Name {{imagebuilder:buildDate}}", "description": "An example image name with parameter references" } }, { "region": "eu-west-2", "amiDistributionConfiguration": { "name": "My {{imagebuilder:buildVersion}} image {{imagebuilder:buildDate}}" } } ] } ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [UpdateDistributionConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/update-distribution-configuration.html) na *Referência de comandos da AWS CLI*. ### `update-image-pipeline` O código de exemplo a seguir mostra como usar `update-image-pipeline`. **AWS CLI** **Criar um pipeline de imagens** O exemplo `update-image-pipeline` a seguir atualiza um pipeline de imagens usando um arquivo JSON. ``` aws imagebuilder update-image-pipeline \ --cli-input-json file://update-image-pipeline.json ``` Conteúdo de `update-image-pipeline.json`: ``` { "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline", "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure", "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution", "imageTestsConfiguration": { "imageTestsEnabled": true, "timeoutMinutes": 120 }, "schedule": { "scheduleExpression": "cron(0 0 * * MON)", "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE" }, "status": "DISABLED" } ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + Para ver detalhes da API, consulte [UpdateImagePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/update-image-pipeline.html) na *Referência de comandos da AWS CLI*. ### `update-infrastructure-configuration` O código de exemplo a seguir mostra como usar `update-infrastructure-configuration`. **AWS CLI** **Atualizar uma configuração de infraestrutura** O exemplo `update-infrastructure-configuration` a seguir atualiza uma configuração de infraestrutura usando um arquivo JSON. ``` aws imagebuilder update-infrastructure-configuration \ --cli-input-json file:/update-infrastructure-configuration.json ``` Conteúdo de `update-infrastructure-configuration.json`: ``` { "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure", "description": "An example that will terminate instances of failed builds", "instanceTypes": [ "m5.large", "m5.2xlarge" ], "instanceProfileName": "EC2InstanceProfileForImageFactory", "securityGroupIds": [ "sg-a48c95ef" ], "subnetId": "subnet-a48c95ef", "logging": { "s3Logs": { "s3BucketName": "bucket-name", "s3KeyPrefix": "bucket-path" } }, "terminateInstanceOnFailure": true, "snsTopicArn": "arn:aws:sns:us-west-2:123456789012:sns-name" } ``` Resultado: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } ``` Para obter mais informações, consulte [Configurando e gerenciando um pipeline de imagem do EC2 Image Builder usando a AWS CLI](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html) no *Guia do usuário do EC2 Image Builder*. + *Para ver detalhes da API, consulte [UpdateInfrastructureConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/update-infrastructure-configuration.html) na Referência de comandos da AWS CLI*. # Exemplos do Incident Manager usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Incident 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 ### `create-replication-set` O código de exemplo a seguir mostra como usar `create-replication-set`. **AWS CLI** **Para criar o conjunto de replicação** O exemplo `create-replication-set` a seguir cria o conjunto de replicação que o Incident Manager usa para replicar e criptografar dados em sua conta da Amazon Web Services. Este exemplo usa as regiões us-east-1 e us-east-2 ao criar o conjunto de replicação. ``` aws ssm-incidents create-replication-set \ --regions '{"us-east-1": {"sseKmsKeyId": "arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"}, "us-east-2": {"sseKmsKeyId": "arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"}}' ``` Resultado: ``` { "replicationSetArns": [ "arn:aws:ssm-incidents::111122223333:replication-set/c4bcb603-4bf9-bb3f-413c-08df53673b57" ] } ``` Para obter mais informações, consulte [Usar o conjunto de replicação do Incident Manager](https://docs.aws.amazon.com/incident-manager/latest/userguide/replication.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [CreateReplicationSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/create-replication-set.html) na *Referência de comandos da AWS CLI*. ### `create-response-plan` O código de exemplo a seguir mostra como usar `create-response-plan`. **AWS CLI** **Para criar um plano de resposta** O exemplo `create-response-plan` a seguir cria um plano de resposta com os detalhes especificados. ``` aws ssm-incidents create-response-plan \ --chat-channel '{"chatbotSns": ["arn:aws:sns:us-east-1:111122223333:Standard_User"]}' \ --display-name "Example response plan" \ --incident-template '{"impact": 5, "title": "example-incident"}' \ --name "example-response" \ --actions '[{"ssmAutomation": {"documentName": "AWSIncidents-CriticalIncidentRunbookTemplate", "documentVersion": "$DEFAULT", "roleArn": "arn:aws:iam::111122223333:role/aws-service-role/ssm-incidents.amazonaws.com/AWSServiceRoleForIncidentManager", "targetAccount": "RESPONSE_PLAN_OWNER_ACCOUNT"}}]' \ --engagements '["arn:aws:ssm-contacts:us-east-1:111122223333:contact/example"]' ``` Resultado: ``` { "arn": "arn:aws:ssm-incidents::111122223333:response-plan/example-response" } ``` Para obter mais informações, consulte [Preparação para incidentes](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-response.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [CreateResponsePlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/create-response-plan.html) na *Referência de comandos da AWS CLI*. ### `create-timeline-event` O código de exemplo a seguir mostra como usar `create-timeline-event`. **AWS CLI** **Exemplo 1: criar um evento do cronograma personalizado** O exemplo `create-timeline-event` a seguir cria um evento do cronograma personalizado no horário especificado no incidente especificado. ``` aws ssm-incidents create-timeline-event \ --event-data "\"example timeline event\"" \ --event-time 2022-10-01T20:30:00.000 \ --event-type "Custom Event" \ --incident-record-arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4EXAMPLE" ``` Resultado: ``` { "eventId": "c0bcc885-a41d-eb01-b4ab-9d2deEXAMPLE", "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4EXAMPLE" } ``` **Exemplo 2: criar um evento do cronograma com uma nota de incidente** O exemplo `create-timeline-event` a seguir cria um evento do cronograma listado no painel “Notas do incidente”. ``` aws ssm-incidents create-timeline-event \ --event-data "\"New Note\"" \ --event-type "Note" \ --incident-record-arn "arn:aws:ssm-incidents::111122223333:incident-record/Test/6cc46130-ca6c-3b38-68f1-f6abeEXAMPLE" \ --event-time 2023-06-20T12:06:00.000 \ --event-references '[{"resource":"arn:aws:ssm-incidents::111122223333:incident-record/Test/6cc46130-ca6c-3b38-68f1-f6abeEXAMPLE"}]' ``` Resultado: ``` { "eventId": "a41dc885-c0bc-b4ab-eb01-de9d2EXAMPLE", "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4EXAMPLE" } ``` Para obter mais informações, consulte [Detalhes de incidentes](https://docs.aws.amazon.com/incident-manager/latest/userguide/tracking-details.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [CreateTimelineEvent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/create-timeline-event.html) na *Referência de comandos da AWS CLI*. ### `delete-incident-record` O código de exemplo a seguir mostra como usar `delete-incident-record`. **AWS CLI** **Para excluir um registro de incidente** O exemplo `delete-incident-record` a seguir exclui o registro de incidentes especificado. ``` aws ssm-incidents delete-incident-record \ --arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" ``` Este comando não produz saída. Para obter mais informações, consulte [Rastreamento de incidentes](https://docs.aws.amazon.com/incident-manager/latest/userguide/tracking.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [DeleteIncidentRecord](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/delete-incident-record.html) na *Referência de comandos da AWS CLI*. ### `delete-replication-set` O código de exemplo a seguir mostra como usar `delete-replication-set`. **AWS CLI** **Para excluir o conjunto de replicação** O exemplo `delete-replication-set` a seguir exclui o conjunto de replicação da sua conta da Amazon Web Services. A exclusão do conjunto de replicação também exclui todos os dados do Incident Manager. Essa ação não pode ser desfeita. ``` aws ssm-incidents delete-replication-set \ --arn "arn:aws:ssm-incidents::111122223333:replication-set/c4bcb603-4bf9-bb3f-413c-08df53673b57" ``` Este comando não produz saída. Para obter mais informações, consulte [Usar o conjunto de replicação do Incident Manager](https://docs.aws.amazon.com/incident-manager/latest/userguide/replication.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [DeleteReplicationSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/delete-replication-set.html) na *Referência de comandos da AWS CLI*. ### `delete-resource-policy` O código de exemplo a seguir mostra como usar `delete-resource-policy`. **AWS CLI** **Para excluir uma política de recurso** O exemplo `delete-resource-policy` a seguir exclui uma política de recursos de um plano de resposta. Isso revogará o acesso da entidade principal ou da organização com a qual o plano de resposta foi compartilhado. ``` aws ssm-incidents delete-resource-policy \ --policy-id "be8b57191f0371f1c6827341aa3f0a03" \ --resource-arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan" ``` Este comando não produz saída. Para obter mais informações, consulte [Como trabalhar com contatos e planos de resposta](https://docs.aws.amazon.com/incident-manager/latest/userguide/sharing.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [DeleteResourcePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/delete-resource-policy.html) na *Referência de comandos da AWS CLI*. ### `delete-response-plan` O código de exemplo a seguir mostra como usar `delete-response-plan`. **AWS CLI** **Para excluir um plano de resposta** O exemplo `delete-response-plan` a seguir exclui o plano de resposta especificado. ``` aws ssm-incidents delete-response-plan \ --arn "arn:aws:ssm-incidents::111122223333:response-plan/example-response" ``` Este comando não produz saída. Para obter mais informações, consulte [Preparação para incidentes](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-response.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [DeleteResponsePlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/delete-response-plan.html) na *Referência de comandos da AWS CLI*. ### `delete-timeline-event` O código de exemplo a seguir mostra como usar `delete-timeline-event`. **AWS CLI** **Para excluir um evento do cronograma** O exemplo `delete-timeline-event` a seguir exclui um evento do cronograma personalizado do registro de incidente especificado. ``` aws ssm-incidents delete-timeline-event \ --event-id "c0bcc885-a41d-eb01-b4ab-9d2de193643c" \ --incident-record-arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" ``` Este comando não produz saída. Para obter mais informações, consulte [Detalhes de incidentes](https://docs.aws.amazon.com/incident-manager/latest/userguide/tracking-details.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [DeleteTimelineEvent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/delete-timeline-event.html) na *Referência de comandos da AWS CLI*. ### `get-incident-record` O código de exemplo a seguir mostra como usar `get-incident-record`. **AWS CLI** **Para obter um registro de incidentes** O exemplo `get-incident-record` a seguir obtém detalhes sobre o registro de incidente especificado. ``` aws ssm-incidents get-incident-record \ --arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" ``` Resultado: ``` { "incidentRecord": { "arn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308", "automationExecutions": [], "creationTime": "2021-05-21T18:16:57.579000+00:00", "dedupeString": "c4bcc812-85e7-938d-2b78-17181176ee1a", "impact": 5, "incidentRecordSource": { "createdBy": "arn:aws:iam::111122223333:user/draliatp", "invokedBy": "arn:aws:iam::111122223333:user/draliatp", "source": "aws.ssm-incidents.custom" }, "lastModifiedBy": "arn:aws:iam::111122223333:user/draliatp", "lastModifiedTime": "2021-05-21T18:16:59.149000+00:00", "notificationTargets": [], "status": "OPEN", "title": "Example-Incident" } } ``` Para obter mais informações, consulte [Detalhes de incidentes](https://docs.aws.amazon.com/incident-manager/latest/userguide/tracking-details.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [GetIncidentRecord](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/get-incident-record.html) na *Referência de comandos da AWS CLI*. ### `get-replication-set` O código de exemplo a seguir mostra como usar `get-replication-set`. **AWS CLI** **Para obter o conjunto de replicação** O exemplo `get-replication-set` a seguir obtém os detalhes do conjunto de replicação que o Incident Manager usa para replicar e criptografar dados em sua conta da Amazon Web Services. ``` aws ssm-incidents get-replication-set \ --arn "arn:aws:ssm-incidents::111122223333:replication-set/c4bcb603-4bf9-bb3f-413c-08df53673b57" ``` Resultado: ``` { "replicationSet": { "createdBy": "arn:aws:sts::111122223333:assumed-role/Admin/username", "createdTime": "2021-05-14T17:57:22.010000+00:00", "deletionProtected": false, "lastModifiedBy": "arn:aws:sts::111122223333:assumed-role/Admin/username", "lastModifiedTime": "2021-05-14T17:57:22.010000+00:00", "regionMap": { "us-east-1": { "sseKmsKeyId": "DefaultKey", "status": "ACTIVE" }, "us-east-2": { "sseKmsKeyId": "DefaultKey", "status": "ACTIVE", "statusMessage": "Tagging inaccessible" } }, "status": "ACTIVE" } } ``` Para obter mais informações, consulte [Usar o conjunto de replicação do Incident Manager](https://docs.aws.amazon.com/incident-manager/latest/userguide/replication.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [GetReplicationSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/get-replication-set.html) na *Referência de comandos da AWS CLI*. ### `get-resource-policies` O código de exemplo a seguir mostra como usar `get-resource-policies`. **AWS CLI** **Para listar políticas de recursos para um plano de resposta** O exemplo `command-name` a seguir lista as políticas de recursos associadas ao plano de resposta especificado. ``` aws ssm-incidents get-resource-policies \ --resource-arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan" ``` Resultado: ``` { "resourcePolicies": [ { "policyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"d901b37a-dbb0-458a-8842-75575c464219-external-principals\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::222233334444:root\"},\"Action\":[\"ssm-incidents:GetResponsePlan\",\"ssm-incidents:StartIncident\",\"ssm-incidents:UpdateIncidentRecord\",\"ssm-incidents:GetIncidentRecord\",\"ssm-incidents:CreateTimelineEvent\",\"ssm-incidents:UpdateTimelineEvent\",\"ssm-incidents:GetTimelineEvent\",\"ssm-incidents:ListTimelineEvents\",\"ssm-incidents:UpdateRelatedItems\",\"ssm-incidents:ListRelatedItems\"],\"Resource\":[\"arn:aws:ssm-incidents:*:111122223333:response-plan/Example-Response-Plan\",\"arn:aws:ssm-incidents:*:111122223333:incident-record/Example-Response-Plan/*\"]}]}", "policyId": "be8b57191f0371f1c6827341aa3f0a03", "ramResourceShareRegion": "us-east-1" } ] } ``` Para obter mais informações, consulte [Como trabalhar com contatos e planos de resposta](https://docs.aws.amazon.com/incident-manager/latest/userguide/sharing.html) no *Guia do usuário do Incident Manager*. + Para receber detalhes da API, consulte [GetResourcePolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/get-resource-policies.html) na *Referência de comandos da AWS CLI*. ### `get-response-plan` O código de exemplo a seguir mostra como usar `get-response-plan`. **AWS CLI** **Para obter detalhes de um plano de resposta** O exemplo `command-name` a seguir mostra detalhes sobre um plano de resposta específico em sua conta da AWS. ``` aws ssm-incidents get-response-plan \ --arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan" ``` Resultado: ``` { "actions": [ { "ssmAutomation": { "documentName": "AWSIncidents-CriticalIncidentRunbookTemplate", "documentVersion": "$DEFAULT", "roleArn": "arn:aws:iam::111122223333:role/aws-service-role/ssm-incidents.amazonaws.com/AWSServiceRoleForIncidentManager", "targetAccount": "RESPONSE_PLAN_OWNER_ACCOUNT" } } ], "arn": "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan", "chatChannel": { "chatbotSns": [ "arn:aws:sns:us-east-1:111122223333:Standard_User" ] }, "displayName": "Example response plan", "engagements": [ "arn:aws:ssm-contacts:us-east-1:111122223333:contact/example" ], "incidentTemplate": { "impact": 5, "title": "Example-Incident" }, "name": "Example-Response-Plan" } ``` Para obter mais informações, consulte [Preparação para incidentes](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-response.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [GetResponsePlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/get-response-plan.html) na *Referência de comandos da AWS CLI*. ### `get-timeline-event` O código de exemplo a seguir mostra como usar `get-timeline-event`. **AWS CLI** **Para obter detalhes de um evento do cronograma** O exemplo `get-timeline-event` a seguir retorna os detalhes sobre o evento do cronograma especificado. ``` aws ssm-incidents get-timeline-event \ --event-id 20bcc812-8a94-4cd7-520c-0ff742111424 \ --incident-record-arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" ``` Resultado: ``` { "event": { "eventData": "\"Incident Started\"", "eventId": "20bcc812-8a94-4cd7-520c-0ff742111424", "eventTime": "2021-05-21T18:16:57+00:00", "eventType": "Custom Event", "eventUpdatedTime": "2021-05-21T18:16:59.944000+00:00", "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" } } ``` Para obter mais informações, consulte [Detalhes de incidentes](https://docs.aws.amazon.com/incident-manager/latest/userguide/tracking-details.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [GetTimelineEvent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/get-timeline-event.html) na *Referência de comandos da AWS CLI*. ### `list-incident-records` O código de exemplo a seguir mostra como usar `list-incident-records`. **AWS CLI** **Para listar registros de incidentes** O exemplo `command-name` a seguir lista os registros de incidentes na sua conta da Amazon Web Services. ``` aws ssm-incidents list-incident-records ``` Resultado: ``` { "incidentRecordSummaries": [ { "arn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308", "creationTime": "2021-05-21T18:16:57.579000+00:00", "impact": 5, "incidentRecordSource": { "createdBy": "arn:aws:iam::111122223333:user/draliatp", "invokedBy": "arn:aws:iam::111122223333:user/draliatp", "source": "aws.ssm-incidents.custom" }, "status": "OPEN", "title": "Example-Incident" } ] } ``` Para obter mais informações, consulte [Lista de incidentes](https://docs.aws.amazon.com/incident-manager/latest/userguide/tracking-list.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [ListIncidentRecords](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/list-incident-records.html) na *Referência de comandos da AWS CLI*. ### `list-related-items` O código de exemplo a seguir mostra como usar `list-related-items`. **AWS CLI** **Para listar os itens relacionados** O exemplo `list-related-items` a seguir lista os itens relacionados ao incidente especificado. ``` aws ssm-incidents list-related-items \ --incident-record-arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" ``` Resultado: ``` { "relatedItems": [ { "identifier": { "type": "OTHER", "value": { "url": "https://console.aws.amazon.com/systems-manager/opsitems/oi-8ef82158e190/workbench?region=us-east-1" } }, "title": "Example related item" }, { "identifier": { "type": "PARENT", "value": { "arn": "arn:aws:ssm:us-east-1:111122223333:opsitem/oi-8084126392ac" } }, "title": "parentItem" } ] } ``` Para obter mais informações, consulte [Detalhes de incidentes](https://docs.aws.amazon.com/incident-manager/latest/userguide/tracking-details.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [ListRelatedItems](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/list-related-items.html) na *Referência de comandos da AWS CLI*. ### `list-replication-sets` O código de exemplo a seguir mostra como usar `list-replication-sets`. **AWS CLI** **Para listar o conjunto de replicação** O exemplo `list-replication-set` a seguir lista o conjunto de replicação que o Incident Manager usa para replicar e criptografar dados em sua conta da AWS. ``` aws ssm-incidents list-replication-sets ``` Resultado: ``` { "replicationSetArns": [ "arn:aws:ssm-incidents::111122223333:replication-set/c4bcb603-4bf9-bb3f-413c-08df53673b57" ] } ``` Para obter mais informações, consulte [Usar o conjunto de replicação do Incident Manager](https://docs.aws.amazon.com/incident-manager/latest/userguide/replication.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [ListReplicationSets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/list-replication-sets.html) na *Referência de comandos da AWS CLI*. ### `list-response-plans` O código de exemplo a seguir mostra como usar `list-response-plans`. **AWS CLI** **Para listar os planos de resposta disponíveis** O exemplo `list-response-plans` a seguir lista os planos de resposta disponíveis na sua conta da Amazon Web Services. ``` aws ssm-incidents list-response-plans ``` Resultado: ``` { "responsePlanSummaries": [ { "arn": "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan", "displayName": "Example response plan", "name": "Example-Response-Plan" } ] } ``` Para obter mais informações, consulte [Preparação para incidentes](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-response.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [ListResponsePlans](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/list-response-plans.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar tags para um plano de resposta** O exemplo `list-tags-for-resource` a seguir lista as tags associadas ao plano de resposta especificado. ``` aws ssm-incidents list-tags-for-resource \ --resource-arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan" ``` Resultado: ``` { "tags": { "group1": "1" } } ``` Para obter mais informações, consulte [Marcações](https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html) no *Guia do usuário do Incident Manager*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `list-timeline-events` O código de exemplo a seguir mostra como usar `list-timeline-events`. **AWS CLI** **Para listar os eventos do cronograma de um incidente** O exemplo `command-name` a seguir lista os eventos do cronograma do incidente especificado. ``` aws ssm-incidents list-timeline-events \ --incident-record-arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" ``` Resultado: ``` { "eventSummaries": [ { "eventId": "8cbcc889-35e1-a42d-2429-d6f100799915", "eventTime": "2021-05-21T22:36:13.766000+00:00", "eventType": "SSM Incident Record Update", "eventUpdatedTime": "2021-05-21T22:36:13.766000+00:00", "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" }, { "eventId": "a2bcc825-aab5-1787-c605-f9bb2640d85b", "eventTime": "2021-05-21T18:58:46.443000+00:00", "eventType": "SSM Incident Record Update", "eventUpdatedTime": "2021-05-21T18:58:46.443000+00:00", "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" }, { "eventId": "5abcc812-89c0-b0a8-9437-1c74223d4685", "eventTime": "2021-05-21T18:16:59.149000+00:00", "eventType": "SSM Incident Record Update", "eventUpdatedTime": "2021-05-21T18:16:59.149000+00:00", "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" }, { "eventId": "06bcc812-8820-405e-4065-8d2b14d29b92", "eventTime": "2021-05-21T18:16:58+00:00", "eventType": "SSM Automation Execution Start Failure for Incident", "eventUpdatedTime": "2021-05-21T18:16:58.689000+00:00", "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" }, { "eventId": "20bcc812-8a94-4cd7-520c-0ff742111424", "eventTime": "2021-05-21T18:16:57+00:00", "eventType": "Custom Event", "eventUpdatedTime": "2021-05-21T18:16:59.944000+00:00", "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" }, { "eventId": "c0bcc885-a41d-eb01-b4ab-9d2de193643c", "eventTime": "2020-10-01T20:30:00+00:00", "eventType": "Custom Event", "eventUpdatedTime": "2021-05-21T22:28:26.299000+00:00", "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" } ] } ``` Para obter mais informações, consulte [Detalhes de incidentes](https://docs.aws.amazon.com/incident-manager/latest/userguide/tracking-details.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [ListTimelineEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/list-timeline-events.html) na *Referência de comandos da AWS CLI*. ### `put-resource-policy` O código de exemplo a seguir mostra como usar `put-resource-policy`. **AWS CLI** **Como compartilhar um plano de resposta e incidentes** O exemplo `command-name` a seguir adiciona uma política de recursos ao Example-Response-Plan que compartilha o plano de resposta e os incidentes associados com a entidade principal especificada. ``` aws ssm-incidents put-resource-policy \ --resource-arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan" \ --policy "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"ExampleResourcePolciy\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::222233334444:root\"},\"Action\":[\"ssm-incidents:GetResponsePlan\",\"ssm-incidents:StartIncident\",\"ssm-incidents:UpdateIncidentRecord\",\"ssm-incidents:GetIncidentRecord\",\"ssm-incidents:CreateTimelineEvent\",\"ssm-incidents:UpdateTimelineEvent\",\"ssm-incidents:GetTimelineEvent\",\"ssm-incidents:ListTimelineEvents\",\"ssm-incidents:UpdateRelatedItems\",\"ssm-incidents:ListRelatedItems\"],\"Resource\":[\"arn:aws:ssm-incidents:*:111122223333:response-plan/Example-Response-Plan\",\"arn:aws:ssm-incidents:*:111122223333:incident-record/Example-Response-Plan/*\"]}]}" ``` Resultado: ``` { "policyId": "be8b57191f0371f1c6827341aa3f0a03" } ``` Para obter mais informações, consulte [Como trabalhar com contatos e planos de resposta](https://docs.aws.amazon.com/incident-manager/latest/userguide/sharing.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [PutResourcePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/put-resource-policy.html) na *Referência de comandos da AWS CLI*. ### `start-incident` O código de exemplo a seguir mostra como usar `start-incident`. **AWS CLI** **Para iniciar um incidente** O exemplo `start-incident` a seguir inicia um incidente usando o plano de resposta especificado. ``` aws ssm-incidents start-incident \ --response-plan-arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan" ``` Resultado: ``` { "incidentRecordArn": "arn:aws:ssm-incidents::682428703967:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" } ``` Para obter mais informações, consulte [Criação de incidentes](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-creation.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [StartIncident](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/start-incident.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como marcar um plano de resposta** O exemplo `tag-resource` a seguir marca um plano de resposta especificado com o par de chave-valor de tag fornecido. ``` aws ssm-incidents tag-resource \ --resource-arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan" \ --tags '{"group1":"1"}' ``` Este comando não produz saída. Para obter mais informações, consulte [Marcações](https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html) no *Guia do usuário do Incident Manager*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover as tags de um plano de resposta** O exemplo `untag-resource` a seguir remove as tags especificadas do plano de resposta. ``` aws ssm-incidents untag-resource \ --resource-arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan" \ --tag-keys '["group1"]' ``` Este comando não produz saída. Para obter mais informações, consulte [Marcações](https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html) no *Guia do usuário do Incident Manager*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-deletion-protection` O código de exemplo a seguir mostra como usar `update-deletion-protection`. **AWS CLI** **Para atualizar a proteção contra a exclusão de grupos de replicações** O exemplo `update-deletion-protection` a seguir atualiza a proteção contra exclusão em sua conta para evitar que você exclua a última região em seu conjunto de replicação. ``` aws ssm-incidents update-deletion-protection \ --arn "arn:aws:ssm-incidents::111122223333:replication-set/a2bcc5c9-0f53-8047-7fef-c20749989b40" \ --deletion-protected ``` Este comando não produz saída. Para obter mais informações, consulte [Usar o conjunto de replicação do Incident Manager](https://docs.aws.amazon.com/incident-manager/latest/userguide/replication.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [UpdateDeletionProtection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/update-deletion-protection.html) na *Referência de comandos da AWS CLI*. ### `update-incident-record` O código de exemplo a seguir mostra como usar `update-incident-record`. **AWS CLI** **Para atualizar um registro de incidentes** O exemplo `command-name` a seguir resolve o incidente especificado. ``` aws ssm-incidents update-incident-record \ --arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" \ --status "RESOLVED" ``` Este comando não produz saída. Para obter mais informações, consulte [Detalhes de incidentes](https://docs.aws.amazon.com/incident-manager/latest/userguide/tracking-details.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [UpdateIncidentRecord](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/update-incident-record.html) na *Referência de comandos da AWS CLI*. ### `update-related-items` O código de exemplo a seguir mostra como usar `update-related-items`. **AWS CLI** **Para atualizar um item relacionado a incidentes** O exemplo `update-related-item` a seguir remove um item relacionado do registro de incidente especificado. ``` aws ssm-incidents update-related-items \ --incident-record-arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" \ --related-items-update '{"itemToRemove": {"type": "OTHER", "value": {"url": "https://console.aws.amazon.com/systems-manager/opsitems/oi-8ef82158e190/workbench?region=us-east-1"}}}' ``` Este comando não produz saída. Para obter mais informações, consulte [Detalhes de incidentes](https://docs.aws.amazon.com/incident-manager/latest/userguide/tracking-details.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [UpdateRelatedItems](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/update-related-items.html) na *Referência de comandos da AWS CLI*. ### `update-replication-set` O código de exemplo a seguir mostra como usar `update-replication-set`. **AWS CLI** **Para atualizar um conjunto de replicação** O exemplo `command-name` a seguir exclui a região us-east-2 do conjunto de replicação. ``` aws ssm-incidents update-replication-set \ --arn "arn:aws:ssm-incidents::111122223333:replication-set/a2bcc5c9-0f53-8047-7fef-c20749989b40" \ --actions '[{"deleteRegionAction": {"regionName": "us-east-2"}}]' ``` Este comando não produz saída. Para obter mais informações, consulte [Usar o conjunto de replicação do Incident Manager](https://docs.aws.amazon.com/incident-manager/latest/userguide/replication.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [UpdateReplicationSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/update-replication-set.html) na *Referência de comandos da AWS CLI*. ### `update-response-plan` O código de exemplo a seguir mostra como usar `update-response-plan`. **AWS CLI** **Para criar um plano de resposta** O exemplo `update-response-plan` a seguir remove um canal de chat do plano de resposta especificado. ``` aws ssm-incidents update-response-plan \ --arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan" \ --chat-channel '{"empty":{}}' ``` Este comando não produz saída. Para obter mais informações, consulte [Preparação para incidentes](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-response.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [UpdateResponsePlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/update-response-plan.html) na *Referência de comandos da AWS CLI*. ### `update-timeline-event` O código de exemplo a seguir mostra como usar `update-timeline-event`. **AWS CLI** **Para atualizar um evento do cronograma** O exemplo `update-timeline-event` a seguir atualiza a hora em que o evento ocorreu. ``` aws ssm-incidents update-timeline-event \ --event-id 20bcc812-8a94-4cd7-520c-0ff742111424 \ --incident-record-arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" \ --event-time "2021-05-21T18:10:57+00:00" ``` Este comando não produz saída. Para obter mais informações, consulte [Detalhes de incidentes](https://docs.aws.amazon.com/incident-manager/latest/userguide/tracking-details.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [UpdateTimelineEvent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/update-timeline-event.html) na *Referência de comandos da AWS CLI*. # Exemplos do Incident Manager Contacts usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Incident Manager Contacts. *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 ### `accept-page` O código de exemplo a seguir mostra como usar `accept-page`. **AWS CLI** **Como aceitar uma página durante uma interação** O exemplo `accept-page` a seguir usa um código de aceitação enviado ao canal de contato para aceitar uma página. ``` aws ssm-contacts accept-page \ --page-id "arn:aws:ssm-contacts:us-east-2:682428703967:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3" \ --accept-type READ \ --accept-code 425440 ``` Este comando não produz saída Para obter mais informações, consulte [Contatos](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [AcceptPage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/accept-page.html) na *Referência de comandos da AWS CLI*. ### `activate-contact-channel` O código de exemplo a seguir mostra como usar `activate-contact-channel`. **AWS CLI** **Ativar o canal de comunicação de um contato.** O exemplo `activate-contact-channel` a seguir ativa um canal de contato e o torna utilizável como parte de um incidente. ``` aws ssm-contacts activate-contact-channel \ --contact-channel-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d" \ --activation-code "466136" ``` Este comando não produz saída. Para obter mais informações, consulte [Contatos](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [ActivateContactChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/activate-contact-channel.html) na *Referência de comandos da AWS CLI*. ### `command-name` O código de exemplo a seguir mostra como usar `command-name`. **AWS CLI** **Para excluir um contato** O exemplo `command-name` a seguir exclui um contato. O contato não estará mais acessível a partir de nenhum plano de escalonamento que se refira a ele. ``` aws ssm-contacts delete-contact \ --contact-id "arn:aws:ssm-contacts:us-east-1:682428703967:contact/alejr" ``` Este comando não produz saída. Para obter mais informações, consulte [Contatos](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [CommandName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/command-name.html) na *Referência de comandos da AWS CLI*. ### `create-contact-channel` O código de exemplo a seguir mostra como usar `create-contact-channel`. **AWS CLI** **Para criar um canal de contato** Cria um canal de contato do tipo SMS para o contato Akua Mansa. Canais de contato podem ser criados do tipo SMS, E-MAIL ou VOZ. ``` aws ssm-contacts create-contact-channel \ --contact-id "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" \ --name "akuas sms-test" \ --type SMS \ --delivery-address '{"SimpleAddress": "+15005550199"}' ``` Resultado: ``` { "ContactChannelArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/02f506b9-ea5d-4764-af89-2daa793ff024" } ``` Para obter mais informações, consulte [Contatos](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [CreateContactChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/create-contact-channel.html) na *Referência de comandos da AWS CLI*. ### `create-contact` O código de exemplo a seguir mostra como usar `create-contact`. **AWS CLI** **Para criar um contato** O exemplo `create-contact` a seguir cria um contato em seu ambiente com um plano em branco. O plano pode ser atualizado após a criação dos canais de contato. Use o comando create-contact-channel com o ARN de saída desse comando. Depois de criar canais de contato para esse contato, use update-contact para atualizar o plano. ``` aws ssm-contacts create-contact \ --alias "akuam" \ --display-name "Akua Mansa" \ --type PERSONAL \ --plan '{"Stages": []}' ``` Resultado: ``` { "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" } ``` Para obter mais informações, consulte [Contatos](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [CreateContact](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/create-contact.html) na *Referência de comandos da AWS CLI*. ### `deactivate-contact-channel` O código de exemplo a seguir mostra como usar `deactivate-contact-channel`. **AWS CLI** **Para desativar um canal de contato** O exemplo `deactivate-contact-channel` a seguir desativa um canal de contato. Desativar um canal de contato significa que o canal de contato não será mais paginado durante um incidente. Você também pode reativar um canal de contato a qualquer momento usando o comando `activate-contact-channel`. ``` aws ssm-contacts deactivate-contact-channel \ --contact-channel-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d" ``` Este comando não produz saída. Para obter mais informações, consulte [Contatos](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [DeactivateContactChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/deactivate-contact-channel.html) na *Referência de comandos da AWS CLI*. ### `delete-contact-channel` O código de exemplo a seguir mostra como usar `delete-contact-channel`. **AWS CLI** **Para excluir um canal de contato** O exemplo `delete-contact-channel` a seguir exclui um canal de contato. A exclusão de um canal de contato garante que o canal de contato não seja paginado durante um incidente. ``` aws ssm-contacts delete-contact-channel \ --contact-channel-id "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/13149bad-52ee-45ea-ae1e-45857f78f9b2" ``` Este comando não produz saída. Para obter mais informações, consulte [Contatos](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [DeleteContactChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/delete-contact-channel.html) na *Referência de comandos da AWS CLI*. ### `delete-contact` O código de exemplo a seguir mostra como usar `delete-contact`. **AWS CLI** **Para excluir um contato** O exemplo `delete-contact` a seguir exclui um contato. O contato não estará mais acessível a partir de nenhum plano de escalonamento que se refira a ele. ``` aws ssm-contacts delete-contact \ --contact-id "arn:aws:ssm-contacts:us-east-1:111122223333:contact/alejr" ``` Este comando não produz saída. Para obter mais informações, consulte [Contatos](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [DeleteContact](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/delete-contact.html) na *Referência de comandos da AWS CLI*. ### `describe-engagement` O código de exemplo a seguir mostra como usar `describe-engagement`. **AWS CLI** **Para descrever os detalhes de uma interação** O exemplo `describe-engagement` a seguir lista os detalhes de uma interação com um plano de contato ou escalonamento. O assunto e o conteúdo são enviados para os canais de contato. ``` aws ssm-contacts describe-engagement \ --engagement-id "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356" ``` Resultado: ``` { "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356", "Sender": "cli", "Subject": "cli-test", "Content": "Testing engagements via CLI", "PublicSubject": "cli-test", "PublicContent": "Testing engagements va CLI", "StartTime": "2021-05-18T18:25:41.151000+00:00" } ``` Para obter mais informações, consulte [Contatos](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [DescribeEngagement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/describe-engagement.html) na *Referência de comandos da AWS CLI*. ### `describe-page` O código de exemplo a seguir mostra como usar `describe-page`. **AWS CLI** **Para listar os detalhes de uma página em um canal de contato** O exemplo `describe-page` a seguir lista os detalhes de uma página em um canal de contato. A página incluirá o assunto e o conteúdo fornecidos. ``` aws ssm-contacts describe-page \ --page-id "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93" ``` Resultado: ``` { "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93", "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Sender": "cli", "Subject": "cli-test", "Content": "Testing engagements via CLI", "PublicSubject": "cli-test", "PublicContent": "Testing engagements va CLI", "SentTime": "2021-05-18T18:43:29.301000+00:00", "ReadTime": "2021-05-18T18:43:55.708000+00:00", "DeliveryTime": "2021-05-18T18:43:55.265000+00:00" } ``` Para obter mais informações, consulte [Contatos](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [DescribePage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/describe-page.html) na *Referência de comandos da AWS CLI*. ### `get-contact-channel` O código de exemplo a seguir mostra como usar `get-contact-channel`. **AWS CLI** **Para listar os detalhes de um canal de contato** O exemplo `get-contact-channel` a seguir lista os detalhes de um canal de contato. ``` aws ssm-contacts get-contact-channel \ --contact-channel-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d" ``` Resultado: ``` { "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", "Name": "akuas sms", "Type": "SMS", "DeliveryAddress": { "SimpleAddress": "+15005550199" }, "ActivationStatus": "ACTIVATED" } ``` Para obter mais informações, consulte [Contatos](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [GetContactChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/get-contact-channel.html) na *Referência de comandos da AWS CLI*. ### `get-contact-policy` O código de exemplo a seguir mostra como usar `get-contact-policy`. **AWS CLI** **Para listar as políticas de recursos de um contato** O exemplo `get-contact-policy` a seguir lista as políticas de recursos associadas ao contato especificado. ``` aws ssm-contacts get-contact-policy \ --contact-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" ``` Resultado: ``` { "ContactArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"SharePolicyForDocumentationDralia\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"222233334444\"},\"Action\":[\"ssm-contacts:GetContact\",\"ssm-contacts:StartEngagement\",\"ssm-contacts:DescribeEngagement\",\"ssm-contacts:ListPagesByEngagement\",\"ssm-contacts:StopEngagement\"],\"Resource\":[\"arn:aws:ssm-contacts:*:111122223333:contact/akuam\",\"arn:aws:ssm-contacts:*:111122223333:engagement/akuam/*\"]}]}" } ``` Para obter mais informações, consulte [Como trabalhar com contatos e planos de resposta](https://docs.aws.amazon.com/incident-manager/latest/userguide/sharing.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [GetContactPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/get-contact-policy.html) na *Referência de comandos da AWS CLI*. ### `get-contact` O código de exemplo a seguir mostra como usar `get-contact`. **AWS CLI** **Exemplo 1: descrever um plano de contato** O exemplo `get-contact` a seguir descreve um contato. ``` aws ssm-contacts get-contact \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" ``` Resultado: ``` { "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Alias": "akuam", "DisplayName": "Akua Mansa", "Type": "PERSONAL", "Plan": { "Stages": [ { "DurationInMinutes": 5, "Targets": [ { "ChannelTargetInfo": { "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65", "RetryIntervalInMinutes": 1 } } ] }, { "DurationInMinutes": 5, "Targets": [ { "ChannelTargetInfo": { "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad", "RetryIntervalInMinutes": 1 } } ] }, { "DurationInMinutes": 5, "Targets": [ { "ChannelTargetInfo": { "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a", "RetryIntervalInMinutes": 1 } } ] } ] } } ``` **Exemplo 2: descrever um plano de escalonamento** O exemplo `get-contact` a seguir descreve um plano de escalonamento. ``` aws ssm-contacts get-contact \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation" ``` Resultado: ``` { "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", "Alias": "example_escalation", "DisplayName": "Example Escalation", "Type": "ESCALATION", "Plan": { "Stages": [ { "DurationInMinutes": 5, "Targets": [ { "ContactTargetInfo": { "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "IsEssential": true } } ] }, { "DurationInMinutes": 5, "Targets": [ { "ContactTargetInfo": { "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr", "IsEssential": false } } ] }, { "DurationInMinutes": 0, "Targets": [ { "ContactTargetInfo": { "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi", "IsEssential": false } } ] } ] } } ``` Para obter mais informações, consulte [Contatos](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [GetContact](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/get-contact.html) na *Referência de comandos da AWS CLI*. ### `list-contact-channels` O código de exemplo a seguir mostra como usar `list-contact-channels`. **AWS CLI** **Para listar os canais de contato de um contato** O exemplo `list-contact-channels` a seguir lista os canais de contato disponíveis do contato especificado. ``` aws ssm-contacts list-contact-channels \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" ``` Resultado: ``` { [ { "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Name": "akuas email", "Type": "EMAIL", "DeliveryAddress": { "SimpleAddress": "akuam@example.com" }, "ActivationStatus": "NOT_ACTIVATED" }, { "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Name": "akuas sms", "Type": "SMS", "DeliveryAddress": { "SimpleAddress": "+15005550100" }, "ActivationStatus": "ACTIVATED" } ] } ``` Para obter mais informações, consulte [Contatos](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [ListContactChannels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/list-contact-channels.html) na *Referência de comandos da AWS CLI*. ### `list-contacts` O código de exemplo a seguir mostra como usar `list-contacts`. **AWS CLI** **Para listar todos os planos e contatos de escalonamento** O exemplo `list-contacts` a seguir lista os contatos e os planos de escalonamento em sua conta. ``` aws ssm-contacts list-contacts ``` Resultado: ``` { "Contacts": [ { "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Alias": "akuam", "DisplayName": "Akua Mansa", "Type": "PERSONAL" }, { "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr", "Alias": "alejr", "DisplayName": "Alejandro Rosalez", "Type": "PERSONAL" }, { "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi", "Alias": "anasi", "DisplayName": "Ana Carolina Silva", "Type": "PERSONAL" }, { "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", "Alias": "example_escalation", "DisplayName": "Example Escalation", "Type": "ESCALATION" } ] } ``` Para obter mais informações, consulte [Contatos](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [ListContacts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/list-contacts.html) na *Referência de comandos da AWS CLI*. ### `list-engagements` O código de exemplo a seguir mostra como usar `list-engagements`. **AWS CLI** **Para listar todas as interações** O exemplo `list-engagements` a seguir lista os compromissos com planos e contatos de escalonamento. Você também pode listar interações para um único incidente. ``` aws ssm-contacts list-engagements ``` Resultado: ``` { "Engagements": [ { "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/91792571-0b53-4821-9f73-d25d13d9e529", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Sender": "cli", "StartTime": "2021-05-18T20:37:50.300000+00:00" }, { "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Sender": "cli", "StartTime": "2021-05-18T18:40:26.666000+00:00" }, { "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", "Sender": "cli", "StartTime": "2021-05-18T18:25:41.151000+00:00" }, { "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Sender": "cli", "StartTime": "2021-05-18T18:20:58.093000+00:00" } ] } ``` Para obter mais informações, consulte [Contatos](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [ListEngagements](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/list-engagements.html) na *Referência de comandos da AWS CLI*. ### `list-page-receipts` O código de exemplo a seguir mostra como usar `list-page-receipts`. **AWS CLI** **Para listar os recibos da página** O exemplo `command-name` a seguir lista se uma página foi recebida ou não por um contato. ``` aws ssm-contacts list-page-receipts \ --page-id "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3" ``` Resultado: ``` { "Receipts": [ { "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", "ReceiptType": "DELIVERED", "ReceiptInfo": "425440", "ReceiptTime": "2021-05-18T20:42:57.485000+00:00" }, { "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", "ReceiptType": "READ", "ReceiptInfo": "425440", "ReceiptTime": "2021-05-18T20:42:57.907000+00:00" }, { "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", "ReceiptType": "SENT", "ReceiptInfo": "SM6656c19132f1465f9c9c1123a5dde7c9", "ReceiptTime": "2021-05-18T20:40:52.962000+00:00" } ] } ``` Para obter mais informações, consulte [Contatos](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [ListPageReceipts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/list-page-receipts.html) na *Referência de comandos da AWS CLI*. ### `list-pages-by-contact` O código de exemplo a seguir mostra como usar `list-pages-by-contact`. **AWS CLI** **Para listar páginas por contato** O exemplo `list-pages-by-contact` a seguir lista todas as páginas do contato especificado. ``` aws ssm-contacts list-pages-by-contact \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" ``` Resultado: ``` { "Pages": [ { "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93", "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Sender": "cli", "SentTime": "2021-05-18T18:43:29.301000+00:00", "DeliveryTime": "2021-05-18T18:43:55.265000+00:00", "ReadTime": "2021-05-18T18:43:55.708000+00:00" } ] } ``` Para obter mais informações, consulte [Contatos](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [ListPagesByContact](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/list-pages-by-contact.html) na *Referência de comandos da AWS CLI*. ### `list-pages-by-engagement` O código de exemplo a seguir mostra como usar `list-pages-by-engagement`. **AWS CLI** **Como páginas para canais de contato iniciados a partir de uma interação.** O exemplo `list-pages-by-engagement` a seguir lista as páginas que ocorreram ao interagir com o plano de interação definido. ``` aws ssm-contacts list-pages-by-engagement \ --engagement-id "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0" ``` Resultado: ``` { "Pages": [ { "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93", "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Sender": "cli", "SentTime": "2021-05-18T18:40:27.245000+00:00" } ] } ``` Para obter mais informações, consulte [Contatos](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [ListPagesByEngagement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/list-pages-by-engagement.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar tags para um contato** O exemplo `list-tags-for-resource` a seguir lista as tags do contato especificado. ``` aws ssm-contacts list-tags-for-resource \ --resource-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" ``` Resultado: ``` { "Tags": [ { "Key": "group1", "Value": "1" } ] } ``` Para obter mais informações, consulte [Marcações](https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html) no *Guia do usuário do Incident Manager*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `put-contact-policy` O código de exemplo a seguir mostra como usar `put-contact-policy`. **AWS CLI** **Como compartilhar um contato e interações** O exemplo `put-contact-policy` a seguir adiciona uma política de recursos ao contato Akua que compartilha o contato e os compromissos relacionados com a entidade principal. ``` aws ssm-contacts put-contact-policy \ --contact-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" \ --policy "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"ExampleResourcePolicy\",\"Action\":[\"ssm-contacts:GetContact\",\"ssm-contacts:StartEngagement\",\"ssm-contacts:DescribeEngagement\",\"ssm-contacts:ListPagesByEngagement\",\"ssm-contacts:StopEngagement\"],\"Principal\":{\"AWS\":\"222233334444\"},\"Effect\":\"Allow\",\"Resource\":[\"arn:aws:ssm-contacts:*:111122223333:contact\/akuam\",\"arn:aws:ssm-contacts:*:111122223333:engagement\/akuam\/*\"]}]}" ``` Este comando não produz saída. Para obter mais informações, consulte [Como trabalhar com contatos e planos de resposta](https://docs.aws.amazon.com/incident-manager/latest/userguide/sharing.html) no *Guia do usuário do Incident Manager*. + Consulte detalhes da API em [PutContactPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/put-contact-policy.html) na *Referência de comandos da AWS CLI*. ### `send-activation-code` O código de exemplo a seguir mostra como usar `send-activation-code`. **AWS CLI** **Como enviar um código de ativação** O exemplo `send-activation-code` a seguir envia um código de ativação e uma mensagem para o canal de contato especificado. ``` aws ssm-contacts send-activation-code \ --contact-channel-id "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/8ddae2d1-12c8-4e45-b852-c8587266c400" ``` Este comando não produz saída. Para obter mais informações, consulte [Contatos](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [SendActivationCode](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/send-activation-code.html) na *Referência de comandos da AWS CLI*. ### `start-engagement` O código de exemplo a seguir mostra como usar `start-engagement`. **AWS CLI** **Exemplo 1: paginar os canais de comunicação de um contato.** As páginas de `start-engagement` a seguir entram em contato com os canais de contato. Remetente, assunto, assunto público e conteúdo público estão todos livres de campos. O Incident Manager envia o assunto e o conteúdo para os canais de contato de VOZ ou E-MAIL fornecidos. O Incident Manager envia o assunto público e o conteúdo público para os canais de contato por SMS fornecidos. O remetente é usado para rastrear quem iniciou a interação. ``` aws ssm-contacts start-engagement \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" \ --sender "cli" \ --subject "cli-test" \ --content "Testing engagements via CLI" \ --public-subject "cli-test" \ --public-content "Testing engagements va CLI" ``` Resultado: ``` { "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f" } ``` Para obter mais informações, consulte [Contatos](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html) no *Guia do usuário do Incident Manager*. **Exemplo 2: paginar um contato no plano de escalonamento fornecido.** O `start-engagement` a seguir envolve os contatos por meio de um plano de escalonamento. Cada contato é paginado de acordo com seu plano de interação. ``` aws ssm-contacts start-engagement \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation" \ --sender "cli" \ --subject "cli-test" \ --content "Testing engagements via CLI" \ --public-subject "cli-test" \ --public-content "Testing engagements va CLI" ``` Resultado: ``` { "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356" } ``` Para obter mais informações, consulte [Contatos](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [StartEngagement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/start-engagement.html) na *Referência de comandos da AWS CLI*. ### `stop-engagement` O código de exemplo a seguir mostra como usar `stop-engagement`. **AWS CLI** **Como interromper uma interação** O exemplo `stop-engagement` a seguir impede que uma interação pagine outros contatos e canais de contato. ``` aws ssm-contacts stop-engagement \ --engagement-id "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356" ``` Este comando não produz saída. Para obter mais informações, consulte [Contatos](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [StopEngagement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/stop-engagement.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como marcar um contato** O exemplo `tag-resource` a seguir marca um contato especificado com o par de chave-valor de tag fornecido. ``` aws ssm-contacts tag-resource \ --resource-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" \ --tags '[{"Key":"group1","Value":"1"}]' ``` Este comando não produz saída. Para obter mais informações, consulte [Marcações](https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html) no *Guia do usuário do Incident Manager*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover tags de um contato** O exemplo `untag-resource` a seguir remove a tag group1 do contato especificado. ``` aws ssm-contacts untag-resource \ --resource-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" \ --tag-keys "group1" ``` Este comando não produz saída. Para obter mais informações, consulte [Marcações](https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html) no *Guia do usuário do Incident Manager*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-contact-channel` O código de exemplo a seguir mostra como usar `update-contact-channel`. **AWS CLI** **Para atualizar um canal de contato** O exemplo `update-contact-channel` a seguir atualiza o nome e o endereço de entrega de um canal de contato. ``` aws ssm-contacts update-contact-channel \ --contact-channel-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad" \ --name "akuas voice channel" \ --delivery-address '{"SimpleAddress": "+15005550198"}' ``` Este comando não produz saída. Para obter mais informações, consulte [Contatos](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [UpdateContactChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/update-contact-channel.html) na *Referência de comandos da AWS CLI*. ### `update-contact` O código de exemplo a seguir mostra como usar `update-contact`. **AWS CLI** **Para atualizar o plano de interação do contato** O exemplo `update-contact` a seguir atualiza o plano de engajamento do contato Akua para incluir os três tipos de canais de contatos. Isso é feito depois de criar canais de contato para Akua. ``` aws ssm-contacts update-contact \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" \ --plan '{"Stages": [{"DurationInMinutes": 5, "Targets": [{"ChannelTargetInfo": {"ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65","RetryIntervalInMinutes": 1 }}]}, {"DurationInMinutes": 5, "Targets": [{"ChannelTargetInfo":{"ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad", "RetryIntervalInMinutes": 1}}]}, {"DurationInMinutes": 5, "Targets": [{"ChannelTargetInfo": {"ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a","RetryIntervalInMinutes": 1 }}]}]}' ``` Este comando não produz saída. Para obter mais informações, consulte [Contatos](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html) no *Guia do usuário do Incident Manager*. + Para ver detalhes da API, consulte [UpdateContact](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/update-contact.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon Inspector usando AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Amazon Inspector. *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-attributes-to-findings` O código de exemplo a seguir mostra como usar `add-attributes-to-findings`. **AWS CLI** **Adicionar atributos às descobertas** O comando `add-attribute-to-finding` a seguir designa um atributo com a chave de `Example` e o valor de `example` para a descoberta com o ARN de `arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-8l1VIE0D/run/0-Z02cjjug/finding/0-T8yM9mEU`: ``` aws inspector add-attributes-to-findings --finding-arns arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-8l1VIE0D/run/0-Z02cjjug/finding/0-T8yM9mEU --attributes key=Example,value=example ``` Resultado: ``` { "failedItems": {} } ``` Para obter mais informações, consulte Descobertas do Amazon Inspector no *Guia do usuário do Amazon* Inspector. + Para ver detalhes da API, consulte [AddAttributesToFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/add-attributes-to-findings.html) na *Referência de comandos da AWS CLI*. ### `associate-member` O código de exemplo a seguir mostra como usar `associate-member`. **AWS CLI** **Exemplo: como associar uma conta da AWS a um administrador delegado do Amazon Inspector** O exemplo de `associate-member` a seguir associa uma conta da AWS a um administrador delegado do Amazon Inspector. ``` aws inspector2 associate-member \ --account-id 123456789012 ``` Resultado: ``` { "accountId": "123456789012" } ``` Consulte mais informações em [Managing multiple accounts in Amazon Inspector with AWS Organizations](https://docs.aws.amazon.com/inspector/latest/user/managing-multiple-accounts.html) no *Guia do usuário do Amazon Inspector*. + Consulte detalhes da API em [AssociateMember](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/associate-member.html) na *Referência de comandos da AWS CLI*. ### `create-assessment-target` O código de exemplo a seguir mostra como usar `create-assessment-target`. **AWS CLI** **Criar um destino de avaliação** O comando `create-assessment-target` a seguir cria um destino de avaliação chamado `ExampleAssessmentTarget` usando o grupo de recursos com o ARN de `arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv`: ``` aws inspector create-assessment-target --assessment-target-name ExampleAssessmentTarget --resource-group-arn arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv ``` Resultado: ``` { "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX" } ``` Para obter mais informações, consulte Avaliação de Destinos do Amazon Inspector no *Guia do usuário do Amazon* Inspector. + Para ver detalhes da API, consulte [CreateAssessmentTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/create-assessment-target.html) na *Referência de comandos da AWS CLI*. ### `create-assessment-template` O código de exemplo a seguir mostra como usar `create-assessment-template`. **AWS CLI** **Para criar um modelo de avaliação** O comando `create-assessment-template` a seguir cria um modelo de avaliação chamado `ExampleAssessmentTemplate` para o destino da avaliação com o ARN de `arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX`: ``` aws inspector create-assessment-template --assessment-target-arn arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX --assessment-template-name ExampleAssessmentTemplate --duration-in-seconds 180 --rules-package-arns arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p --user-attributes-for-findings key=ExampleTag,value=examplevalue ``` Resultado: ``` { "assessmentTemplateArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T" } ``` Para obter mais informações, consulte Modelos de Avaliação e Execuções de Avaliação do Amazon Inspector no *Guia do Amazon Inspector*. + Para ver detalhes da API, consulte [CreateAssessmentTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/create-assessment-template.html) na *Referência de comandos da AWS CLI*. ### `create-filter` O código de exemplo a seguir mostra como usar `create-filter`. **AWS CLI** **Criar um filtro** O exemplo `create-filter` a seguir cria uma regra de supressão que omite as descobertas do tipo de instância ECR. ``` aws inspector2 create-filter \ --name "ExampleSuppressionRuleECR" \ --description "This suppression rule omits ECR instance type findings" \ --action SUPPRESS \ --filter-criteria 'resourceType=[{comparison="EQUALS", value="AWS_ECR_INSTANCE"}]' ``` Resultado: ``` { "arn": "arn:aws:inspector2:us-west-2:123456789012:owner/o-EXAMPLE222/filter/EXAMPLE444444444" } ``` Para obter mais informações, consulte [Filtragem das Descobertas do Amazon Inspector](https://docs.aws.amazon.com/inspector/latest/user/findings-managing-filtering.html) no *Guia do usuário do Amazon Inspector*. + Para ver detalhes da API, consulte [CreateFilter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/create-filter.html) na * Referência de comandos AWS CLI*. ### `create-findings-report` O código de exemplo a seguir mostra como usar `create-findings-report`. **AWS CLI** **Criar um relatório de descobertas** O exemplo `create-findings-report` a seguir cria um relatório de descoberta. ``` aws inspector2 create-findings-report \ --report-format CSV \ --s3-destination bucketName=inspector-sbom-123456789012,keyPrefix=sbom-key,kmsKeyArn=arn:aws:kms:us-west-2:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333 \ --filter-criteria '{"ecrImageRepositoryName":[{"comparison":"EQUALS","value":"debian"}]}' ``` Resultado: ``` { "reportId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333" } ``` Para obter mais informações, consulte [Gerenciamento de Descobertas no Amazon Inspector](https://docs.aws.amazon.com/inspector/latest/user/findings-managing.html) no *Guia do usuário do Amazon Inspector*. + Para ver detalhes da API, consulte [CreateFindingsReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/create-findings-report.html) na *Referência de comandos da AWS CLI*. ### `create-resource-group` O código de exemplo a seguir mostra como usar `create-resource-group`. **AWS CLI** **Criar um grupo de recursos** O comando `create-resource-group` a seguir cria um grupo de recursos usando a chave de marcação de `Name` e o valor de `example`: ``` aws inspector create-resource-group --resource-group-tags key=Name,value=example ``` Resultado: ``` { "resourceGroupArn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv" } ``` Para obter mais informações, consulte Avaliação de Destinos do Amazon Inspector no *Guia do usuário do Amazon* Inspector. + Para ver detalhes da API, consulte [CreateResourceGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/create-resource-group.html) na *Referência de comandos da AWS CLI*. ### `create-sbom-export` O código de exemplo a seguir mostra como usar `create-sbom-export`. **AWS CLI** **Criar um relatório de lista de materiais de software (SBOM** O exemplo `create-sbom-export` a seguir cria um relatório de lista de materiais de software (SBOM). ``` aws inspector2 create-sbom-export \ --report-format SPDX_2_3 \ --resource-filter-criteria 'ecrRepositoryName=[{comparison="EQUALS",value="debian"}]' \ --s3-destination bucketName=inspector-sbom-123456789012,keyPrefix=sbom-key,kmsKeyArn=arn:aws:kms:us-west-2:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333 ``` Resultado: ``` { "reportId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333" } ``` Para obter mais informações, consulte [Exportação de SBOMs com o Amazon Inspector](https://docs.aws.amazon.com/inspector/latest/user/sbom-export.html) no *Guia do usuário do Amazon Inspector*. + Para ver detalhes da API, consulte [CreateSbomExport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/create-sbom-export.html) na *Referência de comandos da AWS CLI*. ### `delete-assessment-run` O código de exemplo a seguir mostra como usar `delete-assessment-run`. **AWS CLI** **Excluir uma execução de avaliação** O comando `delete-assessment-run` a seguir exclui a execução de avaliação com o ARN de `arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-11LMTAVe`: ``` aws inspector delete-assessment-run --assessment-run-arn arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-11LMTAVe ``` Para obter mais informações, consulte Modelos de Avaliação e Execuções de Avaliação do Amazon Inspector no *Guia do Amazon Inspector*. + Para ver detalhes da API, consulte [DeleteAssessmentRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/delete-assessment-run.html) na *Referência de comandos da AWS CLI*. ### `delete-assessment-target` O código de exemplo a seguir mostra como usar `delete-assessment-target`. **AWS CLI** **Para excluir um destino de avaliação** O comando `delete-assessment-target` a seguir exclui o destino da avaliação com o ARN de `arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq`: ``` aws inspector delete-assessment-target --assessment-target-arn arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq ``` Para obter mais informações, consulte Avaliação de Destinos do Amazon Inspector no *Guia do usuário do Amazon* Inspector. + Para ver detalhes da API, consulte [DeleteAssessmentTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/delete-assessment-target.html) na *Referência de comandos da AWS CLI*. ### `delete-assessment-template` O código de exemplo a seguir mostra como usar `delete-assessment-template`. **AWS CLI** **Para excluir um modelo de avaliação** O comando `delete-assessment-template` a seguir exclui o modelo de avaliação com o ARN de `arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T`: ``` aws inspector delete-assessment-template --assessment-template-arn arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T ``` Para obter mais informações, consulte Modelos de Avaliação e Execuções de Avaliação do Amazon Inspector no *Guia do Amazon Inspector*. + Para ver detalhes da API, consulte [DeleteAssessmentTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/delete-assessment-template.html) na *Referência de comandos da AWS CLI*. ### `delete-filter` O código de exemplo a seguir mostra como usar `delete-filter`. **AWS CLI** **Excluir uma regra de filtro** O exemplo `delete-filter` a seguir exclui um filtro. ``` aws inspector2 delete-filter \ --arn "arn:aws:inspector2:us-west-2:123456789012:owner/o-EXAMPLE222/filter/EXAMPLE444444444" ``` Resultado: ``` { "arn": "arn:aws:inspector2:us-west-2:123456789012:owner/o-EXAMPLE222/filter/EXAMPLE444444444" } ``` Para obter mais informações, consulte [Filtragem das Descobertas do Amazon Inspector](https://docs.aws.amazon.com/inspector/latest/user/findings-managing-filtering.html) no *Guia do usuário do Amazon Inspector*. + Para ver detalhes da API, consulte [DeleteFilter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/delete-filter.html) na * Referência de comandos da AWS CLI*. ### `describe-assessment-runs` O código de exemplo a seguir mostra como usar `describe-assessment-runs`. **AWS CLI** **Descrever execuções de avaliação** O comando `describe-assessment-run` a seguir descreve uma execução de avaliação com o ARN de `arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE`: ``` aws inspector describe-assessment-runs --assessment-run-arns arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE ``` Resultado: ``` { "assessmentRuns": [ { "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", "assessmentTemplateArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw", "completedAt": 1458680301.4, "createdAt": 1458680170.035, "dataCollected": true, "durationInSeconds": 3600, "name": "Run 1 for ExampleAssessmentTemplate", "notifications": [], "rulesPackageArns": [ "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP" ], "startedAt": 1458680170.161, "state": "COMPLETED", "stateChangedAt": 1458680301.4, "stateChanges": [ { "state": "CREATED", "stateChangedAt": 1458680170.035 }, { "state": "START_DATA_COLLECTION_PENDING", "stateChangedAt": 1458680170.065 }, { "state": "START_DATA_COLLECTION_IN_PROGRESS", "stateChangedAt": 1458680170.096 }, { "state": "COLLECTING_DATA", "stateChangedAt": 1458680170.161 }, { "state": "STOP_DATA_COLLECTION_PENDING", "stateChangedAt": 1458680239.883 }, { "state": "DATA_COLLECTED", "stateChangedAt": 1458680299.847 }, { "state": "EVALUATING_RULES", "stateChangedAt": 1458680300.099 }, { "state": "COMPLETED", "stateChangedAt": 1458680301.4 } ], "userAttributesForFindings": [] } ], "failedItems": {} } ``` Para obter mais informações, consulte Modelos de Avaliação e Execuções de Avaliação do Amazon Inspector no *Guia do Amazon Inspector*. + Para ver detalhes da API, consulte [DescribeAssessmentRuns](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/describe-assessment-runs.html) na *Referência de comandos da AWS CLI*. ### `describe-assessment-targets` O código de exemplo a seguir mostra como usar `describe-assessment-targets`. **AWS CLI** **Descrever destinos de avaliação** O comando `describe-assessment-targets` a seguir descreve o destino da avaliação com o ARN de `arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq`: ``` aws inspector describe-assessment-targets --assessment-target-arns arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq ``` Resultado: ``` { "assessmentTargets": [ { "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq", "createdAt": 1458074191.459, "name": "ExampleAssessmentTarget", "resourceGroupArn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI", "updatedAt": 1458074191.459 } ], "failedItems": {} } ``` Para obter mais informações, consulte Avaliação de Destinos do Amazon Inspector no *Guia do usuário do Amazon* Inspector. + Para ver detalhes da API, consulte [DescribeAssessmentTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/describe-assessment-targets.html) na *Referência de comandos da AWS CLI*. ### `describe-assessment-templates` O código de exemplo a seguir mostra como usar `describe-assessment-templates`. **AWS CLI** **Descrever os modelos de avaliação** O comando `describe-assessment-templates` a seguir descreve o modelo de avaliação com o ARN de `arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw`: ``` aws inspector describe-assessment-templates --assessment-template-arns arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw ``` Resultado: ``` { "assessmentTemplates": [ { "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw", "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq", "createdAt": 1458074191.844, "durationInSeconds": 3600, "name": "ExampleAssessmentTemplate", "rulesPackageArns": [ "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP" ], "userAttributesForFindings": [] } ], "failedItems": {} } ``` Para obter mais informações, consulte Modelos de Avaliação e Execuções de Avaliação do Amazon Inspector no *Guia do Amazon Inspector*. + Para ver detalhes da API, consulte [DescribeAssessmentTemplates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/describe-assessment-templates.html) na *Referência de comandos da AWS CLI*. ### `describe-cross-account-access-role` O código de exemplo a seguir mostra como usar `describe-cross-account-access-role`. **AWS CLI** **Descrever o perfil de acesso entre contas** O comando `describe-cross-account-access-role` a seguir descreve o perfil do IAM que permite que o Amazon Inspector acesse sua conta da AWS: ``` aws inspector describe-cross-account-access-role ``` Resultado: ``` { "registeredAt": 1458069182.826, "roleArn": "arn:aws:iam::123456789012:role/inspector", "valid": true } ``` Para obter mais informações, consulte Configuração do Amazon Inspector no *Guia do Usuário Amazon Inspector*. + Para ver detalhes da API, consulte [DescribeCrossAccountAccessRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/describe-cross-account-access-role.html) na *Referência de comandos da AWS CLI*. ### `describe-findings` O código de exemplo a seguir mostra como usar `describe-findings`. **AWS CLI** **Descrever as descobertas** O comando `describe-findings` a seguir descreve a descoberta com o ARN de `arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4`: ``` aws inspector describe-findings --finding-arns arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4 ``` Resultado: ``` { "failedItems": {}, "findings": [ { "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4", "assetAttributes": { "ipv4Addresses": [], "schemaVersion": 1 }, "assetType": "ec2-instance", "attributes": [], "confidence": 10, "createdAt": 1458680301.37, "description": "Amazon Inspector did not find any potential security issues during this assessment.", "indicatorOfCompromise": false, "numericSeverity": 0, "recommendation": "No remediation needed.", "schemaVersion": 1, "service": "Inspector", "serviceAttributes": { "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", "rulesPackageArn": "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP", "schemaVersion": 1 }, "severity": "Informational", "title": "No potential security issues found", "updatedAt": 1458680301.37, "userAttributes": [] } ] } ``` Para obter mais informações, consulte Descobertas do Amazon Inspector no *Guia do usuário do Amazon* Inspector. + Para ver detalhes da API, consulte [DescribeFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/describe-findings.html) na *AWS CLI Referência de comando*. ### `describe-resource-groups` O código de exemplo a seguir mostra como usar `describe-resource-groups`. **AWS CLI** **Descrever grupos de recursos** O comando`describe-resource-groups` a seguir descreve o grupo de recursos com o ARN de `arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI`: ``` aws inspector describe-resource-groups --resource-group-arns arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI ``` Resultado: ``` { "failedItems": {}, "resourceGroups": [ { "arn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI", "createdAt": 1458074191.098, "tags": [ { "key": "Name", "value": "example" } ] } ] } ``` Para obter mais informações, consulte Avaliação de Destinos do Amazon Inspector no *Guia do usuário do Amazon* Inspector. + Para ver detalhes da API, consulte [DescribeResourceGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/describe-resource-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-rules-packages` O código de exemplo a seguir mostra como usar `describe-rules-packages`. **AWS CLI** **Descrever pacotes de regras** O comando`describe-rules-packages` a seguir descreve o pacote de regras com o ARN de `arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p`: ``` aws inspector describe-rules-packages --rules-package-arns arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p ``` Resultado: ``` { "failedItems": {}, "rulesPackages": [ { "arn": "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p", "description": "The rules in this package help verify whether the EC2 instances in your application are exposed to Common Vulnerabilities and Exposures (CVEs). Attacks can exploit unpatched vulnerabilities to compromise the confidentiality, integrity, or availability of your service or data. The CVE system provides a reference for publicly known information security vulnerabilities and exposures. For more information, see [https://cve.mitre.org/](https://cve.mitre.org/). If a particular CVE appears in one of the produced Findings at the end of a completed Inspector assessment, you can search [https://cve.mitre.org/](https://cve.mitre.org/) using the CVE's ID (for example, \"CVE-2009-0021\") to find detailed information about this CVE, its severity, and how to mitigate it. ", "name": "Common Vulnerabilities and Exposures", "provider": "Amazon Web Services, Inc.", "version": "1.1" } ] } ``` Para obter mais informações, consulte Pacotes e regras de regras do Amazon Inspector no Guia do *Amazon Inspector*. + Para ver detalhes da API, consulte [DescribeRulesPackages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/describe-rules-packages.html) na *Referência de comandos da AWS CLI*. ### `disassociate-member` O código de exemplo a seguir mostra como usar `disassociate-member`. **AWS CLI** **Exemplo: como desassociar uma conta-membro de um administrador delegado do Amazon Inspector** O exemplo de `disassociate-member` a seguir desassocia uma conta da AWS de um administrador delegado do Amazon Inspector. ``` aws inspector2 disassociate-member \ --account-id 123456789012 ``` Resultado: ``` { "accountId": "123456789012" } ``` Consulte mais informações em [Managing multiple accounts in Amazon Inspector with AWS Organizations](https://docs.aws.amazon.com/inspector/latest/user/managing-multiple-accounts.html) no *Guia do usuário do Amazon Inspector*. + Consulte detalhes da API em [DisassociateMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/disassociate-member.html) na *Referência de comandos da AWS CLI*. ### `get-configuration` O código de exemplo a seguir mostra como usar `get-configuration`. **AWS CLI** **Obter as definições de varreduras do Inspector** O exemplo `get-configuration` a seguir obtém as definições de varreduras do Inspector. ``` aws inspector2 get-configuration ``` Resultado: ``` { "ec2Configuration": { "scanModeState": { "scanMode": "EC2_HYBRID", "scanModeStatus": "SUCCESS" } }, "ecrConfiguration": { "rescanDurationState": { "pullDateRescanDuration": "DAYS_90", "rescanDuration": "DAYS_30", "status": "SUCCESS", "updatedAt": "2024-05-14T21:16:20.237000+00:00" } } } ``` Para obter mais informações, consulte [Varredura Automatizada de Recursos com o Amazon Inspector](https://docs.aws.amazon.com/inspector/latest/user/scanning-resources.html) no *Guia do usuário do Amazon Inspector*. + Para ver detalhes da API, consulte [GetConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/get-configuration.html) na *Referência de comandos da AWS CLI*. ### `get-member` O código de exemplo a seguir mostra como usar `get-member`. **AWS CLI** **Exemplo: como obter informações de membros da sua organização** aws inspector2 get-member --account-id 123.456.789.012 Resultado: ``` { "member": { "accountId": "123456789012", "delegatedAdminAccountId": "123456789012", "relationshipStatus": "ENABLED", "updatedAt": "2023-09-11T09:57:20.520000-07:00" } } ``` Consulte mais informações em [Managing multiple accounts in Amazon Inspector with AWS Organizations](https://docs.aws.amazon.com/inspector/latest/user/managing-multiple-accounts.html) no *Guia do usuário do Amazon Inspector*. + Consulte detalhes da API em [GetMember](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/get-member.html) na *Referência de comandos da AWS CLI*. ### `get-telemetry-metadata` O código de exemplo a seguir mostra como usar `get-telemetry-metadata`. **AWS CLI** **Obter os metadados de telemetria** O comando `get-telemetry-metadata` a seguir gera informações sobre os dados coletados para a execução da avaliação com o ARN de `arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE`: ``` aws inspector get-telemetry-metadata --assessment-run-arn arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE ``` Resultado: ``` { "telemetryMetadata": [ { "count": 2, "dataSize": 345, "messageType": "InspectorDuplicateProcess" }, { "count": 3, "dataSize": 255, "messageType": "InspectorTimeEventMsg" }, { "count": 4, "dataSize": 1082, "messageType": "InspectorNetworkInterface" }, { "count": 2, "dataSize": 349, "messageType": "InspectorDnsEntry" }, { "count": 11, "dataSize": 2514, "messageType": "InspectorDirectoryInfoMsg" }, { "count": 1, "dataSize": 179, "messageType": "InspectorTcpV6ListeningPort" }, { "count": 101, "dataSize": 10949, "messageType": "InspectorTerminal" }, { "count": 26, "dataSize": 5916, "messageType": "InspectorUser" }, { "count": 282, "dataSize": 32148, "messageType": "InspectorDynamicallyLoadedCodeModule" }, { "count": 18, "dataSize": 10172, "messageType": "InspectorCreateProcess" }, { "count": 3, "dataSize": 8001, "messageType": "InspectorProcessPerformance" }, { "count": 1, "dataSize": 360, "messageType": "InspectorOperatingSystem" }, { "count": 6, "dataSize": 546, "messageType": "InspectorStopProcess" }, { "count": 1, "dataSize": 1553, "messageType": "InspectorInstanceMetaData" }, { "count": 2, "dataSize": 434, "messageType": "InspectorTcpV4Connection" }, { "count": 474, "dataSize": 2960322, "messageType": "InspectorPackageInfo" }, { "count": 3, "dataSize": 2235, "messageType": "InspectorSystemPerformance" }, { "count": 105, "dataSize": 46048, "messageType": "InspectorCodeModule" }, { "count": 1, "dataSize": 182, "messageType": "InspectorUdpV6ListeningPort" }, { "count": 2, "dataSize": 371, "messageType": "InspectorUdpV4ListeningPort" }, { "count": 18, "dataSize": 8362, "messageType": "InspectorKernelModule" }, { "count": 29, "dataSize": 48788, "messageType": "InspectorConfigurationInfo" }, { "count": 1, "dataSize": 79, "messageType": "InspectorMonitoringStart" }, { "count": 5, "dataSize": 0, "messageType": "InspectorSplitMsgBegin" }, { "count": 51, "dataSize": 4593, "messageType": "InspectorGroup" }, { "count": 1, "dataSize": 184, "messageType": "InspectorTcpV4ListeningPort" }, { "count": 1159, "dataSize": 3146579, "messageType": "Total" }, { "count": 5, "dataSize": 0, "messageType": "InspectorSplitMsgEnd" }, { "count": 1, "dataSize": 612, "messageType": "InspectorLoadImageInProcess" } ] } ``` + Para ver detalhes da API, consulte [GetTelemetryMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/get-telemetry-metadata.html) na *Referência de comandos da AWS CLI*. ### `list-account-permissions` O código de exemplo a seguir mostra como usar `list-account-permissions`. **AWS CLI** **Listar as permissões da conta** O exemplo `list-account-permissions` a seguir lista as permissões da sua conta. ``` aws inspector2 list-account-permissions ``` Resultado: ``` { "permissions": [ { "operation": "ENABLE_SCANNING", "service": "ECR" }, { "operation": "DISABLE_SCANNING", "service": "ECR" }, { "operation": "ENABLE_REPOSITORY", "service": "ECR" }, { "operation": "DISABLE_REPOSITORY", "service": "ECR" }, { "operation": "ENABLE_SCANNING", "service": "EC2" }, { "operation": "DISABLE_SCANNING", "service": "EC2" }, { "operation": "ENABLE_SCANNING", "service": "LAMBDA" }, { "operation": "DISABLE_SCANNING", "service": "LAMBDA" } ] } ``` Para obter mais informações, consulte [Gerenciamento de Identidade e Acesso para o Amazon Inspector](https://docs.aws.amazon.com/inspector/latest/user/security-iam.html) no *Guia do usuário do Amazon Inspector*. + Para ver detalhes da API, consulte [ListAccountPermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/list-account-permissions.html) na *Referência de comandos da AWS CLI*. ### `list-assessment-run-agents` O código de exemplo a seguir mostra como usar `list-assessment-run-agents`. **AWS CLI** **Listar agentes de execução de avaliação** O comando `list-assessment-run-agents` a seguir lista os agentes de execução de avaliação com o ARN específico. ``` aws inspector list-assessment-run-agents \ --assessment-run-arn arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE ``` Resultado: ``` { "assessmentRunAgents": [ { "agentHealth": "HEALTHY", "agentHealthCode": "HEALTHY", "agentId": "i-49113b93", "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", "telemetryMetadata": [ { "count": 2, "dataSize": 345, "messageType": "InspectorDuplicateProcess" }, { "count": 3, "dataSize": 255, "messageType": "InspectorTimeEventMsg" }, { "count": 4, "dataSize": 1082, "messageType": "InspectorNetworkInterface" }, { "count": 2, "dataSize": 349, "messageType": "InspectorDnsEntry" }, { "count": 11, "dataSize": 2514, "messageType": "InspectorDirectoryInfoMsg" }, { "count": 1, "dataSize": 179, "messageType": "InspectorTcpV6ListeningPort" }, { "count": 101, "dataSize": 10949, "messageType": "InspectorTerminal" }, { "count": 26, "dataSize": 5916, "messageType": "InspectorUser" }, { "count": 282, "dataSize": 32148, "messageType": "InspectorDynamicallyLoadedCodeModule" }, { "count": 18, "dataSize": 10172, "messageType": "InspectorCreateProcess" }, { "count": 3, "dataSize": 8001, "messageType": "InspectorProcessPerformance" }, { "count": 1, "dataSize": 360, "messageType": "InspectorOperatingSystem" }, { "count": 6, "dataSize": 546, "messageType": "InspectorStopProcess" }, { "count": 1, "dataSize": 1553, "messageType": "InspectorInstanceMetaData" }, { "count": 2, "dataSize": 434, "messageType": "InspectorTcpV4Connection" }, { "count": 474, "dataSize": 2960322, "messageType": "InspectorPackageInfo" }, { "count": 3, "dataSize": 2235, "messageType": "InspectorSystemPerformance" }, { "count": 105, "dataSize": 46048, "messageType": "InspectorCodeModule" }, { "count": 1, "dataSize": 182, "messageType": "InspectorUdpV6ListeningPort" }, { "count": 2, "dataSize": 371, "messageType": "InspectorUdpV4ListeningPort" }, { "count": 18, "dataSize": 8362, "messageType": "InspectorKernelModule" }, { "count": 29, "dataSize": 48788, "messageType": "InspectorConfigurationInfo" }, { "count": 1, "dataSize": 79, "messageType": "InspectorMonitoringStart" }, { "count": 5, "dataSize": 0, "messageType": "InspectorSplitMsgBegin" }, { "count": 51, "dataSize": 4593, "messageType": "InspectorGroup" }, { "count": 1, "dataSize": 184, "messageType": "InspectorTcpV4ListeningPort" }, { "count": 1159, "dataSize": 3146579, "messageType": "Total" }, { "count": 5, "dataSize": 0, "messageType": "InspectorSplitMsgEnd" }, { "count": 1, "dataSize": 612, "messageType": "InspectorLoadImageInProcess" } ] } ] } ``` Para obter mais informações, consulte [AWS Agentes](https://docs.aws.amazon.com/inspector/latest/userguide/inspector_agents.html) no *Guia do usuário do Amazon Inspector*. + Para ver detalhes da API, consulte [ListAssessmentRunAgents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/list-assessment-run-agents.html) na *Referência de comandos da AWS CLI*. ### `list-assessment-runs` O código de exemplo a seguir mostra como usar `list-assessment-runs`. **AWS CLI** **Listar as execuções de avaliação** O comando `list-assessment-runs` a seguir lista todas as execuções de avaliação existentes. ``` aws inspector list-assessment-runs ``` Resultado: ``` { "assessmentRunArns": [ "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-v5D6fI3v" ] } ``` Para obter mais informações, consulte [Modelos de Avaliação e Execuções de Avaliação do Amazon Inspector](https://docs.aws.amazon.com/inspector/latest/userguide/inspector_assessments.html) no *Guia do usuário do Amazon Inspector*. + Para ver detalhes da API, consulte [ListAssessmentRuns](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/list-assessment-runs.html) na *Referência de comandos da AWS CLI*. ### `list-assessment-targets` O código de exemplo a seguir mostra como usar `list-assessment-targets`. **AWS CLI** **Listar os destinos da avaliação** O comando `list-assessment-targets` a seguir lista todos os destinos de avaliação existentes: ``` aws inspector list-assessment-targets ``` Resultado: ``` { "assessmentTargetArns": [ "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq" ] } ``` Para obter mais informações, consulte Avaliação de Destinos do Amazon Inspector no *Guia do usuário do Amazon* Inspector. + Para ver detalhes da API, consulte [ListAssessmentTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/list-assessment-targets.html) na *Referência de comandos da AWS CLI*. ### `list-assessment-templates` O código de exemplo a seguir mostra como usar `list-assessment-templates`. **AWS CLI** **Listar modelos de avaliação** O comando `list-assessment-templates` a seguir lista todos os modelos de avaliação existentes: ``` aws inspector list-assessment-templates ``` Resultado: ``` { "assessmentTemplateArns": [ "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw", "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-Uza6ihLh" ] } ``` Para obter mais informações, consulte Modelos de Avaliação e Execuções de Avaliação do Amazon Inspector no *Guia do Amazon Inspector*. + Para ver detalhes da API, consulte [ListAssessmentTemplates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/list-assessment-templates.html) na *Referência de comandos da AWS CLI*. ### `list-coverage-statistics` O código de exemplo a seguir mostra como usar `list-coverage-statistics`. **AWS CLI** **Exemplo 1: listar estatísticas de cobertura por grupos** O exemplo `list-coverage-statistics` a seguir lista as estatísticas de cobertura do seu ambiente AWS por grupos. ``` aws inspector2 list-coverage-statistics \ --group-by RESOURCE_TYPE ``` Resultado: ``` { "countsByGroup": [ { "count": 56, "groupKey": "AWS_LAMBDA_FUNCTION" }, { "count": 27, "groupKey": "AWS_ECR_REPOSITORY" }, { "count": 18, "groupKey": "AWS_EC2_INSTANCE" }, { "count": 3, "groupKey": "AWS_ECR_CONTAINER_IMAGE" }, { "count": 1, "groupKey": "AWS_ACCOUNT" } ], "totalCounts": 105 } ``` Para obter mais informações, consulte [Avaliando a Cobertura do AWS seu ambiente pelo Amazon Inspector](https://docs.aws.amazon.com/inspector/latest/user/assessing-coverage.html) no *Guia do usuário do Amazon Inspector*. **Exemplo 2: listar estatísticas de cobertura por tipo de recurso** O exemplo `list-coverage-statistics` a seguir lista as estatísticas de cobertura do seu ambiente AWS por tipo de recurso. ``` aws inspector2 list-coverage-statistics --filter-criteria '{"resourceType":[{"comparison":"EQUALS","value":"AWS_ECR_REPOSITORY"}]}' --group-by SCAN_STATUS_REASON ``` Resultado: ``` { "countsByGroup": [ { "count": 27, "groupKey": "SUCCESSFUL" } ], "totalCounts": 27 } ``` Para obter mais informações, consulte [Avaliando a Cobertura do AWS seu ambiente pelo Amazon Inspector](https://docs.aws.amazon.com/inspector/latest/user/assessing-coverage.html) no *Guia do usuário do Amazon Inspector*. **Exemplo 3: listar as estatísticas de cobertura por nome do repositório ECR** O exemplo `list-coverage-statistics` a seguir lista as estatísticas de cobertura do seu ambiente AWS pelo nome do repositório ECR. ``` aws inspector2 list-coverage-statistics --filter-criteria '{"ecrRepositoryName":[{"comparison":"EQUALS","value":"debian"}]}' --group-by SCAN_STATUS_REASON ``` Resultado: ``` { "countsByGroup": [ { "count": 3, "groupKey": "SUCCESSFUL" } ], "totalCounts": 3 } ``` Para obter mais informações, consulte [Avaliando a Cobertura do AWS seu ambiente pelo Amazon Inspector](https://docs.aws.amazon.com/inspector/latest/user/assessing-coverage.html) no *Guia do usuário do Amazon Inspector*. + Para ver detalhes da API, consulte [ListCoverageStatistics](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/list-coverage-statistics.html) na *Referência de comandos da AWS CLI*. ### `list-coverage` O código de exemplo a seguir mostra como usar `list-coverage`. **AWS CLI** **Exemplo 1: listar detalhes de cobertura sobre seu ambiente** O exemplo `list-coverage` a seguir lista os detalhes da cobertura do seu ambiente. ``` aws inspector2 list-coverage ``` Resultado: ``` { "coveredResources": [ { "accountId": "123456789012", "lastScannedAt": "2024-05-20T16:23:20-07:00", "resourceId": "i-EXAMPLE55555555555", "resourceMetadata": { "ec2": { "amiId": "ami-EXAMPLE6666666666", "platform": "LINUX" } }, "resourceType": "AWS_EC2_INSTANCE", "scanStatus": { "reason": "SUCCESSFUL", "statusCode": "ACTIVE" }, "scanType": "PACKAGE" } ] } ``` **Exemplo 2: listar detalhes de cobertura sobre o tipo de recurso da função do Lambda** O exemplo `list-coverage` a seguir lista os detalhes do tipo de recurso da função do Lambda. ``` aws inspector2 list-coverage --filter-criteria '{"resourceType":[{"comparison":"EQUALS","value":"AWS_LAMBDA_FUNCTION"}]}' ``` Resultado: ``` { "coveredResources": [ { "accountId": "123456789012", "resourceId": "arn:aws:lambda:us-west-2:123456789012:function:Eval-container-scan-results:$LATEST", "resourceMetadata": { "lambdaFunction": { "functionName": "Eval-container-scan-results", "functionTags": {}, "layers": [], "runtime": "PYTHON_3_7" } }, "resourceType": "AWS_LAMBDA_FUNCTION", "scanStatus": { "reason": "SUCCESSFUL", "statusCode": "ACTIVE" }, "scanType": "CODE" } ] } ``` + Para ver detalhes da API, consulte [ListCoverage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/list-coverage.html) na *Referência de comandos da AWS CLI*. ### `list-delegated-admin-accounts` O código de exemplo a seguir mostra como usar `list-delegated-admin-accounts`. **AWS CLI** **Listar informações sobre a conta de administrador delegado da sua organização** O exemplo `list-delegated-admin-accounts` a seguir lista informações sobre a conta de administrador delegado da sua organização. ``` aws inspector2 list-delegated-admin-accounts ``` Resultado: ``` { "delegatedAdminAccounts": [ { "accountId": "123456789012", "status": "ENABLED" } ] } ``` Para obter mais informações, consulte [Designação de um administrador delegado para o Amazon Inspector](https://docs.aws.amazon.com/inspector/latest/user/admin-member-relationship.html) no *Guia do usuário do Amazon Inspector*. + Para ver detalhes da API, consulte [ListDelegatedAdminAccounts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/list-delegated-admin-accounts.html) na *Referência de comandos da AWS CLI*. ### `list-event-subscriptions` O código de exemplo a seguir mostra como usar `list-event-subscriptions`. **AWS CLI** **Para listar assinaturas de eventos** O comando `list-event-subscriptions` a seguir lista todas as inscrições de eventos para o modelo de avaliação com o ARN de `arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0`: ``` aws inspector list-event-subscriptions --resource-arn arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0 ``` Resultado: ``` { "subscriptions": [ { "eventSubscriptions": [ { "event": "ASSESSMENT_RUN_COMPLETED", "subscribedAt": 1459455440.867 } ], "resourceArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0", "topicArn": "arn:aws:sns:us-west-2:123456789012:exampletopic" } ] } ``` Para obter mais informações, consulte Modelos de Avaliação e Execuções de Avaliação do Amazon Inspector no *Guia do Amazon Inspector*. + Para ver detalhes da API, consulte [ListEventSubscriptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/list-event-subscriptions.html) na *Referência de comandos da AWS CLI*. ### `list-filters` O código de exemplo a seguir mostra como usar `list-filters`. **AWS CLI** **Listar filtros associados à conta que você usou para ativar o Amazon Inspector** Os exemplos `list-filters` a seguir listam os filtros associados à conta que você usou para ativar o Amazon Inspector. ``` aws inspector2 list-filters ``` Resultado: ``` { "filters": [ { "action": "SUPPRESS", "arn": "arn:aws:inspector2:us-west-2:123456789012:owner/o-EXAMPLE222/filter/EXAMPLE444444444", "createdAt": "2024-05-15T21:11:08.602000+00:00", "criteria": { "resourceType": [ { "comparison": "EQUALS", "value": "AWS_EC2_INSTANCE" }, ] }, "description": "This suppression rule omits EC2 instance type findings", "name": "ExampleSuppressionRuleEC2", "ownerId": "o-EXAMPLE222", "tags": {}, "updatedAt": "2024-05-15T21:11:08.602000+00:00" }, { "action": "SUPPRESS", "arn": "arn:aws:inspector2:us-east-1:813737243517:owner/o-EXAMPLE222/filter/EXAMPLE444444444", "createdAt": "2024-05-15T21:28:27.054000+00:00", "criteria": { "resourceType": [ { "comparison": "EQUALS", "value": "AWS_ECR_INSTANCE" } ] }, "description": "This suppression rule omits ECR instance type findings", "name": "ExampleSuppressionRuleECR", "ownerId": "o-EXAMPLE222", "tags": {}, "updatedAt": "2024-05-15T21:28:27.054000+00:00" } ] } ``` Para obter mais informações, consulte [Filtragem das Descobertas do Amazon Inspector](https://docs.aws.amazon.com/inspector/latest/user/findings-managing-filtering.html) no *Guia do usuário do Amazon Inspector*. + Para ver detalhes da API, consulte [ListFilters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/list-filters.html) na *Referência de comandos da AWS CLI*. ### `list-findings` O código de exemplo a seguir mostra como usar `list-findings`. **AWS CLI** **Listar as descobertas** O comando `list-findings` a seguir lista todas as descobertas geradas: ``` aws inspector list-findings ``` Resultado: ``` { "findingArns": [ "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4", "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-v5D6fI3v/finding/0-tyvmqBLy" ] } ``` Para obter mais informações, consulte Descobertas do Amazon Inspector no *Guia do usuário do Amazon* Inspector. + Para ver detalhes da API, consulte [ListFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/list-findings.html) na *Referência de comandos da AWS CLI*. ### `list-members` O código de exemplo a seguir mostra como usar `list-members`. **AWS CLI** **Exemplo 1: como listar todas as contas-membro associadas ao administrador delegado do Amazon Inspector para sua organização** aws inspector2 list-members --only-associated Resultado: ``` { { "members": [ { "accountId": "123456789012", "delegatedAdminAccountId": "123456789012", "relationshipStatus": "ENABLED", "updatedAt": "2023-09-11T09:57:20.520000-07:00" }, { "accountId": "123456789012", "delegatedAdminAccountId": "123456789012", "relationshipStatus": "ENABLED", "updatedAt": "2024-08-12T10:13:01.472000-07:00" }, { "accountId": "625032911453", "delegatedAdminAccountId": "123456789012", "relationshipStatus": "ENABLED", "updatedAt": "2023-09-11T09:57:20.438000-07:00" }, { "accountId": "715411239211", "delegatedAdminAccountId": "123456789012", "relationshipStatus": "ENABLED", "updatedAt": "2024-04-24T09:14:57.471000-07:00" } ] } ``` Consulte mais informações em [Managing multiple accounts in Amazon Inspector with AWS Organizations](https://docs.aws.amazon.com/inspector/latest/user/managing-multiple-accounts.html) no *Guia do usuário do Amazon Inspector*. **Exemplo 2: como listar todas as contas-membro associadas e desassociadas do administrador delegado do Amazon Inspector para sua organização** aws inspector2 list-members --no-only-associated Resultado: ``` { { "members": [ { "accountId": "123456789012", "delegatedAdminAccountId": "123456789012", "relationshipStatus": "REMOVED", "updatedAt": "2024-05-15T11:34:53.326000-07:00" }, { "accountId": "123456789012", "delegatedAdminAccountId": "123456789012", "relationshipStatus": "ENABLED", "updatedAt": "2023-09-11T09:57:20.520000-07:00" }, { "accountId": "123456789012", "delegatedAdminAccountId": "123456789012", "relationshipStatus": "ENABLED", "updatedAt": "2024-08-12T10:13:01.472000-07:00" }, { "accountId": "123456789012", "delegatedAdminAccountId": "123456789012", "relationshipStatus": "ENABLED", "updatedAt": "2023-09-11T09:57:20.438000-07:00" }, { "accountId": "123456789012", "delegatedAdminAccountId": "123456789012", "relationshipStatus": "ENABLED", "updatedAt": "2024-04-24T09:14:57.471000-07:00" } ] } ``` Consulte mais informações em [Managing multiple accounts in Amazon Inspector with AWS Organizations](https://docs.aws.amazon.com/inspector/latest/user/managing-multiple-accounts.html) no *Guia do usuário do Amazon Inspector*. + Para ver detalhes da API, consulte [ListMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/list-members.html) na *Referência de comandos da AWS CLI*. ### `list-rules-packages` O código de exemplo a seguir mostra como usar `list-rules-packages`. **AWS CLI** **Listar pacotes de regras** O comando `list-rules-packages` a seguir lista todos os pacotes de regras do Inspector disponíveis: ``` aws inspector list-rules-packages ``` Resultado: ``` { "rulesPackageArns": [ "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p", "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-H5hpSawc", "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ", "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-vg5GGHSD" ] } ``` Para obter mais informações, consulte Pacotes e regras de regras do Amazon Inspector no Guia do *Amazon Inspector*. + Para ver detalhes da API, consulte [ListRulesPackages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/list-rules-packages.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar tags para recurso** O comando `list-tags-for-resource` a seguir lista todas as marcações associadas ao modelo de avaliação com o ARN de `arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-gcwFliYu`: ``` aws inspector list-tags-for-resource --resource-arn arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-gcwFliYu ``` Resultado: ``` { "tags": [ { "key": "Name", "value": "Example" } ] } ``` Para obter mais informações, consulte Modelos de Avaliação e Execuções de Avaliação do Amazon Inspector no *Guia do Amazon Inspector*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `list-usage-totals` O código de exemplo a seguir mostra como usar `list-usage-totals`. **AWS CLI** **Listar os totais de uso nos últimos 30 dias** Os exemplos `list-usage-totals` a seguir listam os totais de uso nos últimos 30 dias. ``` aws inspector2 list-usage-totals ``` Resultado: ``` { "totals": [ { "accountId": "123456789012", "usage": [ { "currency": "USD", "estimatedMonthlyCost": 4.6022044647, "total": 1893.4784083333334, "type": "EC2_AGENTLESS_INSTANCE_HOURS" }, { "currency": "USD", "estimatedMonthlyCost": 18.892449279, "total": 10882.050784722222, "type": "EC2_INSTANCE_HOURS" }, { "currency": "USD", "estimatedMonthlyCost": 5.4525363736, "total": 6543.043648333333, "type": "LAMBDA_FUNCTION_CODE_HOURS" }, { "currency": "USD", "estimatedMonthlyCost": 3.9064080309, "total": 9375.379274166668, "type": "LAMBDA_FUNCTION_HOURS" }, { "currency": "USD", "estimatedMonthlyCost": 0.06, "total": 6.0, "type": "ECR_RESCAN" }, { "currency": "USD", "estimatedMonthlyCost": 0.09, "total": 1.0, "type": "ECR_INITIAL_SCAN" } ] } ] } ``` Para obter mais informações, consulte [Monitoramento de uso e custo no Amazon Inspector](https://docs.aws.amazon.com/inspector/latest/user/usage.html) no *Guia do usuário do Amazon Inspector*. + Para ver detalhes da API, consulte [ListUsageTotals](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/list-usage-totals.html) na *Referência de comandos da AWS CLI*. ### `preview-agents` O código de exemplo a seguir mostra como usar `preview-agents`. **AWS CLI** **Pré-visualizar agentes** O comando `preview-agents` a seguir visualiza os agentes instalados nas instâncias do EC2 que fazem parte do destino de avaliação com o ARN de `arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq`: ``` aws inspector preview-agents --preview-agents-arn arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq ``` Resultado: ``` { "agentPreviews": [ { "agentId": "i-49113b93" } ] } ``` Para obter mais informações, consulte Avaliação de Destinos do Amazon Inspector no *Guia do usuário do Amazon* Inspector. + *Para ver detalhes da API, consulte [PreviewAgents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/preview-agents.html) na Referência de comandos da AWS CLI*. ### `register-cross-account-access-role` O código de exemplo a seguir mostra como usar `register-cross-account-access-role`. **AWS CLI** **Registrar o perfil de acesso entre contas** O comando `register-cross-account-access-role` a seguir registra o perfil do IAM com o ARN de `arn:aws:iam::123456789012:role/inspector` que o Amazon Inspector usa para listar suas instâncias do EC2 no início da execução da avaliação quando você chama o comando preview-agents: ``` aws inspector register-cross-account-access-role --role-arn arn:aws:iam::123456789012:role/inspector ``` Para obter mais informações, consulte Configuração do Amazon Inspector no *Guia do Usuário Amazon Inspector*. + Para ver detalhes da API, consulte [RegisterCrossAccountAccessRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/register-cross-account-access-role.html) na *Referência de comandos da AWS CLI*. ### `remove-attributes-from-findings` O código de exemplo a seguir mostra como usar `remove-attributes-from-findings`. **AWS CLI** **Remover atributos das descobertas** O comando `remove-attributes-from-finding` a seguir remove o atributo com a chave de `Example` e o valor de `example` da descoberta com o ARN de `arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-8l1VIE0D/run/0-Z02cjjug/finding/0-T8yM9mEU`: ``` aws inspector remove-attributes-from-findings --finding-arns arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-8l1VIE0D/run/0-Z02cjjug/finding/0-T8yM9mEU --attribute-keys key=Example,value=example ``` Resultado: ``` { "failedItems": {} } ``` Para obter mais informações, consulte Descobertas do Amazon Inspector no *Guia do usuário do Amazon* Inspector. + Para ver detalhes da API, consulte [RemoveAttributesFromFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/remove-attributes-from-findings.html) na *Referência de comandos da AWS CLI*. ### `set-tags-for-resource` O código de exemplo a seguir mostra como usar `set-tags-for-resource`. **AWS CLI** **Listar as marcações para um recurso** O comando `set-tags-for-resource` a seguir define a marcação com a chave de `Example` e o valor de `example` para o modelo de avaliação com o ARN de `arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0`: ``` aws inspector set-tags-for-resource --resource-arn arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0 --tags key=Example,value=example ``` Para obter mais informações, consulte Modelos de Avaliação e Execuções de Avaliação do Amazon Inspector no *Guia do Amazon Inspector*. + Para ver detalhes da API, consulte [SetTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/set-tags-for-resource.html) na *Referência de comandos da AWS CLI*. ### `start-assessment-run` O código de exemplo a seguir mostra como usar `start-assessment-run`. **AWS CLI** **Iniciar uma execução de avaliação** O comando `start-assessment-run` a seguir inicia a execução da avaliação nomeada `examplerun` usando o modelo de avaliação com o ARN de `arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T`: ``` aws inspector start-assessment-run --assessment-run-name examplerun --assessment-template-arn arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T ``` Resultado: ``` { "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-jOoroxyY" } ``` Para obter mais informações, consulte Modelos de Avaliação e Execuções de Avaliação do Amazon Inspector no *Guia do Amazon Inspector*. + Para ver detalhes da API, consulte [StartAssessmentRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/start-assessment-run.html) na *Referência de comandos da AWS CLI*. ### `stop-assessment-run` O código de exemplo a seguir mostra como usar `stop-assessment-run`. **AWS CLI** **Interromper uma execução de avaliação** O comando `stop-assessment-run` a seguir interrompe a execução da avaliação com o ARN de `arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-jOoroxyY`: ``` aws inspector stop-assessment-run --assessment-run-arn arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-jOoroxyY ``` Para obter mais informações, consulte Modelos de Avaliação e Execuções de Avaliação do Amazon Inspector no *Guia do Amazon Inspector*. + Para ver detalhes da API, consulte [StopAssessmentRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/stop-assessment-run.html) na *Referência de comandos da AWS CLI*. ### `subscribe-to-event` O código de exemplo a seguir mostra como usar `subscribe-to-event`. **AWS CLI** **Inscrever-se em um evento** O exemplo a seguir ativa o processo de envio de notificações do Amazon SNS sobre o evento `ASSESSMENT_RUN_COMPLETED` para o tópico com o ARN de `arn:aws:sns:us-west-2:123456789012:exampletopic` ``` aws inspector subscribe-to-event \ --event ASSESSMENT_RUN_COMPLETED \ --resource-arn arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0 \ --topic-arn arn:aws:sns:us-west-2:123456789012:exampletopic ``` Este comando não produz saída. Para obter mais informações, consulte [Modelos de Avaliação e Execuções de Avaliação do Amazon Inspector](https://docs.aws.amazon.com/inspector/latest/userguide/inspector_assessments.html) no *Guia do Amazon Inspector*. + Para ver detalhes da API, consulte [SubscribeToEvent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/subscribe-to-event.html) na *Referência de comandos da AWS CLI*. ### `unsubscribe-from-event` O código de exemplo a seguir mostra como usar `unsubscribe-from-event`. **AWS CLI** **Cancelar a inscrição em um evento** O comando `unsubscribe-from-event` a seguir desativa o processo de envio de notificações do Amazon SNS sobre o evento `ASSESSMENT_RUN_COMPLETED` para o tópico com o ARN de `arn:aws:sns:us-west-2:123456789012:exampletopic`: ``` aws inspector unsubscribe-from-event --event ASSESSMENT_RUN_COMPLETED --resource-arn arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0 --topic arn:aws:sns:us-west-2:123456789012:exampletopic ``` Para obter mais informações, consulte Modelos de Avaliação e Execuções de Avaliação do Amazon Inspector no *Guia do Amazon Inspector*. + Para ver detalhes da API, consulte [UnsubscribeFromEvent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/unsubscribe-from-event.html) na *Referência de comandos da AWS CLI*. ### `update-assessment-target` O código de exemplo a seguir mostra como usar `update-assessment-target`. **AWS CLI** **Criar um destino de avaliação** O comando `update-assessment-target` a seguir atualiza o destino da avaliação com o ARN de `arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX` e o nome de`Example`, e o grupo de recursos com o ARN de `arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-yNbgL5Pt`: ``` aws inspector update-assessment-target --assessment-target-arn arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX --assessment-target-name Example --resource-group-arn arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-yNbgL5Pt ``` Para obter mais informações, consulte Avaliação de Destinos do Amazon Inspector no *Guia do usuário do Amazon* Inspector. + Para ver detalhes da API, consulte [UpdateAssessmentTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/update-assessment-target.html) na *Referência de comandos da AWS CLI*. ### `update-filter` O código de exemplo a seguir mostra como usar `update-filter`. **AWS CLI** **Criar um filtro** O exemplo `update-filter` a seguir atualiza um filtro para omitir as descobertas do Lambda em vez das descobertas da instância ECR. ``` aws inspector2 update-filter \ --filter-arn "arn:aws:inspector2:us-west-2:123456789012:owner/o-EXAMPLE222/filter/EXAMPLE444444444" \ --name "ExampleSuppressionRuleLambda" \ --description "This suppression rule omits Lambda instance findings" \ --reason "Updating filter to omit Lambda instance findings instead of ECR instance findings" ``` Resultado: ``` { "filters": [ { "action": "SUPPRESS", "arn": "arn:aws:inspector2:us-west-2:123456789012:owner/o-EXAMPLE222/filter/EXAMPLE444444444", "createdAt": "2024-05-15T21:28:27.054000+00:00", "criteria": { "resourceType": [ { "comparison": "EQUALS", "value": "AWS_ECR_INSTANCE" } ] }, "description": "This suppression rule omits Lambda instance findings", "name": "ExampleSuppressionRuleLambda", "ownerId": "o-EXAMPLE222", "reason": "Updating filter to omit Lambda instance findings instead of ECR instance findings", "tags": {}, "updatedAt": "2024-05-15T22:23:13.665000+00:00" } ] } ``` Para obter mais informações, consulte [Gerenciamento de Descobertas no Amazon Inspector](https://docs.aws.amazon.com/inspector/latest/user/findings-managing.html) no *Guia do usuário do Amazon Inspector*. + Para ver detalhes da API, consulte [UpdateFilter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/update-filter.html) na *Referência de comandos da AWS CLI*. # AWS IoT Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o AWS IoT. *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 ### `accept-certificate-transfer` O código de exemplo a seguir mostra como usar `accept-certificate-transfer`. **AWS CLI** **Para aceitar um certificado de dispositivo transferido de uma conta da AWS diferente** O exemplo `accept-certificate-transfer` a seguir aceita um certificado de dispositivo transferido de outra conta da AWS. O certificado é identificado por seu ID. ``` aws iot accept-certificate-transfer \ --certificate-id 488b6a7f2acdeb00a77384e63c4e40b18bEXAMPLEe57b7272ba44c45e3448142 ``` Esse comando não produz nenhuma saída. Para obter mais informações, consulte [Transferir um certificado para outra conta](https://docs.aws.amazon.com/iot/latest/developerguide/transfer-cert.html) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [AcceptCertificateTransfer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/accept-certificate-transfer.html) na *Referência de comandos da AWS CLI*. ### `add-thing-to-billing-group` O código de exemplo a seguir mostra como usar `add-thing-to-billing-group`. **AWS CLI** **Exemplo 1: adicionar um item a um grupo de cobrança pelo nome** O exemplo `add-thing-to-billing-group` a seguir adiciona o item chamado `MyLightBulb` ao grupo de cobrança chamado `GroupOne`. ``` aws iot add-thing-to-billing-group \ --billing-group-name GroupOne \ --thing-name MyLightBulb ``` Este comando não produz saída. **Exemplo 2: adicionar um item a um grupo de cobrança por ARN** O exemplo `add-thing-to-billing-group` a seguir adiciona um item com um ARN especificado a um grupo de cobrança com o ARN especificado. Especificar um ARN é útil ao trabalhar com várias regiões ou contas da AWS. Isso pode ajudar a garantir que o item seja adicionado à região e à conta corretas. ``` aws iot add-thing-to-thing-group \ --billing-group-arn "arn:aws:iot:us-west-2:123456789012:billinggroup/GroupOne" \ --thing-arn "arn:aws:iot:us-west-2:123456789012:thing/MyOtherLightBulb" ``` Este comando não produz saída. Para obter mais informações, consulte [Grupos de cobrança](https://docs.aws.amazon.com/iot/latest/developerguide/tagging-iot-billing-groups.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [AddThingToBillingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/add-thing-to-billing-group.html) na *Referência de comandos da AWS CLI*. ### `add-thing-to-thing-group` O código de exemplo a seguir mostra como usar `add-thing-to-thing-group`. **AWS CLI** **Para adicionar um item a um grupo** O exemplo `add-thing-to-thing-group` a seguir adiciona o item especificado a um grupo de itens especificado. ``` aws iot add-thing-to-thing-group \ --thing-name MyLightBulb \ --thing-group-name LightBulbs ``` Este comando não produz saída. Para obter mais informações, consulte [Grupos de itens](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [AddThingToThingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/add-thing-to-thing-group.html) na *Referência de comandos da AWS CLI*. ### `associate-targets-with-job` O código de exemplo a seguir mostra como usar `associate-targets-with-job`. **AWS CLI** **Para associar um grupo a um trabalho contínuo** O exemplo `associate-targets-with-job` a seguir associa o grupo de itens especificado ao trabalho contínuo especificado. ``` aws iot associate-targets-with-job \ --targets "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" \ --job-id "example-job-04" ``` Resultado: ``` { "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-04", "jobId": "example-job-04", "description": "example continuous job" } ``` Para obter mais informações, consulte [Criar e gerenciar trabalhos (CLI)](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [AssociateTargetsWithJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/associate-targets-with-job.html) na *Referência de comandos da AWS CLI*. ### `attach-policy` O código de exemplo a seguir mostra como usar `attach-policy`. **AWS CLI** **Exemplo 1: anexar uma política a um grupo de itens** O exemplo `attach-policy` a seguir anexa a política especificada a um grupo de itens identificado por seu ARN. ``` aws iot attach-policy \ --target "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" \ --policy-name "UpdateDeviceCertPolicy" ``` Esse comando não produz nenhuma saída. Para obter mais informações, consulte [Grupos de itens](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html) no *Guia do desenvolvedor do AWS IoT*. **Exemplo 2: anexar uma política a um certificado** O exemplo `attach-policy` a seguir anexa a política `UpdateDeviceCertPolicy` à entidade principal especificada por um certificado. ``` aws iot attach-policy \ --policy-name UpdateDeviceCertPolicy \ --target "arn:aws:iot:us-west-2:123456789012:cert/4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e" ``` Esse comando não produz nenhuma saída. Para obter mais informações, consulte [Anexar uma política de AWS IoT a um certificado de dispositivo](https://docs.aws.amazon.com/iot/latest/developerguide/attach-policy-to-certificate.html) no *Guia do desenvolvedor do AWS IoT*. + Consulte detalhes da API em [AttachPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/attach-policy.html) na *Referência de comandos da AWS CLI*. ### `attach-security-profile` O código de exemplo a seguir mostra como usar `attach-security-profile`. **AWS CLI** **Para associar um perfil de segurança a todos os dispositivos não registrados** O exemplo `attach-security-profile` a seguir associa o perfil de segurança do AWS IoT Device Defender chamado `Testprofile` a todos os dispositivos não registrados na região `us-west-2` para essa conta da AWS. ``` aws iot attach-security-profile \ --security-profile-name Testprofile \ --security-profile-target-arn "arn:aws:iot:us-west-2:123456789012:all/unregistered-things" ``` Este comando não produz saída. Para obter mais informações, consulte [Comandos do Detect](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [AttachSecurityProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/attach-security-profile.html) na *Referência de comandos da AWS CLI*. ### `attach-thing-principal` O código de exemplo a seguir mostra como usar `attach-thing-principal`. **AWS CLI** **Para anexar um certificado a um item** O exemplo `attach-thing-principal` a seguir anexa um certificado ao item MyTemperatureSensor. O certificado é identificado por um ARN. É possível encontrar o ARN para um certificado no console do AWS IoT. ``` aws iot attach-thing-principal \ --thing-name MyTemperatureSensor \ --principal arn:aws:iot:us-west-2:123456789012:cert/2e1eb273792174ec2b9bf4e9b37e6c6c692345499506002a35159767055278e8 ``` Este comando não produz saída. Para acessar mais informações, consulte [Como gerenciar objetos com o registro](https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [AttachThingPrincipal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/attach-thing-principal.html) na *Referência de Comandos da AWS CLI*. ### `cancel-audit-mitigation-actions-task` O código de exemplo a seguir mostra como usar `cancel-audit-mitigation-actions-task`. **AWS CLI** **Para cancelar uma tarefa de ações de mitigação de auditoria** O exemplo `cancel-audit-mitigations-action-task` a seguir cancela a aplicação de ações de mitigação para a tarefa especificada. Não é possível cancelar tarefas que foram concluídas. ``` aws iot cancel-audit-mitigation-actions-task --task-id "myActionsTaskId" ``` Este comando não produz saída. Para obter mais informações, consulte [CancelAuditMitigationActionsTask (Comandos de ação de mitigação)](https://docs.aws.amazon.com/iot/latest/developerguide/mitigation-action-commands.html#dd-api-iot-CancelAuditMitigationActionsTask) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [CancelAuditMitigationActionsTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/cancel-audit-mitigation-actions-task.html) na *Referência de comandos da AWS CLI*. ### `cancel-audit-task` O código de exemplo a seguir mostra como usar `cancel-audit-task`. **AWS CLI** **Para cancelar uma tarefa de auditoria** O exemplo `cancel-audit-task` a seguir cancela uma tarefa de auditoria com o ID de tarefa especificado. Não é possível cancelar uma tarefa que está concluída. ``` aws iot cancel-audit-task \ --task-id a3aea009955e501a31b764abe1bebd3d ``` Este comando não produz saída. Para obter mais informações, consulte [Comandos de auditoria](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [CancelAuditTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/cancel-audit-task.html) na *Referência de comandos da AWS CLI*. ### `cancel-certificate-transfer` O código de exemplo a seguir mostra como usar `cancel-certificate-transfer`. **AWS CLI** **Para cancelar a transferência de um certificado para uma conta da AWS diferente** O exemplo `cancel-certificate-transfer` a seguir cancela a transferência da transferência de certificado especificada. O certificado é identificado por uma ID de certificado. É possível encontrar o ID para um certificado no console do AWS IoT. ``` aws iot cancel-certificate-transfer \ --certificate-id f0f33678c7c9a046e5cc87b2b1a58dfa0beec26db78addd5e605d630e05c7fc8 ``` Este comando não produz saída. Para obter mais informações, consulte [Transferir um certificado para outra conta](https://docs.aws.amazon.com/iot/latest/developerguide/transfer-cert.html) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [CancelCertificateTransfer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/cancel-certificate-transfer.html) na *Referência de comandos da AWS CLI*. ### `cancel-job-execution` O código de exemplo a seguir mostra como usar `cancel-job-execution`. **AWS CLI** **Para cancelar uma execução de trabalho em um dispositivo** O exemplo `cancel-job-execution` a seguir cancela a execução do trabalho especificado em um dispositivo. Se o trabalho não estiver no estado `QUEUED`, é necessário adicionar o parâmetro `--force`. ``` aws iot cancel-job-execution \ --job-id "example-job-03" \ --thing-name "MyRPi" ``` Este comando não produz saída. Para obter mais informações, consulte [Criar e gerenciar trabalhos (CLI)](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [CancelJobExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/cancel-job-execution.html) na *Referência de comandos da AWS CLI*. ### `cancel-job` O código de exemplo a seguir mostra como usar `cancel-job`. **AWS CLI** **Para cancelar um trabalho** O exemplo `cancel-job` a seguir cancela o trabalho especificado. ``` aws iot cancel-job \ --job-job "example-job-03" ``` Resultado: ``` { "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-03", "jobId": "example-job-03", "description": "example job test" } ``` Para obter mais informações, consulte [Criar e gerenciar trabalhos (CLI)](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [CancelJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/cancel-job.html) na *Referência de comandos da AWS CLI*. ### `clear-default-authorizer` O código de exemplo a seguir mostra como usar `clear-default-authorizer`. **AWS CLI** **Para limpar o autorizador padrão** O exemplo `clear-default-authorizer` a seguir limpa o autorizador personalizado padrão atualmente configurado. Depois de executar esse comando, não haverá um autorizador padrão. Ao usar um autorizador personalizado, é necessário especificá-lo pelo nome nos cabeçalhos da solicitação HTTP. ``` aws iot clear-default-authorizer ``` Este comando não produz saída. Para obter mais informações, consulte [ClearDefaultAuthorizer](https://docs.aws.amazon.com/iot/latest/apireference/API_ClearDefaultAuthorizer.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [ClearDefaultAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/clear-default-authorizer.html) na *Referência de comandos da AWS CLI*. ### `confirm-topic-rule-destination` O código de exemplo a seguir mostra como usar `confirm-topic-rule-destination`. **AWS CLI** **Para confirmar um destino de regra de tópico** O exemplo `confirm-topic-rule-destination` a seguir confirma o destino de uma regra de tópico com um token de confirmação recebido em um endpoint HTTP. ``` aws iot confirm-topic-rule-destination \ --confirmation-token "AYADeIcmtq-ZkxfpiWIQqHWM5ucAXwABABVhd3MtY3J5cHRvLXB1YmxpYy1rZXkAREFxY1E0UmlGeDg0V21BZWZ1VjZtZWFRVUJJUktUYXJaN09OZlJOczJhRENSZmZYL3JHZC9PR3NNcis5T3ZlSitnQT09AAEAB2F3cy1rbXMAS2Fybjphd3M6a21zOnVzLWVhc3QtMTo5ODc5NTE4NTI0OTk6a2V5L2U4YmU3ODViLTU5NWMtNDcxYi1iOWJmLWQ2Y2I4ZjQxODlmNwC4AQIBAHhwz48UWTGWE1ua0P8U1hj27nsFzEaAdf6Hs2K_7wBheAF62zwMuk_A4dPiC6eyPGuMAAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQM9vtRMpf9D3CiZ8sMAgEQgDuFd0Txy-aywpPqg8YEsa1lD4B40aJ2s1wEHKMybiF1RoOZzYisI0IvslzQY5UmCkqq3tV-3f7-nKfosgIAAAAADAAAEAAAAAAAAAAAAAAAAAAi9RMgy-V19V9m6Iw2xfbw_____wAAAAEAAAAAAAAAAAAAAAEAAAB1hw4SokgUcxiJ3gTO6n50NLJVpzyQR1UmPIj5sShqXEQGcOsWmXzpYOOx_PWyPVNsIFHApyK7Cc3g4bW8VaLVwOLkC83g6YaZAh7dFEl2-iufgrzTePl8RZYOWr0O6Aj9DiVzJZx-1iD6Pu-G6PUw1kaO7Knzs2B4AD0qfrHUF4pYRTvyUgBnMGUCMQC8ZRmhKqntd_c6Kgrow3bMUDBvNqo2qZr8Z8Jm2rzgseROlAnLgFLGpGShr99oSZkCMEd1v62NBRKX9HQXnybyF3fkg__-PIetJ803Z4IlIlF8xXlcdPGP-PV1dOXFemyL8g" ``` Este comando não produz saída. Para obter mais informações, consulte [Confirmar um destino de regra de tópico](https://docs.aws.amazon.com/iot/latest/developerguide/rule-destination.html#confirm-destination) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ConfirmTopicRuleDestination](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/confirm-topic-rule-destination.html) na *Referência de comandos da AWS CLI*. ### `create-audit-suppression` O código de exemplo a seguir mostra como usar `create-audit-suppression`. **AWS CLI** **Para criar uma supressão de descoberta de auditoria** O exemplo `create-audit-suppression` a seguir cria uma supressão de descoberta de auditoria para uma política chamada "virtualMachinePolicy" que foi sinalizada por ser excessivamente permissiva. ``` aws iot create-audit-suppression \ --check-name IOT_POLICY_OVERLY_PERMISSIVE_CHECK \ --resource-identifier policyVersionIdentifier={"policyName"="virtualMachinePolicy","policyVersionId"="1"} \ --no-suppress-indefinitely \ --expiration-date 2020-10-20 ``` Este comando não produz saída. Para obter mais informações, consulte [Supressões de descoberta de auditoria](https://docs.aws.amazon.com/iot/latest/developerguide/audit-finding-suppressions.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [CreateAuditSuppression](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-audit-suppression.html) na *Referência de comandos da AWS CLI*. ### `create-authorizer` O código de exemplo a seguir mostra como usar `create-authorizer`. **AWS CLI** **Para criar um autorizador personalizado** O exemplo `create-authorizer` a seguir cria um autorizador personalizado que usa a função do Lambda especificada como parte de um serviço de autenticação personalizado. ``` aws iot create-authorizer \ --authorizer-name "CustomAuthorizer" \ --authorizer-function-arn "arn:aws:lambda:us-west-2:123456789012:function:CustomAuthorizerFunction" \ --token-key-name "MyAuthToken" \ --status ACTIVE \ --token-signing-public-keys FIRST_KEY="-----BEGIN PUBLIC KEY----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1uJOB4lQPgG/lM6ZfIwo Z+7ENxAio9q6QD4FFqjGZsvjtYwjoe1RKK0U8Eq9xb5O3kRSmyIwTzwzm/f4Gf0Y ZUloJ+t3PUUwHrmbYTAgTrCUgRFygjfgVwGCPs5ZAX4Eyqt5cr+AIHIiUDbxSa7p zwOBKPeic0asNJpqT8PkBbRaKyleJh5oo81NDHHmVtbBm5A5YiJjqYXLaVAowKzZ +GqsNvAQ9Jy1wI2VrEa1OfL8flDB/BJLm7zjpfPOHDJQgID0XnZwAlNnZcOhCwIx 50g2LW2Oy9R/dmqtDmJiVP97Z4GykxPvwlYHrUXY0iW1R3AR/Ac1NhCTGZMwVDB1 lQIDAQAB -----END PUBLIC KEY-----" ``` Resultado: ``` { "authorizerName": "CustomAuthorizer", "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer2" } ``` Para obter mais informações, consulte [CreateAuthorizer](https://docs.aws.amazon.com/iot/latest/apireference/API_CreateAuthorizer.html) no *Guia de referência da API do AWS IoT*. + Para ver detalhes da API, consulte [CreateAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-authorizer.html) na *Referência de comandos da AWS CLI*. ### `create-billing-group` O código de exemplo a seguir mostra como usar `create-billing-group`. **AWS CLI** **Para criar um grupo de cobrança** O exemplo `create-billing-group` a seguir cria um grupo de cobrança simples chamado `GroupOne`. ``` aws iot create-billing-group \ --billing-group-name GroupOne ``` Resultado: ``` { "billingGroupName": "GroupOne", "billingGroupArn": "arn:aws:iot:us-west-2:123456789012:billinggroup/GroupOne", "billingGroupId": "103de383-114b-4f51-8266-18f209ef5562" } ``` Para obter mais informações, consulte [Grupos de cobrança](https://docs.aws.amazon.com/iot/latest/developerguide/tagging-iot-billing-groups.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [CreateBillingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-billing-group.html) na *Referência de comandos da AWS CLI*. ### `create-certificate-from-csr` O código de exemplo a seguir mostra como usar `create-certificate-from-csr`. **AWS CLI** **Para criar um certificado de dispositivo a partir de uma solicitação de assinatura de certificado (CSR)** O exemplo `create-certificate-from-csr` a seguir cria um certificado de dispositivo a partir de uma CSR. É possível usar o comando `openssl` para criar um CSR. ``` aws iot create-certificate-from-csr \ --certificate-signing-request=file://certificate.csr ``` Resultado: ``` { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/c0c57bbc8baaf4631a9a0345c957657f5e710473e3ddbee1428d216d54d53ac9", "certificateId": "c0c57bbc8baaf4631a9a0345c957657f5e710473e3ddbee1428d216d54d53ac9", "certificatePem": "" } ``` Para obter mais informações, consulte [CreateCertificateFromCSR](https://docs.aws.amazon.com/iot/latest/apireference/API_CreateCertificateFromCsr.html) no *Guia de referência da API do AWS IoT*. + Para ver detalhes da API, consulte [CreateCertificateFromCsr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-certificate-from-csr.html) na *Referência de comandos da AWS CLI*. ### `create-custom-metric` O código de exemplo a seguir mostra como usar `create-custom-metric`. **AWS CLI** **Para criar uma métrica personalizada publicada por seus dispositivos no Device Defender** O exemplo `create-custom-metric` a seguir cria uma métrica personalizada que mede a porcentagem da bateria. ``` aws iot create-custom-metric \ --metric-name "batteryPercentage" \ --metric-type "number" \ --display-name "Remaining battery percentage." \ --region us-east-1 \ --client-request-token "02ccb92b-33e8-4dfa-a0c1-35b181ed26b0" ``` Resultado: ``` { "metricName": "batteryPercentage", "metricArn": "arn:aws:iot:us-east-1:1234564789012:custommetric/batteryPercentage" } ``` Para obter mais informações, consulte [Métricas personalizadas](https://docs.aws.amazon.com/iot/latest/developerguide/dd-detect-custom-metrics.html) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [CreateCustomMetric](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-custom-metric.html) na *Referência de comandos da AWS CLI*. ### `create-dimension` O código de exemplo a seguir mostra como usar `create-dimension`. **AWS CLI** **Para criar uma dimensão** O `create-dimension` a seguir cria uma dimensão com um único filtro de tópico chamado `TopicFilterForAuthMessages`. ``` aws iot create-dimension \ --name TopicFilterForAuthMessages \ --type TOPIC_FILTER \ --string-values device/+/auth ``` Resultado: ``` { "name": "TopicFilterForAuthMessages", "arn": "arn:aws:iot:eu-west-2:123456789012:dimension/TopicFilterForAuthMessages" } ``` Para obter mais informações, consulte [Comandos do Detect](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [CreateDimension](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-dimension.html) na *Referência de comandos da AWS CLI*. ### `create-domain-configuration` O código de exemplo a seguir mostra como usar `create-domain-configuration`. **AWS CLI** **Para criar uma configuração de domínio** O exemplo `create-domain-configuration` a seguir cria uma configuração de domínio gerenciado pela AWS com um tipo de serviço de `DATA`. ``` aws iot create-domain-configuration \ --domain-configuration-name "additionalDataDomain" \ --service-type "DATA" ``` Resultado: ``` { "domainConfigurationName": "additionalDataDomain", "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/additionalDataDomain/dikMh" } ``` Para obter mais informações, consulte [Endpoints configuráveis](https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-endpoints-configurable-aws.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [CreateDomainConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-domain-configuration.html) na *Referência de comandos da AWS CLI*. ### `create-dynamic-thing-group` O código de exemplo a seguir mostra como usar `create-dynamic-thing-group`. **AWS CLI** **Para criar um grupo dinâmico de itens** O exemplo `create-dynamic-thing-group` a seguir cria um grupo dinâmico de itens que contém qualquer item com um atributo de temperatura maior que 60 graus. É necessário habilitar a indexação da frota do AWS IoT antes de poder usar grupos dinâmicos de itens. ``` aws iot create-dynamic-thing-group \ --thing-group-name "RoomTooWarm" \ --query-string "attributes.temperature>60" ``` Resultado: ``` { "thingGroupName": "RoomTooWarm", "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/RoomTooWarm", "thingGroupId": "9d52492a-fc87-43f4-b6e2-e571d2ffcad1", "indexName": "AWS_Things", "queryString": "attributes.temperature>60", "queryVersion": "2017-09-30" } ``` Para obter mais informações, consulte [Grupos dinâmicos de itens](https://docs.aws.amazon.com/iot/latest/developerguide/dynamic-thing-groups.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [CreateDynamicThingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-dynamic-thing-group.html) na *Referência de comandos da AWS CLI*. ### `create-job` O código de exemplo a seguir mostra como usar `create-job`. **AWS CLI** **Exemplo 1: criar um trabalho** O exemplo `create-job` a seguir cria um trabalho simples do AWS IoT que envia um documento JSON para o dispositivo `MyRaspberryPi`. ``` aws iot create-job \ --job-id "example-job-01" \ --targets "arn:aws:iot:us-west-2:123456789012:thing/MyRaspberryPi" \ --document file://example-job.json \ --description "example job test" \ --target-selection SNAPSHOT ``` Resultado: ``` { "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01", "jobId": "example-job-01", "description": "example job test" } ``` **Exemplo 2: criar um trabalho contínuo** O exemplo `create-job` a seguir cria um trabalho que continua sendo executado depois que os itens especificados como destinos concluírem o trabalho. Neste exemplo, o destino é um grupo de itens, portanto, quando novos dispositivos são adicionados ao grupo, o trabalho contínuo é executado nesses itens novos. aws iot create-job --job-id "example-job-04" --targets "arn:aws:iot:us-west-2:123456789012:thinggroup/DeadBulbs" --document file://example-job.json --description "example continuous job" --target-selection CONTINUOUS Resultado: ``` { "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-04", "jobId": "example-job-04", "description": "example continuous job" } ``` Para obter mais informações, consulte [Criar e gerenciar trabalhos (CLI)](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html) no *Guia do desenvolvedor do AWS IoT*. + Consulte detalhes da API em [CreateJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-job.html) na *Referência de comandos da AWS CLI*. ### `create-keys-and-certificate` O código de exemplo a seguir mostra como usar `create-keys-and-certificate`. **AWS CLI** **Para criar um par de chaves RSA e emitir um certificado X.509** O `create-keys-and-certificate` a seguir cria um par de chaves RSA de 2048 bits e emite um certificado X.509 usando a chave pública emitida. Como essa é a única vez que o AWS IoT fornece a chave privada para esse certificado, certifique-se de mantê-lo em um local seguro. ``` aws iot create-keys-and-certificate \ --certificate-pem-outfile "myTest.cert.pem" \ --public-key-outfile "myTest.public.key" \ --private-key-outfile "myTest.private.key" ``` Resultado: ``` { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/9894ba17925e663f1d29c23af4582b8e3b7619c31f3fbd93adcb51ae54b83dc2", "certificateId": "9894ba17925e663f1d29c23af4582b8e3b7619c31f3fbd93adcb51ae54b83dc2", "certificatePem": " -----BEGIN CERTIFICATE----- MIICiTCCEXAMPLE6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC VVMxCzAJBgNVBAgEXAMPLEAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 b24xFDASBgNVBAsTC0lBTSEXAMPLE2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd BgkqhkiG9w0BCQEWEG5vb25lQGFtYEXAMPLEb20wHhcNMTEwNDI1MjA0NTIxWhcN MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCEXAMPLEJBgNVBAgTAldBMRAwDgYD VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDAEXAMPLEsTC0lBTSBDb25z b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEXAMPLE25lQGFt YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+aEXAMPLE EXAMPLEfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T rDHudUZEXAMPLELG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE Ibb3OhjZnzcvQAEXAMPLEWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 nUhVVxYUntneD9+h8Mg9qEXAMPLEyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb FFBjvSfpJIlJ00zbhNYS5f6GuoEDEXAMPLEBHjJnyp378OD8uTs7fLvjx79LjSTb NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= -----END CERTIFICATE-----\n", "keyPair": { "PublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkEXAMPLEQEFAAOCAQ8AMIIBCgKCAQEAEXAMPLE1nnyJwKSMHw4h\nMMEXAMPLEuuN/dMAS3fyce8DW/4+EXAMPLEyjmoF/YVF/gHr99VEEXAMPLE5VF13\n59VK7cEXAMPLE67GK+y+jikqXOgHh/xJTwo+sGpWEXAMPLEDz18xOd2ka4tCzuWEXAMPLEahJbYkCPUBSU8opVkR7qkEXAMPLE1DR6sx2HocliOOLtu6Fkw91swQWEXAMPLE\GB3ZPrNh0PzQYvjUStZeccyNCx2EXAMPLEvp9mQOUXP6plfgxwKRX2fEXAMPLEDa\nhJLXkX3rHU2xbxJSq7D+XEXAMPLEcw+LyFhI5mgFRl88eGdsAEXAMPLElnI9EesG\nFQIDAQAB\n-----END PUBLIC KEY-----\n", "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nkey omittted for security reasons\n-----END RSA PRIVATE KEY-----\n" } } ``` Para ter mais informações, consulte [Criar e registrar um certificado de dispositivo do AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/device-certs-create.html) no **Guia do desenvolvedor do AWS IoT**. + Para ver detalhes da API, consulte [CreateKeysAndCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-keys-and-certificate.html) na *Referência de comandos da AWS CLI*. ### `create-mitigation-action` O código de exemplo a seguir mostra como usar `create-mitigation-action`. **AWS CLI** **Para criar ações de mitigação** O exemplo `create-mitigation-action` a seguir define uma ação de mitigação chamada `AddThingsToQuarantineGroup1Action` que, quando aplicada, move os itens para o grupo de itens chamado `QuarantineGroup1`. Essa ação substitui grupos dinâmicos de itens. ``` aws iot create-mitigation-action --cli-input-json file::params.json ``` Conteúdo de `params.json`: ``` { "actionName": "AddThingsToQuarantineGroup1Action", "actionParams": { "addThingsToThingGroupParams": { "thingGroupNames": [ "QuarantineGroup1" ], "overrideDynamicGroups": true } }, "roleArn": "arn:aws:iam::123456789012:role/service-role/MoveThingsToQuarantineGroupRole" } ``` Resultado: ``` { "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroup1Action", "actionId": "992e9a63-a899-439a-aa50-4e20c52367e1" } ``` Para obter mais informações, consulte [CreateMitigationAction (Comandos de ação de mitigação)](https://docs.aws.amazon.com/iot/latest/developerguide/iot/latest/developerguide/iot/latest/developerguide/mitigation-action-commands.html.html#dd-api-iot-CreateMitigationAction) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [CreateMitigationAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-mitigation-action.html) na *Referência de comandos da AWS CLI*. ### `create-ota-update` O código de exemplo a seguir mostra como usar `create-ota-update`. **AWS CLI** **Para criar uma atualização OTA para uso com o Amazon FreeRTOS** O exemplo `create-ota-update` a seguir cria um OTAUpdate do AWS IoT em um grupo ou grupo de itens alvo. Isso faz parte de uma atualização over-the-air do Amazon FreeRTOS que possibilita a implantação de novas imagens de firmware em um único dispositivo ou em um grupo de dispositivos. ``` aws iot create-ota-update \ --cli-input-json file://create-ota-update.json ``` Conteúdo de `create-ota-update.json`: ``` { "otaUpdateId": "ota12345", "description": "A critical update needed right away.", "targets": [ "device1", "device2", "device3", "device4" ], "targetSelection": "SNAPSHOT", "awsJobExecutionsRolloutConfig": { "maximumPerMinute": 10 }, "files": [ { "fileName": "firmware.bin", "fileLocation": { "stream": { "streamId": "004", "fileId":123 } }, "codeSigning": { "awsSignerJobId": "48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6" } } ] "roleArn": "arn:aws:iam:123456789012:role/service-role/my_ota_role" } ``` Resultado: ``` { "otaUpdateId": "ota12345", "awsIotJobId": "job54321", "otaUpdateArn": "arn:aws:iot:us-west-2:123456789012:otaupdate/itsaupdate", "awsIotJobArn": "arn:aws:iot:us-west-2:123456789012:job/itsajob", "otaUpdateStatus": "CREATE_IN_PROGRESS" } ``` Para obter mais informações, consulte [CreateOTAUpdate](https://docs.aws.amazon.com/iot/latest/apireference/API_CreateOTAUpdate.html) no *Guia de referência da API do AWS IoT*. + Para ver detalhes da API, consulte [CreateOtaUpdate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-ota-update.html) na *Referência de comandos da AWS CLI*. ### `create-policy-version` O código de exemplo a seguir mostra como usar `create-policy-version`. **AWS CLI** **Para atualizar uma política com uma nova versão** O exemplo `create-policy-version` a seguir atualiza uma definição de política, criando uma nova versão da política. Esse exemplo também torna a nova versão padrão. ``` aws iot create-policy-version \ --policy-name UpdateDeviceCertPolicy \ --policy-document file://policy.json \ --set-as-default ``` Conteúdo de `policy.json`: ``` { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "iot:UpdateCertificate", "Resource": "*" } ] } ``` Resultado: ``` { "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy", "policyDocument": "{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Effect\": \"Allow\", \"Action\": \"iot:UpdateCertificate\", \"Resource\": \"*\" } ] }", "policyVersionId": "2", "isDefaultVersion": true } ``` Para obter mais informações, consulte [Políticas do AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) no *Guia do desenvolvedor do AWS IoT*. + Consulte detalhes da API em [CreatePolicyVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-policy-version.html) na *Referência de comandos da AWS CLI*. ### `create-policy` O código de exemplo a seguir mostra como usar `create-policy`. **AWS CLI** **Para criar uma política do AWS IoT** O exemplo `create-policy` a seguir cria uma política do AWS IoT chamada TemperatureSensorPolicy. O arquivo `policy.json` contém declarações que permitem ações da política do AWS IoT. ``` aws iot create-policy \ --policy-name TemperatureSensorPolicy \ --policy-document file://policy.json ``` Conteúdo de `policy.json`: ``` { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "iot:Publish", "iot:Receive" ], "Resource": [ "arn:aws:iot:us-west-2:123456789012:topic/topic_1", "arn:aws:iot:us-west-2:123456789012:topic/topic_2" ] }, { "Effect": "Allow", "Action": [ "iot:Subscribe" ], "Resource": [ "arn:aws:iot:us-west-2:123456789012:topicfilter/topic_1", "arn:aws:iot:us-west-2:123456789012:topicfilter/topic_2" ] }, { "Effect": "Allow", "Action": [ "iot:Connect" ], "Resource": [ "arn:aws:iot:us-west-2:123456789012:client/basicPubSub" ] } ] } ``` Resultado: ``` { "policyName": "TemperatureSensorPolicy", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TemperatureSensorPolicy", "policyDocument": "{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Effect\": \"Allow\", \"Action\": [ \"iot:Publish\", \"iot:Receive\" ], \"Resource\": [ \"arn:aws:iot:us-west-2:123456789012:topic/topic_1\", \"arn:aws:iot:us-west-2:123456789012:topic/topic_2\" ] }, { \"Effect\": \"Allow\", \"Action\": [ \"iot:Subscribe\" ], \"Resource\": [ \"arn:aws:iot:us-west-2:123456789012:topicfilter/topic_1\", \"arn:aws:iot:us-west-2:123456789012:topicfilter/topic_2\" ] }, { \"Effect\": \"Allow\", \"Action\": [ \"iot:Connect\" ], \"Resource\": [ \"arn:aws:iot:us-west-2:123456789012:client/basicPubSub\" ] } ] }", "policyVersionId": "1" } ``` Para obter mais informações, consulte [Políticas do AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) no *Guia do desenvolvedor do AWS IoT*. + Consulte detalhes da API em [CreatePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-policy.html) na *Referência de comandos da AWS CLI*. ### `create-provisioning-claim` O código de exemplo a seguir mostra como usar `create-provisioning-claim`. **AWS CLI** **Para criar uma declaração de provisionamento** O exemplo `create-provisioning-claim` a seguir cria uma declaração de provisionamento a partir de um modelo de provisionamento. ``` aws iot create-provisioning-claim \ --template-name MyTestProvisioningTemplate ``` Resultado: ``` { "certificateId": "78de02184b2ce80cf8fb709bda59e62b19fb83513590483eb0434589476ab09f", "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDdzCCAl+gAwIBAgIUXSZhEBLztMLZ2fHG 14gV0NymYY0wDQYJKoZIhvcNAQEL\nBQAwfjELMAkGA1UEBhMCVVMxEzARBgNVBAgMCldhc2hpbmd0b24xEDAOBg VBAcM\nB1NlYXR0bGUxGDAWBgNVBAoMD0FtYXpvbi5jb20gSW5jLjEgMB4GA1UECwwXQW1h\nem9uIElvVCBQcm9 2aXNpb25pbmcxDDAKBgNVBAUTAzEuMDAeFw0yMDA3MjgxNjQ0\nMDZaFw0yMDA3MjgxNjUxMDZaMEsxSTBHBgNVB AMMQDFhNDEyM2VkNmIxYjU3MzE3\nZTgzMTJmY2MzN2FiNTdhY2MzYTZkZGVjOGQ5OGY3NzUwMWRlMjc0YjhmYTQ xN2Iw\nggEiMA0GCSqGSIb3EXAMPLEAA4IBDwAwggEKAoIBAQDBhKI94ktKLqTwnj+ayOq1\nTAJt/N6s6IJDZvl rYjkC0E7wzaeY3TprWk03S29vUzVuEOXHXQXZbihgpg2m6fza\nkWm9/wpjzE9ny5+xkPGVH4Wnwz7yK5m8S0agL T96cRBSWnWmonOWdY0GKVzni0CA\n+iyGudgrFKm7Eae/v18oXrf82KtOAGO4xG0KE2WKYHsT1fx3c9xZhlXP/eX Lhv00\n+lGp0WVw9PbhKfrxliKJ5q6sL5nVUaUHq6hlQPYwsATeOvAp3u0ak5zgTyL0fg7Y\nPyKk6VYwLW62r+V YBSForEMOAhkq3LsP/rjxpEKmi2W4lPVS6oFZRKcD+H1Kyil5\nAgMBAAGjIDAeMAwGA1UdEwEB/wQCMAAwDgYDV R0PAQH/BAQDAgeAMA0GCSqGSIb3\nDQEBCwUAA4IBAQAGgix2k6nVqbZFKq97/fZBzLGS0dyz5rT/E41cDIRX+1j EPW41\nw0D+2sXheCZLZZnSkvIiP74IToNeXDrjdcaodeGFVHIElRjhMIq+4ZebPbRLtidF\nRc2hfcTAlqq9Z6v 5Vk6BeM1tu0RqH1wPoVUccLPya8EjNCbnJZUmGdOfrN/Y9pho\n5ikV+HPeZhG/k6dhE2GsQJyKFVHL/uBgKSily 1bRyWU1r6qcpWBNBHjUoD7HgOwD\nnzMh4XRb2FQDsqFalkCSYmeL8IVC49sgPD9Otyp5uteGMTy62usAAUQdq/f ZvrWg\nOkFpwMVnGKVKT7Kg0kKOLzKWOBB2Jm4/gmrJ\n-----END CERTIFICATE-----\n", "keyPair": { "PublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCg KCAQEAwYSiPeJLSi6k8J4/msjq\ntUwCbfzerOiCQ2b5a2I5AtBO8M2nmN06a1pNN0tvb1M1bhDlx10F2W4oYKYN pun8\n2pFpvf8KY8xPZ8ufsZDxlR+Fp8M+8iuZvEtGoC0/enEQUlp1pqJzlnWNBilc54tA\ngPoshrnYKxSpuxGn v79fKF63/NirTgBjuMRtChNlimEXAMPLE3PcWYZVz/3ly4b9\nNPpRqdFlcPT24Sn68ZYiieaurC+Z1VGlB6uoZU D2MLAE3jrwKd7tGpOc4E8i9H4O\n2D8ipOlWMC1utq/lWAUhaKxDDgIZKty7D/648aRCpotluJT1UuqBWUSnA/h9 Ssop\neQIDAQAB\n-----END PUBLIC KEY-----\n", "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwYSiPeJLSi6k8J4/ msjqtUwCbfzerOiCQ2b5a2I5AtBO8M2n\nmN06a1pNN0tvb1M1bhDlx10F2W4oYKYNpun82pFpvf8KY8xPZ8ufsZ DxlR+Fp8M+\n8iuZvEtGoC0/enEQUlp1pqJzlnWNBilc54tAgPoshrnYKxSpuxGnv79fKF63/Nir\nTgBjuMRtCh NlimB7E9X8d3PcWYZVz/3ly4b9NPpRqdFlcPT24Sn68ZYiieaurC+Z\n1VGlB6uoZUD2MLAE3jrwKd7tGpOc4E8i 9H4O2D8ipOlWMC1utq/lWAUhaKxDDgIZ\nKty7D/648aRCpotluJT1UuqBWUSnA/h9SsopeQIDAQABAoIBAEAybN QUtx9T2/nK\ntZT2pA4iugecxI4dz+DmT0XVXs5VJmrx/nBSq6ejXExEpSIMO4RY7LE3ZdJcnd56\nF7tQkkY7yR VzfxHeXFU1krOIPuxWebNOrRoPZr+1RSer+wv2aBC525+88pVuR6tM\nm3pgkrR2ycCj9FdOUoQxdjHBHaM5PDmJ 9aSxCKdg3nReepeGwsR2TQA+m2vVxWk7\nou0+91eTOP+/QfP7P8ZjOIkO2XivlRcVDyN/E4QXPKuIkM/8vS8VK+ E9pATQ0MtB\n2lw8R/YU5AJd6jlEXAMPLEGU2UzRzInNWiLtkPPPqgqXXhxOf+mxByjcMalVJk0L\nhOG2ROUCgY EA+ROcHNHy/XbsP7FihOhEh+6Q2QxQ2ncBUPYbBazrR8Hn+7SCICQK\nVyYfd8Ajfq3e7RsKVL5SlMBp7Slidxak bIn28fKfPn62DaemGCIoyDgLpF+eUxBx\ngzbCiBZga8brfurza43UZjKZLpg3hq721+FeAiXi1Nma4Yr9YWEHEN 8CgYEAxuWt\npzdWWmsiFzfsAw0sy9ySDA/xr5WRWzJyAqUsjsks6rxNzWebpufnYHcmtW7pLdqM\nkboHwN2pXa kmZvrk2nKkEMq5brBYGDXuxDe+V369Bianx8aZFyIsckA7OwXW1w1h\ngRC5rQ4XOgp3+Jmw7eAO8LRYDjaN846+ QbtO2KcCgYAWS0UL51bijQR0ZwI0dz27\nFQVuCAYsp748aurcRTACCj8jbnK/QbqTNlxWsaH7ssBjZKo2D5sAqY BRtASWODab\naHXsDhVm2Jye+ESLoHMaCLoyCkT3ll8yqXIcEDStMO7fO1Ryag164EiJvSIrMfny\nNL/fXVjCSH /udCxdzPt+7QKBgQC+LAD7rxdr4J9538hTqpc4XK9vxRbrMXEH55XH\nHbMa2xONZXpmeTgEQBukyohCVceyRhK9 i0e6irZTjVXghOeoTpC8VXkzcnzouTiQ\neFQQSGfnp7Ioe6UIz23715pKduzSNkMSKrG924ktv7CyDBF1gBQI5g aDoHnddJBJ\nPRTIZQKBgA8MASXtTxQntRwXXzR92U0vAighiuRkB/mx9jQpUcK1qiqHbkAMqgNF\nPFCBYIUbFT iYKKKeJNbyJQvjfsJCkAnaFJ+RnTxk0Q6Wjm20peJ/ii4QiDdnigoE\nvdlc5cFQewWb4/zqAtPdinkPlN94ileI 79XQdc7RlJ0jpgTimL+V\n-----END RSA PRIVATE KEY-----\n" }, "expiration": 1595955066.0 } ``` Para obter mais informações, consulte [Provisionamento por usuário confiável](https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#trusted-user) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [CreateProvisioningClaim](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-provisioning-claim.html) na *Referência de comandos da AWS CLI*. ### `create-provisioning-template-version` O código de exemplo a seguir mostra como usar `create-provisioning-template-version`. **AWS CLI** **Para criar uma versão de um modelo de provisionamento** O exemplo a seguir cria uma versão para o modelo de provisionamento especificado. O corpo da nova versão é fornecido no arquivo `template.json`. ``` aws iot create-provisioning-template-version \ --template-name widget-template \ --template-body file://template.json ``` Conteúdo de `template.json`: ``` { "Parameters" : { "DeviceLocation": { "Type": "String" } }, "Mappings": { "LocationTable": { "Seattle": { "LocationUrl": "https://example.aws" } } }, "Resources" : { "thing" : { "Type" : "AWS::IoT::Thing", "Properties" : { "AttributePayload" : { "version" : "v1", "serialNumber" : "serialNumber" }, "ThingName" : {"Fn::Join":["",["ThingPrefix_",{"Ref":"SerialNumber"}]]}, "ThingTypeName" : {"Fn::Join":["",["ThingTypePrefix_",{"Ref":"SerialNumber"}]]}, "ThingGroups" : ["widgets", "WA"], "BillingGroup": "BillingGroup" }, "OverrideSettings" : { "AttributePayload" : "MERGE", "ThingTypeName" : "REPLACE", "ThingGroups" : "DO_NOTHING" } }, "certificate" : { "Type" : "AWS::IoT::Certificate", "Properties" : { "CertificateId": {"Ref": "AWS::IoT::Certificate::Id"}, "Status" : "Active" } }, "policy" : { "Type" : "AWS::IoT::Policy", "Properties" : { "PolicyDocument" : { "Version":"2012-10-17", "Statement": [{ "Effect": "Allow", "Action":["iot:Publish"], "Resource": ["arn:aws:iot:us-east-1:123456789012:topic/foo/bar"] }] } } } }, "DeviceConfiguration": { "FallbackUrl": "https://www.example.com/test-site", "LocationUrl": { "Fn::FindInMap": ["LocationTable",{"Ref": "DeviceLocation"}, "LocationUrl"]} } } } ``` Resultado: ``` { "templateArn": "arn:aws:iot:us-east-1:123456789012:provisioningtemplate/widget-template", "templateName": "widget-template", "versionId": 2, "isDefaultVersion": false } ``` Para obter mais informações, consulte [AWS IoT Secure Tunneling](https://docs.aws.amazon.com/iot/latest/developerguide/secure-tunneling.html) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [CreateProvisioningTemplateVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-provisioning-template-version.html) na *Referência de comandos da AWS CLI*. ### `create-provisioning-template` O código de exemplo a seguir mostra como usar `create-provisioning-template`. **AWS CLI** **Para criar um modelo de provisionamento** O exemplo `create-provisioning-template` a seguir cria um modelo de provisionamento conforme definido pelo arquivo `template.json`. ``` aws iot create-provisioning-template \ --template-name widget-template \ --description "A provisioning template for widgets" \ --provisioning-role-arn arn:aws:iam::123456789012:role/Provision_role \ --template-body file://template.json ``` Conteúdo de `template.json`: ``` { "Parameters" : { "DeviceLocation": { "Type": "String" } }, "Mappings": { "LocationTable": { "Seattle": { "LocationUrl": "https://example.aws" } } }, "Resources" : { "thing" : { "Type" : "AWS::IoT::Thing", "Properties" : { "AttributePayload" : { "version" : "v1", "serialNumber" : "serialNumber" }, "ThingName" : {"Fn::Join":["",["ThingPrefix_",{"Ref":"SerialNumber"}]]}, "ThingTypeName" : {"Fn::Join":["",["ThingTypePrefix_",{"Ref":"SerialNumber"}]]}, "ThingGroups" : ["widgets", "WA"], "BillingGroup": "BillingGroup" }, "OverrideSettings" : { "AttributePayload" : "MERGE", "ThingTypeName" : "REPLACE", "ThingGroups" : "DO_NOTHING" } }, "certificate" : { "Type" : "AWS::IoT::Certificate", "Properties" : { "CertificateId": {"Ref": "AWS::IoT::Certificate::Id"}, "Status" : "Active" } }, "policy" : { "Type" : "AWS::IoT::Policy", "Properties" : { "PolicyDocument" : { "Version":"2012-10-17", "Statement": [{ "Effect": "Allow", "Action":["iot:Publish"], "Resource": ["arn:aws:iot:us-east-1:504350838278:topic/foo/bar"] }] } } } }, "DeviceConfiguration": { "FallbackUrl": "https://www.example.com/test-site", "LocationUrl": { "Fn::FindInMap": ["LocationTable",{"Ref": "DeviceLocation"}, "LocationUrl"]} } } } ``` Resultado: ``` { "templateArn": "arn:aws:iot:us-east-1:123456789012:provisioningtemplate/widget-template", "templateName": "widget-template", "defaultVersionId": 1 } ``` Para obter mais informações, consulte [AWS IoT Secure Tunneling](https://docs.aws.amazon.com/iot/latest/developerguide/secure-tunneling.html) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [CreateProvisioningTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-provisioning-template.html) na *Referência de comandos da AWS CLI*. ### `create-role-alias` O código de exemplo a seguir mostra como usar `create-role-alias`. **AWS CLI** **Para criar um alias de perfil** O exemplo `create-role-alias` a seguir cria um alias de perfil chamado `LightBulbRole` para o perfil especificado. ``` aws iot create-role-alias \ --role-alias LightBulbRole \ --role-arn arn:aws:iam::123456789012:role/lightbulbrole-001 ``` Resultado: ``` { "roleAlias": "LightBulbRole", "roleAliasArn": "arn:aws:iot:us-west-2:123456789012:rolealias/LightBulbRole" } ``` Para obter mais informações, consulte [CreateRoleAlias](https://docs.aws.amazon.com/iot/latest/apireference/API_CreateRoleAlias.html) no *Guia de referência da API do AWS IoT*. + Para ver detalhes da API, consulte [CreateRoleAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-role-alias.html) na *Referência de comandos da AWS CLI*. ### `create-scheduled-audit` O código de exemplo a seguir mostra como usar `create-scheduled-audit`. **AWS CLI** **Para criar uma auditoria agendada** O exemplo `create-scheduled-audit` a seguir cria uma auditoria agendada que é executada semanalmente, na quarta-feira, para verificar se os certificados da CA ou os certificados do dispositivo estão prestes a expirar. ``` aws iot create-scheduled-audit \ --scheduled-audit-name WednesdayCertCheck \ --frequency WEEKLY \ --day-of-week WED \ --target-check-names CA_CERTIFICATE_EXPIRING_CHECK DEVICE_CERTIFICATE_EXPIRING_CHECK ``` Resultado: ``` { "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/WednesdayCertCheck" } ``` Para obter mais informações, consulte [Comandos de auditoria](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [CreateScheduledAudit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-scheduled-audit.html) na *Referência de comandos da AWS CLI*. ### `create-security-profile` O código de exemplo a seguir mostra como usar `create-security-profile`. **AWS CLI** **Para criar um perfil de segurança** O exemplo `create-security-profile` a seguir cria um perfil de segurança que verifica se a largura de banda celular excede um limite ou se mais de 10 falhas de autorização ocorrem em um período de cinco minutos. ``` aws iot create-security-profile \ --security-profile-name PossibleIssue \ --security-profile-description "Check to see if authorization fails 10 times in 5 minutes or if cellular bandwidth exceeds 128" \ --behaviors "[{\"name\":\"CellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}},{\"name\":\"Authorization\",\"metric\":\"aws:num-authorization-failures\",\"criteria\":{\"comparisonOperator\":\"less-than\",\"value\":{\"count\":10},\"durationSeconds\":300,\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}}]" ``` Resultado: ``` { "securityProfileName": "PossibleIssue", "securityProfileArn": "arn:aws:iot:us-west-2:123456789012:securityprofile/PossibleIssue" } ``` Para obter mais informações, consulte [Comandos do Detect](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [CreateSecurityProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-security-profile.html) na *Referência de comandos da AWS CLI*. ### `create-stream` O código de exemplo a seguir mostra como usar `create-stream`. **AWS CLI** **Para criar um fluxo para fornecer um ou mais arquivos grandes em blocos por meio do MQTT** O exemplo `create-stream` a seguir cria um fluxo para fornecer um ou mais arquivos grandes em blocos por meio do MQTT. Um fluxo transporta bytes de dados em blocos ou blocos empacotados como mensagens MQTT de uma origem, como o S3. Você pode ter um ou mais arquivos associados a um fluxo. ``` aws iot create-stream \ --cli-input-json file://create-stream.json ``` Conteúdo de `create-stream.json`: ``` { "streamId": "stream12345", "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.", "files": [ { "fileId": 123, "s3Location": { "bucket":"codesign-ota-bucket", "key":"48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6" } } ], "roleArn": "arn:aws:iam:123456789012:role/service-role/my_ota_stream_role" } ``` Resultado: ``` { "streamId": "stream12345", "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream12345", "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.", "streamVersion": "1" } ``` Para obter mais informações, consulte [CreateStream](https://docs.aws.amazon.com/iot/latest/apireference/API_CreateStream.html) no *Guia de referência da API do AWS IoT*. + Consulte detalhes da API em [CreateStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-stream.html) na *Referência de comandos da AWS CLI*. ### `create-thing-group` O código de exemplo a seguir mostra como usar `create-thing-group`. **AWS CLI** **Exemplo 1: criar um grupo de itens** O exemplo `create-thing-group` a seguir cria um grupo de itens chamado `LightBulbs` com uma descrição e dois atributos. ``` aws iot create-thing-group \ --thing-group-name LightBulbs \ --thing-group-properties "thingGroupDescription=\"Generic bulb group\", attributePayload={attributes={Manufacturer=AnyCompany,wattage=60}}" ``` Resultado: ``` { "thingGroupName": "LightBulbs", "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs", "thingGroupId": "9198bf9f-1e76-4a88-8e8c-e7140142c331" } ``` **Exemplo 2: criar um grupo de itens que faça parte de um grupo pai** O seguinte `create-thing-group` cria um grupo de itens chamado `HalogenBulbs` que tem um grupo de itens pai chamado `LightBulbs`. ``` aws iot create-thing-group \ --thing-group-name HalogenBulbs \ --parent-group-name LightBulbs ``` Resultado: ``` { "thingGroupName": "HalogenBulbs", "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/HalogenBulbs", "thingGroupId": "f4ec6b84-b42b-499d-9ce1-4dbd4d4f6f6e" } ``` Para obter mais informações, consulte [Grupos de itens](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [CreateThingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-thing-group.html) na *Referência de comandos da AWS CLI*. ### `create-thing-type` O código de exemplo a seguir mostra como usar `create-thing-type`. **AWS CLI** **Como definir um tipo de item** O exemplo `create-thing-type` a seguir define um tipo de item os e atributos associados. ``` aws iot create-thing-type \ --thing-type-name "LightBulb" \ --thing-type-properties "thingTypeDescription=light bulb type, searchableAttributes=wattage,model" ``` Resultado: ``` { "thingTypeName": "LightBulb", "thingTypeArn": "arn:aws:iot:us-west-2:123456789012:thingtype/LightBulb", "thingTypeId": "ce3573b0-0a3c-45a7-ac93-4e0ce14cd190" } ``` Para obter mais informações, consulte [Tipos de itens](https://docs.aws.amazon.com/iot/latest/developerguide/thing-types.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [CreateThingType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-thing-type.html) na *Referência de comandos da AWS CLI*. ### `create-thing` O código de exemplo a seguir mostra como usar `create-thing`. **AWS CLI** **Exemplo 1: criar um registro de item no registro** O exemplo `create-thing` a seguir cria uma entrada para um dispositivo no registro de itens do AWS IoT. ``` aws iot create-thing \ --thing-name SampleIoTThing ``` Resultado: ``` { "thingName": "SampleIoTThing", "thingArn": "arn:aws:iot:us-west-2: 123456789012:thing/SampleIoTThing", "thingId": " EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE " } ``` **Exemplo 2: definir um item associado a um tipo de item** O exemplo `create-thing` a seguir cria um item com o tipo de item e seus atributos especificados. ``` aws iot create-thing \ --thing-name "MyLightBulb" \ --thing-type-name "LightBulb" \ --attribute-payload "{"attributes": {"wattage":"75", "model":"123"}}" ``` Resultado: ``` { "thingName": "MyLightBulb", "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb", "thingId": "40da2e73-c6af-406e-b415-15acae538797" } ``` Para obter mais informações, consulte [Como gerenciar itens com o registro](https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html) e [Tipos de itens](https://docs.aws.amazon.com/iot/latest/developerguide/thing-types.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [CreateThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-thing.html) na *Referência de comandos da AWS CLI*. ### `create-topic-rule-destination` O código de exemplo a seguir mostra como usar `create-topic-rule-destination`. **AWS CLI** **Para criar um destino da regra de tópico** O exemplo `create-topic-rule-destination` a seguir cria um destino de regra de tópico para um endpoint HTTP. ``` aws iot create-topic-rule-destination \ --destination-configuration httpUrlConfiguration={confirmationUrl=https://example.com} ``` Resultado: ``` { "topicRuleDestination": { "arn": "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "status": "IN_PROGRESS", "statusReason": "Awaiting confirmation. Confirmation message sent on 2020-07-09T22:47:54.154Z; no response received from the endpoint.", "httpUrlProperties": { "confirmationUrl": "https://example.com" } } } ``` Para obter mais informações, consulte [Criar um destino de regra de tópico](https://docs.aws.amazon.com/iot/latest/developerguide/rule-destination.html#create-destination) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [CreateTopicRuleDestination](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-topic-rule-destination.html) na *Referência de comandos da AWS CLI*. ### `create-topic-rule` O código de exemplo a seguir mostra como usar `create-topic-rule`. **AWS CLI** **Para criar uma regra que envie um alerta do Amazon SNS** O exemplo `create-topic-rule` a seguir cria uma regra que envia uma mensagem do Amazon SNS quando as leituras do nível de umidade do solo, encontradas em uma sombra do dispositivo, estão baixas. ``` aws iot create-topic-rule \ --rule-name "LowMoistureRule" \ --topic-rule-payload file://plant-rule.json ``` O exemplo exige que o código JSON a seguir seja salvo em um arquivo chamado `plant-rule.json`: ``` { "sql": "SELECT * FROM '$aws/things/MyRPi/shadow/update/accepted' WHERE state.reported.moisture = 'low'\n", "description": "Sends an alert whenever soil moisture level readings are too low.", "ruleDisabled": false, "awsIotSqlVersion": "2016-03-23", "actions": [{ "sns": { "targetArn": "arn:aws:sns:us-west-2:123456789012:MyRPiLowMoistureTopic", "roleArn": "arn:aws:iam::123456789012:role/service-role/MyRPiLowMoistureTopicRole", "messageFormat": "RAW" } }] } ``` Este comando não produz saída. Para obter mais informações, consulte [Criar uma regra do AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/iot-create-rule.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [CreateTopicRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-topic-rule.html) na *Referência de comandos da AWS CLI*. ### `delete-account-audit-configuration` O código de exemplo a seguir mostra como usar `delete-account-audit-configuration`. **AWS CLI** **Para desativar todas as verificações de auditoria da sua conta da AWS** O exemplo `delete-account-audit-configuration` a seguir restaura as configurações padrão do AWS IoT Device Defender para essa conta, desativando todas as verificações de auditoria e limpando os dados de configuração. Ele também exclui todas as auditorias agendadas para essa conta. **Use esse comando com cuidado.** ``` aws iot delete-account-audit-configuration \ --delete-scheduled-audits ``` Este comando não produz saída. Para obter mais informações, consulte [Comandos de auditoria](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DeleteAccountAuditConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-account-audit-configuration.html) na *Referência de comandos da AWS CLI*. ### `delete-audit-suppression` O código de exemplo a seguir mostra como usar `delete-audit-suppression`. **AWS CLI** **Para excluir uma supressão de descoberta de auditoria** O exemplo `delete-audit-suppression` a seguir exclui uma supressão de descoberta de auditoria para DEVICE\$1CERTIFICATE\$1EXPIRING\$1CHECK. ``` aws iot delete-audit-suppression \ --check-name DEVICE_CERTIFICATE_EXPIRING_CHECK \ --resource-identifier deviceCertificateId="c7691e" ``` Este comando não produz saída. Para obter mais informações, consulte [Supressões de descoberta de auditoria](https://docs.aws.amazon.com/iot/latest/developerguide/audit-finding-suppressions.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DeleteAuditSuppression](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-audit-suppression.html) na *Referência de comandos da AWS CLI*. ### `delete-authorizer` O código de exemplo a seguir mostra como usar `delete-authorizer`. **AWS CLI** **Para excluir um autorizador personalizado** O `delete-authorizer` a seguir exclui o autorizador chamado `CustomAuthorizer`. É necessário que um autorizador personalizado esteja no estado `INACTIVE` antes que seja possível excluí-lo. ``` aws iot delete-authorizer \ --authorizer-name CustomAuthorizer ``` Este comando não produz saída. Para obter mais informações, consulte [DeleteAuthorizer](https://docs.aws.amazon.com/iot/latest/apireference/API_DeleteAuthorizer.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DeleteAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-authorizer.html) na *Referência de comandos da AWS CLI*. ### `delete-billing-group` O código de exemplo a seguir mostra como usar `delete-billing-group`. **AWS CLI** **Para excluir um grupo de cobrança** O exemplo `delete-billing-group` a seguir exclui o grupo de cobrança especificado. É possível excluir um grupo de cobrança mesmo que ele contenha um ou mais itens. ``` aws iot delete-billing-group \ --billing-group-name BillingGroupTwo ``` Esse comando não produz nenhuma saída. Para obter mais informações, consulte [Grupos de cobrança](https://docs.aws.amazon.com/iot/latest/developerguide/tagging-iot-billing-groups.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DeleteBillingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-billing-group.html) na *Referência de comandos da AWS CLI*. ### `delete-ca-certificate` O código de exemplo a seguir mostra como usar `delete-ca-certificate`. **AWS CLI** **Para excluir um certificado CA** O exemplo `delete-ca-certificate` a seguir exclui o certificado CA com o ID do certificado especificado. ``` aws iot delete-ca-certificate \ --certificate-id f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467 ``` Este comando não produz saída. Para obter mais informações, consulte [DeleteCACertificate](https://docs.aws.amazon.com/iot/latest/apireference/API_DeleteCACertificate.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [DeleteCaCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-ca-certificate.html) na *Referência de comandos da AWS CLI*. ### `delete-certificate` O código de exemplo a seguir mostra como usar `delete-certificate`. **AWS CLI** **Para excluir um certificado de um dispositivo** O exemplo de `delete-certificate` a seguir exclui o certificado do dispositivo com o ID especificado. ``` aws iot delete-certificate \ --certificate-id c0c57bbc8baaf4631a9a0345c957657f5e710473e3ddbee1428d216d54d53ac9 ``` Este comando não produz saída. Para obter mais informações, consulte [DeleteCertificate](https://docs.aws.amazon.com/iot/latest/apireference/API_DeleteCertificate.html) na *Referência da API do AWS IoT*. + Consulte detalhes da API em [DeleteCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-certificate.html) na *Referência de comandos da AWS CLI*. ### `delete-custom-metric` O código de exemplo a seguir mostra como usar `delete-custom-metric`. **AWS CLI** **Para excluir uma métrica personalizada** O exemplo `delete-custom-metric` a seguir exclui uma métrica personalizada. ``` aws iot delete-custom-metric \ --metric-name batteryPercentage \ --region us-east-1 ``` Resultado: ``` HTTP 200 ``` Para obter mais informações, consulte [Métricas personalizadas](https://docs.aws.amazon.com/iot/latest/developerguide/dd-detect-custom-metrics.html) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [DeleteCustomMetric](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-custom-metric.html) na *Referência de comandos da AWS CLI*. ### `delete-dimension` O código de exemplo a seguir mostra como usar `delete-dimension`. **AWS CLI** **Para excluir uma dimensão** O exemplo `delete-dimension` a seguir exclui uma dimensão chamada `TopicFilterForAuthMessages`. ``` aws iot delete-dimension \ --name TopicFilterForAuthMessages ``` Este comando não produz saída. Para obter mais informações, consulte [Comandos do Detect](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DeleteDimension](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-dimension.html) na *Referência de comandos da AWS CLI*. ### `delete-domain-configuration` O código de exemplo a seguir mostra como usar `delete-domain-configuration`. **AWS CLI** **Para excluir uma configuração de domínio** O exemplo `delete-domain-configuration` a seguir exclui uma configuração de domínio chamada `additionalDataDomain` da sua conta da AWS. ``` aws iot delete-domain-configuration \ --domain-configuration-name "additionalDataDomain" \ --domain-configuration-status "OK" ``` Este comando não produz saída. Para obter mais informações, consulte [Endpoints configuráveis](https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-endpoints-configurable-aws.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DeleteDomainConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-domain-configuration.html) na *Referência de comandos da AWS CLI*. ### `delete-dynamic-thing-group` O código de exemplo a seguir mostra como usar `delete-dynamic-thing-group`. **AWS CLI** **Para excluir um grupo dinâmico de itens** O exemplo `delete-dynamic-thing-group` a seguir exclui o grupo dinâmico de itens especificado. ``` aws iot delete-dynamic-thing-group \ --thing-group-name "RoomTooWarm" ``` Este comando não produz saída. Para obter mais informações, consulte [Grupos dinâmicos de itens](https://docs.aws.amazon.com/iot/latest/developerguide/dynamic-thing-groups.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DeleteDynamicThingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-dynamic-thing-group.html) na *Referência de comandos da AWS CLI*. ### `delete-job-execution` O código de exemplo a seguir mostra como usar `delete-job-execution`. **AWS CLI** **Para excluir uma execução de trabalho** O exemplo `delete-job-execution` a seguir exclui a execução do trabalho especificado em um dispositivo. Use `describe-job-execution` para obter o número da execução. ``` aws iot delete-job-execution --job-id "example-job-02" --thing-name "MyRaspberryPi" --execution-number 1 ``` Este comando não produz saída. Para obter mais informações, consulte [Criar e gerenciar trabalhos (CLI)](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DeleteJobExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-job-execution.html) na *Referência de comandos da AWS CLI*. ### `delete-job` O código de exemplo a seguir mostra como usar `delete-job`. **AWS CLI** **Para excluir um trabalho** O exemplo `delete-job` a seguir exclui o trabalho especificado. Ao especificar a opção `--force`, o trabalho é excluído mesmo que o status seja `IN_PROGRESS`. ``` aws iot delete-job \ --job-id "example-job-04" \ --force ``` Este comando não produz saída. Para obter mais informações, consulte [Criar e gerenciar trabalhos (CLI)](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html) no *Guia do desenvolvedor do AWS IoT*. + Consulte detalhes da API em [DeleteJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-job.html) na *Referência de comandos da AWS CLI*. ### `delete-mitigation-action` O código de exemplo a seguir mostra como usar `delete-mitigation-action`. **AWS CLI** **Para excluir uma ação de mitigação** O exemplo `delete-mitigation-action` a seguir exclui a ação de mitigação especificada. ``` aws iot delete-mitigation-action \ --action-name AddThingsToQuarantineGroup1Action ``` Este comando não produz saída. Para obter mais informações, consulte [DeleteMitigationAction (Comandos de ação de mitigação)](https://docs.aws.amazon.com/iot/latest/developerguide/mitigation-action-commands.html#dd-api-iot-DeleteMitigationAction) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DeleteMitigationAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-mitigation-action.html) na *Referência de comandos da AWS CLI*. ### `delete-ota-update` O código de exemplo a seguir mostra como usar `delete-ota-update`. **AWS CLI** **Para excluir uma atualização OTA** O exemplo `delete-ota-update` a seguir exclui a atualização OTA especificada. ``` aws iot delete-ota-update \ --ota-update-id ota12345 \ --delete-stream \ --force-delete-aws-job ``` Este comando não produz saída. Para obter mais informações, consulte [DeleteOTAUpdate](https://docs.aws.amazon.com/iot/latest/apireference/API_DeleteOTAUpdate.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [DeleteOtaUpdate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-ota-update.html) na *Referência de comandos da AWS CLI*. ### `delete-policy-version` O código de exemplo a seguir mostra como usar `delete-policy-version`. **AWS CLI** **Para excluir uma versão de uma política** O exemplo `delete-policy-version` a seguir exclui a versão 2 da política especificada da sua conta da AWS. ``` aws iot delete-policy-version \ --policy-name UpdateDeviceCertPolicy \ --policy-version-id 2 ``` Este comando não produz saída. Para obter mais informações, consulte [Políticas do AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) no *Guia do desenvolvedor do AWS IoT*. + Consulte detalhes da API em [DeletePolicyVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-policy-version.html) na *Referência de comandos da AWS CLI*. ### `delete-policy` O código de exemplo a seguir mostra como usar `delete-policy`. **AWS CLI** **Como excluir uma política** O exemplo `delete-policy` a seguir exclui a política especificada da sua conta da AWS. ``` aws iot delete-policy --policy-name UpdateDeviceCertPolicy ``` Este comando não produz saída. Para obter mais informações, consulte [Políticas do AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) no *Guia do desenvolvedor do AWS IoT*. + Consulte detalhes da API em [DeletePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-policy.html) na *Referência de comandos da AWS CLI*. ### `delete-provisioning-template-version` O código de exemplo a seguir mostra como usar `delete-provisioning-template-version`. **AWS CLI** **Para excluir uma versão do modelo de provisionamento** O exemplo `delete-provisioning-template-version` a seguir excluir a versão 2 do modelo de provisionamento especificado. ``` aws iot delete-provisioning-template-version \ --version-id 2 \ --template-name "widget-template" ``` Este comando não produz saída. Para obter mais informações, consulte [AWS IoT Secure Tunneling](https://docs.aws.amazon.com/iot/latest/developerguide/secure-tunneling.html) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [DeleteProvisioningTemplateVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-provisioning-template-version.html) na *Referência de comandos da AWS CLI*. ### `delete-provisioning-template` O código de exemplo a seguir mostra como usar `delete-provisioning-template`. **AWS CLI** **Para excluir um modelo de provisionamento** O exemplo `delete-provisioning-template` a seguir excluir o modelo de provisionamento especificado. ``` aws iot delete-provisioning-template \ --template-name widget-template ``` Este comando não produz saída. Para obter mais informações, consulte [AWS IoT Secure Tunneling](https://docs.aws.amazon.com/iot/latest/developerguide/secure-tunneling.html) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [DeleteProvisioningTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-provisioning-template.html) na *Referência de comandos da AWS CLI*. ### `delete-registration-code` O código de exemplo a seguir mostra como usar `delete-registration-code`. **AWS CLI** **Para excluir seu código de registro** O exemplo `delete-registration-code` a seguir exclui um código de registro específico para a conta do AWS IoT. ``` aws iot delete-registration-code ``` Este comando não produz saída. Para obter mais informações, consulte [Usar seu próprio certificado](https://docs.aws.amazon.com/iot/latest/developerguide/device-certs-your-own.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DeleteRegistrationCode](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-registration-code.html) na *Referência de comandos da AWS CLI*. ### `delete-role-alias` O código de exemplo a seguir mostra como usar `delete-role-alias`. **AWS CLI** **Para excluir um alias de perfil do AWS IoT** O exemplo `delete-role-alias` a seguir exclui um alias de perfil do AWS IoT chamado `LightBulbRole`. ``` aws iot delete-role-alias \ --role-alias LightBulbRole ``` Este comando não produz saída. Para obter mais informações, consulte [Autorizar de chamadas diretas para serviços AWS](https://docs.aws.amazon.com/iot/latest/developerguide/authorizing-direct-aws.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DeleteRoleAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-role-alias.html) na *Referência de comandos da AWS CLI*. ### `delete-scheduled-audit` O código de exemplo a seguir mostra como usar `delete-scheduled-audit`. **AWS CLI** **Para excluir uma auditoria agendada** O exemplo `delete-scheduled-audit` a seguir exclui a auditoria agendada do AWS IoT Device Defender chamada `AWSIoTDeviceDefenderDailyAudit`. ``` aws iot delete-scheduled-audit \ --scheduled-audit-name AWSIoTDeviceDefenderDailyAudit ``` Este comando não produz saída. Para obter mais informações, consulte [Comandos de auditoria](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DeleteScheduledAudit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-scheduled-audit.html) na *Referência de comandos da AWS CLI*. ### `delete-security-profile` O código de exemplo a seguir mostra como usar `delete-security-profile`. **AWS CLI** **Para excluir um perfil de segurança** O exemplo `delete-security-profile` a seguir exclui um perfil de segurança chamado `PossibleIssue`. ``` aws iot delete-security-profile \ --security-profile-name PossibleIssue ``` Este comando não produz saída. Para obter mais informações, consulte [Comandos do Detect](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DeleteSecurityProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-security-profile.html) na *Referência de comandos da AWS CLI*. ### `delete-stream` O código de exemplo a seguir mostra como usar `delete-stream`. **AWS CLI** **Para excluir um fluxo** O exemplo `delete-stream` a seguir exclui o fluxo especificado. ``` aws iot delete-stream \ --stream-id stream12345 ``` Este comando não produz saída. Para obter mais informações, consulte [DeleteStream](https://docs.aws.amazon.com/iot/latest/apireference/API_DeleteStream.html) na *Referência da API do AWS IoT*. + Consulte detalhes da API em [DeleteStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-stream.html) na *Referência de comandos da AWS CLI*. ### `delete-thing-group` O código de exemplo a seguir mostra como usar `delete-thing-group`. **AWS CLI** **Para excluir um grupo de itens** O exemplo `delete-thing-group` a seguir exclui o grupo de itens especificado. Não é possível excluir um grupo de itens se ele contiver grupos-filho de itens. ``` aws iot delete-thing-group \ --thing-group-name DefectiveBulbs ``` Este comando não produz saída. Para obter mais informações, consulte [Grupos de itens](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DeleteThingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-thing-group.html) na *Referência de comandos da AWS CLI*. ### `delete-thing-type` O código de exemplo a seguir mostra como usar `delete-thing-type`. **AWS CLI** **Exemplo 1: excluir um tipo de item** O exemplo `delete-thing-type` a seguir exclui um tipo de item obsoleto. ``` aws iot delete-thing-type \ --thing-type-name "obsoleteThingType" ``` Este comando não produz saída. Para obter mais informações, consulte [Tipos de itens](https://docs.aws.amazon.com/iot/latest/developerguide/thing-types.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DeleteThingType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-thing-type.html) na *Referência de comandos da AWS CLI*. ### `delete-thing` O código de exemplo a seguir mostra como usar `delete-thing`. **AWS CLI** **Como exibir informações detalhadas sobre um item** O exemplo `delete-thing` a seguir exclui um item do registro do AWS IoT da sua conta da AWS. aws iot delete-thing --thing-name "FourthBulb" Este comando não produz saída. Para acessar mais informações, consulte [Como gerenciar objetos com o registro](https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DeleteThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-thing.html) na *Referência de comandos da AWS CLI*. ### `delete-topic-rule-destination` O código de exemplo a seguir mostra como usar `delete-topic-rule-destination`. **AWS CLI** **Para excluir um destino de regra de tópico** O exemplo `delete-topic-rule-destination` a seguir exclui o destino de regra de tópico especificado. ``` aws iot delete-topic-rule-destination \ --arn "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir um destino de regra de tópico](https://docs.aws.amazon.com/iot/latest/developerguide/rule-destination.html#delete-destination) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DeleteTopicRuleDestination](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-topic-rule-destination.html) na *Referência de comandos da AWS CLI*. ### `delete-topic-rule` O código de exemplo a seguir mostra como usar `delete-topic-rule`. **AWS CLI** **Para excluir uma regra** O exemplo de `delete-topic-rule` a seguir exclui a regra especificada. ``` aws iot delete-topic-rule \ --rule-name "LowMoistureRule" ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir uma regra](https://docs.aws.amazon.com/iot/latest/developerguide/iot-delete-rule.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DeleteTopicRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-topic-rule.html) na *Referência de comandos da AWS CLI*. ### `delete-v2-logging-level` O código de exemplo a seguir mostra como usar `delete-v2-logging-level`. **AWS CLI** **Para excluir o nível de log de um grupo de itens** O exemplo `delete-v2-logging-level` a seguir exclui o nível de log do grupo de itens especificado. ``` aws iot delete-v2-logging-level \ --target-type THING_GROUP \ --target-name LightBulbs ``` Este comando não produz saída. + Para ver detalhes da API, consulte [DeleteV2LoggingLevel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-v2-logging-level.html) na *Referência de comandos da AWS CLI*. ### `deprecate-thing-type` O código de exemplo a seguir mostra como usar `deprecate-thing-type`. **AWS CLI** **Exemplo 1: descontinuar um tipo de item** O exemplo `deprecate-thing-type` a seguir descontinua um tipo de item para que os usuários não possam associar novas itens a ele. ``` aws iot deprecate-thing-type \ --thing-type-name "obsoleteThingType" ``` Este comando não produz saída. **Exemplo 2: reverter a descontinuação de um tipo de item** O exemplo `deprecate-thing-type` a seguir reverte a descontinuação de uso de um tipo de item, o que possibilita que os usuários voltem a associar novos itens a ele. ``` aws iot deprecate-thing-type \ --thing-type-name "obsoleteThingType" \ --undo-deprecate ``` Este comando não produz saída. Para obter mais informações, consulte [Tipos de itens](https://docs.aws.amazon.com/iot/latest/developerguide/thing-types.html) no *Guia do desenvolvedor do AWS IoT*. + *Para ver detalhes da API, consulte [DeprecateThingType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/deprecate-thing-type.html) na Referência de comandos da AWS CLI*. ### `describe-account-audit-configuration` O código de exemplo a seguir mostra como usar `describe-account-audit-configuration`. **AWS CLI** **Como visualizar as configurações de auditoria atuais** O exemplo `describe-account-audit-configuration` a seguir lista as configurações atuais da sua configuração de auditoria do AWS IoT Device Defender. ``` aws iot describe-account-audit-configuration ``` Resultado: ``` { "roleArn": "arn:aws:iam::123456789012:role/service-role/AWSIoTDeviceDefenderAudit_1551201085996", "auditNotificationTargetConfigurations": { "SNS": { "targetArn": "arn:aws:sns:us-west-2:123456789012:ddaudits", "roleArn": "arn:aws:iam::123456789012:role/service-role/AWSIoTDeviceDefenderAudit", "enabled": true } }, "auditCheckConfigurations": { "AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK": { "enabled": true }, "CA_CERTIFICATE_EXPIRING_CHECK": { "enabled": true }, "CONFLICTING_CLIENT_IDS_CHECK": { "enabled": true }, "DEVICE_CERTIFICATE_EXPIRING_CHECK": { "enabled": true }, "DEVICE_CERTIFICATE_SHARED_CHECK": { "enabled": true }, "IOT_POLICY_OVERLY_PERMISSIVE_CHECK": { "enabled": true }, "LOGGING_DISABLED_CHECK": { "enabled": true }, "REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK": { "enabled": true }, "REVOKED_DEVICE_CERTIFICATE_STILL_ACTIVE_CHECK": { "enabled": true }, "UNAUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK": { "enabled": true } } } ``` Para obter mais informações, consulte [Comandos de auditoria](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DescribeAccountAuditConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-account-audit-configuration.html) na *Referência de comandos da AWS CLI*. ### `describe-audit-finding` O código de exemplo a seguir mostra como usar `describe-audit-finding`. **AWS CLI** **Para listar detalhes de uma descoberta de auditoria** O exemplo `describe-audit-finding` a seguir lista os detalhes da descoberta de auditoria especificada do AWS IoT Device Defender. Uma auditoria pode produzir várias descobertas. Use o comando `list-audit-findings` para obter uma lista das descobertas de uma auditoria para obter o `findingId`. ``` aws iot describe-audit-finding \ --finding-id "ef4826b8-e55a-44b9-b460-5c485355371b" ``` Resultado: ``` { "finding": { "findingId": "ef4826b8-e55a-44b9-b460-5c485355371b", "taskId": "873ed69c74a9ec8fa9b8e88e9abc4661", "checkName": "IOT_POLICY_OVERLY_PERMISSIVE_CHECK", "taskStartTime": 1576012045.745, "findingTime": 1576012046.168, "severity": "CRITICAL", "nonCompliantResource": { "resourceType": "IOT_POLICY", "resourceIdentifier": { "policyVersionIdentifier": { "policyName": "smp-ggrass-group_Core-policy", "policyVersionId": "1" } } }, "reasonForNonCompliance": "Policy allows broad access to IoT data plane actions: [iot:Subscribe, iot:Connect, iot:GetThingShadow, iot:DeleteThingShadow, iot:UpdateThingShadow, iot:Publish].", "reasonForNonComplianceCode": "ALLOWS_BROAD_ACCESS_TO_IOT_DATA_PLANE_ACTIONS" } } ``` Para obter mais informações, consulte [Verificar resultados de auditorias (Comandos de auditoria)](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html#device-defender-AuditCommandsFindings) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DescribeAuditFinding](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-audit-finding.html) na *Referência de comandos da AWS CLI*. ### `describe-audit-mitigation-actions-task` O código de exemplo a seguir mostra como usar `describe-audit-mitigation-actions-task`. **AWS CLI** **Como exibir os detalhes de uma tarefa de ações de mitigação de auditoria** O exemplo `describe-audit-mitigation-actions-task` a seguir exibe os detalhes da tarefa especificada, na qual a `ResetPolicyVersionAction` foi aplicada a uma descoberta. Os resultados incluem quando a tarefa começou e terminou, quantas descobertas foram direcionadas (e seu resultado) e a definição da ação que é aplicada como parte dessa tarefa. ``` aws iot describe-audit-mitigation-actions-task \ --task-id ResetPolicyTask01 ``` Resultado: ``` { "taskStatus": "COMPLETED", "startTime": "2019-12-10T15:13:19.457000-08:00", "endTime": "2019-12-10T15:13:19.947000-08:00", "taskStatistics": { "IOT_POLICY_OVERLY_PERMISSIVE_CHECK": { "totalFindingsCount": 1, "failedFindingsCount": 0, "succeededFindingsCount": 1, "skippedFindingsCount": 0, "canceledFindingsCount": 0 } }, "target": { "findingIds": [ "ef4826b8-e55a-44b9-b460-5c485355371b" ] }, "auditCheckToActionsMapping": { "IOT_POLICY_OVERLY_PERMISSIVE_CHECK": [ "ResetPolicyVersionAction" ] }, "actionsDefinition": [ { "name": "ResetPolicyVersionAction", "id": "1ea0b415-bef1-4a01-bd13-72fb63c59afb", "roleArn": "arn:aws:iam::123456789012:role/service-role/ReplacePolicyVersionRole", "actionParams": { "replaceDefaultPolicyVersionParams": { "templateName": "BLANK_POLICY" } } } ] } ``` Para obter mais informações, consulte [DescribeAuditMitigationActionsTask (Comandos de ação de mitigação)](https://docs.aws.amazon.com/iot/latest/developerguide/mitigation-action-commands.html#dd-api-iot-DescribeAuditMitigationActionsTask) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DescribeAuditMitigationActionsTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-audit-mitigation-actions-task.html) na *Referência de comandos da AWS CLI*. ### `describe-audit-suppression` O código de exemplo a seguir mostra como usar `describe-audit-suppression`. **AWS CLI** **Para excluir uma supressão de descoberta de auditoria** O exemplo `describe-audit-suppression` a seguir lista detalhes sobre a supressão de uma descoberta de auditoria. ``` aws iot describe-audit-task \ --task-id "787ed873b69cb4d6cdbae6ddd06996c5" ``` Resultado: ``` { "taskStatus": "COMPLETED", "taskType": "SCHEDULED_AUDIT_TASK", "taskStartTime": 1596168096.157, "taskStatistics": { "totalChecks": 1, "inProgressChecks": 0, "waitingForDataCollectionChecks": 0, "compliantChecks": 0, "nonCompliantChecks": 1, "failedChecks": 0, "canceledChecks": 0 }, "scheduledAuditName": "AWSIoTDeviceDefenderDailyAudit", "auditDetails": { "DEVICE_CERTIFICATE_EXPIRING_CHECK": { "checkRunStatus": "COMPLETED_NON_COMPLIANT", "checkCompliant": false, "totalResourcesCount": 195, "nonCompliantResourcesCount": 2 } } } ``` Para obter mais informações, consulte [Supressões de descoberta de auditoria](https://docs.aws.amazon.com/iot/latest/developerguide/audit-finding-suppressions.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DescribeAuditSuppression](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-audit-suppression.html) na *Referência de comandos da AWS CLI*. ### `describe-audit-task` O código de exemplo a seguir mostra como usar `describe-audit-task`. **AWS CLI** **Para obter informações sobre uma instância de auditoria** O exemplo `describe-audit-task` a seguir obtém informações sobre uma instância de uma auditoria do AWS IoT Device Defender. Se a auditoria for concluída, as estatísticas resumidas da execução serão incluídas nos resultados. ``` aws iot describe-audit-task \ --task-id a3aea009955e501a31b764abe1bebd3d ``` Resultado: ``` { "taskStatus": "COMPLETED", "taskType": "ON_DEMAND_AUDIT_TASK", "taskStartTime": 1560356923.434, "taskStatistics": { "totalChecks": 3, "inProgressChecks": 0, "waitingForDataCollectionChecks": 0, "compliantChecks": 3, "nonCompliantChecks": 0, "failedChecks": 0, "canceledChecks": 0 }, "auditDetails": { "CA_CERTIFICATE_EXPIRING_CHECK": { "checkRunStatus": "COMPLETED_COMPLIANT", "checkCompliant": true, "totalResourcesCount": 0, "nonCompliantResourcesCount": 0 }, "DEVICE_CERTIFICATE_EXPIRING_CHECK": { "checkRunStatus": "COMPLETED_COMPLIANT", "checkCompliant": true, "totalResourcesCount": 6, "nonCompliantResourcesCount": 0 }, "REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK": { "checkRunStatus": "COMPLETED_COMPLIANT", "checkCompliant": true, "totalResourcesCount": 0, "nonCompliantResourcesCount": 0 } } } ``` Para obter mais informações, consulte [Comandos de auditoria](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DescribeAuditTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-audit-task.html) na *Referência de comandos da AWS CLI*. ### `describe-authorizer` O código de exemplo a seguir mostra como usar `describe-authorizer`. **AWS CLI** **Para obter informações sobre um autorizador personalizado** O exemplo `describe-authorizer` a seguir exibe os detalhes do autorizador personalizado especificado. ``` aws iot describe-authorizer \ --authorizer-name CustomAuthorizer ``` Resultado: ``` { "authorizerDescription": { "authorizerName": "CustomAuthorizer", "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer", "authorizerFunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:CustomAuthorizerFunction", "tokenKeyName": "MyAuthToken", "tokenSigningPublicKeys": { "FIRST_KEY": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1uJOB4lQPgG/lM6ZfIwo\nZ+7ENxAio9q6QD4FFqjGZsvjtYwjoe1RKK0U8Eq9xb5O3kRSmyIwTzwzm/f4Gf0Y\nZUloJ+t3PUUwHrmbYTAgTrCUgRFygjfgVwGCPs5ZAX4Eyqt5cr+AIHIiUDbxSa7p\nzwOBKPeic0asNJpqT8PkBbRaKyleJh5oo81NDHHmVtbBm5A5YiJjqYXLaVAowKzZ\n+GqsNvAQ9Jy1wI2VrEa1OfL8flDB/BJLm7zjpfPOHDJQgID0XnZwAlNnZcOhCwIx\n50g2LW2Oy9R/dmqtDmJiVP97Z4GykxPvwlYHrUXY0iW1R3AR/Ac1NhCTGZMwVDB1\nlQIDAQAB\n-----END PUBLIC KEY-----" }, "status": "ACTIVE", "creationDate": 1571245658.069, "lastModifiedDate": 1571245658.069 } } ``` Para obter mais informações, consulte [DescribeAuthorizer](https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeAuthorizer.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [DescribeAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-authorizer.html) na *Referência de comandos da AWS CLI*. ### `describe-billing-group` O código de exemplo a seguir mostra como usar `describe-billing-group`. **AWS CLI** **Para obter informações sobre um grupo de cobrança** O exemplo `describe-billing-group` a seguir obtém informações sobre o grupo de cobrança especificado. ``` aws iot describe-billing-group --billing-group-name GroupOne ``` Resultado: ``` { "billingGroupName": "GroupOne", "billingGroupId": "103de383-114b-4f51-8266-18f209ef5562", "billingGroupArn": "arn:aws:iot:us-west-2:123456789012:billinggroup/GroupOne", "version": 1, "billingGroupProperties": {}, "billingGroupMetadata": { "creationDate": 1560199355.378 } } ``` Para obter mais informações, consulte [Grupos de cobrança](https://docs.aws.amazon.com/iot/latest/developerguide/tagging-iot-billing-groups.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DescribeBillingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-billing-group.html) na *Referência de comandos da AWS CLI*. ### `describe-ca-certificate` O código de exemplo a seguir mostra como usar `describe-ca-certificate`. **AWS CLI** **Para obter detalhes sobre um certificado CA** O exemplo `describe-ca-certificate` a seguir exibe os detalhes do certificado CA especificado. ``` aws iot describe-ca-certificate \ --certificate-id f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467 ``` Resultado: ``` { "certificateDescription": { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cacert/f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467", "certificateId": "f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467", "status": "INACTIVE", "certificatePem": "-----BEGIN CERTIFICATE-----\nMIICzzCCAbegEXAMPLEJANVEPWXl8taPMA0GCSqGSIb3DQEBBQUAMB4xCzAJBgNV\nBAYTAlVTMQ8wDQYDVQQKDAZBbWF6b24wHhcNMTkwOTI0MjEzMTE1WhcNMjkwOTIx\nMjEzMTE1WjAeMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGQW1hem9uMIIBIjANBgkq\nhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzd3R3ioalCS0MhFWfBrVGR036EK07UAf\nVdz9EXAMPLE1VczICbADnATK522kEIB51/18VzlFtAhQL5V5eybXKnB7QebNer5m\n4Yibx7shR5oqNzFsrXWxuugN5+w5gEfqNMawOjhF4LsculKG49yuqjcDU19/13ua\n3B2gxs1Pe7TiWWvUskzxnbO1F2WCshbEJvqY8fIWtGYCjTeJAgQ9hvZx/69XhKen\nwV9LJwOQxrsUS0Ty8IHwbB8fRy72VM3u7fJoaU+nO4jD5cqaoEPtzoeFUEXAMPLE\nyVAJpqHwgbYbcUfn7V+AB6yh1+0Fa1rEQGuZDPGyJslxwr5vh8nRewIDAQABoxAw\nDjAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4IBAQA+3a5CV3IJgOnd0AgI\nBgVMtmYzTvqAngx26aG9/spvCjXckh2SBF+EcBlCFwH1yakwjJL1dR4yarnrfxgI\nEqP4AOYVimAVoQ5FBwnloHe16+3qtDiblU9DeXBUCtS55EcfrEXAMPLEYtXdqU5C\nU9ia4KAjV0dxW1+EFYMwX5eGeb0gDTNHBylV6B/fOSZiQAwDYp4x3B+gAP+a/bWB\nu1umOqtBdWe6L6/83L+JhaTByqV25iVJ4c/UZUnG8926wUlDM9zQvEXuEVvzZ7+m\n4PSNqst/nVOvnLpoG4e0WgcJgANuB33CSWtjWSuYsbhmqQRknGhREXAMPLEZT4fm\nfo0e\n-----END CERTIFICATE-----\n", "ownedBy": "123456789012", "creationDate": 1569365372.053, "autoRegistrationStatus": "DISABLE", "lastModifiedDate": 1569365372.053, "customerVersion": 1, "generationId": "c5c2eb95-140b-4f49-9393-6aaac85b2a90", "validity": { "notBefore": 1569360675.0, "notAfter": 1884720675.0 } } } ``` Para obter mais informações, consulte [DescribeCACertificate](https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeCACertificate.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [DescribeCaCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-ca-certificate.html) na *Referência de comandos da AWS CLI*. ### `describe-certificate` O código de exemplo a seguir mostra como usar `describe-certificate`. **AWS CLI** **Para obter informações sobre um certificado** O exemplo `describe-certificate` a seguir exibe os detalhes do certificado especificado. ``` aws iot describe-certificate \ --certificate-id "4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e" ``` Resultado: ``` { "certificateDescription": { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e", "certificateId": "4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e", "status": "ACTIVE", "certificatePem": "-----BEGIN CERTIFICATE----- MIICiTEXAMPLEQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC VVMxCzAJBgNVBEXAMPLEMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 b24xFDASBgNVBAsTC0lBTSBDEXAMPLElMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5EXAMPLEcNMTEwNDI1MjA0NTIxWhcN MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNEXAMPLEdBMRAwDgYD VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBEXAMPLEz b2xEXAMPLEYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt YXpvbi5jb20wgZ8EXAMPLEZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ 21uUSfwfEvySWtC2XADZ4nB+BLYEXAMPLEpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7EXAMPLEGBzZswY6786m86gpE Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFEXAMPLEAtCu4 nUhVVxYUnEXAMPLE8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb FFBjvSfpJIlJ00zbhNYS5f6GEXAMPLEl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= -----END CERTIFICATE-----", "ownedBy": "123456789012", "creationDate": 1541022751.983, "lastModifiedDate": 1541022751.983, "customerVersion": 1, "transferData": {}, "generationId": "6974fbed-2e61-4114-bc5e-4204cc79b045", "validity": { "notBefore": 1541022631.0, "notAfter": 2524607999.0 } } } ``` Para obter mais informações, consulte [DescribeCertificate](https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeCertificate.html) na *Referência da API do AWS IoT*. + Consulte detalhes da API em [DescribeCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-certificate.html) na *Referência de comandos da AWS CLI*. ### `describe-custom-metric` O código de exemplo a seguir mostra como usar `describe-custom-metric`. **AWS CLI** **Para obter informações sobre uma métrica personalizada do Device Defender** O exemplo `describe-custom-metric` a seguir obtém informações sobre uma métrica personalizada chamada `myCustomMetric`. ``` aws iot describe-custom-metric \ --metric-name myCustomMetric ``` Resultado: ``` { "metricName": "myCustomMetric", "metricArn": "arn:aws:iot:us-east-1:1234564789012:custommetric/myCustomMetric", "metricType": "number", "displayName": "My custom metric", "creationDate": 2020-11-17T23:02:12.879000-09:00, "lastModifiedDate": 2020-11-17T23:02:12.879000-09:00 } ``` Para obter mais informações, consulte [Métricas personalizadas](https://docs.aws.amazon.com/iot/latest/developerguide/dd-detect-custom-metrics.html) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [DescribeCustomMetric](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-custom-metric.html) na *Referência de comandos da AWS CLI*. ### `describe-default-authorizer` O código de exemplo a seguir mostra como usar `describe-default-authorizer`. **AWS CLI** **Para obter informações sobre o autorizador personalizado padrão** O exemplo `describe-default-authorizer` a seguir exibe os detalhes do autorizador personalizado padrão. ``` aws iot describe-default-authorizer ``` Resultado: ``` { "authorizerName": "CustomAuthorizer", "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer" } ``` Para obter mais informações, consulte [DescribeDefaultAuthorizer](https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeDefautAuthorizer.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [DescribeDefaultAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-default-authorizer.html) na *Referência de comandos da AWS CLI*. ### `describe-dimension` O código de exemplo a seguir mostra como usar `describe-dimension`. **AWS CLI** **Para obter informações sobre uma dimensão** O exemplo `describe-dimension` a seguir obtém informações sobre uma dimensão chamada `TopicFilterForAuthMessages`. ``` aws iot describe-dimension \ --name TopicFilterForAuthMessages ``` Resultado: ``` { "name": "TopicFilterForAuthMessages", "arn": "arn:aws:iot:eu-west-2:123456789012:dimension/TopicFilterForAuthMessages", "type": "TOPIC_FILTER", "stringValues": [ "device/+/auth" ], "creationDate": 1578620223.255, "lastModifiedDate": 1578620223.255 } ``` Para obter mais informações, consulte [Comandos do Detect](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DescribeDimension](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-dimension.html) na *Referência de comandos da AWS CLI*. ### `describe-domain-configuration` O código de exemplo a seguir mostra como usar `describe-domain-configuration`. **AWS CLI** **Para descrever uma configuração de domínio** O exemplo `describe-domain-configuration` a seguir descreve os detalhes sobre a configuração de domínio especificada. ``` aws iot describe-domain-configuration \ --domain-configuration-name "additionalDataDomain" ``` Resultado: ``` { "domainConfigurationName": "additionalDataDomain", "domainConfigurationArn": "arn:aws:iot:us-east-1:758EXAMPLE143:domainconfiguration/additionalDataDomain/norpw", "domainName": "d055exampleed74y71zfd-ats.beta.us-east-1.iot.amazonaws.com", "serverCertificates": [], "domainConfigurationStatus": "ENABLED", "serviceType": "DATA", "domainType": "AWS_MANAGED", "lastStatusChangeDate": 1601923783.774 } ``` Para obter mais informações, consulte [Endpoints configuráveis](https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-endpoints-configurable-aws.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DescribeDomainConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-domain-configuration.html) na *Referência de comandos da AWS CLI*. ### `describe-endpoint` O código de exemplo a seguir mostra como usar `describe-endpoint`. **AWS CLI** **Exemplo 1: como obter o endpoint atual da AWS** O exemplo de `describe-endpoint` a seguir recupera o endpoint padrão da AWS ao qual todos os comandos são aplicados. ``` aws iot describe-endpoint ``` Resultado: ``` { "endpointAddress": "abc123defghijk.iot.us-west-2.amazonaws.com" } ``` Para obter mais informações, consulte [DescribeEndpoint](https://docs.aws.amazon.com/iot/latest/developerguide/iot-commands.html#api-iot-DescribeEndpoint) no *Guia do desenvolvedor do AWS IoT*. **Exemplo 2: como obter o endpoint do ATS** O exemplo de `describe-endpoint` a seguir recupera o endpoint do Amazon Trust Services (ATS). ``` aws iot describe-endpoint \ --endpoint-type iot:Data-ATS ``` Resultado: ``` { "endpointAddress": "abc123defghijk-ats.iot.us-west-2.amazonaws.com" } ``` Para obter mais informações, consulte [X.509 Certificates and AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/managing-device-certs.html) no *Guia do desenvolvedor do AWS IoT*. + Consulte detalhes da API em [DescribeEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-endpoint.html) na *Referência de comandos da AWS CLI*. ### `describe-event-configurations` O código de exemplo a seguir mostra como usar `describe-event-configurations`. **AWS CLI** **Como mostrar quais tipos de eventos são publicados** O exemplo `describe-event-configurations` a seguir lista a configuração que controla quais eventos são gerados quando um item é adicionado, atualizado ou excluído. ``` aws iot describe-event-configurations ``` Resultado: ``` { "eventConfigurations": { "CA_CERTIFICATE": { "Enabled": false }, "CERTIFICATE": { "Enabled": false }, "JOB": { "Enabled": false }, "JOB_EXECUTION": { "Enabled": false }, "POLICY": { "Enabled": false }, "THING": { "Enabled": false }, "THING_GROUP": { "Enabled": false }, "THING_GROUP_HIERARCHY": { "Enabled": false }, "THING_GROUP_MEMBERSHIP": { "Enabled": false }, "THING_TYPE": { "Enabled": false }, "THING_TYPE_ASSOCIATION": { "Enabled": false } } } ``` Para obter mais informações, consulte [Mensagens de evento](https://docs.aws.amazon.com/iot/latest/developerguide/iot-events.html) no * Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DescribeEventConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-event-configurations.html) na *Referência de comandos da AWS CLI*. ### `describe-index` O código de exemplo a seguir mostra como usar `describe-index`. **AWS CLI** **Para recuperar o status atual do índice do item** O exemplo `describe-index` a seguir recupera o status atual do índice do item. ``` aws iot describe-index \ --index-name "AWS_Things" ``` Resultado: ``` { "indexName": "AWS_Things", "indexStatus": "ACTIVE", "schema": "REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS" } ``` Para obter mais informações, consulte [Gerenciar indexações de itens](https://docs.aws.amazon.com/iot/latest/developerguide/managing-index.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DescribeIndex](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-index.html) na *Referência de comandos da AWS CLI*. ### `describe-job-execution` O código de exemplo a seguir mostra como usar `describe-job-execution`. **AWS CLI** **Para obter detalhes de um trabalho em um dispositivo** O exemplo `describe-job-execution` a seguir obtém os detalhes de execução do trabalho especificado. ``` aws iot describe-job-execution \ --job-id "example-job-01" \ --thing-name "MyRaspberryPi" ``` Resultado: ``` { "execution": { "jobId": "example-job-01", "status": "QUEUED", "statusDetails": {}, "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyRaspberryPi", "queuedAt": 1560787023.636, "lastUpdatedAt": 1560787023.636, "executionNumber": 1, "versionNumber": 1 } } ``` Para obter mais informações, consulte [Criar e gerenciar trabalhos (CLI)](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DescribeJobExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-job-execution.html) na *Referência de comandos da AWS CLI*. ### `describe-job` O código de exemplo a seguir mostra como usar `describe-job`. **AWS CLI** **Para obter o status de um trabalho** O exemplo `describe-job` a seguir obtém o status detalhado do trabalho cujo ID é `example-job-01`. ``` aws iot describe-job \ --job-id "example-job-01" ``` Resultado: ``` { "job": { "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01", "jobId": "example-job-01", "targetSelection": "SNAPSHOT", "status": "IN_PROGRESS", "targets": [ "arn:aws:iot:us-west-2:123456789012:thing/MyRaspberryPi" ], "description": "example job test", "presignedUrlConfig": {}, "jobExecutionsRolloutConfig": {}, "createdAt": 1560787022.733, "lastUpdatedAt": 1560787026.294, "jobProcessDetails": { "numberOfCanceledThings": 0, "numberOfSucceededThings": 0, "numberOfFailedThings": 0, "numberOfRejectedThings": 0, "numberOfQueuedThings": 1, "numberOfInProgressThings": 0, "numberOfRemovedThings": 0, "numberOfTimedOutThings": 0 }, "timeoutConfig": {} } } ``` Para obter mais informações, consulte [Criar e gerenciar trabalhos (CLI)](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html) no *Guia do desenvolvedor do AWS IoT*. + Consulte detalhes da API em [DescribeJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-job.html) na *Referência de comandos da AWS CLI*. ### `describe-mitigation-action` O código de exemplo a seguir mostra como usar `describe-mitigation-action`. **AWS CLI** **Como visualizar os detalhes de uma ação de mitigação definida** O exemplo `describe-mitigation-action` a seguir exibe os detalhes da ação de mitigação especificada. ``` aws iot describe-mitigation-action \ --action-name AddThingsToQuarantineGroupAction ``` Resultado: ``` { "actionName": "AddThingsToQuarantineGroupAction", "actionType": "ADD_THINGS_TO_THING_GROUP", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroupAction", "actionId": "2fd2726d-98e1-4abf-b10f-09465ccd6bfa", "roleArn": "arn:aws:iam::123456789012:role/service-role/MoveThingsToQuarantineGroupRole", "actionParams": { "addThingsToThingGroupParams": { "thingGroupNames": [ "QuarantineGroup1" ], "overrideDynamicGroups": true } }, "creationDate": "2019-12-10T11:09:35.999000-08:00", "lastModifiedDate": "2019-12-10T11:09:35.999000-08:00" } ``` Para obter mais informações, consulte [DescribeMitigationAction (Comandos de ação de mitigação)](https://docs.aws.amazon.com/iot/latest/developerguide/mitigation-action-commands.html#dd-api-iot-DescribeMitigationAction) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DescribeMitigationAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-mitigation-action.html) na *Referência de comandos da AWS CLI*. ### `describe-provisioning-template-version` O código de exemplo a seguir mostra como usar `describe-provisioning-template-version`. **AWS CLI** **Para descrever uma versão do modelo de provisionamento** O exemplo `describe-provisioning-template-version` a seguir descreve uma versão do modelo de provisionamento. ``` aws iot describe-provisioning-template-version \ --template-name MyTestProvisioningTemplate \ --version-id 1 ``` Resultado: ``` { "versionId": 1, "creationDate": 1589308310.574, "templateBody": "{ \"Parameters\":{ \"SerialNumber\":{ \"Type\":\"String\" }, \"AWS::IoT::Certificate::Id\":{ \"Type\":\"String\" } }, \"Resources\":{ \"certificate\":{ \"Properties\":{ \"CertificateId\":{ \"Ref\":\"AWS::IoT::Certificate::Id\" }, \"Status\":\"Active\" }, \"Type\":\"AWS::IoT::Certificate\" }, \"policy\":{ \"Properties\":{ \"PolicyName\":\"MyIotPolicy\" }, \"Type\":\"AWS::IoT::Policy\" }, \"thing\":{ \"OverrideSettings\":{ \"AttributePayload\":\"MERGE\", \"ThingGroups\":\"DO_NOTHING\", \"ThingTypeName\":\"REPLACE\" }, \"Properties\":{ \"AttributePayload\":{}, \"ThingGroups\":[], \"ThingName\":{ \"Fn::Join\":[ \"\", [ \"DemoGroup_\", {\"Ref\":\"SerialNumber\"} ] ] }, \"ThingTypeName\":\"VirtualThings\" }, \"Type\":\"AWS::IoT::Thing\" } } }", "isDefaultVersion": true } ``` Para obter mais informações, consulte [Provisionar itens que não têm certificados de dispositivo usando o provisionamento de frota](https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [DescribeProvisioningTemplateVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-provisioning-template-version.html) na *Referência de comandos da AWS CLI*. ### `describe-provisioning-template` O código de exemplo a seguir mostra como usar `describe-provisioning-template`. **AWS CLI** **Para descrever um modelo de provisionamento** O exemplo `describe-provisioning-template` a seguir descreve um modelo de provisionamento. ``` aws iot describe-provisioning-template \ --template-name MyTestProvisioningTemplate ``` Resultado: ``` { "templateArn": "arn:aws:iot:us-west-2:57EXAMPLE833:provisioningtemplate/MyTestProvisioningTemplate", "templateName": "MyTestProvisioningTemplate", "creationDate": 1589308310.574, "lastModifiedDate": 1589308345.539, "defaultVersionId": 1, "templateBody": "{ \"Parameters\":{ \"SerialNumber\":{ \"Type\":\"String\" }, \"AWS::IoT::Certificate::Id\":{ \"Type\":\"String\" } }, \"Resources\":{ \"certificate\":{ \"Properties\":{ \"CertificateId\":{ \"Ref\":\"AWS::IoT::Certificate::Id\" }, \"Status\":\"Active\" }, \"Type\":\"AWS::IoT::Certificate\" }, \"policy\":{ \"Properties\":{ \"PolicyName\":\"MyIotPolicy\" }, \"Type\":\"AWS::IoT::Policy\" }, \"thing\":{ \"OverrideSettings\":{ \"AttributePayload\":\"MERGE\", \"ThingGroups\":\"DO_NOTHING\", \"ThingTypeName\":\"REPLACE\" }, \"Properties\":{ \"AttributePayload\":{}, \"ThingGroups\":[], \"ThingName\":{ \"Fn::Join\":[ \"\", [ \"DemoGroup_\", {\"Ref\":\"SerialNumber\"} ] ] }, \"ThingTypeName\":\"VirtualThings\" }, \"Type\":\"AWS::IoT::Thing\" } } }", "enabled": true, "provisioningRoleArn": "arn:aws:iam::571032923833:role/service-role/IoT_access" } ``` Para obter mais informações, consulte [Provisionar itens que não têm certificados de dispositivo usando o provisionamento de frota](https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [DescribeProvisioningTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-provisioning-template.html) na *Referência de comandos da AWS CLI*. ### `describe-role-alias` O código de exemplo a seguir mostra como usar `describe-role-alias`. **AWS CLI** **Para obter informações sobre um alias de perfil do AWS IoT** O exemplo `describe-role-alias` a seguir exibe os detalhes do alias de perfil especificado. ``` aws iot describe-role-alias \ --role-alias LightBulbRole ``` Resultado: ``` { "roleAliasDescription": { "roleAlias": "LightBulbRole", "roleAliasArn": "arn:aws:iot:us-west-2:123456789012:rolealias/LightBulbRole", "roleArn": "arn:aws:iam::123456789012:role/light_bulb_role_001", "owner": "123456789012", "credentialDurationSeconds": 3600, "creationDate": 1570558643.221, "lastModifiedDate": 1570558643.221 } } ``` Para obter mais informações, consulte [DescribeRoleAlias](https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeRoleAlias.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [DescribeRoleAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-role-alias.html) na *Referência de comandos da AWS CLI*. ### `describe-scheduled-audit` O código de exemplo a seguir mostra como usar `describe-scheduled-audit`. **AWS CLI** **Para obter informações sobre uma auditoria programada** O exemplo `describe-scheduled-audit` a seguir obtém informações detalhadas sobre uma instância auditoria programada do AWS IoT Device Defender `AWSIoTDeviceDefenderDailyAudit`. ``` aws iot describe-scheduled-audit \ --scheduled-audit-name AWSIoTDeviceDefenderDailyAudit ``` Resultado: ``` { "frequency": "DAILY", "targetCheckNames": [ "AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK", "CONFLICTING_CLIENT_IDS_CHECK", "DEVICE_CERTIFICATE_SHARED_CHECK", "IOT_POLICY_OVERLY_PERMISSIVE_CHECK", "REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK", "UNAUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK" ], "scheduledAuditName": "AWSIoTDeviceDefenderDailyAudit", "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/AWSIoTDeviceDefenderDailyAudit" } ``` Para obter mais informações, consulte [Comandos de auditoria](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DescribeScheduledAudit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-scheduled-audit.html) na *Referência de comandos da AWS CLI*. ### `describe-security-profile` O código de exemplo a seguir mostra como usar `describe-security-profile`. **AWS CLI** **Para obter informações sobre um perfil de segurança** O exemplo `describe-security-profile` a seguir obtém informações sobre o perfil de segurança do AWS IoT Device Defender chamado `PossibleIssue.` ``` aws iot describe-security-profile \ --security-profile-name PossibleIssue ``` Resultado: ``` { "securityProfileName": "PossibleIssue", "securityProfileArn": "arn:aws:iot:us-west-2:123456789012:securityprofile/PossibleIssue", "securityProfileDescription": "check to see if authorization fails 10 times in 5 minutes or if cellular bandwidth exceeds 128", "behaviors": [ { "name": "CellularBandwidth", "metric": "aws:message-byte-size", "criteria": { "comparisonOperator": "greater-than", "value": { "count": 128 }, "consecutiveDatapointsToAlarm": 1, "consecutiveDatapointsToClear": 1 } }, { "name": "Authorization", "metric": "aws:num-authorization-failures", "criteria": { "comparisonOperator": "greater-than", "value": { "count": 10 }, "durationSeconds": 300, "consecutiveDatapointsToAlarm": 1, "consecutiveDatapointsToClear": 1 } } ], "version": 1, "creationDate": 1560278102.528, "lastModifiedDate": 1560278102.528 } ``` Para obter mais informações, consulte [Comandos do Detect](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DescribeSecurityProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-security-profile.html) na *Referência de comandos da AWS CLI*. ### `describe-stream` O código de exemplo a seguir mostra como usar `describe-stream`. **AWS CLI** **Para obter informações sobre um fluxo** O exemplo `describe-stream` a seguir exibe os detalhes do fluxo especificado. ``` aws iot describe-stream \ --stream-id stream12345 ``` Resultado: ``` { "streamInfo": { "streamId": "stream12345", "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream12345", "streamVersion": 1, "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.", "files": [ { "fileId": "123", "s3Location": { "bucket":"codesign-ota-bucket", "key":"48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6" } } ], "createdAt": 1557863215.995, "lastUpdatedAt": 1557863215.995, "roleArn": "arn:aws:iam:123456789012:role/service-role/my_ota_stream_role" } } ``` Para obter mais informações, consulte [DescribeStream](https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeStream.html) na *Referência da API do AWS IoT*. + Consulte detalhes da API em [DescribeStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-stream.html) na *Referência de comandos da AWS CLI*. ### `describe-thing-group` O código de exemplo a seguir mostra como usar `describe-thing-group`. **AWS CLI** **Para obter informações sobre um grupo de itens** O exemplo `describe-thing-group` a seguir obtém informações sobre o grupo de itens chamado `HalogenBulbs`. ``` aws iot describe-thing-group \ --thing-group-name HalogenBulbs ``` Resultado: ``` { "thingGroupName": "HalogenBulbs", "thingGroupId": "f4ec6b84-b42b-499d-9ce1-4dbd4d4f6f6e", "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/HalogenBulbs", "version": 1, "thingGroupProperties": {}, "thingGroupMetadata": { "parentGroupName": "LightBulbs", "rootToParentThingGroups": [ { "groupName": "LightBulbs", "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" } ], "creationDate": 1559927609.897 } } ``` Para obter mais informações, consulte [Grupos de itens](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DescribeThingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-thing-group.html) na *Referência de comandos da AWS CLI*. ### `describe-thing-type` O código de exemplo a seguir mostra como usar `describe-thing-type`. **AWS CLI** **Para obter informações sobre um tipo de item** O exemplo `describe-thing-type` a seguir exibe informações sobre o tipo de item especificado definido em sua conta da AWS. ``` aws iot describe-thing-type \ --thing-type-name "LightBulb" ``` Resultado: ``` { "thingTypeName": "LightBulb", "thingTypeId": "ce3573b0-0a3c-45a7-ac93-4e0ce14cd190", "thingTypeArn": "arn:aws:iot:us-west-2:123456789012:thingtype/LightBulb", "thingTypeProperties": { "thingTypeDescription": "light bulb type", "searchableAttributes": [ "model", "wattage" ] }, "thingTypeMetadata": { "deprecated": false, "creationDate": 1559772562.498 } } ``` Para obter mais informações, consulte [Tipos de itens](https://docs.aws.amazon.com/iot/latest/developerguide/thing-types.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DescribeThingType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-thing-type.html) na *Referência de comandos da AWS CLI*. ### `describe-thing` O código de exemplo a seguir mostra como usar `describe-thing`. **AWS CLI** **Como exibir informações detalhadas sobre um item** O exemplo `describe-thing` a seguir exibe informações sobre um item (dispositivo) definido no registro do AWS IoT da sua conta da AWS. aws iot describe-thing --thing-name "MyLightBulb" Resultado: ``` { "defaultClientId": "MyLightBulb", "thingName": "MyLightBulb", "thingId": "40da2e73-c6af-406e-b415-15acae538797", "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb", "thingTypeName": "LightBulb", "attributes": { "model": "123", "wattage": "75" }, "version": 1 } ``` Para acessar mais informações, consulte [Como gerenciar objetos com o registro](https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DescribeThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-thing.html) na *Referência de comandos da AWS CLI*. ### `detach-policy` O código de exemplo a seguir mostra como usar `detach-policy`. **AWS CLI** **Exemplo 1: remover uma política do AWS IoT de um grupo de itens** O exemplo `detach-policy` a seguir remove a política especificada de um grupo de itens e, por extensão, de todos os itens desse grupo e de qualquer um de seus grupos-filho. ``` aws iot detach-policy \ --target "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" \ --policy-name "MyFirstGroup_Core-policy" ``` Este comando não produz saída. Para obter mais informações, consulte [Grupos de itens](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html) no *Guia do desenvolvedor do AWS IoT*. **Exemplo 2: remover uma política do AWS IoT de um certificado de dispositivo** O exemplo `detach-policy` a seguir separa a política TemperatureSensorPolicy de um certificado de dispositivo identificado pelo ARN. ``` aws iot detach-policy \ --policy-name TemperatureSensorPolicy \ --target arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142 ``` Este comando não produz saída. + Para obter detalhes da API, consulte.[DetachPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/detach-policy.html) na *Referência de comandos da AWS CLI*. ### `detach-security-profile` O código de exemplo a seguir mostra como usar `detach-security-profile`. **AWS CLI** **Como desassociar um perfil de segurança de um alvo** O exemplo `detach-security-profile` a seguir remove a associação entre o perfil de segurança do AWS IoT Device Defender chamado `Testprofile` e o alvo de todos os dispositivos registrados. ``` aws iot detach-security-profile \ --security-profile-name Testprofile \ --security-profile-target-arn "arn:aws:iot:us-west-2:123456789012:all/registered-things" ``` Este comando não produz saída. Para obter mais informações, consulte [Comandos do Detect](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DetachSecurityProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/detach-security-profile.html) na *Referência de comandos da AWS CLI*. ### `detach-thing-principal` O código de exemplo a seguir mostra como usar `detach-thing-principal`. **AWS CLI** **Para remover um certificado/entidade principal de um item** O exemplo `detach-thing-principal` a seguir remove um certificado que representa uma entidade principal do item especificado. ``` aws iot detach-thing-principal \ --thing-name "MyLightBulb" \ --principal "arn:aws:iot:us-west-2:123456789012:cert/604c48437a57b7d5fc5d137c5be75011c6ee67c9a6943683a1acb4b1626bac36" ``` Este comando não produz saída. Para acessar mais informações, consulte [Como gerenciar objetos com o registro](https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DetachThingPrincipal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/detach-thing-principal.html) na *Referência de comandos da AWS CLI*. ### `disable-topic-rule` O código de exemplo a seguir mostra como usar `disable-topic-rule`. **AWS CLI** **Para desativar uma regra de tópico** O exemplo `disable-topic-rule` a seguir desabilita a regra de tópico especificada. ``` aws iot disable-topic-rule \ --rule-name "MyPlantPiMoistureAlertRule" ``` Este comando não produz saída. Para obter mais informações, consulte [Visualizar suas regras](https://docs.aws.amazon.com/iot/latest/developerguide/iot-view-rules.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DisableTopicRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/disable-topic-rule.html) na *Referência de comandos da AWS CLI*. ### `enable-topic-rule` O código de exemplo a seguir mostra como usar `enable-topic-rule`. **AWS CLI** **Como ativar uma regra de tópico** O exemplo `enable-topic-rule` a seguir ativa (ou reativa) a regra de tópico especificada. ``` aws iot enable-topic-rule \ --rule-name "MyPlantPiMoistureAlertRule" ``` Este comando não produz saída. Para obter mais informações, consulte [Visualizar suas regras](https://docs.aws.amazon.com/iot/latest/developerguide/iot-view-rules.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [EnableTopicRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/enable-topic-rule.html) na *Referência de comandos da AWS CLI*. ### `get-behavior-model-training-summaries` O código de exemplo a seguir mostra como usar `get-behavior-model-training-summaries`. **AWS CLI** **Para listar o status do modelo de treinamento do Perfil de segurança do ML Detect do Device Defender** O exemplo `get-behavior-model-training-summaries` a seguir lista o status do treinamento de modelo para os comportamentos configurados no Perfil de Segurança escolhido. Para cada comportamento, o nome, o status do modelo e a porcentagem de pontos de dados coletados são listados. ``` aws iot get-behavior-model-training-summaries \ --security-profile-name MySecuirtyProfileName ``` Resultado: ``` { "summaries": [ { "securityProfileName": "MySecuirtyProfileName", "behaviorName": "Messages_sent_ML_behavior", "modelStatus": "PENDING_BUILD", "datapointsCollectionPercentage": 0.0 }, { "securityProfileName": "MySecuirtyProfileName", "behaviorName": "Messages_received_ML_behavior", "modelStatus": "PENDING_BUILD", "datapointsCollectionPercentage": 0.0 }, { "securityProfileName": "MySecuirtyProfileName", "behaviorName": "Authorization_failures_ML_behavior", "modelStatus": "PENDING_BUILD", "datapointsCollectionPercentage": 0.0 }, { "securityProfileName": "MySecuirtyProfileName", "behaviorName": "Message_size_ML_behavior", "modelStatus": "PENDING_BUILD", "datapointsCollectionPercentage": 0.0 }, { "securityProfileName": "MySecuirtyProfileName", "behaviorName": "Connection_attempts_ML_behavior", "modelStatus": "PENDING_BUILD", "datapointsCollectionPercentage": 0.0 }, { "securityProfileName": "MySPNoALerts", "behaviorName": "Disconnects_ML_behavior", "modelStatus": "PENDING_BUILD", "datapointsCollectionPercentage": 0.0 } ] } ``` Para obter mais informações, consulte [GetBehaviorModelTrainingSummaries (Comandos do Detect)](https://docs.aws.amazon.com/iot/latest/developerguide/detect-commands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [GetBehaviorModelTrainingSummaries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-behavior-model-training-summaries.html) na *Referência de comandos da AWS CLI*. ### `get-cardinality` O código de exemplo a seguir mostra como usar `get-cardinality`. **AWS CLI** **Como retornar a contagem aproximada de valores exclusivos que correspondem à consulta** É possível usar o script de configuração a seguir para criar 10 itens representando 10 sensores de temperatura. Cada item novo tem 3 atributos. ``` # Bash script. If in other shells, type `bash` before running Temperatures=(70 71 72 73 74 75 47 97 98 99) Racks=(Rack1 Rack1 Rack2 Rack2 Rack3 Rack4 Rack5 Rack6 Rack6 Rack6) IsNormal=(true true true true true true false false false false) for ((i=0; i<10 ; i++)) do thing=$(aws iot create-thing --thing-name "TempSensor$i" --attribute-payload attributes="{temperature=${Temperatures[i]},rackId=${Racks[i]},stateNormal=${IsNormal[i]}}") aws iot describe-thing --thing-name "TempSensor$i" done ``` Exemplo de saída do script de configuração: ``` { "version": 1, "thingName": "TempSensor0", "defaultClientId": "TempSensor0", "attributes": { "rackId": "Rack1", "stateNormal": "true", "temperature": "70" }, "thingArn": "arn:aws:iot:us-east-1:123456789012:thing/TempSensor0", "thingId": "example1-90ab-cdef-fedc-ba987example" } ``` O exemplo `get-cardinality` a seguir consulta os 10 sensores criados pelo script de configuração e retorna o número de racks que têm sensores de temperatura relatando valores de temperatura anormais. Se o valor da temperatura estiver abaixo de 60 ou acima de 80, o sensor de temperatura está em um estado anormal. ``` aws iot get-cardinality \ --aggregation-field "attributes.rackId" \ --query-string "thingName:TempSensor* AND attributes.stateNormal:false" ``` Resultado: ``` { "cardinality": 2 } ``` Para obter mais informações, consulte Consultar dados agregados no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [GetCardinality](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-cardinality.html) na *Referência de comandos da AWS CLI*. ### `get-effective-policies` O código de exemplo a seguir mostra como usar `get-effective-policies`. **AWS CLI** **Para listar as políticas que afetam um item** O exemplo `get-effective-policies` a seguir lista as políticas que afetam o item especificado, incluindo políticas anexadas a qualquer grupo ao qual ele pertença. ``` aws iot get-effective-policies \ --thing-name TemperatureSensor-001 \ --principal arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142 ``` Resultado: ``` { "effectivePolicies": [ { "policyName": "TemperatureSensorPolicy", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TemperatureSensorPolicy", "policyDocument": "{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Effect\": \"Allow\", \"Action\": [ \"iot:Publish\", \"iot:Receive\" ], \"Resource\": [ \"arn:aws:iot:us-west-2:123456789012:topic/topic_1\", \"arn:aws:iot:us-west-2:123456789012:topic/topic_2\" ] }, { \"Effect\": \"Allow\", \"Action\": [ \"iot:Subscribe\" ], \"Resource\": [ \"arn:aws:iot:us-west-2:123456789012:topicfilter/topic_1\", \"arn:aws:iot:us-west-2:123456789012:topicfilter/topic_2\" ] }, { \"Effect\": \"Allow\", \"Action\": [ \"iot:Connect\" ], \"Resource\": [ \"arn:aws:iot:us-west-2:123456789012:client/basicPubSub\" ] } ] }" } ] } ``` Para obter mais informações, consulte [Obter políticas que afetam um item](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html#group-get-effective-policies) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [GetEffectivePolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-effective-policies.html) na *Referência de comandos da AWS CLI*. ### `get-indexing-configuration` O código de exemplo a seguir mostra como usar `get-indexing-configuration`. **AWS CLI** **Para obter a configuração da indexação de itens** O exemplo `get-indexing-configuration` a seguir obtém os dados de configuração atuais para indexação de frotas do AWS IoT. ``` aws iot get-indexing-configuration ``` Resultado: ``` { "thingIndexingConfiguration": { "thingIndexingMode": "OFF", "thingConnectivityIndexingMode": "OFF" }, "thingGroupIndexingConfiguration": { "thingGroupIndexingMode": "OFF" } } ``` Para obter mais informações, consulte [Gerenciar indexações de itens](https://docs.aws.amazon.com/iot/latest/developerguide/managing-index.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [GetIndexingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-indexing-configuration.html) na *Referência de comandos da AWS CLI*. ### `get-job-document` O código de exemplo a seguir mostra como usar `get-job-document`. **AWS CLI** **Para recuperar o documento para um trabalho** O exemplo `get-job-document` a seguir exibe detalhes sobre o documento do trabalho cujo ID é `example-job-01`. ``` aws iot get-job-document \ --job-id "example-job-01" ``` Resultado: ``` { "document": "\n{\n \"operation\":\"customJob\",\n \"otherInfo\":\"someValue\"\n}\n" } ``` Para obter mais informações, consulte [Criar e gerenciar trabalhos (CLI)](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [GetJobDocument](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-job-document.html) na *Referência de comandos da AWS CLI*. ### `get-logging-options` O código de exemplo a seguir mostra como usar `get-logging-options`. **AWS CLI** **Para obter as opções de log** O exemplo `get-logging-options` a seguir mostra as opções de log atuais da sua conta da AWS. ``` aws iot get-logging-options ``` Resultado: ``` { "roleArn": "arn:aws:iam::123456789012:role/service-role/iotLoggingRole", "logLevel": "ERROR" } ``` Para obter mais informações, consulte o título no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [GetLoggingOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-logging-options.html) na *Referência de comandos da AWS CLI*. ### `get-ota-update` O código de exemplo a seguir mostra como usar `get-ota-update`. **AWS CLI** **Para recuperar informações sobre uma Atualização OTA** O exemplo `get-ota-update` a seguir exibe os detalhes da Atualização OTA especificada. ``` aws iot get-ota-update \ --ota-update-id ota12345 ``` Resultado: ``` { "otaUpdateInfo": { "otaUpdateId": "ota12345", "otaUpdateArn": "arn:aws:iot:us-west-2:123456789012:otaupdate/itsaupdate", "creationDate": 1557863215.995, "lastModifiedDate": 1557863215.995, "description": "A critical update needed right away.", "targets": [ "device1", "device2", "device3", "device4" ], "targetSelection": "SNAPSHOT", "protocols": ["HTTP"], "awsJobExecutionsRolloutConfig": { "maximumPerMinute": 10 }, "otaUpdateFiles": [ { "fileName": "firmware.bin", "fileLocation": { "stream": { "streamId": "004", "fileId":123 } }, "codeSigning": { "awsSignerJobId": "48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6" } } ], "roleArn": "arn:aws:iam:123456789012:role/service-role/my_ota_role" "otaUpdateStatus": "CREATE_COMPLETE", "awsIotJobId": "job54321", "awsIotJobArn": "arn:aws:iot:us-west-2:123456789012:job/job54321", "errorInfo": { } } } ``` Para obter mais informações, consulte [GetOTAUpdate](https://docs.aws.amazon.com/iot/latest/apireference/API_GetOTAUpdate.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [GetOtaUpdate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-ota-update.html) na *Referência de comandos da AWS CLI*. ### `get-percentiles` O código de exemplo a seguir mostra como usar `get-percentiles`. **AWS CLI** **Como agrupar os valores agregados que correspondem à consulta em agrupamentos de percentil** É possível usar o script de configuração a seguir para criar 10 itens representando 10 sensores de temperatura. Cada item novo tem 1 atributo. ``` # Bash script. If in other shells, type `bash` before running Temperatures=(70 71 72 73 74 75 47 97 98 99) for ((i=0; i<10 ; i++)) do thing=$(aws iot create-thing --thing-name "TempSensor$i" --attribute-payload attributes="{temperature=${Temperatures[i]}}") aws iot describe-thing --thing-name "TempSensor$i" done ``` Exemplo de saída do script de configuração: ``` { "version": 1, "thingName": "TempSensor0", "defaultClientId": "TempSensor0", "attributes": { "temperature": "70" }, "thingArn": "arn:aws:iot:us-east-1:123456789012:thing/TempSensor0", "thingId": "example1-90ab-cdef-fedc-ba987example" } ``` O exemplo `get-percentiles` a seguir consulta os 10 sensores criados pelo script de configuração e retorna um valor para cada grupo de percentis especificado. O grupo de percentis "10" contém o valor de campo agregado que ocorre em aproximadamente 10 por cento dos valores que correspondem à consulta. Na saída a seguir, \$1"percent": 10.0, "value": 67.7\$1 significa que aproximadamente 10,0% dos valores de temperatura estão abaixo de 67,7. ``` aws iot get-percentiles \ --aggregation-field "attributes.temperature" \ --query-string "thingName:TempSensor*" \ --percents 10 25 50 75 90 ``` Resultado: ``` { "percentiles": [ { "percent": 10.0, "value": 67.7 }, { "percent": 25.0, "value": 71.25 }, { "percent": 50.0, "value": 73.5 }, { "percent": 75.0, "value": 91.5 }, { "percent": 90.0, "value": 98.1 } ] } ``` Para obter mais informações, consulte [Consultar dados agregados](https://docs.aws.amazon.com/iot/latest/developerguide/index-aggregate.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [GetPercentiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-percentiles.html) na *Referência de comandos da AWS CLI*. ### `get-policy-version` O código de exemplo a seguir mostra como usar `get-policy-version`. **AWS CLI** **Para obter informações sobre uma versão específica de uma política** O exemplo `get-policy-version` a seguir obtém informações sobre a primeira versão da política especificada. ``` aws iot get-policy \ --policy-name UpdateDeviceCertPolicy --policy-version-id "1" ``` Resultado: ``` { "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy", "policyName": "UpdateDeviceCertPolicy", "policyDocument": "{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Effect\": \"Allow\", \"Action\": \"iot:UpdateCertificate\", \"Resource\": \"*\" } ] }", "policyVersionId": "1", "isDefaultVersion": false, "creationDate": 1559925941.924, "lastModifiedDate": 1559926175.458, "generationId": "5066f1b6712ce9d2a1e56399771649a272d6a921762fead080e24fe52f24e042" } ``` Para obter mais informações, consulte [Políticas do AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) no *Guia do desenvolvedor do AWS IoT*. + Consulte detalhes da API em [GetPolicyVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-policy-version.html) na *Referência de comandos da AWS CLI*. ### `get-policy` O código de exemplo a seguir mostra como usar `get-policy`. **AWS CLI** **Para obter informações sobre uma versão padrão de uma política** O exemplo `get-policy` a seguir obtém informações sobre a versão padrão da política especificada. ``` aws iot get-policy \ --policy-name UpdateDeviceCertPolicy ``` Resultado: ``` { "policyName": "UpdateDeviceCertPolicy", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy", "policyDocument": "{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Effect\": \"Allow\", \"Action\": \"iot:UpdateCertificate\", \"Resource\": \"*\" } ] }", "defaultVersionId": "2", "creationDate": 1559925941.924, "lastModifiedDate": 1559925941.924, "generationId": "5066f1b6712ce9d2a1e56399771649a272d6a921762fead080e24fe52f24e042" } ``` Para obter mais informações, consulte [Políticas do AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) no *Guia do desenvolvedor do AWS IoT*. + Consulte detalhes da API em [GetPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-policy.html) na *Referência de comandos da AWS CLI*. ### `get-registration-code` O código de exemplo a seguir mostra como usar `get-registration-code`. **AWS CLI** **Para obter o código de registro específico da sua conta da AWS** O exemplo `get-registration-code` a seguir recupera o código de registro específico para sua conta da AWS. ``` aws iot get-registration-code ``` Resultado: ``` { "registrationCode": "15c51ae5e36ba59ba77042df1115862076bea4bd15841c838fcb68d5010a614c" } ``` Para obter mais informações, consulte [Usar seu próprio certificado](https://docs.aws.amazon.com/iot/latest/developerguide/device-certs-your-own.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [GetRegistrationCode](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-registration-code.html) na *Referência de comandos da AWS CLI*. ### `get-statistics` O código de exemplo a seguir mostra como usar `get-statistics`. **AWS CLI** **Como pesquisar dados agregados no índice do dispositivo** O exemplo `get-statistics` a seguir retorna o número de dispositivos que têm uma propriedade chamada `connectivity.connected` definida como `false` (ou seja, o número de itens que não estão conectados) na sombra do dispositivo. ``` aws iot get-statistics \ --index-name AWS_Things \ --query-string "connectivity.connected:false" ``` Resultado: ``` { "statistics": { "count": 6 } } ``` Para obter mais informações, consulte [Obter estatísticas sobre sua frota de dispositivos](https://docs.aws.amazon.com/iot/latest/developerguide/index-aggregate.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [GetStatistics](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-statistics.html) na *Referência de comandos da AWS CLI*. ### `get-topic-rule-destination` O código de exemplo a seguir mostra como usar `get-topic-rule-destination`. **AWS CLI** **Para obter um destino da regra de tópico** O exemplo `get-topic-rule-destination` a seguir obtém informações sobre um destino de regra de tópico. ``` aws iot get-topic-rule-destination \ --arn "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" ``` Resultado: ``` { "topicRuleDestination": { "arn": "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "status": "DISABLED", "httpUrlProperties": { "confirmationUrl": "https://example.com" } } } ``` Para obter mais informações, consulte [Trabalhar com destinos de tópicos](https://docs.aws.amazon.com/iot/latest/developerguide/rule-destination.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [GetTopicRuleDestination](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-topic-rule-destination.html) na *Referência de comandos da AWS CLI*. ### `get-topic-rule` O código de exemplo a seguir mostra como usar `get-topic-rule`. **AWS CLI** **Para obter informações sobre uma regra** O exemplo `get-topic-rule` a seguir mostra as informações sobre a regra especificada. ``` aws iot get-topic-rule \ --rule-name MyRPiLowMoistureAlertRule ``` Resultado: ``` { "ruleArn": "arn:aws:iot:us-west-2:123456789012:rule/MyRPiLowMoistureAlertRule", "rule": { "ruleName": "MyRPiLowMoistureAlertRule", "sql": "SELECT * FROM '$aws/things/MyRPi/shadow/update/accepted' WHERE state.reported.moisture = 'low'\n ", "description": "Sends an alert whenever soil moisture level readings are too low.", "createdAt": 1558624363.0, "actions": [ { "sns": { "targetArn": "arn:aws:sns:us-west-2:123456789012:MyRPiLowMoistureTopic", "roleArn": "arn:aws:iam::123456789012:role/service-role/MyRPiLowMoistureTopicRole", "messageFormat": "RAW" } } ], "ruleDisabled": false, "awsIotSqlVersion": "2016-03-23" } } ``` Para obter mais informações, consulte [Visualizando as regras](https://docs.aws.amazon.com/iot/latest/developerguide/iot-managae-rule.html#iot-view-rules) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [GetTopicRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-topic-rule.html) na *Referência de comandos da AWS CLI*. ### `get-v2-logging-options` O código de exemplo a seguir mostra como usar `get-v2-logging-options`. **AWS CLI** **Para listar as opções de log atuais** O exemplo `get-v2-logging-options` a seguir lista as opções atuais de log do AWS IoT. ``` aws iot get-v2-logging-options ``` Resultado: ``` { "roleArn": "arn:aws:iam::094249569039:role/service-role/iotLoggingRole", "defaultLogLevel": "WARN", "disableAllLogs": false } ``` Para obter mais informações, consulte o título no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [GetV2LoggingOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-v2-logging-options.html) na *Referência de comandos da AWS CLI*. ### `list-active-violations` O código de exemplo a seguir mostra como usar `list-active-violations`. **AWS CLI** **Para listar as violações ativas** O exemplo `list-active-violations` a seguir lista todas as violações do perfil de segurança especificado. ``` aws iot list-active-violations \ --security-profile-name Testprofile ``` Resultado: ``` { "activeViolations": [ { "violationId": "174db59167fa474c80a652ad1583fd44", "thingName": "iotconsole-1560269126751-1", "securityProfileName": "Testprofile", "behavior": { "name": "Authorization", "metric": "aws:num-authorization-failures", "criteria": { "comparisonOperator": "greater-than", "value": { "count": 10 }, "durationSeconds": 300, "consecutiveDatapointsToAlarm": 1, "consecutiveDatapointsToClear": 1 } }, "lastViolationValue": { "count": 0 }, "lastViolationTime": 1560293700.0, "violationStartTime": 1560279000.0 }, { "violationId": "c8a9466a093d3b7b35cd44ca58bdbeab", "thingName": "TvnQoEoU", "securityProfileName": "Testprofile", "behavior": { "name": "CellularBandwidth", "metric": "aws:message-byte-size", "criteria": { "comparisonOperator": "greater-than", "value": { "count": 128 }, "consecutiveDatapointsToAlarm": 1, "consecutiveDatapointsToClear": 1 } }, "lastViolationValue": { "count": 110 }, "lastViolationTime": 1560369000.0, "violationStartTime": 1560276600.0 }, { "violationId": "74aa393adea02e6648f3ac362beed55e", "thingName": "iotconsole-1560269232412-2", "securityProfileName": "Testprofile", "behavior": { "name": "Authorization", "metric": "aws:num-authorization-failures", "criteria": { "comparisonOperator": "greater-than", "value": { "count": 10 }, "durationSeconds": 300, "consecutiveDatapointsToAlarm": 1, "consecutiveDatapointsToClear": 1 } }, "lastViolationValue": { "count": 0 }, "lastViolationTime": 1560276600.0, "violationStartTime": 1560276600.0 }, { "violationId": "1e6ab5f7cf39a1466fcd154e1377e406", "thingName": "TvnQoEoU", "securityProfileName": "Testprofile", "behavior": { "name": "Authorization", "metric": "aws:num-authorization-failures", "criteria": { "comparisonOperator": "greater-than", "value": { "count": 10 }, "durationSeconds": 300, "consecutiveDatapointsToAlarm": 1, "consecutiveDatapointsToClear": 1 } }, "lastViolationValue": { "count": 0 }, "lastViolationTime": 1560369000.0, "violationStartTime": 1560276600.0 } ] } ``` + Para ver detalhes da API, consulte [ListActiveViolations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-active-violations.html) na *Referência de comandos da AWS CLI*. ### `list-attached-policies` O código de exemplo a seguir mostra como usar `list-attached-policies`. **AWS CLI** **Exemplo 1: listar as políticas anexadas a um grupo** O exemplo `list-attached-policies` a seguir lista as políticas anexadas ao grupo especificado. ``` aws iot list-attached-policies \ --target "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" ``` Resultado: ``` { "policies": [ { "policyName": "UpdateDeviceCertPolicy", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy" } ] } ``` Para obter mais informações, consulte [Grupos de itens](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html) no *Guia do desenvolvedor do AWS IoT*. **Exemplo 2: listar as políticas anexadas a um certificado de dispositivo** O exemplo `list-attached-policies` a seguir lista as políticas do AWS IoT anexadas ao certificado do dispositivo. Cada certificado é identificado pelo seu ARN. ``` aws iot list-attached-policies \ --target arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142 ``` Resultado: ``` { "policies": [ { "policyName": "TemperatureSensorPolicy", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TemperatureSensorPolicy" } ] } ``` Para obter mais informações, consulte [Grupos de itens](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListAttachedPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-attached-policies.html) na *Referência de comandos da AWS CLI*. ### `list-audit-findings` O código de exemplo a seguir mostra como usar `list-audit-findings`. **AWS CLI** **Exemplo 1: listar todas as descobertas de uma auditoria** O exemplo `list-audit-findings` a seguir lista todas as descobertas de uma auditoria do AWS IoT Device Defender com um ID de tarefa especificado. ``` aws iot list-audit-findings \ --task-id a3aea009955e501a31b764abe1bebd3d ``` Resultado: ``` { "findings": [] } ``` **Exemplo 2: listar as descobertas de um tipo de verificação de auditoria** O exemplo `list-audit-findings` a seguir mostra as descobertas das auditorias do AWS IoT Device Defender realizadas entre 5 de junho de 2019 e 19 de junho de 2019, nas quais os itens compartilham um certificado de dispositivo. Ao especificar um nome de verificação, é necessário fornecer um horário de início e término. ``` aws iot list-audit-findings \ --check-name DEVICE_CERTIFICATE_SHARED_CHECK \ --start-time 1559747125 \ --end-time 1560962028 ``` Resultado: ``` { "findings": [ { "taskId": "eeef61068b0eb03c456d746c5a26ee04", "checkName": "DEVICE_CERTIFICATE_SHARED_CHECK", "taskStartTime": 1560161017.172, "findingTime": 1560161017.592, "severity": "CRITICAL", "nonCompliantResource": { "resourceType": "DEVICE_CERTIFICATE", "resourceIdentifier": { "deviceCertificateId": "b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b" } }, "relatedResources": [ { "resourceType": "CLIENT_ID", "resourceIdentifier": { "clientId": "ZipxgAIl" }, "additionalInfo": { "CONNECTION_TIME": "1560086374068" } }, { "resourceType": "CLIENT_ID", "resourceIdentifier": { "clientId": "ZipxgAIl" }, "additionalInfo": { "CONNECTION_TIME": "1560081552187", "DISCONNECTION_TIME": "1560086371552" } }, { "resourceType": "CLIENT_ID", "resourceIdentifier": { "clientId": "ZipxgAIl" }, "additionalInfo": { "CONNECTION_TIME": "1559289863631", "DISCONNECTION_TIME": "1560081532716" } } ], "reasonForNonCompliance": "Certificate shared by one or more devices.", "reasonForNonComplianceCode": "CERTIFICATE_SHARED_BY_MULTIPLE_DEVICES" }, { "taskId": "bade6b5efd2e1b1569822f6021b39cf5", "checkName": "DEVICE_CERTIFICATE_SHARED_CHECK", "taskStartTime": 1559988217.27, "findingTime": 1559988217.655, "severity": "CRITICAL", "nonCompliantResource": { "resourceType": "DEVICE_CERTIFICATE", "resourceIdentifier": { "deviceCertificateId": "b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b" } }, "relatedResources": [ { "resourceType": "CLIENT_ID", "resourceIdentifier": { "clientId": "xShGENLW" }, "additionalInfo": { "CONNECTION_TIME": "1559972350825" } }, { "resourceType": "CLIENT_ID", "resourceIdentifier": { "clientId": "xShGENLW" }, "additionalInfo": { "CONNECTION_TIME": "1559255062002", "DISCONNECTION_TIME": "1559972350616" } } ], "reasonForNonCompliance": "Certificate shared by one or more devices.", "reasonForNonComplianceCode": "CERTIFICATE_SHARED_BY_MULTIPLE_DEVICES" }, { "taskId": "c23f6233ba2d35879c4bb2810fb5ffd6", "checkName": "DEVICE_CERTIFICATE_SHARED_CHECK", "taskStartTime": 1559901817.31, "findingTime": 1559901817.767, "severity": "CRITICAL", "nonCompliantResource": { "resourceType": "DEVICE_CERTIFICATE", "resourceIdentifier": { "deviceCertificateId": "b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b" } }, "relatedResources": [ { "resourceType": "CLIENT_ID", "resourceIdentifier": { "clientId": "TvnQoEoU" }, "additionalInfo": { "CONNECTION_TIME": "1559826729768" } }, { "resourceType": "CLIENT_ID", "resourceIdentifier": { "clientId": "TvnQoEoU" }, "additionalInfo": { "CONNECTION_TIME": "1559345920964", "DISCONNECTION_TIME": "1559826728402" } } ], "reasonForNonCompliance": "Certificate shared by one or more devices.", "reasonForNonComplianceCode": "CERTIFICATE_SHARED_BY_MULTIPLE_DEVICES" } ] } ``` Para obter mais informações, consulte [Comandos de auditoria](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListAuditFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-audit-findings.html) na *Referência de comandos da AWS CLI*. ### `list-audit-mitigation-actions-executions` O código de exemplo a seguir mostra como usar `list-audit-mitigation-actions-executions`. **AWS CLI** **Para listar os detalhes da execução de uma ação de mitigação de auditoria** Uma tarefa de ação de mitigação de auditoria aplica uma ação de mitigação a uma ou mais descobertas de uma auditoria do AWS IoT Device Defender. O exemplo `list-audit-mitigation-actions-executions` a seguir lista os detalhes da tarefa de ação de mitigação com a `taskId` e a descoberta especificadas. ``` aws iot list-audit-mitigation-actions-executions \ --task-id myActionsTaskId \ --finding-id 0edbaaec-2fe1-4cf5-abc9-d4c3e51f7464 ``` Resultado: ``` { "actionsExecutions": [ { "taskId": "myActionsTaskId", "findingId": "0edbaaec-2fe1-4cf5-abc9-d4c3e51f7464", "actionName": "ResetPolicyVersionAction", "actionId": "1ea0b415-bef1-4a01-bd13-72fb63c59afb", "status": "COMPLETED", "startTime": "2019-12-10T15:19:13.279000-08:00", "endTime": "2019-12-10T15:19:13.337000-08:00" } ] } ``` Para obter mais informações, consulte [ListAuditMitigationActionsExecutions (Comandos de ação de mitigação)](https://docs.aws.amazon.com/iot/latest/developerguide/mitigation-action-commands.html#dd-api-iot-ListAuditMitigationActionsExecutions) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListAuditMitigationActionsExecutions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-audit-mitigation-actions-executions.html) na *Referência de comandos da AWS CLI*. ### `list-audit-mitigation-actions-tasks` O código de exemplo a seguir mostra como usar `list-audit-mitigation-actions-tasks`. **AWS CLI** **Para listar as tarefas de ação de mitigação de auditoria** O exemplo `list-audit-mitigation-actions-tasks` a seguir lista as ações de mitigação que foram aplicadas às descobertas dentro do período de tempo especificado. ``` aws iot list-audit-mitigation-actions-tasks \ --start-time 1594157400 \ --end-time 1594157430 ``` Resultado: ``` { "tasks": [ { "taskId": "0062f2d6-3999-488f-88c7-bef005414103", "startTime": "2020-07-07T14:30:15.172000-07:00", "taskStatus": "COMPLETED" } ] } ``` Para obter mais informações, consulte [ListAuditMitigationActionsTasks (Comandos de ação de mitigação)](https://docs.aws.amazon.com/iot/latest/developerguide/mitigation-action-commands.html#dd-api-iot-ListAuditMitigationActionsTasks) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListAuditMitigationActionsTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-audit-mitigation-actions-tasks.html) na *Referência de comandos da AWS CLI*. ### `list-audit-suppressions` O código de exemplo a seguir mostra como usar `list-audit-suppressions`. **AWS CLI** **Para listar as supressões de descobertas de auditoria** O exemplo `list-audit-suppressions` a seguir lista todas as supressões de descobertas de auditoria. ``` aws iot list-audit-suppressions ``` Resultado: ``` { "suppressions": [ { "checkName": "DEVICE_CERTIFICATE_EXPIRING_CHECK", "resourceIdentifier": { "deviceCertificateId": "c7691e" }, "expirationDate": 1597881600.0, "suppressIndefinitely": false } ] } ``` Para obter mais informações, consulte [Supressões de descoberta de auditoria](https://docs.aws.amazon.com/iot/latest/developerguide/audit-finding-suppressions.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListAuditSuppressions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-audit-suppressions.html) na *Referência de comandos da AWS CLI*. ### `list-audit-tasks` O código de exemplo a seguir mostra como usar `list-audit-tasks`. **AWS CLI** **Para listar todas as descobertas de uma auditoria** O exemplo `list-audit-tasks` a seguir lista as tarefas de auditoria executadas entre 5 de junho de 2019 e 12 de junho de 2019. ``` aws iot list-audit-tasks \ --start-time 1559747125 \ --end-time 1560357228 ``` Resultado: ``` { "tasks": [ { "taskId": "a3aea009955e501a31b764abe1bebd3d", "taskStatus": "COMPLETED", "taskType": "ON_DEMAND_AUDIT_TASK" }, { "taskId": "f76b4b5102b632cd9ae38a279c266da1", "taskStatus": "COMPLETED", "taskType": "SCHEDULED_AUDIT_TASK" }, { "taskId": "51d9967d9f9ff4d26529505f6d2c444a", "taskStatus": "COMPLETED", "taskType": "SCHEDULED_AUDIT_TASK" }, { "taskId": "eeef61068b0eb03c456d746c5a26ee04", "taskStatus": "COMPLETED", "taskType": "SCHEDULED_AUDIT_TASK" }, { "taskId": "041c49557b7c7b04c079a49514b55589", "taskStatus": "COMPLETED", "taskType": "SCHEDULED_AUDIT_TASK" }, { "taskId": "82c7f2afac1562d18a4560be73998acc", "taskStatus": "COMPLETED", "taskType": "SCHEDULED_AUDIT_TASK" }, { "taskId": "bade6b5efd2e1b1569822f6021b39cf5", "taskStatus": "COMPLETED", "taskType": "SCHEDULED_AUDIT_TASK" }, { "taskId": "c23f6233ba2d35879c4bb2810fb5ffd6", "taskStatus": "COMPLETED", "taskType": "SCHEDULED_AUDIT_TASK" }, { "taskId": "ac9086b7222a2f5e2e17bb6fd30b3aeb", "taskStatus": "COMPLETED", "taskType": "SCHEDULED_AUDIT_TASK" } ] } ``` Para obter mais informações, consulte [Comandos de auditoria](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListAuditTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-audit-tasks.html) na *Referência de comandos da AWS CLI*. ### `list-authorizers` O código de exemplo a seguir mostra como usar `list-authorizers`. **AWS CLI** **Para listar seu autorizador personalizado** O exemplo `list-authorizers` a seguir lista os autorizadores personalizados em sua conta da AWS. ``` aws iot list-authorizers ``` Resultado: ``` { "authorizers": [ { "authorizerName": "CustomAuthorizer", "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer" }, { "authorizerName": "CustomAuthorizer2", "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer2" }, { "authorizerName": "CustomAuthorizer3", "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer3" } ] } ``` Para obter mais informações, consulte [ListAuthorizers](https://docs.aws.amazon.com/iot/latest/apireference/API_ListAuthorizers.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [ListAuthorizers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-authorizers.html) na *Referência de comandos da AWS CLI*. ### `list-billing-groups` O código de exemplo a seguir mostra como usar `list-billing-groups`. **AWS CLI** **Para listar os grupos de cobrança da sua conta da AWS e região** O exemplo `list-billing-groups` a seguir lista todos os grupos de cobrança definidos para sua conta da AWS e região da AWS. ``` aws iot list-billing-groups ``` Resultado: ``` { "billingGroups": [ { "groupName": "GroupOne", "groupArn": "arn:aws:iot:us-west-2:123456789012:billinggroup/GroupOne" } ] } ``` Para obter mais informações, consulte [Grupos de cobrança](https://docs.aws.amazon.com/iot/latest/developerguide/tagging-iot-billing-groups.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListBillingGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-billing-groups.html) na *Referência de comandos da AWS CLI*. ### `list-ca-certificates` O código de exemplo a seguir mostra como usar `list-ca-certificates`. **AWS CLI** **Para listar os certificados CA registrados em sua conta da AWS**. O exemplo `list-ca-certificates` a seguir lista os certificados CA registrados em sua conta da AWS. ``` aws iot list-ca-certificates ``` Resultado: ``` { "certificates": [ { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cacert/f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467", "certificateId": "f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467", "status": "INACTIVE", "creationDate": 1569365372.053 } ] } ``` Para obter mais informações, consulte [Usar seu próprio certificado](https://docs.aws.amazon.com/iot/latest/developerguide/device-certs-your-own.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListCaCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-ca-certificates.html) na *Referência de comandos da AWS CLI*. ### `list-certificates-by-ca` O código de exemplo a seguir mostra como usar `list-certificates-by-ca`. **AWS CLI** **Para listar todos os certificados de dispositivo assinados com um certificado CA** O exemplo `list-certificates-by-ca` a seguir lista todos os certificados de dispositivo em sua conta da AWS que estão assinados com o certificado CA especificado. ``` aws iot list-certificates-by-ca \ --ca-certificate-id f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467 ``` Resultado: ``` { "certificates": [ { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", "certificateId": "488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", "status": "ACTIVE", "creationDate": 1569363250.557 } ] } ``` Para obter mais informações, consulte [ListCertificatesByCA](https://docs.aws.amazon.com/iot/latest/apireference/API_ListCertificatesByCA.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [ListCertificatesByCa](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-certificates-by-ca.html) na *Referência de comandos da AWS CLI*. ### `list-certificates` O código de exemplo a seguir mostra como usar `list-certificates`. **AWS CLI** **Exemplo 1: listar os certificados registrados em sua conta da AWS**. O exemplo de `list-certificates` a seguir lista os certificados registrados em sua conta. Se o limite de paginação for maior do que o padrão de 25, é possível usar o valor de resposta `nextMarker` desse comando e fornecê-lo ao próximo comando para obter o próximo lote de resultados. Repita até `nextMarker` retornar sem um valor. ``` aws iot list-certificates ``` Resultado: ``` { "certificates": [ { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/604c48437a57b7d5fc5d137c5be75011c6ee67c9a6943683a1acb4b1626bac36", "certificateId": "604c48437a57b7d5fc5d137c5be75011c6ee67c9a6943683a1acb4b1626bac36", "status": "ACTIVE", "creationDate": 1556810537.617 }, { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/262a1ac8a7d8aa72f6e96e365480f7313aa9db74b8339ec65d34dc3074e1c31e", "certificateId": "262a1ac8a7d8aa72f6e96e365480f7313aa9db74b8339ec65d34dc3074e1c31e", "status": "ACTIVE", "creationDate": 1546447050.885 }, { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b", "certificateId": "b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b", "status": "ACTIVE", "creationDate": 1546292258.322 }, { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/7aebeea3845d14a44ec80b06b8b78a89f3f8a706974b8b34d18f5adf0741db42", "certificateId": "7aebeea3845d14a44ec80b06b8b78a89f3f8a706974b8b34d18f5adf0741db42", "status": "ACTIVE", "creationDate": 1541457693.453 }, { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/54458aa39ebb3eb39c91ffbbdcc3a6ca1c7c094d1644b889f735a6fc2cd9a7e3", "certificateId": "54458aa39ebb3eb39c91ffbbdcc3a6ca1c7c094d1644b889f735a6fc2cd9a7e3", "status": "ACTIVE", "creationDate": 1541113568.611 }, { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e", "certificateId": "4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e", "status": "ACTIVE", "creationDate": 1541022751.983 } ] } ``` + Consulte detalhes da API em [ListCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-certificates.html) na *Referência de comandos da AWS CLI*. ### `list-custom-metrics` O código de exemplo a seguir mostra como usar `list-custom-metrics`. **AWS CLI** **Para listar suas métricas personalizadas** O exemplo `list-custom-metrics` a seguir lista todas as suas métricas personalizadas. ``` aws iot list-custom-metrics \ --region us-east-1 ``` Resultado: ``` { "metricNames": [ "batteryPercentage" ] } ``` Para obter mais informações, consulte [Métricas personalizadas](https://docs.aws.amazon.com/iot/latest/developerguide/dd-detect-custom-metrics.html) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [ListCustomMetrics](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-custom-metrics.html) na *Referência de comandos da AWS CLI*. ### `list-dimensions` O código de exemplo a seguir mostra como usar `list-dimensions`. **AWS CLI** **Para listar as dimensões da sua conta da AWS** O exemplo `list-dimensions` a seguir lista todas as dimensões do AWS IoT Device Defender definidas na sua conta da AWS. ``` aws iot list-dimensions ``` Resultado: ``` { "dimensionNames": [ "TopicFilterForAuthMessages", "TopicFilterForActivityMessages" ] } ``` Para obter mais informações, consulte [Comandos do Detect](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListDimensions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-dimensions.html) na *Referência de comandos da AWS CLI*. ### `list-domain-configurations` O código de exemplo a seguir mostra como usar `list-domain-configurations`. **AWS CLI** **Para listar as configurações de domínio** O exemplo `list-domain-configurations` a seguir lista as configurações de domínio em sua conta da AWS que têm o tipo de serviço especificado. ``` aws iot list-domain-configurations \ --service-type "DATA" ``` Resultado: ``` { "domainConfigurations": [ { "domainConfigurationName": "additionalDataDomain", "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/additionalDataDomain/dikMh", "serviceType": "DATA" }, { "domainConfigurationName": "iot:Jobs", "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/iot:Jobs", "serviceType": "JOBS" }, { "domainConfigurationName": "iot:Data-ATS", "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/iot:Data-ATS", "serviceType": "DATA" }, { "domainConfigurationName": "iot:CredentialProvider", "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/iot:CredentialProvider", "serviceType": "CREDENTIAL_PROVIDER" } ] } ``` Para obter mais informações, consulte [Endpoints configuráveis](https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-endpoints-configurable-aws.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListDomainConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-domain-configurations.html) na *Referência de comandos da AWS CLI*. ### `list-indices` O código de exemplo a seguir mostra como usar `list-indices`. **AWS CLI** **Para listar os índices de pesquisa configurados** O exemplo `list-indices` a seguir lista todos os índices de pesquisa configurados em sua conta da AWS. Se a indexação de itens não foi ativada, talvez não haja nenhum índice. ``` aws iot list-indices ``` Resultado: ``` { "indexNames": [ "AWS_Things" ] } ``` Para obter mais informações, consulte [Gerenciar indexações de itens](https://docs.aws.amazon.com/iot/latest/developerguide/managing-index.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListIndices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-indices.html) na *Referência de comandos da AWS CLI*. ### `list-job-executions-for-job` O código de exemplo a seguir mostra como usar `list-job-executions-for-job`. **AWS CLI** **Para listar os trabalhos em sua conta da AWS** O exemplo `list-job-executions-for-job` a seguir lista todas as execuções de um trabalho em sua contaAWS, especificados pelo jobID. ``` aws iot list-job-executions-for-job \ --job-id my-ota-job ``` Resultado: ``` { "executionSummaries": [ { "thingArn": "arn:aws:iot:us-east-1:123456789012:thing/my_thing", "jobExecutionSummary": { "status": "QUEUED", "queuedAt": "2022-03-07T15:58:42.195000-08:00", "lastUpdatedAt": "2022-03-07T15:58:42.195000-08:00", "executionNumber": 1, "retryAttempt": 0 } } ] } ``` Para obter mais informações, consulte [Criar e gerenciar trabalhos (CLI)](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListJobExecutionsForJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-job-executions-for-job.html) na *Referência de comandos da AWS CLI*. ### `list-job-executions-for-thing` O código de exemplo a seguir mostra como usar `list-job-executions-for-thing`. **AWS CLI** **Para listar os trabalhos que executados para um item** O exemplo `list-job-executions-for-thing` a seguir lista todos os trabalhos que foram executados para o item chamado`MyRaspberryPi`. ``` aws iot list-job-executions-for-thing \ --thing-name "MyRaspberryPi" ``` Resultado: ``` { "executionSummaries": [ { "jobId": "example-job-01", "jobExecutionSummary": { "status": "QUEUED", "queuedAt": 1560787023.636, "lastUpdatedAt": 1560787023.636, "executionNumber": 1 } } ] } ``` Para obter mais informações, consulte [Criar e gerenciar trabalhos (CLI)](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListJobExecutionsForThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-job-executions-for-thing.html) na *Referência de comandos da AWS CLI*. ### `list-jobs` O código de exemplo a seguir mostra como usar `list-jobs`. **AWS CLI** **Para listar os trabalhos em sua conta da AWS** O exemplo `list-jobs` a seguir lista todos os trabalhos em sua conta da AWS classificados pelo status do trabalho. ``` aws iot list-jobs ``` Resultado: ``` { "jobs": [ { "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01", "jobId": "example-job-01", "targetSelection": "SNAPSHOT", "status": "IN_PROGRESS", "createdAt": 1560787022.733, "lastUpdatedAt": 1560787026.294 } ] } ``` Para obter mais informações, consulte [Criar e gerenciar trabalhos (CLI)](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html) no *Guia do desenvolvedor do AWS IoT*. + Consulte detalhes da API em [ListJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-jobs.html) na *Referência de comandos da AWS CLI*. ### `list-mitigation-actions` O código de exemplo a seguir mostra como usar `list-mitigation-actions`. **AWS CLI** **Para listar todas as ações de mitigação definidas** O exemplo `list-mitigation-actions` a seguir lista todas as ações de mitigação definidas para sua região e conta da AWS. Para cada ação, o nome, o ARN e a data de criação são listados. ``` aws iot list-mitigation-actions ``` Resultado: ``` { "actionIdentifiers": [ { "actionName": "DeactivateCACertAction", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/DeactivateCACertAction", "creationDate": "2019-12-10T11:12:47.574000-08:00" }, { "actionName": "ResetPolicyVersionAction", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/ResetPolicyVersionAction", "creationDate": "2019-12-10T11:11:48.920000-08:00" }, { "actionName": "PublishFindingToSNSAction", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/PublishFindingToSNSAction", "creationDate": "2019-12-10T11:10:49.546000-08:00" }, { "actionName": "AddThingsToQuarantineGroupAction", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroupAction", "creationDate": "2019-12-10T11:09:35.999000-08:00" }, { "actionName": "UpdateDeviceCertAction", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/UpdateDeviceCertAction", "creationDate": "2019-12-10T11:08:44.263000-08:00" }, { "actionName": "SampleMitigationAction", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/SampleMitigationAction", "creationDate": "2019-12-10T11:03:41.840000-08:00" } ] } ``` Para obter mais informações, consulte [ListMitigationActions (Comandos de ação de mitigação)](https://docs.aws.amazon.com/iot/latest/developerguide/mitigation-action-commands.html#dd-api-iot-ListMitigationActions) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListMitigationActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-mitigation-actions.html) na *Referência de comandos da AWS CLI*. ### `list-mitigations-actions` O código de exemplo a seguir mostra como usar `list-mitigations-actions`. **AWS CLI** **Para listar todas as ações de mitigação definidas** O exemplo `list-mitigations-actions` a seguir lista todas as ações de mitigação definidas para sua região e conta da AWS. Para cada ação, o nome, o ARN e a data de criação são listados. ``` aws iot list-mitigation-actions ``` Resultado: ``` { "actionIdentifiers": [ { "actionName": "DeactivateCACertAction", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/DeactivateCACertAction", "creationDate": "2019-12-10T11:12:47.574000-08:00" }, { "actionName": "ResetPolicyVersionAction", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/ResetPolicyVersionAction", "creationDate": "2019-12-10T11:11:48.920000-08:00" }, { "actionName": "PublishFindingToSNSAction", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/PublishFindingToSNSAction", "creationDate": "2019-12-10T11:10:49.546000-08:00" }, { "actionName": "AddThingsToQuarantineGroupAction", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroupAction", "creationDate": "2019-12-10T11:09:35.999000-08:00" }, { "actionName": "UpdateDeviceCertAction", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/UpdateDeviceCertAction", "creationDate": "2019-12-10T11:08:44.263000-08:00" }, { "actionName": "SampleMitigationAction", "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/SampleMitigationAction", "creationDate": "2019-12-10T11:03:41.840000-08:00" } ] } ``` Para obter mais informações, consulte [ListMitigationActions (Comandos de ação de mitigação)](https://docs.aws.amazon.com/iot/latest/developerguide/mitigation-action-commands.html#dd-api-iot-ListMitigationActions) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListMitigationsActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-mitigations-actions.html) na *Referência de comandos da AWS CLI*. ### `list-ota-updates` O código de exemplo a seguir mostra como usar `list-ota-updates`. **AWS CLI** **Para listar atualizações OTA para a conta** O exemplo `list-ota-updates` a seguir lista as atualizações OTA disponíveis. ``` aws iot list-ota-updates ``` Resultado: ``` { "otaUpdates": [ { "otaUpdateId": "itsaupdate", "otaUpdateArn": "arn:aws:iot:us-west-2:123456789012:otaupdate/itsaupdate", "creationDate": 1557863215.995 } ] } ``` Para obter mais informações, consulte [ListOTAUpdates](https://docs.aws.amazon.com/iot/latest/apireference/API_ListOTAUpdates.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [ListOtaUpdates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-ota-updates.html) na *Referência de comandos da AWS CLI*. ### `list-outgoing-certificates` O código de exemplo a seguir mostra como usar `list-outgoing-certificates`. **AWS CLI** **Para listar os certificados que estão sendo transferidos para uma conta da AWS diferente** O exemplo `list-outgoing-certificates` a seguir lista todos os certificados de dispositivo que estão sendo transferidos para uma conta da AWS diferente usando o comando `transfer-certificate`. ``` aws iot list-outgoing-certificates ``` Resultado: ``` { "outgoingCertificates": [ { "certificateArn": "arn:aws:iot:us-west-2:030714055129:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", "certificateId": "488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", "transferredTo": "030714055129", "transferDate": 1569427780.441, "creationDate": 1569363250.557 } ] } ``` Para obter mais informações, consulte [ListOutgoingCertificates](https://docs.aws.amazon.com/iot/latest/apireference/API_ListOutgoingCertificates.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [ListOutgoingCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-outgoing-certificates.html) na *Referência de comandos da AWS CLI*. ### `list-policies` O código de exemplo a seguir mostra como usar `list-policies`. **AWS CLI** **Para listar as políticas definidas em sua conta da AWS** O exemplo `list-policies` a seguir lista todas as políticas definidas em sua conta da AWS. ``` aws iot list-policies ``` Resultado: ``` { "policies": [ { "policyName": "UpdateDeviceCertPolicy", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy" }, { "policyName": "PlantIoTPolicy", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/PlantIoTPolicy" }, { "policyName": "MyPiGroup_Core-policy", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/MyPiGroup_Core-policy" } ] } ``` Para obter mais informações, consulte [Políticas do AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) no *Guia do desenvolvedor do AWS IoT*. + Consulte detalhes da API em [ListPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-policies.html) na *Referência de comandos da AWS CLI*. ### `list-policy-versions` O código de exemplo a seguir mostra como usar `list-policy-versions`. **AWS CLI** **Exemplo 1: ver todas as versões de uma política** O exemplo `list-policy-versions` a seguir lista todas as versões da política especificada e suas datas de criação. ``` aws iot list-policy-versions \ --policy-name LightBulbPolicy ``` Resultado: ``` { "policyVersions": [ { "versionId": "2", "isDefaultVersion": true, "createDate": 1559925941.924 }, { "versionId": "1", "isDefaultVersion": false, "createDate": 1559925941.924 } ] } ``` Para obter mais informações, consulte [Políticas do AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) no *Guia do desenvolvedor do AWS IoT*. + Consulte detalhes da API em [ListPolicyVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-policy-versions.html) na *Referência de comandos da AWS CLI*. ### `list-principal-things` O código de exemplo a seguir mostra como usar `list-principal-things`. **AWS CLI** **Para listar os itens anexados a uma entidade principal** O exemplo `list-principal-things` a seguir lista os itens anexados à entidade principal especificados por um ARN. ``` aws iot list-principal-things \ --principal arn:aws:iot:us-west-2:123456789012:cert/2e1eb273792174ec2b9bf4e9b37e6c6c692345499506002a35159767055278e8 ``` Resultado: ``` { "things": [ "DeskLamp", "TableLamp" ] } ``` Para obter mais informações, consulte [ListPrincipalThings](https://docs.aws.amazon.com/iot/latest/apireference/API_ListPrincipleThings.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [ListPrincipalThings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-principal-things.html) na *Referência de comandos da AWS CLI*. ### `list-provisioning-template-versions` O código de exemplo a seguir mostra como usar `list-provisioning-template-versions`. **AWS CLI** **Para listar as versões do modelo de provisionamento** O exemplo `list-provisioning-template-versions` a seguir lista as versões disponíveis do modelo de provisionamento especificado. ``` aws iot list-provisioning-template-versions \ --template-name "widget-template" ``` Resultado: ``` { "versions": [ { "versionId": 1, "creationDate": 1574800471.339, "isDefaultVersion": true }, { "versionId": 2, "creationDate": 1574801192.317, "isDefaultVersion": false } ] } ``` Para obter mais informações, consulte [AWS IoT Secure Tunneling](https://docs.aws.amazon.com/iot/latest/developerguide/secure-tunneling.html) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [ListProvisioningTemplateVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-provisioning-template-versions.html) na *Referência de comandos da AWS CLI*. ### `list-provisioning-templates` O código de exemplo a seguir mostra como usar `list-provisioning-templates`. **AWS CLI** **Para listar modelos de provisionamento** O exemplo `list-provisioning-templates` a seguir lista todos os modelos de provisionamento em sua conta da AWS. ``` aws iot list-provisioning-templates ``` Resultado: ``` { "templates": [ { "templateArn": "arn:aws:iot:us-east-1:123456789012:provisioningtemplate/widget-template", "templateName": "widget-template", "description": "A provisioning template for widgets", "creationDate": 1574800471.367, "lastModifiedDate": 1574801192.324, "enabled": false } ] } ``` Para obter mais informações, consulte [AWS IoT Secure Tunneling](https://docs.aws.amazon.com/iot/latest/developerguide/secure-tunneling.html) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [ListProvisioningTemplates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-provisioning-templates.html) na *Referência de comandos da AWS CLI*. ### `list-role-aliases` O código de exemplo a seguir mostra como usar `list-role-aliases`. **AWS CLI** **Para listar os aliases da função do AWS IoT em sua conta da AWS** O exemplo `list-role-aliases` a seguir lista os aliases da função do AWS IoT em sua conta da AWS. ``` aws iot list-role-aliases ``` Resultado: ``` { "roleAliases": [ "ResidentAlias", "ElectricianAlias" ] } ``` Para obter mais informações, consulte [ListRoleAliases](https://docs.aws.amazon.com/iot/latest/apireference/API_ListRoleAliases.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [ListRoleAliases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-role-aliases.html) na *Referência de comandos da AWS CLI*. ### `list-scheduled-audits` O código de exemplo a seguir mostra como usar `list-scheduled-audits`. **AWS CLI** **Para listar as auditorias programadas para sua conta da AWS** O exemplo `list-scheduled-audits` a seguir lista todas as auditorias programadas para sua conta da AWS. ``` aws iot list-scheduled-audits ``` Resultado: ``` { "scheduledAudits": [ { "scheduledAuditName": "AWSIoTDeviceDefenderDailyAudit", "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/AWSIoTDeviceDefenderDailyAudit", "frequency": "DAILY" }, { "scheduledAuditName": "AWSDeviceDefenderWeeklyAudit", "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/AWSDeviceDefenderWeeklyAudit", "frequency": "WEEKLY", "dayOfWeek": "SUN" } ] } ``` Para obter mais informações, consulte [Comandos de auditoria](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListScheduledAudits](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-scheduled-audits.html) na *Referência de comandos da AWS CLI*. ### `list-security-profiles-for-target` O código de exemplo a seguir mostra como usar `list-security-profiles-for-target`. **AWS CLI** **Para listar os perfis de segurança anexados a um alvo** O exemplo `list-security-profiles-for-target` a seguir lista os perfis de segurança do AWS IoT Device Defender que estão conectados a dispositivos não registrados. ``` aws iot list-security-profiles-for-target \ --security-profile-target-arn "arn:aws:iot:us-west-2:123456789012:all/unregistered-things" ``` Resultado: ``` { "securityProfileTargetMappings": [ { "securityProfileIdentifier": { "name": "Testprofile", "arn": "arn:aws:iot:us-west-2:123456789012:securityprofile/Testprofile" }, "target": { "arn": "arn:aws:iot:us-west-2:123456789012:all/unregistered-things" } } ] } ``` Para obter mais informações, consulte [Comandos do Detect](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListSecurityProfilesForTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-security-profiles-for-target.html) na *Referência de comandos da AWS CLI*. ### `list-security-profiles` O código de exemplo a seguir mostra como usar `list-security-profiles`. **AWS CLI** **Para listar os perfis de segurança da sua conta da AWS** O exemplo `list-security-profiles` a seguir lista todos os perfis de segurança do AWS IoT Device Defender definidas na sua conta da AWS. ``` aws iot list-security-profiles ``` Resultado: ``` { "securityProfileIdentifiers": [ { "name": "Testprofile", "arn": "arn:aws:iot:us-west-2:123456789012:securityprofile/Testprofile" } ] } ``` Para obter mais informações, consulte [Comandos do Detect](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListSecurityProfiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-security-profiles.html) na *Referência de comandos da AWS CLI*. ### `list-streams` O código de exemplo a seguir mostra como usar `list-streams`. **AWS CLI** **Para listar os fluxos na conta** O exemplo `list-streams` a seguir lista todos fluxos em sua conta da AWS. ``` aws iot list-streams ``` Resultado: ``` { "streams": [ { "streamId": "stream12345", "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream12345", "streamVersion": 1, "description": "This stream is used for Amazon FreeRTOS OTA Update 12345." }, { "streamId": "stream54321", "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream54321", "streamVersion": 1, "description": "This stream is used for Amazon FreeRTOS OTA Update 54321." } ] } ``` Para obter mais informações, consulte [ListStreams](https://docs.aws.amazon.com/iot/latest/apireference/API_ListStreams.html) na *Referência da API do AWS IoT*. + Consulte detalhes da API em [ListStreams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-streams.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Como exibir as tags e seus valores associados a um recurso** O exemplo `list-tags-for-resource` a seguir exibe as tags e os valores associados ao grupo de itens `LightBulbs`. ``` aws iot list-tags-for-resource \ --resource-arn "arn:aws:iot:us-west-2:094249569039:thinggroup/LightBulbs" ``` Resultado: ``` { "tags": [ { "Key": "Assembly", "Value": "Fact1NW" }, { "Key": "MyTag", "Value": "777" } ] } ``` Para obter mais informações, consulte [Adicionar tags aos recursos do AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/tagging-iot.html), no *Guia do Desenvolvedor do AWS IoT*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `list-targets-for-policy` O código de exemplo a seguir mostra como usar `list-targets-for-policy`. **AWS CLI** **Para listar as entidades principais associadas a uma política do AWS IoT** O exemplo `list-targets-for-policy` a seguir lista os certificados de dispositivo aos quais a política especificada está anexada. ``` aws iot list-targets-for-policy \ --policy-name UpdateDeviceCertPolicy ``` Resultado: ``` { "targets": [ "arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", "arn:aws:iot:us-west-2:123456789012:cert/d1eb269fb55a628552143c8f96eb3c258fcd5331ea113e766ba0c82bf225f0be" ] } ``` Para obter mais informações, consulte [Grupos de itens](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListTargetsForPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-targets-for-policy.html) na *Referência de comandos da AWS CLI*. ### `list-targets-for-security-profile` O código de exemplo a seguir mostra como usar `list-targets-for-security-profile`. **AWS CLI** **Para listar os alvos aos quais um perfil de segurança é aplicado** O exemplo `list-targets-for-security-profile` a seguir lista os alvos aos quais o perfil de segurança do AWS IoT Device Defender chamado `PossibleIssue` é aplicado. ``` aws iot list-targets-for-security-profile \ --security-profile-name Testprofile ``` Resultado: ``` { "securityProfileTargets": [ { "arn": "arn:aws:iot:us-west-2:123456789012:all/unregistered-things" }, { "arn": "arn:aws:iot:us-west-2:123456789012:all/registered-things" } ] } ``` Para obter mais informações, consulte [Comandos do Detect](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListTargetsForSecurityProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-targets-for-security-profile.html) na *Referência de comandos da AWS CLI*. ### `list-thing-groups-for-thing` O código de exemplo a seguir mostra como usar `list-thing-groups-for-thing`. **AWS CLI** **Para listar os grupos aos quais um item pertence** O exemplo `list-thing-groups-for-thing` a seguir lista os grupos aos quais o item especificado pertence. ``` aws iot list-thing-groups-for-thing \ --thing-name MyLightBulb ``` Resultado: ``` { "thingGroups": [ { "groupName": "DeadBulbs", "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/DeadBulbs" }, { "groupName": "LightBulbs", "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" } ] } ``` Para obter mais informações, consulte [Grupos de itens](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListThingGroupsForThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-thing-groups-for-thing.html) na *Referência de comandos da AWS CLI*. ### `list-thing-groups` O código de exemplo a seguir mostra como usar `list-thing-groups`. **AWS CLI** **Para listar os grupos de itens em sua conta da AWS** O exemplo `describe-thing-group` a seguir lista todos os grupos de itens definidos em sua conta da AWS. ``` aws iot list-thing-groups ``` Resultado: ``` { "thingGroups": [ { "groupName": "HalogenBulbs", "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/HalogenBulbs" }, { "groupName": "LightBulbs", "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" } ] } ``` Para obter mais informações, consulte [Grupos de itens](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListThingGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-thing-groups.html) na *Referência de comandos da AWS CLI*. ### `list-thing-principals` O código de exemplo a seguir mostra como usar `list-thing-principals`. **AWS CLI** **As entidades principais associadas ao item.** O exemplo `list-thing-principals` a seguir lista as entidades principais (certificados X.509, usuários do IAM, grupos, perfis, identidades do Amazon Cognito ou identidades federadas) associados ao item especificado. ``` aws iot list-thing-principals \ --thing-name MyRaspberryPi ``` Resultado: ``` { "principals": [ "arn:aws:iot:us-west-2:123456789012:cert/33475ac865079a5ffd5ecd44240640349293facc760642d7d8d5dbb6b4c86893" ] } ``` Para obter mais informações, consulte [ListThingPrincipals](https://docs.aws.amazon.com/iot/latest/apireference/API_ListThingPrincipals.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [ListThingPrincipals](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-thing-principals.html) na *Referência de comandos da AWS CLI*. ### `list-thing-types` O código de exemplo a seguir mostra como usar `list-thing-types`. **AWS CLI** **Para listar os tipos de itens definidos** O exemplo `list-thing-types` a seguir lista todos os grupos de itens definidos em sua conta da AWS. ``` aws iot list-thing-types ``` Resultado: ``` { "thingTypes": [ { "thingTypeName": "LightBulb", "thingTypeArn": "arn:aws:iot:us-west-2:123456789012:thingtype/LightBulb", "thingTypeProperties": { "thingTypeDescription": "light bulb type", "searchableAttributes": [ "model", "wattage" ] }, "thingTypeMetadata": { "deprecated": false, "creationDate": 1559772562.498 } } ] } ``` Para obter mais informações, consulte [Tipos de itens](https://docs.aws.amazon.com/iot/latest/developerguide/thing-types.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListThingTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-thing-types.html) na *Referência de comandos da AWS CLI*. ### `list-things-in-billing-group` O código de exemplo a seguir mostra como usar `list-things-in-billing-group`. **AWS CLI** **Para listar os itens em um grupo de cobrança** O exemplo `list-things-in-billing-group` a seguir lista os itens que no grupo de cobrança especificado. ``` aws iot list-things-in-billing-group \ --billing-group-name GroupOne ``` Resultado: ``` { "things": [ "MyOtherLightBulb", "MyLightBulb" ] } ``` Para obter mais informações, consulte [Grupos de cobrança](https://docs.aws.amazon.com/iot/latest/developerguide/tagging-iot-billing-groups.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListThingsInBillingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-things-in-billing-group.html) na *Referência de comandos da AWS CLI*. ### `list-things-in-thing-group` O código de exemplo a seguir mostra como usar `list-things-in-thing-group`. **AWS CLI** **Para listar os itens que pertencem a um grupo** O exemplo `list-things-in-thing-group` a seguir lista os itens que pertencem ao grupo de itens especificado. ``` aws iot list-things-in-thing-group \ --thing-group-name LightBulbs ``` Resultado: ``` { "things": [ "MyLightBulb" ] } ``` Para obter mais informações, consulte [Grupos de itens](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListThingsInThingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-things-in-thing-group.html) na *Referência de comandos da AWS CLI*. ### `list-things` O código de exemplo a seguir mostra como usar `list-things`. **AWS CLI** **Exemplo 1: listar todas os itens do registro** O exemplo de `list-things` a seguir lista os itens (dispositivos) que estão definidos no registro do AWS IoT da conta da AWS. ``` aws iot list-things ``` Resultado: ``` { "things": [ { "thingName": "ThirdBulb", "thingTypeName": "LightBulb", "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/ThirdBulb", "attributes": { "model": "123", "wattage": "75" }, "version": 2 }, { "thingName": "MyOtherLightBulb", "thingTypeName": "LightBulb", "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyOtherLightBulb", "attributes": { "model": "123", "wattage": "75" }, "version": 3 }, { "thingName": "MyLightBulb", "thingTypeName": "LightBulb", "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb", "attributes": { "model": "123", "wattage": "75" }, "version": 1 }, { "thingName": "SampleIoTThing", "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/SampleIoTThing", "attributes": {}, "version": 1 } ] } ``` **Exemplo 2: como listar os itens definidos que possuem um atributo específico** O exemplo de `list-things` a seguir exibe uma lista dos itens que têm um atributo chamado `wattage`. ``` aws iot list-things \ --attribute-name wattage ``` Resultado: ``` { "things": [ { "thingName": "MyLightBulb", "thingTypeName": "LightBulb", "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb", "attributes": { "model": "123", "wattage": "75" }, "version": 1 }, { "thingName": "MyOtherLightBulb", "thingTypeName": "LightBulb", "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyOtherLightBulb", "attributes": { "model": "123", "wattage": "75" }, "version": 3 } ] } ``` Para acessar mais informações, consulte [Como gerenciar objetos com o registro](https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html) no *Guia do desenvolvedor do AWS IoT*. + Consulte detalhes da API em [ListThings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-things.html) na *Referência de comandos da AWS CLI*. ### `list-topic-rule-destinations` O código de exemplo a seguir mostra como usar `list-topic-rule-destinations`. **AWS CLI** **Para listar seus destinos de regras de tópicos** O exemplo `list-topic-rule-destinations` a seguir lista todos os destinos de regras de tópicos definidas na região da AWS atual. ``` aws iot list-topic-rule-destinations ``` Resultado: ``` { "destinationSummaries": [ { "arn": "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "status": "ENABLED", "httpUrlSummary": { "confirmationUrl": "https://example.com" } } ] } ``` Para obter mais informações, consulte [Trabalhar com destinos de tópicos](https://docs.aws.amazon.com/iot/latest/developerguide/rule-destination.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListTopicRuleDestinations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-topic-rule-destinations.html) na *Referência de comandos da AWS CLI*. ### `list-topic-rules` O código de exemplo a seguir mostra como usar `list-topic-rules`. **AWS CLI** **Para listar suas regras** O exemplo `list-topic-rules` a seguir lista todas as regras definidas. ``` aws iot list-topic-rules ``` Resultado: ``` { "rules": [ { "ruleArn": "arn:aws:iot:us-west-2:123456789012:rule/MyRPiLowMoistureAlertRule", "ruleName": "MyRPiLowMoistureAlertRule", "topicPattern": "$aws/things/MyRPi/shadow/update/accepted", "createdAt": 1558624363.0, "ruleDisabled": false }, { "ruleArn": "arn:aws:iot:us-west-2:123456789012:rule/MyPlantPiMoistureAlertRule", "ruleName": "MyPlantPiMoistureAlertRule", "topicPattern": "$aws/things/MyPlantPi/shadow/update/accepted", "createdAt": 1541458459.0, "ruleDisabled": false } ] } ``` Para obter mais informações, consulte [Visualizando as regras](https://docs.aws.amazon.com/iot/latest/developerguide/iot-managae-rule.html#iot-view-rules) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListTopicRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-topic-rules.html) na *Referência de comandos da AWS CLI*. ### `list-v2-logging-levels` O código de exemplo a seguir mostra como usar `list-v2-logging-levels`. **AWS CLI** **Para listar os níveis de log** O exemplo `list-v2-logging-levels` a seguir lista os níveis de log configurados. Se os níveis de log não foram definidos, um `NotConfiguredException` ocorre ao executar esse comando. ``` aws iot list-v2-logging-levels ``` Resultado: ``` { "logTargetConfigurations": [ { "logTarget": { "targetType": "DEFAULT" }, "logLevel": "ERROR" } ] } ``` + Para ver detalhes da API, consulte [ListV2LoggingLevels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-v2-logging-levels.html) na *Referência de comandos da AWS CLI*. ### `list-violation-events` O código de exemplo a seguir mostra como usar `list-violation-events`. **AWS CLI** **Para listar as violações do perfil de segurança durante um período** O exemplo `list-violation-events` a seguir lista as violações que ocorreram entre 5 de junho de 2019 e 12 de junho de 2019 para todos os perfis de segurança do AWS IoT Device Defender da conta da AWS atual e da região da AWS. ``` aws iot list-violation-events \ --start-time 1559747125 \ --end-time 1560351925 ``` Resultado: ``` { "violationEvents": [ { "violationId": "174db59167fa474c80a652ad1583fd44", "thingName": "iotconsole-1560269126751-1", "securityProfileName": "Testprofile", "behavior": { "name": "Authorization", "metric": "aws:num-authorization-failures", "criteria": { "comparisonOperator": "greater-than", "value": { "count": 10 }, "durationSeconds": 300, "consecutiveDatapointsToAlarm": 1, "consecutiveDatapointsToClear": 1 } }, "metricValue": { "count": 0 }, "violationEventType": "in-alarm", "violationEventTime": 1560279000.0 }, { "violationId": "c8a9466a093d3b7b35cd44ca58bdbeab", "thingName": "TvnQoEoU", "securityProfileName": "Testprofile", "behavior": { "name": "CellularBandwidth", "metric": "aws:message-byte-size", "criteria": { "comparisonOperator": "greater-than", "value": { "count": 128 }, "consecutiveDatapointsToAlarm": 1, "consecutiveDatapointsToClear": 1 } }, "metricValue": { "count": 110 }, "violationEventType": "in-alarm", "violationEventTime": 1560276600.0 }, { "violationId": "74aa393adea02e6648f3ac362beed55e", "thingName": "iotconsole-1560269232412-2", "securityProfileName": "Testprofile", "behavior": { "name": "Authorization", "metric": "aws:num-authorization-failures", "criteria": { "comparisonOperator": "greater-than", "value": { "count": 10 }, "durationSeconds": 300, "consecutiveDatapointsToAlarm": 1, "consecutiveDatapointsToClear": 1 } }, "metricValue": { "count": 0 }, "violationEventType": "in-alarm", "violationEventTime": 1560276600.0 }, { "violationId": "1e6ab5f7cf39a1466fcd154e1377e406", "thingName": "TvnQoEoU", "securityProfileName": "Testprofile", "behavior": { "name": "Authorization", "metric": "aws:num-authorization-failures", "criteria": { "comparisonOperator": "greater-than", "value": { "count": 10 }, "durationSeconds": 300, "consecutiveDatapointsToAlarm": 1, "consecutiveDatapointsToClear": 1 } }, "metricValue": { "count": 0 }, "violationEventType": "in-alarm", "violationEventTime": 1560276600.0 } ] } ``` Para obter mais informações, consulte [Comandos do Detect](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListViolationEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-violation-events.html) na *Referência de comandos da AWS CLI*. ### `register-ca-certificate` O código de exemplo a seguir mostra como usar `register-ca-certificate`. **AWS CLI** **Para registrar um certificado de autoridade de certificação (CA)** O exemplo `register-ca-certificate` a seguir registra um certificado CA. O comando fornece o certificado CA e um certificado de verificação de chave que prova a posse da chave privada associada ao certificado CA. ``` aws iot register-ca-certificate \ --ca-certificate file://rootCA.pem \ --verification-cert file://verificationCert.pem ``` Resultado: ``` { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cacert/f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467", "certificateId": "f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467" } ``` Para obter mais informações, consulte [RegisterCACertificate](https://docs.aws.amazon.com/iot/latest/apireference/API_RegisterCACertificate.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [RegisterCaCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/register-ca-certificate.html) na *Referência de comandos da AWS CLI*. ### `register-certificate` O código de exemplo a seguir mostra como usar `register-certificate`. **AWS CLI** **Para registrar um certificado de dispositivo autoassinado** O exemplo `register-certificate` a seguir registra o certificado do dispositivo `deviceCert.pem` assinado pelo certificado CA `rootCA.pem`. O certificado CA deve ser registrado antes de ser usado para registrar um certificado de dispositivo autoassinado. O certificado autoassinado deve ser assinado pelo mesmo certificado CA passado para esse comando. ``` aws iot register-certificate \ --certificate-pem file://deviceCert.pem \ --ca-certificate-pem file://rootCA.pem ``` Resultado: ``` { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", "certificateId": "488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142" } ``` Para obter mais informações, consulte [RegisterCertificate](https://docs.aws.amazon.com/iot/latest/apireference/API_RegisterCertificate.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [RegisterCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/register-certificate.html) na *Referência de comandos da AWS CLI*. ### `register-thing` O código de exemplo a seguir mostra como usar `register-thing`. **AWS CLI** **Para registrar um item** O exemplo `register-thing` a seguir registra um item usando um modelo de provisionamento. ``` aws iot register-thing \ --template-body '{"Parameters":{"ThingName":{"Type":"String"},"AWS::IoT::Certificate::Id":{"Type":"String"}},"Resources": {"certificate":{"Properties":{"CertificateId":{"Ref":"AWS::IoT::Certificate::Id"},"Status":"Active"},"Type":"AWS::IoT::Certificate"},"policy":{"Properties":{"PolicyName":"MyIotPolicy"},"Type":"AWS::IoT::Policy"},"thing":{"OverrideSettings":{"AttributePayload":"MERGE","ThingGroups":"DO_NOTHING","ThingTypeName":"REPLACE"},"Properties":{"AttributePayload":{},"ThingGroups":[],"ThingName":{"Ref":"ThingName"},"ThingTypeName":"VirtualThings"},"Type":"AWS::IoT::Thing"}}}' \ --parameters '{"ThingName":"Register-thing-trial-1","AWS::IoT::Certificate::Id":"799a9ea048a1e6aea42b55EXAMPLEf8697b4bafcd77a318a3068e30404b9233c"}' ``` Resultado: ``` { "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDWTCCAkGgAwIBAgIUYLk81I35cIppobpw HiOJ2jNjboIwDQYJKoZIhvcNAQEL\nBQAwTTFLMEkGA1UECwxCQW1hem9uIFdlYiBTZXJ2aWNlcyBPPUFtYXpvbi 5jb20g\nSW5jLiBMPVNlYXR0bGUgU1Q9V2FzaGluZ3RvbiBDPVVTMB4XDTIwMDcyMzE2NDUw\nOVoXDTQ5MTIzMT IzNTk1OVowHjEcMBoGA1UEAwwTQVdTIElvVCBDZXJ0aWZpY2F0\nZTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCC AQoCggEBAO71uADhdBajqTmgrMV5\nmCFfBZQRMo1MdtVoZr2X+M4MzL+RARrtUzH9a2SMAckeX8KeblIOTKzORI RDXnyE\n6lVOwjgAsd0ku22rFxex4eG2ikha7pYYkvuToqA7L3TxItRvfKrxRI4ZfJoFPip4\nKqiuBJVNOGKTcQ Hd1RNOrddwwu6kFJLeKDmEXAMPLEdUF0N+qfR9yKnZQkm+g6Q2\nGXu7u0W3hn6nlRN8qVoka0uW12p53xM7oHVz Gf+cxKBxlbOhGkp6yCfTSkUBm3Sp\n9zLw35kiHXVm4EVpwgNlnk6XcIGIkw8a/iy4pzmvuGAANY1/uU/zgCjymw ZT5S30\nBV0CAwEAAaNgMF4wHwYDVR0jBBgwFoAUGx0tCcU3q2n1WXAuUCv6hugXjKswHQYD\nVR0OBBYEFOVtvZ 9Aj2RYFnkX7Iu01XTRUdxgMAwGA1UdEwEB/wQCMAAwDgYDVR0P\nAQH/BAQDAgeAMA0GCSqGSIb3DQEBCwUAA4IB AQCXCQcpOtubS5ftOsDMTcpP/jNX\nDHyArxmjpSc2aCdmm7WX59lTKWyAdxGAvqaDVWqTo0oXI7tZ8w7aINlGi5 pXnifx\n3SBebMUoBbTktrC97yUaeL025mCFv8emDnTR/fE7PTsBKjW0g/rrfpwBxZLXDFwN\nnqkQjy3EDfifj2 6j0xYIqqWMPogyn4srOCKynS5wMJuQZlHQOnabVwnwK4Y0Mflp\np9+4susFUR9aT3BT1AcIwqSpzhlKhh4Iz7ND kRn4amsUT210jg/zOO1Ow+BTHcVQ\nJly8XDu0CWSu04q6SnaBzHmlySIajxuRTP/AdfRouP1OXe+qlbPOBcvVvF 8o\n-----END CERTIFICATE-----\n", "resourceArns": { "certificate": "arn:aws:iot:us-west-2:571032923833:cert/799a9ea048a1e6aea42b55EXAMPLEf8697b4bafcd77a318a3068e30404b9233c", "thing": "arn:aws:iot:us-west-2:571032923833:thing/Register-thing-trial-1" } } ``` Para obter mais informações, consulte [Provisionamento por usuário confiável](https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#trusted-user) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [RegisterThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/register-thing.html) na *Referência de comandos da AWS CLI*. ### `reject-certificate-transfer` O código de exemplo a seguir mostra como usar `reject-certificate-transfer`. **AWS CLI** **Como aceitar ou rejeitar uma transferência de certificado** O exemplo `reject-certificate-transfer` a seguir rejeita a transferência do certificado do dispositivo especificado de outra conta da AWS. ``` aws iot reject-certificate-transfer \ --certificate-id f0f33678c7c9a046e5cc87b2b1a58dfa0beec26db78addd5e605d630e05c7fc8 ``` Este comando não produz saída. Para obter mais informações, consulte [Transferir um certificado para outra conta](https://docs.aws.amazon.com/iot/latest/developerguide/transfer-cert.html) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [RejectCertificateTransfer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/reject-certificate-transfer.html) na *Referência de comandos da AWS CLI*. ### `remove-thing-from-billing-group` O código de exemplo a seguir mostra como usar `remove-thing-from-billing-group`. **AWS CLI** **Para remover um item de um grupo de cobrança** O exemplo `remove-thing-from-billing-group` a seguir remove os itens especificados de um grupo de cobrança. ``` aws iot remove-thing-from-billing-group \ --billing-group-name GroupOne \ --thing-name MyOtherLightBulb ``` Este comando não produz saída. Para obter mais informações, consulte [Grupos de cobrança](https://docs.aws.amazon.com/iot/latest/developerguide/tagging-iot-billing-groups.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [RemoveThingFromBillingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/remove-thing-from-billing-group.html) na *Referência de comandos da AWS CLI*. ### `remove-thing-from-thing-group` O código de exemplo a seguir mostra como usar `remove-thing-from-thing-group`. **AWS CLI** **Para remover um item de um grupo de itens** O exemplo `remove-thing-from-thing-group` a seguir remove o item especificado de um grupo de itens. ``` aws iot remove-thing-from-thing-group \ --thing-name bulb7 \ --thing-group-name DeadBulbs ``` Este comando não produz saída. Para obter mais informações, consulte Grupos de itens no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [RemoveThingFromThingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/remove-thing-from-thing-group.html) na *Referência de comandos da AWS CLI*. ### `replace-topic-rule` O código de exemplo a seguir mostra como usar `replace-topic-rule`. **AWS CLI** **Para atualizar a definição de regra de um tópico** O exemplo `replace-topic-rule` a seguir atualiza a regra especificada para enviar um alerta do SNS quando as leituras do nível de umidade do solo estiverem muito baixas. ``` aws iot replace-topic-rule \ --rule-name MyRPiLowMoistureAlertRule \ --topic-rule-payload "{\"sql\": \"SELECT * FROM '$aws/things/MyRPi/shadow/update/accepted' WHERE state.reported.moisture = 'low'\", \"description\": \"Sends an alert when soil moisture level readings are too low.\",\"actions\": [{\"sns\":{\"targetArn\":\"arn:aws:sns:us-west-2:123456789012:MyRPiLowMoistureTopic\",\"roleArn\":\"arn:aws:iam::123456789012:role/service-role/MyRPiLowMoistureTopicRole\",\"messageFormat\": \"RAW\"}}],\"ruleDisabled\": false,\"awsIotSqlVersion\":\"2016-03-23\"}" ``` Este comando não produz saída. Para obter mais informações, consulte [Criando uma regra do AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/iot-create-rule.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ReplaceTopicRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/replace-topic-rule.html) na *Referência de comandos da AWS CLI*. ### `search-index` O código de exemplo a seguir mostra como usar `search-index`. **AWS CLI** **Como consultar o índice do item** O exemplo de `search-index` a seguir consulta o índice `AWS_Things` em busca de itens que tenham um tipo de `LightBulb`. ``` aws iot search-index \ --index-name "AWS_Things" \ --query-string "thingTypeName:LightBulb" ``` Resultado: ``` { "things": [ { "thingName": "MyLightBulb", "thingId": "40da2e73-c6af-406e-b415-15acae538797", "thingTypeName": "LightBulb", "thingGroupNames": [ "LightBulbs", "DeadBulbs" ], "attributes": { "model": "123", "wattage": "75" }, "connectivity": { "connected": false } }, { "thingName": "ThirdBulb", "thingId": "615c8455-33d5-40e8-95fd-3ee8b24490af", "thingTypeName": "LightBulb", "attributes": { "model": "123", "wattage": "75" }, "connectivity": { "connected": false } }, { "thingName": "MyOtherLightBulb", "thingId": "6dae0d3f-40c1-476a-80c4-1ed24ba6aa11", "thingTypeName": "LightBulb", "attributes": { "model": "123", "wattage": "75" }, "connectivity": { "connected": false } } ] } ``` Para obter mais informações, consulte [Gerenciar indexações de itens](https://docs.aws.amazon.com/iot/latest/developerguide/managing-index.html) no *Guia do desenvolvedor do AWS IoT*. + Consulte detalhes da API em [SearchIndex](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/search-index.html) na *Referência de comandos da AWS CLI*. ### `set-default-authorizer` O código de exemplo a seguir mostra como usar `set-default-authorizer`. **AWS CLI** **Como definir o autorizador padrão** O exemplo `set-default-authorizer` a seguir define o autorizador personalizado chamado `CustomAuthorizer` como o autorizador padrão. ``` aws iot set-default-authorizer \ --authorizer-name CustomAuthorizer ``` Resultado: ``` { "authorizerName": "CustomAuthorizer", "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer" } ``` Para obter mais informações, consulte [CreateDefaultAuthorizer](https://docs.aws.amazon.com/iot/latest/apireference/API_CreateDefaultAuthorizer.html) no *Guia de referência da API do AWS IoT*. + Para ver detalhes da API, consulte [SetDefaultAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/set-default-authorizer.html) na *Referência de comandos da AWS CLI*. ### `set-default-policy-version` O código de exemplo a seguir mostra como usar `set-default-policy-version`. **AWS CLI** **Como definir a versão padrão de uma política** O exemplo `set-default-policy-version` a seguir define a versão padrão de `2` para a política chamada `UpdateDeviceCertPolicy`. ``` aws iot set-default-policy-version \ --policy-name UpdateDeviceCertPolicy \ --policy-version-id 2 ``` Este comando não produz saída. + Consulte detalhes da API em [SetDefaultPolicyVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/set-default-policy-version.html) na *Referência de comandos da AWS CLI*. ### `set-v2-logging-level` O código de exemplo a seguir mostra como usar `set-v2-logging-level`. **AWS CLI** **Como definir o nível de log para um grupo de itens** O exemplo `set-v2-logging-level` a seguir define o nível de registro para registrar avisos para o grupo de itens especificado. ``` aws iot set-v2-logging-level \ --log-target "{\"targetType\":\"THING_GROUP\",\"targetName\":\"LightBulbs\"}" \ --log-level WARN ``` Este comando não produz saída. + Para ver detalhes da API, consulte [SetV2LoggingLevel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/set-v2-logging-level.html) na *Referência de comandos da AWS CLI*. ### `set-v2-logging-options` O código de exemplo a seguir mostra como usar `set-v2-logging-options`. **AWS CLI** **Como definir as opções de log** O exemplo `set-v2-logging-options` a seguir define o nível de detalhamento do log padrão como ERROR e especifica o ARN a ser usado para o registro. ``` aws iot set-v2-logging-options \ --default-log-level ERROR \ --role-arn "arn:aws:iam::094249569039:role/service-role/iotLoggingRole" ``` Este comando não produz saída. + Para ver detalhes da API, consulte [SetV2LoggingOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/set-v2-logging-options.html) na *Referência de comandos da AWS CLI*. ### `start-audit-mitigation-actions-task` O código de exemplo a seguir mostra como usar `start-audit-mitigation-actions-task`. **AWS CLI** **Como aplicar uma ação de mitigação às descobertas de uma auditoria** O exemplo `start-audit-mitigation-actions-task` a seguir aplica a ação `ResetPolicyVersionAction` (que limpa a política) à descoberta única especificada. ``` aws iot start-audit-mitigation-actions-task \ --task-id "myActionsTaskId" \ --target "findingIds=[\"0edbaaec-2fe1-4cf5-abc9-d4c3e51f7464\"]" \ --audit-check-to-actions-mapping "IOT_POLICY_OVERLY_PERMISSIVE_CHECK=[\"ResetPolicyVersionAction\"]" \ --client-request-token "adhadhahda" ``` Resultado: ``` { "taskId": "myActionsTaskId" } ``` Para obter mais informações, consulte [StartAuditMitigationActionsTask (Comandos de ação de mitigação)](https://docs.aws.amazon.com/iot/latest/developerguide/mitigation-action-commands.html#dd-api-iot-StartAuditMitigationActionsTask) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [StartAuditMitigationActionsTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/start-audit-mitigation-actions-task.html) na *Referência de comandos da AWS CLI*. ### `start-on-demand-audit-task` O código de exemplo a seguir mostra como usar `start-on-demand-audit-task`. **AWS CLI** **Para iniciar uma auditoria imediatamente** O exemplo `start-on-demand-audit-task` a seguir inicia uma auditoria do AWS IoT Device Defender e executa três verificações de certificado. ``` aws iot start-on-demand-audit-task \ --target-check-names CA_CERTIFICATE_EXPIRING_CHECK DEVICE_CERTIFICATE_EXPIRING_CHECK REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK ``` Resultado: ``` { "taskId": "a3aea009955e501a31b764abe1bebd3d" } ``` Para obter mais informações, consulte [Comandos de auditoria](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [StartOnDemandAuditTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/start-on-demand-audit-task.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Para especificar a chave e o valor de uma tag para um recurso** O exemplo `tag-resource` a seguir aplica a tag com uma chave `Assembly` e o valor `Fact1NW` ao grupo de itens `LightBulbs`. ``` aws iot tag-resource \ --tags Key=Assembly,Value="Fact1NW" \ --resource-arn "arn:aws:iot:us-west-2:094249569039:thinggroup/LightBulbs" ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar tags aos recursos do AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/tagging-iot.html), no *Guia do Desenvolvedor do AWS IoT*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `test-authorization` O código de exemplo a seguir mostra como usar `test-authorization`. **AWS CLI** **Para testar suas políticas do AWS IoT** O exemplo `test-authorization` a seguir testa as políticas do AWS IoT associadas à entidade principal especificada. ``` aws iot test-authorization \ --auth-infos actionType=CONNECT,resources=arn:aws:iot:us-east-1:123456789012:client/client1 \ --principal arn:aws:iot:us-west-2:123456789012:cert/aab1068f7f43ac3e3cae4b3a8aa3f308d2a750e6350507962e32c1eb465d9775 ``` Resultado: ``` { "authResults": [ { "authInfo": { "actionType": "CONNECT", "resources": [ "arn:aws:iot:us-east-1:123456789012:client/client1" ] }, "allowed": { "policies": [ { "policyName": "TestPolicyAllowed", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TestPolicyAllowed" } ] }, "denied": { "implicitDeny": { "policies": [ { "policyName": "TestPolicyDenied", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TestPolicyDenied" } ] }, "explicitDeny": { "policies": [ { "policyName": "TestPolicyExplicitDenied", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TestPolicyExplicitDenied" } ] } }, "authDecision": "IMPLICIT_DENY", "missingContextValues": [] } ] } ``` Para obter mais informações, consulte [TestAuthorization](https://docs.aws.amazon.com/iot/latest/apireference/API_TestAuthorization.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [TestAuthorization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/test-authorization.html) na *Referência de comandos da AWS CLI*. ### `test-invoke-authorizer` O código de exemplo a seguir mostra como usar `test-invoke-authorizer`. **AWS CLI** **Para testar um autorizador personalizado** O exemplo `test-invoke-authorizer` a seguir testa seu autorizador personalizado. ``` aws iot test-invoke-authorizer \ --authorizer-name IoTAuthorizer \ --token allow \ --token-signature "mE0GvaHqy9nER/FdgtJX5lXYEJ3b3vE7t1gEszc0TKGgLKWXTnPkb2AbKnOAZ8lGyoN5dVtWDWVmr25m7++zjbYIMk2TBvyGXhOmvKFBPkdgyA43KL6SiZy0cTqlPMcQDsP7VX2rXr7CTowCxSNKphGXdQe0/I5dQ+JO6KUaHwCmupt0/MejKtaNwiia064j6wprOAUwG5S1IYFuRd0X+wfo8pb0DubAIX1Ua705kuhRUcTx4SxUShEYKmN4IDEvLB6FsIr0B2wvB7y4iPmcajxzGl02ExvyCUNctCV9dYlRRGJj0nsGzBIXOI4sGytPfqlA7obdgmN22pkDzYvwjQ==" ``` Resultado: ``` { "isAuthenticated": true, "principalId": "principalId", "policyDocuments": [ "{"Version":"2012-10-17", "Statement":[{"Action":"iot:Publish","Effect":"Allow","Resource":"arn:aws:iot:us-west-2:123456789012:topic/customauthtesting"}]}" ], "refreshAfterInSeconds": 600, "disconnectAfterInSeconds": 3600 } ``` Para obter mais informações, consulte [TestInvokeAuthorizer](https://docs.aws.amazon.com/iot/latest/apireference/API_TestInvokeAuthorizers.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [TestInvokeAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/test-invoke-authorizer.html) na *Referência de comandos da AWS CLI*. ### `transfer-certificate` O código de exemplo a seguir mostra como usar `transfer-certificate`. **AWS CLI** **Como transferir um certificado para uma conta da AWS diferente** O exemplo `transfer-certificate` a seguir transfere um certificado de dispositivo a outra conta da AWS. O certificado e a conta da AWS são identificados por ID. ``` aws iot transfer-certificate \ --certificate-id 488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142 \ --target-aws-account 030714055129 ``` Resultado: ``` { "transferredCertificateArn": "arn:aws:iot:us-west-2:030714055129:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142" } ``` Para obter mais informações, consulte [Transferir um certificado para outra conta](https://docs.aws.amazon.com/iot/latest/developerguide/transfer-cert.html) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [TransferCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/transfer-certificate.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover uma tag de um recurso** O exemplo `untag-resource` a seguir remove a tag `MyTag` e seu valor do grupo de itens `LightBulbs`. ``` command ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar tags aos recursos do AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/tagging-iot.html), no *Guia do Desenvolvedor do AWS IoT*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-account-audit-configuration` O código de exemplo a seguir mostra como usar `update-account-audit-configuration`. **AWS CLI** **Exemplo 1: habilitar as notificações do Amazon SNS para notificações de auditoria** O exemplo `update-account-audit-configuration` a seguir habilita notificações do Amazon SNS para notificações de auditoria do AWS IoT Device Defender, especificando um alvo e a função usada para gravar nesse destino. ``` aws iot update-account-audit-configuration \ --audit-notification-target-configurations "SNS={targetArn=\"arn:aws:sns:us-west-2:123456789012:ddaudits\",roleArn=\"arn:aws:iam::123456789012:role/service-role/AWSIoTDeviceDefenderAudit\",enabled=true}" ``` Este comando não produz saída. **Exemplo 2: habilitar uma verificação de auditoria** O exemplo `update-account-audit-configuration` a seguir habilita a auditoria do AWS IoT Device Defender chamada `AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK`. Não é possível desativar uma verificação de auditoria se ela fizer parte de `targetCheckNames` em uma ou mais auditorias programadas para a conta da AWS. ``` aws iot update-account-audit-configuration \ --audit-check-configurations "{\"AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK\":{\"enabled\":true}}" ``` Este comando não produz saída. Para obter mais informações, consulte [Comandos de auditoria](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [UpdateAccountAuditConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-account-audit-configuration.html) na *Referência de comandos da AWS CLI*. ### `update-audit-suppression` O código de exemplo a seguir mostra como usar `update-audit-suppression`. **AWS CLI** **Para atualizar uma supressão de descoberta de auditoria** O exemplo `update-audit-suppression` a seguir atualiza a data de expiração de uma supressão da descoberta de auditoria para 21-09-2020. ``` aws iot update-audit-suppression \ --check-name DEVICE_CERTIFICATE_EXPIRING_CHECK \ --resource-identifier deviceCertificateId=c7691e \ --no-suppress-indefinitely \ --expiration-date 2020-09-21 ``` Este comando não produz saída. Para obter mais informações, consulte [Supressões de descoberta de auditoria](https://docs.aws.amazon.com/iot/latest/developerguide/audit-finding-suppressions.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [UpdateAuditSuppression](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-audit-suppression.html) na *Referência de comandos da AWS CLI*. ### `update-authorizer` O código de exemplo a seguir mostra como usar `update-authorizer`. **AWS CLI** **Para atualizar um autorizador personalizado** O exemplo `update-authorizer` a seguir atualiza o estado de `CustomAuthorizer2` para `INACTIVE`. ``` aws iot update-authorizer \ --authorizer-name CustomAuthorizer2 \ --status INACTIVE ``` Resultado: ``` { "authorizerName": "CustomAuthorizer2", "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer2" } ``` Para obter mais informações, consulte [UpdateAuthorizer](https://docs.aws.amazon.com/iot/latest/apireference/API_UpdateAuthorizer.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [UpdateAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-authorizer.html) na *Referência de comandos da AWS CLI*. ### `update-billing-group` O código de exemplo a seguir mostra como usar `update-billing-group`. **AWS CLI** **Para atualizar informações sobre um grupo de cobrança** O exemplo `update-billing-group` a seguir atualiza a descrição do grupo de cobrança especificado. ``` aws iot update-billing-group \ --billing-group-name GroupOne \ --billing-group-properties "billingGroupDescription=\"Primary bulb billing group\"" ``` Resultado: ``` { "version": 2 } ``` Para obter mais informações, consulte [Grupos de cobrança](https://docs.aws.amazon.com/iot/latest/developerguide/tagging-iot-billing-groups.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [UpdateBillingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-billing-group.html) na *Referência de comandos da AWS CLI*. ### `update-ca-certificate` O código de exemplo a seguir mostra como usar `update-ca-certificate`. **AWS CLI** **Para atualizar um certificado de autoridade de certificação (CA)** O exemplo `update-ca-certificate` a seguir define o status do certificado CA especificado para ATIVO. ``` aws iot update-ca-certificate \ --certificate-id f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467 \ --new-status ACTIVE ``` Este comando não produz saída. Para obter mais informações, consulte [UpdateCACertificate](https://docs.aws.amazon.com/iot/latest/apireference/API_UpdateCACertificate.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [UpdateCaCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-ca-certificate.html) na *Referência de comandos da AWS CLI*. ### `update-certificate` O código de exemplo a seguir mostra como usar `update-certificate`. **AWS CLI** **Para atualizar um certificado de dispositivo** O exemplo `update-certificate` a seguir define o status do certificado do dispositivo especificado para INATIVO. ``` aws iot update-certificate \ --certificate-id d1eb269fb55a628552143c8f96eb3c258fcd5331ea113e766ba0c82bf225f0be \ --new-status INACTIVE ``` Este comando não produz saída. Para obter mais informações, consulte [UpdateCertificate](https://docs.aws.amazon.com/iot/latest/apireference/API_UpdateCertificate.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [UpdateCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-certificate.html) na *Referência de comandos da AWS CLI*. ### `update-custom-metric` O código de exemplo a seguir mostra como usar `update-custom-metric`. **AWS CLI** **Para atualizar uma métrica personalizada** O exemplo `update-custom-metric` a seguir atualiza uma métrica personalizada para ter uma nova `display-name`. ``` aws iot update-custom-metric \ --metric-name batteryPercentage \ --display-name 'remaining battery percentage on device' \ --region us-east-1 ``` Resultado: ``` { "metricName": "batteryPercentage", "metricArn": "arn:aws:iot:us-east-1:1234564789012:custommetric/batteryPercentage", "metricType": "number", "displayName": "remaining battery percentage on device", "creationDate": "2020-11-17T23:01:35.110000-08:00", "lastModifiedDate": "2020-11-17T23:02:12.879000-08:00" } ``` Para obter mais informações, consulte [Métricas personalizadas](https://docs.aws.amazon.com/iot/latest/developerguide/dd-detect-custom-metrics.html) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [UpdateCustomMetric](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-custom-metric.html) na *Referência de comandos da AWS CLI*. ### `update-dimension` O código de exemplo a seguir mostra como usar `update-dimension`. **AWS CLI** **Para atualizar uma dimensão** O exemplo `update-dimension` a seguir atualiza uma dimensão. ``` aws iot update-dimension \ --name TopicFilterForAuthMessages \ --string-values device/${iot:ClientId}/auth ``` Resultado: ``` { "name": "TopicFilterForAuthMessages", "lastModifiedDate": 1585866222.317, "stringValues": [ "device/${iot:ClientId}/auth" ], "creationDate": 1585854500.474, "type": "TOPIC_FILTER", "arn": "arn:aws:iot:us-west-2:1234564789012:dimension/TopicFilterForAuthMessages" } ``` Para obter mais informações, consulte [Métricas de escopo em perfis de segurança usando dimensões](https://docs.aws.amazon.com/iot/latest/developerguide/scoping-security-behavior.html) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [UpdateDimension](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-dimension.html) na *Referência de comandos da AWS CLI*. ### `update-domain-configuration` O código de exemplo a seguir mostra como usar `update-domain-configuration`. **AWS CLI** **Para atualizar uma configuração de domínio** O exemplo `update-domain-configuration` a seguir desabilita a configuração de domínio especificada. ``` aws iot update-domain-configuration \ --domain-configuration-name "additionalDataDomain" \ --domain-configuration-status "DISABLED" ``` Resultado: ``` { "domainConfigurationName": "additionalDataDomain", "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/additionalDataDomain/dikMh" } ``` Para obter mais informações, consulte [Endpoints configuráveis](https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-endpoints-configurable-aws.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [UpdateDomainConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-domain-configuration.html) na *Referência de comandos da AWS CLI*. ### `update-dynamic-thing-group` O código de exemplo a seguir mostra como usar `update-dynamic-thing-group`. **AWS CLI** **Para atualizar um grupo dinâmico de itens** O exemplo `update-dynamic-thing-group` a seguir atualiza o grupo dinâmico de itens especificado. Ele fornece uma descrição e atualiza a string de consulta para alterar os critérios de associação ao grupo. ``` aws iot update-dynamic-thing-group \ --thing-group-name "RoomTooWarm" --thing-group-properties "thingGroupDescription=\"This thing group contains rooms warmer than 65F.\"" \ --query-string "attributes.temperature>65" ``` Resultado: ``` { "version": 2 } ``` Para obter mais informações, consulte [Grupos dinâmicos de itens](https://docs.aws.amazon.com/iot/latest/developerguide/dynamic-thing-groups.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [UpdateDynamicThingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-dynamic-thing-group.html) na *Referência de comandos da AWS CLI*. ### `update-event-configurations` O código de exemplo a seguir mostra como usar `update-event-configurations`. **AWS CLI** **Como mostrar quais tipos de eventos são publicados** O exemplo `update-event-configurations` a seguir atualiza a configuração para habilitar mensagens quando o certificado CA é adicionado, atualizado ou excluído. ``` aws iot update-event-configurations \ --event-configurations "{\"CA_CERTIFICATE\":{\"Enabled\":true}}" ``` Este comando não produz saída. Para obter mais informações, consulte [Mensagens de evento](https://docs.aws.amazon.com/iot/latest/developerguide/iot-events.html) no * Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [UpdateEventConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-event-configurations.html) na *Referência de comandos da AWS CLI*. ### `update-indexing-configuration` O código de exemplo a seguir mostra como usar `update-indexing-configuration`. **AWS CLI** **Para habilitar a indexação de itens** O exemplo de `update-indexing-configuration` a seguir permite que a indexação de itens ofereça suporte à pesquisa de dados de registro, dados de sombra e status de conectividade de itens usando o índice AWS\$1Things. ``` aws iot update-indexing-configuration --thing-indexing-configuration thingIndexingMode=REGISTRY_AND_SHADOW,thingConnectivityIndexingMode=STATUS ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar indexações de itens](https://docs.aws.amazon.com/iot/latest/developerguide/managing-index.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [UpdateIndexingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-indexing-configuration.html) na *Referência de comandos da AWS CLI*. ### `update-job` O código de exemplo a seguir mostra como usar `update-job`. **AWS CLI** **Para obter o status de um trabalho** O exemplo `update-job` a seguir obtém o status detalhado do trabalho cujo ID é `example-job-01`. ``` aws iot describe-job \ --job-id "example-job-01" ``` Resultado: ``` { "job": { "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01", "jobId": "example-job-01", "targetSelection": "SNAPSHOT", "status": "IN_PROGRESS", "targets": [ "arn:aws:iot:us-west-2:123456789012:thing/MyRaspberryPi" ], "description": "example job test", "presignedUrlConfig": {}, "jobExecutionsRolloutConfig": {}, "createdAt": 1560787022.733, "lastUpdatedAt": 1560787026.294, "jobProcessDetails": { "numberOfCanceledThings": 0, "numberOfSucceededThings": 0, "numberOfFailedThings": 0, "numberOfRejectedThings": 0, "numberOfQueuedThings": 1, "numberOfInProgressThings": 0, "numberOfRemovedThings": 0, "numberOfTimedOutThings": 0 }, "timeoutConfig": {} } } ``` Para obter mais informações, consulte [Criar e gerenciar trabalhos (CLI)](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [UpdateJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-job.html) na *Referência de comandos da AWS CLI*. ### `update-mitigation-action` O código de exemplo a seguir mostra como usar `update-mitigation-action`. **AWS CLI** **Para atualizar uma ação de mitigação** O exemplo `update-mitigation-action` a seguir atualiza a ação de mitigação especificada chamada `AddThingsToQuarantineGroupAction`, altera o nome do grupo de itens e define `overrideDynamicGroups` como `false`. Para verificar as alterações, use o comando `describe-mitigation-action`. ``` aws iot update-mitigation-action \ --cli-input-json "{ \"actionName\": \"AddThingsToQuarantineGroupAction\", \"actionParams\": { \"addThingsToThingGroupParams\": {\"thingGroupNames\":[\"QuarantineGroup2\"],\"overrideDynamicGroups\": false}}}" ``` Resultado: ``` { "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroupAction", "actionId": "2fd2726d-98e1-4abf-b10f-09465ccd6bfa" } ``` Para obter mais informações, consulte [UpdateMitigationAction (Comandos de ação de mitigação)](https://docs.aws.amazon.com/iot/latest/developerguide/mitigation-action-commands.html#dd-api-iot-UpdateMitigationAction) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [UpdateMitigationAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-mitigation-action.html) na *Referência de comandos da AWS CLI*. ### `update-provisioning-template` O código de exemplo a seguir mostra como usar `update-provisioning-template`. **AWS CLI** **Para atualizar um modelo de provisionamento** O exemplo `update-provisioning-template` a seguir modifica a descrição e o perfil ARN do modelo de provisionamento especificado e ativa o modelo. ``` aws iot update-provisioning-template \ --template-name widget-template \ --enabled \ --description "An updated provisioning template for widgets" \ --provisioning-role-arn arn:aws:iam::504350838278:role/Provision_role ``` Este comando não produz saída. Para obter mais informações, consulte [AWS IoT Secure Tunneling](https://docs.aws.amazon.com/iot/latest/developerguide/secure-tunneling.html) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [UpdateProvisioningTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-provisioning-template.html) na *Referência de comandos da AWS CLI*. ### `update-role-alias` O código de exemplo a seguir mostra como usar `update-role-alias`. **AWS CLI** **Para atualizar um alias de perfil** O exemplo `update-role-alias` a seguir atualiza o alias do perfil `LightBulbRole`. ``` aws iot update-role-alias \ --role-alias LightBulbRole \ --role-arn arn:aws:iam::123456789012:role/lightbulbrole-001 ``` Resultado: ``` { "roleAlias": "LightBulbRole", "roleAliasArn": "arn:aws:iot:us-west-2:123456789012:rolealias/LightBulbRole" } ``` Para obter mais informações, consulte [UpdateRoleAlias](https://docs.aws.amazon.com/iot/latest/apireference/API_UpdateRoleAlias.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [UpdateRoleAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-role-alias.html) na *Referência de comandos da AWS CLI*. ### `update-scheduled-audit` O código de exemplo a seguir mostra como usar `update-scheduled-audit`. **AWS CLI** **Para atualizar uma definição de auditoria programada** O exemplo `update-scheduled-audit` a seguir altera os nomes das verificações de alvo para uma auditoria agendada do AWS IoT Device Defender. ``` aws iot update-scheduled-audit \ --scheduled-audit-name WednesdayCertCheck \ --target-check-names CA_CERTIFICATE_EXPIRING_CHECK DEVICE_CERTIFICATE_EXPIRING_CHECK REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK ``` Resultado: ``` { "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/WednesdayCertCheck" } ``` Para obter mais informações, consulte [Comandos de auditoria](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [UpdateScheduledAudit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-scheduled-audit.html) na *Referência de comandos da AWS CLI*. ### `update-security-profile` O código de exemplo a seguir mostra como usar `update-security-profile`. **AWS CLI** **Para alterar um perfil de segurança** O exemplo `update-security-profile` a seguir atualiza a descrição e os comportamentos de um perfil de segurança do AWS IoT Device Defender. ``` aws iot update-security-profile \ --security-profile-name PossibleIssue \ --security-profile-description "Check to see if authorization fails 12 times in 5 minutes or if cellular bandwidth exceeds 128" \ --behaviors "[{\"name\":\"CellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}},{\"name\":\"Authorization\",\"metric\":\"aws:num-authorization-failures\",\"criteria\":{\"comparisonOperator\":\"less-than\",\"value\":{\"count\":12},\"durationSeconds\":300,\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}}]" ``` Resultado: ``` { "securityProfileName": "PossibleIssue", "securityProfileArn": "arn:aws:iot:us-west-2:123456789012:securityprofile/PossibleIssue", "securityProfileDescription": "check to see if authorization fails 12 times in 5 minutes or if cellular bandwidth exceeds 128", "behaviors": [ { "name": "CellularBandwidth", "metric": "aws:message-byte-size", "criteria": { "comparisonOperator": "greater-than", "value": { "count": 128 }, "consecutiveDatapointsToAlarm": 1, "consecutiveDatapointsToClear": 1 } }, { "name": "Authorization", "metric": "aws:num-authorization-failures", "criteria": { "comparisonOperator": "less-than", "value": { "count": 12 }, "durationSeconds": 300, "consecutiveDatapointsToAlarm": 1, "consecutiveDatapointsToClear": 1 } } ], "version": 2, "creationDate": 1560278102.528, "lastModifiedDate": 1560352711.207 } ``` Para obter mais informações, consulte [Comandos do Detect](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [UpdateSecurityProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-security-profile.html) na *Referência de comandos da AWS CLI*. ### `update-stream` O código de exemplo a seguir mostra como usar `update-stream`. **AWS CLI** **Para atualizar um fluxo** O exemplo `update-stream` a seguir atualiza um fluxo existente. A versão do fluxo será incrementada em um. ``` aws iot update-stream \ --cli-input-json file://update-stream.json ``` Conteúdo de `update-stream.json`: ``` { "streamId": "stream12345", "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.", "files": [ { "fileId": 123, "s3Location": { "bucket":"codesign-ota-bucket", "key":"48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6" } } ] "roleArn": "arn:aws:iam:us-west-2:123456789012:role/service-role/my_ota_stream_role" } ``` Resultado: ``` { "streamId": "stream12345", "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream12345", "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.", "streamVersion": 2 } ``` Para obter mais informações, consulte [UpdateStream](https://docs.aws.amazon.com/iot/latest/apireference/API_UpdateStream.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [UpdateStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-stream.html) na *Referência de comandos da AWS CLI*. ### `update-thing-group` O código de exemplo a seguir mostra como usar `update-thing-group`. **AWS CLI** **Para atualizar a definição de um grupo de itens** O exemplo `update-thing-group` a seguir atualiza a definição do grupo de itens especificado, alterando a descrição e dois atributos. ``` aws iot update-thing-group \ --thing-group-name HalogenBulbs \ --thing-group-properties "thingGroupDescription=\"Halogen bulb group\", attributePayload={attributes={Manufacturer=AnyCompany,wattage=60}}" ``` Resultado: ``` { "version": 2 } ``` Para obter mais informações, consulte [Grupos de itens](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [UpdateThingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-thing-group.html) na *Referência de comandos da AWS CLI*. ### `update-thing-groups-for-thing` O código de exemplo a seguir mostra como usar `update-thing-groups-for-thing`. **AWS CLI** **Para alterar uma lista de grupos aos quais o item pertence** O exemplo `update-thing-groups-for-thing` a seguir remove o item chamado `MyLightBulb` do grupo chamado `DeadBulbs` e a adiciona ao grupo nomeado `replaceableItems` ao mesmo tempo. ``` aws iot update-thing-groups-for-thing \ --thing-name MyLightBulb \ --thing-groups-to-add "replaceableItems" \ --thing-groups-to-remove "DeadBulbs" ``` Este comando não produz saída. Para obter mais informações, consulte [Grupos de itens](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [UpdateThingGroupsForThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-thing-groups-for-thing.html) na *Referência de comandos da AWS CLI*. ### `update-thing` O código de exemplo a seguir mostra como usar `update-thing`. **AWS CLI** **Como associar um item a um tipo de item** O exemplo `update-thing` a seguir associa um item no registro do AWS IoT a um tipo de item. Ao fazer a associação, devem ser fornecidos valores para os atributos definidos pelo tipo de item. ``` aws iot update-thing \ --thing-name "MyOtherLightBulb" \ --thing-type-name "LightBulb" \ --attribute-payload "{"attributes": {"wattage":"75", "model":"123"}}" ``` Esse comando não produz nenhuma saída. É possível usar o comando `describe-thing` para exibir o resultado. Para obter mais informações, consulte [Tipos de itens](https://docs.aws.amazon.com/iot/latest/developerguide/thing-types.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [UpdateThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-thing.html) na *Referência de comandos da AWS CLI*. ### `update-topic-rule-destination` O código de exemplo a seguir mostra como usar `update-topic-rule-destination`. **AWS CLI** **Exemplo 1: habilitar um destino de regra de tópico** O exemplo `update-topic-rule-destination` a seguir ativa o tráfego para um destino de regra de tópico. ``` aws iot update-topic-rule-destination \ --arn "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" \ --status ENABLED ``` Este comando não produz saída. Para obter mais informações, consulte [Habilitar um destino de regra de tópico](https://docs.aws.amazon.com/iot/latest/developerguide/rule-destination.html#enable-destination) no *Guia do desenvolvedor do AWS IoT*. **Exemplo 2: desativar um destino de regra de tópico** O exemplo `update-topic-rule-destination` a seguir desativa o tráfego para um destino de regra de tópico. ``` aws iot update-topic-rule-destination \ --arn "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" \ --status DISABLED ``` Este comando não produz saída. Para obter mais informações, consulte [Desativar um destino de regra de tópico](https://docs.aws.amazon.com/iot/latest/developerguide/rule-destination.html#disable-destination) no *Guia do desenvolvedor do AWS IoT*. **Exemplo 3: enviar uma nova mensagem de confirmação** O exemplo `update-topic-rule-destination` a seguir envia uma nova mensagem de confirmação para um destino de regra de tópico. ``` aws iot update-topic-rule-destination \ --arn "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" \ --status IN_PROGRESS ``` Este comando não produz saída. Para obter mais informações, consulte [Enviar uma nova mensagem de confirmação](https://docs.aws.amazon.com/iot/latest/developerguide/rule-destination.html#trigger-confirm) no Guia do *desenvolvedor de AWS IoT*. + Para ver detalhes da API, consulte [UpdateTopicRuleDestination](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-topic-rule-destination.html) na *Referência de comandos da AWS CLI*. ### `validate-security-profile-behaviors` O código de exemplo a seguir mostra como usar `validate-security-profile-behaviors`. **AWS CLI** **Exemplo 1: validar os parâmetros de comportamento de um perfil de segurança** O exemplo `validate-security-profile-behaviors` a seguir valida um conjunto bem formado e correto de comportamentos para um perfil de segurança do AWS IoT Device Defender. ``` aws iot validate-security-profile-behaviors \ --behaviors "[{\"name\":\"CellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}},{\"name\":\"Authorization\",\"metric\":\"aws:num-authorization-failures\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":12},\"durationSeconds\":300,\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}}]" ``` Resultado: ``` { "valid": true, "validationErrors": [] } ``` **Exemplo 2: validar os parâmetros de comportamento incorretos de um perfil de segurança** O exemplo `validate-security-profile-behaviors` a seguir valida um conjunto de comportamentos que contém um erro para um perfil de segurança do AWS IoT Device Defender. ``` aws iot validate-security-profile-behaviors \ --behaviors "[{\"name\":\"CellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}},{\"name\":\"Authorization\",\"metric\":\"aws:num-authorization-failures\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":12},\"durationSeconds\":300,\"consecutiveDatapointsToAlarm\":100000,\"consecutiveDatapointsToClear\":1}}]" ``` Resultado: ``` { "valid": false, "validationErrors": [ { "errorMessage": "Behavior Authorization is malformed. consecutiveDatapointsToAlarm 100000 should be in range[1,10]" } ] } ``` Para obter mais informações, consulte [Comandos do Detect](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ValidateSecurityProfileBehaviors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/validate-security-profile-behaviors.html) na *Referência de comandos da AWS CLI*. # Exemplos do Device Advisor usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o Device Advisor. *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 ### `create-suite-definition` O código de exemplo a seguir mostra como usar `create-suite-definition`. **AWS CLI** **Exemplo 1: criar uma suíte de testes do IoT Device Advisor** O exemplo `create-suite-definition` a seguir cria uma suíte de testes do Device Advisor no AWS IoT com a configuração de definição de suíte especificada. ``` aws iotdeviceadvisor create-suite-definition \ --suite-definition-configuration '{ \ "suiteDefinitionName": "TestSuiteName", \ "devices": [{"thingArn":"arn:aws:iot:us-east-1:123456789012:thing/MyIotThing"}], \ "intendedForQualification": false, \ "rootGroup": "{\"configuration\":{},\"tests\":[{\"name\":\"MQTT Connect\",\"configuration\":{\"EXECUTION_TIMEOUT\":120},\"tests\":[{\"name\":\"MQTT_Connect\",\"configuration\":{},\"test\":{\"id\":\"MQTT_Connect\",\"testCase\":null,\"version\":\"0.0.0\"}}]}]}", \ "devicePermissionRoleArn": "arn:aws:iam::123456789012:role/Myrole"}' ``` Resultado: ``` { "suiteDefinitionId": "0jtsgio7yenu", "suiteDefinitionArn": "arn:aws:iotdeviceadvisor:us-east-1:123456789012:suitedefinition/0jtsgio7yenu", "suiteDefinitionName": "TestSuiteName", "createdAt": "2022-12-02T11:38:13.263000-05:00" } ``` Para obter mais informações, consulte [Criar uma definição de suíte de testes](https://docs.aws.amazon.com/iot/latest/developerguide/device-advisor-workflow.html#device-advisor-workflow-create-suite-definition) no *Guia do desenvolvedor do AWS IoT Core*. **Exemplo 2: criar uma suíte de testes Latest Qualification do IoT Device Advisor** O exemplo `create-suite-definition` a seguir cria uma suíte de testes de qualificação do Device Advisor com a versão mais recente no AWS IoT usando a configuração de definição de suíte especificada. ``` aws iotdeviceadvisor create-suite-definition \ --suite-definition-configuration '{ \ "suiteDefinitionName": "TestSuiteName", \ "devices": [{"thingArn":"arn:aws:iot:us-east-1:123456789012:thing/MyIotThing"}], \ "intendedForQualification": true, \ "rootGroup": "", \ "devicePermissionRoleArn": "arn:aws:iam::123456789012:role/Myrole"}' ``` Resultado: ``` { "suiteDefinitionId": "txgsuolk2myj", "suiteDefinitionArn": "arn:aws:iotdeviceadvisor:us-east-1:123456789012:suitedefinition/txgsuolk2myj", "suiteDefinitionName": "TestSuiteName", "createdAt": "2022-12-02T11:38:13.263000-05:00" } ``` Para obter mais informações, consulte [Criar uma definição de suíte de testes](https://docs.aws.amazon.com/iot/latest/developerguide/device-advisor-workflow.html#device-advisor-workflow-create-suite-definition) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [CreateSuiteDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/create-suite-definition.html) na *Referência de comandos da AWS CLI*. ### `delete-suite-definition` O código de exemplo a seguir mostra como usar `delete-suite-definition`. **AWS CLI** **Para excluir a suíte de testes do IoT Device Advisor** O exemplo `delete-suite-definition` a seguir exclui a suíte de testes do Device Advisor com o ID de definição da suíte especificado. ``` aws iotdeviceadvisor delete-suite-definition \ --suite-definition-id 0jtsgio7yenu ``` Este comando não produz saída. Para obter mais informações, consulte [DeleteSuiteDefinition](https://docs.aws.amazon.com/iot/latest/apireference/API_iotdeviceadvisor_DeleteSuiteDefinition.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [DeleteSuiteDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/delete-suite-definition.html) na *Referência de comandos da AWS CLI*. ### `get-endpoint` O código de exemplo a seguir mostra como usar `get-endpoint`. **AWS CLI** **Exemplo 1: obter as informações sobre um endpoint em nível de conta do IoT Device Advisor** O exemplo `get-endpoint` a seguir obtém as informações sobre um endpoint de teste em nível de conta do Device Advisor. ``` aws iotdeviceadvisor get-endpoint ``` Resultado: ``` { "endpoint": "t6y4c143x9sfo.deviceadvisor.iot.us-east-1.amazonaws.com" } ``` **Exemplo 2: obter informações sobre um endpoint em nível de dispositivo do IoT Device Advisor** O exemplo `get-endpoint` a seguir obtém as informações sobre um endpoint de teste em nível de dispositivo do Device Advisor com o thing-arn ou certificate-arn especificado. ``` aws iotdeviceadvisor get-endpoint \ --thing-arn arn:aws:iot:us-east-1:123456789012:thing/MyIotThing ``` Resultado: ``` { "endpoint": "tdb7719be5t6y4c143x9sfo.deviceadvisor.iot.us-east-1.amazonaws.com" } ``` Para obter mais informações, consulte [Obter um endpoint de teste](https://docs.aws.amazon.com/iot/latest/developerguide/device-advisor-workflow.html#device-advisor-workflow-get-test-endpoint) no *Guia do desenvolvedor do AWS IoT Core*. + Consulte detalhes da API em [GetEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/get-endpoint.html) na *Referência de comandos da AWS CLI*. ### `get-suite-definition` O código de exemplo a seguir mostra como usar `get-suite-definition`. **AWS CLI** **Para obter informações sobre uma suíte de testes do IoT Device Advisor** O exemplo `get-suite-definition` a seguir obtém as informações sobre uma suíte de testes do Device Advisor com o ID de definição da suíte especificado. ``` aws iotdeviceadvisor get-suite-definition \ --suite-definition-id qqcsmtyyjabl ``` Resultado: ``` { "suiteDefinitionId": "qqcsmtyyjabl", "suiteDefinitionArn": "arn:aws:iotdeviceadvisor:us-east-1:123456789012:suitedefinition/qqcsmtyyjabl", "suiteDefinitionVersion": "v1", "latestVersion": "v1", "suiteDefinitionConfiguration": { "suiteDefinitionName": "MQTT connection", "devices": [], "intendedForQualification": false, "isLongDurationTest": false, "rootGroup": "{\"configuration\":{},\"tests\":[{\"id\":\"uta5d9j1kvwc\",\"name\":\"Test group 1\",\"configuration\":{},\"tests\":[{\"id\":\"awr8pq5vc9yp\",\"name\":\"MQTT Connect\",\"configuration\":{},\"test\":{\"id\":\"MQTT_Connect\",\"testCase\":null,\"version\":\"0.0.0\"}}]}]}", "devicePermissionRoleArn": "arn:aws:iam::123456789012:role/Myrole", "protocol": "MqttV3_1_1" }, "createdAt": "2022-11-11T22:28:52.389000-05:00", "lastModifiedAt": "2022-11-11T22:28:52.389000-05:00", "tags": {} } ``` Para obter mais informações, consulte [Obter uma definição de suíte de testes](https://docs.aws.amazon.com/iot/latest/developerguide/device-advisor-workflow.html#device-advisor-workflow-create-suite-definition) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [GetSuiteDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/get-suite-definition.html) na *Referência de comandos da AWS CLI*. ### `get-suite-run-report` O código de exemplo a seguir mostra como usar `get-suite-run-report`. **AWS CLI** **Para obter informações sobre um relatório de uma suíte de testes de qualificação do IoT Device Advisor** O exemplo `get-suite-run-report` a seguir obtém o link de download do relatório para uma execução bem-sucedida da suíte de testes de qualificação do Device Advisor com o ID de definição da suíte e o ID de execução da suíte especificados. ``` aws iotdeviceadvisor get-suite-run-report \ --suite-definition-id ztvb5aek4w4x \ --suite-run-id p6awv83nre6v ``` Resultado: ``` { "qualificationReportDownloadUrl": "https://senate-apn-reports-us-east-1-prod.s3.amazonaws.com/report.downloadlink" } ``` Para obter mais informações, consulte [Obter um relatório de qualificação para uma execução bem-sucedida de uma suíte de testes de qualificação](https://docs.aws.amazon.com/iot/latest/developerguide/device-advisor-workflow.html#device-advisor-workflow-qualification-report) no *Guia do Desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [GetSuiteRunReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/get-suite-run-report.html) na *Referência de comandos da AWS CLI*. ### `get-suite-run` O código de exemplo a seguir mostra como usar `get-suite-run`. **AWS CLI** **Para obter informações sobre o status de execução uma suíte de testes do IoT Device Advisor** O exemplo `get-suite-run` a seguir obtém as informações sobre o status de execução de uma suíte de testes do Device Advisor com o ID de definição da suíte especificado. ``` aws iotdeviceadvisor get-suite-run \ --suite-definition-id qqcsmtyyjabl \ --suite-run-id nzlfyhaa18oa ``` Resultado: ``` { "suiteDefinitionId": "qqcsmtyyjabl", "suiteDefinitionVersion": "v1", "suiteRunId": "nzlfyhaa18oa", "suiteRunArn": "arn:aws:iotdeviceadvisor:us-east-1:123456789012:suiterun/qqcsmtyyjabl/nzlfyhaa18oa", "suiteRunConfiguration": { "primaryDevice": { "thingArn": "arn:aws:iot:us-east-1:123456789012:thing/MyIotThing", "certificateArn": "arn:aws:iot:us-east-1:123456789012:cert/certFile" }, "parallelRun": false }, "testResult": { "groups": [ { "groupId": "uta5d9j1kvwc", "groupName": "Test group 1", "tests": [ { "testCaseRunId": "2ve2twrqyr0s", "testCaseDefinitionId": "awr8pq5vc9yp", "testCaseDefinitionName": "MQTT Connect", "status": "PASS", "startTime": "2022-11-12T00:01:53.693000-05:00", "endTime": "2022-11-12T00:02:15.443000-05:00", "logUrl": "https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#logEventViewer:group=/aws/iot/deviceadvisor/qqcsmtyyjabl;stream=nzlfyhaa18oa_2ve2twrqyr0s", "warnings": "null", "failure": "null" } ] } ] }, "startTime": "2022-11-12T00:01:52.673000-05:00", "endTime": "2022-11-12T00:02:16.496000-05:00", "status": "PASS", "tags": {} } ``` Para obter mais informações, consulte [Obter uma execução de suíte de testes](https://docs.aws.amazon.com/iot/latest/developerguide/device-advisor-workflow.html#device-advisor-workflow-describe-suite) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [GetSuiteRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/get-suite-run.html) na *Referência de comandos da AWS CLI*. ### `list-suite-definitions` O código de exemplo a seguir mostra como usar `list-suite-definitions`. **AWS CLI** **Exemplo 1: listar suítes de testes do IoT Device Advisor criadas** O exemplo `list-suite-definitions` a seguir lista até 25 suítes de teste do Device Advisor criadas no AWS IoT. Se houver mais de 25 suítes de teste, o "nextToken" será mostrado na saída. É possível usar esse "nextToken" para mostrar o resto das suítes de teste criadas. ``` aws iotdeviceadvisor list-suite-definitions ``` Resultado: ``` { "suiteDefinitionInformationList": [ { "suiteDefinitionId": "3hsn88h4p2g5", "suiteDefinitionName": "TestSuite1", "defaultDevices": [ { "thingArn": "arn:aws:iot:us-east-1:123456789012:thing/MyIotThing" } ], "intendedForQualification": false, "isLongDurationTest": false, "protocol": "MqttV3_1_1", "createdAt": "2022-11-17T14:15:56.830000-05:00" }, { ...... } ], "nextToken": "nextTokenValue" } ``` **Exemplo 2: listar suítes de testes do IoT Device Advisor criadas com as configurações especificadas** O exemplo `list-suite-definitions` a seguir lista as suítes de testes do Device Advisor criadas no AWS IoT com o número máximo de resultados especificado. Se houver mais suítes de teste do que o número máximo, o "nextToken" será mostrado na saída. Se houver um "nextToken", é possível usar "nextToken" para mostrar as suítes de teste criadas que não foram mostradas antes. ``` aws iotdeviceadvisor list-suite-definitions \ --max-result 1 \ --next-token "nextTokenValue" ``` Resultado: ``` { "suiteDefinitionInformationList": [ { "suiteDefinitionId": "ztvb5aew4w4x", "suiteDefinitionName": "TestSuite2", "defaultDevices": [], "intendedForQualification": true, "isLongDurationTest": false, "protocol": "MqttV3_1_1", "createdAt": "2022-11-17T14:15:56.830000-05:00" } ], "nextToken": "nextTokenValue" } ``` Para obter mais informações, consulte [ListSuiteDefinitions](https://docs.aws.amazon.com/iot/latest/apireference/API_iotdeviceadvisor_ListSuiteDefinitions.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [ListSuiteDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/list-suite-definitions.html) na *Referência de comandos da AWS CLI*. ### `list-suite-runs` O código de exemplo a seguir mostra como usar `list-suite-runs`. **AWS CLI** **Exemplo 1: listar todas as informações sobre o status de execução da suíte de testes do IoT Device Advisor especificada** O exemplo `list-suite-runs` a seguir lista todas as informações sobre o status de execução de uma suíte de testes do Device Advisor com o ID de definição da suíte especificado. Se houver mais de 25 execuções de suítes de teste, o "nextToken" será mostrado na saída. É possível usar esse "nextToken" para mostrar o resto das suítes de teste criadas. ``` aws iotdeviceadvisor list-suite-runs \ --suite-definition-id ztvb5aew4w4x ``` Resultado: ``` { "suiteRunsList": [ { "suiteDefinitionId": "ztvb5aew4w4x", "suiteDefinitionVersion": "v1", "suiteDefinitionName": "TestSuite", "suiteRunId": "p6awv89nre6v", "createdAt": "2022-12-01T16:33:14.212000-05:00", "startedAt": "2022-12-01T16:33:15.710000-05:00", "endAt": "2022-12-01T16:42:03.323000-05:00", "status": "PASS", "passed": 6, "failed": 0 } ] } ``` **Exemplo 2: listar todas as informações sobre o status de execução da suíte de testes do IoT Device Advisor com as configurações especificadas** O exemplo `list-suite-runs` a seguir lista todas as informações sobre o status de execução de uma suíte de testes do Device Advisor com o ID de definição da suíte e o número máximo de resultados especificados. Se houver mais execuções de suítes de teste do que o número máximo especificado, o "nextToken" será mostrado na saída. Se houver um "nextToken", é possível usar "nextToken" para mostrar as suítes de teste criadas que não foram mostradas antes. ``` aws iotdeviceadvisor list-suite-runs \ --suite-definition-id qqcsmtyyjaml \ --max-result 1 \ --next-token "nextTokenValue" ``` Resultado: ``` { "suiteRunsList": [ { "suiteDefinitionId": "qqcsmtyyjaml", "suiteDefinitionVersion": "v1", "suiteDefinitionName": "MQTT connection", "suiteRunId": "gz9vm2s6d2jy", "createdAt": "2022-12-01T20:10:27.079000-05:00", "startedAt": "2022-12-01T20:10:28.003000-05:00", "endAt": "2022-12-01T20:10:45.084000-05:00", "status": "STOPPED", "passed": 0, "failed": 0 } ], "nextToken": "nextTokenValue" } ``` Para obter mais informações, consulte [ListSuiteRuns](https://docs.aws.amazon.com/iot/latest/apireference/API_iotdeviceadvisor_ListSuiteRuns.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [ListSuiteRuns](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/list-suite-runs.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar as tags anexadas a um recurso do IoT Device Advisor** O exemplo `list-tags-for-resource` a seguir lista as tags anexadas a um recurso do Device Advisor. O recurso do Device Advisor pode ser um Suitedefinition-Arn ou um Suiterun-Arn. ``` aws iotdeviceadvisor list-tags-for-resource \ --resource-arn arn:aws:iotdeviceadvisor:us-east-1:123456789012:suitedefinition/ba0uyjpg38ny ``` Resultado: ``` { "tags": { "TestTagKey": "TestTagValue" } } ``` Para obter mais informações, consulte [ListTagsForResource](https://docs.aws.amazon.com/iot/latest/apireference/API_iotdeviceadvisor_ListTagsForResource.html) na *Referência da API do AWS IoT* e [Tipos de recursos definidos pelo AWS IoT Core Device Advisor](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotcoredeviceadvisor.html#awsiotcoredeviceadvisor-resources-for-iam-policies) na *Referência de autorização de serviço.* + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `start-suite-run` O código de exemplo a seguir mostra como usar `start-suite-run`. **AWS CLI** **Para iniciar uma execução da suíte de testes do IoT Device Advisor** O exemplo `start-suite-run` a seguir lista os widgets disponíveis na sua conta da AWS. ``` aws iotdeviceadvisor start-suite-run \ --suite-definition-id qqcsmtyyjabl \ --suite-definition-version v1 \ --suite-run-configuration '{"primaryDevice":{"thingArn": "arn:aws:iot:us-east-1:123456789012:thing/MyIotThing","certificateArn":"arn:aws:iot:us-east-1:123456789012:cert/certFile"}}' ``` Resultado: ``` { "suiteRunId": "pwmucgw7lt9s", "suiteRunArn": "arn:aws:iotdeviceadvisor:us-east-1:123456789012:suiterun/qqcsmtyyjabl/pwmucgw7lk9s", "createdAt": "2022-12-02T15:43:05.581000-05:00" } ``` Para obter mais informações, consulte [Iniciar a execução de uma suíte de testes](https://docs.aws.amazon.com/iot/latest/developerguide/device-advisor-workflow.html#device-advisor-workflow-start-suite-run) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [StartSuiteRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/start-suite-run.html) na *Referência de comandos da AWS CLI*. ### `stop-suite-run` O código de exemplo a seguir mostra como usar `stop-suite-run`. **AWS CLI** **Para interromper a execução de uma suíte de testes do IoT Device Advisor** O exemplo `stop-suite-run` a seguir interrompe a execução de uma suíte de testes do Device Advisor com o ID de definição e ID de execução da suíte especificados. ``` aws iotdeviceadvisor stop-suite-run \ --suite-definition-id qqcsmtyyjabl \ --suite-run-id nzlfyhaa18oa ``` Este comando não produz saída. Para obter mais informações, consulte [Interromper a execução de uma suíte de testes](https://docs.aws.amazon.com/iot/latest/developerguide/device-advisor-workflow.html#device-advisor-workflow-stop-suite-run) no *Guia do desenvolvedor do AWS IoT Core*. + Para ver detalhes da API, consulte [StopSuiteRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/stop-suite-run.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Para adicionar e modificar as tags existentes de um recurso do IoT Device Advisor** O exemplo `tag-resource` a seguir adiciona e modifica as tags existentes de um recurso do Device Advisor com o arn e as tags do recurso especificados. O recurso do Device Advisor pode ser um Suitedefinition-Arn ou um Suiterun-Arn. ``` aws iotdeviceadvisor tag-resource \ --resource-arn arn:aws:iotdeviceadvisor:us-east-1:123456789012:suitedefinition/ba0uyjpg38ny \ --tags '{"TagKey": "TagValue"}' ``` Este comando não produz saída. Para obter mais informações, consulte [TagResource](https://docs.aws.amazon.com/iot/latest/apireference/API_iotdeviceadvisor_TagResource.html) na *Referência da API do AWS IoT* e [Tipos de recursos definidos pelo AWS IoT Core Device Advisor](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotcoredeviceadvisor.html#awsiotcoredeviceadvisor-resources-for-iam-policies) na *Referência de autorização de serviço.* + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover as tags existentes de um recurso do IoT Device Advisor** O exemplo `untag-resource` a seguir adiciona e modifica as tags existentes de um recurso do Device Advisor com o arn e a chave da tag do recurso especificados. O recurso do Device Advisor pode ser um Suitedefinition-Arn ou um Suiterun-Arn. ``` aws iotdeviceadvisor untag-resource \ --resource-arn arn:aws:iotdeviceadvisor:us-east-1:123456789012:suitedefinition/ba0uyjpg38ny \ --tag-keys "TagKey" ``` Este comando não produz saída. Para obter mais informações, consulte [UntagResource](https://docs.aws.amazon.com/iot/latest/apireference/API_iotdeviceadvisor_UntagResource.html) na *Referência da API do AWS IoT* e [Tipos de recursos definidos pelo AWS IoT Core Device Advisor](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotcoredeviceadvisor.html#awsiotcoredeviceadvisor-resources-for-iam-policies) na *Referência de autorização de serviço.* + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-suite-definition` O código de exemplo a seguir mostra como usar `update-suite-definition`. **AWS CLI** **Exemplo 1: atualizar uma suíte de testes do IoT Device Advisor** O exemplo `update-suite-definition` a seguir atualiza uma suíte de testes do Device Advisor no AWS IoT com o ID de definição e a definição de suíte especificados. ``` aws iotdeviceadvisor update-suite-definition \ --suite-definition-id 3hsn88h4p2g5 \ --suite-definition-configuration '{ \ "suiteDefinitionName": "TestSuiteName", \ "devices": [{"thingArn":"arn:aws:iot:us-east-1:123456789012:thing/MyIotThing"}], \ "intendedForQualification": false, \ "rootGroup": "{\"configuration\":{},\"tests\":[{\"name\":\"MQTT Connect\",\"configuration\":{\"EXECUTION_TIMEOUT\":120},\"tests\":[{\"name\":\"MQTT_Connect\",\"configuration\":{},\"test\":{\"id\":\"MQTT_Connect\",\"testCase\":null,\"version\":\"0.0.0\"}}]}]}", \ "devicePermissionRoleArn": "arn:aws:iam::123456789012:role/Myrole"}' ``` Resultado: ``` { "suiteDefinitionId": "3hsn88h4p2g5", "suiteDefinitionName": "TestSuiteName", "suiteDefinitionVersion": "v3", "createdAt": "2022-11-17T14:15:56.830000-05:00", "lastUpdatedAt": "2022-12-02T16:02:45.857000-05:00" } ``` **Exemplo 2: atualizar uma suíte de testes de quantificação do IoT Device Advisor** O exemplo `update-suite-definition` a seguir atualiza uma suíte de testes de quantificação do Device Advisor no AWS IoT com o ID de definição e a definição de suíte especificados. ``` aws iotdeviceadvisor update-suite-definition \ --suite-definition-id txgsuolk2myj \ --suite-definition-configuration '{ "suiteDefinitionName": "TestSuiteName", \ "devices": [{"thingArn":"arn:aws:iot:us-east-1:123456789012:thing/MyIotThing"}], \ "intendedForQualification": true, \ "rootGroup": "", \ "devicePermissionRoleArn": "arn:aws:iam::123456789012:role/Myrole"}' ``` Resultado: ``` { "suiteDefinitionId": "txgsuolk2myj", "suiteDefinitionName": "TestSuiteName", "suiteDefinitionVersion": "v3", "createdAt": "2022-11-17T14:15:56.830000-05:00", "lastUpdatedAt": "2022-12-02T16:02:45.857000-05:00" } ``` Para obter mais informações, consulte [UpdateSuiteDefinition](https://docs.aws.amazon.com/iot/latest/apireference/API_iotdeviceadvisor_UpdateSuiteDefinition.html) na *Referência da API do AWS IoT*. + Para ver detalhes da API, consulte [UpdateSuiteDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/update-suite-definition.html) na *Referência de comandos da AWS CLI*. # AWS IoT data Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o AWS IoT data. *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 ### `delete-thing-shadow` O código de exemplo a seguir mostra como usar `delete-thing-shadow`. **AWS CLI** **Para excluir um documento de sombra do dispositivo** O exemplo `delete-thing-shadow` a seguir exclui todo o documento de sombra do dispositivo chamado `MyRPi`. ``` aws iot-data delete-thing-shadow \ --thing-name MyRPi \ "output.txt" ``` O comando não produz saída na tela, mas `output.txt` contém informações que confirmam a versão e a data e hora da do documento de sombra excluído. ``` {"version":2,"timestamp":1560270384} ``` Para obter mais informações, consulte [Usar sombras](https://docs.aws.amazon.com/iot/latest/developerguide/using-device-shadows.html) no *Guia do desenvolvedor da AWS IoT*. + Para ver detalhes da API, consulte [DeleteThingShadow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot-data/delete-thing-shadow.html) na *Referência de comandos da AWS CLI*. ### `get-thing-shadow` O código de exemplo a seguir mostra como usar `get-thing-shadow`. **AWS CLI** **Para obter um documento de sombra de item** O exemplo `get-thing-shadow` a seguir obtém o documento de sombra do item para o item IoT especificado. ``` aws iot-data get-thing-shadow \ --thing-name MyRPi \ output.txt ``` O comando não produz nenhuma saída na tela, mas o seguinte mostra o conteúdo de `output.txt`: ``` { "state":{ "reported":{ "moisture":"low" } }, "metadata":{ "reported":{ "moisture":{ "timestamp":1560269319 } } }, "version":1,"timestamp":1560269405 } ``` Para obter mais informações, consulte [Fluxo de dados da sombra do dispositivo](https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-data-flow.html) no *Guia do desenvolvedor da AWS IoT*. + Para ver detalhes da API, consulte [GetThingShadow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot-data/get-thing-shadow.html) na *Referência de comandos da AWS CLI*. ### `update-thing-shadow` O código de exemplo a seguir mostra como usar `update-thing-shadow`. **AWS CLI** **Para atualizar uma sombra de item** O exemplo `update-thing-shadow` a seguir modifica o estado atual da sombra do dispositivo para o item especificado e o salva no arquivo `output.txt`. ``` aws iot-data update-thing-shadow \ --thing-name MyRPi \ --payload "{"state":{"reported":{"moisture":"okay"}}}" \ "output.txt" ``` O comando não produz nenhuma saída na tela, mas o seguinte mostra o conteúdo de `output.txt`: ``` { "state": { "reported": { "moisture": "okay" } }, "metadata": { "reported": { "moisture": { "timestamp": 1560270036 } } }, "version": 2, "timestamp": 1560270036 } ``` Para obter mais informações, consulte [Fluxo de dados da sombra do dispositivo](https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-data-flow.html) no *Guia do desenvolvedor da AWS IoT*. + Para ver detalhes da API, consulte [UpdateThingShadow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot-data/update-thing-shadow.html) na *Referência de comandos da AWS CLI*. # AWS IoT Events Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o AWS IoT Events. *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 ### `batch-put-message` O código de exemplo a seguir mostra como usar `batch-put-message`. **AWS CLI** **Como enviar mensagens (entradas) para o AWS IoT Events** O exemplo `batch-put-message` a seguir envia um conjunto de mensagens para o sistema do AWS IoT Events. A carga útil de cada mensagem é transformada na entrada especificada (`inputName`) e ingerida em qualquer detector que monitore essa entrada. Por padrão, a ordem em que as mensagens são processadas é garantida quando várias mensagens são enviadas. Para garantir a ordem do processamento, deve-se enviar uma mensagem de cada vez e aguardar uma resposta bem-sucedida. ``` aws iotevents-data batch-put-message \ --cli-input-json file://highPressureMessage.json ``` Conteúdo de `highPressureMessage.json`: ``` { "messages": [ { "messageId": "00001", "inputName": "PressureInput", "payload": "{\"motorid\": \"Fulton-A32\", \"sensorData\": {\"pressure\": 80, \"temperature\": 39} }" } ] } ``` Resultado: ``` { "BatchPutMessageErrorEntries": [] } ``` Para obter mais informações, consulte [BatchPutMessage](https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchPutMessage.html) na *Referência da API do AWS IoT Events*. + Para ver detalhes da API, consulte [BatchPutMessage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/batch-put-message.html) na *Referência de comandos da AWS CLI*. ### `batch-update-detector` O código de exemplo a seguir mostra como usar `batch-update-detector`. **AWS CLI** **Para atualizar um detector (instância)** O exemplo `batch-update-detector` a seguir atualiza o estado, os valores das variáveis e as configurações do temporizador de um ou mais detectores (instâncias) de um modelo de detector especificado. ``` aws iotevents-data batch-update-detector \ --cli-input-json file://budFulton-A32.json ``` Conteúdo de `budFulton-A32.json`: ``` { "detectors": [ { "messageId": "00001", "detectorModelName": "motorDetectorModel", "keyValue": "Fulton-A32", "state": { "stateName": "Normal", "variables": [ { "name": "pressureThresholdBreached", "value": "0" } ], "timers": [ ] } } ] } ``` Resultado: ``` { "batchUpdateDetectorErrorEntries": [] } ``` Para obter mais informações, consulte [BatchUpdateDetector](https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchUpdateDetector.html) na *Referência da API do AWS IoT Events*. + Para ver detalhes da API, consulte [BatchUpdateDetector](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/batch-update-detector.html) na *Referência de comandos da AWS CLI*. ### `create-detector-model` O código de exemplo a seguir mostra como usar `create-detector-model`. **AWS CLI** **Para criar um modelo de detector** O exemplo `create-detector-model` a seguir cria um modelo de detector com sua configuração especificada por um arquivo de parâmetros. ``` aws iotevents create-detector-model \ --cli-input-json file://motorDetectorModel.json ``` Conteúdo de `motorDetectorModel.json`: ``` { "detectorModelName": "motorDetectorModel", "detectorModelDefinition": { "states": [ { "stateName": "Normal", "onEnter": { "events": [ { "eventName": "init", "condition": "true", "actions": [ { "setVariable": { "variableName": "pressureThresholdBreached", "value": "0" } } ] } ] }, "onInput": { "transitionEvents": [ { "eventName": "Overpressurized", "condition": "$input.PressureInput.sensorData.pressure > 70", "actions": [ { "setVariable": { "variableName": "pressureThresholdBreached", "value": "$variable.pressureThresholdBreached + 3" } } ], "nextState": "Dangerous" } ] } }, { "stateName": "Dangerous", "onEnter": { "events": [ { "eventName": "Pressure Threshold Breached", "condition": "$variable.pressureThresholdBreached > 1", "actions": [ { "sns": { "targetArn": "arn:aws:sns:us-east-1:123456789012:underPressureAction" } } ] } ] }, "onInput": { "events": [ { "eventName": "Overpressurized", "condition": "$input.PressureInput.sensorData.pressure > 70", "actions": [ { "setVariable": { "variableName": "pressureThresholdBreached", "value": "3" } } ] }, { "eventName": "Pressure Okay", "condition": "$input.PressureInput.sensorData.pressure <= 70", "actions": [ { "setVariable": { "variableName": "pressureThresholdBreached", "value": "$variable.pressureThresholdBreached - 1" } } ] } ], "transitionEvents": [ { "eventName": "BackToNormal", "condition": "$input.PressureInput.sensorData.pressure <= 70 && $variable.pressureThresholdBreached <= 1", "nextState": "Normal" } ] }, "onExit": { "events": [ { "eventName": "Normal Pressure Restored", "condition": "true", "actions": [ { "sns": { "targetArn": "arn:aws:sns:us-east-1:123456789012:pressureClearedAction" } } ] } ] } } ], "initialStateName": "Normal" }, "key": "motorid", "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole" } ``` Resultado: ``` { "detectorModelConfiguration": { "status": "ACTIVATING", "lastUpdateTime": 1560796816.077, "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", "creationTime": 1560796816.077, "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel", "key": "motorid", "detectorModelName": "motorDetectorModel", "detectorModelVersion": "1" } } ``` Para obter mais informações, consulte [CreateDetectorModel](https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateDetectorModel.html) no *Guia de referência da API do AWS IoT Events*. + Para ver detalhes da API, consulte [CreateDetectorModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/create-detector-model.html) na *Referência de comandos da AWS CLI*. ### `create-input` O código de exemplo a seguir mostra como usar `create-input`. **AWS CLI** **Para criar uma entrada** O exemplo `create-input` a seguir cria uma entrada. ``` aws iotevents create-input \ --cli-input-json file://pressureInput.json ``` Conteúdo de `pressureInput.json`: ``` { "inputName": "PressureInput", "inputDescription": "Pressure readings from a motor", "inputDefinition": { "attributes": [ { "jsonPath": "sensorData.pressure" }, { "jsonPath": "motorid" } ] } } ``` Resultado: ``` { "inputConfiguration": { "status": "ACTIVE", "inputArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", "lastUpdateTime": 1560795312.542, "creationTime": 1560795312.542, "inputName": "PressureInput", "inputDescription": "Pressure readings from a motor" } } ``` Para obter mais informações, consulte [CreateInput](https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateInput) no *Guia de referência da API do AWS IoT Events*. + Para ver detalhes da API, consulte [CreateInput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/create-input.html) na *Referência de comandos da AWS CLI*. ### `delete-detector-model` O código de exemplo a seguir mostra como usar `delete-detector-model`. **AWS CLI** **Para excluir um modelo de detector** O exemplo `delete-detector-model` a seguir exclui o modelo de detector especificado. Todas as instâncias ativas do modelo do detector também são excluídas. ``` aws iotevents delete-detector-model \ --detector-model-name motorDetectorModel ``` Este comando não produz saída. Para obter mais informações, consulte [DeleteDetectorModel](https://docs.aws.amazon.com/iotevents/latest/apireference/API_DeleteDetectorModel) no *Guia de referência da API do AWS IoT Events*. + Para ver detalhes da API, consulte [DeleteDetectorModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/delete-detector-model.html) na *Referência de comandos da AWS CLI*. ### `delete-input` O código de exemplo a seguir mostra como usar `delete-input`. **AWS CLI** **Para excluir uma entrada** O exemplo `delete-input` a seguir exclui a entrada especificada. ``` aws iotevents delete-input \ --input-name PressureInput ``` Este comando não produz saída. Para obter mais informações, consulte [DeleteInput](https://docs.aws.amazon.com/iotevents/latest/apireference/API_DeleteInput) no *Guia de referência da API do AWS IoT Events*. + Para ver detalhes da API, consulte [DeleteInput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/delete-input.html) na *Referência de comandos da AWS CLI*. ### `describe-detector-model` O código de exemplo a seguir mostra como usar `describe-detector-model`. **AWS CLI** **Para obter informações sobre um modelo de detector** O exemplo `describe-detector-model` a seguir exibe detalhes do modelo de detector especificado. Como o parâmetro `version` não está especificado, o comando retornará informações sobre a versão mais recente. ``` aws iotevents describe-detector-model \ --detector-model-name motorDetectorModel ``` Resultado: ``` { "detectorModel": { "detectorModelConfiguration": { "status": "ACTIVE", "lastUpdateTime": 1560796816.077, "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", "creationTime": 1560796816.077, "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel", "key": "motorid", "detectorModelName": "motorDetectorModel", "detectorModelVersion": "1" }, "detectorModelDefinition": { "states": [ { "onInput": { "transitionEvents": [ { "eventName": "Overpressurized", "actions": [ { "setVariable": { "variableName": "pressureThresholdBreached", "value": "$variable.pressureThresholdBreached + 3" } } ], "condition": "$input.PressureInput.sensorData.pressure > 70", "nextState": "Dangerous" } ], "events": [] }, "stateName": "Normal", "onEnter": { "events": [ { "eventName": "init", "actions": [ { "setVariable": { "variableName": "pressureThresholdBreached", "value": "0" } } ], "condition": "true" } ] }, "onExit": { "events": [] } }, { "onInput": { "transitionEvents": [ { "eventName": "BackToNormal", "actions": [], "condition": "$input.PressureInput.sensorData.pressure <= 70 && $variable.pressureThresholdBreached <= 1", "nextState": "Normal" } ], "events": [ { "eventName": "Overpressurized", "actions": [ { "setVariable": { "variableName": "pressureThresholdBreached", "value": "3" } } ], "condition": "$input.PressureInput.sensorData.pressure > 70" }, { "eventName": "Pressure Okay", "actions": [ { "setVariable": { "variableName": "pressureThresholdBreached", "value": "$variable.pressureThresholdBreached - 1" } } ], "condition": "$input.PressureInput.sensorData.pressure <= 70" } ] }, "stateName": "Dangerous", "onEnter": { "events": [ { "eventName": "Pressure Threshold Breached", "actions": [ { "sns": { "targetArn": "arn:aws:sns:us-east-1:123456789012:underPressureAction" } } ], "condition": "$variable.pressureThresholdBreached > 1" } ] }, "onExit": { "events": [ { "eventName": "Normal Pressure Restored", "actions": [ { "sns": { "targetArn": "arn:aws:sns:us-east-1:123456789012:pressureClearedAction" } } ], "condition": "true" } ] } } ], "initialStateName": "Normal" } } } ``` Para obter mais informações, consulte [DescribeDetectorModel](https://docs.aws.amazon.com/iotevents/latest/apireference/API_DescribeDetectorModel) na *Referência da API do AWS IoT Events*. + Para ver detalhes da API, consulte [DescribeDetectorModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/describe-detector-model.html) na *Referência de comandos da AWS CLI*. ### `describe-detector` O código de exemplo a seguir mostra como usar `describe-detector`. **AWS CLI** **Para obter informações sobre um detector (instância).** O exemplo `describe-detector` a seguir exibe os detalhes do detector (instância) especificado. ``` aws iotevents-data describe-detector \ --detector-model-name motorDetectorModel \ --key-value "Fulton-A32" ``` Resultado: ``` { "detector": { "lastUpdateTime": 1560797852.776, "creationTime": 1560797852.775, "state": { "variables": [ { "name": "pressureThresholdBreached", "value": "3" } ], "stateName": "Dangerous", "timers": [] }, "keyValue": "Fulton-A32", "detectorModelName": "motorDetectorModel", "detectorModelVersion": "1" } } ``` Para obter mais informações, consulte [DescribeDetector](https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_DescribeDetector) na *Referência da API do AWS IoT Events*. + Para ver detalhes da API, consulte [DescribeDetector](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/describe-detector.html) na *Referência de comandos da AWS CLI*. ### `describe-input` O código de exemplo a seguir mostra como usar `describe-input`. **AWS CLI** **Para obter informações sobre uma entrada** O exemplo `describe-input` a seguir exibe os detalhes da entrada especificada. ``` aws iotevents describe-input \ --input-name PressureInput ``` Resultado: ``` { "input": { "inputConfiguration": { "status": "ACTIVE", "inputArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", "lastUpdateTime": 1560795312.542, "creationTime": 1560795312.542, "inputName": "PressureInput", "inputDescription": "Pressure readings from a motor" }, "inputDefinition": { "attributes": [ { "jsonPath": "sensorData.pressure" }, { "jsonPath": "motorid" } ] } } } ``` Para obter mais informações, consulte [DescribeInput](https://docs.aws.amazon.com/iotevents/latest/apireference/API_DescribeInput) na *Referência da API do AWS IoT Events*. + Para ver detalhes da API, consulte [DescribeInput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/describe-input.html) na *Referência de comandos da AWS CLI*. ### `describe-logging-options` O código de exemplo a seguir mostra como usar `describe-logging-options`. **AWS CLI** **Para obter informações sobre as configurações de log** O exemplo `describe-logging-options` a seguir recupera as configurações atuais de log do AWS IoT Events. ``` aws iotevents describe-logging-options ``` Resultado: ``` { "loggingOptions": { "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", "enabled": false, "level": "ERROR" } } ``` Para obter mais informações, consulte [DescribeLoggingOptions](https://docs.aws.amazon.com/iotevents/latest/apireference/API_DescribeLoggingOptions) na *Referência da API do AWS IoT Events*. + Para ver detalhes da API, consulte [DescribeLoggingOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/describe-logging-options.html) na *Referência de comandos da AWS CLI*. ### `list-detector-model-versions` O código de exemplo a seguir mostra como usar `list-detector-model-versions`. **AWS CLI** **Para obter informações sobre versões de um modelo de detector** O exemplo `list-detector-model-versions` a seguir lista todas as versões de um modelo de detector. Somente os metadados associados a cada versão de modelo de detector são retornados. ``` aws iotevents list-detector-model-versions \ --detector-model-name motorDetectorModel ``` Resultado: ``` { "detectorModelVersionSummaries": [ { "status": "ACTIVE", "lastUpdateTime": 1560796816.077, "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", "creationTime": 1560796816.077, "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel", "detectorModelName": "motorDetectorModel", "detectorModelVersion": "1" } ] } ``` Para obter mais informações, consulte [ListDetectorModelVersions](https://docs.aws.amazon.com/iotevents/latest/apireference/API_ListDetectorModelVersions) na *Referência da API do AWS IoT Events*. + Para ver detalhes da API, consulte [ListDetectorModelVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/list-detector-model-versions.html) na *Referência de comandos da AWS CLI*. ### `list-detector-models` O código de exemplo a seguir mostra como usar `list-detector-models`. **AWS CLI** **Para obter uma lista de seus modelos de detectores** O exemplo `list-detector-models` a seguir lista os modelos de detectores criados. Somente os metadados associados a cada modelo de detector são retornados. ``` aws iotevents list-detector-models ``` Resultado: ``` { "detectorModelSummaries": [ { "detectorModelName": "motorDetectorModel", "creationTime": 1552072424.212 "detectorModelDescription": "Detect overpressure in a motor." } ] } ``` Para obter mais informações, consulte [ListDetectorModels](https://docs.aws.amazon.com/iotevents/latest/apireference/API_ListDetectorModels) na *Referência da API do AWS IoT Events*. + Para ver detalhes da API, consulte [ListDetectorModels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/list-detector-models.html) na *Referência de comandos da AWS CLI*. ### `list-detectors` O código de exemplo a seguir mostra como usar `list-detectors`. **AWS CLI** **Para obter uma lista de detectores para um modelo de detector** O exemplo `list-detectors` a seguir lista os detectores (as instâncias de um modelo de detector) presentes na conta. ``` aws iotevents-data list-detectors \ --detector-model-name motorDetectorModel ``` Resultado: ``` { "detectorSummaries": [ { "lastUpdateTime": 1558129925.2, "creationTime": 1552073155.527, "state": { "stateName": "Normal" }, "keyValue": "Fulton-A32", "detectorModelName": "motorDetectorModel", "detectorModelVersion": "1" } ] } ``` Para obter mais informações, consulte [ListDetectors](https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_ListDetectors) na *Referência da API do AWS IoT Events*. + Para ver detalhes da API, consulte [ListDetectors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/list-detectors.html) na *Referência de comandos da AWS CLI*. ### `list-inputs` O código de exemplo a seguir mostra como usar `list-inputs`. **AWS CLI** **Para listar entradas** O exemplo `list-inputs` a seguir lista as entradas criadas na conta. ``` aws iotevents list-inputs ``` Este comando não produz saída. Resultado: ``` { { "status": "ACTIVE", "inputArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", "lastUpdateTime": 1551742986.768, "creationTime": 1551742986.768, "inputName": "PressureInput", "inputDescription": "Pressure readings from a motor" } } ``` Para obter mais informações, consulte [ListInputs](https://docs.aws.amazon.com/iotevents/latest/apireference/API_ListInputs) na *Referência da API do AWS IoT Events*. + Para ver detalhes da API, consulte [ListInputs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/list-inputs.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar tags atribuídas a um recurso.** O exemplo `list-tags-for-resource` a seguir lista as chaves de nomes e valores de tags atribuídas ao recurso. ``` aws iotevents list-tags-for-resource \ --resource-arn "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput" ``` Resultado: ``` { "tags": [ { "value": "motor", "key": "deviceType" } ] } ``` Para obter mais informações, consulte [ListTagsForResource](https://docs.aws.amazon.com/iotevents/latest/apireference/API_ListTagsForResource) na *Referência da API do AWS IoT Events*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `put-logging-options` O código de exemplo a seguir mostra como usar `put-logging-options`. **AWS CLI** **Para definir as opções de log** O exemplo `put-logging-options` a seguir recupera as opções atuais de log do AWS IoT Events. Se o valor de qualquer campo `loggingOptions` field, it can take up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the ``roleArn` for atualizado (por exemplo, para corrigir uma política inválida), levará até 5 minutos para que a mudança entre em vigor. ``` aws iotevents put-logging-options \ --cli-input-json file://logging-options.json ``` Conteúdo de `logging-options.json`: ``` { "loggingOptions": { "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", "level": "DEBUG", "enabled": true, "detectorDebugOptions": [ { "detectorModelName": "motorDetectorModel", "keyValue": "Fulton-A32" } ] } } ``` Este comando não produz saída. Para obter mais informações, consulte [PutLoggingOptions](https://docs.aws.amazon.com/iotevents/latest/apireference/API_PutLoggingOptions) na *Referência da API do AWS IoT Events*. + Para ver detalhes da API, consulte [PutLoggingOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/put-logging-options.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Para adicionar tags a um recurso** O exemplo `tag-resource` a seguir adiciona ou modifica (se a chave `deviceType` já existir) a tag anexada ao recurso especificado. ``` aws iotevents tag-resource \ --cli-input-json file://pressureInput.tag.json ``` Conteúdo de `pressureInput.tag.json`: ``` { "resourceArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", "tags": [ { "key": "deviceType", "value": "motor" } ] } ``` Este comando não produz saída. Para obter mais informações, consulte [TagResource](https://docs.aws.amazon.com/iotevents/latest/apireference/API_TagResource) na *Referência da API do AWS IoT Events*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Como remover as tags de um recurso** O exemplo `untag-resource` a seguir remove a tag com uma chave de nome do recurso especificado. ``` aws iotevents untag-resource \ --resource-arn arn:aws:iotevents:us-west-2:123456789012:input/PressureInput \ --tagkeys deviceType ``` Este comando não produz saída. Para obter mais informações, consulte [UntagResource](https://docs.aws.amazon.com/iotevents/latest/apireference/API_UntagResource) na *Referência da API do AWS IoT Events*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-detector-model` O código de exemplo a seguir mostra como usar `update-detector-model`. **AWS CLI** **Para atualizar um modelo de detector** O exemplo `update-detector-model` a seguir atualiza o modelo de detector especificado. Os detectores (instâncias) gerados pela versão anterior são excluídos e recriados à medida que novas entradas chegam. ``` aws iotevents update-detector-model \ --cli-input-json file://motorDetectorModel.update.json ``` Conteúdo de `motorDetectorModel.update.json`: ``` { "detectorModelName": "motorDetectorModel", "detectorModelDefinition": { "states": [ { "stateName": "Normal", "onEnter": { "events": [ { "eventName": "init", "condition": "true", "actions": [ { "setVariable": { "variableName": "pressureThresholdBreached", "value": "0" } } ] } ] }, "onInput": { "transitionEvents": [ { "eventName": "Overpressurized", "condition": "$input.PressureInput.sensorData.pressure > 70", "actions": [ { "setVariable": { "variableName": "pressureThresholdBreached", "value": "$variable.pressureThresholdBreached + 3" } } ], "nextState": "Dangerous" } ] } }, { "stateName": "Dangerous", "onEnter": { "events": [ { "eventName": "Pressure Threshold Breached", "condition": "$variable.pressureThresholdBreached > 1", "actions": [ { "sns": { "targetArn": "arn:aws:sns:us-east-1:123456789012:underPressureAction" } } ] } ] }, "onInput": { "events": [ { "eventName": "Overpressurized", "condition": "$input.PressureInput.sensorData.pressure > 70", "actions": [ { "setVariable": { "variableName": "pressureThresholdBreached", "value": "3" } } ] }, { "eventName": "Pressure Okay", "condition": "$input.PressureInput.sensorData.pressure <= 70", "actions": [ { "setVariable": { "variableName": "pressureThresholdBreached", "value": "$variable.pressureThresholdBreached - 1" } } ] } ], "transitionEvents": [ { "eventName": "BackToNormal", "condition": "$input.PressureInput.sensorData.pressure <= 70 && $variable.pressureThresholdBreached <= 1", "nextState": "Normal" } ] }, "onExit": { "events": [ { "eventName": "Normal Pressure Restored", "condition": "true", "actions": [ { "sns": { "targetArn": "arn:aws:sns:us-east-1:123456789012:pressureClearedAction" } } ] } ] } } ], "initialStateName": "Normal" }, "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole" } ``` Resultado: ``` { "detectorModelConfiguration": { "status": "ACTIVATING", "lastUpdateTime": 1560799387.719, "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", "creationTime": 1560799387.719, "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel", "key": "motorid", "detectorModelName": "motorDetectorModel", "detectorModelVersion": "2" } } ``` Para obter mais informações, consulte [UpdateDetectorModel](https://docs.aws.amazon.com/iotevents/latest/apireference/API_UpdateDetectorModel) na *Referência da API do AWS IoT Events*. + Para ver detalhes da API, consulte [UpdateDetectorModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/update-detector-model.html) na *Referência de comandos da AWS CLI*. ### `update-input` O código de exemplo a seguir mostra como usar `update-input`. **AWS CLI** **Para atualizar uma entrada** O exemplo `update-input` a seguir atualiza a entrada especificada com uma nova descrição e definição. ``` aws iotevents update-input \ --cli-input-json file://pressureInput.json ``` Conteúdo de `pressureInput.json`: ``` { "inputName": "PressureInput", "inputDescription": "Pressure readings from a motor", "inputDefinition": { "attributes": [ { "jsonPath": "sensorData.pressure" }, { "jsonPath": "motorid" } ] } } ``` Resultado: ``` { "inputConfiguration": { "status": "ACTIVE", "inputArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", "lastUpdateTime": 1560795976.458, "creationTime": 1560795312.542, "inputName": "PressureInput", "inputDescription": "Pressure readings from a motor" } } ``` Para obter mais informações, consulte [UpdateInput](https://docs.aws.amazon.com/iotevents/latest/apireference/API_UpdateInput) na *Referência da API do AWS IoT Events*. + Para ver detalhes da API, consulte [UpdateInput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/update-input.html) na *Referência de comandos da AWS CLI*. # AWS IoT Events-Data Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o AWS IoT Events-Data. *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 ### `batch-put-message` O código de exemplo a seguir mostra como usar `batch-put-message`. **AWS CLI** **Como enviar mensagens (entradas) para o AWS IoT Events** O exemplo `batch-put-message` a seguir envia um conjunto de mensagens para o sistema do AWS IoT Events. A carga útil de cada mensagem é transformada na entrada especificada (`inputName`) e ingerida em qualquer detector que monitore essa entrada. Por padrão, a ordem em que as mensagens são processadas é garantida quando várias mensagens são enviadas. Para garantir a ordem do processamento, deve-se enviar uma mensagem de cada vez e aguardar uma resposta bem-sucedida. ``` aws iotevents-data batch-put-message \ --cli-binary-format raw-in-base64-out \ --cli-input-json file://highPressureMessage.json ``` Conteúdo de `highPressureMessage.json`: ``` { "messages": [ { "messageId": "00001", "inputName": "PressureInput", "payload": "{\"motorid\": \"Fulton-A32\", \"sensorData\": {\"pressure\": 80, \"temperature\": 39} }" } ] } ``` Resultado: ``` { "BatchPutMessageErrorEntries": [] } ``` Para obter mais informações, consulte [BatchPutMessage](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-data-BatchPutMessage) no *Guia do desenvolvedor do AWS IoT Events\$1*. + Para ver detalhes da API, consulte [BatchPutMessage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/batch-put-message.html) na *Referência de comandos da AWS CLI*. ### `batch-update-detector` O código de exemplo a seguir mostra como usar `batch-update-detector`. **AWS CLI** **Para atualizar um detector (instância)** O exemplo `batch-update-detector` a seguir atualiza o estado, os valores das variáveis e as configurações do temporizador de um ou mais detectores (instâncias) de um modelo de detector especificado. ``` aws iotevents-data batch-update-detector \ --cli-input-json file://budFulton-A32.json ``` Conteúdo de `budFulton-A32.json`: ``` { "detectors": [ { "messageId": "00001", "detectorModelName": "motorDetectorModel", "keyValue": "Fulton-A32", "state": { "stateName": "Normal", "variables": [ { "name": "pressureThresholdBreached", "value": "0" } ], "timers": [ ] } } ] } ``` Resultado: ``` { "batchUpdateDetectorErrorEntries": [] } ``` Para obter mais informações, consulte [BatchUpdateDetector](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-data-BatchUpdateDetector) no *Guia do desenvolvedor do AWS IoT Events\$1*. + Para ver detalhes da API, consulte [BatchUpdateDetector](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/batch-update-detector.html) na *Referência de comandos da AWS CLI*. ### `create-detector-model` O código de exemplo a seguir mostra como usar `create-detector-model`. **AWS CLI** **Para criar um modelo de detector** O exemplo `create-detector-model` a seguir cria um modelo de detector. ``` aws iotevents create-detector-model \ --cli-input-json file://motorDetectorModel.json ``` Conteúdo de `motorDetectorModel.json`: ``` { "detectorModelName": "motorDetectorModel", "detectorModelDefinition": { "states": [ { "stateName": "Normal", "onEnter": { "events": [ { "eventName": "init", "condition": "true", "actions": [ { "setVariable": { "variableName": "pressureThresholdBreached", "value": "0" } } ] } ] }, "onInput": { "transitionEvents": [ { "eventName": "Overpressurized", "condition": "$input.PressureInput.sensorData.pressure > 70", "actions": [ { "setVariable": { "variableName": "pressureThresholdBreached", "value": "$variable.pressureThresholdBreached + 3" } } ], "nextState": "Dangerous" } ] } }, { "stateName": "Dangerous", "onEnter": { "events": [ { "eventName": "Pressure Threshold Breached", "condition": "$variable.pressureThresholdBreached > 1", "actions": [ { "sns": { "targetArn": "arn:aws:sns:us-east-1:123456789012:underPressureAction" } } ] } ] }, "onInput": { "events": [ { "eventName": "Overpressurized", "condition": "$input.PressureInput.sensorData.pressure > 70", "actions": [ { "setVariable": { "variableName": "pressureThresholdBreached", "value": "3" } } ] }, { "eventName": "Pressure Okay", "condition": "$input.PressureInput.sensorData.pressure <= 70", "actions": [ { "setVariable": { "variableName": "pressureThresholdBreached", "value": "$variable.pressureThresholdBreached - 1" } } ] } ], "transitionEvents": [ { "eventName": "BackToNormal", "condition": "$input.PressureInput.sensorData.pressure <= 70 && $variable.pressureThresholdBreached <= 1", "nextState": "Normal" } ] }, "onExit": { "events": [ { "eventName": "Normal Pressure Restored", "condition": "true", "actions": [ { "sns": { "targetArn": "arn:aws:sns:us-east-1:123456789012:pressureClearedAction" } } ] } ] } } ], "initialStateName": "Normal" }, "key": "motorid", "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole" } ``` Resultado: ``` { "detectorModelConfiguration": { "status": "ACTIVATING", "lastUpdateTime": 1560796816.077, "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", "creationTime": 1560796816.077, "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel", "key": "motorid", "detectorModelName": "motorDetectorModel", "detectorModelVersion": "1" } } ``` Para obter mais informações, consulte [CreateDetectorModel](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-CreateDetectorModel) no *AWSGuia do desenvolvedor do IoT Events\$1*. + Para ver detalhes da API, consulte [CreateDetectorModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/create-detector-model.html) na *Referência de comandos da AWS CLI*. ### `create-input` O código de exemplo a seguir mostra como usar `create-input`. **AWS CLI** **Para criar uma entrada** O exemplo `create-input` a seguir cria uma entrada. ``` aws iotevents create-input \ --cli-input-json file://pressureInput.json ``` Conteúdo de `pressureInput.json`: ``` { "inputName": "PressureInput", "inputDescription": "Pressure readings from a motor", "inputDefinition": { "attributes": [ { "jsonPath": "sensorData.pressure" }, { "jsonPath": "motorid" } ] } } ``` Resultado: ``` { "inputConfiguration": { "status": "ACTIVE", "inputArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", "lastUpdateTime": 1560795312.542, "creationTime": 1560795312.542, "inputName": "PressureInput", "inputDescription": "Pressure readings from a motor" } } ``` Para obter mais informações, consulte [CreateInput](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-CreateInput) no *Guia do desenvolvedor do AWS IoT Events\$1*. + Para ver detalhes da API, consulte [CreateInput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/create-input.html) na *Referência de comandos da AWS CLI*. ### `delete-detector-model` O código de exemplo a seguir mostra como usar `delete-detector-model`. **AWS CLI** **Para excluir um modelo de detector** O exemplo `delete-detector-model` a seguir exclui um modelo de detector. Todas as instâncias ativas do modelo do detector também são excluídas. ``` aws iotevents delete-detector-model \ --detector-model-name motorDetectorModel* ``` Este comando não produz saída. Para obter mais informações, consulte [DeleteDetectorModel](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-DeleteDetectorModel) no *Guia do desenvolvedor do AWS IoT Events\$1*. + Para ver detalhes da API, consulte [DeleteDetectorModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/delete-detector-model.html) na *Referência de comandos da AWS CLI*. ### `delete-input` O código de exemplo a seguir mostra como usar `delete-input`. **AWS CLI** **Para excluir uma entrada** O exemplo `delete-input` a seguir exclui uma entrada. ``` aws iotevents delete-input \ --input-name PressureInput ``` Este comando não produz saída. Para obter mais informações, consulte [DeleteInput](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-DeleteInput) no *Guia do desenvolvedor do AWS IoT Events\$1*. + Para ver detalhes da API, consulte [DeleteInput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/delete-input.html) na *Referência de comandos da AWS CLI*. ### `describe-detector-model` O código de exemplo a seguir mostra como usar `describe-detector-model`. **AWS CLI** **Para obter informações sobre um modelo de detector** O exemplo `describe-detector-model` a seguir descreve um modelo de detector. Se o parâmetro `version` não for especificado, o comando retornará informações sobre a versão mais recente. ``` aws iotevents describe-detector-model \ --detector-model-name motorDetectorModel ``` Resultado: ``` { "detectorModel": { "detectorModelConfiguration": { "status": "ACTIVE", "lastUpdateTime": 1560796816.077, "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", "creationTime": 1560796816.077, "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel", "key": "motorid", "detectorModelName": "motorDetectorModel", "detectorModelVersion": "1" }, "detectorModelDefinition": { "states": [ { "onInput": { "transitionEvents": [ { "eventName": "Overpressurized", "actions": [ { "setVariable": { "variableName": "pressureThresholdBreached", "value": "$variable.pressureThresholdBreached + 3" } } ], "condition": "$input.PressureInput.sensorData.pressure > 70", "nextState": "Dangerous" } ], "events": [] }, "stateName": "Normal", "onEnter": { "events": [ { "eventName": "init", "actions": [ { "setVariable": { "variableName": "pressureThresholdBreached", "value": "0" } } ], "condition": "true" } ] }, "onExit": { "events": [] } }, { "onInput": { "transitionEvents": [ { "eventName": "BackToNormal", "actions": [], "condition": "$input.PressureInput.sensorData.pressure <= 70 && $variable.pressureThresholdBreached <= 1", "nextState": "Normal" } ], "events": [ { "eventName": "Overpressurized", "actions": [ { "setVariable": { "variableName": "pressureThresholdBreached", "value": "3" } } ], "condition": "$input.PressureInput.sensorData.pressure > 70" }, { "eventName": "Pressure Okay", "actions": [ { "setVariable": { "variableName": "pressureThresholdBreached", "value": "$variable.pressureThresholdBreached - 1" } } ], "condition": "$input.PressureInput.sensorData.pressure <= 70" } ] }, "stateName": "Dangerous", "onEnter": { "events": [ { "eventName": "Pressure Threshold Breached", "actions": [ { "sns": { "targetArn": "arn:aws:sns:us-east-1:123456789012:underPressureAction" } } ], "condition": "$variable.pressureThresholdBreached > 1" } ] }, "onExit": { "events": [ { "eventName": "Normal Pressure Restored", "actions": [ { "sns": { "targetArn": "arn:aws:sns:us-east-1:123456789012:pressureClearedAction" } } ], "condition": "true" } ] } } ], "initialStateName": "Normal" } } } ``` Para obter mais informações, consulte [DescribeDetectorModel](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-DescribeDetectorModel) no *Guia do desenvolvedor do AWS IoT Events\$1*. + Para ver detalhes da API, consulte [DescribeDetectorModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/describe-detector-model.html) na *Referência de comandos da AWS CLI*. ### `describe-detector` O código de exemplo a seguir mostra como usar `describe-detector`. **AWS CLI** **Para obter informações sobre um detector (instância)** O exemplo `describe-detector` a seguir retorna informações sobre o detector especificado (instância). ``` aws iotevents-data describe-detector \ --detector-model-name motorDetectorModel \ --key-value "Fulton-A32" ``` Resultado: ``` { "detector": { "lastUpdateTime": 1560797852.776, "creationTime": 1560797852.775, "state": { "variables": [ { "name": "pressureThresholdBreached", "value": "3" } ], "stateName": "Dangerous", "timers": [] }, "keyValue": "Fulton-A32", "detectorModelName": "motorDetectorModel", "detectorModelVersion": "1" } } ``` Para obter mais informações, consulte [DescribeDetector](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-data-DescribeDetector) no *Guia do desenvolvedor do AWS IoT Events\$1*. + Para ver detalhes da API, consulte [DescribeDetector](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/describe-detector.html) na *Referência de comandos da AWS CLI*. ### `describe-input` O código de exemplo a seguir mostra como usar `describe-input`. **AWS CLI** **Para obter informações sobre uma entrada** O exemplo `describe-input` a seguir recupera os detalhes de uma entrada. ``` aws iotevents describe-input \ --input-name PressureInput ``` Resultado: ``` { "input": { "inputConfiguration": { "status": "ACTIVE", "inputArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", "lastUpdateTime": 1560795312.542, "creationTime": 1560795312.542, "inputName": "PressureInput", "inputDescription": "Pressure readings from a motor" }, "inputDefinition": { "attributes": [ { "jsonPath": "sensorData.pressure" }, { "jsonPath": "motorid" } ] } } } ``` Para obter mais informações, consulte [DescribeInput](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-DescribeInput) no *Guia do desenvolvedor do AWS IoT Events\$1*. + Para ver detalhes da API, consulte [DescribeInput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/describe-input.html) na *Referência de comandos da AWS CLI*. ### `describe-logging-options` O código de exemplo a seguir mostra como usar `describe-logging-options`. **AWS CLI** **Para obter informações sobre as configurações de log** O exemplo `describe-logging-options` a seguir recupera as opções atuais de registro do AWS IoT Events. ``` aws iotevents describe-logging-options ``` Resultado: ``` { "loggingOptions": { "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", "enabled": false, "level": "ERROR" } } ``` Para obter mais informações, consulte [DescribeLoggingOptions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-DescribeLoggingOptions) no *Guia do desenvolvedor do AWS IoT Events\$1*. + Para ver detalhes da API, consulte [DescribeLoggingOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/describe-logging-options.html) na *Referência de comandos da AWS CLI*. ### `list-detector-model-versions` O código de exemplo a seguir mostra como usar `list-detector-model-versions`. **AWS CLI** **Para obter informações sobre versões de um modelo de detector** O exemplo `list-detector-model-versions` a seguir lista todas as versões de um modelo de detector. Somente os metadados associados a cada versão de modelo de detector são retornados. ``` aws iotevents list-detector-model-versions \ --detector-model-name motorDetectorModel ``` Resultado: ``` { "detectorModelVersionSummaries": [ { "status": "ACTIVE", "lastUpdateTime": 1560796816.077, "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", "creationTime": 1560796816.077, "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel", "detectorModelName": "motorDetectorModel", "detectorModelVersion": "1" } ] } ``` Para obter mais informações, consulte [ListDetectorModelVersions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-ListDetectorModelVersions) no *Guia do desenvolvedor do AWS IoT Events\$1*. + Para ver detalhes da API, consulte [ListDetectorModelVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/list-detector-model-versions.html) na *Referência de comandos da AWS CLI*. ### `list-detector-models` O código de exemplo a seguir mostra como usar `list-detector-models`. **AWS CLI** **Para obter uma lista de seus modelos de detectores** O exemplo `list-detector-models` a seguir lista os modelos de detectores criados. Somente os metadados associados a cada modelo de detector são retornados. ``` aws iotevents list-detector-models ``` Resultado: ``` { "detectorModelSummaries": [ { "detectorModelName": "motorDetectorModel", "creationTime": 1552072424.212 "detectorModelDescription": "Detect overpressure in a motor." } ] } ``` Para obter mais informações, consulte [ListDetectorModels](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-ListDetectorModels) no *Guia do desenvolvedor do AWS IoT Events\$1*. + Para ver detalhes da API, consulte [ListDetectorModels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/list-detector-models.html) na *Referência de comandos da AWS CLI*. ### `list-detectors` O código de exemplo a seguir mostra como usar `list-detectors`. **AWS CLI** **Para obter uma lista de detectores para um modelo de detector** O exemplo `list-detectors` a seguir lista detectores (as instâncias de um modelo de detector). ``` aws iotevents-data list-detectors \ --detector-model-name motorDetectorModel ``` Resultado: ``` { "detectorSummaries": [ { "lastUpdateTime": 1558129925.2, "creationTime": 1552073155.527, "state": { "stateName": "Normal" }, "keyValue": "Fulton-A32", "detectorModelName": "motorDetectorModel", "detectorModelVersion": "1" } ] } ``` Para obter mais informações, consulte [ListDetectors](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-ListDetectors) no *Guia do desenvolvedor do AWS IoT Events\$1*. + Para ver detalhes da API, consulte [ListDetectors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/list-detectors.html) na *Referência de comandos da AWS CLI*. ### `list-inputs` O código de exemplo a seguir mostra como usar `list-inputs`. **AWS CLI** **Para listar entradas** O exemplo `list-inputs` a seguir lista as entradas criadas. ``` aws iotevents list-inputs ``` Resultado: ``` { "status": "ACTIVE", "inputArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", "lastUpdateTime": 1551742986.768, "creationTime": 1551742986.768, "inputName": "PressureInput", "inputDescription": "Pressure readings from a motor" } ``` Para obter mais informações, consulte [ListInputs](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-ListInputs) no *Guia do desenvolvedor do AWS IoT Events\$1*. + Para ver detalhes da API, consulte [ListInputs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/list-inputs.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar tags atribuídas a um recurso** O exemplo `list-tags-for-resource` a seguir lista as tags (metadados) atribuídas ao recurso. ``` aws iotevents list-tags-for-resource \ --resource-arn "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput" ``` Resultado: ``` { "tags": [ { "value": "motor", "key": "deviceType" } ] } ``` Para obter mais informações, consulte [ListTagsForResource](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-ListTagsForResource) no *Guia do desenvolvedor do AWS IoT Events\$1*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `put-logging-options` O código de exemplo a seguir mostra como usar `put-logging-options`. **AWS CLI** **Para definir as opções de log** O exemplo `list-tags-for-resource` a seguir recupera as opções atuais de log do AWS IoT Events. Se você atualizar o valor de qualquer campo `loggingOptions`, levará até um minuto para ver a mudança entrar em vigor. Além disso, se for alterada a política anexada à função especificada no campo `roleArn` (por exemplo, para corrigir uma política inválida) levará até 5 minutos para que a mudança entre em vigor. ``` aws iotevents put-logging-options \ --cli-input-json file://logging-options.json ``` Conteúdo de `logging-options.json`: ``` { "loggingOptions": { "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", "level": "DEBUG", "enabled": true, "detectorDebugOptions": [ { "detectorModelName": "motorDetectorModel", "keyValue": "Fulton-A32" } ] } } ``` Este comando não produz saída. Para obter mais informações, consulte [PutLoggingOptions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-PutLoggingOptions) no *Guia do desenvolvedor do AWS IoT Events\$1*. + Para ver detalhes da API, consulte [PutLoggingOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/put-logging-options.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Para adicionar tags a um recurso** O exemplo `tag-resource` a seguir adiciona ou modifica as tags do recurso determinado. Tags são metadados que podem ser usados para gerenciar um recurso. ``` aws iotevents tag-resource \ --cli-input-json file://pressureInput.tag.json ``` Conteúdo de `pressureInput.tag.json`: ``` { "resourceArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", "tags": [ { "key": "deviceType", "value": "motor" } ] } ``` Este comando não produz saída. Para obter mais informações, consulte [TagResource](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-TagResource) no *Guia do desenvolvedor do AWS IoT Events\$1*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Como remover as tags de um recurso** O exemplo `untag-resource` a seguir remove as tags especificadas do recurso. ``` aws iotevents untag-resource \ --cli-input-json file://pressureInput.untag.json ``` Conteúdo de `pressureInput.untag.json`: ``` { "resourceArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", "tagKeys": [ "deviceType" ] } ``` Este comando não produz saída. Para obter mais informações, consulte [UntagResource](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-UntagResource) no *Guia do desenvolvedor do AWS IoT Events\$1*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-detector-model` O código de exemplo a seguir mostra como usar `update-detector-model`. **AWS CLI** **Para atualizar um modelo de detector** O exemplo `update-detector-model` a seguir atualiza um modelo de detector. Os detectores (instâncias) gerados pela versão anterior são excluídos e recriados à medida que novas entradas chegam. ``` aws iotevents update-detector-model \ --cli-input-json file://motorDetectorModel.update.json ``` Conteúdo de motorDetectorModel.update.json: ``` { "detectorModelName": "motorDetectorModel", "detectorModelDefinition": { "states": [ { "stateName": "Normal", "onEnter": { "events": [ { "eventName": "init", "condition": "true", "actions": [ { "setVariable": { "variableName": "pressureThresholdBreached", "value": "0" } } ] } ] }, "onInput": { "transitionEvents": [ { "eventName": "Overpressurized", "condition": "$input.PressureInput.sensorData.pressure > 70", "actions": [ { "setVariable": { "variableName": "pressureThresholdBreached", "value": "$variable.pressureThresholdBreached + 3" } } ], "nextState": "Dangerous" } ] } }, { "stateName": "Dangerous", "onEnter": { "events": [ { "eventName": "Pressure Threshold Breached", "condition": "$variable.pressureThresholdBreached > 1", "actions": [ { "sns": { "targetArn": "arn:aws:sns:us-east-1:123456789012:underPressureAction" } } ] } ] }, "onInput": { "events": [ { "eventName": "Overpressurized", "condition": "$input.PressureInput.sensorData.pressure > 70", "actions": [ { "setVariable": { "variableName": "pressureThresholdBreached", "value": "3" } } ] }, { "eventName": "Pressure Okay", "condition": "$input.PressureInput.sensorData.pressure <= 70", "actions": [ { "setVariable": { "variableName": "pressureThresholdBreached", "value": "$variable.pressureThresholdBreached - 1" } } ] } ], "transitionEvents": [ { "eventName": "BackToNormal", "condition": "$input.PressureInput.sensorData.pressure <= 70 && $variable.pressureThresholdBreached <= 1", "nextState": "Normal" } ] }, "onExit": { "events": [ { "eventName": "Normal Pressure Restored", "condition": "true", "actions": [ { "sns": { "targetArn": "arn:aws:sns:us-east-1:123456789012:pressureClearedAction" } } ] } ] } } ], "initialStateName": "Normal" }, "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole" } ``` Resultado: ``` { "detectorModelConfiguration": { "status": "ACTIVATING", "lastUpdateTime": 1560799387.719, "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", "creationTime": 1560799387.719, "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel", "key": "motorid", "detectorModelName": "motorDetectorModel", "detectorModelVersion": "2" } } ``` Para obter mais informações, consulte [UpdateDetectorModel](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-UpdateDetectorModel) no *Guia do desenvolvedor do AWS IoT Events\$1*. + Para ver detalhes da API, consulte [UpdateDetectorModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/update-detector-model.html) na *Referência de comandos da AWS CLI*. ### `update-input` O código de exemplo a seguir mostra como usar `update-input`. **AWS CLI** **Para atualizar uma entrada** O seguinte exemplo de `update-input` atualiza uma entrada. ``` aws iotevents update-input \ --cli-input-json file://pressureInput.json ``` Conteúdo de `pressureInput.json`: ``` { "inputName": "PressureInput", "inputDescription": "Pressure readings from a motor", "inputDefinition": { "attributes": [ { "jsonPath": "sensorData.pressure" }, { "jsonPath": "motorid" } ] } } ``` Resultado: ``` { "inputConfiguration": { "status": "ACTIVE", "inputArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", "lastUpdateTime": 1560795976.458, "creationTime": 1560795312.542, "inputName": "PressureInput", "inputDescription": "Pressure readings from a motor" } } ``` Para obter mais informações, consulte [UpdateInput](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-UpdateInput) no *Guia do desenvolvedor do AWS IoT Events\$1*. + Para ver detalhes da API, consulte [UpdateInput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/update-input.html) na *Referência de comandos da AWS CLI*. # AWS IoT Greengrass Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o AWS IoT Greengrass. *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 ### `associate-role-to-group` O código de exemplo a seguir mostra como usar `associate-role-to-group`. **AWS CLI** **Associar um perfil a um grupo Greengrass** O exemplo `associate-role-to-group` a seguir associa o perfil do IAM específico a um grupo do Greengrass. O perfil de grupo é usado por funções e conectores locais do Lambda para acessar serviços da AWS. Por exemplo, seu perfil de grupo pode conceder as permissões necessárias para integrar com o CloudWatch Logs. ``` aws greengrass associate-role-to-group \ --group-id 2494ee3f-7f8a-4e92-a78b-d205f808b84b \ --role-arn arn:aws:iam::123456789012:role/GG-Group-Role ``` Resultado: ``` { "AssociatedAt": "2019-09-10T20:03:30Z" } ``` Para obter mais informações sobre grupos, consulte [Configurar Perfil de Grupo](https://docs.aws.amazon.com/greengrass/latest/developerguide/config-iam-roles.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [AssociateRoleToGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/associate-role-to-group.html) na *Referência de comandos da AWS CLI*. ### `associate-service-role-to-account` O código de exemplo a seguir mostra como usar `associate-service-role-to-account`. **AWS CLI** **Associar um perfil de serviço à sua conta AWS** O exemplo `associate-service-role-to-account` a seguir associa perfil de serviço do IAM, especificado por seu ARN, ao AWS IoT Greengrass em sua conta da AWS. É preciso ter criado, anteriormente, o perfil de serviço no IAM e associar a ele um documento de política que permita que o AWS IoT Greengrass assuma esse perfil. ``` aws greengrass associate-service-role-to-account \ --role-arn "arn:aws:iam::123456789012:role/service-role/Greengrass_ServiceRole" ``` Resultado: ``` { "AssociatedAt": "2019-06-25T18:12:45Z" } ``` Para obter mais informações sobre grupos, consulte [Perfil de Serviço do Greengrass](https://docs.aws.amazon.com/greengrass/latest/developerguide/service-role.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [AssociateServiceRoleToAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/associate-service-role-to-account.html) na * Referência do comando da AWS CLI*. ### `create-connector-definition-version` O código de exemplo a seguir mostra como usar `create-connector-definition-version`. **AWS CLI** **Criar uma versão de definição de conector** O exemplo `create-connector-definition-version` a seguir cria uma versão de definição de conector e a associa à definição de conector específica. Todos os conectores em uma versão definem valores para seus parâmetros. ``` aws greengrass create-connector-definition-version \ --connector-definition-id "55d0052b-0d7d-44d6-b56f-21867215e118" \ --connectors "[{\"Id\": \"MyTwilioNotificationsConnector\", \"ConnectorArn\": \"arn:aws:greengrass:us-west-2::/connectors/TwilioNotifications/versions/2\", \"Parameters\": {\"TWILIO_ACCOUNT_SID\": \"AC1a8d4204890840d7fc482aab38090d57\", \"TwilioAuthTokenSecretArn\": \"arn:aws:secretsmanager:us-west-2:123456789012:secret:greengrass-TwilioAuthToken-ntSlp6\", \"TwilioAuthTokenSecretArn-ResourceId\": \"TwilioAuthToken\", \"DefaultFromPhoneNumber\": \"4254492999\"}}]" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/55d0052b-0d7d-44d6-b56f-21867215e118/versions/33f709a0-c825-49cb-9eea-dc8964fbd635", "CreationTimestamp": "2019-06-24T20:46:30.134Z", "Id": "55d0052b-0d7d-44d6-b56f-21867215e118", "Version": "33f709a0-c825-49cb-9eea-dc8964fbd635" } ``` + Para ver detalhes da API, consulte [CreateConnectorDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-connector-definition-version.html) na *Referência de comandos da AWS CLI*. ### `create-connector-definition` O código de exemplo a seguir mostra como usar `create-connector-definition`. **AWS CLI** **Criar uma definição de conector** O exemplo `create-connector-definition` a seguir cria uma definição de conector e uma versão inicial de definição de conector. A versão inicial contém um conector. Todos os conectores em uma versão definem valores para seus parâmetros. ``` aws greengrass create-connector-definition \ --name MySNSConnector \ --initial-version "{\"Connectors\": [{\"Id\":\"MySNSConnector\",\"ConnectorArn\":\"arn:aws:greengrass:us-west-2::/connectors/SNS/versions/1\",\"Parameters\": {\"DefaultSNSArn\":\"arn:aws:sns:us-west-2:123456789012:GGConnectorTopic\"}}]}" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/b5c4ebfd-f672-49a3-83cd-31c7216a7bb8", "CreationTimestamp": "2019-06-19T19:30:01.300Z", "Id": "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8", "LastUpdatedTimestamp": "2019-06-19T19:30:01.300Z", "LatestVersion": "63c57963-c7c2-4a26-a7e2-7bf478ea2623", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/b5c4ebfd-f672-49a3-83cd-31c7216a7bb8/versions/63c57963-c7c2-4a26-a7e2-7bf478ea2623", "Name": "MySNSConnector" } ``` Para obter mais informações, consulte [Introdução aos Conectores Greengrass (CLI)](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-cli.html) no **Guia do Desenvolvedor do AWS IoT Greengrass**. + Para ver detalhes da API, consulte [CreateConnectorDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-connector-definition.html) na *Referência de comandos da AWS CLI*. ### `create-core-definition-version` O código de exemplo a seguir mostra como usar `create-core-definition-version`. **AWS CLI** **Criar uma versão de definição de núcleo** O exemplo `create-core-definition-version` a seguir cria uma versão de definição de núcleo e a associa à definição de núcleo específica. A versão pode conter apenas um núcleo. Antes de criar um núcleo, é preciso antes criar e fornecer o item do AWS IoT correspondente. Esse processo inclui os seguintes `iot` comandos, que retornam `ThingArn` e `CertificateArn` necessários para o comando `create-core-definition-version`. Criar o item do AWS IoT que corresponde ao dispositivo principal: ``` aws iot create-thing \ --thing-name "MyCoreDevice" ``` Resultado: ``` { "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyCoreDevice", "thingName": "MyCoreDevice", "thingId": "cb419a19-9099-4515-9cec-e9b0e760608a" } ``` Criar chaves públicas e privadas, além do certificado do dispositivo principal para o item. Este exemplo usa o comando `create-keys-and-certificate` e exige permissões de gravação no diretório atual. Como alternativa, você pode usar o comando `create-certificate-from-csr`. ``` aws iot create-keys-and-certificate \ --set-as-active \ --certificate-pem-outfile "myCore.cert.pem" \ --public-key-outfile "myCore.public.key" \ --private-key-outfile "myCore.private.key" ``` Resultado: ``` { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz", "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDWTCAkGgAwIBATgIUCgq6EGqou6zFqWgIZRndgQEFW+gwDQYJKoZIhvc...KdGewQS\n-----END CERTIFICATE-----\n", "keyPair": { "PublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBzrqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqKpRgnn6yq26U3y...wIDAQAB\n-----END PUBLIC KEY-----\n", "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIABAKCAQEAqKpRgnn6yq26U3yt5YFZquyukfRjbMXDcNOK4rMCxDR...fvY4+te\n-----END RSA PRIVATE KEY-----\n" }, "certificateId": "123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz" } ``` Criar uma política do AWS IoT que permita ações `iot` e `greengrass`. Simplificando, a política a seguir permite ações em todos os recursos, mas sua política deve ser mais restritiva. ``` aws iot create-policy \ --policy-name "Core_Devices" \ --policy-document "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}" ``` Resultado: ``` { "policyName": "Core_Devices", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/Core_Devices", "policyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}", "policyVersionId": "1" } ``` Anexar a política ao certificado: ``` aws iot attach-policy \ --policy-name "Core_Devices" \ --target "arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz" ``` Este comando não produz saída. Anexar o item ao certificado: ``` aws iot attach-thing-principal \ --thing-name "MyCoreDevice" \ --principal "arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz" ``` Este comando não produz saída. Criar uma versão de definição de núcleo: ``` aws greengrass create-core-definition-version \ --core-definition-id "582efe12-b05a-409e-9a24-a2ba1bcc4a12" \ --cores "[{\"Id\":\"MyCoreDevice\",\"ThingArn\":\"arn:aws:iot:us-west-2:123456789012:thing/MyCoreDevice\",\"CertificateArn\":\"arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz\",\"SyncShadow\":true}]" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/582efe12-b05a-409e-9a24-a2ba1bcc4a12/versions/3fdc1190-2ce5-44de-b98b-eec8f9571014", "Version": "3fdc1190-2ce5-44de-b98b-eec8f9571014", "CreationTimestamp": "2019-09-18T00:15:09.838Z", "Id": "582efe12-b05a-409e-9a24-a2ba1bcc4a12" } ``` Para obter mais informações, consulte [Configurar AWS IoT Greengrass Core](https://docs.aws.amazon.com/greengrass/latest/developerguide/gg-core.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [CreateCoreDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-core-definition-version.html) na *Referência de comandos da AWS CLI*. ### `create-core-definition` O código de exemplo a seguir mostra como usar `create-core-definition`. **AWS CLI** **Exemplo 1: criar uma definição de núcleo vazia** O exemplo `create-core-definition` a seguir cria uma definição de núcleo Greengrass vazia (sem versão inicial). Antes que o núcleo possa ser usado, é necessário usar o comando `create-core-definition-version` para fornecer os outros parâmetros do núcleo. ``` aws greengrass create-core-definition \ --name cliGroup_Core ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/b5c08008-54cb-44bd-9eec-c121b04283b5", "CreationTimestamp": "2019-06-25T18:23:22.106Z", "Id": "b5c08008-54cb-44bd-9eec-c121b04283b5", "LastUpdatedTimestamp": "2019-06-25T18:23:22.106Z", "Name": "cliGroup_Core" } ``` **Exemplo 2: criar uma definição de núcleo com uma versão inicial** O exemplo `create-core-definition` a seguir cria uma definição de núcleo que contém uma versão inicial da definição de núcleo. A versão pode conter apenas um núcleo. Antes de criar um núcleo, é preciso antes criar e fornecer o item do AWS IoT correspondente. Esse processo inclui os seguintes `iot` comandos, que retornam `ThingArn` e `CertificateArn` necessários para o comando `create-core-definition`. Criar o item do AWS IoT que corresponde ao dispositivo principal: ``` aws iot create-thing \ --thing-name "MyCoreDevice" ``` Resultado: ``` { "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyCoreDevice", "thingName": "MyCoreDevice", "thingId": "cb419a19-9099-4515-9cec-e9b0e760608a" } ``` Criar chaves públicas e privadas, além do certificado do dispositivo principal para o item. Este exemplo usa o comando `create-keys-and-certificate` e exige permissões de gravação no diretório atual. Como alternativa, você pode usar o comando `create-certificate-from-csr`. ``` aws iot create-keys-and-certificate \ --set-as-active \ --certificate-pem-outfile "myCore.cert.pem" \ --public-key-outfile "myCore.public.key" \ --private-key-outfile "myCore.private.key" ``` Resultado: ``` { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz", "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDWTCAkGgAwIBATgIUCgq6EGqou6zFqWgIZRndgQEFW+gwDQYJKoZIhvc...KdGewQS\n-----END CERTIFICATE-----\n", "keyPair": { "PublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBzrqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqKpRgnn6yq26U3y...wIDAQAB\n-----END PUBLIC KEY-----\n", "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIABAKCAQEAqKpRgnn6yq26U3yt5YFZquyukfRjbMXDcNOK4rMCxDR...fvY4+te\n-----END RSA PRIVATE KEY-----\n" }, "certificateId": "123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz" } ``` Criar uma política do AWS IoT que permita ações `iot` e `greengrass`. Simplificando, a política a seguir permite ações em todos os recursos, mas sua política deve ser mais restritiva. ``` aws iot create-policy \ --policy-name "Core_Devices" \ --policy-document "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}" ``` Resultado: ``` { "policyName": "Core_Devices", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/Core_Devices", "policyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}", "policyVersionId": "1" } ``` Anexar a política ao certificado: ``` aws iot attach-policy \ --policy-name "Core_Devices" \ --target "arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz" ``` Este comando não produz saída. Anexar o item ao certificado: ``` aws iot attach-thing-principal \ --thing-name "MyCoreDevice" \ --principal "arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz" ``` Este comando não produz saída. Criar uma definição de núcleo: ``` aws greengrass create-core-definition \ --name "MyCores" \ --initial-version "{\"Cores\":[{\"Id\":\"MyCoreDevice\",\"ThingArn\":\"arn:aws:iot:us-west-2:123456789012:thing/MyCoreDevice\",\"CertificateArn\":\"arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz\",\"SyncShadow\":true}]}" ``` Resultado: ``` { "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/582efe12-b05a-409e-9a24-a2ba1bcc4a12/versions/cc87b5b3-8f4b-465d-944c-1d6de5dbfcdb", "Name": "MyCores", "LastUpdatedTimestamp": "2019-09-18T00:11:06.197Z", "LatestVersion": "cc87b5b3-8f4b-465d-944c-1d6de5dbfcdb", "CreationTimestamp": "2019-09-18T00:11:06.197Z", "Id": "582efe12-b05a-409e-9a24-a2ba1bcc4a12", "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/582efe12-b05a-409e-9a24-a2ba1bcc4a12" } ``` Para obter mais informações, consulte [Configurar AWS IoT Greengrass Core](https://docs.aws.amazon.com/greengrass/latest/developerguide/gg-core.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [CreateCoreDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-core-definition.html) na *Referência de comandos da AWS CLI*. ### `create-deployment` O código de exemplo a seguir mostra como usar `create-deployment`. **AWS CLI** **Criar uma implantação para uma versão de um grupo do Greengrass** O exemplo `create-deployment` a seguir implanta a versão específica de um grupo do Greengrass. ``` aws greengrass create-deployment \ --deployment-type NewDeployment \ --group-id "ce2e7d01-3240-4c24-b8e6-f6f6e7a9eeca" \ --group-version-id "dc40c1e9-e8c8-4d28-a84d-a9cad5f599c9" ``` Resultado: ``` { "DeploymentArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/ce2e7d01-3240-4c24-b8e6-f6f6e7a9eeca/deployments/bfceb608-4e97-45bc-af5c-460144270308", "DeploymentId": "bfceb608-4e97-45bc-af5c-460144270308" } ``` Para obter mais informações, consulte [Introdução a Conectores (CLI)](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-cli.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Consulte detalhes da API em [CreateDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-deployment.html) na *Referência de comandos da AWS CLI*. ### `create-device-definition-version` O código de exemplo a seguir mostra como usar `create-device-definition-version`. **AWS CLI** **Criar uma versão de definição de dispositivo** O exemplo `create-device-definition-version` a seguir cria uma versão de definição de dispositivo e a associa à definição de dispositivo específica. A versão define dois dispositivos. Antes de criar um dispositivo Greengrass, é necessário primeiro criar e provisionar o item do AWS IoT correspondente. Esse processo inclui os seguintes comandos `iot` que devem ser executados para obter informações necessárias para o comando Greengrass: Criar o item do AWS IoT correspondente ao dispositivo: ``` aws iot create-thing \ --thing-name "InteriorTherm" ``` Resultado: ``` { "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/InteriorTherm", "thingName": "InteriorTherm", "thingId": "01d4763c-78a6-46c6-92be-7add080394bf" } ``` Crie chaves públicas e privadas, além do certificado do dispositivo para o item. Este exemplo usa o comando `create-keys-and-certificate` e exige permissões de gravação no diretório atual. Como alternativa, você pode usar o comando `create-certificate-from-csr`: ``` aws iot create-keys-and-certificate \ --set-as-active \ --certificate-pem-outfile "myDevice.cert.pem" \ --public-key-outfile "myDevice.public.key" \ --private-key-outfile "myDevice.private.key" ``` Resultado: ``` { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92", "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDWTCAkGgAwIBATgIUCgq6EGqou6zFqWgIZRndgQEFW+gwDQYJKoZIhvc...KdGewQS\n-----END CERTIFICATE-----\n", "keyPair": { "PublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBzrqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqKpRgnn6yq26U3y...wIDAQAB\n-----END PUBLIC KEY-----\n", "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIABAKCAQEAqKpRgnn6yq26U3yt5YFZquyukfRjbMXDcNOK4rMCxDR...fvY4+te\n-----END RSA PRIVATE KEY-----\n" }, "certificateId": "66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92" } ``` Criar uma política do AWS IoT que permita ações `iot` e `greengrass`. Para simplificar, a política a seguir permite ações em todos os recursos, mas sua política pode ficar mais rigorosa: ``` aws iot create-policy \ --policy-name "GG_Devices" \ --policy-document "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}" ``` Resultado: ``` { "policyName": "GG_Devices", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/GG_Devices", "policyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}", "policyVersionId": "1" } ``` Anexar a política ao certificado: ``` aws iot attach-policy \ --policy-name "GG_Devices" \ --target "arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92" ``` Anexar o item ao certificado ``` aws iot attach-thing-principal \ --thing-name "InteriorTherm" \ --principal "arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92" ``` Depois de criar e configurar o item IoT conforme demonstrado anteriormente, use `ThingArn` e `CertificateArn` dos dois primeiros comandos no exemplo a seguir. ``` aws greengrass create-device-definition-version \ --device-definition-id "f9ba083d-5ad4-4534-9f86-026a45df1ccd" \ --devices "[{\"Id\":\"InteriorTherm\",\"ThingArn\":\"arn:aws:iot:us-west-2:123456789012:thing/InteriorTherm\",\"CertificateArn\":\"arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92\",\"SyncShadow\":true},{\"Id\":\"ExteriorTherm\",\"ThingArn\":\"arn:aws:iot:us-west-2:123456789012:thing/ExteriorTherm\",\"CertificateArn\":\"arn:aws:iot:us-west-2:123456789012:cert/6c52ce1b47bde88a637e9ccdd45fe4e4c2c0a75a6866f8f63d980ee22fa51e02\",\"SyncShadow\":true}]" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd/versions/83c13984-6fed-447e-84d5-5b8aa45d5f71", "Version": "83c13984-6fed-447e-84d5-5b8aa45d5f71", "CreationTimestamp": "2019-09-11T00:15:09.838Z", "Id": "f9ba083d-5ad4-4534-9f86-026a45df1ccd" } ``` + Para ver detalhes da API, consulte [CreateDeviceDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-device-definition-version.html) na *Referência de comandos da AWS CLI*. ### `create-device-definition` O código de exemplo a seguir mostra como usar `create-device-definition`. **AWS CLI** **Criar uma definição de dispositivo** O exemplo `create-device-definition` a seguir cria uma definição de dispositivo que contém uma versão inicial da definição de dispositivo. A versão inicial define dois dispositivos. Antes de criar um dispositivo Greengrass, é necessário primeiro criar e provisionar o item do AWS IoT correspondente. Esse processo inclui os seguintes comandos `iot` que devem ser executados para obter informações necessárias para o comando Greengrass: Criar o item do AWS IoT correspondente ao dispositivo: ``` aws iot create-thing \ --thing-name "InteriorTherm" ``` Resultado: ``` { "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/InteriorTherm", "thingName": "InteriorTherm", "thingId": "01d4763c-78a6-46c6-92be-7add080394bf" } ``` Crie chaves públicas e privadas, além do certificado do dispositivo para o item. Este exemplo usa o comando `create-keys-and-certificate` e exige permissões de gravação no diretório atual. Como alternativa, você pode usar o comando `create-certificate-from-csr`: ``` aws iot create-keys-and-certificate \ --set-as-active \ --certificate-pem-outfile "myDevice.cert.pem" \ --public-key-outfile "myDevice.public.key" \ --private-key-outfile "myDevice.private.key" ``` Resultado: ``` { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92", "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDWTCAkGgAwIBATgIUCgq6EGqou6zFqWgIZRndgQEFW+gwDQYJKoZIhvc...KdGewQS\n-----END CERTIFICATE-----\n", "keyPair": { "PublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBzrqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqKpRgnn6yq26U3y...wIDAQAB\n-----END PUBLIC KEY-----\n", "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIABAKCAQEAqKpRgnn6yq26U3yt5YFZquyukfRjbMXDcNOK4rMCxDR...fvY4+te\n-----END RSA PRIVATE KEY-----\n" }, "certificateId": "66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92" } ``` Criar uma política do AWS IoT que permita ações `iot` e `greengrass`. Para simplificar, a política a seguir permite ações em todos os recursos, mas sua política pode ficar mais rigorosa: ``` aws iot create-policy \ --policy-name "GG_Devices" \ --policy-document "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}" ``` Resultado: ``` { "policyName": "GG_Devices", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/GG_Devices", "policyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}", "policyVersionId": "1" } ``` Anexar a política ao certificado: ``` aws iot attach-policy \ --policy-name "GG_Devices" \ --target "arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92" ``` Anexar o item ao certificado ``` aws iot attach-thing-principal \ --thing-name "InteriorTherm" \ --principal "arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92" ``` Depois de criar e configurar o item IoT conforme demonstrado anteriormente, use `ThingArn` e `CertificateArn` dos dois primeiros comandos no exemplo a seguir. ``` aws greengrass create-device-definition \ --name "Sensors" \ --initial-version "{\"Devices\":[{\"Id\":\"InteriorTherm\",\"ThingArn\":\"arn:aws:iot:us-west-2:123456789012:thing/InteriorTherm\",\"CertificateArn\":\"arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92\",\"SyncShadow\":true},{\"Id\":\"ExteriorTherm\",\"ThingArn\":\"arn:aws:iot:us-west-2:123456789012:thing/ExteriorTherm\",\"CertificateArn\":\"arn:aws:iot:us-west-2:123456789012:cert/6c52ce1b47bde88a637e9ccdd45fe4e4c2c0a75a6866f8f63d980ee22fa51e02\",\"SyncShadow\":true}]}" ``` Resultado: ``` { "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd/versions/3b5cc510-58c1-44b5-9d98-4ad858ffa795", "Name": "Sensors", "LastUpdatedTimestamp": "2019-09-11T00:11:06.197Z", "LatestVersion": "3b5cc510-58c1-44b5-9d98-4ad858ffa795", "CreationTimestamp": "2019-09-11T00:11:06.197Z", "Id": "f9ba083d-5ad4-4534-9f86-026a45df1ccd", "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd" } ``` + Para ver detalhes da API, consulte [CreateDeviceDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-device-definition.html) na *Referência de comandos da AWS CLI*. ### `create-function-definition-version` O código de exemplo a seguir mostra como usar `create-function-definition-version`. **AWS CLI** **Criar uma versão da definição da função** O exemplo `create-function-definition-version` a seguir cria uma nova versão da definição de função específica. Essa versão especifica uma única função cujo ID é `Hello-World-function`, permite acesso ao sistema de arquivos e determina um tamanho máximo de memória e um período de tempo limite. ``` aws greengrass create-function-definition-version \ --cli-input-json "{\"FunctionDefinitionId\": \"e626e8c9-3b8f-4bf3-9cdc-d26ecdeb9fa3\",\"Functions\": [{\"Id\": \"Hello-World-function\", \"FunctionArn\": \""arn:aws:lambda:us-west-2:123456789012:function:Greengrass_HelloWorld_Counter:gghw-alias"\",\"FunctionConfiguration\": {\"Environment\": {\"AccessSysfs\": true},\"Executable\": \"greengrassHelloWorldCounter.function_handler\",\"MemorySize\": 16000,\"Pinned\": false,\"Timeout\": 25}}]}" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/e626e8c9-3b8f-4bf3-9cdc-d26ecdeb9fa3/versions/74abd1cc-637e-4abe-8684-9a67890f4043", "CreationTimestamp": "2019-06-25T22:03:43.376Z", "Id": "e626e8c9-3b8f-4bf3-9cdc-d26ecdeb9fa3", "Version": "74abd1cc-637e-4abe-8684-9a67890f4043" } ``` + Para ver detalhes da API, consulte [CreateFunctionDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-function-definition-version.html) na *Referência de comandos da AWS CLI*. ### `create-function-definition` O código de exemplo a seguir mostra como usar `create-function-definition`. **AWS CLI** **Criar uma definição da função do Lambda** O exemplo `create-function-definition` a seguir cria uma definição de função do Lambda e uma versão inicial, fornecendo uma lista de funções do Lambda (neste caso, uma lista de apenas uma função chamada `TempMonitorFunction`) e suas configurações. Antes de criar a definição da função, é necessária a função do Lambda ARN. Para criar a função e seu respectivo alias, use comandos `create-function` e `publish-version` do Lambda. O comando `create-function` do Lambda exige o ARN do perfil de execução, embora o AWS IoT Greengrass não use esse perfil porque as permissões são especificadas no perfil de grupo do Greengrass. Você pode usar o comando `create-role` IAM para criar um perfil vazio e obter um ARN para usar com o `create-function` do Lambda ou usar um perfil de execução existente. ``` aws greengrass create-function-definition \ --name MyGreengrassFunctions \ --initial-version "{\"Functions\": [{\"Id\": \"TempMonitorFunction\", \"FunctionArn\": \"arn:aws:lambda:us-west-2:123456789012:function:TempMonitor:GG_TempMonitor\", \"FunctionConfiguration\": {\"Executable\": \"temp_monitor.function_handler\", \"MemorySize\": 16000,\"Timeout\": 5}}]}" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/3b0d0080-87e7-48c6-b182-503ec743a08b", "CreationTimestamp": "2019-06-19T22:24:44.585Z", "Id": "3b0d0080-87e7-48c6-b182-503ec743a08b", "LastUpdatedTimestamp": "2019-06-19T22:24:44.585Z", "LatestVersion": "67f918b9-efb4-40b0-b87c-de8c9faf085b", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/3b0d0080-87e7-48c6-b182-503ec743a08b/versions/67f918b9-efb4-40b0-b87c-de8c9faf085b", "Name": "MyGreengrassFunctions" } ``` Para obter mais informações, consulte [How to Configure Local Resource Access Using the AWS Command Line Interface](https://docs.aws.amazon.com/greengrass/latest/developerguide/lra-cli.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [CreateFunctionDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-function-definition.html) na *Referência de comandos da AWS CLI*. ### `create-group-certificate-authority` O código de exemplo a seguir mostra como usar `create-group-certificate-authority`. **AWS CLI** **Criar uma autoridade de certificação (CA) para um grupo** O exemplo `create-group-certificate-authority` a seguir cria ou alterna uma CA para o grupo específico. ``` aws greengrass create-group-certificate-authority \ --group-id "8eaadd72-ce4b-4f15-892a-0cc4f3a343f1" ``` Resultado: ``` { "GroupCertificateAuthorityArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/8eaadd72-ce4b-4f15-892a-0cc4f3a343f1/certificateauthorities/d31630d674c4437f6c5dbc0dca56312a902171ce2d086c38e509c8EXAMPLEcc5" } ``` Para obter mais informações sobre grupos, consulte [Segurança do AWS IoT Greengrass](https://docs.aws.amazon.com/greengrass/latest/developerguide/gg-sec.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [CreateGroupCertificateAuthority](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-group-certificate-authority.html) na *Referência de comandos da AWS CLI*. ### `create-group-version` O código de exemplo a seguir mostra como usar `create-group-version`. **AWS CLI** **Criar uma versão de um grupo do Greengrass** O exemplo `create-group-version` a seguir cria uma versão de grupo e a associa ao grupo específico. A versão faz referência às versões de núcleo, recurso, conector, função e assinatura que contêm as entidades a serem incluídas nessa versão de grupo. É necessário criar essas entidades antes da versão de grupo. Para criar uma definição de recurso com uma versão inicial, use o comando `create-resource-definition`.Para criar uma definição de conector com uma versão inicial, use o comando `create-connector-definition`.Para criar uma definição de função com uma versão inicial, use o comando `create-function-definition`.Para criar uma definição de assinatura com uma versão inicial, use o comando `create-subscription-definition`.Para recuperar o ARN da última versão da definição de núcleo, use o comando `get-group-version` e especifique a ID da última versão do grupo. ``` aws greengrass create-group-version \ --group-id "ce2e7d01-3240-4c24-b8e6-f6f6e7a9eeca" \ --core-definition-version-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/6a630442-8708-4838-ad36-eb98849d975e/versions/6c87151b-1fb4-4cb2-8b31-6ee715d8f8ba" \ --resource-definition-version-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/c8bb9ebc-c3fd-40a4-9c6a-568d75569d38/versions/a5f94d0b-f6bc-40f4-bb78-7a1c5fe13ba1" \ --connector-definition-version-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/55d0052b-0d7d-44d6-b56f-21867215e118/versions/78a3331b-895d-489b-8823-17b4f9f418a0" \ --function-definition-version-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/3b0d0080-87e7-48c6-b182-503ec743a08b/versions/67f918b9-efb4-40b0-b87c-de8c9faf085b" \ --subscription-definition-version-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/9d611d57-5d5d-44bd-a3b4-feccbdd69112/versions/aa645c47-ac90-420d-9091-8c7ffa4f103f" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/ce2e7d01-3240-4c24-b8e6-f6f6e7a9eeca/versions/e10b0459-4345-4a09-88a4-1af1f5d34638", "CreationTimestamp": "2019-06-20T18:42:47.020Z", "Id": "ce2e7d01-3240-4c24-b8e6-f6f6e7a9eeca", "Version": "e10b0459-4345-4a09-88a4-1af1f5d34638" } ``` *Para obter mais informações, consulte [Overview of the AWS IoT Greengrass Group Object Model](https://docs.aws.amazon.com/greengrass/latest/developerguide/deployments.html#api-overview) no Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [CreateGroupVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-group-version.html) na *Referência de comandos da AWS CLI*. ### `create-group` O código de exemplo a seguir mostra como usar `create-group`. **AWS CLI** **Criar um grupo Greengrass** O exemplo `create-group` a seguir cria um grupo chamado `cli-created-group`. ``` aws greengrass create-group \ --name cli-created-group ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/4e22bd92-898c-436b-ade5-434d883ff749", "CreationTimestamp": "2019-06-25T18:07:17.688Z", "Id": "4e22bd92-898c-436b-ade5-434d883ff749", "LastUpdatedTimestamp": "2019-06-25T18:07:17.688Z", "Name": "cli-created-group" } ``` *Para obter mais informações, consulte [Overview of the AWS IoT Greengrass Group Object Model](https://docs.aws.amazon.com/greengrass/latest/developerguide/deployments.html#api-overview) no Guia do Desenvolvedor do AWS IoT Greengrass*. + Consulte detalhes da API em [CreateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-group.html) na *Referência de comandos da AWS CLI*. ### `create-logger-definition-version` O código de exemplo a seguir mostra como usar `create-logger-definition-version`. **AWS CLI** **Criar uma versão de definição de logger** O exemplo `create-logger-definition-version` a seguir cria uma versão de definição de logger e a associa a uma definição de logger. A versão define quatro configurações de log: 1) logs de componentes do sistema no sistema de arquivos do dispositivo principal, 2) logs de funções do Lambda definidas pelo usuário no sistema de arquivos do dispositivo principal, 3) logs de componentes do sistema no Amazon CloudWatch Logs e 4) logs de funções do Lambda definidas pelo usuário no Amazon CloudWatch Logs. Observação: para integrar os logs do CloudWatch, sua função de grupo deve conceder as permissões apropriadas. ``` aws greengrass create-logger-definition-version \ --logger-definition-id "a454b62a-5d56-4ca9-bdc4-8254e1662cb0" \ --loggers "[{\"Id\":\"1\",\"Component\":\"GreengrassSystem\",\"Level\":\"ERROR\",\"Space\":10240,\"Type\":\"FileSystem\"},{\"Id\":\"2\",\"Component\":\"Lambda\",\"Level\":\"INFO\",\"Space\":10240,\"Type\":\"FileSystem\"},{\"Id\":\"3\",\"Component\":\"GreengrassSystem\",\"Level\":\"WARN\",\"Type\":\"AWSCloudWatch\"},{\"Id\":\"4\",\"Component\":\"Lambda\",\"Level\":\"INFO\",\"Type\":\"AWSCloudWatch\"}]" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/a454b62a-5d56-4ca9-bdc4-8254e1662cb0/versions/49aedb1e-01a3-4d39-9871-3a052573f1ea", "Version": "49aedb1e-01a3-4d39-9871-3a052573f1ea", "CreationTimestamp": "2019-07-24T00:04:48.523Z", "Id": "a454b62a-5d56-4ca9-bdc4-8254e1662cb0" } ``` Para obter mais informações, consulte [Monitoring with AWS IoT Greengrass Logs](https://docs.aws.amazon.com/greengrass/latest/developerguide/greengrass-logs-overview.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [CreateLoggerDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-logger-definition-version.html) na *Referência de comandos da AWS CLI*. ### `create-logger-definition` O código de exemplo a seguir mostra como usar `create-logger-definition`. **AWS CLI** **Criar uma definição de logger** O exemplo `create-logger-definition` a seguir cria uma definição de logger que contém uma versão inicial de definição de logger. A versão inicial define três configurações de log: 1) logs de componentes do sistema no sistema de arquivos do dispositivo principal, 2) logs de funções do Lambda definidas pelo usuário no sistema de arquivos do dispositivo principal e 3) logs de funções do Lambda definidas pelo usuário no Amazon CloudWatch Logs. Observação: para integrar os logs do CloudWatch, sua função de grupo deve conceder as permissões apropriadas. ``` aws greengrass create-logger-definition \ --name "LoggingConfigs" \ --initial-version "{\"Loggers\":[{\"Id\":\"1\",\"Component\":\"GreengrassSystem\",\"Level\":\"ERROR\",\"Space\":10240,\"Type\":\"FileSystem\"},{\"Id\":\"2\",\"Component\":\"Lambda\",\"Level\":\"INFO\",\"Space\":10240,\"Type\":\"FileSystem\"},{\"Id\":\"3\",\"Component\":\"Lambda\",\"Level\":\"INFO\",\"Type\":\"AWSCloudWatch\"}]}" ``` Resultado: ``` { "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/a454b62a-5d56-4ca9-bdc4-8254e1662cb0/versions/de1d9854-1588-4525-b25e-b378f60f2322", "Name": "LoggingConfigs", "LastUpdatedTimestamp": "2019-07-23T23:52:17.165Z", "LatestVersion": "de1d9854-1588-4525-b25e-b378f60f2322", "CreationTimestamp": "2019-07-23T23:52:17.165Z", "Id": "a454b62a-5d56-4ca9-bdc4-8254e1662cb0", "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/a454b62a-5d56-4ca9-bdc4-8254e1662cb0" } ``` Para obter mais informações, consulte [Monitoring with AWS IoT Greengrass Logs](https://docs.aws.amazon.com/greengrass/latest/developerguide/greengrass-logs-overview.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [CreateLoggerDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-logger-definition.html) na *Referência de comandos da AWS CLI*. ### `create-resource-definition-version` O código de exemplo a seguir mostra como usar `create-resource-definition-version`. **AWS CLI** **Criar uma versão de uma definição de recurso** O exemplo `create-resource-definition-version` a seguir cria uma nova versão de um TwilioAuthToken. ``` aws greengrass create-resource-definition-version \ --resource-definition-id "c8bb9ebc-c3fd-40a4-9c6a-568d75569d38" \ --resources "[{\"Id\": \"TwilioAuthToken\",\"Name\": \"MyTwilioAuthToken\",\"ResourceDataContainer\": {\"SecretsManagerSecretResourceData\": {\"ARN\": \"arn:aws:secretsmanager:us-west-2:123456789012:secret:greengrass-TwilioAuthToken-ntSlp6\"}}}]" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/c8bb9ebc-c3fd-40a4-9c6a-568d75569d38/versions/b3bcada0-5fb6-42df-bf0b-1ee4f15e769e", "CreationTimestamp": "2019-06-24T21:17:25.623Z", "Id": "c8bb9ebc-c3fd-40a4-9c6a-568d75569d38", "Version": "b3bcada0-5fb6-42df-bf0b-1ee4f15e769e" } ``` + Para ver detalhes da API, consulte [CreateResourceDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-resource-definition-version.html) na *Referência de comandos da AWS CLI*. ### `create-resource-definition` O código de exemplo a seguir mostra como usar `create-resource-definition`. **AWS CLI** **Criar uma definição de recurso** O exemplo `create-resource-definition` a seguir cria uma definição de recurso que contém uma lista de recursos a serem usados em um grupo do Greengrass. Neste exemplo, inclui-se uma versão inicial da definição de recursos por meio do fornecimento de uma lista de recursos. A lista inclui um recurso para um token de autorização do Twilio e o ARN para um segredo armazenado no AWS Secrets Manager. É necessário criar o segredo antes de definir o recurso. ``` aws greengrass create-resource-definition \ --name MyGreengrassResources \ --initial-version "{\"Resources\": [{\"Id\": \"TwilioAuthToken\",\"Name\": \"MyTwilioAuthToken\",\"ResourceDataContainer\": {\"SecretsManagerSecretResourceData\": {\"ARN\": \"arn:aws:secretsmanager:us-west-2:123456789012:secret:greengrass-TwilioAuthToken-ntSlp6\"}}}]}" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/c8bb9ebc-c3fd-40a4-9c6a-568d75569d38", "CreationTimestamp": "2019-06-19T21:51:28.212Z", "Id": "c8bb9ebc-c3fd-40a4-9c6a-568d75569d38", "LastUpdatedTimestamp": "2019-06-19T21:51:28.212Z", "LatestVersion": "a5f94d0b-f6bc-40f4-bb78-7a1c5fe13ba1", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/c8bb9ebc-c3fd-40a4-9c6a-568d75569d38/versions/a5f94d0b-f6bc-40f4-bb78-7a1c5fe13ba1", "Name": "MyGreengrassResources" } ``` Para obter mais informações, consulte [How to Configure Local Resource Access Using the AWS Command Line Interface](https://docs.aws.amazon.com/greengrass/latest/developerguide/lra-cli.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [CreateResourceDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-resource-definition.html) na *Referência de comandos da AWS CLI*. ### `create-software-update-job` O código de exemplo a seguir mostra como usar `create-software-update-job`. **AWS CLI** **Criar um serviço de atualização de software para um núcleo** O exemplo `create-software-update-job` a seguir cria um serviço de atualização via ondas de rádio (OTA) para atualizar o software AWS IoT Greengrass Core no núcleo denominado `MyFirstGroup_Core`. Esse comando requer um perfil do IAM que permita o acesso a pacotes de atualização de software no Amazon S3 e inclua `iot.amazonaws.com` como uma entidade confiável. ``` aws greengrass create-software-update-job \ --update-targets-architecture armv7l \ --update-targets [\"arn:aws:iot:us-west-2:123456789012:thing/MyFirstGroup_Core\"] \ --update-targets-operating-system raspbian \ --software-to-update core \ --s3-url-signer-role arn:aws:iam::123456789012:role/OTA_signer_role \ --update-agent-log-level WARN ``` Resultado: ``` { "IotJobId": "GreengrassUpdateJob_30b353e3-3af7-4786-be25-4c446663c09e", "IotJobArn": "arn:aws:iot:us-west-2:123456789012:job/GreengrassUpdateJob_30b353e3-3af7-4786-be25-4c446663c09e", "PlatformSoftwareVersion": "1.9.3" } ``` *Para obter mais informações, consulte [OTA Updates of AWS IoT Greengrass Core Software](https://docs.aws.amazon.com/greengrass/latest/developerguide/core-ota-update.html) no Guia do desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [CreateSoftwareUpdateJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-software-update-job.html) na *Referência de comandos da AWS CLI*. ### `create-subscription-definition-version` O código de exemplo a seguir mostra como usar `create-subscription-definition-version`. **AWS CLI** **Criar uma nova versão de uma definição de assinatura** O exemplo `create-subscription-definition-version` a seguir cria uma nova versão de uma definição de assinatura que contém três assinaturas: uma notificação de acionamento, uma entrada de temperatura e um status de saída. ``` aws greengrass create-subscription-definition-version \ --subscription-definition-id "9d611d57-5d5d-44bd-a3b4-feccbdd69112" \ --subscriptions "[{\"Id\": \"TriggerNotification\", \"Source\": \"arn:aws:lambda:us-west-2:123456789012:function:TempMonitor:GG_TempMonitor\", \"Subject\": \"twilio/txt\", \"Target\": \"arn:aws:greengrass:us-west-2::/connectors/TwilioNotifications/versions/1\"},{\"Id\": \"TemperatureInput\", \"Source\": \"cloud\", \"Subject\": \"temperature/input\", \"Target\": \"arn:aws:lambda:us-west-2:123456789012:function:TempMonitor:GG_TempMonitor\"},{\"Id\": \"OutputStatus\", \"Source\": \"arn:aws:greengrass:us-west-2::/connectors/TwilioNotifications/versions/1\", \"Subject\": \"twilio/message/status\", \"Target\": \"cloud\"}]" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/9d611d57-5d5d-44bd-a3b4-feccbdd69112/versions/7b65dfae-50b6-4d0f-b3e0-27728bfb0620", "CreationTimestamp": "2019-06-24T21:21:33.837Z", "Id": "9d611d57-5d5d-44bd-a3b4-feccbdd69112", "Version": "7b65dfae-50b6-4d0f-b3e0-27728bfb0620" } ``` + Para ver detalhes da API, consulte [CreateSubscriptionDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-subscription-definition-version.html) na *Referência de comandos da AWS CLI*. ### `create-subscription-definition` O código de exemplo a seguir mostra como usar `create-subscription-definition`. **AWS CLI** **Criar uma definição de assinatura** O exemplo `create-subscription-definition` a seguir cria uma definição de assinatura e especifica sua versão inicial. A versão inicial contém três assinaturas: uma para o tópico MQTT ao qual o conector se inscreve, uma para permitir que uma função receba leituras de temperatura da IoT AWS e uma para permitir que a IoT AWS receba informações de status do conector. O exemplo fornece o ARN para o alias da função do Lambda que foi criado anteriormente usando o comando `create-alias` do Lambda. ``` aws greengrass create-subscription-definition \ --initial-version "{\"Subscriptions\": [{\"Id\": \"TriggerNotification\", \"Source\": \"arn:aws:lambda:us-west-2:123456789012:function:TempMonitor:GG_TempMonitor\", \"Subject\": \"twilio/txt\", \"Target\": \"arn:aws:greengrass:us-west-2::/connectors/TwilioNotifications/versions/1\"},{\"Id\": \"TemperatureInput\", \"Source\": \"cloud\", \"Subject\": \"temperature/input\", \"Target\": \"arn:aws:lambda:us-west-2:123456789012:function:TempMonitor:GG_TempMonitor\"},{\"Id\": \"OutputStatus\", \"Source\": \"arn:aws:greengrass:us-west-2::/connectors/TwilioNotifications/versions/1\", \"Subject\": \"twilio/message/status\", \"Target\": \"cloud\"}]}" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/9d611d57-5d5d-44bd-a3b4-feccbdd69112", "CreationTimestamp": "2019-06-19T22:34:26.677Z", "Id": "9d611d57-5d5d-44bd-a3b4-feccbdd69112", "LastUpdatedTimestamp": "2019-06-19T22:34:26.677Z", "LatestVersion": "aa645c47-ac90-420d-9091-8c7ffa4f103f", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/9d611d57-5d5d-44bd-a3b4-feccbdd69112/versions/aa645c47-ac90-420d-9091-8c7ffa4f103f" } ``` Para obter mais informações, consulte [Introdução a Conectores (CLI)](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-cli.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [CreateSubscriptionDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-subscription-definition.html) na *Referência de comandos da AWS CLI*. ### `delete-connector-definition` O código de exemplo a seguir mostra como usar `delete-connector-definition`. **AWS CLI** **Excluir uma definição de conector** O exemplo `delete-connector-definition` a seguir exclui a definição específica do conector Greengrass. Caso exclua uma definição de conector que seja usada por um grupo, esse grupo não poderá ser implantado com êxito. ``` aws greengrass delete-connector-definition \ --connector-definition-id "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8" ``` Este comando não produz saída. + Para ver detalhes da API, consulte [DeleteConnectorDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/delete-connector-definition.html) na *Referência de comandos da AWS CLI*. ### `delete-core-definition` O código de exemplo a seguir mostra como usar `delete-core-definition`. **AWS CLI** **Excluir uma definição de núcleo** O exemplo `delete-core-definition` a seguir exclui a definição básica específica do Greengrass, incluindo todas as versões. Caso exclua um núcleo associado a um grupo Greengrass, esse grupo não poderá ser implantado com êxito. ``` aws greengrass delete-core-definition \ --core-definition-id "ff36cc5f-9f98-4994-b468-9d9b6dc52abd" ``` Este comando não produz saída. + Para ver detalhes da API, consulte [DeleteCoreDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/delete-core-definition.html) na *Referência de comandos da AWS CLI*. ### `delete-device-definition` O código de exemplo a seguir mostra como usar `delete-device-definition`. **AWS CLI** **Excluir uma definição de dispositivo** O exemplo `delete-device-definition` a seguir exclui a definição de dispositivo específica, incluindo todas as versões. Caso exclua uma versão de definição de dispositivo usada por uma versão de grupo, esta não poderá ser implantada com êxito. ``` aws greengrass delete-device-definition \ --device-definition-id "f9ba083d-5ad4-4534-9f86-026a45df1ccd" ``` Este comando não produz saída. + Para ver detalhes da API, consulte [DeleteDeviceDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/delete-device-definition.html) na *Referência de comandos da AWS CLI*. ### `delete-function-definition` O código de exemplo a seguir mostra como usar `delete-function-definition`. **AWS CLI** **Excluir uma definição de função** O exemplo `delete-function-definition` a seguir exclui a definição da função Greengrass específica. Caso exclua uma definição de função usada por um grupo, esse grupo não poderá ser implantado com êxito. ``` aws greengrass delete-function-definition \ --function-definition-id "fd4b906a-dff3-4c1b-96eb-52ebfcfac06a" ``` Este comando não produz saída. + Para ver detalhes da API, consulte [DeleteFunctionDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/delete-function-definition.html) na *Referência de comandos da AWS CLI*. ### `delete-group` O código de exemplo a seguir mostra como usar `delete-group`. **AWS CLI** **Para excluir um grupo** O exemplo `delete-group` a seguir exclui o grupo Greengrass específico. ``` aws greengrass delete-group \ --group-id "4e22bd92-898c-436b-ade5-434d883ff749" ``` Este comando não produz saída. + Consulte detalhes da API em [DeleteGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/delete-group.html) na *Referência de comandos da AWS CLI*. ### `delete-logger-definition` O código de exemplo a seguir mostra como usar `delete-logger-definition`. **AWS CLI** **Excluir uma definição de logger** O exemplo `delete-logger-definition` a seguir exclui a definição do logger específico, incluindo todas as versões da definição do logger. Caso exclua uma versão de definição de logger usada por uma versão de grupo, esta não poderá ser implantada com êxito. ``` aws greengrass delete-logger-definition \ --logger-definition-id "a454b62a-5d56-4ca9-bdc4-8254e1662cb0" ``` Este comando não produz saída. Para obter mais informações, consulte [Monitoring with AWS IoT Greengrass Logs](https://docs.aws.amazon.com/greengrass/latest/developerguide/greengrass-logs-overview.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [DeleteLoggerDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/delete-logger-definition.html) na *Referência de comandos da AWS CLI*. ### `delete-resource-definition` O código de exemplo a seguir mostra como usar `delete-resource-definition`. **AWS CLI** **Excluir uma definição de recurso** O exemplo `delete-resource-definition` a seguir exclui a definição de recurso específica, incluindo todas as versões do recurso. Caso exclua uma definição de recurso usada por um grupo, este não poderá ser implantado com êxito. ``` aws greengrass delete-resource-definition \ --resource-definition-id "ad8c101d-8109-4b0e-b97d-9cc5802ab658" ``` Este comando não produz saída. + Para ver detalhes da API, consulte [DeleteResourceDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/delete-resource-definition.html) na *Referência de comandos da AWS CLI*. ### `delete-subscription-definition` O código de exemplo a seguir mostra como usar `delete-subscription-definition`. **AWS CLI** **Excluir uma definição de assinatura** O exemplo `delete-subscription-definition` a seguir exclui a definição de assinatura Greengrass específica. Caso exclua uma assinatura que esteja sendo usada por um grupo, este não poderá ser implantado com êxito. ``` aws greengrass delete-subscription-definition \ --subscription-definition-id "cd6f1c37-d9a4-4e90-be94-01a7404f5967" ``` Este comando não produz saída. + Para ver detalhes da API, consulte [DeleteSubscriptionDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/delete-subscription-definition.html) na * Referência de comandos da AWS CLI*. ### `disassociate-role-from-group` O código de exemplo a seguir mostra como usar `disassociate-role-from-group`. **AWS CLI** **Desassociar um perfil de um grupo do Greengrass** O exemplo `disassociate-role-from-group` a seguir dissocia o perfil do IAM do grupo Greengrass específico. ``` aws greengrass disassociate-role-from-group \ --group-id 2494ee3f-7f8a-4e92-a78b-d205f808b84b ``` Resultado: ``` { "DisassociatedAt": "2019-09-10T20:05:49Z" } ``` Para obter mais informações sobre grupos, consulte [Configurar Perfil de Grupo](https://docs.aws.amazon.com/greengrass/latest/developerguide/config-iam-roles.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [DisassociateRoleFromGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/disassociate-role-from-group.html) na *Referência de comandos da AWS CLI*. ### `disassociate-service-role-from-account` O código de exemplo a seguir mostra como usar `disassociate-service-role-from-account`. **AWS CLI** **Desassociar um perfil de serviço de sua conta AWS** O exemplo `disassociate-service-role-from-account` a seguir remove o perfil de serviço associado à sua conta da AWS. Se não estiver usando o perfil de serviço em nenhuma região da AWS, use o comando `delete-role-policy` para desvincular a política gerenciada `AWSGreengrassResourceAccessRolePolicy` do perfil e, em seguida, use o comando `delete-role` para excluí-lo. ``` aws greengrass disassociate-service-role-from-account ``` Resultado: ``` { "DisassociatedAt": "2019-06-25T22:12:55Z" } ``` Para obter mais informações sobre grupos, consulte [Perfil de Serviço do Greengrass](https://docs.aws.amazon.com/greengrass/latest/developerguide/service-role.html) no **Guia do Desenvolvedor do AWS IoT Greengrass**. + Para ver detalhes da API, consulte [DisassociateServiceRoleFromAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/disassociate-service-role-from-account.html) na *Referência de comandos da AWS CLI*. ### `get-associated-role` O código de exemplo a seguir mostra como usar `get-associated-role`. **AWS CLI** **Obter o perfil associado a um grupo Greengrass** O exemplo `get-associated-role` a seguir obtém o perfil do IAM associado ao grupo Greengrass específico. O perfil de grupo é usado por funções e conectores locais do Lambda para acessar serviços da AWS. ``` aws greengrass get-associated-role \ --group-id 2494ee3f-7f8a-4e92-a78b-d205f808b84b ``` Resultado: ``` { "RoleArn": "arn:aws:iam::123456789012:role/GG-Group-Role", "AssociatedAt": "2019-09-10T20:03:30Z" } ``` Para obter mais informações sobre grupos, consulte [Configurar Perfil de Grupo](https://docs.aws.amazon.com/greengrass/latest/developerguide/config-iam-roles.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [GetAssociatedRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-associated-role.html) na *Referência de comandos da AWS CLI*. ### `get-bulk-deployment-status` O código de exemplo a seguir mostra como usar `get-bulk-deployment-status`. **AWS CLI** **Verificar o status de sua implantação em massa** O exemplo `get-bulk-deployment-status` a seguir recupera as informações de status da operação de implantação em massa específica. Neste exemplo, o arquivo que especificou os grupos a serem implantados tem um registro de entrada inválido. ``` aws greengrass get-bulk-deployment-status \ --bulk-deployment-id "870fb41b-6288-4e0c-bc76-a7ba4b4d3267" ``` Resultado: ``` { "BulkDeploymentMetrics": { "InvalidInputRecords": 1, "RecordsProcessed": 1, "RetryAttempts": 0 }, "BulkDeploymentStatus": "Completed", "CreatedAt": "2019-06-25T16:11:33.265Z", "tags": {} } ``` Para obter mais informações, consulte [Criar Implantações em Massa para Grupos](https://docs.aws.amazon.com/greengrass/latest/developerguide/bulk-deploy-cli.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [GetBulkDeploymentStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-bulk-deployment-status.html) na *Referência de comandos da AWS CLI*. ### `get-connectivity-info` O código de exemplo a seguir mostra como usar `get-connectivity-info`. **AWS CLI** **Obter as informações de conectividade de um núcleo Greengrass** O exemplo `get-connectivity-info` a seguir mostra os endpoints que os dispositivos podem usar para se conectar ao núcleo específico do Greengrass. As informações de conectividade são uma lista de endereços IP ou nomes de domínio, com números de porta correspondentes e metadados opcionais definidos pelo cliente. ``` aws greengrass get-connectivity-info \ --thing-name "MyGroup_Core" ``` Resultado: ``` { "ConnectivityInfo": [ { "Metadata": "", "PortNumber": 8883, "HostAddress": "127.0.0.1", "Id": "AUTOIP_127.0.0.1_0" }, { "Metadata": "", "PortNumber": 8883, "HostAddress": "192.168.1.3", "Id": "AUTOIP_192.168.1.3_1" }, { "Metadata": "", "PortNumber": 8883, "HostAddress": "::1", "Id": "AUTOIP_::1_2" }, { "Metadata": "", "PortNumber": 8883, "HostAddress": "fe80::1e69:ed93:f5b:f6d", "Id": "AUTOIP_fe80::1e69:ed93:f5b:f6d_3" } ] } ``` + Para receber detalhes da API, consulte [GetConnectivityInfo](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-connectivity-info.html) na * Referência de comandos da AWS CLI*. ### `get-connector-definition-version` O código de exemplo a seguir mostra como usar `get-connector-definition-version`. **AWS CLI** **Como recuperar informações sobre uma versão específica de uma definição de conector** O exemplo `get-connector-definition-version` a seguir recupera informações sobre a versão específica de uma dada definição de conector. Para recuperar as IDs de todas as versões da definição do conector, use o `list-connector-definition-versions` comando. Para recuperar a ID da última versão adicionada à definição do conector, use o `get-connector-definition` comando e verifique a `LatestVersion` propriedade. ``` aws greengrass get-connector-definition-version \ --connector-definition-id "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8" \ --connector-definition-version-id "63c57963-c7c2-4a26-a7e2-7bf478ea2623" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/b5c4ebfd-f672-49a3-83cd-31c7216a7bb8/versions/63c57963-c7c2-4a26-a7e2-7bf478ea2623", "CreationTimestamp": "2019-06-19T19:30:01.300Z", "Definition": { "Connectors": [ { "ConnectorArn": "arn:aws:greengrass:us-west-2::/connectors/SNS/versions/1", "Id": "MySNSConnector", "Parameters": { "DefaultSNSArn": "arn:aws:sns:us-west-2:123456789012:GGConnectorTopic" } } ] }, "Id": "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8", "Version": "63c57963-c7c2-4a26-a7e2-7bf478ea2623" } ``` Para obter mais informações, consulte [Integração com Serviços e Protocolos usando Conectores Greengrass](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors.html) no **Guia do Desenvolvedor do AWS IoT Greengrass**. + Para ver detalhes da API, consulte [GetConnectorDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-connector-definition-version.html) na *Referência de comandos da AWS CLI*. ### `get-connector-definition` O código de exemplo a seguir mostra como usar `get-connector-definition`. **AWS CLI** **Recuperar informações sobre uma definição de conector** O exemplo `get-connector-definition` a seguir recupera informações sobre a definição do conector específico. Para recuperar as IDs das definições do conector, use o `list-connector-definitions` comando. ``` aws greengrass get-connector-definition \ --connector-definition-id "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/b5c4ebfd-f672-49a3-83cd-31c7216a7bb8", "CreationTimestamp": "2019-06-19T19:30:01.300Z", "Id": "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8", "LastUpdatedTimestamp": "2019-06-19T19:30:01.300Z", "LatestVersion": "63c57963-c7c2-4a26-a7e2-7bf478ea2623", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/b5c4ebfd-f672-49a3-83cd-31c7216a7bb8/versions/63c57963-c7c2-4a26-a7e2-7bf478ea2623", "Name": "MySNSConnector", "tags": {} } ``` Para obter mais informações, consulte [Integração com Serviços e Protocolos usando Conectores Greengrass](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors.html) no **Guia do Desenvolvedor do AWS IoT Greengrass**. + Para ver detalhes da API, consulte [GetConnectorDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-connector-definition.html) na *Referência de comandos da AWS CLI*. ### `get-core-definition-version` O código de exemplo a seguir mostra como usar `get-core-definition-version`. **AWS CLI** **Obter detalhes sobre uma versão específica da definição de núcleo do Greengrass** O exemplo `get-core-definition-version` a seguir recupera informações sobre a versão específica de uma dada definição de núcleo. Para recuperar os IDs de todas as versões da definição de núcleo, use o `list-core-definition-versions` comando. Para recuperar o ID da última versão adicionada à definição de núcleo, use o `get-core-definition` comando e verifique a `LatestVersion` propriedade. ``` aws greengrass get-core-definition-version \ --core-definition-id "c906ed39-a1e3-4822-a981-7b9bd57b4b46" \ --core-definition-version-id "42aeeac3-fd9d-4312-a8fd-ffa9404a20e0" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/c906ed39-a1e3-4822-a981-7b9bd57b4b46/versions/42aeeac3-fd9d-4312-a8fd-ffa9404a20e0", "CreationTimestamp": "2019-06-18T16:21:21.351Z", "Definition": { "Cores": [ { "CertificateArn": "arn:aws:iot:us-west-2:123456789012:cert/928dea7b82331b47c3ff77b0e763fc5e64e2f7c884e6ef391baed9b6b8e21b45", "Id": "1a39aac7-0885-4417-91f6-23e4cea6c511", "SyncShadow": false, "ThingArn": "arn:aws:iot:us-west-2:123456789012:thing/GGGroup4Pi3_Core" } ] }, "Id": "c906ed39-a1e3-4822-a981-7b9bd57b4b46", "Version": "42aeeac3-fd9d-4312-a8fd-ffa9404a20e0" } ``` + Para ver detalhes da API, consulte [GetCoreDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-core-definition-version.html) na *Referência de comandos da AWS CLI*. ### `get-core-definition` O código de exemplo a seguir mostra como usar `get-core-definition`. **AWS CLI** **Recuperar detalhes de uma definição básica do Greengrass** O exemplo `get-core-definition` a seguir recupera informações sobre a definição de núcleo específica. Para recuperar as IDs de suas definições de núcleo, use o `list-core-definitions` comando. ``` aws greengrass get-core-definition \ --core-definition-id "c906ed39-a1e3-4822-a981-7b9bd57b4b46" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/237d6916-27cf-457f-ba0c-e86cfb5d25cd", "CreationTimestamp": "2018-10-18T04:47:06.721Z", "Id": "237d6916-27cf-457f-ba0c-e86cfb5d25cd", "LastUpdatedTimestamp": "2018-10-18T04:47:06.721Z", "LatestVersion": "bd2cd6d4-2bc5-468a-8962-39e071e34b68", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/237d6916-27cf-457f-ba0c-e86cfb5d25cd/versions/bd2cd6d4-2bc5-468a-8962-39e071e34b68", "tags": {} } ``` + Para ver detalhes da API, consulte [GetCoreDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-core-definition.html) na *Referência de comandos da AWS CLI*. ### `get-deployment-status` O código de exemplo a seguir mostra como usar `get-deployment-status`. **AWS CLI** **Recuperar o status de uma implantação** O exemplo `get-deployment-status` a seguir recupera o status de uma dada implantação do grupo Greengrass específico. Para obter a ID de implantação, use o `list-deployments` comando e especifique o ID do grupo. ``` aws greengrass get-deployment-status \ --group-id "1013db12-8b58-45ff-acc7-704248f66731" \ --deployment-id "1065b8a0-812b-4f21-9d5d-e89b232a530f" ``` Resultado: ``` { "DeploymentStatus": "Success", "DeploymentType": "NewDeployment", "UpdatedAt": "2019-06-18T17:04:44.761Z" } ``` + Para receber detalhes da API, consulte [GetDeploymentStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-deployment-status.html) na *AWS CLI Referência de comando*. ### `get-device-definition-version` O código de exemplo a seguir mostra como usar `get-device-definition-version`. **AWS CLI** **Obter uma versão de definição de dispositivo** O exemplo `get-device-definition-version` a seguir recupera informações sobre a versão específica de uma dada definição de dispositivo. Para recuperar as IDs de todas as versões da definição do dispositivo, use o `list-device-definition-versions` comando. Para recuperar o ID da última versão adicionada à definição do dispositivo, use o `get-device-definition` comando e verifique a `LatestVersion` propriedade. ``` aws greengrass get-device-definition-version \ --device-definition-id "f9ba083d-5ad4-4534-9f86-026a45df1ccd" \ --device-definition-version-id "83c13984-6fed-447e-84d5-5b8aa45d5f71" ``` Resultado: ``` { "Definition": { "Devices": [ { "CertificateArn": "arn:aws:iot:us-west-2:123456789012:cert/6c52ce1b47bde88a637e9ccdd45fe4e4c2c0a75a6866f8f63d980ee22fa51e02", "ThingArn": "arn:aws:iot:us-west-2:123456789012:thing/ExteriorTherm", "SyncShadow": true, "Id": "ExteriorTherm" }, { "CertificateArn": "arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92", "ThingArn": "arn:aws:iot:us-west-2:123456789012:thing/InteriorTherm", "SyncShadow": true, "Id": "InteriorTherm" } ] }, "Version": "83c13984-6fed-447e-84d5-5b8aa45d5f71", "CreationTimestamp": "2019-09-11T00:15:09.838Z", "Id": "f9ba083d-5ad4-4534-9f86-026a45df1ccd", "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd/versions/83c13984-6fed-447e-84d5-5b8aa45d5f71" } ``` + Consulte detalhes da API em [GetDeviceDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-device-definition-version.html) na *AWS CLI Referência de comando*. ### `get-device-definition` O código de exemplo a seguir mostra como usar `get-device-definition`. **AWS CLI** **Obter uma definição de dispositivo** O exemplo `get-device-definition` a seguir recupera informações sobre a definição do dispositivo específico. Para recuperar os IDs das definições do seu dispositivo, use o `list-device-definitions` comando. ``` aws greengrass get-device-definition \ --device-definition-id "f9ba083d-5ad4-4534-9f86-026a45df1ccd" ``` Resultado: ``` { "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd/versions/83c13984-6fed-447e-84d5-5b8aa45d5f71", "Name": "TemperatureSensors", "tags": {}, "LastUpdatedTimestamp": "2019-09-11T00:19:03.698Z", "LatestVersion": "83c13984-6fed-447e-84d5-5b8aa45d5f71", "CreationTimestamp": "2019-09-11T00:11:06.197Z", "Id": "f9ba083d-5ad4-4534-9f86-026a45df1ccd", "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd" } ``` + Para mais detalhes da API, consulte [GetDeviceDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-device-definition.html) na *AWS CLI Referência de comando*. ### `get-function-definition-version` O código de exemplo a seguir mostra como usar `get-function-definition-version`. **AWS CLI** **Recuperar detalhes sobre uma versão específica de uma função do Lambda** O exemplo `get-function-definition-version` a seguir recupera informações sobre a versão específica de uma dada definição da função. Para recuperar as IDs de todas as versões da definição da função, use o `list-function-definition-versions` comando. Para recuperar a ID da última versão adicionada à definição da função, use o `get-function-definition` comando e verifique a `LatestVersion` propriedade. ``` aws greengrass get-function-definition-version \ --function-definition-id "063f5d1a-1dd1-40b4-9b51-56f8993d0f85" \ --function-definition-version-id "9748fda7-1589-4fcc-ac94-f5559e88678b" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/9748fda7-1589-4fcc-ac94-f5559e88678b", "CreationTimestamp": "2019-06-18T17:04:30.776Z", "Definition": { "Functions": [ { "FunctionArn": "arn:aws:lambda:::function:GGIPDetector:1", "FunctionConfiguration": { "Environment": {}, "MemorySize": 32768, "Pinned": true, "Timeout": 3 }, "Id": "26b69bdb-e547-46bc-9812-84ec04b6cc8c" }, { "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:Greengrass_HelloWorld:GG_HelloWorld", "FunctionConfiguration": { "EncodingType": "json", "Environment": { "Variables": {} }, "MemorySize": 16384, "Pinned": true, "Timeout": 25 }, "Id": "384465a8-eedf-48c6-b793-4c35f7bfae9b" } ] }, "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85", "Version": "9748fda7-1589-4fcc-ac94-f5559e88678b" } ``` + Para ver detalhes da API, consulte [GetFunctionDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-function-definition-version.html) na *Referência de comandos da AWS CLI*. ### `get-function-definition` O código de exemplo a seguir mostra como usar `get-function-definition`. **AWS CLI** **Recuperar uma definição de função** O exemplo `get-function-definition` a seguir exibe os detalhes de uma definição de função específica. Para recuperar as IDs de suas definições de função, use o `list-function-definitions` comando. ``` aws greengrass get-function-definition \ --function-definition-id "063f5d1a-1dd1-40b4-9b51-56f8993d0f85" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85", "CreationTimestamp": "2019-06-18T16:21:21.431Z", "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85", "LastUpdatedTimestamp": "2019-06-18T16:21:21.431Z", "LatestVersion": "9748fda7-1589-4fcc-ac94-f5559e88678b", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/9748fda7-1589-4fcc-ac94-f5559e88678b", "tags": {} } ``` + Para ver detalhes da API, consulte [GetFunctionDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-function-definition.html) na *Referência de comandos da AWS CLI*. ### `get-group-certificate-authority` O código de exemplo a seguir mostra como usar `get-group-certificate-authority`. **AWS CLI** **Recuperar a CA associada a um grupo do Greengrass** O exemplo `get-group-certificate-authority` a seguir recupera a autoridade de certificação (CA) associada ao grupo Greengrass específico. Para obter a ID da autoridade de certificação, use o `list-group-certificate-authorities` comando e especifique a ID do grupo. ``` aws greengrass get-group-certificate-authority \ --group-id "1013db12-8b58-45ff-acc7-704248f66731" \ --certificate-authority-id "f0430e1736ea8ed30cc5d5de9af67a7e3586bad9ae4d89c2a44163f65fdd8cf6" ``` Resultado: ``` { "GroupCertificateAuthorityArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/certificateauthorities/f0430e1736ea8ed30cc5d5de9af67a7e3586bad9ae4d89c2a44163f65fdd8cf6", "GroupCertificateAuthorityId": "f0430e1736ea8ed30cc5d5de9af67a7e3586bad9ae4d89c2a44163f65fdd8cf6", "PemEncodedCertificate": "-----BEGIN CERTIFICATE----- MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBWEXAMPLEGA1UEBhMC VVMxCzAJBgNVBAgTAldBMRAwDEXAMPLEEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 b24xFDASBgNVBAEXAMPLESBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jEXAMPLENMTEwNDI1MjA0NTIxWhcN MTIwNDI0MjA0EXAMPLEBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWEXAMPLEDASBgNVBAsTC0lBTSBDb25z b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWEXAMPLEgkqhkiG9w0BCQEWEG5vb25lQGFt YXpvbi5EXAMPLE8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CEXAMPLE93vUEIO3IyNoH/f0wYK8m9T rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswYEXAMPLEgpE Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKEXAMPLEAQEFBQADgYEAtCu4 nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= -----END CERTIFICATE-----\n" } ``` + Para ver detalhes da API, consulte [GetGroupCertificateAuthority](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-group-certificate-authority.html) na *Referência de comandos da AWS CLI*. ### `get-group-certificate-configuration` O código de exemplo a seguir mostra como usar `get-group-certificate-configuration`. **AWS CLI** **Recuperar a configuração da autoridade de certificação usada pelo grupo Greengrass** O exemplo `get-group-certificate-configuration` a seguir recupera a configuração da autoridade de certificação (CA) usada pelo grupo Greengrass específico. ``` aws greengrass get-group-certificate-configuration \ --group-id "1013db12-8b58-45ff-acc7-704248f66731" ``` Resultado: ``` { "CertificateAuthorityExpiryInMilliseconds": 2524607999000, "CertificateExpiryInMilliseconds": 604800000, "GroupId": "1013db12-8b58-45ff-acc7-704248f66731" } ``` + Para ver detalhes da API, consulte [GetGroupCertificateConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-group-certificate-configuration.html) na *Referência de comandos da AWS CLI*. ### `get-group-version` O código de exemplo a seguir mostra como usar `get-group-version`. **AWS CLI** **Recuperar informações sobre uma versão de um grupo do Greengrass** O exemplo `get-group-version` a seguir recupera informações sobre a versão específica do grupo específico. Para recuperar as IDs de todas as versões do grupo, use o `list-group-versions` comando. Para recuperar a ID da última versão adicionada ao grupo, use o `get-group` comando e verifique a `LatestVersion` propriedade. ``` aws greengrass get-group-version \ --group-id "1013db12-8b58-45ff-acc7-704248f66731" \ --group-version-id "115136b3-cfd7-4462-b77f-8741a4b00e5e" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/115136b3-cfd7-4462-b77f-8741a4b00e5e", "CreationTimestamp": "2019-06-18T17:04:30.915Z", "Definition": { "CoreDefinitionVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/c906ed39-a1e3-4822-a981-7b9bd57b4b46/versions/42aeeac3-fd9d-4312-a8fd-ffa9404a20e0", "FunctionDefinitionVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/9748fda7-1589-4fcc-ac94-f5559e88678b", "SubscriptionDefinitionVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152/versions/88ae8699-12ac-4663-ba3f-4d7f0519140b" }, "Id": "1013db12-8b58-45ff-acc7-704248f66731", "Version": "115136b3-cfd7-4462-b77f-8741a4b00e5e" } ``` + Para ver detalhes da API, consulte [GetGroupVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-group-version.html) na *Referência de comandos da AWS CLI*. ### `get-group` O código de exemplo a seguir mostra como usar `get-group`. **AWS CLI** **Recuperar informações sobre um grupo do Greengrass** O exemplo `get-group` a seguir recupera informações sobre o grupo Greengrass específico. Para recuperar as IDs dos seus grupos, use o `list-groups` comando. ``` aws greengrass get-group \ --group-id "1013db12-8b58-45ff-acc7-704248f66731" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731", "CreationTimestamp": "2019-06-18T16:21:21.457Z", "Id": "1013db12-8b58-45ff-acc7-704248f66731", "LastUpdatedTimestamp": "2019-06-18T16:21:21.457Z", "LatestVersion": "115136b3-cfd7-4462-b77f-8741a4b00e5e", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/115136b3-cfd7-4462-b77f-8741a4b00e5e", "Name": "GGGroup4Pi3", "tags": {} } ``` + Consulte detalhes da API em [GetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-group.html) na *Referência de comandos da AWS CLI*. ### `get-logger-definition-version` O código de exemplo a seguir mostra como usar `get-logger-definition-version`. **AWS CLI** **Recuperar informações sobre uma versão de uma definição de logger** O exemplo `get-logger-definition-version` a seguir recupera informações sobre a versão específica da definição específica do logger. Para recuperar as IDs de todas as versões da definição do logger, use o `list-logger-definition-versions` comando. Para recuperar a ID da última versão adicionada à definição do logger, use o `get-logger-definition` comando e verifique a `LatestVersion` propriedade. ``` aws greengrass get-logger-definition-version \ --logger-definition-id "49eeeb66-f1d3-4e34-86e3-3617262abf23" \ --logger-definition-version-id "5e3f6f64-a565-491e-8de0-3c0d8e0f2073" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/49eeeb66-f1d3-4e34-86e3-3617262abf23/versions/5e3f6f64-a565-491e-8de0-3c0d8e0f2073", "CreationTimestamp": "2019-05-08T16:10:13.866Z", "Definition": { "Loggers": [] }, "Id": "49eeeb66-f1d3-4e34-86e3-3617262abf23", "Version": "5e3f6f64-a565-491e-8de0-3c0d8e0f2073" } ``` + Consulte detalhes da API em [GetLoggerDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-logger-definition-version.html) na *AWS CLI Referência de comando*. ### `get-logger-definition` O código de exemplo a seguir mostra como usar `get-logger-definition`. **AWS CLI** **Recuperar informações sobre uma definição de logger** O exemplo `get-logger-definition` a seguir recupera informações sobre a definição de logger específica. Para recuperar as IDs das definições do seu logger, use o `list-logger-definitions` comando. ``` aws greengrass get-logger-definition \ --logger-definition-id "49eeeb66-f1d3-4e34-86e3-3617262abf23" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/49eeeb66-f1d3-4e34-86e3-3617262abf23", "CreationTimestamp": "2019-05-08T16:10:13.809Z", "Id": "49eeeb66-f1d3-4e34-86e3-3617262abf23", "LastUpdatedTimestamp": "2019-05-08T16:10:13.809Z", "LatestVersion": "5e3f6f64-a565-491e-8de0-3c0d8e0f2073", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/49eeeb66-f1d3-4e34-86e3-3617262abf23/versions/5e3f6f64-a565-491e-8de0-3c0d8e0f2073", "tags": {} } ``` + Para mais detalhes da API, consulte [GetLoggerDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-logger-definition.html) na *AWS CLI Referência de comando*. ### `get-resource-definition-version` O código de exemplo a seguir mostra como usar `get-resource-definition-version`. **AWS CLI** **Recuperar informações sobre uma versão específica de uma definição de recurso** O exemplo `get-resource-definition-version` a seguir recupera informações sobre a versão específica da definição de recurso específica. Para recuperar as IDs de todas as versões da definição do recurso, use o `list-resource-definition-versions` comando. Para recuperar a ID da última versão adicionada à definição do recurso, use o `get-resource-definition` comando e verifique a `LatestVersion` propriedade. ``` aws greengrass get-resource-definition-version \ --resource-definition-id "ad8c101d-8109-4b0e-b97d-9cc5802ab658" \ --resource-definition-version-id "26e8829a-491a-464d-9c87-664bf6f6f2be" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658/versions/26e8829a-491a-464d-9c87-664bf6f6f2be", "CreationTimestamp": "2019-06-19T16:40:59.392Z", "Definition": { "Resources": [ { "Id": "26ff3f7b-839a-4217-9fdc-a218308b3963", "Name": "usb-port", "ResourceDataContainer": { "LocalDeviceResourceData": { "GroupOwnerSetting": { "AutoAddGroupOwner": false }, "SourcePath": "/dev/bus/usb" } } } ] }, "Id": "ad8c101d-8109-4b0e-b97d-9cc5802ab658", "Version": "26e8829a-491a-464d-9c87-664bf6f6f2be" } ``` + Para ver detalhes da API, consulte [GetResourceDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-resource-definition-version.html) na *Referência de comandos da AWS CLI*. ### `get-resource-definition` O código de exemplo a seguir mostra como usar `get-resource-definition`. **AWS CLI** **Recuperar informações sobre uma definição de recurso** O exemplo `get-resource-definition` a seguir recupera informações sobre a definição do recurso específico. Para recuperar as IDs das suas definições de recursos, use o `list-resource-definitions` comando. ``` aws greengrass get-resource-definition \ --resource-definition-id "ad8c101d-8109-4b0e-b97d-9cc5802ab658" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658", "CreationTimestamp": "2019-06-19T16:40:59.261Z", "Id": "ad8c101d-8109-4b0e-b97d-9cc5802ab658", "LastUpdatedTimestamp": "2019-06-19T16:40:59.261Z", "LatestVersion": "26e8829a-491a-464d-9c87-664bf6f6f2be", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658/versions/26e8829a-491a-464d-9c87-664bf6f6f2be", "tags": {} } ``` + Para ver detalhes da API, consulte [GetResourceDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-resource-definition.html) na *Referência de comandos da AWS CLI*. ### `get-service-role-for-account` O código de exemplo a seguir mostra como usar `get-service-role-for-account`. **AWS CLI** **Recuperar os detalhes do perfil de serviço que está anexado à sua conta** O exemplo `get-service-role-for-account` a seguir recupera informações sobre o perfil de serviço vinculado à sua conta da AWS. ``` aws greengrass get-service-role-for-account ``` Resultado: ``` { "AssociatedAt": "2018-10-18T15:59:20Z", "RoleArn": "arn:aws:iam::123456789012:role/service-role/Greengrass_ServiceRole" } ``` Para obter mais informações sobre grupos, consulte [Perfil de Serviço do Greengrass](https://docs.aws.amazon.com/greengrass/latest/developerguide/service-role.html) no **Guia do Desenvolvedor do AWS IoT Greengrass**. + Para ver detalhes da API, consulte [GetServiceRoleForAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-service-role-for-account.html) na * Referência de comandos da AWS CLI*. ### `get-subscription-definition-version` O código de exemplo a seguir mostra como usar `get-subscription-definition-version`. **AWS CLI** **Recuperar informações sobre uma versão específica de uma definição de assinatura** O exemplo `get-subscription-definition-version` a seguir recupera informações sobre a versão específica de uma dada definição de assinatura. Para recuperar as IDs de todas as versões da definição de assinatura, use o `list-subscription-definition-versions` comando. Para recuperar a ID da última versão adicionada à definição de assinatura, use o `get-subscription-definition` comando e verifique a `LatestVersion` propriedade. ``` aws greengrass get-subscription-definition-version \ --subscription-definition-id "70e49321-83d5-45d2-bc09-81f4917ae152" \ --subscription-definition-version-id "88ae8699-12ac-4663-ba3f-4d7f0519140b" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152/versions/88ae8699-12ac-4663-ba3f-4d7f0519140b", "CreationTimestamp": "2019-06-18T17:03:52.499Z", "Definition": { "Subscriptions": [ { "Id": "692c4484-d89f-4f64-8edd-1a041a65e5b6", "Source": "arn:aws:lambda:us-west-2:123456789012:function:Greengrass_HelloWorld:GG_HelloWorld", "Subject": "hello/world", "Target": "cloud" } ] }, "Id": "70e49321-83d5-45d2-bc09-81f4917ae152", "Version": "88ae8699-12ac-4663-ba3f-4d7f0519140b" } ``` + Para ver detalhes da API, consulte [GetSubscriptionDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-subscription-definition-version.html) na *Referência de comandos da AWS CLI*. ### `get-subscription-definition` O código de exemplo a seguir mostra como usar `get-subscription-definition`. **AWS CLI** **Recuperar informações sobre uma definição de assinatura** O exemplo `get-subscription-definition` a seguir recupera informações sobre a definição de assinatura específica. Para recuperar as IDs das suas definições de assinatura, use o `list-subscription-definitions` comando. ``` aws greengrass get-subscription-definition \ --subscription-definition-id "70e49321-83d5-45d2-bc09-81f4917ae152" ``` Resultado: ``` { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152", "CreationTimestamp": "2019-06-18T17:03:52.392Z", "Id": "70e49321-83d5-45d2-bc09-81f4917ae152", "LastUpdatedTimestamp": "2019-06-18T17:03:52.392Z", "LatestVersion": "88ae8699-12ac-4663-ba3f-4d7f0519140b", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152/versions/88ae8699-12ac-4663-ba3f-4d7f0519140b", "tags": {} } ``` + Para ver detalhes da API, consulte [GetSubscriptionDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-subscription-definition.html) na *Referência de comandos da AWS CLI*. ### `get-thing-runtime-configuration` O código de exemplo a seguir mostra como usar `get-thing-runtime-configuration`. **AWS CLI** **Recuperar a configuração de runtime de um núcleo do Greengrass** O exemplo `get-thing-runtime-configuration` a seguir recupera a configuração de runtime de um núcleo do Greengrass. Antes de recuperar a configuração de runtime, é preciso usar o `update-thing-runtime-configuration` comando para criar uma configuração de runtime para o núcleo. ``` aws greengrass get-thing-runtime-configuration \ --thing-name SampleGreengrassCore ``` Resultado: ``` { "RuntimeConfiguration": { "TelemetryConfiguration": { "ConfigurationSyncStatus": "OutOfSync", "Telemetry": "On" } } } ``` Para obter mais informações, consulte [Configuring telemetry settings](https://docs.aws.amazon.com/greengrass/latest/developerguide/telemetry.html#configure-telemetry-settings) no *AWS Guia do Desenvolvedor do IoT Greengrass*. + Para ver detalhes da API, consulte [GetThingRuntimeConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-thing-runtime-configuration.html) na *Referência de comandos da AWS CLI*. ### `list-bulk-deployment-detailed-reports` O código de exemplo a seguir mostra como usar `list-bulk-deployment-detailed-reports`. **AWS CLI** **Listar informações sobre implantações individuais em uma implantação em massa** O exemplo `list-bulk-deployment-detailed-reports` a seguir exibe informações sobre as implantações individuais em uma operação de implantação em massa, incluindo o status. ``` aws greengrass list-bulk-deployment-detailed-reports \ --bulk-deployment-id 42ce9c42-489b-4ed4-b905-8996aa50ef9d ``` Resultado: ``` { "Deployments": [ { "DeploymentType": "NewDeployment", "DeploymentStatus": "Success", "DeploymentId": "123456789012:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeploymentArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333/deployments/123456789012:123456789012:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "GroupArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333/versions/123456789012:a1b2c3d4-5678-90ab-cdef-EXAMPLE44444", "CreatedAt": "2020-01-21T21:34:16.501Z" }, { "DeploymentType": "NewDeployment", "DeploymentStatus": "InProgress", "DeploymentId": "123456789012:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "DeploymentArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/a1b2c3d4-5678-90ab-cdef-EXAMPLE55555/deployments/123456789012:123456789012:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "GroupArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/a1b2c3d4-5678-90ab-cdef-EXAMPLE55555/versions/a1b2c3d4-5678-90ab-cdef-EXAMPLE66666", "CreatedAt": "2020-01-21T21:34:16.486Z" }, ... ] } ``` Para obter mais informações, consulte [Criar Implantações em Massa para Grupos](https://docs.aws.amazon.com/greengrass/latest/developerguide/bulk-deploy-cli.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [ListBulkDeploymentDetailedReports](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-bulk-deployment-detailed-reports.html) na *Referência de comandos da AWS CLI*. ### `list-bulk-deployments` O código de exemplo a seguir mostra como usar `list-bulk-deployments`. **AWS CLI** **Listar implantações em massa** O exemplo `list-bulk-deployments` a seguir lista todas as implantações em massa. ``` aws greengrass list-bulk-deployments ``` Resultado: ``` { "BulkDeployments": [ { "BulkDeploymentArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/bulk/deployments/870fb41b-6288-4e0c-bc76-a7ba4b4d3267", "BulkDeploymentId": "870fb41b-6288-4e0c-bc76-a7ba4b4d3267", "CreatedAt": "2019-06-25T16:11:33.265Z" } ] } ``` Para obter mais informações, consulte [Criar Implantações em Massa para Grupos](https://docs.aws.amazon.com/greengrass/latest/developerguide/bulk-deploy-cli.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [ListBulkDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-bulk-deployments.html) na *Referência de comandos da AWS CLI*. ### `list-connector-definition-versions` O código de exemplo a seguir mostra como usar `list-connector-definition-versions`. **AWS CLI** **Listar as versões disponíveis para uma definição de conector** O exemplo `list-connector-definition-versions` a seguir lista as versões disponíveis para a definição de conector específico. Use o `list-connector-definitions` comando para obter a ID de definição do conector. ``` aws greengrass list-connector-definition-versions \ --connector-definition-id "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8" ``` Resultado: ``` { "Versions": [ { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/b5c4ebfd-f672-49a3-83cd-31c7216a7bb8/versions/63c57963-c7c2-4a26-a7e2-7bf478ea2623", "CreationTimestamp": "2019-06-19T19:30:01.300Z", "Id": "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8", "Version": "63c57963-c7c2-4a26-a7e2-7bf478ea2623" } ] } ``` Para obter mais informações, consulte [Integração com Serviços e Protocolos usando Conectores Greengrass](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors.html) no **Guia do Desenvolvedor do AWS IoT Greengrass**. + Para ver detalhes da API, consulte [ListConnectorDefinitionVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-connector-definition-versions.html) na *Referência de comandos da AWS CLI*. ### `list-connector-definitions` O código de exemplo a seguir mostra como usar `list-connector-definitions`. **AWS CLI** **Listar os conectores do Greengrass que estão definidos** O exemplo `list-connector-definitions` a seguir lista todos os conectores do Greengrass definidos para sua conta da AWS. ``` aws greengrass list-connector-definitions ``` Resultado: ``` { "Definitions": [ { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/b5c4ebfd-f672-49a3-83cd-31c7216a7bb8", "CreationTimestamp": "2019-06-19T19:30:01.300Z", "Id": "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8", "LastUpdatedTimestamp": "2019-06-19T19:30:01.300Z", "LatestVersion": "63c57963-c7c2-4a26-a7e2-7bf478ea2623", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/b5c4ebfd-f672-49a3-83cd-31c7216a7bb8/versions/63c57963-c7c2-4a26-a7e2-7bf478ea2623", "Name": "MySNSConnector" } ] } ``` Para obter mais informações, consulte [Integração com Serviços e Protocolos usando Conectores Greengrass](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors.html) no **Guia do Desenvolvedor do AWS IoT Greengrass**. + Para ver detalhes da API, consulte [ListConnectorDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-connector-definitions.html) na *Referência de comandos da AWS CLI*. ### `list-core-definition-versions` O código de exemplo a seguir mostra como usar `list-core-definition-versions`. **AWS CLI** **Listar as versões da definição de núcleo do Greengrass** O exemplo `list-core-definitions` a seguir lista todas as versões da definição do núcleo Greengrass especificado. É possível usar o `list-core-definitions` comando para obter a ID da versão. ``` aws greengrass list-core-definition-versions \ --core-definition-id "eaf280cb-138c-4d15-af36-6f681a1348f7" ``` Resultado: ``` { "Versions": [ { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/eaf280cb-138c-4d15-af36-6f681a1348f7/versions/467c36e4-c5da-440c-a97b-084e62593b4c", "CreationTimestamp": "2019-06-18T16:14:17.709Z", "Id": "eaf280cb-138c-4d15-af36-6f681a1348f7", "Version": "467c36e4-c5da-440c-a97b-084e62593b4c" } ] } ``` + Para ver detalhes da API, consulte [ListCoreDefinitionVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-core-definition-versions.html) na *Referência de comandos da AWS CLI*. ### `list-core-definitions` O código de exemplo a seguir mostra como usar `list-core-definitions`. **AWS CLI** **Listar as definições de núcleo do Greengrass** O exemplo `list-core-definitions` a seguir lista todas as definições de núcleo do Greengrass para sua conta da AWS. ``` aws greengrass list-core-definitions ``` Resultado: ``` { "Definitions": [ { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/0507843c-c1ef-4f06-b051-817030df7e7d", "CreationTimestamp": "2018-10-17T04:30:32.786Z", "Id": "0507843c-c1ef-4f06-b051-817030df7e7d", "LastUpdatedTimestamp": "2018-10-17T04:30:32.786Z", "LatestVersion": "bcdf9e86-3793-491e-93af-3cdfbf4e22b7", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/0507843c-c1ef-4f06-b051-817030df7e7d/versions/bcdf9e86-3793-491e-93af-3cdfbf4e22b7" }, { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/31c22500-3509-4271-bafd-cf0655cda438", "CreationTimestamp": "2019-06-18T16:24:16.064Z", "Id": "31c22500-3509-4271-bafd-cf0655cda438", "LastUpdatedTimestamp": "2019-06-18T16:24:16.064Z", "LatestVersion": "2f350395-6d09-4c8a-8336-9ae5b57ace84", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/31c22500-3509-4271-bafd-cf0655cda438/versions/2f350395-6d09-4c8a-8336-9ae5b57ace84" }, { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/c906ed39-a1e3-4822-a981-7b9bd57b4b46", "CreationTimestamp": "2019-06-18T16:21:21.351Z", "Id": "c906ed39-a1e3-4822-a981-7b9bd57b4b46", "LastUpdatedTimestamp": "2019-06-18T16:21:21.351Z", "LatestVersion": "42aeeac3-fd9d-4312-a8fd-ffa9404a20e0", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/c906ed39-a1e3-4822-a981-7b9bd57b4b46/versions/42aeeac3-fd9d-4312-a8fd-ffa9404a20e0" }, { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/eaf280cb-138c-4d15-af36-6f681a1348f7", "CreationTimestamp": "2019-06-18T16:14:17.709Z", "Id": "eaf280cb-138c-4d15-af36-6f681a1348f7", "LastUpdatedTimestamp": "2019-06-18T16:14:17.709Z", "LatestVersion": "467c36e4-c5da-440c-a97b-084e62593b4c", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/eaf280cb-138c-4d15-af36-6f681a1348f7/versions/467c36e4-c5da-440c-a97b-084e62593b4c" } ] } ``` + Para ver detalhes da API, consulte [ListCoreDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-core-definitions.html) na *Referência de comandos da AWS CLI*. ### `list-deployments` O código de exemplo a seguir mostra como usar `list-deployments`. **AWS CLI** **Listar as implantações de um grupo do Greengrass** O exemplo `list-deployments` a seguir lista as implantações do grupo Greengrass específico. É possível usar o comando `list-groups` para procurar sua ID de grupo. ``` aws greengrass list-deployments \ --group-id "1013db12-8b58-45ff-acc7-704248f66731" ``` Resultado: ``` { "Deployments": [ { "CreatedAt": "2019-06-18T17:04:32.702Z", "DeploymentId": "1065b8a0-812b-4f21-9d5d-e89b232a530f", "DeploymentType": "NewDeployment", "GroupArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/115136b3-cfd7-4462-b77f-8741a4b00e5e" } ] } ``` + Para ver detalhes da API, consulte [ListDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-deployments.html) na *Referência de comandos da AWS CLI*. ### `list-device-definition-versions` O código de exemplo a seguir mostra como usar `list-device-definition-versions`. **AWS CLI** **Listar as versões de uma definição de dispositivo** O exemplo `list-device-definition-versions` a seguir exibe as versões da definição de dispositivo associadas à definição de dispositivo específica. ``` aws greengrass list-device-definition-versions \ --device-definition-id "f9ba083d-5ad4-4534-9f86-026a45df1ccd" ``` Resultado: ``` { "Versions": [ { "Version": "83c13984-6fed-447e-84d5-5b8aa45d5f71", "CreationTimestamp": "2019-09-11T00:15:09.838Z", "Id": "f9ba083d-5ad4-4534-9f86-026a45df1ccd", "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd/versions/83c13984-6fed-447e-84d5-5b8aa45d5f71" }, { "Version": "3b5cc510-58c1-44b5-9d98-4ad858ffa795", "CreationTimestamp": "2019-09-11T00:11:06.197Z", "Id": "f9ba083d-5ad4-4534-9f86-026a45df1ccd", "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd/versions/3b5cc510-58c1-44b5-9d98-4ad858ffa795" } ] } ``` + Para ver detalhes da API, consulte [ListDeviceDefinitionVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-device-definition-versions.html) na *Referência de comandos da AWS CLI*. ### `list-device-definitions` O código de exemplo a seguir mostra como usar `list-device-definitions`. **AWS CLI** **Listar as definições do seu dispositivo** O exemplo `list-device-definitions` a seguir exibe detalhes sobre as definições do dispositivo em sua conta AWS na região da AWS especificada. ``` aws greengrass list-device-definitions \ --region us-west-2 ``` Resultado: ``` { "Definitions": [ { "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/50f3274c-3f0a-4f57-b114-6f46085281ab/versions/c777b0f5-1059-449b-beaa-f003ebc56c34", "LastUpdatedTimestamp": "2019-06-14T15:42:09.059Z", "LatestVersion": "c777b0f5-1059-449b-beaa-f003ebc56c34", "CreationTimestamp": "2019-06-14T15:42:09.059Z", "Id": "50f3274c-3f0a-4f57-b114-6f46085281ab", "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/50f3274c-3f0a-4f57-b114-6f46085281ab" }, { "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/e01951c9-6134-479a-969a-1a15cac11c40/versions/514d57aa-4ee6-401c-9fac-938a9f7a51e5", "Name": "TestDeviceDefinition", "LastUpdatedTimestamp": "2019-04-16T23:17:43.245Z", "LatestVersion": "514d57aa-4ee6-401c-9fac-938a9f7a51e5", "CreationTimestamp": "2019-04-16T23:17:43.245Z", "Id": "e01951c9-6134-479a-969a-1a15cac11c40", "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/e01951c9-6134-479a-969a-1a15cac11c40" }, { "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd/versions/83c13984-6fed-447e-84d5-5b8aa45d5f71", "Name": "TemperatureSensors", "LastUpdatedTimestamp": "2019-09-10T00:19:03.698Z", "LatestVersion": "83c13984-6fed-447e-84d5-5b8aa45d5f71", "CreationTimestamp": "2019-09-11T00:11:06.197Z", "Id": "f9ba083d-5ad4-4534-9f86-026a45df1ccd", "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd" } ] } ``` + Para ver detalhes da API, consulte [ListDeviceDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-device-definitions.html) na *Referência de comandos da AWS CLI*. ### `list-function-definition-versions` O código de exemplo a seguir mostra como usar `list-function-definition-versions`. **AWS CLI** **Listar as versões de uma função do Lambda** O exemplo `list-function-definition-versions` a seguir lista todas as versões da função do Lambda específica. É possível usar o comando `list-function-definitions` para obter a ID. ``` aws greengrass list-function-definition-versions \ --function-definition-id "063f5d1a-1dd1-40b4-9b51-56f8993d0f85" ``` Resultado: ``` { "Versions": [ { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/9748fda7-1589-4fcc-ac94-f5559e88678b", "CreationTimestamp": "2019-06-18T17:04:30.776Z", "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85", "Version": "9748fda7-1589-4fcc-ac94-f5559e88678b" }, { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/9b08df77-26f2-4c29-93d2-769715edcfec", "CreationTimestamp": "2019-06-18T17:02:44.087Z", "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85", "Version": "9b08df77-26f2-4c29-93d2-769715edcfec" }, { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/4236239f-94f7-4b90-a2f8-2a24c829d21e", "CreationTimestamp": "2019-06-18T17:01:42.284Z", "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85", "Version": "4236239f-94f7-4b90-a2f8-2a24c829d21e" }, { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/343408bb-549a-4fbe-b043-853643179a39", "CreationTimestamp": "2019-06-18T16:21:21.431Z", "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85", "Version": "343408bb-549a-4fbe-b043-853643179a39" } ] } ``` + Para ver detalhes da API, consulte [ListFunctionDefinitionVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-function-definition-versions.html) na *Referência de comandos da AWS CLI*. ### `list-function-definitions` O código de exemplo a seguir mostra como usar `list-function-definitions`. **AWS CLI** **Listar funções do Lambda** O exemplo `list-function-definitions` a seguir lista todas as funções do Lambda definidas para sua conta da AWS. ``` aws greengrass list-function-definitions ``` Resultado: ``` { "Definitions": [ { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/017970a5-8952-46dd-b1c1-020b3ae8e960", "CreationTimestamp": "2018-10-17T04:30:32.884Z", "Id": "017970a5-8952-46dd-b1c1-020b3ae8e960", "LastUpdatedTimestamp": "2018-10-17T04:30:32.884Z", "LatestVersion": "4380b302-790d-4ed8-92bf-02e88afecb15", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/017970a5-8952-46dd-b1c1-020b3ae8e960/versions/4380b302-790d-4ed8-92bf-02e88afecb15" }, { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85", "CreationTimestamp": "2019-06-18T16:21:21.431Z", "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85", "LastUpdatedTimestamp": "2019-06-18T16:21:21.431Z", "LatestVersion": "9748fda7-1589-4fcc-ac94-f5559e88678b", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/9748fda7-1589-4fcc-ac94-f5559e88678b" }, { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/6598e653-a262-440c-9967-e2697f64da7b", "CreationTimestamp": "2019-06-18T16:24:16.123Z", "Id": "6598e653-a262-440c-9967-e2697f64da7b", "LastUpdatedTimestamp": "2019-06-18T16:24:16.123Z", "LatestVersion": "38bc6ccd-98a2-4ce7-997e-16c84748fae4", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/6598e653-a262-440c-9967-e2697f64da7b/versions/38bc6ccd-98a2-4ce7-997e-16c84748fae4" }, { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/c668df84-fad2-491b-95f4-655d2cad7885", "CreationTimestamp": "2019-06-18T16:14:17.784Z", "Id": "c668df84-fad2-491b-95f4-655d2cad7885", "LastUpdatedTimestamp": "2019-06-18T16:14:17.784Z", "LatestVersion": "37dd68c4-a64f-40ba-aa13-71fecc3ebded", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/c668df84-fad2-491b-95f4-655d2cad7885/versions/37dd68c4-a64f-40ba-aa13-71fecc3ebded" } ] } ``` + Para ver detalhes da API, consulte [ListFunctionDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-function-definitions.html) na *Referência de comandos da AWS CLI*. ### `list-group-certificate-authorities` O código de exemplo a seguir mostra como usar `list-group-certificate-authorities`. **AWS CLI** **Listar as CAs atuais de grupo** O exemplo `list-group-certificate-authorities` a seguir lista as autoridades de certificação (CAs) atuais do grupo Greengrass especificado. ``` aws greengrass list-group-certificate-authorities \ --group-id "1013db12-8b58-45ff-acc7-704248f66731" ``` Resultado: ``` { "GroupCertificateAuthorities": [ { "GroupCertificateAuthorityArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/certificateauthorities/f0430e1736ea8ed30cc5d5de9af67a7e3586bad9ae4d89c2a44163f65fdd8cf6", "GroupCertificateAuthorityId": "f0430e1736ea8ed30cc5d5de9af67a7e3586bad9ae4d89c2a44163f65fdd8cf6" } ] } ``` + Para ver detalhes da API, consulte [ListGroupCertificateAuthorities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-group-certificate-authorities.html) na *Referência de comandos da AWS CLI*. ### `list-group-versions` O código de exemplo a seguir mostra como usar `list-group-versions`. **AWS CLI** **Listar as versões de um grupo do Greengrass** O exemplo `list-group-versions` a seguir lista as versões do grupo Greengrass especificado. ``` aws greengrass list-group-versions \ --group-id "1013db12-8b58-45ff-acc7-704248f66731" ``` Resultado: ``` { "Versions": [ { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/115136b3-cfd7-4462-b77f-8741a4b00e5e", "CreationTimestamp": "2019-06-18T17:04:30.915Z", "Id": "1013db12-8b58-45ff-acc7-704248f66731", "Version": "115136b3-cfd7-4462-b77f-8741a4b00e5e" }, { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/4340669d-d14d-44e3-920c-46c928750750", "CreationTimestamp": "2019-06-18T17:03:52.663Z", "Id": "1013db12-8b58-45ff-acc7-704248f66731", "Version": "4340669d-d14d-44e3-920c-46c928750750" }, { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/1b06e099-2d5b-4f10-91b9-78c4e060f5da", "CreationTimestamp": "2019-06-18T17:02:44.189Z", "Id": "1013db12-8b58-45ff-acc7-704248f66731", "Version": "1b06e099-2d5b-4f10-91b9-78c4e060f5da" }, { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/2d3f27f1-3b43-4554-ab7a-73ec30477efe", "CreationTimestamp": "2019-06-18T17:01:42.401Z", "Id": "1013db12-8b58-45ff-acc7-704248f66731", "Version": "2d3f27f1-3b43-4554-ab7a-73ec30477efe" }, { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/d20f7ae9-3444-4c1c-b025-e2ede23cdd31", "CreationTimestamp": "2019-06-18T16:21:21.457Z", "Id": "1013db12-8b58-45ff-acc7-704248f66731", "Version": "d20f7ae9-3444-4c1c-b025-e2ede23cdd31" } ] } ``` + Para ver detalhes da API, consulte [ListGroupVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-group-versions.html) na *Referência de comandos da AWS CLI*. ### `list-groups` O código de exemplo a seguir mostra como usar `list-groups`. **AWS CLI** **Listar os grupos do Greengrass** O exemplo `list-groups` a seguir lista todos os grupos do Greengrass definidos em sua conta da AWS. ``` aws greengrass list-groups ``` Resultado: ``` { "Groups": [ { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731", "CreationTimestamp": "2019-06-18T16:21:21.457Z", "Id": "1013db12-8b58-45ff-acc7-704248f66731", "LastUpdatedTimestamp": "2019-06-18T16:21:21.457Z", "LatestVersion": "115136b3-cfd7-4462-b77f-8741a4b00e5e", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/115136b3-cfd7-4462-b77f-8741a4b00e5e", "Name": "GGGroup4Pi3" }, { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1402daf9-71cf-4cfe-8be0-d5e80526d0d8", "CreationTimestamp": "2018-10-31T21:52:46.603Z", "Id": "1402daf9-71cf-4cfe-8be0-d5e80526d0d8", "LastUpdatedTimestamp": "2018-10-31T21:52:46.603Z", "LatestVersion": "749af901-60ab-456f-a096-91b12d983c29", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1402daf9-71cf-4cfe-8be0-d5e80526d0d8/versions/749af901-60ab-456f-a096-91b12d983c29", "Name": "MyTestGroup" }, { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/504b5c8d-bbed-4635-aff1-48ec5b586db5", "CreationTimestamp": "2018-12-31T21:39:36.771Z", "Id": "504b5c8d-bbed-4635-aff1-48ec5b586db5", "LastUpdatedTimestamp": "2018-12-31T21:39:36.771Z", "LatestVersion": "46911e8e-f9bc-4898-8b63-59c7653636ec", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/504b5c8d-bbed-4635-aff1-48ec5b586db5/versions/46911e8e-f9bc-4898-8b63-59c7653636ec", "Name": "smp-ggrass-group" } ] } ``` + Consulte detalhes da API em [ListGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-groups.html) na *Referência de comandos da AWS CLI*. ### `list-logger-definition-versions` O código de exemplo a seguir mostra como usar `list-logger-definition-versions`. **AWS CLI** **Obter uma lista de versões da definição de um logger** O exemplo `list-logger-definition-versions` a seguir obtém uma lista de todas as versões da definição de logger específico. ``` aws greengrass list-logger-definition-versions \ --logger-definition-id "49eeeb66-f1d3-4e34-86e3-3617262abf23" ``` Resultado: ``` { "Versions": [ { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/49eeeb66-f1d3-4e34-86e3-3617262abf23/versions/5e3f6f64-a565-491e-8de0-3c0d8e0f2073", "CreationTimestamp": "2019-05-08T16:10:13.866Z", "Id": "49eeeb66-f1d3-4e34-86e3-3617262abf23", "Version": "5e3f6f64-a565-491e-8de0-3c0d8e0f2073" }, { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/49eeeb66-f1d3-4e34-86e3-3617262abf23/versions/3ec6d3af-eb85-48f9-a16d-1c795fe696d7", "CreationTimestamp": "2019-05-08T16:10:13.809Z", "Id": "49eeeb66-f1d3-4e34-86e3-3617262abf23", "Version": "3ec6d3af-eb85-48f9-a16d-1c795fe696d7" } ] } ``` + Para ver detalhes da API, consulte [ListLoggerDefinitionVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-logger-definition-versions.html) na *Referência de comandos da AWS CLI*. ### `list-logger-definitions` O código de exemplo a seguir mostra como usar `list-logger-definitions`. **AWS CLI** **Obter uma lista de definições de logger** O exemplo `list-logger-definitions` a seguir lista todas as definições de logger da sua conta da AWS. ``` aws greengrass list-logger-definitions ``` Resultado: ``` { "Definitions": [ { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/49eeeb66-f1d3-4e34-86e3-3617262abf23", "CreationTimestamp": "2019-05-08T16:10:13.809Z", "Id": "49eeeb66-f1d3-4e34-86e3-3617262abf23", "LastUpdatedTimestamp": "2019-05-08T16:10:13.809Z", "LatestVersion": "5e3f6f64-a565-491e-8de0-3c0d8e0f2073", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/49eeeb66-f1d3-4e34-86e3-3617262abf23/versions/5e3f6f64-a565-491e-8de0-3c0d8e0f2073" } ] } ``` + Para ver detalhes da API, consulte [ListLoggerDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-logger-definitions.html) na *Referência de comandos da AWS CLI*. ### `list-resource-definition-versions` O código de exemplo a seguir mostra como usar `list-resource-definition-versions`. **AWS CLI** **Listar as versões de uma definição de recurso** O exemplo `list-resource-definition-versions` a seguir lista as versões do recurso Greengrass específico. ``` aws greengrass list-resource-definition-versions \ --resource-definition-id "ad8c101d-8109-4b0e-b97d-9cc5802ab658" ``` Resultado: ``` { "Versions": [ { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658/versions/26e8829a-491a-464d-9c87-664bf6f6f2be", "CreationTimestamp": "2019-06-19T16:40:59.392Z", "Id": "ad8c101d-8109-4b0e-b97d-9cc5802ab658", "Version": "26e8829a-491a-464d-9c87-664bf6f6f2be" }, { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658/versions/432d92f6-12de-4ec9-a704-619a942a62aa", "CreationTimestamp": "2019-06-19T16:40:59.261Z", "Id": "ad8c101d-8109-4b0e-b97d-9cc5802ab658", "Version": "432d92f6-12de-4ec9-a704-619a942a62aa" } ] } ``` + Para ver detalhes da API, consulte [ListResourceDefinitionVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-resource-definition-versions.html) na *Referência de comandos da AWS CLI*. ### `list-resource-definitions` O código de exemplo a seguir mostra como usar `list-resource-definitions`. **AWS CLI** **Listar os recursos que estão definidos** O exemplo `list-resource-definitions` a seguir lista os recursos definidos para serem usados pelo AWS IoT Greengrass. ``` aws greengrass list-resource-definitions ``` Resultado: ``` { "Definitions": [ { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658", "CreationTimestamp": "2019-06-19T16:40:59.261Z", "Id": "ad8c101d-8109-4b0e-b97d-9cc5802ab658", "LastUpdatedTimestamp": "2019-06-19T16:40:59.261Z", "LatestVersion": "26e8829a-491a-464d-9c87-664bf6f6f2be", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658/versions/26e8829a-491a-464d-9c87-664bf6f6f2be" }, { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/c8bb9ebc-c3fd-40a4-9c6a-568d75569d38", "CreationTimestamp": "2019-06-19T21:51:28.212Z", "Id": "c8bb9ebc-c3fd-40a4-9c6a-568d75569d38", "LastUpdatedTimestamp": "2019-06-19T21:51:28.212Z", "LatestVersion": "a5f94d0b-f6bc-40f4-bb78-7a1c5fe13ba1", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/c8bb9ebc-c3fd-40a4-9c6a-568d75569d38/versions/a5f94d0b-f6bc-40f4-bb78-7a1c5fe13ba1", "Name": "MyGreengrassResources" } ] } ``` + Para ver detalhes da API, consulte [ListResourceDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-resource-definitions.html) na *Referência de comandos da AWS CLI*. ### `list-subscription-definition-versions` O código de exemplo a seguir mostra como usar `list-subscription-definition-versions`. **AWS CLI** **Listar as versões de uma definição de assinatura** O exemplo `list-subscription-definition-versions` a seguir lista todas as versões das assinaturas específicas. Você pode usar o `list-subscription-definitions` comando para pesquisar a ID da assinatura. ``` aws greengrass list-subscription-definition-versions \ --subscription-definition-id "70e49321-83d5-45d2-bc09-81f4917ae152" ``` Resultado: ``` { "Versions": [ { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152/versions/88ae8699-12ac-4663-ba3f-4d7f0519140b", "CreationTimestamp": "2019-06-18T17:03:52.499Z", "Id": "70e49321-83d5-45d2-bc09-81f4917ae152", "Version": "88ae8699-12ac-4663-ba3f-4d7f0519140b" }, { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152/versions/7e320ba3-c369-4069-a2f0-90acb7f219d6", "CreationTimestamp": "2019-06-18T17:03:52.392Z", "Id": "70e49321-83d5-45d2-bc09-81f4917ae152", "Version": "7e320ba3-c369-4069-a2f0-90acb7f219d6" } ] } ``` + Para ver detalhes da API, consulte [ListSubscriptionDefinitionVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-subscription-definition-versions.html) na *Referência de comandos da AWS CLI*. ### `list-subscription-definitions` O código de exemplo a seguir mostra como usar `list-subscription-definitions`. **AWS CLI** **Obter uma lista de definições de assinatura** O exemplo `list-subscription-definitions` a seguir lista todas as assinaturas do AWS IoT Greengrass definidas em sua conta da AWS. ``` aws greengrass list-subscription-definitions ``` Resultado: ``` { "Definitions": [ { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152", "CreationTimestamp": "2019-06-18T17:03:52.392Z", "Id": "70e49321-83d5-45d2-bc09-81f4917ae152", "LastUpdatedTimestamp": "2019-06-18T17:03:52.392Z", "LatestVersion": "88ae8699-12ac-4663-ba3f-4d7f0519140b", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152/versions/88ae8699-12ac-4663-ba3f-4d7f0519140b" }, { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/cd6f1c37-d9a4-4e90-be94-01a7404f5967", "CreationTimestamp": "2018-10-18T15:45:34.024Z", "Id": "cd6f1c37-d9a4-4e90-be94-01a7404f5967", "LastUpdatedTimestamp": "2018-10-18T15:45:34.024Z", "LatestVersion": "d1cf8fac-284f-4f6a-98fe-a2d36d089373", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/cd6f1c37-d9a4-4e90-be94-01a7404f5967/versions/d1cf8fac-284f-4f6a-98fe-a2d36d089373" }, { "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/fa81bc84-3f59-4377-a84b-5d0134da359b", "CreationTimestamp": "2018-10-22T17:09:31.429Z", "Id": "fa81bc84-3f59-4377-a84b-5d0134da359b", "LastUpdatedTimestamp": "2018-10-22T17:09:31.429Z", "LatestVersion": "086d1b08-b25a-477c-a16f-6f9b3a9c295a", "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/fa81bc84-3f59-4377-a84b-5d0134da359b/versions/086d1b08-b25a-477c-a16f-6f9b3a9c295a" } ] } ``` + Para ver detalhes da API, consulte [ListSubscriptionDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-subscription-definitions.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Listar as marcas anexadas a um recurso** O exemplo `list-tags-for-resource` a seguir lista as marcas e seus valores anexados ao recurso específico. ``` aws greengrass list-tags-for-resource \ --resource-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658" ``` Resultado: ``` { "tags": { "ResourceSubType": "USB", "ResourceType": "Device" } } ``` Para obter mais informações, consulte [Como Marcar seus Recursos Greengrass](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) no **Guia do Desenvolvedor do AWS IoT Greengrass**. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `reset-deployments` O código de exemplo a seguir mostra como usar `reset-deployments`. **AWS CLI** **Limpar as informações de implantação de um grupo do Greengrass** O exemplo `reset-deployments` a seguir limpa as informações de implantação do grupo Greengrass específico. Quando se adiciona o `--force option`, as informações de implantação são redefinidas sem esperar que o dispositivo principal responda. ``` aws greengrass reset-deployments \ --group-id "1402daf9-71cf-4cfe-8be0-d5e80526d0d8" \ --force ``` Resultado: ``` { "DeploymentArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1402daf9-71cf-4cfe-8be0-d5e80526d0d8/deployments/7dd4e356-9882-46a3-9e28-6d21900c011a", "DeploymentId": "7dd4e356-9882-46a3-9e28-6d21900c011a" } ``` Para obter mais informações, consulte [Resetar Implantações](https://docs.aws.amazon.com/greengrass/latest/developerguide/reset-deployments-scenario.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [ResetDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/reset-deployments.html) na *Referência de comandos da AWS CLI*. ### `start-bulk-deployment` O código de exemplo a seguir mostra como usar `start-bulk-deployment`. **AWS CLI** **Iniciar uma operação de implantação em massa** O exemplo `start-bulk-deployment` a seguir inicia uma operação de implantação em massa, usando um arquivo armazenado em um bucket S3 para especificar os grupos a serem implantados. ``` aws greengrass start-bulk-deployment \ --cli-input-json "{\"InputFileUri\":\"https://gg-group-deployment1.s3-us-west-2.amazonaws.com/MyBulkDeploymentInputFile.txt\", \"ExecutionRoleArn\":\"arn:aws:iam::123456789012:role/ggCreateDeploymentRole\",\"AmznClientToken\":\"yourAmazonClientToken\"}" ``` Resultado: ``` { "BulkDeploymentArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/bulk/deployments/870fb41b-6288-4e0c-bc76-a7ba4b4d3267", "BulkDeploymentId": "870fb41b-6288-4e0c-bc76-a7ba4b4d3267" } ``` Para obter mais informações, consulte [Criar Implantações em Massa para Grupos](https://docs.aws.amazon.com/greengrass/latest/developerguide/bulk-deploy-cli.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para obter detalhes sobre a API, consulte [StartBulkDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/start-bulk-deployment.html) na *AWS CLI Referência de comando*. ### `stop-bulk-deployment` O código de exemplo a seguir mostra como usar `stop-bulk-deployment`. **AWS CLI** **Interromper uma implantação em massa** O exemplo `stop-bulk-deployment` a seguir interrompe a implantação em massa específica. Ao tentar interromper uma implantação em massa que foi concluída, ocorrerá um erro: `InvalidInputException: Cannot change state of finished execution.` ``` aws greengrass stop-bulk-deployment \ --bulk-deployment-id "870fb41b-6288-4e0c-bc76-a7ba4b4d3267" ``` Este comando não produz saída. Para obter mais informações, consulte [Criar Implantações em Massa para Grupos](https://docs.aws.amazon.com/greengrass/latest/developerguide/bulk-deploy-cli.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [StopBulkDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/stop-bulk-deployment.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Aplicar marcas a um recurso** O exemplo `tag-resource` a seguir aplica duas marcas, `ResourceType` e `ResourceSubType`, ao recurso Greengrass específico. Essa operação pode adicionar novas marcas e valores ou atualizar o valor das marcas existentes. Para remover uma marca, use o comando `untag-resource`. ``` aws greengrass tag-resource \ --resource-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658" \ --tags "ResourceType=Device,ResourceSubType=USB" ``` Este comando não produz saída. Para obter mais informações, consulte [Como Marcar seus Recursos Greengrass](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) no **Guia do Desenvolvedor do AWS IoT Greengrass**. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Remover uma marca e seu valor de um recurso** O exemplo `untag-resource` a seguir remove a marca, cuja chave é `Category`, do grupo Greengrass específico. Se a chave `Category` não existir para o recurso especificado, não haverá mensagem de erro. ``` aws greengrass untag-resource \ --resource-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731" \ --tag-keys "Category" ``` Este comando não produz saída. Para obter mais informações, consulte [Como Marcar seus Recursos Greengrass](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) no **Guia do Desenvolvedor do AWS IoT Greengrass**. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-connectivity-info` O código de exemplo a seguir mostra como usar `update-connectivity-info`. **AWS CLI** **Atualizar as informações de conectividade para um núcleo do Greengrass ** O exemplo `update-connectivity-info` a seguir altera os endpoints que os dispositivos podem usar para se conectar ao núcleo específico do Greengrass. As informações de conectividade são uma lista de endereços IP ou nomes de domínio, com números de porta correspondentes e metadados opcionais definidos pelo cliente. Talvez seja necessário atualizar as informações de conectividade quando a rede local mudar. ``` aws greengrass update-connectivity-info \ --thing-name "MyGroup_Core" \ --connectivity-info "[{\"Metadata\":\"\",\"PortNumber\":8883,\"HostAddress\":\"127.0.0.1\",\"Id\":\"localhost_127.0.0.1_0\"},{\"Metadata\":\"\",\"PortNumber\":8883,\"HostAddress\":\"192.168.1.3\",\"Id\":\"localIP_192.168.1.3\"}]" ``` Resultado: ``` { "Version": "312de337-59af-4cf9-a278-2a23bd39c300" } ``` + Para ver detalhes da API, consulte [UpdateConnectivityInfo](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/update-connectivity-info.html) na * Referência de comandos da AWS CLI*. ### `update-connector-definition` O código de exemplo a seguir mostra como usar `update-connector-definition`. **AWS CLI** **Atualizar o nome de uma definição de conector** O exemplo `update-connector-definition` a seguir atualiza o nome da definição do conector específico. Se desejar atualizar os detalhes do conector, use o `create-connector-definition-version` comando para criar uma nova versão. ``` aws greengrass update-connector-definition \ --connector-definition-id "55d0052b-0d7d-44d6-b56f-21867215e118" \ --name "GreengrassConnectors2019" ``` Para obter mais informações, consulte [Integração com Serviços e Protocolos usando Conectores](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [UpdateConnectorDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/update-connector-definition.html) na *Referência de comandos da AWS CLI*. ### `update-core-definition` O código de exemplo a seguir mostra como usar `update-core-definition`. **AWS CLI** **Atualizar uma definição de núcleo** O exemplo `update-core-definition` a seguir altera o nome da definição do núcleo específico. Só é possível atualizar a propriedade `name` de uma definição de núcleo. ``` aws greengrass update-core-definition \ --core-definition-id "582efe12-b05a-409e-9a24-a2ba1bcc4a12" \ --name "MyCoreDevices" ``` Este comando não produz saída. Para obter mais informações, consulte [Configurar AWS IoT Greengrass Core](https://docs.aws.amazon.com/greengrass/latest/developerguide/gg-core.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [UpdateCoreDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/update-core-definition.html) na *Referência de comandos da AWS CLI*. ### `update-device-definition` O código de exemplo a seguir mostra como usar `update-device-definition`. **AWS CLI** **Atualizar uma definição de dispositivo** O exemplo `update-device-definition` a seguir altera o nome da definição do dispositivo específico. Só é possível atualizar a propriedade `name` de uma definição de dispositivo. ``` aws greengrass update-device-definition \ --device-definition-id "f9ba083d-5ad4-4534-9f86-026a45df1ccd" \ --name "TemperatureSensors" ``` Este comando não produz saída. + Para ver detalhes da API, consulte [UpdateDeviceDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/update-device-definition.html) na *Referência de comandos da AWS CLI*. ### `update-function-definition` O código de exemplo a seguir mostra como usar `update-function-definition`. **AWS CLI** **Atualizar o nome de uma definição de função** O exemplo `update-function-definition` a seguir atualiza o nome da definição da função específica. Se desejar atualizar os detalhes da função, use o comando `create-function-definition-version` para criar uma nova versão. ``` aws greengrass update-function-definition \ --function-definition-id "e47952bd-dea9-4e2c-a7e1-37bbe8807f46" \ --name ObsoleteFunction ``` Este comando não produz saída. Para obter mais informações, consulte [Executar funções do Lambda locais](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-functions.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [UpdateFunctionDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/update-function-definition.html) na *Referência de comandos da AWS CLI*. ### `update-group-certificate-configuration` O código de exemplo a seguir mostra como usar `update-group-certificate-configuration`. **AWS CLI** **Atualizar a expiração dos certificados de um grupo** O exemplo `update-group-certificate-configuration` a seguir define uma expiração de 10 dias para os certificados gerados para o grupo especificado. ``` aws greengrass update-group-certificate-configuration \ --group-id "8eaadd72-ce4b-4f15-892a-0cc4f3a343f1" \ --certificate-expiry-in-milliseconds 864000000 ``` Resultado: ``` { "CertificateExpiryInMilliseconds": 864000000, "CertificateAuthorityExpiryInMilliseconds": 2524607999000, "GroupId": "8eaadd72-ce4b-4f15-892a-0cc4f3a343f1" } ``` Para obter mais informações sobre grupos, consulte [Segurança do AWS IoT Greengrass](https://docs.aws.amazon.com/greengrass/latest/developerguide/gg-sec.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [UpdateGroupCertificateConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/update-group-certificate-configuration.html) na *Referência de comandos da AWS CLI*. ### `update-group` O código de exemplo a seguir mostra como usar `update-group`. **AWS CLI** **Atualizar o nome do grupo** O exemplo `update-group` a seguir atualiza o nome do grupo Greengrass específico. Se desejar atualizar os detalhes do grupo, use o comando `create-group-version` para criar uma nova versão. ``` aws greengrass update-group \ --group-id "1402daf9-71cf-4cfe-8be0-d5e80526d0d8" \ --name TestGroup4of6 ``` Para obter mais informações, consulte [Configurar o AWS IoT Greengrass na AWS IoT](https://docs.aws.amazon.com/greengrass/latest/developerguide/gg-config.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Consulte detalhes da API em [UpdateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/update-group.html) na *Referência de comandos da AWS CLI*. ### `update-logger-definition` O código de exemplo a seguir mostra como usar `update-logger-definition`. **AWS CLI** **Atualizar uma definição de logger** O exemplo `update-logger-definition` a seguir altera o nome da definição do logger específico. Só é possível atualizar a propriedade `name` de uma definição de logger. ``` aws greengrass update-logger-definition \ --logger-definition-id "a454b62a-5d56-4ca9-bdc4-8254e1662cb0" \ --name "LoggingConfigsForSensors" ``` Este comando não produz saída. Para obter mais informações, consulte [Monitoring with AWS IoT Greengrass Logs](https://docs.aws.amazon.com/greengrass/latest/developerguide/greengrass-logs-overview.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [UpdateLoggerDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/update-logger-definition.html) na *Referência de comandos da AWS CLI*. ### `update-resource-definition` O código de exemplo a seguir mostra como usar `update-resource-definition`. **AWS CLI** **Atualizar o nome de uma definição de recurso** O exemplo `update-resource-definition` a seguir atualiza o nome da definição do recurso específico. Se desejar alterar os detalhes do recurso, use o comando `create-resource-definition-version` para criar uma nova versão. ``` aws greengrass update-resource-definition \ --resource-definition-id "c8bb9ebc-c3fd-40a4-9c6a-568d75569d38" \ --name GreengrassConnectorResources ``` Este comando não produz saída. Para obter mais informações, consulte [Acessar Recursos Locais com Funções do Lambda e Conectores](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-local-resources.html) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [UpdateResourceDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/update-resource-definition.html) na *Referência de comandos da AWS CLI*. ### `update-subscription-definition` O código de exemplo a seguir mostra como usar `update-subscription-definition`. **AWS CLI** **Atualizar o nome de uma definição de assinatura** O exemplo `update-subscription-definition` a seguir atualiza o nome da definição de assinatura específica. Se desejar alterar os detalhes da assinatura, use o comando `create-subscription-definition-version` para criar uma nova versão. ``` aws greengrass update-subscription-definition \ --subscription-definition-id "fa81bc84-3f59-4377-a84b-5d0134da359b" \ --name "ObsoleteSubscription" ``` Este comando não produz saída. Para obter mais informações, consulte *guia*. + Para ver detalhes da API, consulte [UpdateSubscriptionDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/update-subscription-definition.html) na *Referência de comandos da AWS CLI*. ### `update-thing-runtime-configuration` O código de exemplo a seguir mostra como usar `update-thing-runtime-configuration`. **AWS CLI** **Para ativar a telemetria na configuração de runtime de um núcleo Greengrass** O exemplo `update-thing-runtime-configuration` a seguir atualiza a configuração de runtime de um núcleo do Greengrass para ativar a telemetria. ``` aws greengrass update-thing-runtime-configuration \ --thing-name SampleGreengrassCore \ --telemetry-configuration {\"Telemetry\":\"On\"} ``` Este comando não produz saída. Para obter mais informações, consulte [Configuring telemetry settings](https://docs.aws.amazon.com/greengrass/latest/developerguide/telemetry.html#configure-telemetry-settings) no *Guia do Desenvolvedor do AWS IoT Greengrass*. + Para ver detalhes da API, consulte [UpdateThingRuntimeConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/update-thing-runtime-configuration.html) na *Referência de comandos da AWS CLI*. # AWS IoT Greengrass V2 Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o AWS IoT Greengrass V2. *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 ### `associate-service-role-to-account` O código de exemplo a seguir mostra como usar `associate-service-role-to-account`. **AWS CLI** **Associar o perfil de serviço Greengrass à sua AWS conta** O exemplo `associate-service-role-to-account` a seguir associa um perfil de serviço ao AWS IoT Greengrass para sua conta da AWS. ``` aws greengrassv2 associate-service-role-to-account \ --role-arn arn:aws:iam::123456789012:role/service-role/Greengrass_ServiceRole ``` Resultado: ``` { "associatedAt": "2022-01-19T19:21:53Z" } ``` Para obter mais informações, consulte [Perfil de serviço do Greengrass](https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Para ver detalhes da API, consulte [AssociateServiceRoleToAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/associate-service-role-to-account.html) na * Referência do comando da AWS CLI*. ### `batch-associate-client-device-with-core-device` O código de exemplo a seguir mostra como usar `batch-associate-client-device-with-core-device`. **AWS CLI** **Associar dispositivos-clientes a um dispositivo principal** O exemplo `batch-associate-client-device-with-core-device` a seguir associa dois dispositivos-clientes a um dispositivo principal. ``` aws greengrassv2 batch-associate-client-device-with-core-device \ --core-device-thing-name MyGreengrassCore \ --entries thingName=MyClientDevice1 thingName=MyClientDevice2 ``` Resultado: ``` { "errorEntries": [] } ``` Para obter mais informações, consulte [Interagindo com dispositivos IoT locais](https://docs.aws.amazon.com/greengrass/v2/developerguide/interact-with-local-iot-devices.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Para ver detalhes da API, consulte [BatchAssociateClientDeviceWithCoreDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/batch-associate-client-device-with-core-device.html) na *Referência de comandos da AWS CLI*. ### `batch-disassociate-client-device-from-core-device` O código de exemplo a seguir mostra como usar `batch-disassociate-client-device-from-core-device`. **AWS CLI** **Desassociar dispositivos-clientes de um dispositivo principal** O exemplo `batch-disassociate-client-device-from-core-device` a seguir desassocia dois dispositivos-clientes de um dispositivo principal. ``` aws greengrassv2 batch-disassociate-client-device-from-core-device \ --core-device-thing-name MyGreengrassCore \ --entries thingName=MyClientDevice1 thingName=MyClientDevice2 ``` Resultado: ``` { "errorEntries": [] } ``` Para obter mais informações, consulte [Interagindo com dispositivos IoT locais](https://docs.aws.amazon.com/greengrass/v2/developerguide/interact-with-local-iot-devices.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Para ver detalhes da API, consulte [BatchDisassociateClientDeviceFromCoreDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/batch-disassociate-client-device-from-core-device.html) na *Referência de comandos da AWS CLI*. ### `cancel-deployment` O código de exemplo a seguir mostra como usar `cancel-deployment`. **AWS CLI** **Cancelar uma implantação** O exemplo `cancel-deployment` a seguir interrompe uma implantação contínua em um grupo de itens. ``` aws greengrassv2 cancel-deployment \ --deployment-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "message": "SUCCESS" } ``` Para obter mais informações, consulte [Cancelar implantações](https://docs.aws.amazon.com/greengrass/v2/developerguide/cancel-deployments.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Para ver detalhes da API, consulte [CancelDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/cancel-deployment.html) na *Referência de comandos da AWS CLI*. ### `create-component-version` O código de exemplo a seguir mostra como usar `create-component-version`. **AWS CLI** **Exemplo 1: criar uma versão de componente a partir de uma fórmula** O exemplo `create-component-version` a seguir cria uma versão de um componente Hello World a partir de um arquivo de fórmula. ``` aws greengrassv2 create-component-version \ --inline-recipe fileb://com.example.HelloWorld-1.0.0.json ``` Conteúdo de `com.example.HelloWorld-1.0.0.json`: ``` { "RecipeFormatVersion": "2020-01-25", "ComponentName": "com.example.HelloWorld", "ComponentVersion": "1.0.0", "ComponentDescription": "My first AWS IoT Greengrass component.", "ComponentPublisher": "Amazon", "ComponentConfiguration": { "DefaultConfiguration": { "Message": "world" } }, "Manifests": [ { "Platform": { "os": "linux" }, "Lifecycle": { "Run": "echo 'Hello {configuration:/Message}'" } } ] } ``` Resultado: ``` { "arn": "arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0", "componentName": "com.example.HelloWorld", "componentVersion": "1.0.0", "creationTimestamp": "2021-01-07T16:24:33.650000-08:00", "status": { "componentState": "REQUESTED", "message": "NONE", "errors": {} } } ``` Para obter mais informações, consulte [Criar componentes personalizados](https://docs.aws.amazon.com/greengrass/v2/developerguide/create-components.html) e [Fazer upload de componentes para implantar](https://docs.aws.amazon.com/greengrass/v2/developerguide/upload-components.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. **Exemplo 2: criar uma versão de componente a partir de uma AWS função do Lambda** O exemplo `create-component-version` a seguir cria uma versão de um componente Hello World a partir de uma AWS função do Lambda. ``` aws greengrassv2 create-component-version \ --cli-input-json file://lambda-function-component.json ``` Conteúdo de `lambda-function-component.json`: ``` { "lambdaFunction": { "lambdaArn": "arn:aws:lambda:us-west-2:123456789012:function:HelloWorldPythonLambda:1", "componentName": "com.example.HelloWorld", "componentVersion": "1.0.0", "componentLambdaParameters": { "eventSources": [ { "topic": "hello/world/+", "type": "IOT_CORE" } ] } } } ``` Resultado: ``` { "arn": "arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0", "componentName": "com.example.HelloWorld", "componentVersion": "1.0.0", "creationTimestamp": "2021-01-07T17:05:27.347000-08:00", "status": { "componentState": "REQUESTED", "message": "NONE", "errors": {} } } ``` Para obter mais informações, consulte [Executar AWS funções do Lambda](https://docs.aws.amazon.com/greengrass/v2/developerguide/run-lambda-functions.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Para ver detalhes da API, consulte [CreateComponentVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/create-component-version.html) na *Referência de comandos da AWS CLI*. ### `create-deployment` O código de exemplo a seguir mostra como usar `create-deployment`. **AWS CLI** **Exemplo 1: criar uma implantação** O exemplo `create-deployment` a seguir implanta a Interface AWS IoT Greengrass Command Line Interface em um dispositivo principal. ``` aws greengrassv2 create-deployment \ --cli-input-json file://cli-deployment.json ``` Conteúdo de `cli-deployment.json`: ``` { "targetArn": "arn:aws:iot:us-west-2:123456789012:thing/MyGreengrassCore", "deploymentName": "Deployment for MyGreengrassCore", "components": { "aws.greengrass.Cli": { "componentVersion": "2.0.3" } }, "deploymentPolicies": { "failureHandlingPolicy": "DO_NOTHING", "componentUpdatePolicy": { "timeoutInSeconds": 60, "action": "NOTIFY_COMPONENTS" }, "configurationValidationPolicy": { "timeoutInSeconds": 60 } }, "iotJobConfiguration": {} } ``` Resultado: ``` { "deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } ``` Para obter mais informações, consulte [Criar implantações](https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. **Exemplo 2: criar uma implantação que atualize as configurações dos componentes** O exemplo `create-deployment` a seguir implanta o componente do núcleo do AWS IoT Greengrass em um grupo de dispositivos principais. Esta implantação aplica as seguintes atualizações de configuração para o componente do núcleo: Redefine as configurações de proxy dos dispositivos de destino para suas configurações padrão sem proxy.Redefine as configurações de MQTT dos dispositivos de destino para suas configurações padrão.Define as opções de JVM para a JVM do núcleo.Define o nível de logging para o núcleo. ``` aws greengrassv2 create-deployment \ --cli-input-json file://nucleus-deployment.json ``` Conteúdo de `nucleus-deployment.json`: ``` { "targetArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/MyGreengrassCoreGroup", "deploymentName": "Deployment for MyGreengrassCoreGroup", "components": { "aws.greengrass.Nucleus": { "componentVersion": "2.0.3", "configurationUpdate": { "reset": [ "/networkProxy", "/mqtt" ], "merge": "{\"jvmOptions\":\"-Xmx64m\",\"logging\":{\"level\":\"WARN\"}}" } } }, "deploymentPolicies": { "failureHandlingPolicy": "ROLLBACK", "componentUpdatePolicy": { "timeoutInSeconds": 60, "action": "NOTIFY_COMPONENTS" }, "configurationValidationPolicy": { "timeoutInSeconds": 60 } }, "iotJobConfiguration": {} } ``` Resultado: ``` { "deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "iotJobId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "iotJobArn": "arn:aws:iot:us-west-2:123456789012:job/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" } ``` Para obter mais informações, consulte [Criar implantações](https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html) e [Atualizar configurações de componentes](https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Consulte detalhes da API em [CreateDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/create-deployment.html) na *Referência de comandos da AWS CLI*. ### `delete-component` O código de exemplo a seguir mostra como usar `delete-component`. **AWS CLI** **Excluir uma versão do componente** O exemplo `delete-component` a seguir exclui um componente do Hello World. ``` aws greengrassv2 delete-component \ --arn arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0 ``` Este comando não produz saída. Para obter mais informações, consulte o [Gerenciar componentes](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-components.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Para ver detalhes da API, consulte [DeleteComponent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/delete-component.html) na * Referência do comando da AWS CLI*. ### `delete-core-device` O código de exemplo a seguir mostra como usar `delete-core-device`. **AWS CLI** **Excluir dispositivo principal** O exemplo `delete-core-device` a seguir exclui um dispositivo principal do AWS IoT Greengrass. ``` aws greengrassv2 delete-core-device \ --core-device-thing-name MyGreengrassCore ``` Este comando não produz saída. Para obter mais informações, consulte [Desinstalar o software principal do AWS IoT Greengrass](https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#uninstall-greengrass-core-v2) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Para ver detalhes da API, consulte [DeleteCoreDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/delete-core-device.html) na *Referência de comandos da AWS CLI*. ### `describe-component` O código de exemplo a seguir mostra como usar `describe-component`. **AWS CLI** **Descrever a versão de um componente** O exemplo `describe-component` a seguir descreve um componente do Hello World. ``` aws greengrassv2 describe-component \ --arn arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0 ``` Resultado: ``` { "arn": "arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0", "componentName": "com.example.HelloWorld", "componentVersion": "1.0.0", "creationTimestamp": "2021-01-07T17:12:11.133000-08:00", "publisher": "Amazon", "description": "My first AWS IoT Greengrass component.", "status": { "componentState": "DEPLOYABLE", "message": "NONE", "errors": {} }, "platforms": [ { "attributes": { "os": "linux" } } ] } ``` Para obter mais informações, consulte o [Gerenciar componentes](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-components.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Para ver detalhes da API, consulte [DescribeComponent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/describe-component.html) na *Referência de comandos da AWS CLI*. ### `disassociate-service-role-from-account` O código de exemplo a seguir mostra como usar `disassociate-service-role-from-account`. **AWS CLI** **Desassociar o perfil de serviço do Greengrass de sua AWS conta** O exemplo `disassociate-service-role-from-account` a seguir desassocia o perfil de serviço Greengrass do AWS IoT Greengrass da sua conta da AWS. ``` aws greengrassv2 disassociate-service-role-from-account ``` Resultado: ``` { "disassociatedAt": "2022-01-19T19:26:09Z" } ``` Para obter mais informações, consulte [Perfil de serviço do Greengrass](https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Para ver detalhes da API, consulte [DisassociateServiceRoleFromAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/disassociate-service-role-from-account.html) na *Referência de comandos da AWS CLI*. ### `get-component-version-artifact` O código de exemplo a seguir mostra como usar `get-component-version-artifact`. **AWS CLI** **Obter uma URL para baixar um artefato de componente** O exemplo `get-component-version-artifact` a seguir obtém uma URL para baixar o arquivo JAR do componente do console de depuração local. ``` aws greengrassv2 get-component-version-artifact \ --arn arn:aws:greengrass:us-west-2:aws:components:aws.greengrass.LocalDebugConsole:versions:2.0.3 \ --artifact-name "Uvt6ZEzQ9TKiAuLbfXBX_APdY0TWks3uc46tHFHTzBM=/aws.greengrass.LocalDebugConsole.jar" ``` Resultado: ``` { "preSignedUrl": "https://evergreencomponentmanageme-artifactbucket7410c9ef-g18n1iya8kwr.s3.us-west-2.amazonaws.com/public/aws.greengrass.LocalDebugConsole/2.0.3/s3/ggv2-component-releases-prod-pdx/EvergreenHttpDebugView/2ffc496ba41b39568968b22c582b4714a937193ee7687a45527238e696672521/aws.greengrass.LocalDebugConsole/aws.greengrass.LocalDebugConsole.jar?X-Amz-Security-Token=KwfLKSdEXAMPLE..." } ``` Para obter mais informações, consulte o [Gerenciar componentes](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-components.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Para ver detalhes da API, consulte [GetComponentVersionArtifact](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/get-component-version-artifact.html) na *Referência de comandos da AWS CLI*. ### `get-component` O código de exemplo a seguir mostra como usar `get-component`. **AWS CLI** **Exemplo 1: baixar a fórmula de um componente no formato YAML (Linux, macOS ou Unix)** O exemplo `get-component` a seguir baixa a fórmula de um componente Hello World em um arquivo no formato YAML. Esse comando faz o seguinte: Usa os parâmetros `--output` e `--query` para controlar a saída do comando. Esses parâmetros extraem o blob da fórmula da saída do comando. Para obter mais informações, consulte [Controlar a saída do comando](https://docs.aws.amazon.com/cli/latest/userguide/controlling-output.html) no * Guia do Usuário do AWS Command Line Interface*. Usa o `base64` utilitário. Este utilitário decodifica o blob extraído para o texto original. O blob devolvido por um comando `get-component` bem-sucedido é um texto codificado em base64. É necessário decodificar esse blob para obter o texto original. Salva o texto decodificado em um arquivo. A seção final do comando (`> com.example.HelloWorld-1.0.0.json`) salva o texto decodificado em um arquivo. ``` aws greengrassv2 get-component \ --arn arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0 \ --recipe-output-format YAML \ --query recipe \ --output text | base64 --decode > com.example.HelloWorld-1.0.0.json ``` Para obter mais informações, consulte o [Gerenciar componentes](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-components.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. **Exemplo 2: baixar a fórmula de um componente no formato YAML (Windows CMD)** O exemplo `get-component` a seguir baixa a fórmula de um componente Hello World em um arquivo no formato YAML. Este comando usa o `certutil` utilitário. ``` aws greengrassv2 get-component ^ --arn arn:aws:greengrass:us-west-2:675946970638:components:com.example.HelloWorld:versions:1.0.0 ^ --recipe-output-format YAML ^ --query recipe ^ --output text > com.example.HelloWorld-1.0.0.yaml.b64 certutil -decode com.example.HelloWorld-1.0.0.yaml.b64 com.example.HelloWorld-1.0.0.yaml ``` Para obter mais informações, consulte o [Gerenciar componentes](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-components.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. **Exemplo 3: baixar a fórmula de um componente no formato YAML (Windows PowerShell)** O exemplo `get-component` a seguir baixa a fórmula de um componente Hello World em um arquivo no formato YAML. Este comando usa o `certutil` utilitário. ``` aws greengrassv2 get-component ` --arn arn:aws:greengrass:us-west-2:675946970638:components:com.example.HelloWorld:versions:1.0.0 ` --recipe-output-format YAML ` --query recipe ` --output text > com.example.HelloWorld-1.0.0.yaml.b64 certutil -decode com.example.HelloWorld-1.0.0.yaml.b64 com.example.HelloWorld-1.0.0.yaml ``` Para obter mais informações, consulte o [Gerenciar componentes](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-components.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Para ver detalhes da API, consulte [GetComponent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/get-component.html) na * Referência do comando da AWS CLI*. ### `get-connectivity-info` O código de exemplo a seguir mostra como usar `get-connectivity-info`. **AWS CLI** **Obter informações de conectividade para um dispositivo principal do Greengrass** O exemplo `get-connectivity-info` a seguir obtém informações de conectividade para um dispositivo principal do Greengrass. Os dispositivos-clientes usam essas informações para se conectar ao agente MQTT, executado nesse dispositivo principal. ``` aws greengrassv2 get-connectivity-info \ --thing-name MyGreengrassCore ``` Resultado: ``` { "connectivityInfo": [ { "id": "localIP_192.0.2.0", "hostAddress": "192.0.2.0", "portNumber": 8883 } ] } ``` Para obter mais informações, consulte [Gerenciar endpoints de dispositivos principais](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-core-device-endpoints.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Para receber detalhes da API, consulte [GetConnectivityInfo](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/get-connectivity-info.html) na * Referência de comandos da AWS CLI*. ### `get-core-device` O código de exemplo a seguir mostra como usar `get-core-device`. **AWS CLI** **Obter um dispositivo principal** O exemplo `get-core-device` a seguir obtém informações sobre um dispositivo principal do AWS IoT Greengrass. ``` aws greengrassv2 get-core-device \ --core-device-thing-name MyGreengrassCore ``` Resultado: ``` { "coreDeviceThingName": "MyGreengrassCore", "coreVersion": "2.0.3", "platform": "linux", "architecture": "amd64", "status": "HEALTHY", "lastStatusUpdateTimestamp": "2021-01-08T04:57:58.838000-08:00", "tags": {} } ``` Para obter mais informações, consulte [Verificar status do dispositivo principal](https://docs.aws.amazon.com/greengrass/v2/developerguide/device-status.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Para ver detalhes da API, consulte [GetCoreDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/get-core-device.html) na *Referência de comandos da AWS CLI*. ### `get-deployment` O código de exemplo a seguir mostra como usar `get-deployment`. **AWS CLI** **Obter uma implantação** O exemplo `get-deployment` a seguir obtém informações sobre a implantação do componente de núcleo do AWS IoT Greengrass em um grupo de dispositivos principais. ``` aws greengrassv2 get-deployment \ --deployment-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` Resultado: ``` { "targetArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/MyGreengrassCoreGroup", "revisionId": "14", "deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "deploymentName": "Deployment for MyGreengrassCoreGroup", "deploymentStatus": "ACTIVE", "iotJobId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "iotJobArn": "arn:aws:iot:us-west-2:123456789012:job/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "components": { "aws.greengrass.Nucleus": { "componentVersion": "2.0.3", "configurationUpdate": { "merge": "{\"jvmOptions\":\"-Xmx64m\",\"logging\":{\"level\":\"WARN\"}}", "reset": [ "/networkProxy", "/mqtt" ] } } }, "deploymentPolicies": { "failureHandlingPolicy": "ROLLBACK", "componentUpdatePolicy": { "timeoutInSeconds": 60, "action": "NOTIFY_COMPONENTS" }, "configurationValidationPolicy": { "timeoutInSeconds": 60 } }, "iotJobConfiguration": {}, "creationTimestamp": "2021-01-07T17:21:20.691000-08:00", "isLatestForTarget": false, "tags": {} } ``` Para obter mais informações, consulte [Implantar componentes em dispositivos](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-deployments.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Para ver detalhes da API, consulte [GetDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/get-deployment.html) na *Referência de comandos da AWS CLI*. ### `get-service-role-for-account` O código de exemplo a seguir mostra como usar `get-service-role-for-account`. **AWS CLI** **Obter o perfil de serviço do Greengrass para sua AWS conta** O exemplo `get-service-role-for-account` a seguir obtém o perfil de serviço associado ao AWS IoT Greengrass para sua conta da AWS. ``` aws greengrassv2 get-service-role-for-account ``` Resultado: ``` { "associatedAt": "2022-01-19T19:21:53Z", "roleArn": "arn:aws:iam::123456789012:role/service-role/Greengrass_ServiceRole" } ``` Para obter mais informações, consulte [Perfil de serviço do Greengrass](https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Para ver detalhes da API, consulte [GetServiceRoleForAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/get-service-role-for-account.html) na * Referência de comandos da AWS CLI*. ### `list-client-devices-associated-with-core-device` O código de exemplo a seguir mostra como usar `list-client-devices-associated-with-core-device`. **AWS CLI** **Listar os dispositivos-clientes associados a um dispositivo principal** O exemplo `list-client-devices-associated-with-core-device` a seguir lista todos os dispositivos-clientes associados a um dispositivo principal. ``` aws greengrassv2 list-client-devices-associated-with-core-device \ --core-device-thing-name MyTestGreengrassCore ``` Resultado: ``` { "associatedClientDevices": [ { "thingName": "MyClientDevice2", "associationTimestamp": "2021-07-12T16:33:55.843000-07:00" }, { "thingName": "MyClientDevice1", "associationTimestamp": "2021-07-12T16:33:55.843000-07:00" } ] } ``` Para obter mais informações, consulte [Interagindo com dispositivos IoT locais](https://docs.aws.amazon.com/greengrass/v2/developerguide/interact-with-local-iot-devices.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Para ver detalhes da API, consulte [ListClientDevicesAssociatedWithCoreDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/list-client-devices-associated-with-core-device.html) na *Referência de comandos da AWS CLI*. ### `list-component-versions` O código de exemplo a seguir mostra como usar `list-component-versions`. **AWS CLI** **Listar versões de um componente** O exemplo `list-component-versions` a seguir lista todas as versões de um componente do Hello World. ``` aws greengrassv2 list-component-versions \ --arn arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld ``` Resultado: ``` { "componentVersions": [ { "componentName": "com.example.HelloWorld", "componentVersion": "1.0.1", "arn": "arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.1" }, { "componentName": "com.example.HelloWorld", "componentVersion": "1.0.0", "arn": "arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0" } ] } ``` Para obter mais informações, consulte o [Gerenciar componentes](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-components.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Para ver detalhes da API, consulte [ListComponentVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/list-component-versions.html) na *Referência de comandos da AWS CLI*. ### `list-components` O código de exemplo a seguir mostra como usar `list-components`. **AWS CLI** **Listar componentes** O exemplo `list-components` a seguir lista cada componente e sua versão mais recente definida em sua conta AWS na Região atual. ``` aws greengrassv2 list-components ``` Resultado: ``` { "components": [ { "arn": "arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld", "componentName": "com.example.HelloWorld", "latestVersion": { "arn": "arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.1", "componentVersion": "1.0.1", "creationTimestamp": "2021-01-08T16:51:07.352000-08:00", "description": "My first AWS IoT Greengrass component.", "publisher": "Amazon", "platforms": [ { "attributes": { "os": "linux" } } ] } } ] } ``` Para obter mais informações, consulte o [Gerenciar componentes](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-components.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Para ver detalhes da API, consulte [ListComponents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/list-components.html) na * Referência do comando da AWS CLI*. ### `list-core-devices` O código de exemplo a seguir mostra como usar `list-core-devices`. **AWS CLI** **Listar dispositivos principais** O exemplo `list-core-devices` a seguir lista os principais dispositivos AWS IoT Greengrass em sua conta da AWS na região atual. ``` aws greengrassv2 list-core-devices ``` Resultado: ``` { "coreDevices": [ { "coreDeviceThingName": "MyGreengrassCore", "status": "HEALTHY", "lastStatusUpdateTimestamp": "2021-01-08T04:57:58.838000-08:00" } ] } ``` Para obter mais informações, consulte [Verificar status do dispositivo principal](https://docs.aws.amazon.com/greengrass/v2/developerguide/device-status.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Para ver detalhes da API, consulte [ListCoreDevices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/list-core-devices.html) na *Referência de comandos da AWS CLI*. ### `list-deployments` O código de exemplo a seguir mostra como usar `list-deployments`. **AWS CLI** **Listar implantações** O exemplo `list-deployments` a seguir lista a revisão mais recente de cada implantação definida em sua conta AWS na Região atual. ``` aws greengrassv2 list-deployments ``` Resultado: ``` { "deployments": [ { "targetArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/MyGreengrassCoreGroup", "revisionId": "14", "deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "deploymentName": "Deployment for MyGreengrassCoreGroup", "creationTimestamp": "2021-01-07T17:21:20.691000-08:00", "deploymentStatus": "ACTIVE", "isLatestForTarget": false }, { "targetArn": "arn:aws:iot:us-west-2:123456789012:thing/MyGreengrassCore", "revisionId": "1", "deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "deploymentName": "Deployment for MyGreengrassCore", "creationTimestamp": "2021-01-06T16:10:42.407000-08:00", "deploymentStatus": "COMPLETED", "isLatestForTarget": false } ] } ``` Para obter mais informações, consulte [Implantar componentes em dispositivos](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-deployments.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Para ver detalhes da API, consulte [ListDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/list-deployments.html) na *Referência de comandos da AWS CLI*. ### `list-effective-deployments` O código de exemplo a seguir mostra como usar `list-effective-deployments`. **AWS CLI** **Listar tarefas de implantação** O exemplo `list-effective-deployments` a seguir lista as implantações que se aplicam a um dispositivo principal do AWS IoT Greengrass. ``` aws greengrassv2 list-effective-deployments \ --core-device-thing-name MyGreengrassCore ``` Resultado: ``` { "effectiveDeployments": [ { "deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "deploymentName": "Deployment for MyGreengrassCore", "iotJobId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "targetArn": "arn:aws:iot:us-west-2:123456789012:thing/MyGreengrassCore", "coreDeviceExecutionStatus": "COMPLETED", "reason": "SUCCESSFUL", "creationTimestamp": "2021-01-06T16:10:42.442000-08:00", "modifiedTimestamp": "2021-01-08T17:21:27.830000-08:00" }, { "deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "deploymentName": "Deployment for MyGreengrassCoreGroup", "iotJobId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE44444", "iotJobArn": "arn:aws:iot:us-west-2:123456789012:job/a1b2c3d4-5678-90ab-cdef-EXAMPLE44444", "targetArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/MyGreengrassCoreGroup", "coreDeviceExecutionStatus": "SUCCEEDED", "reason": "SUCCESSFUL", "creationTimestamp": "2021-01-07T17:19:20.394000-08:00", "modifiedTimestamp": "2021-01-07T17:21:20.721000-08:00" } ] } ``` Para obter mais informações, consulte [Verificar status do dispositivo principal](https://docs.aws.amazon.com/greengrass/v2/developerguide/device-status.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Para ver detalhes da API, consulte [ListEffectiveDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/list-effective-deployments.html) na *Referência de comandos da AWS CLI*. ### `list-installed-components` O código de exemplo a seguir mostra como usar `list-installed-components`. **AWS CLI** **Listar os componentes instalados em um dispositivo principal** O exemplo `list-installed-components` a seguir lista os componentes instalados em um dispositivo principal do AWS IoT Greengrass. ``` aws greengrassv2 list-installed-components \ --core-device-thing-name MyGreengrassCore ``` Resultado: ``` { "installedComponents": [ { "componentName": "aws.greengrass.Cli", "componentVersion": "2.0.3", "lifecycleState": "RUNNING", "isRoot": true }, { "componentName": "aws.greengrass.Nucleus", "componentVersion": "2.0.3", "lifecycleState": "FINISHED", "isRoot": true } ] } ``` Para obter mais informações, consulte [Verificar status do dispositivo principal](https://docs.aws.amazon.com/greengrass/v2/developerguide/device-status.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Para ver detalhes da API, consulte [ListInstalledComponents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/list-installed-components.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar as tags para um recurso** O exemplo `list-tags-for-resource` a seguir lista todas as marcações de um dispositivo principal do AWS IoT Greengrass. ``` aws greengrassv2 list-tags-for-resource \ --resource-arn arn:aws:greengrass:us-west-2:123456789012:coreDevices:MyGreengrassCore ``` Resultado: ``` { "tags": { "Owner": "richard-roe" } } ``` Para obter mais informações, consulte [Marcar seus recursos](https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Adicionar uma tag a um recurso** O exemplo `tag-resource` a seguir adiciona uma marca de proprietário a um dispositivo principal do AWS IoT Greengrass. É possível usar essa marca para controlar o acesso ao dispositivo principal com base em quem o possui. ``` aws greengrassv2 tag-resource \ --resource-arn arn:aws:greengrass:us-west-2:123456789012:coreDevices:MyGreengrassCore \ --tags Owner=richard-roe ``` Este comando não produz saída. Para obter mais informações, consulte [Marcar seus recursos](https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover uma tag de um recurso** O exemplo `untag-resource` a seguir remove uma marca de proprietário de um dispositivo principal do AWS IoT Greengrass. ``` aws iotsitewise untag-resource \ --resource-arn arn:aws:greengrass:us-west-2:123456789012:coreDevices:MyGreengrassCore \ --tag-keys Owner ``` Este comando não produz saída. Para obter mais informações, consulte [Marcar seus recursos](https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-connectivity-info` O código de exemplo a seguir mostra como usar `update-connectivity-info`. **AWS CLI** **Atualizar as informações de conectividade de um dispositivo principal do Greengrass** O exemplo `update-connectivity-info` a seguir obtém informações de conectividade para um dispositivo principal do Greengrass. Os dispositivos-clientes usam essas informações para se conectar ao agente MQTT, executado nesse dispositivo principal. ``` aws greengrassv2 update-connectivity-info \ --thing-name MyGreengrassCore \ --cli-input-json file://core-device-connectivity-info.json ``` Conteúdo de `core-device-connectivity-info.json`: ``` { "connectivityInfo": [ { "hostAddress": "192.0.2.0", "portNumber": 8883, "id": "localIP_192.0.2.0" } ] } ``` Resultado: ``` { "version": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } ``` Para obter mais informações, consulte [Gerenciar endpoints de dispositivos principais](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-core-device-endpoints.html) no *Guia do Desenvolvedor do AWS IoT Greengrass V2*. + Para ver detalhes da API, consulte [UpdateConnectivityInfo](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/update-connectivity-info.html) na * Referência de comandos da AWS CLI*. # Lançamento do AWS IoT Jobs SDK Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Lançamento do AWS IoT Jobs SDK. *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 ### `describe-job-execution` O código de exemplo a seguir mostra como usar `describe-job-execution`. **AWS CLI** **Para obter os detalhes da execução do trabalho** O exemplo `describe-job-execution` a seguir recupera detalhes sobre a execução mais recente do trabalho e do item especificados. ``` aws iot-jobs-data describe-job-execution \ --job-id SampleJob \ --thing-name MotionSensor1 \ --endpoint-url https://1234567890abcd.jobs.iot.us-west-2.amazonaws.com ``` Resultado: ``` { "execution": { "approximateSecondsBeforeTimedOut": 88, "executionNumber": 2939653338, "jobId": "SampleJob", "lastUpdatedAt": 1567701875.743, "queuedAt": 1567701902.444, "status": "QUEUED", "thingName": "MotionSensor1 ", "versionNumber": 3 } } ``` Para obter mais informações, consulte [Dispositivos e Trabalhos](https://docs.aws.amazon.com/iot/latest/developerguide/jobs-devices.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DescribeJobExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot-jobs-data/describe-job-execution.html) na *Referência de comandos da AWS CLI*. ### `get-pending-job-executions` O código de exemplo a seguir mostra como usar `get-pending-job-executions`. **AWS CLI** **Para obter uma lista de todos os trabalhos que não estejam no status de terminal para um item** O exemplo `get-pending-job-executions` a seguir exibe uma lista de todos os trabalhos que não estejam em um status de terminal para o item especificado. ``` aws iot-jobs-data get-pending-job-executions \ --thing-name MotionSensor1 --endpoint-url https://1234567890abcd.jobs.iot.us-west-2.amazonaws.com ``` Resultado: ``` { "inProgressJobs": [ ], "queuedJobs": [ { "executionNumber": 2939653338, "jobId": "SampleJob", "lastUpdatedAt": 1567701875.743, "queuedAt": 1567701902.444, "versionNumber": 3 } ] } ``` Para obter mais informações, consulte [Dispositivos e Trabalhos](https://docs.aws.amazon.com/iot/latest/developerguide/jobs-devices.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [GetPendingJobExecutions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot-jobs-data/get-pending-job-executions.html) na *Referência de comandos da AWS CLI*. ### `start-next-pending-job-execution` O código de exemplo a seguir mostra como usar `start-next-pending-job-execution`. **AWS CLI** **Para obter e iniciar a próxima execução de tarefas pendentes para um item** O exemplo `start-next-pending-job-execution` a seguir recupera e inicia a próxima execução do trabalho cujo status é IN\$1PROGRESS ou QUEUED para o item especificado. ``` aws iot-jobs-data start-next-pending-job-execution \ --thing-name MotionSensor1 --endpoint-url https://1234567890abcd.jobs.iot.us-west-2.amazonaws.com ``` Resultado: ``` { "execution": { "approximateSecondsBeforeTimedOut": 88, "executionNumber": 2939653338, "jobId": "SampleJob", "lastUpdatedAt": 1567714853.743, "queuedAt": 1567701902.444, "startedAt": 1567714871.690, "status": "IN_PROGRESS", "thingName": "MotionSensor1 ", "versionNumber": 3 } } ``` Para obter mais informações, consulte [Dispositivos e Trabalhos](https://docs.aws.amazon.com/iot/latest/developerguide/jobs-devices.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [StartNextPendingJobExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot-jobs-data/start-next-pending-job-execution.html) na *Referência de comandos da AWS CLI*. ### `update-job-execution` O código de exemplo a seguir mostra como usar `update-job-execution`. **AWS CLI** **Para atualizar o status de uma execução de trabalho** O exemplo `update-job-execution` a seguir atualiza o status do trabalho e do item especificados. ``` aws iot-jobs-data update-job-execution \ --job-id SampleJob \ --thing-name MotionSensor1 \ --status REMOVED \ --endpoint-url https://1234567890abcd.jobs.iot.us-west-2.amazonaws.com ``` Resultado: ``` { "executionState": { "status": "REMOVED", "versionNumber": 3 }, } ``` Para obter mais informações, consulte [Dispositivos e Trabalhos](https://docs.aws.amazon.com/iot/latest/developerguide/jobs-devices.html) no *Guia do desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [UpdateJobExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot-jobs-data/update-job-execution.html) na *Referência de comandos da AWS CLI*. # AWS IoT SiteWise Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o AWS IoT SiteWise. *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 ### `associate-assets` O código de exemplo a seguir mostra como usar `associate-assets`. **AWS CLI** **Para associar um ativo filho a um ativo pai** O exemplo `associate-assets` a seguir associa um ativo de turbina eólica a um ativo de parque eólico, onde o modelo de ativo de turbina eólica existe como uma hierarquia no modelo de ativo de parque eólico. ``` aws iotsitewise associate-assets \ --asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE \ --hierarchy-id a1b2c3d4-5678-90ab-cdef-77777EXAMPLE \ --child-asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE ``` Este comando não produz saída. Para obter mais informações, consulte [Associação de ativos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/add-associated-assets.html) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [AssociateAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/associate-assets.html) na *Referência de comandos da AWS CLI*. ### `batch-associate-project-assets` O código de exemplo a seguir mostra como usar `batch-associate-project-assets`. **AWS CLI** **Para associar um ativo a um projeto** O exemplo `batch-associate-project-assets` a seguir associa um ativo de parque eólico a um projeto. ``` aws iotsitewise batch-associate-project-assets \ --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \ --asset-ids a1b2c3d4-5678-90ab-cdef-44444EXAMPLE ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar ativos a projetos](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/add-assets-to-projects-sd.html) no *Guia da aplicação AWS IoT SiteWise Monitor*. + Para ver detalhes da API, consulte [BatchAssociateProjectAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/batch-associate-project-assets.html) na *Referência de comandos da AWS CLI*. ### `batch-disassociate-project-assets` O código de exemplo a seguir mostra como usar `batch-disassociate-project-assets`. **AWS CLI** **Para desassociar um ativo de um projeto** O exemplo `batch-disassociate-project-assets` a seguir desassocia um ativo de parque eólico a um projeto. ``` aws iotsitewise batch-disassociate-project-assets \ --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \ --asset-ids a1b2c3d4-5678-90ab-cdef-44444EXAMPLE ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar ativos a projetos](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/add-assets-to-projects-sd.html) no *Guia da aplicação AWS IoT SiteWise Monitor*. + Para ver detalhes da API, consulte [BatchDisassociateProjectAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/batch-disassociate-project-assets.html) na *Referência de comandos da AWS CLI*. ### `batch-put-asset-property-value` O código de exemplo a seguir mostra como usar `batch-put-asset-property-value`. **AWS CLI** **Para enviar dados às propriedades do ativo** O exemplo `batch-put-asset-property-value` a seguir envia dados de potência e temperatura para as propriedades do ativo identificadas pelos aliases da propriedade. ``` aws iotsitewise batch-put-asset-property-value \ --cli-input-json file://batch-put-asset-property-value.json ``` Conteúdo de `batch-put-asset-property-value.json`: ``` { "entries": [ { "entryId": "1575691200-company-windfarm-3-turbine-7-power", "propertyAlias": "company-windfarm-3-turbine-7-power", "propertyValues": [ { "value": { "doubleValue": 4.92 }, "timestamp": { "timeInSeconds": 1575691200 }, "quality": "GOOD" } ] }, { "entryId": "1575691200-company-windfarm-3-turbine-7-temperature", "propertyAlias": "company-windfarm-3-turbine-7-temperature", "propertyValues": [ { "value": { "integerValue": 38 }, "timestamp": { "timeInSeconds": 1575691200 } } ] } ] } ``` Resultado: ``` { "errorEntries": [] } ``` Para obter mais informações, consulte [Ingerir dados usando a API do AWS IoT SiteWise](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ingest-api.html) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [BatchPutAssetPropertyValue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/batch-put-asset-property-value.html) na *Referência de comandos da AWS CLI*. ### `create-access-policy` O código de exemplo a seguir mostra como usar `create-access-policy`. **AWS CLI** **Exemplo 1: conceder a um usuário acesso administrativo a um portal** O exemplo `create-access-policy` a seguir cria uma política de acesso que concede ao usuário acesso administrativo a um portal da web para uma empresa de parques eólicos. ``` aws iotsitewise create-access-policy \ --cli-input-json file://create-portal-administrator-access-policy.json ``` Conteúdo de `create-portal-administrator-access-policy.json`: ``` { "accessPolicyIdentity": { "user": { "id": "a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE" } }, "accessPolicyPermission": "ADMINISTRATOR", "accessPolicyResource": { "portal": { "id": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE" } } } ``` Resultado: ``` { "accessPolicyId": "a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE", "accessPolicyArn": "arn:aws:iotsitewise:us-west-2:123456789012:access-policy/a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE" } ``` Para obter mais informações, consulte [Adicionar ou remover administradores de portal](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins) no *Guia do usuário do AWS IoT SiteWise*. **Exemplo 2: conceder a um usuário acesso somente de leitura a um projeto** O exemplo `create-access-policy` a seguir cria uma política de acesso que concede ao usuário acesso somente de leitura a um projeto de parque eólico. ``` aws iotsitewise create-access-policy \ --cli-input-json file://create-project-viewer-access-policy.json ``` Conteúdo de `create-project-viewer-access-policy.json`: ``` { "accessPolicyIdentity": { "user": { "id": "a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE" } }, "accessPolicyPermission": "VIEWER", "accessPolicyResource": { "project": { "id": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE" } } } ``` Resultado: ``` { "accessPolicyId": "a1b2c3d4-5678-90ab-cdef-dddddEXAMPLE", "accessPolicyArn": "arn:aws:iotsitewise:us-west-2:123456789012:access-policy/a1b2c3d4-5678-90ab-cdef-dddddEXAMPLE" } ``` Para obter mais informações, consulte [Designar visualizadores de projetos](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/assign-project-viewers.html) no *Guia da aplicação AWS IoT SiteWise Monitor*. + Para ver detalhes da API, consulte [CreateAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-access-policy.html) na *Referência de comandos da AWS CLI*. ### `create-asset-model` O código de exemplo a seguir mostra como usar `create-asset-model`. **AWS CLI** **Para criar um modelo de ativo** O exemplo `create-asset-model` a seguir cria um modelo de ativo que define uma turbina eólica com as seguintes propriedades: Número de série - O número de série de uma turbina eólica Potência gerada - O fluxo de dados da potência gerada de uma turbina eólica Temperatura C - O fluxo de dados de temperatura de uma turbina eólica em Celsius Temperatura F - Os pontos de dados de temperatura mapeados de Celsius a Fahrenheit ``` aws iotsitewise create-asset-model \ --cli-input-json file://create-wind-turbine-model.json ``` Conteúdo de `create-wind-turbine-model.json`: ``` { "assetModelName": "Wind Turbine Model", "assetModelDescription": "Represents a wind turbine", "assetModelProperties": [ { "name": "Serial Number", "dataType": "STRING", "type": { "attribute": {} } }, { "name": "Generated Power", "dataType": "DOUBLE", "unit": "kW", "type": { "measurement": {} } }, { "name": "Temperature C", "dataType": "DOUBLE", "unit": "Celsius", "type": { "measurement": {} } }, { "name": "Temperature F", "dataType": "DOUBLE", "unit": "Fahrenheit", "type": { "transform": { "expression": "temp_c * 9 / 5 + 32", "variables": [ { "name": "temp_c", "value": { "propertyId": "Temperature C" } } ] } } }, { "name": "Total Generated Power", "dataType": "DOUBLE", "unit": "kW", "type": { "metric": { "expression": "sum(power)", "variables": [ { "name": "power", "value": { "propertyId": "Generated Power" } } ], "window": { "tumbling": { "interval": "1h" } } } } } ] } ``` Resultado: ``` { "assetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "assetModelArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "assetModelStatus": { "state": "CREATING" } } ``` Para obter mais informações, consulte [Definir modelos de ativos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/define-models.html) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [CreateAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-asset-model.html) na *Referência de comandos da AWS CLI*. ### `create-asset` O código de exemplo a seguir mostra como usar `create-asset`. **AWS CLI** **Para criar um ativo** O exemplo `create-asset` a seguir cria um ativo de turbina eólica a partir de um modelo de ativo de turbina eólica. ``` aws iotsitewise create-asset \ --asset-model-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --asset-name "Wind Turbine 1" ``` Resultado: ``` { "assetId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", "assetArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", "assetStatus": { "state": "CREATING" } } ``` Para obter mais informações, consulte [Criação de ativos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-assets.html) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [CreateAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-asset.html) na *Referência de comandos da AWS CLI*. ### `create-dashboard` O código de exemplo a seguir mostra como usar `create-dashboard`. **AWS CLI** **Para criar um painel** O exemplo `create-dashboard` a seguir cria um painel com um gráfico de linhas que exibe a potência total gerada por um parque eólico. ``` aws iotsitewise create-dashboard \ --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \ --dashboard-name "Wind Farm" \ --dashboard-definition file://create-wind-farm-dashboard.json ``` Conteúdo de `create-wind-farm-dashboard.json`: ``` { "widgets": [ { "type": "monitor-line-chart", "title": "Generated Power", "x": 0, "y": 0, "height": 3, "width": 3, "metrics": [ { "label": "Power", "type": "iotsitewise", "assetId": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE", "propertyId": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE" } ] } ] } ``` Resultado: ``` { "dashboardId": "a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE", "dashboardArn": "arn:aws:iotsitewise:us-west-2:123456789012:dashboard/a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE" } ``` Para obter mais informações, consulte [Criação de painéis (CLI)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [CreateDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-dashboard.html) na *Referência de comandos da AWS CLI*. ### `create-gateway` O código de exemplo a seguir mostra como usar `create-gateway`. **AWS CLI** **Para criar um gateway** O exemplo `create-gateway` a seguir cria um gateway que é executado no AWS IoT Greengrass. ``` aws iotsitewise create-gateway \ --gateway-name ExampleCorpGateway \ --gateway-platform greengrass={groupArn=arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/a1b2c3d4-5678-90ab-cdef-1b1b1EXAMPLE} ``` Resultado: ``` { "gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE", "gatewayArn": "arn:aws:iotsitewise:us-west-2:123456789012:gateway/a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE" } ``` Para obter mais informações, consulte [Configurar um gateway](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-gateway.html) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [CreateGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-gateway.html) na *Referência de comandos da AWS CLI*. ### `create-portal` O código de exemplo a seguir mostra como usar `create-portal`. **AWS CLI** **Para criar um portal** O exemplo `create-portal` a seguir cria um portal da web para uma empresa de parques eólicos. É possível criar portais somente na mesma região em que o AWS Single Sign-On esteja habilitado. ``` aws iotsitewise create-portal \ --portal-name WindFarmPortal \ --portal-description "A portal that contains wind farm projects for Example Corp." \ --portal-contact-email support@example.com \ --role-arn arn:aws:iam::123456789012:role/service-role/MySiteWiseMonitorServiceRole ``` Resultado: ``` { "portalId": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE", "portalArn": "arn:aws:iotsitewise:us-west-2:123456789012:portal/a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE", "portalStartUrl": "https://a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE.app.iotsitewise.aws", "portalStatus": { "state": "CREATING" }, "ssoApplicationId": "ins-a1b2c3d4-EXAMPLE" } ``` Para obter mais informações, consulte [Introdução ao AWS IoT SiteWise Monitor](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-getting-started.html) no *Guia do Usuário do AWS IoT SiteWise* e [Habilitar o AWS SSO](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-getting-started.html#monitor-enable-sso) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [CreatePortal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-portal.html) na *Referência de comandos da AWS CLI*. ### `create-project` O código de exemplo a seguir mostra como usar `create-project`. **AWS CLI** **Para criar um projeto** O exemplo `create-project` a seguir cria um projeto de parque eólico. ``` aws iotsitewise create-project \ --portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE \ --project-name "Wind Farm 1" \ --project-description "Contains asset visualizations for Wind Farm #1 for Example Corp." ``` Resultado: ``` { "projectId": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE", "projectArn": "arn:aws:iotsitewise:us-west-2:123456789012:project/a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE" } ``` Para obter mais informações, consulte [Criar projetos](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/create-projects.html) no *Guia da aplicação AWS IoT SiteWise Monitor*. + Consulte detalhes da API em [CreateProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-project.html) na *Referência de comandos da AWS CLI*. ### `delete-access-policy` O código de exemplo a seguir mostra como usar `delete-access-policy`. **AWS CLI** **Para revogar o acesso de um usuário a um projeto ou portal** O exemplo `delete-access-policy` a seguir exclui uma política de acesso que concede ao usuário acesso administrativo a um portal. ``` aws iotsitewise delete-access-policy \ --access-policy-id a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar ou remover administradores de portal](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [DeleteAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-access-policy.html) na *Referência de comandos da AWS CLI*. ### `delete-asset-model` O código de exemplo a seguir mostra como usar `delete-asset-model`. **AWS CLI** **Para excluir um modelo de ativo** O exemplo `delete-asset-model` a seguir exclui um modelo de ativo de turbina eólica. ``` aws iotsitewise delete-asset-model \ --asset-model-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE ``` Resultado: ``` { "assetModelStatus": { "state": "DELETING" } } ``` Para obter mais informações, consulte [Excluir modelos de ativos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html#delete-asset-models) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [DeleteAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-asset-model.html) na *Referência de comandos da AWS CLI*. ### `delete-asset` O código de exemplo a seguir mostra como usar `delete-asset`. **AWS CLI** **Para excluir um ativo** O exemplo `delete-asset` a seguir exclui um modelo de ativo de turbina eólica. ``` aws iotsitewise delete-asset \ --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE ``` Resultado: ``` { "assetStatus": { "state": "DELETING" } } ``` Para obter mais informações, consulte [Excluir ativos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html#delete-assets) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [DeleteAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-asset.html) na *Referência de comandos da AWS CLI*. ### `delete-dashboard` O código de exemplo a seguir mostra como usar `delete-dashboard`. **AWS CLI** **Para excluir um painel** O exemplo `delete-dashboard` a seguir exclui um painel de turbina eólica. ``` aws iotsitewise delete-dashboard \ --dashboard-id a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir painéis](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/delete-dashboards.html) no *Guia da aplicação AWS IoT SiteWise Monitor*. + Para ver detalhes da API, consulte [DeleteDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-dashboard.html) na *Referência de comandos da AWS CLI*. ### `delete-gateway` O código de exemplo a seguir mostra como usar `delete-gateway`. **AWS CLI** **Para excluir um gateway** O exemplo `delete-gateway` a seguir exclui um gateway. ``` aws iotsitewise delete-gateway \ --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE ``` Este comando não produz saída. Para obter mais informações, consulte [Ingerir dados usando um gateway](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [DeleteGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-gateway.html) na *referência de comandos da AWS CLI*. ### `delete-portal` O código de exemplo a seguir mostra como usar `delete-portal`. **AWS CLI** **Para excluir um portal** O exemplo `delete-portal` a seguir exclui um portal da web para uma empresa de parques eólicos. ``` aws iotsitewise delete-portal \ --portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE ``` Resultado: ``` { "portalStatus": { "state": "DELETING" } } ``` Para obter mais informações, consulte [Excluir um portal](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-delete-portal) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [DeletePortal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-portal.html) na *Referência de comandos da AWS CLI*. ### `delete-project` O código de exemplo a seguir mostra como usar `delete-project`. **AWS CLI** **Para excluir um projeto** O exemplo `delete-project` a seguir exclui um projeto de parque eólico. ``` aws iotsitewise delete-project \ --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir projetos](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/delete-projects.html) no *Guia da aplicação AWS IoT SiteWise Monitor*. + Para ver detalhes da API, consulte [DeleteProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-project.html) na *Referência de comandos da AWS CLI*. ### `describe-access-policy` O código de exemplo a seguir mostra como usar `describe-access-policy`. **AWS CLI** **Para descrever uma política de acesso** O exemplo `describe-access-policy` a seguir descreve uma política de acesso que concede ao usuário acesso administrativo a um portal da web para uma empresa de parques eólicos. ``` aws iotsitewise describe-access-policy \ --access-policy-id a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE ``` Resultado: ``` { "accessPolicyId": "a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE", "accessPolicyArn": "arn:aws:iotsitewise:us-west-2:123456789012:access-policy/a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE", "accessPolicyIdentity": { "user": { "id": "a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE" } }, "accessPolicyResource": { "portal": { "id": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE" } }, "accessPolicyPermission": "ADMINISTRATOR", "accessPolicyCreationDate": "2020-02-20T22:35:15.552880124Z", "accessPolicyLastUpdateDate": "2020-02-20T22:35:15.552880124Z" } ``` Para obter mais informações, consulte [Adicionar ou remover administradores de portal](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [DescribeAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-access-policy.html) na *Referência de comandos da AWS CLI*. ### `describe-asset-model` O código de exemplo a seguir mostra como usar `describe-asset-model`. **AWS CLI** **Para descrever um modelo de ativo** O exemplo `describe-asset-model` a seguir descreve um modelo de ativo de parque eólico. ``` aws iotsitewise describe-asset-model \ --asset-model-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE ``` Resultado: ``` { "assetModelId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "assetModelArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "assetModelName": "Wind Farm Model", "assetModelDescription": "Represents a wind farm that comprises many wind turbines", "assetModelProperties": [ { "id": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE", "name": "Total Generated Power", "dataType": "DOUBLE", "unit": "kW", "type": { "metric": { "expression": "sum(power)", "variables": [ { "name": "power", "value": { "propertyId": "a1b2c3d4-5678-90ab-cdef-66666EXAMPLE", "hierarchyId": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE" } } ], "window": { "tumbling": { "interval": "1h" } } } } }, { "id": "a1b2c3d4-5678-90ab-cdef-88888EXAMPLE", "name": "Region", "dataType": "STRING", "type": { "attribute": { "defaultValue": " " } } } ], "assetModelHierarchies": [ { "id": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE", "name": "Wind Turbines", "childAssetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" } ], "assetModelCreationDate": 1575671284.0, "assetModelLastUpdateDate": 1575671988.0, "assetModelStatus": { "state": "ACTIVE" } } ``` Para obter mais informações, consulte [Descrever um modelo de ativo específico](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#describe-asset-model) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [DescribeAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-asset-model.html) na *Referência de comandos da AWS CLI*. ### `describe-asset-property` O código de exemplo a seguir mostra como usar `describe-asset-property`. **AWS CLI** **Para descrever uma propriedade do ativo** O exemplo `describe-asset-property` a seguir descreve a propriedade de potência total gerada de um ativo de parque eólico. ``` aws iotsitewise describe-asset-property \ --asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE \ --property-id a1b2c3d4-5678-90ab-cdef-99999EXAMPLE ``` Resultado: ``` { "assetId": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE", "assetName": "Wind Farm 1", "assetModelId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "assetProperty": { "id": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE", "name": "Total Generated Power", "notification": { "topic": "$aws/sitewise/asset-models/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE/assets/a1b2c3d4-5678-90ab-cdef-44444EXAMPLE/properties/a1b2c3d4-5678-90ab-cdef-99999EXAMPLE", "state": "DISABLED" }, "dataType": "DOUBLE", "unit": "kW", "type": { "metric": { "expression": "sum(power)", "variables": [ { "name": "power", "value": { "propertyId": "a1b2c3d4-5678-90ab-cdef-66666EXAMPLE", "hierarchyId": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE" } } ], "window": { "tumbling": { "interval": "1h" } } } } } } ``` Para obter mais informações, consulte [Descrever uma propriedade de ativo específica](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#describe-asset-property) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [DescribeAssetProperty](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-asset-property.html) na *Referência de comandos da AWS CLI*. ### `describe-asset` O código de exemplo a seguir mostra como usar `describe-asset`. **AWS CLI** **Para descrever um ativo** O exemplo `describe-asset` a seguir descreve ativo de parque eólico. ``` aws iotsitewise describe-asset \ --asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE ``` Resultado: ``` { "assetId": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE", "assetArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-44444EXAMPLE", "assetName": "Wind Farm 1", "assetModelId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "assetProperties": [ { "id": "a1b2c3d4-5678-90ab-cdef-88888EXAMPLE", "name": "Region", "dataType": "STRING" }, { "id": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE", "name": "Total Generated Power", "dataType": "DOUBLE", "unit": "kW" } ], "assetHierarchies": [ { "id": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE", "name": "Wind Turbines" } ], "assetCreationDate": 1575672453.0, "assetLastUpdateDate": 1575672453.0, "assetStatus": { "state": "ACTIVE" } } ``` Para obter mais informações, consulte [Descrever um ativo específico](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#describe-asset) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [DescribeAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-asset.html) na *Referência de comandos da AWS CLI*. ### `describe-dashboard` O código de exemplo a seguir mostra como usar `describe-dashboard`. **AWS CLI** **Para descrever um painel** O exemplo `describe-dashboard` a seguir descreve o painel do parque eólico especificado. ``` aws iotsitewise describe-dashboard \ --dashboard-id a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE ``` Resultado: ``` { "dashboardId": "a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE", "dashboardArn": "arn:aws:iotsitewise:us-west-2:123456789012:dashboard/a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE", "dashboardName": "Wind Farm", "projectId": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE", "dashboardDefinition": "{\"widgets\":[{\"type\":\"monitor-line-chart\",\"title\":\"Generated Power\",\"x\":0,\"y\":0,\"height\":3,\"width\":3,\"metrics\":[{\"label\":\"Power\",\"type\":\"iotsitewise\",\"assetId\":\"a1b2c3d4-5678-90ab-cdef-44444EXAMPLE\",\"propertyId\":\"a1b2c3d4-5678-90ab-cdef-99999EXAMPLE\"}]}]}", "dashboardCreationDate": "2020-05-01T20:32:12.228476348Z", "dashboardLastUpdateDate": "2020-05-01T20:32:12.228476348Z" } ``` Para obter mais informações, consulte [Visualizar painéis](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/view-dashboards.html) no *Guia da aplicação AWS IoT SiteWise Monitor*. + Para ver detalhes da API, consulte [DescribeDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-dashboard.html) na *Referência de comandos da AWS CLI*. ### `describe-gateway-capability-configuration` O código de exemplo a seguir mostra como usar `describe-gateway-capability-configuration`. **AWS CLI** **Para descrever uma capacidade de gateway** O exemplo `describe-gateway-capability-configuration` a seguir descreve uma capacidade de fonte OPC-UA. ``` aws iotsitewise describe-gateway-capability-configuration \ --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE \ --capability-namespace "iotsitewise:opcuacollector:1" ``` Resultado: ``` { "gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE", "capabilityNamespace": "iotsitewise:opcuacollector:1", "capabilityConfiguration": "{\"sources\":[{\"name\":\"Wind Farm #1\",\"endpoint\":{\"certificateTrust\":{\"type\":\"TrustAny\"},\"endpointUri\":\"opc.tcp://203.0.113.0:49320\",\"securityPolicy\":\"BASIC256\",\"messageSecurityMode\":\"SIGN_AND_ENCRYPT\",\"identityProvider\":{\"type\":\"Username\",\"usernameSecretArn\":\"arn:aws:secretsmanager:us-east-1:123456789012:secret:greengrass-factory1-auth-3QNDmM\"},\"nodeFilterRules\":[]},\"measurementDataStreamPrefix\":\"\"}]}", "capabilitySyncStatus": "IN_SYNC" } ``` Para obter mais informações, consulte [Configurar fontes de dados](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [DescribeGatewayCapabilityConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-gateway-capability-configuration.html) na *Referência de comandos da AWS CLI*. ### `describe-gateway` O código de exemplo a seguir mostra como usar `describe-gateway`. **AWS CLI** **Para descrever um gateway** O exemplo `describe-gateway` a seguir descreve um gateway. ``` aws iotsitewise describe-gateway \ --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE ``` Resultado: ``` { "gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE", "gatewayName": "ExampleCorpGateway", "gatewayArn": "arn:aws:iotsitewise:us-west-2:123456789012:gateway/a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE", "gatewayPlatform": { "greengrass": { "groupArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/a1b2c3d4-5678-90ab-cdef-1b1b1EXAMPLE" } }, "gatewayCapabilitySummaries": [ { "capabilityNamespace": "iotsitewise:opcuacollector:1", "capabilitySyncStatus": "IN_SYNC" } ], "creationDate": 1588369971.457, "lastUpdateDate": 1588369971.457 } ``` Para obter mais informações, consulte [Ingerir dados usando um gateway](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [DescribeGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-gateway.html) na *Referência de comandos da AWS CLI*. ### `describe-logging-options` O código de exemplo a seguir mostra como usar `describe-logging-options`. **AWS CLI** **Para recuperar as opções de log atuais do AWS IoT SiteWise** O exemplo `describe-logging-options` a seguir recupera as opções atuais de log do AWS IoT SiteWise para sua conta da AWS na região atual. ``` aws iotsitewise describe-logging-options ``` Resultado: ``` { "loggingOptions": { "level": "INFO" } } ``` Para obter mais informações, consulte [Monitorar o AWS IoT SiteWise com o Amazon CloudWatch Logs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-cloudwatch-logs.html) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [DescribeLoggingOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-logging-options.html) na *Referência de comandos da AWS CLI*. ### `describe-portal` O código de exemplo a seguir mostra como usar `describe-portal`. **AWS CLI** **Para descrever um portal** O exemplo `describe-portal` a seguir descreve um portal da web para uma empresa de parques eólicos. ``` aws iotsitewise describe-portal \ --portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE ``` Resultado: ``` { "portalId": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE", "portalArn": "arn:aws:iotsitewise:us-west-2:123456789012:portal/a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE", "portalName": "WindFarmPortal", "portalDescription": "A portal that contains wind farm projects for Example Corp.", "portalClientId": "E-a1b2c3d4e5f6_a1b2c3d4e5f6EXAMPLE", "portalStartUrl": "https://a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE.app.iotsitewise.aws", "portalContactEmail": "support@example.com", "portalStatus": { "state": "ACTIVE" }, "portalCreationDate": "2020-02-04T23:01:52.90248068Z", "portalLastUpdateDate": "2020-02-04T23:01:52.90248078Z", "roleArn": "arn:aws:iam::123456789012:role/MySiteWiseMonitorServiceRole" } ``` Para obter mais informações, consulte [Administrar portais](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [DescribePortal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-portal.html) na *Referência de comandos da AWS CLI*. ### `describe-project` O código de exemplo a seguir mostra como usar `describe-project`. **AWS CLI** **Para descrever um projeto** O exemplo `describe-project` a seguir exclui um projeto de parque eólico. ``` aws iotsitewise describe-project \ --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE ``` Resultado: ``` { "projectId": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE", "projectArn": "arn:aws:iotsitewise:us-west-2:123456789012:project/a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE", "projectName": "Wind Farm 1", "portalId": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE", "projectDescription": "Contains asset visualizations for Wind Farm #1 for Example Corp.", "projectCreationDate": "2020-02-20T21:58:43.362246001Z", "projectLastUpdateDate": "2020-02-20T21:58:43.362246095Z" } ``` Para obter mais informações, consulte [Visualizar detalhes do projeto](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/view-project-details.html) no *Guia da aplicação AWS IoT SiteWise Monitor*. + Para ver detalhes da API, consulte [DescribeProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-project.html) na *Referência de comandos da AWS CLI*. ### `disassociate-assets` O código de exemplo a seguir mostra como usar `disassociate-assets`. **AWS CLI** **Para desassociar um ativo filho de um ativo pai** O exemplo `disassociate-assets` a seguir desassocia um ativo de turbina eólica de um projeto de parque eólico. ``` aws iotsitewise disassociate-assets \ --asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE \ --hierarchy-id a1b2c3d4-5678-90ab-cdef-77777EXAMPLE \ --child-asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE ``` Este comando não produz saída. Para obter mais informações, consulte [Associação de ativos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/add-associated-assets.html) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [DisassociateAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/disassociate-assets.html) na *Referência de comandos da AWS CLI*. ### `get-asset-property-aggregates` O código de exemplo a seguir mostra como usar `get-asset-property-aggregates`. **AWS CLI** **Para recuperar a média agregada e os valores de contagem de uma propriedade do ativo** O exemplo `get-asset-property-aggregates` a seguir recupera a potência total média de um ativo de turbina eólica e a contagem de pontos de dados para um período de 1 hora. ``` aws iotsitewise get-asset-property-aggregates \ --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \ --property-id a1b2c3d4-5678-90ab-cdef-66666EXAMPLE \ --start-date 1580849400 \ --end-date 1580853000 \ --aggregate-types AVERAGE COUNT \ --resolution 1h ``` Resultado: ``` { "aggregatedValues": [ { "timestamp": 1580850000.0, "quality": "GOOD", "value": { "average": 8723.46538886233, "count": 12.0 } } ] } ``` Para obter mais informações, consulte [Consultar agregados de propriedades de ativos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates) no *Guia do Usuário do AWS IoT SiteWise*. + Consulte detalhes da API em [GetAssetPropertyAggregates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/get-asset-property-aggregates.html) na *Referência de comandos da AWS CLI*. ### `get-asset-property-value-history` O código de exemplo a seguir mostra como usar `get-asset-property-value-history`. **AWS CLI** **Para recuperar os valores históricos de uma propriedade do ativo** O exemplo `get-asset-property-value-history` a seguir recupera os valores de potência total de um ativo de turbina eólica por um período de 20 minutos. ``` aws iotsitewise get-asset-property-value-history \ --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \ --property-id a1b2c3d4-5678-90ab-cdef-66666EXAMPLE \ --start-date 1580851800 \ --end-date 1580853000 ``` Resultado: ``` { "assetPropertyValueHistory": [ { "value": { "doubleValue": 7217.787046814844 }, "timestamp": { "timeInSeconds": 1580852100, "offsetInNanos": 0 }, "quality": "GOOD" }, { "value": { "doubleValue": 6941.242811875451 }, "timestamp": { "timeInSeconds": 1580852400, "offsetInNanos": 0 }, "quality": "GOOD" }, { "value": { "doubleValue": 6976.797662266717 }, "timestamp": { "timeInSeconds": 1580852700, "offsetInNanos": 0 }, "quality": "GOOD" }, { "value": { "doubleValue": 6890.8677520453875 }, "timestamp": { "timeInSeconds": 1580853000, "offsetInNanos": 0 }, "quality": "GOOD" } ] } ``` Para obter mais informações, consulte [Consultar valores históricos de propriedades de ativos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values) no *Guia do Usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [GetAssetPropertyValueHistory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/get-asset-property-value-history.html) na *Referência de comandos da AWS CLI*. ### `get-asset-property-value` O código de exemplo a seguir mostra como usar `get-asset-property-value`. **AWS CLI** **Para recuperar o valor atual de uma propriedade do ativo** O exemplo `get-asset-property-value` a seguir recupera a potência total atual de um ativo de turbina eólica. ``` aws iotsitewise get-asset-property-value \ --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \ --property-id a1b2c3d4-5678-90ab-cdef-66666EXAMPLE ``` Resultado: ``` { "propertyValue": { "value": { "doubleValue": 6890.8677520453875 }, "timestamp": { "timeInSeconds": 1580853000, "offsetInNanos": 0 }, "quality": "GOOD" } } ``` Para obter mais informações, consulte [Consultar valores de propriedades de ativos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values) no *Guia do Usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [GetAssetPropertyValue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/get-asset-property-value.html) na *Referência de comandos da AWS CLI*. ### `list-access-policies` O código de exemplo a seguir mostra como usar `list-access-policies`. **AWS CLI** **Para listar todas as políticas de acesso** O exemplo `list-access-policies` a seguir lista todas as políticas de acesso para um usuário que é administrador do portal. ``` aws iotsitewise list-access-policies \ --identity-type USER \ --identity-id a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE ``` Resultado: ``` { "accessPolicySummaries": [ { "id": "a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE", "identity": { "user": { "id": "a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE" } }, "resource": { "portal": { "id": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE" } }, "permission": "ADMINISTRATOR" } ] } ``` Para obter mais informações, consulte [Administrar portais](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [ListAccessPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-access-policies.html) na *Referência de comandos da AWS CLI*. ### `list-asset-models` O código de exemplo a seguir mostra como usar `list-asset-models`. **AWS CLI** **Para listar todos os modelos de ativos** O exemplo `list-asset-models` a seguir lista todos os modelos de ativos definidos em sua conta da AWS na região atual. ``` aws iotsitewise list-asset-models ``` Resultado: ``` { "assetModelSummaries": [ { "id": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "arn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "name": "Wind Farm Model", "description": "Represents a wind farm that comprises many wind turbines", "creationDate": 1575671284.0, "lastUpdateDate": 1575671988.0, "status": { "state": "ACTIVE" } }, { "id": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "arn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "name": "Wind Turbine Model", "description": "Represents a wind turbine manufactured by Example Corp", "creationDate": 1575671207.0, "lastUpdateDate": 1575686273.0, "status": { "state": "ACTIVE" } } ] } ``` Para obter mais informações, consulte [Listar todos os modelos de ativos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#list-asset-models) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [ListAssetModels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-asset-models.html) na *Referência de comandos da AWS CLI*. ### `list-assets` O código de exemplo a seguir mostra como usar `list-assets`. **AWS CLI** **Exemplo 1: listar todos os ativos de nível superior** O exemplo `list-assets` a seguir lista todos os modelos de ativos com nível superior na árvore hierárquica definidos em sua conta da AWS na região atual. ``` aws iotsitewise list-assets \ --filter TOP_LEVEL ``` Resultado: ``` { "assetSummaries": [ { "id": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE", "arn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-44444EXAMPLE", "name": "Wind Farm 1", "assetModelId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "creationDate": 1575672453.0, "lastUpdateDate": 1575672453.0, "status": { "state": "ACTIVE" }, "hierarchies": [ { "id": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE", "name": "Wind Turbines" } ] } ] } ``` Para obter mais informações, consulte [Listar ativos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#list-assets) no *Guia do usuário do AWS IoT SiteWise*. **Exemplo 2: listar todos os ativos com base em um modelo de ativo** O exemplo `list-assets` a seguir lista todos os ativos baseados em um modelo de ativo definidos em sua conta da AWS na região atual. ``` aws iotsitewise list-assets \ --asset-model-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE ``` Resultado: ``` { "assetSummaries": [ { "id": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", "arn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", "name": "Wind Turbine 1", "assetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "creationDate": 1575671550.0, "lastUpdateDate": 1575686308.0, "status": { "state": "ACTIVE" }, "hierarchies": [] } ] } ``` Para obter mais informações, consulte [Listar ativos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#list-assets) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [ListAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-assets.html) na *Referência de comandos da AWS CLI*. ### `list-associated-assets` O código de exemplo a seguir mostra como usar `list-associated-assets`. **AWS CLI** **Para listar todos os ativos associados a um ativo em uma hierarquia específica** O exemplo `list-associated-assets` a seguir lista todos os ativos da turbina eólica associados ao ativo do parque eólico especificado. ``` aws iotsitewise list-associated-assets \ --asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE \ --hierarchy-id a1b2c3d4-5678-90ab-cdef-77777EXAMPLE ``` Resultado: ``` { "assetSummaries": [ { "id": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", "arn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", "name": "Wind Turbine 1", "assetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "creationDate": 1575671550.0, "lastUpdateDate": 1575686308.0, "status": { "state": "ACTIVE" }, "hierarchies": [] } ] } ``` Para obter mais informações, consulte [Listar ativos associados a um ativo específico](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#list-associated-assets) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [ListAssociatedAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-associated-assets.html) na *Referência de comandos da AWS CLI*. ### `list-dashboards` O código de exemplo a seguir mostra como usar `list-dashboards`. **AWS CLI** **Para listar todos os painéis em um projeto** O exemplo `list-dashboards` a seguir lista todos os painéis definidos em um projeto. ``` aws iotsitewise list-dashboards \ --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE ``` Resultado: ``` { "dashboardSummaries": [ { "id": "a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE", "name": "Wind Farm", "creationDate": "2020-05-01T20:32:12.228476348Z", "lastUpdateDate": "2020-05-01T20:32:12.228476348Z" } ] } ``` Para obter mais informações, consulte [Visualizar painéis](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/view-dashboards.html) no *Guia da aplicação AWS IoT SiteWise Monitor*. + Para ver detalhes da API, consulte [ListDashboards](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-dashboards.html) na *Referência de comandos da AWS CLI*. ### `list-gateways` O código de exemplo a seguir mostra como usar `list-gateways`. **AWS CLI** **Para listar todos os gateways** O exemplo `list-gateways` a seguir lista todos os gateways definidos em sua conta da AWS na região atual. ``` aws iotsitewise list-gateways ``` Resultado: ``` { "gatewaySummaries": [ { "gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE", "gatewayName": "ExampleCorpGateway", "gatewayCapabilitySummaries": [ { "capabilityNamespace": "iotsitewise:opcuacollector:1", "capabilitySyncStatus": "IN_SYNC" } ], "creationDate": 1588369971.457, "lastUpdateDate": 1588369971.457 } ] } ``` Para obter mais informações, consulte [Ingerir dados usando um gateway](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [ListGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-gateways.html) na *Referência de comandos da AWS CLI*. ### `list-portals` O código de exemplo a seguir mostra como usar `list-portals`. **AWS CLI** **Para listar todos os portais** O exemplo `list-portals` a seguir lista todos os portais definidos em sua conta da AWS na região atual. ``` aws iotsitewise list-portals ``` Resultado: ``` { "portalSummaries": [ { "id": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE", "name": "WindFarmPortal", "description": "A portal that contains wind farm projects for Example Corp.", "startUrl": "https://a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE.app.iotsitewise.aws", "creationDate": "2020-02-04T23:01:52.90248068Z", "lastUpdateDate": "2020-02-04T23:01:52.90248078Z", "roleArn": "arn:aws:iam::123456789012:role/service-role/MySiteWiseMonitorServiceRole" } ] } ``` Para obter mais informações, consulte [Administrar portais](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [ListPortals](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-portals.html) na *Referência de comandos da AWS CLI*. ### `list-project-assets` O código de exemplo a seguir mostra como usar `list-project-assets`. **AWS CLI** **Para listar todos os ativos associados a um projeto** O exemplo `list-project-assets` a seguir lista todos os ativos associados a um projeto de parque eólico. ``` aws iotsitewise list-projects \ --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE ``` Resultado: ``` { "assetIds": [ "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE" ] } ``` Para obter mais informações, consulte [Adicionar ativos a projetos](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/add-assets-to-projects-sd.html) no *Guia da aplicação AWS IoT SiteWise Monitor*. + Para ver detalhes da API, consulte [ListProjectAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-project-assets.html) na *Referência de comandos da AWS CLI*. ### `list-projects` O código de exemplo a seguir mostra como usar `list-projects`. **AWS CLI** **Para listar todos os projetos em um portal** O exemplo `list-projects` a seguir lista todos os projetos definidos em um portal. ``` aws iotsitewise list-projects \ --portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE ``` Resultado: ``` { "projectSummaries": [ { "id": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE", "name": "Wind Farm 1", "description": "Contains asset visualizations for Wind Farm #1 for Example Corp.", "creationDate": "2020-02-20T21:58:43.362246001Z", "lastUpdateDate": "2020-02-20T21:58:43.362246095Z" } ] } ``` Para obter mais informações, consulte [Visualizar detalhes do projeto](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/view-project-details.html) no *Guia da aplicação AWS IoT SiteWise Monitor*. + Para ver detalhes da API, consulte [ListProjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-projects.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar todas as tags de um recurso** O exemplo `list-tags-for-resource` a seguir lista todas as tags de um ativo de turbina eólica. ``` aws iotsitewise list-tags-for-resource \ --resource-arn arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE ``` Resultado: ``` { "tags": { "Owner": "richard-roe" } } ``` Para obter mais informações, consulte [Adicionar tags a recursos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html), no *Guia do usuário do AWS IoT SiteWise*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `put-logging-options` O código de exemplo a seguir mostra como usar `put-logging-options`. **AWS CLI** **Para especificar o nível de log** O exemplo `put-logging-options` a seguir permite o log de nível `INFO` no AWS IoT SiteWise. Outros níveis incluem `DEBUG` e `OFF`. ``` aws iotsitewise put-logging-options \ --logging-options level=INFO ``` Este comando não produz saída. Para obter mais informações, consulte [Monitorar o AWS IoT SiteWise com o Amazon CloudWatch Logs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-cloudwatch-logs.html) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [PutLoggingOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/put-logging-options.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Adicionar uma tag a um recurso** O exemplo `tag-resource` a seguir adiciona uma tag de proprietário a um ativo de turbina eólica. Isso permite o controle do acesso ao ativo com base em quem o possui. ``` aws iotsitewise tag-resource \ --resource-arn arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \ --tags Owner=richard-roe ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar tags a recursos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html), no *Guia do usuário do AWS IoT SiteWise*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover uma tag de um recurso** O exemplo `untag-resource` a seguir remove uma tag de proprietário de um ativo de turbina eólica. ``` aws iotsitewise untag-resource \ --resource-arn arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \ --tag-keys Owner ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar tags a recursos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html), no *Guia do usuário do AWS IoT SiteWise*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-access-policy` O código de exemplo a seguir mostra como usar `update-access-policy`. **AWS CLI** **Para designar um visualizador do projeto como proprietário** O exemplo `update-access-policy` a seguir atualiza uma política de acesso que concede ao visualizador do projeto a propriedade de um projeto. ``` aws iotsitewise update-access-policy \ --access-policy-id a1b2c3d4-5678-90ab-cdef-dddddEXAMPLE \ --cli-input-json file://update-project-viewer-access-policy.json ``` Conteúdo de `update-project-viewer-access-policy.json`: ``` { "accessPolicyIdentity": { "user": { "id": "a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE" } }, "accessPolicyPermission": "ADMINISTRATOR", "accessPolicyResource": { "project": { "id": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE" } } } ``` Este comando não produz saída. Para obter mais informações, consulte [Designar proprietários de projetos](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/assign-project-owners.html) no *Guia da aplicação AWS IoT SiteWise Monitor*. + Para ver detalhes da API, consulte [UpdateAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-access-policy.html) na *Referência de comandos da AWS CLI*. ### `update-asset-model` O código de exemplo a seguir mostra como usar `update-asset-model`. **AWS CLI** **Para atualizar um modelo de ativo** O exemplo `update-asset-model` a seguir atualiza a descrição de um modelo de ativo de parque eólico. Esse exemplo inclui os IDs e as definições existentes do modelo, pois `update-asset-model` substitui o modelo existente pelo novo modelo. ``` aws iotsitewise update-asset-model \ --cli-input-json file://update-wind-farm-model.json ``` Conteúdo de `update-wind-farm-model.json`: ``` { "assetModelName": "Wind Farm Model", "assetModelDescription": "Represents a wind farm that comprises many wind turbines", "assetModelProperties": [ { "id": "a1b2c3d4-5678-90ab-cdef-88888EXAMPLE", "name": "Region", "dataType": "STRING", "type": { "attribute": {} } }, { "id": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE", "name": "Total Generated Power", "dataType": "DOUBLE", "unit": "kW", "type": { "metric": { "expression": "sum(power)", "variables": [ { "name": "power", "value": { "hierarchyId": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE", "propertyId": "a1b2c3d4-5678-90ab-cdef-66666EXAMPLE" } } ], "window": { "tumbling": { "interval": "1h" } } } } } ], "assetModelHierarchies": [ { "id": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE", "name": "Wind Turbines", "childAssetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" } ] } ``` Resultado: ``` { "assetModelId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "assetModelArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "assetModelStatus": { "state": "CREATING" } } ``` Para obter mais informações, consulte [Atualizar modelos de ativos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html#update-asset-models) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [UpdateAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-asset-model.html) na *Referência de comandos da AWS CLI*. ### `update-asset-property` O código de exemplo a seguir mostra como usar `update-asset-property`. **AWS CLI** **Exemplo 1: atualizar o alias de uma propriedade do ativo** O exemplo `update-asset-property` a seguir atualiza o alias da propriedade de potência de um ativo de turbina eólica. ``` aws iotsitewise update-asset-property \ --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \ --property-id a1b2c3d4-5678-90ab-cdef-55555EXAMPLE \ --property-alias "/examplecorp/windfarm/1/turbine/1/power" \ --property-notification-state DISABLED ``` Este comando não produz saída. Para obter mais informações, consulte [Mapear fluxos de dados industriais para propriedades de ativos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) no *Guia do usuário do AWS IoT SiteWise*. **Exemplo 2: habilitar notificações de propriedade de ativos** O exemplo `update-asset-property` a seguir habilita notificações de atualização de propriedades de ativos para a propriedade de potência de um ativo de turbina eólica. As atualizações do valor da propriedade são publicadas no tópico MQTT `$aws/sitewise/asset-models//assets//properties/`, onde cada ID é substituído pela propriedade, ativo e ID do modelo da propriedade do ativo. ``` aws iotsitewise update-asset-property \ --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \ --property-id a1b2c3d4-5678-90ab-cdef-66666EXAMPLE \ --property-notification-state ENABLED \ --property-alias "/examplecorp/windfarm/1/turbine/1/power" ``` Este comando não produz saída. Para obter mais informações, consulte [Interagir com outros serviços](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [UpdateAssetProperty](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-asset-property.html) na *Referência de comandos da AWS CLI*. ### `update-asset` O código de exemplo a seguir mostra como usar `update-asset`. **AWS CLI** **Para atualizar o nome de um ativo** O exemplo `update-asset` a seguir atualiza o nome de um ativo de turbina eólica. ``` aws iotsitewise update-asset \ --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \ --asset-name "Wind Turbine 2" ``` Resultado: ``` { "assetStatus": { "state": "UPDATING" } } ``` Para obter mais informações, consulte [Atualizar ativos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html#update-assets) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [UpdateAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-asset.html) na *Referência de comandos da AWS CLI*. ### `update-dashboard` O código de exemplo a seguir mostra como usar `update-dashboard`. **AWS CLI** **Para atualizar um painel** O exemplo `update-dashboard` a seguir altera o título de um gráfico de linhas de um painel que exibe a potência total gerada por um parque eólico. ``` aws iotsitewise update-dashboard \ --project-id a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE \ --dashboard-name "Wind Farm" \ --dashboard-definition file://update-wind-farm-dashboard.json ``` Conteúdo de `update-wind-farm-dashboard.json`: ``` { "widgets": [ { "type": "monitor-line-chart", "title": "Total Generated Power", "x": 0, "y": 0, "height": 3, "width": 3, "metrics": [ { "label": "Power", "type": "iotsitewise", "assetId": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE", "propertyId": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE" } ] } ] } ``` Este comando não produz saída. Para obter mais informações, consulte [Criação de painéis (CLI)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [UpdateDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-dashboard.html) na *Referência de comandos da AWS CLI*. ### `update-gateway-capability-configuration` O código de exemplo a seguir mostra como usar `update-gateway-capability-configuration`. **AWS CLI** **Para atualizar uma capacidade de gateway** O seguinte exemplo de `update-gateway-capability-configuration` configura uma fonte OPC-UA com as seguintes propriedades: Confia em qualquer certificado. Usa o algoritmo Basic256 para proteger mensagens. Usa o modo SignAndEncrypt para proteger conexões. Usa credenciais de autenticação armazenadas em um segredo do AWS Secrets Manager. ``` aws iotsitewise update-gateway-capability-configuration \ --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE \ --capability-namespace "iotsitewise:opcuacollector:1" \ --capability-configuration file://opc-ua-capability-configuration.json ``` Conteúdo de `opc-ua-capability-configuration.json`: ``` { "sources": [ { "name": "Wind Farm #1", "endpoint": { "certificateTrust": { "type": "TrustAny" }, "endpointUri": "opc.tcp://203.0.113.0:49320", "securityPolicy": "BASIC256", "messageSecurityMode": "SIGN_AND_ENCRYPT", "identityProvider": { "type": "Username", "usernameSecretArn": "arn:aws:secretsmanager:us-west-2:123456789012:secret:greengrass-windfarm1-auth-1ABCDE" }, "nodeFilterRules": [] }, "measurementDataStreamPrefix": "" } ] } ``` Resultado: ``` { "capabilityNamespace": "iotsitewise:opcuacollector:1", "capabilitySyncStatus": "OUT_OF_SYNC" } ``` Para obter mais informações, consulte [Configurar fontes de dados](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [UpdateGatewayCapabilityConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-gateway-capability-configuration.html) na *Referência de comandos da AWS CLI*. ### `update-gateway` O código de exemplo a seguir mostra como usar `update-gateway`. **AWS CLI** **Para atualizar o nome de um gateway** O exemplo `update-gateway` a seguir atualiza o nome de um gateway. ``` aws iotsitewise update-gateway \ --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE \ --gateway-name ExampleCorpGateway1 ``` Este comando não produz saída. Para obter mais informações, consulte [Ingerir dados usando um gateway](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [UpdateGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-gateway.html) na *Referência de comandos da AWS CLI*. ### `update-portal` O código de exemplo a seguir mostra como usar `update-portal`. **AWS CLI** **Para atualizar os detalhes de um portal** O exemplo `update-portal` a seguir atualiza um portal da web de uma empresa de parques eólicos. ``` aws iotsitewise update-portal \ --portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE \ --portal-name WindFarmPortal \ --portal-description "A portal that contains wind farm projects for Example Corp." \ --portal-contact-email support@example.com \ --role-arn arn:aws:iam::123456789012:role/MySiteWiseMonitorServiceRole ``` Resultado: ``` { "portalStatus": { "state": "UPDATING" } } ``` Para obter mais informações, consulte [Administrar portais](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html) no *Guia do usuário do AWS IoT SiteWise*. + Para ver detalhes da API, consulte [UpdatePortal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-portal.html) na *Referência de comandos da AWS CLI*. ### `update-project` O código de exemplo a seguir mostra como usar `update-project`. **AWS CLI** **Para atualizar os detalhes de um projeto** O exemplo `update-project` a seguir atualiza um projeto de parque eólico. ``` aws iotsitewise update-project \ --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \ --project-name "Wind Farm 1" \ --project-description "Contains asset visualizations for Wind Farm #1 for Example Corp." ``` Este comando não produz saída. Para obter mais informações, consulte [Alterar detalhes do projeto](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/edit-project-details.html) no *Guia da aplicação AWS IoT SiteWise Monitor*. + Para ver detalhes da API, consulte [UpdateProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-project.html) na *Referência de comandos da AWS CLI*. # AWS IoT Things Graph Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o AWS IoT Things Graph. *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 ### `associate-entity-to-thing` O código de exemplo a seguir mostra como usar `associate-entity-to-thing`. **AWS CLI** **Como associar um item a um dispositivo** O exemplo `associate-entity-to-thing` a seguir associa um item a um dispositivo. O exemplo usa um dispositivo de sensor de movimento que está no namespace público. ``` aws iotthingsgraph associate-entity-to-thing \ --thing-name "MotionSensorName" \ --entity-id "urn:tdm:aws/examples:Device:HCSR501MotionSensor" ``` Este comando não produz saída. Para obter mais informações, consulte [Criar e fazer upload de modelos](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-models-gs.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [AssociateEntityToThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/associate-entity-to-thing.html) na *Referência de comandos da AWS CLI*. ### `create-flow-template` O código de exemplo a seguir mostra como usar `create-flow-template`. **AWS CLI** **Para criar um fluxo** O exemplo `create-flow-template` a seguir cria um fluxo (fluxo de trabalho). O valor de `MyFlowDefinition` é o GraphQL que modela o fluxo. ``` aws iotthingsgraph create-flow-template \ --definition language=GRAPHQL,text="MyFlowDefinition" ``` Resultado: ``` { "summary": { "createdAt": 1559248067.545, "id": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow", "revisionNumber": 1 } } ``` Para obter mais informações, consulte [Trabalhar com fluxos](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-workflows.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [CreateFlowTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/create-flow-template.html) na *Referência de comandos da AWS CLI*. ### `create-system-instance` O código de exemplo a seguir mostra como usar `create-system-instance`. **AWS CLI** **Para criar uma instância de sistema** O exemplo `create-system-instance` a seguir cria uma instância de sistema. O valor de `MySystemInstanceDefinition` é o GraphQL que modela a instância do sistema. ``` aws iotthingsgraph create-system-instance -\ -definition language=GRAPHQL,text="MySystemInstanceDefinition" \ --target CLOUD \ --flow-actions-role-arn myRoleARN ``` Resultado: ``` { "summary": { "id": "urn:tdm:us-west-2/123456789012/default:Deployment:Room218", "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218", "status": "NOT_DEPLOYED", "target": "CLOUD", "createdAt": 1559249315.208, "updatedAt": 1559249315.208 } } ``` Para obter mais informações, consulte [Trabalhar com sistemas e configurações de fluxo](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-sysdeploy.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [CreateSystemInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/create-system-instance.html) na *Referência de comandos da AWS CLI*. ### `create-system-template` O código de exemplo a seguir mostra como usar `create-system-template`. **AWS CLI** **Para criar um sistema** O exemplo `create-system-template` a seguir cria um sistema. O valor de MySystemDefinition é o GraphQL que modela o sistema. ``` aws iotthingsgraph create-system-template \ --definition language=GRAPHQL,text="MySystemDefinition" ``` Resultado: ``` { "summary": { "createdAt": 1559249776.254, "id": "urn:tdm:us-west-2/123456789012/default:System:MySystem", "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:System/default/MySystem", "revisionNumber": 1 } } ``` Para obter mais informações, consulte [Criar sistemas](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-sysdeploy-systems.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [CreateSystemTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/create-system-template.html) na *Referência de comandos da AWS CLI*. ### `delete-flow-template` O código de exemplo a seguir mostra como usar `delete-flow-template`. **AWS CLI** **Para excluir um fluxo** O exemplo `delete-flow-template` a seguir cria um fluxo (fluxo de trabalho). ``` aws iotthingsgraph delete-flow-template \ --id "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow" ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar o ciclo de vida de entidades, fluxos, sistemas e implantações do AWS IoT Things Graph](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-lifecycle.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [DeleteFlowTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/delete-flow-template.html) na *Referência de comandos da AWS CLI*. ### `delete-namespace` O código de exemplo a seguir mostra como usar `delete-namespace`. **AWS CLI** **Para excluir um namespace** O exemplo `delete-namespace` a seguir exclui um namespace. ``` aws iotthingsgraph delete-namespace ``` Resultado: ``` { "namespaceArn": "arn:aws:iotthingsgraph:us-west-2:123456789012", "namespaceName": "us-west-2/123456789012/default" } ``` Para obter mais informações, consulte [Gerenciar o ciclo de vida de entidades, fluxos, sistemas e implantações do AWS IoT Things Graph](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-lifecycle.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [DeleteNamespace](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/delete-namespace.html) na *Referência de comandos da AWS CLI*. ### `delete-system-instance` O código de exemplo a seguir mostra como usar `delete-system-instance`. **AWS CLI** **Para excluir uma instância de sistema** O exemplo `delete-system-instance` a seguir exclui uma instância de sistema. ``` aws iotthingsgraph delete-system-instance \ --id "urn:tdm:us-west-2/123456789012/default:Deployment:Room218" ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar o ciclo de vida de entidades, fluxos, sistemas e implantações do AWS IoT Things Graph](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-lifecycle.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [DeleteSystemInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/delete-system-instance.html) na *Referência de comandos da AWS CLI*. ### `delete-system-template` O código de exemplo a seguir mostra como usar `delete-system-template`. **AWS CLI** **Para excluir um sistema** O exemplo `delete-system-template` a seguir exclui um sistema. ``` aws iotthingsgraph delete-system-template \ --id "urn:tdm:us-west-2/123456789012/default:System:MySystem" ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar o ciclo de vida de entidades, fluxos, sistemas e implantações do AWS IoT Things Graph](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-lifecycle.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [DeleteSystemTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/delete-system-template.html) na *Referência de comandos da AWS CLI*. ### `deploy-system-instance` O código de exemplo a seguir mostra como usar `deploy-system-instance`. **AWS CLI** **Para implementar uma instância de sistema** O exemplo `delete-system-template` a seguir implementa uma instância de sistema. ``` aws iotthingsgraph deploy-system-instance \ --id "urn:tdm:us-west-2/123456789012/default:Deployment:Room218" ``` Resultado: ``` { "summary": { "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment:Room218", "createdAt": 1559249776.254, "id": "urn:tdm:us-west-2/123456789012/default:Deployment:Room218", "status": "DEPLOYED_IN_TARGET", "target": "CLOUD", "updatedAt": 1559249776.254 } } ``` Para obter mais informações, consulte [Trabalhar com sistemas e configurações de fluxo](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-sysdeploy.html) no *Guia do usuário do AWS IoT Things Graph*. + Para obter detalhes sobre a API, consulte [DeploySystemInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/deploy-system-instance.html) na *Referência de comandos da AWS CLI*. ### `deprecate-flow-template` O código de exemplo a seguir mostra como usar `deprecate-flow-template`. **AWS CLI** **Como descontinuar um fluxo** O exemplo `deprecate-flow-template` a seguir descontinua um fluxo (fluxo de trabalho). ``` aws iotthingsgraph deprecate-flow-template \ --id "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow" ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar o ciclo de vida de entidades, fluxos, sistemas e implantações do AWS IoT Things Graph](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-lifecycle.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [DeprecateFlowTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/deprecate-flow-template.html) na *Referência de comandos da AWS CLI*. ### `deprecate-system-template` O código de exemplo a seguir mostra como usar `deprecate-system-template`. **AWS CLI** **Para descontinuar um sistema** O exemplo `deprecate-system-template` a seguir descontinua um sistema. ``` aws iotthingsgraph deprecate-system-template \ --id "urn:tdm:us-west-2/123456789012/default:System:MySystem" ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar o ciclo de vida de entidades, fluxos, sistemas e implantações do AWS IoT Things Graph](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-lifecycle.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [DeprecateSystemTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/deprecate-system-template.html) na *Referência de comandos da AWS CLI*. ### `describe-namespace` O código de exemplo a seguir mostra como usar `describe-namespace`. **AWS CLI** **Para obter uma descrição do namespace** O exemplo `describe-namespace` a seguir obtém uma descrição do namespace. ``` aws iotthingsgraph describe-namespace ``` Resultado: ``` { "namespaceName": "us-west-2/123456789012/default", "trackingNamespaceName": "aws", "trackingNamespaceVersion": 1, "namespaceVersion": 5 } ``` Para obter mais informações, consulte [Namespaces](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-whatis-namespace.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [DescribeNamespace](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/describe-namespace.html) na *Referência de comandos da AWS CLI*. ### `dissociate-entity-from-thing` O código de exemplo a seguir mostra como usar `dissociate-entity-from-thing`. **AWS CLI** **Para desassociar um item de um dispositivo** O exemplo `dissociate-entity-from-thing` a seguir desassocia um item de um dispositivo. ``` aws iotthingsgraph dissociate-entity-from-thing \ --thing-name "MotionSensorName" \ --entity-type "DEVICE" ``` Este comando não produz saída. Para obter mais informações, consulte [Criar e fazer upload de modelos](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-models-gs.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [DissociateEntityFromThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/dissociate-entity-from-thing.html) na *Referência de comandos da AWS CLI*. ### `get-entities` O código de exemplo a seguir mostra como usar `get-entities`. **AWS CLI** **Para obter definições para entidades** O exemplo `get-entities` a seguir obtém uma definição para um modelo de dispositivo. ``` aws iotthingsgraph get-entities \ --ids "urn:tdm:aws/examples:DeviceModel:MotionSensor" ``` Resultado: ``` { "descriptions": [ { "id": "urn:tdm:aws/examples:DeviceModel:MotionSensor", "type": "DEVICE_MODEL", "createdAt": 1559256190.599, "definition": { "language": "GRAPHQL", "text": "##\n# Specification of motion sensor devices interface.\n##\ntype MotionSensor @deviceModel(id: \"urn:tdm:aws/examples:deviceModel:MotionSensor\",\n capability: \"urn:tdm:aws/examples:capability:MotionSensorCapability\") {ignore:void}" } } ] } ``` Para obter mais informações, consulte [Criar e fazer upload de modelos](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-models-gs.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [GetEntities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/get-entities.html) na *Referência de comandos da AWS CLI*. ### `get-flow-template-revisions` O código de exemplo a seguir mostra como usar `get-flow-template-revisions`. **AWS CLI** **Para obter informações de revisão sobre um fluxo** O exemplo `get-flow-template-revisions` a seguir obtém informações de revisão sobre um fluxo (fluxo de trabalho). ``` aws iotthingsgraph get-flow-template-revisions \ --id urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow ``` Resultado: ``` { "summaries": [ { "id": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow", "revisionNumber": 1, "createdAt": 1559247540.292 } ] } ``` Para obter mais informações, consulte [Trabalhar com fluxos](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-workflows.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [GetFlowTemplateRevisions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/get-flow-template-revisions.html) na *Referência de comandos da AWS CLI*. ### `get-flow-template` O código de exemplo a seguir mostra como usar `get-flow-template`. **AWS CLI** **Para criar uma definição de fluxo** O exemplo `get-flow-template` a seguir obtém uma definição para um fluxo (fluxo de trabalho). ``` aws iotthingsgraph get-flow-template \ --id "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow" ``` Resultado: ``` { "description": { "summary": { "id": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow", "revisionNumber": 1, "createdAt": 1559247540.292 }, "definition": { "language": "GRAPHQL", "text": "{\nquery MyFlow($camera: string!, $screen: string!) @workflowType(id: \"urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow\") @annotation(type: \"tgc:FlowEvent\", id: \"sledged790c1b2bcd949e09da0c9bfc077f79d\", x: 1586, y: 653) @triggers(definition: \"{MotionSensor(description: \\\"\\\") @position(x: 1045, y: 635.6666564941406) {\\n condition(expr: \\\"devices[name == \\\\\\\"motionSensor\\\\\\\"].events[name == \\\\\\\"StateChanged\\\\\\\"].lastEvent\\\")\\n action(expr: \\\"\\\")\\n}}\") {\n variables {\n cameraResult @property(id: \"urn:tdm:aws/examples:property:CameraStateProperty\")\n }\n steps {\n step(name: \"Camera\", outEvent: [\"sledged790c1b2bcd949e09da0c9bfc077f79d\"]) @position(x: 1377, y: 638.6666564941406) {\n DeviceActivity(deviceModel: \"urn:tdm:aws/examples:deviceModel:Camera\", out: \"cameraResult\", deviceId: \"${camera}\") {\n capture\n }\n }\n step(name: \"Screen\", inEvent: [\"sledged790c1b2bcd949e09da0c9bfc077f79d\"]) @position(x: 1675.6666870117188, y: 637.9999847412109) {\n DeviceActivity(deviceModel: \"urn:tdm:aws/examples:deviceModel:Screen\", deviceId: \"${screen}\") {\n display(imageUrl: \"${cameraResult.lastClickedImage}\")\n }\n }\n }\n}\n}" }, "validatedNamespaceVersion": 5 } } ``` Para obter mais informações, consulte [Trabalhar com fluxos](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-workflows.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [GetFlowTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/get-flow-template.html) na *Referência de comandos da AWS CLI*. ### `get-namespace-deletion-status` O código de exemplo a seguir mostra como usar `get-namespace-deletion-status`. **AWS CLI** **Para obter o status da tarefa de exclusão do namespace** O exemplo `get-namespace-deletion-status` a seguir obtém o status da tarefa de exclusão do namespace. ``` aws iotthingsgraph get-namespace-deletion-status ``` Resultado: ``` { "namespaceArn": "arn:aws:iotthingsgraph:us-west-2:123456789012", "namespaceName": "us-west-2/123456789012/default" "status": "SUCCEEDED " } ``` Para obter mais informações, consulte [Namespaces](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-whatis-namespace.html) no *Guia do usuário do AWS IoT Things Graph*. + Consulte detalhes da API em [GetNamespaceDeletionStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/get-namespace-deletion-status.html) na *Referência de comandos da AWS CLI*. ### `get-system-instance` O código de exemplo a seguir mostra como usar `get-system-instance`. **AWS CLI** **Para obter uma instância de sistema** O exemplo `get-system-instance` a seguir obtém uma definição para uma instância do sistema. ``` aws iotthingsgraph get-system-instance \ --id "urn:tdm:us-west-2/123456789012/default:Deployment:Room218" ``` Resultado: ``` { "description": { "summary": { "id": "urn:tdm:us-west-2/123456789012/default:Deployment:Room218", "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218", "status": "NOT_DEPLOYED", "target": "CLOUD", "createdAt": 1559249315.208, "updatedAt": 1559249315.208 }, "definition": { "language": "GRAPHQL", "text": "{\r\nquery Room218 @deployment(id: \"urn:tdm:us-west-2/123456789012/default:Deployment:Room218\", systemId: \"urn:tdm:us-west-2/123456789012/default:System:SecurityFlow\") {\r\n motionSensor(deviceId: \"MotionSensorName\")\r\n screen(deviceId: \"ScreenName\")\r\n camera(deviceId: \"CameraName\") \r\n triggers {MotionEventTrigger(description: \"a trigger\") { \r\n condition(expr: \"devices[name == 'motionSensor'].events[name == 'StateChanged'].lastEvent\") \r\n action(expr: \"ThingsGraph.startFlow('SecurityFlow', bindings[name == 'camera'].deviceId, bindings[name == 'screen'].deviceId)\")\r\n }\r\n }\r\n }\r\n }" }, "metricsConfiguration": { "cloudMetricEnabled": false }, "validatedNamespaceVersion": 5, "flowActionsRoleArn": "arn:aws:iam::123456789012:role/ThingsGraphRole" } } ``` Para obter mais informações, consulte [Trabalhar com sistemas e configurações de fluxo](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-sysdeploy.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [GetSystemInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/get-system-instance.html) na *Referência de comandos da AWS CLI*. ### `get-system-template-revisions` O código de exemplo a seguir mostra como usar `get-system-template-revisions`. **AWS CLI** **Para obter informações de revisão sobre um sistema** O exemplo `get-system-template-revisions` a seguir obtém informações de revisão sobre um sistema. ``` aws iotthingsgraph get-system-template-revisions \ --id "urn:tdm:us-west-2/123456789012/default:System:MySystem" ``` Resultado: ``` { "summaries": [ { "id": "urn:tdm:us-west-2/123456789012/default:System:MySystem", "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:System/default/MySystem", "revisionNumber": 1, "createdAt": 1559247540.656 } ] } ``` Para obter mais informações, consulte [Trabalhar com sistemas e configurações de fluxo](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-sysdeploy.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [GetSystemTemplateRevisions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/get-system-template-revisions.html) na *Referência de comandos da AWS CLI*. ### `get-system-template` O código de exemplo a seguir mostra como usar `get-system-template`. **AWS CLI** **Para obter um sistema** O exemplo `get-system-template` a seguir obtém uma definição para um sistema. ``` aws iotthingsgraph get-system-template \ --id "urn:tdm:us-west-2/123456789012/default:System:MySystem" ``` Resultado: ``` { "description": { "summary": { "id": "urn:tdm:us-west-2/123456789012/default:System:MySystem", "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:System/default/MyFlow", "revisionNumber": 1, "createdAt": 1559247540.656 }, "definition": { "language": "GRAPHQL", "text": "{\ntype MySystem @systemType(id: \"urn:tdm:us-west-2/123456789012/default:System:MySystem\", description: \"\") {\n camera: Camera @thing(id: \"urn:tdm:aws/examples:deviceModel:Camera\")\n screen: Screen @thing(id: \"urn:tdm:aws/examples:deviceModel:Screen\")\n motionSensor: MotionSensor @thing(id: \"urn:tdm:aws/examples:deviceModel:MotionSensor\")\n MyFlow: MyFlow @workflow(id: \"urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow\")\n}\n}" }, "validatedNamespaceVersion": 5 } } ``` Para obter mais informações, consulte [Trabalhar com sistemas e configurações de fluxo](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-sysdeploy.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [GetSystemTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/get-system-template.html) na *Referência de comandos da AWS CLI*. ### `get-upload-status` O código de exemplo a seguir mostra como usar `get-upload-status`. **AWS CLI** **Para obter o status de upload de uma entidade** O exemplo `get-upload-status` a seguir obtém o status da operação de upload da entidade. O valor de `MyUploadId` é o valor do ID retornado pela operação `upload-entity-definitions`. ``` aws iotthingsgraph get-upload-status \ --upload-id "MyUploadId" ``` Resultado: ``` { "namespaceName": "us-west-2/123456789012/default", "namespaceVersion": 5, "uploadId": "f6294f1e-b109-4bbe-9073-f451a2dda2da", "uploadStatus": "SUCCEEDED" } ``` Para obter mais informações, consulte [Modelar entidades](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-modelmanagement.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [GetUploadStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/get-upload-status.html) na *Referência de comandos da AWS CLI*. ### `list-flow-execution-messages` O código de exemplo a seguir mostra como usar `list-flow-execution-messages`. **AWS CLI** **Para obter informações sobre eventos em uma execução de fluxo** O exemplo `list-flow-execution-messages` a seguir obtém informações sobre eventos em uma execução de fluxo. ``` aws iotthingsgraph list-flow-execution-messages \ --flow-execution-id "urn:tdm:us-west-2/123456789012/default:Workflow:SecurityFlow_2019-05-11T19:39:55.317Z_MotionSensor_69b151ad-a611-42f5-ac21-fe537f9868ad" ``` Resultado: ``` { "messages": [ { "eventType": "EXECUTION_STARTED", "messageId": "f6294f1e-b109-4bbe-9073-f451a2dda2da", "payload": "Flow execution started", "timestamp": 1559247540.656 } ] } ``` Para obter mais informações, consulte [Trabalhar com fluxos](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-workflows.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [ListFlowExecutionMessages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/list-flow-execution-messages.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar todas as tags de um recurso** O exemplo `list-tags-for-resource` a seguir lista todas as tags de um recurso do AWS IoT Things Graph. ``` aws iotthingsgraph list-tags-for-resource \ --resource-arn "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218" ``` Resultado: ``` { "tags": [ { "key": "Type", "value": "Residential" } ] } ``` Para obter mais informações, consulte [Adicionar tags aos recursos do AWS IoT Things Graph](https://docs.aws.amazon.com/thingsgraph/latest/ug/tagging-tg.html), no *Guia do usuário do AWS IoT Things Graph*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `search-entities` O código de exemplo a seguir mostra como usar `search-entities`. **AWS CLI** **Para pesquisar entidades** O exemplo `search-entities` a seguir pesquisa todas as entidades do tipo `EVENT`. ``` aws iotthingsgraph search-entities \ --entity-types "EVENT" ``` Resultado: ``` { "descriptions": [ { "id": "urn:tdm:aws/examples:Event:MotionSensorEvent", "type": "EVENT", "definition": { "language": "GRAPHQL", "text": "##\n# Description of events emitted by motion sensor.\n##\ntype MotionSensorEvent @eventType(id: \"urn:tdm:aws/examples:event:MotionSensorEvent\",\n payload: \"urn:tdm:aws/examples:property:MotionSensorStateProperty\") {ignore:void}" } }, { "id": "urn:tdm:us-west-2/123456789012/default:Event:CameraClickedEventV2", "type": "EVENT", "definition": { "language": "GRAPHQL", "text": "type CameraClickedEventV2 @eventType(id: \"urn:tdm:us-west-2/123456789012/default:event:CameraClickedEventV2\",\r\npayload: \"urn:tdm:aws:Property:Boolean\"){ignore:void}" } }, { "id": "urn:tdm:us-west-2/123456789012/default:Event:MotionSensorEventV2", "type": "EVENT", "definition": { "language": "GRAPHQL", "text": "# Event emitted by the motion sensor.\r\ntype MotionSensorEventV2 @eventType(id: \"urn:tdm:us-west-2/123456789012/default:event:MotionSensorEventV2\",\r\npayload: \"urn:tdm:us-west-2/123456789012/default:property:MotionSensorStateProperty2\") {ignore:void}" } } ], "nextToken": "urn:tdm:us-west-2/123456789012/default:Event:MotionSensorEventV2" } ``` Para obter mais informações, consulte [Referência de modelos de dados do AWS IoT Things Graph](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-models.html), no *Guia do usuário do AWS IoT Things Graph*. + Para obter detalhes sobre a API, consulte [SearchEntities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/search-entities.html) na *Referência de comandos da AWS CLI*. ### `search-flow-executions` O código de exemplo a seguir mostra como usar `search-flow-executions`. **AWS CLI** **Para pesquisar execuções de fluxo** O exemplo `search-flow-executions` a seguir pesquisa todas as execuções de um fluxo em uma instância do sistema especificada. ``` aws iotthingsgraph search-flow-executions \ --system-instance-id "urn:tdm:us-west-2/123456789012/default:Deployment:Room218" ``` Resultado: ``` { "summaries": [ { "createdAt": 1559247540.656, "flowExecutionId": "f6294f1e-b109-4bbe-9073-f451a2dda2da", "flowTemplateId": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow", "status": "RUNNING ", "systemInstanceId": "urn:tdm:us-west-2/123456789012/default:System:MySystem", "updatedAt": 1559247540.656 } ] } ``` Para obter mais informações, consulte [Trabalhar com sistemas e configurações de fluxo](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-sysdeploy.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [SearchFlowExecutions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/search-flow-executions.html) na *Referência de comandos da AWS CLI.* ### `search-flow-templates` O código de exemplo a seguir mostra como usar `search-flow-templates`. **AWS CLI** **Para pesquisar fluxos (ou fluxos de trabalho)** O exemplo `search-flow-templates` a seguir pesquisa todos os fluxos (fluxos de trabalho) que contêm o modelo do dispositivo Camera. ``` aws iotthingsgraph search-flow-templates \ --filters name="DEVICE_MODEL_ID",value="urn:tdm:aws/examples:DeviceModel:Camera" ``` Resultado: ``` { "summaries": [ { "id": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow", "revisionNumber": 1, "createdAt": 1559247540.292 }, { "id": "urn:tdm:us-west-2/123456789012/default:Workflow:SecurityFlow", "revisionNumber": 3, "createdAt": 1548283099.27 } ] } ``` Para obter mais informações, consulte [Trabalhar com fluxos](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-workflows.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [SearchFlowTemplates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/search-flow-templates.html) na *Referência de comandos da AWS CLI*. ### `search-system-instances` O código de exemplo a seguir mostra como usar `search-system-instances`. **AWS CLI** **Para pesquisar instâncias do sistema** O exemplo `search-system-instances` a seguir pesquisa todas as instâncias do sistema que contêm o sistema especificado. ``` aws iotthingsgraph search-system-instances \ --filters name="SYSTEM_TEMPLATE_ID",value="urn:tdm:us-west-2/123456789012/default:System:SecurityFlow" ``` Resultado: ``` { "summaries": [ { "id": "urn:tdm:us-west-2/123456789012/default:Deployment:DeploymentForSample", "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/DeploymentForSample", "status": "NOT_DEPLOYED", "target": "GREENGRASS", "greengrassGroupName": "ThingsGraphGrnGr", "createdAt": 1555716314.707, "updatedAt": 1555716314.707 }, { "id": "urn:tdm:us-west-2/123456789012/default:Deployment:MockDeployment", "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/MockDeployment", "status": "DELETED_IN_TARGET", "target": "GREENGRASS", "greengrassGroupName": "ThingsGraphGrnGr", "createdAt": 1549416462.049, "updatedAt": 1549416722.361, "greengrassGroupId": "01d04b07-2a51-467f-9d03-0c90b3cdcaaf", "greengrassGroupVersionId": "7365aed7-2d3e-4d13-aad8-75443d45eb05" }, { "id": "urn:tdm:us-west-2/123456789012/default:Deployment:MockDeployment2", "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/MockDeployment2", "status": "DEPLOYED_IN_TARGET", "target": "GREENGRASS", "greengrassGroupName": "ThingsGraphGrnGr", "createdAt": 1549572385.774, "updatedAt": 1549572418.408, "greengrassGroupId": "01d04b07-2a51-467f-9d03-0c90b3cdcaaf", "greengrassGroupVersionId": "bfa70ab3-2bf7-409c-a4d4-bc8328ae5b86" }, { "id": "urn:tdm:us-west-2/123456789012/default:Deployment:Room215", "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room215", "status": "NOT_DEPLOYED", "target": "GREENGRASS", "greengrassGroupName": "ThingsGraphGG", "createdAt": 1547056918.413, "updatedAt": 1547056918.413 }, { "id": "urn:tdm:us-west-2/123456789012/default:Deployment:Room218", "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218", "status": "NOT_DEPLOYED", "target": "CLOUD", "createdAt": 1559249315.208, "updatedAt": 1559249315.208 } ] } ``` Para obter mais informações, consulte [Trabalhar com sistemas e configurações de fluxo](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-sysdeploy.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [SearchSystemInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/search-system-instances.html) na *Referência de comandos da AWS CLI*. ### `search-system-templates` O código de exemplo a seguir mostra como usar `search-system-templates`. **AWS CLI** **Para pesquisar sistemas** O exemplo `search-system-templates` a seguir pesquisa todos os sistemas que contenham o fluxo especificado. ``` aws iotthingsgraph search-system-templates \ --filters name="FLOW_TEMPLATE_ID",value="urn:tdm:us-west-2/123456789012/default:Workflow:SecurityFlow" ``` Resultado: ``` { "summaries": [ { "id": "urn:tdm:us-west-2/123456789012/default:System:SecurityFlow", "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:System/default/SecurityFlow", "revisionNumber": 1, "createdAt": 1548283099.433 } ] } ``` Para obter mais informações, consulte [Trabalhar com fluxos](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-workflows.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [SearchSystemTemplates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/search-system-templates.html) na *Referência de comandos da AWS CLI*. ### `search-things` O código de exemplo a seguir mostra como usar `search-things`. **AWS CLI** **Para pesquisar itens associados a dispositivos e modelos de dispositivos** O exemplo `search-things` a seguir pesquisa todos os itens associadas ao dispositivo HCSR501MotionSensor. ``` aws iotthingsgraph search-things \ --entity-id "urn:tdm:aws/examples:Device:HCSR501MotionSensor" ``` Resultado: ``` { "things": [ { "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MotionSensor1", "thingName": "MotionSensor1" }, { "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/TG_MS", "thingName": "TG_MS" } ] } ``` Para obter mais informações, consulte [Criar e fazer upload de modelos](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-models-gs.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [SearchThings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/search-things.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Para criar uma tag para um recurso** O exemplo `tag-resource` a seguir cria uma tag para o recurso especificado. ``` aws iotthingsgraph tag-resource \ --resource-arn "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218" \ --tags key="Type",value="Residential" ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar tags aos recursos do AWS IoT Things Graph](https://docs.aws.amazon.com/thingsgraph/latest/ug/tagging-tg.html), no *Guia do usuário do AWS IoT Things Graph*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `undeploy-system-instance` O código de exemplo a seguir mostra como usar `undeploy-system-instance`. **AWS CLI** **Para desimplantar uma instância do sistema de seu alvo** O exemplo `undeploy-system-instance` a seguir remove uma instância do sistema de seu alvo. ``` aws iotthingsgraph undeploy-system-instance \ --id "urn:tdm:us-west-2/123456789012/default:Deployment:Room215" ``` Resultado: ``` { "summary": { "id": "urn:tdm:us-west-2/123456789012/default:Deployment:Room215", "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room215", "status": "PENDING_DELETE", "target": "GREENGRASS", "greengrassGroupName": "ThingsGraphGrnGr", "createdAt": 1553189694.255, "updatedAt": 1559344549.601, "greengrassGroupId": "01d04b07-2a51-467f-9d03-0c90b3cdcaaf", "greengrassGroupVersionId": "731b371d-d644-4b67-ac64-3934e99b75d7" } } ``` Para obter mais informações, consulte [Gerenciar o ciclo de vida de entidades, fluxos, sistemas e implantações do AWS IoT Things Graph](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-lifecycle.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [UndeploySystemInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/undeploy-system-instance.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover uma tag de um recurso** O exemplo `untag-resource` a seguir remove uma tag do recurso especificado. ``` aws iotthingsgraph untag-resource \ --resource-arn "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218" \ --tag-keys "Type" ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar tags aos recursos do AWS IoT Things Graph](https://docs.aws.amazon.com/thingsgraph/latest/ug/tagging-tg.html), no *Guia do usuário do AWS IoT Things Graph*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-flow-template` O código de exemplo a seguir mostra como usar `update-flow-template`. **AWS CLI** **Para atualizar um fluxo** O exemplo `update-flow-template` a seguir atualiza um fluxo (fluxo de trabalho). O valor de `MyFlowDefinition` é o GraphQL que modela o fluxo. ``` aws iotthingsgraph update-flow-template \ --id "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow" \ --definition language=GRAPHQL,text="MyFlowDefinition" ``` Resultado: ``` { "summary": { "createdAt": 1559248067.545, "id": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow", "revisionNumber": 2 } } ``` Para obter mais informações, consulte [Trabalhar com fluxos](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-workflows.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [UpdateFlowTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/update-flow-template.html) na *Referência de comandos da AWS CLI*. ### `update-system-template` O código de exemplo a seguir mostra como usar `update-system-template`. **AWS CLI** **Para atualizar um sistema** O exemplo `update-system-template` a seguir atualiza um sistema. O valor de `MySystemDefinition` é o GraphQL que modela o sistema. ``` aws iotthingsgraph update-system-template \ --id "urn:tdm:us-west-2/123456789012/default:System:MySystem" \ --definition language=GRAPHQL,text="MySystemDefinition" ``` Resultado: ``` { "summary": { "createdAt": 1559249776.254, "id": "urn:tdm:us-west-2/123456789012/default:System:MySystem", "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:System/default/MySystem", "revisionNumber": 2 } } ``` Para obter mais informações, consulte [Criar sistemas](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-sysdeploy-systems.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [UpdateSystemTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/update-system-template.html) na *Referência de comandos da AWS CLI*. ### `upload-entity-definitions` O código de exemplo a seguir mostra como usar `upload-entity-definitions`. **AWS CLI** **Para carregar definições de entidade** O exemplo `upload-entity-definitions` a seguir carrega as definições de entidade ao namespace. O valor de `MyEntityDefinitions` é o GraphQL que modela as entidades. ``` aws iotthingsgraph upload-entity-definitions \ --document language=GRAPHQL,text="MyEntityDefinitions" ``` Resultado: ``` { "uploadId": "f6294f1e-b109-4bbe-9073-f451a2dda2da" } ``` Para obter mais informações, consulte [Modelar entidades](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-modelmanagement.html) no *Guia do usuário do AWS IoT Things Graph*. + Para ver detalhes da API, consulte [UploadEntityDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/upload-entity-definitions.html) na *Referência de comandos da AWS CLI*. # AWS IoT Wireless Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o AWS IoT Wireless. *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 ### `associate-aws-account-with-partner-account` O código de exemplo a seguir mostra como usar `associate-aws-account-with-partner-account`. **AWS CLI** **Para associar uma conta de parceiro à sua conta da AWS** O exemplo `associate-aws-account-with-partner-account` a seguir associa as seguintes credenciais da conta Sidewalk à sua conta da AWS. ``` aws iotwireless associate-aws-account-with-partner-account \ --sidewalk AmazonId="12345678901234",AppServerPrivateKey="a123b45c6d78e9f012a34cd5e6a7890b12c3d45e6f78a1b234c56d7e890a1234" ``` Resultado: ``` { "Sidewalk": { "AmazonId": "12345678901234", "AppServerPrivateKey": "a123b45c6d78e9f012a34cd5e6a7890b12c3d45e6f78a1b234c56d7e890a1234" } } ``` Para obter mais informações, consulte [Integração do Amazon Sidewalk para AWS IoT Core](https://docs.aws.amazon.com/iot/latest/developerguide/iot-sidewalk.html) no *Guia de desenvolvedores do AWS IoT*. + Para ver detalhes da API, consulte [AssociateAwsAccountWithPartnerAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/associate-aws-account-with-partner-account.html) na *Referência de comandos da AWS CLI*. ### `associate-wireless-device-with-thing` O código de exemplo a seguir mostra como usar `associate-wireless-device-with-thing`. **AWS CLI** **Para associar um item a um dispositivo sem fio** O exemplo `associate-wireless-device-with-thing` a seguir associa um item ao dispositivo sem fio que possua o ID especificado. ``` aws iotwireless associate-wireless-device-with-thing \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" \ --thing-arn "arn:aws:iot:us-east-1:123456789012:thing/MyIoTWirelessThing" ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar gateways e dispositivos sem fio ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-onboard-devices.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [AssociateWirelessDeviceWithThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/associate-wireless-device-with-thing.html) na *Referência de comandos da AWS CLI*. ### `associate-wireless-gateway-with-certificate` O código de exemplo a seguir mostra como usar `associate-wireless-gateway-with-certificate`. **AWS CLI** **Para associar o certificado ao gateway sem fio** O seguinte `associate-wireless-gateway-with-certificate` associa um gateway sem fio a um certificado. ``` aws iotwireless associate-wireless-gateway-with-certificate \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" \ --iot-certificate-id "a123b45c6d78e9f012a34cd5e6a7890b12c3d45e6f78a1b234c56d7e890a1234" ``` Resultado: ``` { "IotCertificateId": "a123b45c6d78e9f012a34cd5e6a7890b12c3d45e6f78a1b234c56d7e890a1234" } ``` Para obter mais informações, consulte [Adicionar gateways e dispositivos sem fio ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-onboard-devices.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [AssociateWirelessGatewayWithCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/associate-wireless-gateway-with-certificate.html) na *Referência de comandos da AWS CLI*. ### `associate-wireless-gateway-with-thing` O código de exemplo a seguir mostra como usar `associate-wireless-gateway-with-thing`. **AWS CLI** **Para associar um item a um gateway sem fio** O exemplo `associate-wireless-gateway-with-thing` a seguir associa um item a um gateway sem fio. ``` aws iotwireless associate-wireless-gateway-with-thing \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" \ --thing-arn "arn:aws:iot:us-east-1:123456789012:thing/MyIoTWirelessThing" ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar gateways e dispositivos sem fio ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-onboard-devices.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [AssociateWirelessGatewayWithThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/associate-wireless-gateway-with-thing.html) na *Referência de comandos da AWS CLI*. ### `create-destination` O código de exemplo a seguir mostra como usar `create-destination`. **AWS CLI** **Para criar um destino de IoT sem fio** O exemplo `create-destination` a seguir cria um destino para mapear uma mensagem do dispositivo para uma regra do AWS IoT. Antes de executar esse comando, é necessário criar um perfil do IAM que conceda ao AWS IoT Core for LoRaWAN as permissões necessárias para enviar dados para a regra do AWS IoT. ``` aws iotwireless create-destination \ --name IoTWirelessDestination \ --expression-type RuleName \ --expression IoTWirelessRule \ --role-arn arn:aws:iam::123456789012:role/IoTWirelessDestinationRole ``` Resultado: ``` { "Arn": "arn:aws:iotwireless:us-east-1:123456789012:Destination/IoTWirelessDestination", "Name": "IoTWirelessDestination" } ``` Para obter mais informações, consulte [Adicionar destinos ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-create-destinations.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [CreateDestination](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/create-destination.html) na *Referência de comandos da AWS CLI*. ### `create-device-profile` O código de exemplo a seguir mostra como usar `create-device-profile`. **AWS CLI** **Para criar um novo perfil de dispositivo** O exemplo `create-device-profile` a seguir cria um novo perfil de dispositivo IoT sem fio. ``` aws iotwireless create-device-profile ``` Resultado: ``` { "Arn": "arn:aws:iotwireless:us-east-1:123456789012:DeviceProfile/12345678-a1b2-3c45-67d8-e90fa1b2c34d", "Id": "12345678-a1b2-3c45-67d8-e90fa1b2c34d" } ``` Para obter mais informações, consulte [Adicionar perfis ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-define-profiles.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [CreateDeviceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/create-device-profile.html) na *Referência de comandos da AWS CLI*. ### `create-service-profile` O código de exemplo a seguir mostra como usar `create-service-profile`. **AWS CLI** **Para criar um novo perfil de serviço** O exemplo `create-service-profile` a seguir cria um novo perfil de serviço IoT sem fio. ``` aws iotwireless create-service-profile ``` Resultado: ``` { "Arn": "arn:aws:iotwireless:us-east-1:123456789012:ServiceProfile/12345678-a1b2-3c45-67d8-e90fa1b2c34d", "Id": "12345678-a1b2-3c45-67d8-e90fa1b2c34d" } ``` Para obter mais informações, consulte [Adicionar perfis ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-define-profiles.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [CreateServiceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/create-service-profile.html) na *Referência de comandos da AWS CLI*. ### `create-wireless-device` O código de exemplo a seguir mostra como usar `create-wireless-device`. **AWS CLI** **Para criar um dispositivo de IoT sem fio** O exemplo `create-wireless-device` a seguir cria um recurso de dispositivo sem fio do tipo LoRaWAN. ``` aws iotwireless create-wireless-device \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "Description": "My LoRaWAN wireless device" "DestinationName": "IoTWirelessDestination" "LoRaWAN": { "DeviceProfileId": "ab0c23d3-b001-45ef-6a01-2bc3de4f5333", "ServiceProfileId": "fe98dc76-cd12-001e-2d34-5550432da100", "OtaaV1_1": { "AppKey": "3f4ca100e2fc675ea123f4eb12c4a012", "JoinEui": "b4c231a359bc2e3d", "NwkKey": "01c3f004a2d6efffe32c4eda14bcd2b4" }, "DevEui": "ac12efc654d23fc2" }, "Name": "SampleIoTWirelessThing" "Type": LoRaWAN } ``` Resultado: ``` { "Arn": "arn:aws:iotwireless:us-east-1:123456789012:WirelessDevice/1ffd32c8-8130-4194-96df-622f072a315f", "Id": "1ffd32c8-8130-4194-96df-622f072a315f" } ``` Para obter mais informações, consulte [Conectar itens e gateways ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [CreateWirelessDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/create-wireless-device.html) na *Referência de comandos da AWS CLI*. ### `create-wireless-gateway-task-definition` O código de exemplo a seguir mostra como usar `create-wireless-gateway-task-definition`. **AWS CLI** **Para criar uma definição de tarefa de gateway sem fio** O `create-wireless-gateway-task-definition` a seguir cria automaticamente tarefas usando a definição de tarefas para todos os gateways com a versão atual especificada. ``` aws iotwireless create-wireless-gateway-task-definition \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "AutoCreateTasks": true, "Name": "TestAutoUpdate", "Update":{ "UpdateDataSource" : "s3://cupsalphagafirmwarebin/station", "UpdateDataRole" : "arn:aws:iam::001234567890:role/SDK_Test_Role", "LoRaWAN" :{ "CurrentVersion" :{ "PackageVersion" : "1.0.0", "Station" : "2.0.5", "Model" : "linux" }, "UpdateVersion" :{ "PackageVersion" : "1.0.1", "Station" : "2.0.5", "Model" : "minihub" } } } } ``` Resultado: ``` { "Id": "b7d3baad-25c7-35e7-a4e1-1683a0d61da9" } ``` Para obter mais informações, consulte [Conectar itens e gateways ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [CreateWirelessGatewayTaskDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/create-wireless-gateway-task-definition.html) na *Referência de comandos da AWS CLI*. ### `create-wireless-gateway-task` O código de exemplo a seguir mostra como usar `create-wireless-gateway-task`. **AWS CLI** **Para criar a tarefa para um gateway sem fio** O exemplo `create-wireless-gateway-task` a seguir cria uma tarefa para um gateway sem fio. ``` aws iotwireless create-wireless-gateway-task \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" \ --wireless-gateway-task-definition-id "aa000102-0304-b0cd-ef56-a1b23cde456a" ``` Resultado: ``` { "WirelessGatewayTaskDefinitionId": "aa204003-0604-30fb-ac82-a4f95aaf450a", "Status": "Success" } ``` Para obter mais informações, consulte [Conectar itens e gateways ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [CreateWirelessGatewayTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/create-wireless-gateway-task.html) na *Referência de comandos da AWS CLI*. ### `create-wireless-gateway` O código de exemplo a seguir mostra como usar `create-wireless-gateway`. **AWS CLI** **Para criar um gateway sem fio** O exemplo `create-wireless-gateway` a seguir cria um gateway de dispositivo LoRaWAN sem fio. ``` aws iotwireless create-wireless-gateway \ --lorawan GatewayEui="a1b2c3d4567890ab",RfRegion="US915" \ --name "myFirstLoRaWANGateway" \ --description "Using my first LoRaWAN gateway" ``` Resultado: ``` { "Arn": "arn:aws:iotwireless:us-east-1:123456789012:WirelessGateway/12345678-a1b2-3c45-67d8-e90fa1b2c34d", "Id": "12345678-a1b2-3c45-67d8-e90fa1b2c34d" } ``` Para obter mais informações, consulte [Conectar itens e gateways ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [CreateWirelessGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/create-wireless-gateway.html) na *Referência de comandos da AWS CLI*. ### `delete-destination` O código de exemplo a seguir mostra como usar `delete-destination`. **AWS CLI** **Para excluir um destino de IoT sem fio** O exemplo `delete-destination` a seguir exclui o recurso de destino sem fio criado com o nome `IoTWirelessDestination`. ``` aws iotwireless delete-destination \ --name "IoTWirelessDestination" ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar destinos ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-create-destinations.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DeleteDestination](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/delete-destination.html) na *Referência de comandos da AWS CLI*. ### `delete-device-profile` O código de exemplo a seguir mostra como usar `delete-device-profile`. **AWS CLI** **Para excluir um perfil de dispositivo** O exemplo `delete-device-profile` a seguir exclui um perfil de dispositivo criado com a ID especificada. ``` aws iotwireless delete-device-profile \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar perfis ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-define-profiles.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DeleteDeviceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/delete-device-profile.html) na *Referência de comandos da AWS CLI*. ### `delete-service-profile` O código de exemplo a seguir mostra como usar `delete-service-profile`. **AWS CLI** **Para excluir um perfil de serviço** O exemplo `delete-service-profile` a seguir exclui um perfil de serviço criado com a ID especificada. ``` aws iotwireless delete-service-profile \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar perfis ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-define-profiles.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DeleteServiceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/delete-service-profile.html) na *Referência de comandos da AWS CLI*. ### `delete-wireless-device` O código de exemplo a seguir mostra como usar `delete-wireless-device`. **AWS CLI** **Para excluir um dispositivo sem fio** O exemplo `delete-wireless-device` a seguir exclui um dispositivo sem fio que possua o ID especificado. ``` aws iotwireless delete-wireless-device \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" ``` Este comando não produz saída. Para obter mais informações, consulte [Conectar itens e gateways ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DeleteWirelessDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/delete-wireless-device.html) na *Referência de comandos da AWS CLI*. ### `delete-wireless-gateway-task-definition` O código de exemplo a seguir mostra como usar `delete-wireless-gateway-task-definition`. **AWS CLI** **Para excluir uma definição de tarefa do gateway sem fio** O exemplo `delete-wireless-gateway-task-definition` a seguir exclui a definição de tarefa do gateway sem fio criado com a seguinte ID. ``` aws iotwireless delete-wireless-gateway-task-definition \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" ``` Este comando não produz saída. Para obter mais informações, consulte [Conectar itens e gateways ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DeleteWirelessGatewayTaskDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/delete-wireless-gateway-task-definition.html) na *Referência de comandos da AWS CLI*. ### `delete-wireless-gateway-task` O código de exemplo a seguir mostra como usar `delete-wireless-gateway-task`. **AWS CLI** **Para excluir uma tarefa do gateway sem fio** O exemplo `delete-wireless-gateway-task` a seguir exclui uma tarefa de gateway sem fio que possua o ID especificado. ``` aws iotwireless delete-wireless-gateway-task \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" ``` Este comando não produz saída. Para obter mais informações, consulte [Conectar itens e gateways ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DeleteWirelessGatewayTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/delete-wireless-gateway-task.html) na *Referência de comandos da AWS CLI*. ### `delete-wireless-gateway` O código de exemplo a seguir mostra como usar `delete-wireless-gateway`. **AWS CLI** **Para excluir um gateway sem fio** O exemplo `delete-wireless-gateway` a seguir exclui gateway sem fio que possua o ID especificado. ``` aws iotwireless delete-wireless-gateway \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" ``` Este comando não produz saída. Para obter mais informações, consulte [Conectar itens e gateways ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DeleteWirelessGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/delete-wireless-gateway.html) na *Referência de comandos da AWS CLI*. ### `disassociate-aws-account-from-partner-account` O código de exemplo a seguir mostra como usar `disassociate-aws-account-from-partner-account`. **AWS CLI** **Para desassociar a conta de parceiro da conta da AWS** O exemplo `disassociate-aws-account-from-partner-account` a seguir desassocia uma conta de parceiro atualmente associado a sua conta da AWS. ``` aws iotwireless disassociate-aws-account-from-partner-account \ --partner-account-id "12345678901234" \ --partner-type "Sidewalk" ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar gateways e dispositivos sem fio ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-onboard-devices.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DisassociateAwsAccountFromPartnerAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/disassociate-aws-account-from-partner-account.html) na *Referência de comandos da AWS CLI*. ### `disassociate-wireless-device-from-thing` O código de exemplo a seguir mostra como usar `disassociate-wireless-device-from-thing`. **AWS CLI** **Como desassociar um item de um dispositivo sem fio** O exemplo `disassociate-wireless-device-from-thing` a seguir desassocia um dispositivo sem fio de seu item atualmente associado. ``` aws iotwireless disassociate-wireless-device-from-thing \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar gateways e dispositivos sem fio ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-onboard-devices.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DisassociateWirelessDeviceFromThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/disassociate-wireless-device-from-thing.html) na *Referência de comandos da AWS CLI*. ### `disassociate-wireless-gateway-from-certificate` O código de exemplo a seguir mostra como usar `disassociate-wireless-gateway-from-certificate`. **AWS CLI** **Como desassociar o certificado do gateway sem fio** O exemplo `disassociate-wireless-gateway-from-certificate` a seguir desassocia um gateway sem fio de seu certificado atualmente associado. ``` aws iotwireless disassociate-wireless-gateway-from-certificate \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar gateways e dispositivos sem fio ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-onboard-devices.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DisassociateWirelessGatewayFromCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/disassociate-wireless-gateway-from-certificate.html) na *Referência de comandos da AWS CLI*. ### `disassociate-wireless-gateway-from-thing` O código de exemplo a seguir mostra como usar `disassociate-wireless-gateway-from-thing`. **AWS CLI** **Como desassociar um item de um gateway sem fio** O exemplo `disassociate-wireless-gateway-from-thing` a seguir desassocia um gateway sem fio de seu item atualmente associado. ``` aws iotwireless disassociate-wireless-gateway-from-thing \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar gateways e dispositivos sem fio ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-onboard-devices.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [DisassociateWirelessGatewayFromThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/disassociate-wireless-gateway-from-thing.html) na *Referência de comandos da AWS CLI*. ### `get-destination` O código de exemplo a seguir mostra como usar `get-destination`. **AWS CLI** **Para obter informações sobre um destino sem fio de IoT** O exemplo `get-destination` a seguir obtém informações sobre o recurso de destino sem fio criado com o nome `IoTWirelessDestination`. ``` aws iotwireless get-destination \ --name "IoTWirelessDestination" ``` Resultado: ``` { "Arn": "arn:aws:iotwireless:us-east-1:123456789012:Destination/IoTWirelessDestination", "Name": "IoTWirelessDestination", "Expression": "IoTWirelessRule", "ExpressionType": "RuleName", "RoleArn": "arn:aws:iam::123456789012:role/IoTWirelessDestinationRole" } ``` Para obter mais informações, consulte [Adicionar destinos ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-create-destinations.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [GetDestination](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-destination.html) na *Referência de comandos da AWS CLI*. ### `get-device-profile` O código de exemplo a seguir mostra como usar `get-device-profile`. **AWS CLI** **Para obter informações sobre um perfil de dispositivo** O exemplo `get-device-profile` a seguir obtém informações sobre o perfil de dispositivo criado o ID especificado. ``` aws iotwireless get-device-profile \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" ``` Resultado: ``` { "Arn": "arn:aws:iotwireless:us-east-1:123456789012:DeviceProfile/12345678-a1b2-3c45-67d8-e90fa1b2c34d", "Id": "12345678-a1b2-3c45-67d8-e90fa1b2c34d", "LoRaWAN": { "MacVersion": "1.0.3", "MaxDutyCycle": 10, "Supports32BitFCnt": false, "RegParamsRevision": "RP002-1.0.1", "SupportsJoin": true, "RfRegion": "US915", "MaxEirp": 13, "SupportsClassB": false, "SupportsClassC": false } } ``` Para obter mais informações, consulte [Adicionar perfis ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-define-profiles.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [GetDeviceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-device-profile.html) na *Referência de comandos da AWS CLI*. ### `get-partner-account` O código de exemplo a seguir mostra como usar `get-partner-account`. **AWS CLI** **Para obter as informações da conta de parceiro** O exemplo `get-partner-account` a seguir obtém informações sobre sua conta do Sidewalk com o seguinte ID. ``` aws iotwireless get-partner-account \ --partner-account-id "12345678901234" \ --partner-type "Sidewalk" ``` Resultado: ``` { "Sidewalk": { "AmazonId": "12345678901234", "Fingerprint": "a123b45c6d78e9f012a34cd5e6a7890b12c3d45e6f78a1b234c56d7e890a1234" }, "AccountLinked": false } ``` Para obter mais informações, consulte [Integração do Amazon Sidewalk para AWS IoT Core](https://docs.aws.amazon.com/iot/latest/developerguide/iot-sidewalk.html) no *Guia de desenvolvedores do AWS IoT*. + Para ver detalhes da API, consulte [GetPartnerAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-partner-account.html) na *Referência de comandos da AWS CLI*. ### `get-service-endpoint` O código de exemplo a seguir mostra como usar `get-service-endpoint`. **AWS CLI** **Para obter o endpoint do serviço** O exemplo `get-service-endpoint` a seguir obtém o endpoint específico da conta para o protocolo CUPS. ``` aws iotwireless get-service-endpoint ``` Resultado: ``` { "ServiceType": "CUPS", "ServiceEndpoint": "https://A1RMKZ37ACAGOT.cups.lorawan.us-east-1.amazonaws.com:443", "ServerTrust": "-----BEGIN CERTIFICATE-----\n MIIESTCCAzGgAwIBAgITBn+UV4WH6Kx33rJTMlu8mYtWDTANBgkqhkiG9w0BAQsF\n ADA5MQswCQYDVQQGEwJVUzEPMA0GA1UEChMGQW1hem9uMRkwFwYDVQQDExBBbWF6\n b24gUm9vdCBDQSAxMB4XDTE1MTAyMjAwMDAwMFoXDTI1MTAxOTAwMDAwMFowRjEL\n MAkGA1UEBhMCVVMxDzANBgNVBAoTBkFtYXpvbjEVMBMGA1UECxMMU2VydmVyIENB\n IDFCMQ8wDQYDVQQDEwZBbWF6b24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK\n AoIBAQDCThZn3c68asg3Wuw6MLAd5tES6BIoSMzoKcG5blPVo+sDORrMd4f2AbnZ\n cMzPa43j4wNxhplty6aUKk4T1qe9BOwKFjwK6zmxxLVYo7bHViXsPlJ6qOMpFge5\n blDP+18x+B26A0piiQOuPkfyDyeR4xQghfj66Yo19V+emU3nazfvpFA+ROz6WoVm\n B5x+F2pV8xeKNR7u6azDdU5YVX1TawprmxRC1+WsAYmz6qP+z8ArDITC2FMVy2fw\n 0IjKOtEXc/VfmtTFch5+AfGYMGMqqvJ6LcXiAhqG5TI+Dr0RtM88k+8XUBCeQ8IG\n KuANaL7TiItKZYxK1MMuTJtV9IblAgMBAAGjggE7MIIBNzASBgNVHRMBAf8ECDAG\n AQH/AgEAMA4GA1UdDwEB/wQEAwIBhjAdBgNVHQ4EFgQUWaRmBlKge5WSPKOUByeW\n dFv5PdAwHwYDVR0jBBgwFoAUhBjMhTTsvAyUlC4IWZzHshBOCggwewYIKwYBBQUH\n AQEEbzBtMC8GCCsGAQUFBzABhiNodHRwOi8vb2NzcC5yb290Y2ExLmFtYXpvbnRy\n dXN0LmNvbTA6BggrBgEFBQcwAoYuaHR0cDovL2NydC5yb290Y2ExLmFtYXpvbnRy\n dXN0LmNvbS9yb290Y2ExLmNlcjA/BgNVHR8EODA2MDSgMqAwhi5odHRwOi8vY3Js\n LnJvb3RjYTEuYW1hem9udHJ1c3QuY29tL3Jvb3RjYTEuY3JsMBMGA1UdIAQMMAow\n CAYGZ4EMAQIBMA0GCSqGSIb3DQEBCwUAA4IBAQCFkr41u3nPo4FCHOTjY3NTOVI1\n 59Gt/a6ZiqyJEi+752+a1U5y6iAwYfmXss2lJwJFqMp2PphKg5625kXg8kP2CN5t\n 6G7bMQcT8C8xDZNtYTd7WPD8UZiRKAJPBXa30/AbwuZe0GaFEQ8ugcYQgSn+IGBI\n 8/LwhBNTZTUVEWuCUUBVV18YtbAiPq3yXqMB48Oz+ctBWuZSkbvkNodPLamkB2g1\n upRyzQ7qDn1X8nn8N8V7YJ6y68AtkHcNSRAnpTitxBKjtKPISLMVCx7i4hncxHZS\n yLyKQXhw2W2Xs0qLeC1etA+jTGDK4UfLeC0SF7FSi8o5LL21L8IzApar2pR/\n -----END CERTIFICATE-----\n" } ``` Para obter mais informações, consulte [Conectar itens e gateways ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [GetServiceEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-service-endpoint.html) na *Referência de comandos da AWS CLI*. ### `get-service-profile` O código de exemplo a seguir mostra como usar `get-service-profile`. **AWS CLI** **Para obter informações sobre um perfil de serviço** O exemplo `get-service-profile` a seguir obtém informações sobre o perfil de serviço criado o ID especificado. ``` aws iotwireless get-service-profile \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" ``` Resultado: ``` { "Arn": "arn:aws:iotwireless:us-east-1:651419225604:ServiceProfile/538185bb-d7e7-4b95-96a0-c51aa4a5b9a0", "Id": "12345678-a1b2-3c45-67d8-e90fa1b2c34d", "LoRaWAN": { "HrAllowed": false, "NwkGeoLoc": false, "DrMax": 15, "UlBucketSize": 4096, "PrAllowed": false, "ReportDevStatusBattery": false, "DrMin": 0, "DlRate": 60, "AddGwMetadata": false, "ReportDevStatusMargin": false, "MinGwDiversity": 1, "RaAllowed": false, "DlBucketSize": 4096, "DevStatusReqFreq": 24, "TargetPer": 5, "UlRate": 60 } } ``` Para obter mais informações, consulte [Adicionar perfis ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-define-profiles.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [GetServiceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-service-profile.html) na *Referência de comandos da AWS CLI*. ### `get-wireless-device-statistics` O código de exemplo a seguir mostra como usar `get-wireless-device-statistics`. **AWS CLI** **Para obter informações operacionais sobre um dispositivo sem fio** O exemplo `get-wireless-device-statistics` a seguir obtém informações operacionais sobre um dispositivo sem fio. ``` aws iotwireless get-wireless-device-statistics \ --wireless-device-id "1ffd32c8-8130-4194-96df-622f072a315f" ``` Resultado: ``` { "WirelessDeviceId": "1ffd32c8-8130-4194-96df-622f072a315f" } ``` Para obter mais informações, consulte [Conectar itens e gateways ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [GetWirelessDeviceStatistics](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-wireless-device-statistics.html) na *Referência de comandos da AWS CLI*. ### `get-wireless-device` O código de exemplo a seguir mostra como usar `get-wireless-device`. **AWS CLI** **Para obter informações de entrada sobre um dispositivo sem fio** O exemplo `get-wireless-device` a seguir lista os widgets disponíveis na sua conta da AWS. ``` aws iotwireless get-wireless-device \ --identifier "1ffd32c8-8130-4194-96df-622f072a315f" \ --identifier-type WirelessDeviceID ``` Resultado: ``` { "Name": "myLoRaWANDevice", "ThingArn": "arn:aws:iot:us-east-1:123456789012:thing/44b87eb4-9bce-423d-b5fc-973f5ecc358b", "DestinationName": "IoTWirelessDestination", "Id": "1ffd32c8-8130-4194-96df-622f072a315f", "ThingName": "44b87eb4-9bce-423d-b5fc-973f5ecc358b", "Type": "LoRaWAN", "LoRaWAN": { "DeviceProfileId": "ab0c23d3-b001-45ef-6a01-2bc3de4f5333", "ServiceProfileId": "fe98dc76-cd12-001e-2d34-5550432da100", "OtaaV1_1": { "AppKey": "3f4ca100e2fc675ea123f4eb12c4a012", "JoinEui": "b4c231a359bc2e3d", "NwkKey": "01c3f004a2d6efffe32c4eda14bcd2b4" }, "DevEui": "ac12efc654d23fc2" }, "Arn": "arn:aws:iotwireless:us-east-1:123456789012:WirelessDevice/1ffd32c8-8130-4194-96df-622f072a315f", "Description": "My LoRaWAN wireless device" } ``` Para obter mais informações, consulte [Conectar itens e gateways ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [GetWirelessDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-wireless-device.html) na *Referência de comandos da AWS CLI*. ### `get-wireless-gateway-certificate` O código de exemplo a seguir mostra como usar `get-wireless-gateway-certificate`. **AWS CLI** **Para obter o ID de um certificado associado a um gateway sem fio** O exemplo `get-wireless-gateway-certificate` a seguir obtém o ID do certificado associado a um gateway com o ID especificado. ``` aws iotwireless get-wireless-gateway-certificate \ --id "6c44ab31-8b4d-407a-bed3-19b6c7cda551" ``` Resultado: ``` { "IotCertificateId": "8ea4aeae3db34c78cce75d9abd830356869ead6972997e0603e5fd032c804b6f" } ``` Para obter mais informações, consulte [Conectar itens e gateways ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [GetWirelessGatewayCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-wireless-gateway-certificate.html) na *Referência de comandos da AWS CLI*. ### `get-wireless-gateway-firmware-information` O código de exemplo a seguir mostra como usar `get-wireless-gateway-firmware-information`. **AWS CLI** **Para obter informações de firmware de um gateway sem fio** O exemplo `get-wireless-gateway-firmware-information` a seguir obtém a versão do firmware e outras informações sobre um gateway sem fio. ``` aws iotwireless get-wireless-gateway-firmware-information \ --id "3039b406-5cc9-4307-925b-9948c63da25b" ``` Resultado: ``` { "LoRaWAN" :{ "CurrentVersion" :{ "PackageVersion" : "1.0.0", "Station" : "2.0.5", "Model" : "linux" } } } ``` Para obter mais informações, consulte [Conectar itens e gateways ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [GetWirelessGatewayFirmwareInformation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-wireless-gateway-firmware-information.html) na *Referência de comandos da AWS CLI*. ### `get-wireless-gateway-statistics` O código de exemplo a seguir mostra como usar `get-wireless-gateway-statistics`. **AWS CLI** **Para obter informações operacionais sobre um gateway sem fio** O exemplo `get-wireless-gateway-statistics` a seguir obtém informações operacionais sobre um gateway sem fio. ``` aws iotwireless get-wireless-gateway-statistics \ --wireless-gateway-id "3039b406-5cc9-4307-925b-9948c63da25b" ``` Resultado: ``` { "WirelessGatewayId": "3039b406-5cc9-4307-925b-9948c63da25b" } ``` Para obter mais informações, consulte [Conectar itens e gateways ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [GetWirelessGatewayStatistics](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-wireless-gateway-statistics.html) na *Referência de comandos da AWS CLI*. ### `get-wireless-gateway-task-definition` O código de exemplo a seguir mostra como usar `get-wireless-gateway-task-definition`. **AWS CLI** **Para obter informações sobre a definição de tarefas para um gateway sem fio** O exemplo `get-wireless-gateway-task-definition` a seguir obtém informações sobre a definição de tarefas sem fio com o ID especificado. ``` aws iotwireless get-wireless-gateway-task-definition \ --id "b7d3baad-25c7-35e7-a4e1-1683a0d61da9" ``` Resultado: ``` { "AutoCreateTasks": true, "Name": "TestAutoUpdate", "Update":{ "UpdateDataSource" : "s3://cupsalphagafirmwarebin/station", "UpdateDataRole" : "arn:aws:iam::001234567890:role/SDK_Test_Role", "LoRaWAN" :{ "CurrentVersion" :{ "PackageVersion" : "1.0.0", "Station" : "2.0.5", "Model" : "linux" }, "UpdateVersion" :{ "PackageVersion" : "1.0.1", "Station" : "2.0.5", "Model" : "minihub" } } } } ``` Para obter mais informações, consulte [Conectar itens e gateways ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [GetWirelessGatewayTaskDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-wireless-gateway-task-definition.html) na *Referência de comandos da AWS CLI*. ### `get-wireless-gateway-task` O código de exemplo a seguir mostra como usar `get-wireless-gateway-task`. **AWS CLI** **Para obter informações sobre a tarefa para um gateway sem fio** O exemplo `get-wireless-gateway-task` a seguir obtém informações sobre a tarefa para um gateway sem fio com o ID especificado. ``` aws iotwireless get-wireless-gateway-task \ --id "11693a46-6866-47c3-a031-c9a616e7644b" ``` Resultado: ``` { "WirelessGatewayId": "6c44ab31-8b4d-407a-bed3-19b6c7cda551", "WirelessGatewayTaskDefinitionId": "b7d3baad-25c7-35e7-a4e1-1683a0d61da9", "Status": "Success" } ``` Para obter mais informações, consulte [Conectar itens e gateways ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [GetWirelessGatewayTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-wireless-gateway-task.html) na *Referência de comandos da AWS CLI*. ### `get-wireless-gateway` O código de exemplo a seguir mostra como usar `get-wireless-gateway`. **AWS CLI** **Para obter informações sobre um gateway sem fio** O exemplo `get-wireless-gateway` a seguir obtém informações sobre um gateway `myFirstLoRaWANGateway` sem fio. ``` aws iotwireless get-wireless-gateway \ --identifier "12345678-a1b2-3c45-67d8-e90fa1b2c34d" \ --identifier-type WirelessGatewayId ``` Resultado: ``` { "Description": "My first LoRaWAN gateway", "ThingArn": "arn:aws:iot:us-east-1:123456789012:thing/a1b2c3d4-5678-90ab-cdef-12ab345c67de", "LoRaWAN": { "RfRegion": "US915", "GatewayEui": "a1b2c3d4567890ab" }, "ThingName": "a1b2c3d4-5678-90ab-cdef-12ab345c67de", "Id": "12345678-a1b2-3c45-67d8-e90fa1b2c34d", "Arn": "arn:aws:iotwireless:us-east-1:123456789012:WirelessGateway/6c44ab31-8b4d-407a-bed3-19b6c7cda551", "Name": "myFirstLoRaWANGateway" } ``` Para obter mais informações, consulte [Conectar itens e gateways ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [GetWirelessGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-wireless-gateway.html) na *Referência de comandos da AWS CLI*. ### `list-destinations` O código de exemplo a seguir mostra como usar `list-destinations`. **AWS CLI** **Para listar os destinos sem fio** O exemplo `list-destinations` a seguir lista os destinos disponíveis registrados em sua AWS conta. ``` aws iotwireless list-destinations ``` Resultado: ``` { "DestinationList": [ { "Arn": "arn:aws:iotwireless:us-east-1:123456789012:Destination/IoTWirelessDestination", "Name": "IoTWirelessDestination", "Expression": "IoTWirelessRule", "Description": "Destination for messages processed using IoTWirelessRule", "RoleArn": "arn:aws:iam::123456789012:role/IoTWirelessDestinationRole" }, { "Arn": "arn:aws:iotwireless:us-east-1:123456789012:Destination/IoTWirelessDestination2", "Name": "IoTWirelessDestination2", "Expression": "IoTWirelessRule2", "RoleArn": "arn:aws:iam::123456789012:role/IoTWirelessDestinationRole" } ] } ``` Para obter mais informações, consulte [Adicionar destinos ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-create-destinations.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListDestinations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/list-destinations.html) na *Referência de comandos da AWS CLI*. ### `list-device-profiles` O código de exemplo a seguir mostra como usar `list-device-profiles`. **AWS CLI** **Para listar os perfis de dispositivo** O exemplo `list-device-profiles` a seguir lista os perfis de dispositivo disponíveis registrados em sua conta da AWS. ``` aws iotwireless list-device-profiles ``` Resultado: ``` { "DeviceProfileList": [ { "Id": "12345678-a1b2-3c45-67d8-e90fa1b2c34d", "Arn": "arn:aws:iotwireless:us-east-1:123456789012:DeviceProfile/12345678-a1b2-3c45-67d8-e90fa1b2c34d" }, { "Id": "a1b2c3d4-5678-90ab-cdef-12ab345c67de", "Arn": "arn:aws:iotwireless:us-east-1:123456789012:DeviceProfile/a1b2c3d4-5678-90ab-cdef-12ab345c67de" } ] } ``` Para obter mais informações, consulte [Criar credenciais do Git para conexões HTTPS com o CodeCommit](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-define-profiles.html) no *Guia do usuário do AWS CodeCommit*. + Para ver detalhes da API, consulte [ListDeviceProfiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/list-device-profiles.html) na *Referência de comandos da AWS CLI*. ### `list-partner-accounts` O código de exemplo a seguir mostra como usar `list-partner-accounts`. **AWS CLI** **Para listar as contas de parceiros** O exemplo `list-partner-accounts` a seguir lista as contas de parceiros disponíveis associadas à sua conta da AWS. ``` aws iotwireless list-partner-accounts ``` Resultado: ``` { "Sidewalk": [ { "AmazonId": "78965678771228", "Fingerprint": "bd96d8ef66dbfd2160eb60e156849e82ad7018b8b73c1ba0b4fc65c32498ee35" }, { "AmazonId": "89656787651228", "Fingerprint": "bc5e99e151c07be14be7e6603e4489c53f858b271213a36ebe3370777ba06e9b" } ] } ``` Para obter mais informações, consulte [Integração do Amazon Sidewalk para AWS IoT Core](https://docs.aws.amazon.com/iot/latest/developerguide/iot-sidewalk.html) no *Guia de desenvolvedores do AWS IoT*. + Para ver detalhes da API, consulte [ListPartnerAccounts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/list-partner-accounts.html) na *Referência de comandos da AWS CLI*. ### `list-service-profiles` O código de exemplo a seguir mostra como usar `list-service-profiles`. **AWS CLI** **Para listar os perfis de serviço** O exemplo `list-service-profiles` a seguir lista os perfis de serviço disponíveis registrados em sua conta da AWS. ``` aws iotwireless list-service-profiles ``` Resultado: ``` { "ServiceProfileList": [ { "Id": "12345678-a1b2-3c45-67d8-e90fa1b2c34d", "Arn": "arn:aws:iotwireless:us-east-1:123456789012:ServiceProfile/538185bb-d7e7-4b95-96a0-c51aa4a5b9a0" }, { "Id": "a1b2c3d4-5678-90ab-cdef-12ab345c67de", "Arn": "arn:aws:iotwireless:us-east-1:123456789012:ServiceProfile/ea8bc823-5d13-472e-8d26-9550737d8100" } ] } ``` Para obter mais informações, consulte [Adicionar perfis ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-define-profiles.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListServiceProfiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/list-service-profiles.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar as tags atribuídas ao recurso** O exemplo `list-tags-for-resource` a seguir lista as tags atribuídas a um recurso de destino sem fio. ``` aws iotwireless list-tags-for-resource \ --resource-arn "arn:aws:iotwireless:us-east-1:123456789012:Destination/IoTWirelessDestination" ``` Resultado: ``` { "Tags": [ { "Value": "MyValue", "Key": "MyTag" } ] } ``` Para obter mais informações, consulte [Descrever seus recursos AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-describe-resource.html) no *Guia do Desenvolvedor do AWS IoT*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `list-wireless-devices` O código de exemplo a seguir mostra como usar `list-wireless-devices`. **AWS CLI** **Para listar os dispositivo sem fio disponíveis** O exemplo `list-wireless-devices` a seguir lista os perfis de dispositivo sem fio disponíveis registrados em sua conta da AWS. ``` aws iotwireless list-wireless-devices ``` Resultado: ``` { "WirelessDeviceList": [ { "Name": "myLoRaWANDevice", "DestinationName": "IoTWirelessDestination", "Id": "1ffd32c8-8130-4194-96df-622f072a315f", "Type": "LoRaWAN", "LoRaWAN": { "DevEui": "ac12efc654d23fc2" }, "Arn": "arn:aws:iotwireless:us-east-1:123456789012:WirelessDevice/1ffd32c8-8130-4194-96df-622f072a315f" } ] } ``` Para obter mais informações, consulte [Conectar itens e gateways ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListWirelessDevices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/list-wireless-devices.html) na *Referência de comandos da AWS CLI*. ### `list-wireless-gateway-task-definitions` O código de exemplo a seguir mostra como usar `list-wireless-gateway-task-definitions`. **AWS CLI** **Para listar as definições de tarefas do gateway sem fio** O exemplo `list-wireless-gateway-task-definitions` a seguir lista os perfis tarefas do gateway sem fio disponíveis registrados em sua conta da AWS. ``` aws iotwireless list-wireless-gateway-task-definitions ``` Resultado: ``` { "TaskDefinitions": [ { "Id": "b7d3baad-25c7-35e7-a4e1-1683a0d61da9", "LoRaWAN" : { "CurrentVersion" :{ "PackageVersion" : "1.0.0", "Station" : "2.0.5", "Model" : "linux" }, "UpdateVersion" :{ "PackageVersion" : "1.0.1", "Station" : "2.0.5", "Model" : "minihub" } } } ] } ``` Para obter mais informações, consulte [Conectar itens e gateways ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListWirelessGatewayTaskDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/list-wireless-gateway-task-definitions.html) na *Referência de comandos da AWS CLI*. ### `list-wireless-gateways` O código de exemplo a seguir mostra como usar `list-wireless-gateways`. **AWS CLI** **Para listar os gateways sem fio** O exemplo `list-wireless-gateways` a seguir lista os gateways sem fio disponíveis em sua conta da AWS. ``` aws iotwireless list-wireless-gateways ``` Resultado: ``` { "WirelessGatewayList": [ { "Description": "My first LoRaWAN gateway", "LoRaWAN": { "RfRegion": "US915", "GatewayEui": "dac632ebc01d23e4" }, "Id": "3039b406-5cc9-4307-925b-9948c63da25b", "Arn": "arn:aws:iotwireless:us-east-1:123456789012:WirelessGateway/3039b406-5cc9-4307-925b-9948c63da25b", "Name": "myFirstLoRaWANGateway" }, { "Description": "My second LoRaWAN gateway", "LoRaWAN": { "RfRegion": "US915", "GatewayEui": "cda123fffe92ecd2" }, "Id": "3285bdc7-5a12-4991-84ed-dadca65e342e", "Arn": "arn:aws:iotwireless:us-east-1:123456789012:WirelessGateway/3285bdc7-5a12-4991-84ed-dadca65e342e", "Name": "mySecondLoRaWANGateway" } ] } ``` Para obter mais informações, consulte [Conectar itens e gateways ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [ListWirelessGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/list-wireless-gateways.html) na *Referência de comandos da AWS CLI*. ### `send-data-to-wireless-device` O código de exemplo a seguir mostra como usar `send-data-to-wireless-device`. **AWS CLI** **Para enviar dados para o dispositivo sem fio** O exemplo `send-data-to-wireless-device` a seguir envia um quadro de dados de aplicação descriptografado para o dispositivo sem fio. ``` aws iotwireless send-data-to-wireless-device \ --id "11aa5eae-2f56-4b8e-a023-b28d98494e49" \ --transmit-mode "1" \ --payload-data "SGVsbG8gVG8gRGV2c2lt" \ --wireless-metadata LoRaWAN={FPort=1} ``` Resultado: ``` { MessageId: "6011dd36-0043d6eb-0072-0008" } ``` Para obter mais informações, consulte [Conectar itens e gateways ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [SendDataToWirelessDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/send-data-to-wireless-device.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Para especificar a chave e o valor de uma tag para um recurso** O exemplo `tag-resource` a seguir associa uma tag de destino sem fio `IoTWirelessDestination` com a chave `MyTag` e o valor`MyValue`. ``` aws iotwireless tag-resource \ --resource-arn "arn:aws:iotwireless:us-east-1:651419225604:Destination/IoTWirelessDestination" \ --tags Key="MyTag",Value="MyValue" ``` Este comando não produz saída. Para obter mais informações, consulte [Descrever seus recursos AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-describe-resource.html) no *Guia do Desenvolvedor do AWS IoT*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `test-wireless-device` O código de exemplo a seguir mostra como usar `test-wireless-device`. **AWS CLI** **Para testar o dispositivo sem fio** O exemplo `test-wireless-device` a seguir envia dados de uplink de `Hello` para um dispositivo com ID especificado. ``` aws iotwireless test-wireless-device \ --id "11aa5eae-2f56-4b8e-a023-b28d98494e49" ``` Resultado: ``` { Result: "Test succeeded. one message is sent with payload: hello" } ``` Para obter mais informações, consulte [Conectar itens e gateways ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [TestWirelessDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/test-wireless-device.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover uma ou mais tags de um recurso** O exemplo `untag-resource` a seguir remove a tag `MyTag` e seu valor do destino sem fio `IoTWirelessDestination`. ``` aws iotwireless untag-resource \ --resource-arn "arn:aws:iotwireless:us-east-1:123456789012:Destination/IoTWirelessDestination" \ --tag-keys "MyTag" ``` Este comando não produz saída. Para obter mais informações, consulte [Descrever seus recursos AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-describe-resource.html) no *Guia do Desenvolvedor do AWS IoT*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-destination` O código de exemplo a seguir mostra como usar `update-destination`. **AWS CLI** **Para atualizar as propriedades de um destino** O exemplo `update-destination` a seguir atualiza a propriedade de descrição de um destino sem fio. ``` aws iotwireless update-destination \ --name "IoTWirelessDestination" \ --description "Destination for messages processed using IoTWirelessRule" ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar destinos ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-create-destinations.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [UpdateDestination](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/update-destination.html) na *Referência de comandos da AWS CLI*. ### `update-partner-account` O código de exemplo a seguir mostra como usar `update-partner-account`. **AWS CLI** **Para atualizar as propriedades de uma conta de parceiro** O seguinte `update-partner-account` atualiza a `AppServerPrivateKey` da conta com o ID especificado. ``` aws iotwireless update-partner-account \ --partner-account-id "78965678771228" \ --partner-type "Sidewalk" \ --sidewalk AppServerPrivateKey="f798ab4899346a88599180fee9e14fa1ada7b6df989425b7c6d2146dd6c815bb" ``` Este comando não produz saída. Para obter mais informações, consulte [Integração do Amazon Sidewalk para AWS IoT Core](https://docs.aws.amazon.com/iot/latest/developerguide/iot-sidewalk.html) no *Guia de desenvolvedores do AWS IoT*. + Para ver detalhes da API, consulte [UpdatePartnerAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/update-partner-account.html) na *Referência de comandos da AWS CLI*. ### `update-wireless-device` O código de exemplo a seguir mostra como usar `update-wireless-device`. **AWS CLI** **Para atualizar as propriedades de um dispositivo sem fio** O exemplo `update-wireless-device` a seguir atualiza as propriedades de um dispositivo sem fio registrado em sua conta da AWS. ``` aws iotwireless update-wireless-device \ --id "1ffd32c8-8130-4194-96df-622f072a315f" \ --destination-name IoTWirelessDestination2 \ --description "Using my first LoRaWAN device" ``` Este comando não produz saída. Para obter mais informações, consulte [Conectar itens e gateways ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [UpdateWirelessDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/update-wireless-device.html) na *Referência de comandos da AWS CLI*. ### `update-wireless-gateway` O código de exemplo a seguir mostra como usar `update-wireless-gateway`. **AWS CLI** **Para atualizar o gateway sem fio** O exemplo `update-wireless-gateway` a seguir atualiza a descrição de um gateway sem fio. ``` aws iotwireless update-wireless-gateway \ --id "3285bdc7-5a12-4991-84ed-dadca65e342e" \ --description "Using my LoRaWAN gateway" ``` Este comando não produz saída. Para obter mais informações, consulte [Conectar itens e gateways ao AWS IoT Core for LoRaWAN](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html) no *Guia do Desenvolvedor do AWS IoT*. + Para ver detalhes da API, consulte [UpdateWirelessGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/update-wireless-gateway.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon IVS usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o Amazon IVS. *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 ### `batch-get-channel` O código de exemplo a seguir mostra como usar `batch-get-channel`. **AWS CLI** **Para obter informações de configuração de canais sobre vários canais** O exemplo `batch-get-channel` a seguir lista as informações sobre os canais especificados. ``` aws ivs batch-get-channel \ --arns arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \ arn:aws:ivs:us-west-2:123456789012:channel/efghEFGHijkl ``` Resultado: ``` { "channels": [ { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "authorized": false, "containerFormat": "TS", "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net", "insecureIngest": false, "latencyMode": "LOW", "multitrackInputConfiguration": { "enabled": false, "maximumResolution": "FULL_HD", "policy": "ALLOW" }, "name": "channel-1", "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel-1.abcdEFGH.m3u8", "preset": "", "playbackRestrictionPolicyArn": "", "recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh", "srt": { "endpoint": "a1b2c3d4e5f6.srt.live-video.net", "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ" }, "tags": {}, "type": "STANDARD" }, { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/efghEFGHijkl", "authorized": false, "containerFormat": "FRAGMENTED_MP4", "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net", "insecureIngest": false, "latencyMode": "LOW", "multitrackInputConfiguration": { "enabled": true, "maximumResolution": "FULL_HD", "policy": "ALLOW" }, "name": "channel-2", "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel-2.abcdEFGH.m3u8", "preset": "", "playbackRestrictionPolicyArn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ"", "recordingConfigurationArn": "", "srt": { "endpoint": "a1b2c3d4e5f6.srt.live-video.net", "passphrase": "BA1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ" }, "tags": {}, "type": "STANDARD" } ] } ``` Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*. + Para ver detalhes da API, consulte [BatchGetChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/batch-get-channel.html) na *Referência de comandos da AWS CLI*. ### `batch-get-stream-key` O código de exemplo a seguir mostra como usar `batch-get-stream-key`. **AWS CLI** **Para obter informações sobre várias chaves de stream** O exemplo `batch-get-stream-key` a seguir obtém as informações sobre as chaves de stream especificadas. ``` aws ivs batch-get-stream-key \ --arns arn:aws:ivs:us-west-2:123456789012:stream-key/skSKABCDefgh \ arn:aws:ivs:us-west-2:123456789012:stream-key/skSKIJKLmnop ``` Resultado: ``` { "streamKeys": [ { "arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/skSKABCDefgh", "value": "sk_us-west-2_abcdABCDefgh_567890abcdef", "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "tags": {} }, { "arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/skSKIJKLmnop", "value": "sk_us-west-2_abcdABCDefgh_567890ghijkl", "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "tags": {} } ] } ``` Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*. + Para ver detalhes da API, consulte [BatchGetStreamKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/batch-get-stream-key.html) na *Referência de comandos da AWS CLI*. ### `batch-start-viewer-session-revocation` O código de exemplo a seguir mostra como usar `batch-start-viewer-session-revocation`. **AWS CLI** **Como revogar sessões de visualizador para vários pares de ARN de canal e ID de visualizador** O exemplo `batch-start-viewer-session-revocation` a seguir executa a revogação de sessão em vários pares de ARN de canal e ID de visualizador simultaneamente. A solicitação pode ser concluída normalmente, mas retorna valores no campo de erros se não houver permissão para revogar a sessão especificada. ``` aws ivs batch-start-viewer-session-revocation \ --viewer-sessions '[{"channelArn":"arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh1","viewerId":"abcdefg1","viewerSessionVersionsLessThanOrEqualTo":1234567890}, \ {"channelArn":"arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh2","viewerId":"abcdefg2","viewerSessionVersionsLessThanOrEqualTo":1234567890}]' ``` Resultado: ``` { "errors": [ { "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh1", "viewerId": "abcdefg1", "code": "403", "message": "not authorized", }, { "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh2", "viewerId": "abcdefg2", "code": "403", "message": "not authorized", } ] } ``` Para obter mais informações, consulte [Configuração de canais privados](https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) no *Guia do usuário do Amazon Interactive Video Service*. + Para ver detalhes da API, consulte [BatchStartViewerSessionRevocation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/batch-start-viewer-session-revocation.html) na *Referência de comandos da AWS CLI*. ### `create-channel` O código de exemplo a seguir mostra como usar `create-channel`. **AWS CLI** **Exemplo 1: criar um canal sem gravação** O exemplo `create-channel` a seguir cria um novo canal e uma chave de stream associada para iniciar o streaming. ``` aws ivs create-channel \ --name 'test-channel' \ --no-insecure-ingest ``` Resultado: ``` { "channel": { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "authorized": false, "containerFormat": "TS", "name": "test-channel", "latencyMode": "LOW", "multitrackInputConfiguration": { "enabled": false, "maximumResolution": "FULL_HD", "policy": "ALLOW" }, "playbackRestrictionPolicyArn": "", "recordingConfigurationArn": "", "srt": { "endpoint": "a1b2c3d4e5f6.srt.live-video.net", "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ" }, "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net", "insecureIngest": false, "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8", "preset": "", "tags": {}, "type": "STANDARD" }, "streamKey": { "arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/g1H2I3j4k5L6", "value": "sk_us-west-2_abcdABCDefgh_567890abcdef", "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "tags": {} } } ``` Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*. **Exemplo 2: criar um canal com gravação ativada, usando o recurso RecordingConfiguration especificado por seu ARN** O exemplo de `create-channel` a seguir cria um canal e uma chave de fluxo associada para iniciar o streaming, além de definir a gravação no canal: ``` aws ivs create-channel \ --name test-channel-with-recording \ --insecure-ingest \ --recording-configuration-arn 'arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh' ``` Resultado: ``` { "channel": { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "containerFormat": "TS", "name": "test-channel-with-recording", "latencyMode": "LOW", "multitrackInputConfiguration": { "enabled": false, "maximumResolution": "FULL_HD", "policy": "ALLOW" }, "type": "STANDARD", "playbackRestrictionPolicyArn": "", "recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh", "srt": { "endpoint": "a1b2c3d4e5f6.srt.live-video.net", "passphrase": "BA1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ" }, "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net", "insecureIngest": true, "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8", "preset": "", "authorized": false, "tags": {}, "type": "STANDARD" }, "streamKey": { "arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/abcdABCDefgh", "value": "sk_us-west-2_abcdABCDefgh_567890abcdef", "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "tags": {} } } ``` Para obter mais informações, consulte [Gravar no Amazon S3](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html) no *Guia do usuário do IVS Low-Latency*. **Exemplo 3: criar um canal com uma política de restrição de reprodução especificada por seu ARN** O exemplo de `create-channel` a seguir cria um canal e uma chave de fluxo associada para iniciar o streaming, além de definir uma política de restrição de reprodução para o canal: ``` aws ivs create-channel \ --name test-channel-with-playback-restriction-policy\ --insecure-ingest \ --playback-restriction-policy-arn 'arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ' ``` Resultado: ``` { "channel": { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "containerFormat": "TS", "name": "test-channel-with-playback-restriction-policy", "latencyMode": "LOW", "multitrackInputConfiguration": { "enabled": false, "maximumResolution": "FULL_HD", "policy": "ALLOW" }, "type": "STANDARD", "playbackRestrictionPolicyArn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ", "recordingConfigurationArn": "", "srt": { "endpoint": "a1b2c3d4e5f6.srt.live-video.net", "passphrase": "AB1C2edfGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ" }, "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net", "insecureIngest": true, "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8", "preset": "", "authorized": false, "tags": {}, "type": "STANDARD" }, "streamKey": { "arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/abcdABCDefgh", "value": "sk_us-west-2_abcdABCDefgh_567890abcdef", "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "tags": {} } } ``` Para obter mais informações, consulte [Conteúdo e espectadores indesejados](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html) no *Guia do usuário do IVS Low-Latency*. **Exemplo 4: como criar um canal com o recurso de várias faixas habilitado** O exemplo de `create-channel` a seguir cria um canal e uma chave de fluxo associada para iniciar o streaming, além de habilitar o recurso de várias faixas. ``` aws ivs create-channel \ --name 'test-channel' \ --no-insecure-ingest \ --container-format 'FRAGMENTED_MP4' \ --multitrack-input-configuration '{"enabled": true,"maximumResolution": "FULL_HD","policy": "ALLOW"}' ``` Resultado: ``` { "channel": { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "authorized": false, "containerFormat": "FRAGMENTED_MP4", "name": "test-channel", "latencyMode": "LOW", "multitrackInputConfiguration": { "enabled": true, "maximumResolution": "FULL_HD", "policy": "ALLOW" }, "playbackRestrictionPolicyArn": "", "recordingConfigurationArn": "", "srt": { "endpoint": "a1b2c3d4e5f6.srt.live-video.net", "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ" }, "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net", "insecureIngest": false, "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8", "preset": "", "tags": {}, "type": "STANDARD" }, "streamKey": { "arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/g1H2I3j4k5L6", "value": "sk_us-west-2_abcdABCDefgh_567890abcdef", "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "tags": {} } } ``` Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multitrack-video.html) no *Guia do usuário do IVS Low-Latency*. + Para ver detalhes da API, consulte [CreateChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/create-channel.html) na *Referência de comandos da AWS CLI*. ### `create-playback-restriction-policy` O código de exemplo a seguir mostra como usar `create-playback-restriction-policy`. **AWS CLI** **Para criar uma política de restrição de reprodução** O exemplo `create-playback-restriction-policy` a seguir cria uma nova política de restrição de reprodução. ``` aws ivs create-playback-restriction-policy \ --name "test-playback-restriction-policy" \ --enable-strict-origin-enforcement \ --tags "key1=value1, key2=value2" \ --allowed-countries US MX \ --allowed-origins https://www.website1.com https://www.website2.com ``` Resultado: ``` { "playbackRestrictionPolicy": { "arn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ", "allowedCountries": [ "US", "MX" ], "allowedOrigins": [ "https://www.website1.com", "https://www.website2.com" ], "enableStrictOriginEnforcement": true, "name": "test-playback-restriction-policy", "tags": { "key1": "value1", "key2": "value2" } } } ``` Para obter mais informações, consulte [Conteúdo e espectadores indesejados](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html) no *Guia do usuário do IVS Low-Latency*. + Para ver detalhes da API, consulte [CreatePlaybackRestrictionPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/create-playback-restriction-policy.html) na *Referência de comandos da AWS CLI*. ### `create-recording-configuration` O código de exemplo a seguir mostra como usar `create-recording-configuration`. **AWS CLI** **Para criar um recurso RecordingConfiguration** O exemplo `create-recording-configuration` a seguir cria um recurso RecordingConfiguration para permitir a gravação no Amazon S3. ``` aws ivs create-recording-configuration \ --name "test-recording-config" \ --recording-reconnect-window-seconds 60 \ --tags "key1=value1, key2=value2" \ --rendition-configuration renditionSelection="CUSTOM",renditions="HD" \ --thumbnail-configuration recordingMode="INTERVAL",targetIntervalSeconds=1,storage="LATEST",resolution="LOWEST_RESOLUTION" \ --destination-configuration s3={bucketName=demo-recording-bucket} ``` Resultado: ``` { "recordingConfiguration": { "arn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ", "name": "test-recording-config", "destinationConfiguration": { "s3": { "bucketName": "demo-recording-bucket" } }, "state": "CREATING", "tags": { "key1": "value1", "key2": "value2" }, "thumbnailConfiguration": { "recordingMode": "INTERVAL", "targetIntervalSeconds": 1, "resolution": "LOWEST_RESOLUTION", "storage": [ "LATEST" ] }, "recordingReconnectWindowSeconds": 60, "renditionConfiguration": { "renditionSelection": "CUSTOM", "renditions": [ "HD" ] } } } ``` Para obter mais informações, consulte [Gravar no Amazon S3](https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html) no *Guia de usuário do Amazon Interactive Video Service*. + Para ver detalhes da API, consulte [CreateRecordingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/create-recording-configuration.html) na *Referência de comandos da AWS CLI*. ### `create-stream-key` O código de exemplo a seguir mostra como usar `create-stream-key`. **AWS CLI** **Para criar uma chave de stream** O exemplo `create-stream-key` a seguir cria uma chave de stream para o ARN (Amazon Resource Name) do palco especificado. ``` aws ivs create-stream-key \ --channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh ``` Resultado: ``` { "streamKey": { "arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/abcdABCDefgh", "value": "sk_us-west-2_abcdABCDefgh_567890abcdef", "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "tags": {} } } ``` Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*. + Para ver detalhes da API, consulte [CreateStreamKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/create-stream-key.html) na *Referência de comandos da AWS CLI*. ### `delete-channel` O código de exemplo a seguir mostra como usar `delete-channel`. **AWS CLI** **Para excluir um canal e suas chaves de stream associadas** O exemplo `delete-channel` a seguir exclui o canal com o ARN (Amazon Resource Name) especificado. ``` aws ivs delete-channel \ --arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh ``` Este comando não produz saída. Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*. + Para ver detalhes da API, consulte [DeleteChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/delete-channel.html) na *Referência de comandos da AWS CLI*. ### `delete-playback-key-pair` O código de exemplo a seguir mostra como usar `delete-playback-key-pair`. **AWS CLI** **Para excluir um par de chaves de reprodução especificado** O exemplo `delete-playback-key-pair` a seguir retorna a impressão digital do par de chaves especificado. ``` aws ivs delete-playback-key-pair \ --arn arn:aws:ivs:us-west-2:123456789012:playback-key/abcd1234efgh ``` Este comando não produz saída. Para obter mais informações, consulte [Configuração de canais privados](https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) no *Guia do usuário do Amazon Interactive Video Service*. + Para ver detalhes da API, consulte [DeletePlaybackKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/delete-playback-key-pair.html) na *Referência de comandos da AWS CLI*. ### `delete-playback-restriction-policy` O código de exemplo a seguir mostra como usar `delete-playback-restriction-policy`. **AWS CLI** **Para excluir uma política de restrição de reprodução** O exemplo `delete-playback-restriction-policy` a seguir exclui a política de restrição de reprodução com o ARN (Amazon Resource Name) especificado. ``` aws ivs delete-playback-restriction-policy \ --arn "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ" ``` Este comando não produz saída. Para obter mais informações, consulte [Conteúdo e espectadores indesejados](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html) no *Guia do usuário do IVS Low-Latency*. + Para ver detalhes da API, consulte [DeletePlaybackRestrictionPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/delete-playback-restriction-policy.html) na *Referência de comandos da AWS CLI*. ### `delete-recording-configuration` O código de exemplo a seguir mostra como usar `delete-recording-configuration`. **AWS CLI** **Para excluir o recurso RecordingConfiguration especificado por seu ARN** O exemplo `delete-recording-configuration` a seguir exclui o recurso RecordingConfiguration com o ARN especificado. ``` aws ivs delete-recording-configuration \ --arn "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ" ``` Este comando não produz saída. Para obter mais informações, consulte [Gravar no Amazon S3](https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html) no *Guia de usuário do Amazon Interactive Video Service*. + Para ver detalhes da API, consulte [DeleteRecordingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/delete-recording-configuration.html) na *Referência de comandos da AWS CLI*. ### `delete-stream-key` O código de exemplo a seguir mostra como usar `delete-stream-key`. **AWS CLI** **Para excluir uma chave de stream** O exemplo `delete-stream-key` a seguir exclui a chave de stream de um ARN (Amazon Resource Name) especificado, e ele não poderá mais ser usada para streaming. ``` aws ivs delete-stream-key \ --arn arn:aws:ivs:us-west-2:123456789012:stream-key/g1H2I3j4k5L6 ``` Este comando não produz saída. Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*. + Para ver detalhes da API, consulte [DeleteStreamKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/delete-stream-key.html) na *Referência de comandos da AWS CLI*. ### `get-channel` O código de exemplo a seguir mostra como usar `get-channel`. **AWS CLI** **Para obter as informações de configuração de um canal** O exemplo `get-channel` a seguir obtém a configuração de canal para um ARN (Amazon Resource Name) especificado. ``` aws ivs get-channel \ --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' ``` Resultado: ``` { "channel": { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "authorized": false, "containerFormat": "TS", "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net", "insecureIngest": false, "latencyMode": "LOW", "multitrackInputConfiguration": { "enabled": false, "maximumResolution": "FULL_HD", "policy": "ALLOW" }, "name": "channel-1", "playbackRestrictionPolicyArn": "", "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8", "preset": "", "recordingConfigurationArn": "", "srt": { "endpoint": "a1b2c3d4e5f6.srt.live-video.net", "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ" }, "tags": {} "type": "STANDARD", } } ``` Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*. + Para ver detalhes da API, consulte [GetChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-channel.html) na *Referência de comandos da AWS CLI*. ### `get-playback-key-pair` O código de exemplo a seguir mostra como usar `get-playback-key-pair`. **AWS CLI** **Para obter um par de chaves de reprodução especificado** O exemplo `get-playback-key-pair` a seguir retorna a impressão digital do par de chaves especificado. ``` aws ivs get-playback-key-pair \ --arn arn:aws:ivs:us-west-2:123456789012:playback-key/abcd1234efgh ``` Resultado: ``` { "keyPair": { "arn": "arn:aws:ivs:us-west-2:123456789012:playback-key/abcd1234efgh", "name": "my-playback-key", "fingerprint": "0a:1b:2c:ab:cd:ef:34:56:70:b1:b2:71:01:2a:a3:72", "tags": {} } } ``` Para obter mais informações, consulte [Configuração de canais privados](https://docs.aws.amazon.com/ivs/latest/userguide//private-channels.html) no *Guia do usuário do Amazon Interactive Video Service*. + Para ver detalhes da API, consulte [GetPlaybackKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-playback-key-pair.html) na *Referência de comandos da AWS CLI*. ### `get-playback-restriction-policy` O código de exemplo a seguir mostra como usar `get-playback-restriction-policy`. **AWS CLI** **Para obter as informações de configuração de uma política de restrição de reprodução** O exemplo `get-playback-restriction-policy` a seguir obtém a configuração da política de restrição de reprodução com o ARN (Amazon Resource Name) especificado. ``` aws ivs get-playback-restriction-policy \ --arn "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ" ``` Resultado: ``` { "playbackRestrictionPolicy": { "arn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ", "allowedCountries": [ "US", "MX" ], "allowedOrigins": [ "https://www.website1.com", "https://www.website2.com" ], "enableStrictOriginEnforcement": true, "name": "test-playback-restriction-policy", "tags": { "key1": "value1", "key2": "value2" } } } ``` Para obter mais informações, consulte [Conteúdo e espectadores indesejados](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html) no *Guia do usuário do IVS Low-Latency*. + Para ver detalhes da API, consulte [GetPlaybackRestrictionPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-playback-restriction-policy.html) na *Referência de comandos da AWS CLI*. ### `get-recording-configuration` O código de exemplo a seguir mostra como usar `get-recording-configuration`. **AWS CLI** **Para obter informações sobre um recurso RecordingConfiguration** O exemplo `get-recording-configuration` a seguir obtém informações sobre o recurso RecordingConfiguration com o ARN especificado. ``` aws ivs get-recording-configuration \ --arn "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ" ``` Resultado: ``` { "recordingConfiguration": { "arn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ", "destinationConfiguration": { "s3": { "bucketName": "demo-recording-bucket" } }, "name": "test-recording-config", "recordingReconnectWindowSeconds": 60, "state": "ACTIVE", "tags": { "key1" : "value1", "key2" : "value2" }, "thumbnailConfiguration": { "recordingMode": "INTERVAL", "targetIntervalSeconds": 1, "resolution": "LOWEST_RESOLUTION", "storage": [ "LATEST" ] }, "renditionConfiguration": { "renditionSelection": "CUSTOM", "renditions": [ "HD" ] } } } ``` Para obter mais informações, consulte [Gravar no Amazon S3](https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html) no *Guia de usuário do Amazon Interactive Video Service*. + Para ver detalhes da API, consulte [GetRecordingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-recording-configuration.html) na *Referência de comandos da AWS CLI*. ### `get-stream-key` O código de exemplo a seguir mostra como usar `get-stream-key`. **AWS CLI** **Para obter informações sobre um fluxo** O exemplo `get-stream-key` a seguir obtém as informações sobre a chave de stream especificada. ``` aws ivs get-stream-key \ --arn arn:aws:ivs:us-west-2:123456789012:stream-key/skSKABCDefgh --region=us-west-2 ``` Resultado: ``` { "streamKey": { "arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/skSKABCDefgh", "value": "sk_us-west-2_abcdABCDefgh_567890abcdef", "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "tags": {} } } ``` Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*. + Para ver detalhes da API, consulte [GetStreamKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-stream-key.html) na *Referência de comandos da AWS CLI*. ### `get-stream-session` O código de exemplo a seguir mostra como usar `get-stream-session`. **AWS CLI** **Para obter metadados de um stream especificado** O exemplo de `get-stream-session` a seguir obtém a configuração de metadados para o nome do recurso da Amazon (ARN) de canal especificado e o fluxo especificado. Se o `streamId` não for fornecido, o fluxo mais recente do canal será selecionado. ``` aws ivs get-stream-session \ --channel-arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \ --stream-id 'mystream' ``` Resultado: ``` { "streamSession": { "streamId": "mystream1", "startTime": "2023-06-26T19:09:28+00:00", "channel": { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "name": "mychannel", "latencyMode": "LOW", "type": "STANDARD", "recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ", "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net", "playbackUrl": "url-string", "authorized": false, "insecureIngest": false, "preset": "" }, "ingestConfiguration": { "audio": { "channels": 2, "codec": "mp4a.40.2", "sampleRate": 8000, "targetBitrate": 46875, "track": "Track0" }, "video": { "avcProfile": "Baseline", "avcLevel": "4.2", "codec": "avc1.42C02A", "encoder": "Lavf58.45.100", "level": "4.2", "profile": "Baseline", "targetBitrate": 8789062, "targetFramerate": 60, "track": "Track0", "videoHeight": 1080, "videoWidth": 1920 } }, "ingestConfigurations": { "audioConfigurations": [ { "channels": 2, "codec": "mp4a.40.2", "sampleRate": 8000, "targetBitrate": 46875, "track": "Track0" } ], "videoConfigurations": [ { "codec": "avc1.42C02A", "encoder": "Lavf58.45.100", "level": "4.2", "profile": "Baseline", "targetBitrate": 8789062, "targetFramerate": 60, "track": "Track0", "videoHeight": 1080, "videoWidth": 1920 } ] }, "recordingConfiguration": { "arn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ", "name": "test-recording-config", "destinationConfiguration": { "s3": { "bucketName": "demo-recording-bucket" } }, "state": "ACTIVE", "tags": { "key1": "value1", "key2": "value2" }, "thumbnailConfiguration": { "recordingMode": "INTERVAL", "targetIntervalSeconds": 1, "resolution": "LOWEST_RESOLUTION", "storage": [ "LATEST" ] }, "recordingReconnectWindowSeconds": 60, "renditionConfiguration": { "renditionSelection": "CUSTOM", "renditions": [ "HD" ] } }, "truncatedEvents": [ { "code": "StreamTakeoverInvalidPriority", "name": "Stream Takeover Failure", "type": "IVS Stream State Change", "eventTime": "2023-06-26T19:09:48+00:00" }, { "name": "Stream Takeover", "type": "IVS Stream State Change", "eventTime": "2023-06-26T19:09:47+00:00" }, { "name": "Recording Start", "type": "IVS Recording State Change", "eventTime": "2023-06-26T19:09:35+00:00" }, { "name": "Stream Start", "type": "IVS Stream State Change", "eventTime": "2023-06-26T19:09:34+00:00" }, { "name": "Session Created", "type": "IVS Stream State Change", "eventTime": "2023-06-26T19:09:28+00:00" } ] } } ``` Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*. + Para ver detalhes da API, consulte [GetStreamSession](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-stream-session.html) na *Referência de comandos da AWS CLI*. ### `get-stream` O código de exemplo a seguir mostra como usar `get-stream`. **AWS CLI** **Para obter informações sobre um fluxo** O exemplo `get-stream` a seguir obtém as informações sobre o stream no canal especificado. ``` aws ivs get-stream \ --channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh ``` Resultado: ``` { "stream": { "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8", "startTime": "2020-05-05T21:55:38Z", "state": "LIVE", "health": "HEALTHY", "streamId": "st-ABCDEfghij01234KLMN5678", "viewerCount": 1 } } ``` Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*. + Para ver detalhes da API, consulte [GetStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-stream.html) na *Referência de comandos da AWS CLI*. ### `import-playback-key-pair` O código de exemplo a seguir mostra como usar `import-playback-key-pair`. **AWS CLI** **Para importar a parte pública de um novo par de chaves** O exemplo `import-playback-key-pair` a seguir importa a chave pública especificada (especificada como uma string no formato PEM) e retorna o ARN e a impressão digital do novo par de chaves. ``` aws ivs import-playback-key-pair \ --name "my-playback-key" \ --public-key-material "G1lbnQxOTA3BgNVBAMMMFdoeSBhcmUgeW91IGRl..." ``` Resultado: ``` { "keyPair": { "arn": "arn:aws:ivs:us-west-2:123456789012:playback-key/abcd1234efgh", "name": "my-playback-key", "fingerprint": "0a:1b:2c:ab:cd:ef:34:56:70:b1:b2:71:01:2a:a3:72", "tags": {} } } ``` Para obter mais informações, consulte [Configuração de canais privados](https://docs.aws.amazon.com/ivs/latest/userguide//private-channels.html) no *Guia do usuário do Amazon Interactive Video Service*. + *Para ver detalhes da API, consulte [ImportPlaybackKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/import-playback-key-pair.html) na Referência de comandos da AWS CLI*. ### `list-channels` O código de exemplo a seguir mostra como usar `list-channels`. **AWS CLI** **Exemplo 1: obter informações resumidas sobre todos os canais** O exemplo `list-channels` a seguir lista todos os canais da sua conta da AWS. ``` aws ivs list-channels ``` Resultado: ``` { "channels": [ { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "name": "channel-1", "latencyMode": "LOW", "authorized": false, "insecureIngest": false, "preset": "", "playbackRestrictionPolicyArn": "", "recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh", "tags": {}, "type": "STANDARD" }, { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/efghEFGHijkl", "name": "channel-2", "latencyMode": "LOW", "authorized": false, "preset": "", "playbackRestrictionPolicyArn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ", "recordingConfigurationArn": "", "tags": {}, "type": "STANDARD" } ] } ``` Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*. **Exemplo 2: obter informações resumidas sobre todos os canais, filtradas pelo ARN da RecordingConfiguration especificada** O exemplo `list-channels` a seguir lista todos os canais da sua conta da AWS associados ao ARN da RecordingConfiguration especificada. ``` aws ivs list-channels \ --filter-by-recording-configuration-arn "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh" ``` Resultado: ``` { "channels": [ { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "name": "channel-1", "latencyMode": "LOW", "authorized": false, "insecureIngest": false, "preset": "", "playbackRestrictionPolicyArn": "", "recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh", "tags": {}, "type": "STANDARD" } ] } ``` Para obter mais informações, consulte [Gravar no Amazon S3](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html) no *Guia do usuário do IVS Low-Latency*. **Exemplo 3: obter informações resumidas sobre todos os canais, filtradas pelo ARN da PlaybackRestrictionPolicy especificada** O exemplo `list-channels` a seguir lista todos os canais da sua conta da AWS associados ao ARN da PlaybackRestrictionPolicy especificada. ``` aws ivs list-channels \ --filter-by-playback-restriction-policy-arn "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ" ``` Resultado: ``` { "channels": [ { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/efghEFGHijkl", "name": "channel-2", "latencyMode": "LOW", "authorized": false, "preset": "", "playbackRestrictionPolicyArn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ", "recordingConfigurationArn": "", "tags": {}, "type": "STANDARD" } ] } ``` Para obter mais informações, consulte [Conteúdo e espectadores indesejados](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html) no *Guia do usuário do IVS Low-Latency*. + Consulte detalhes da API em [ListChannels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-channels.html) na *Referência de comandos da AWS CLI*. ### `list-playback-key-pairs` O código de exemplo a seguir mostra como usar `list-playback-key-pairs`. **AWS CLI** **Para obter informações resumidas sobre todos os pares de chaves de reprodução** O exemplo `list-playback-key-pairs` a seguir retorna informações sobre todos os pares de chaves. ``` aws ivs list-playback-key-pairs ``` Resultado: ``` { "keyPairs": [ { "arn": "arn:aws:ivs:us-west-2:123456789012:playback-key/abcd1234efgh", "name": "test-key-0", "tags": {} }, { "arn": "arn:aws:ivs:us-west-2:123456789012:playback-key/ijkl5678mnop", "name": "test-key-1", "tags": {} } ] } ``` Para obter mais informações, consulte [Configuração de canais privados](https://docs.aws.amazon.com/ivs/latest/userguide//private-channels.html) no *Guia do usuário do Amazon Interactive Video Service*. + Para ver detalhes da API, consulte [ListPlaybackKeyPairs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-playback-key-pairs.html) na *Referência de comandos da AWS CLI*. ### `list-playback-restriction-policies` O código de exemplo a seguir mostra como usar `list-playback-restriction-policies`. **AWS CLI** **Para obter informações resumidas sobre todas as políticas de restrição de reprodução** O exemplo `list-playback-restriction-policies` a seguir lista todas as políticas de restrição de reprodução da sua conta da AWS. ``` aws ivs list-playback-restriction-policies ``` Resultado: ``` { "playbackRestrictionPolicies": [ { "arn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ", "allowedCountries": [ "US", "MX" ], "allowedOrigins": [ "https://www.website1.com", "https://www.website2.com" ], "enableStrictOriginEnforcement": true, "name": "test-playback-restriction-policy", "tags": { "key1": "value1", "key2": "value2" } } ] } ``` Para obter mais informações, consulte [Conteúdo e espectadores indesejados](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html) no *Guia do usuário do IVS Low-Latency*. + Para ver detalhes da API, consulte [ListPlaybackRestrictionPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-playback-restriction-policies.html) na *Referência de comandos da AWS CLI*. ### `list-recording-configurations` O código de exemplo a seguir mostra como usar `list-recording-configurations`. **AWS CLI** **Para listar todos os recursos de RecordingConfiguration criados nessa conta** O exemplo `list-recording-configurations` a seguir obtém informações sobre o todos os recursos de RecordingConfiguration em sua conta. ``` aws ivs list-recording-configurations ``` Resultado: ``` { "recordingConfigurations": [ { "arn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ", "name": "test-recording-config-1", "destinationConfiguration": { "s3": { "bucketName": "demo-recording-bucket-1" } }, "state": "ACTIVE", "tags": {} }, { "arn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/CD12abcdGHIJ", "name": "test-recording-config-2", "destinationConfiguration": { "s3": { "bucketName": "demo-recording-bucket-2" } }, "state": "ACTIVE", "tags": {} } ] } ``` Para obter mais informações, consulte [Gravar no Amazon S3](https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html) no *Guia de usuário do Amazon Interactive Video Service*. + Para ver detalhes da API, consulte [ListRecordingConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-recording-configurations.html) na *Referência de comandos da AWS CLI*. ### `list-stream-keys` O código de exemplo a seguir mostra como usar `list-stream-keys`. **AWS CLI** **Para obter uma lista de chaves de stream** O exemplo `list-stream-keys` a seguir lista todas as chaves de stream para o ARN (Amazon Resource Name) especificado. ``` aws ivs list-stream-keys \ --channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh ``` Resultado: ``` { "streamKeys": [ { "arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/abcdABCDefgh", "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "tags": {} } ] } ``` Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no Guia do usuário de *baixa latência do IVS*. + Para ver detalhes da API, consulte [ListStreamKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-stream-keys.html) na *Referência de comandos da AWS CLI*. ### `list-stream-sessions` O código de exemplo a seguir mostra como usar `list-stream-sessions`. **AWS CLI** **Para obter um resumo dos streams atuais e anteriores de um canal específico na região da AWS atual** O exemplo `list-stream-sessions` a seguir relata informações resumidas de streams para um ARN (Amazon Resource Name) do canal especificado. ``` aws ivs list-stream-sessions \ --channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \ --max-results 25 \ --next-token "" ``` Resultado: ``` { "nextToken": "set-2", "streamSessions": [ { "startTime": 1641578182, "endTime": 1641579982, "hasErrorEvent": false, "streamId": "mystream" } ... ] } ``` Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*. + Para ver detalhes da API, consulte [ListStreamSessions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-stream-sessions.html) na *Referência de comandos da AWS CLI*. ### `list-streams` O código de exemplo a seguir mostra como usar `list-streams`. **AWS CLI** **Para obter uma lista de streams ao vivo e seu estado** O exemplo `list-streams` a seguir lista todos streams ao vivo em sua conta da AWS. ``` aws ivs list-streams ``` Resultado: ``` { "streams": [ { "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "state": "LIVE", "health": "HEALTHY", "streamId": "st-ABCDEfghij01234KLMN5678", "viewerCount": 1 } ] } ``` Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*. + Consulte detalhes da API em [ListStreams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-streams.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar todas as tags de um recurso AWS (por exemplo: canal, chave de stream)** O exemplo `list-tags-for-resource` a seguir lista todas as tags do recurso ARN (Amazon Resource Name) especificado. ``` aws ivs list-tags-for-resource \ --resource-arn arn:aws:ivs:us-west-2:12345689012:channel/abcdABCDefgh ``` Resultado: ``` { "tags": { "key1": "value1", "key2": "value2" } } ``` Para obter mais informações, consulte [Tags](https://docs.aws.amazon.com/ivs/latest/APIReference/Welcome.html) na *Referência da API do Amazon Interactive Video Service*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `put-metadata` O código de exemplo a seguir mostra como usar `put-metadata`. **AWS CLI** **Como inserir metadados no stream ativo para um canal especificado** O exemplo `put-metadata` a seguir insere os metadados fornecidos no stream do canal especificado. ``` aws ivs put-metadata \ --channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \ --metadata '{"my": "metadata"}' ``` Este comando não produz saída. Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*. + Para ver detalhes da API, consulte [PutMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/put-metadata.html) na *Referência de comandos da AWS CLI*. ### `start-viewer-session-revocation` O código de exemplo a seguir mostra como usar `start-viewer-session-revocation`. **AWS CLI** **Como revogar sessões de visualizador para vários pares de ARN de canal e ID de visualizador** O exemplo `start-viewer-session-revocation` a seguir inicia o processo de revogação da sessão do visualizador associada a um ARN de canal e ID de visualizador, incluindo até o número da versão de sessão especificada. Se uma versão não for fornecida, o valor padrão será 0. ``` aws ivs batch-start-viewer-session-revocation \ --channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \ --viewer-id abcdefg \ --viewer-session-versions-less-than-or-equal-to 1234567890 ``` Este comando não produz saída. Para obter mais informações, consulte [Configuração de canais privados](https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) no *Guia do usuário do Amazon Interactive Video Service*. + Para ver detalhes da API, consulte [StartViewerSessionRevocation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/start-viewer-session-revocation.html) na *Referência de comandos da AWS CLI*. ### `stop-stream` O código de exemplo a seguir mostra como usar `stop-stream`. **AWS CLI** **Para interromper um stream especificado** O exemplo `stop-stream` a seguir interrompe o stream no canal especificado. ``` aws ivs stop-stream \ --channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh ``` Este comando não produz saída. Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*. + Para ver detalhes da API, consulte [StopStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/stop-stream.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Para adicionar ou atualizar tags de um recurso AWS (por exemplo: canal, chave de stream)** O exemplo `tag-resource` a adiciona ou atualiza as tags do recurso ARN (Amazon Resource Name) especificado. ``` aws ivs tag-resource \ --resource-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \ --tags "tagkey1=tagvalue1, tagkey2=tagvalue2" ``` Este comando não produz saída. Para obter mais informações, consulte [Tags](https://docs.aws.amazon.com/ivs/latest/APIReference/Welcome.html) na *Referência da API do Amazon Interactive Video Service*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover tags de um recurso AWS (por exemplo: canal, chave de stream)** O exemplo `untag-resource` a seguir remove as tags especificadas do recurso ARN (Amazon Resource Name) especificado. ``` aws ivs untag-resource \ --resource-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \ --tag-keys "tagkey1, tagkey2" ``` Este comando não produz saída. Para obter mais informações, consulte [Tags](https://docs.aws.amazon.com/ivs/latest/APIReference/Welcome.html) na *Referência da API do Amazon Interactive Video Service*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-channel` O código de exemplo a seguir mostra como usar `update-channel`. **AWS CLI** **Exemplo 1: obter as informações de configuração de um canal** O exemplo `update-channel` a seguir atualiza a configuração do canal do ARN de canal especificado para alterar o nome do canal. Isso não afeta o stream em andamento neste canal; é necessário interromper e reiniciar o stream para que as alterações sejam aplicadas. ``` aws ivs update-channel \ --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \ --name 'channel-1' \ --insecure-ingest ``` Resultado: ``` { "channel": { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "name": "channel-1", "latencyMode": "LOW", "containerFormat": "TS", "multitrackInputConfiguration": { "enabled": false, "maximumResolution": "FULL_HD", "policy": "ALLOW" }, "type": "STANDARD", "playbackRestrictionPolicyArn": "", "recordingConfigurationArn": "", "srt": { "endpoint": "a1b2c3d4e5f6.srt.live-video.net", "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ" }, "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net", "insecureIngest": true, "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8", "preset": "", "authorized": false, "tags": {} } ``` Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*. **Exemplo 2: atualizar a configuração de um canal para ativar a gravação** O exemplo `update-channel` a seguir atualiza a configuração do canal do ARN de canal especificado para ativar a gravação. Isso não afeta o stream em andamento neste canal; é necessário interromper e reiniciar o stream para que as alterações sejam aplicadas. ``` aws ivs update-channel \ --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \ --no-insecure-ingest \ --recording-configuration-arn 'arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh' ``` Resultado: ``` { "channel": { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "name": "test-channel-with-recording", "latencyMode": "LOW", "containerFormat": "TS", "multitrackInputConfiguration": { "enabled": false, "maximumResolution": "FULL_HD", "policy": "ALLOW" }, "type": "STANDARD", "playbackRestrictionPolicyArn": "", "recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh", "srt": { "endpoint": "a1b2c3d4e5f6.srt.live-video.net", "passphrase": "BA1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ" }, "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net", "insecureIngest": false, "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8", "preset": "", "authorized": false, "tags": {} } } ``` Para obter mais informações, consulte [Gravar no Amazon S3](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html) no *Guia do usuário do IVS Low-Latency*. **Exemplo 3: atualizar a configuração de um canal para desativar a gravação** O exemplo `update-channel` a seguir atualiza a configuração do canal do ARN de canal especificado para desativar a gravação. Isso não afeta o stream em andamento neste canal; é necessário interromper e reiniciar o stream para que as alterações sejam aplicadas. ``` aws ivs update-channel \ --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \ --recording-configuration-arn '' ``` Resultado: ``` { "channel": { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "name": "test-channel-with-recording", "latencyMode": "LOW", "containerFormat": "TS", "multitrackInputConfiguration": { "enabled": false, "maximumResolution": "FULL_HD", "policy": "ALLOW" }, "type": "STANDARD", "playbackRestrictionPolicyArn": "", "recordingConfigurationArn": "", "srt": { "endpoint": "a1b2c3d4e5f6.srt.live-video.net", "passphrase": "AB1C2edfGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ" }, "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net", "insecureIngest": false, "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8", "preset": "", "authorized": false, "tags": {} } } ``` Para obter mais informações, consulte [Gravar no Amazon S3](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html) no *Guia do usuário do IVS Low-Latency*. **Exemplo 4: atualizar a configuração de um canal para ativar a restrição de reprodução** O exemplo `update-channel` a seguir atualiza a configuração do canal do ARN de canal especificado para aplicar uma política de restrição de reprodução. Isso não afeta o stream em andamento neste canal; é necessário interromper e reiniciar o stream para que as alterações sejam aplicadas. ``` aws ivs update-channel \ --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \ --no-insecure-ingest \ --playback-restriction-policy-arn 'arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ' ``` Resultado: ``` { "channel": { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "name": "test-channel-with-playback-restriction-policy", "latencyMode": "LOW", "containerFormat": "TS", "multitrackInputConfiguration": { "enabled": false, "maximumResolution": "FULL_HD", "policy": "ALLOW" }, "type": "STANDARD", "playbackRestrictionPolicyArn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ", "recordingConfigurationArn": "", "srt": { "endpoint": "a1b2c3d4e5f6.srt.live-video.net", "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaCBDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ" }, "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net", "insecureIngest": false, "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8", "preset": "", "authorized": false, "tags": {} } } ``` Para obter mais informações, consulte [Conteúdo e espectadores indesejados](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html) no *Guia do usuário do IVS Low-Latency*. **Exemplo 5: como atualizar a configuração de um canal para desabilitar a restrição de reprodução** O exemplo `update-channel` a seguir atualiza a configuração do canal do ARN de canal especificado para desativar uma política de restrição de reprodução. Isso não afeta o stream em andamento neste canal; é necessário interromper e reiniciar o stream para que as alterações sejam aplicadas. ``` aws ivs update-channel \ --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \ --playback-restriction-policy-arn '' ``` Resultado: ``` { "channel": { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "name": "test-channel-with-playback-restriction-policy", "latencyMode": "LOW", "containerFormat": "TS", "multitrackInputConfiguration": { "enabled": false, "maximumResolution": "FULL_HD", "policy": "ALLOW" }, "type": "STANDARD", "playbackRestrictionPolicyArn": "", "recordingConfigurationArn": "", "srt": { "endpoint": "a1b2c3d4e5f6.srt.live-video.net", "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaBCDeFghh4ijklMN5opqrStuVWxyzAbCDEfghIJ" }, "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net", "insecureIngest": false, "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8", "preset": "", "authorized": false, "tags": {} } } ``` Para obter mais informações, consulte [Conteúdo e espectadores indesejados](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html) no *Guia do usuário do IVS Low-Latency*. **Exemplo 6: como atualizar a configuração de um canal para habilitar o recurso de várias faixas** O exemplo de `update-channel` a seguir atualiza a configuração do canal para o ARN de canal especificado com o objetivo de habilitar o recurso de várias faixas. Isso não afeta o stream em andamento neste canal; é necessário interromper e reiniciar o stream para que as alterações sejam aplicadas. ``` aws ivs update-channel \ --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \ --container-format 'FRAGMENTED_MP4' \ --multitrack-input-configuration '{"enabled": true,"maximumResolution": "FULL_HD","policy": "ALLOW"}' ``` Resultado: ``` { "channel": { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "containerFormat": "FRAGMENTED_MP4", "name": "test-channel-with-multitrack", "latencyMode": "LOW", "multitrackInputConfiguration": { "enabled": true, "maximumResolution": "FULL_HD", "policy": "ALLOW" }, "type": "STANDARD", "playbackRestrictionPolicyArn": "", "recordingConfigurationArn": "", "srt": { "endpoint": "a1b2c3d4e5f6.srt.live-video.net", "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaCBDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ" }, "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net", "insecureIngest": false, "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8", "preset": "", "authorized": false, "tags": {} } } ``` Para obter mais informações, consulte [Conteúdo e espectadores indesejados](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multitrack-video.html) no *Guia do usuário do IVS Low-Latency*. **Exemplo 7: como atualizar a configuração de um canal para desabilitar a restrição de reprodução** O exemplo de `update-channel` a seguir atualiza a configuração do canal para o ARN de canal especificado com o objetivo de desabilitar o recurso de várias faixas. Isso não afeta o stream em andamento neste canal; é necessário interromper e reiniciar o stream para que as alterações sejam aplicadas. ``` aws ivs update-channel \ --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \ --container-format 'TS' \ --multitrack-input-configuration '{"enabled": false}' ``` Resultado: ``` { "channel": { ""arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "containerFormat": "TS", "name": "test-channel-with-multitrack", "latencyMode": "LOW", "multitrackInputConfiguration": { "enabled": false, "maximumResolution": "FULL_HD", "policy": "ALLOW" }, "type": "STANDARD", "playbackRestrictionPolicyArn": "", "recordingConfigurationArn": "", "srt": { "endpoint": "a1b2c3d4e5f6.srt.live-video.net", "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaCBDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ" }, "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net", "insecureIngest": false, "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8", "preset": "", "authorized": false, "tags": {} } } ``` Para obter mais informações, consulte [Conteúdo e espectadores indesejados](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multitrack-video.html) no *Guia do usuário do IVS Low-Latency*. + Para ver detalhes da API, consulte [UpdateChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/update-channel.html) na *Referência de comandos da AWS CLI*. ### `update-playback-restriction-policy` O código de exemplo a seguir mostra como usar `update-playback-restriction-policy`. **AWS CLI** **Para atualizar uma política de restrição de reprodução** O exemplo `update-playback-restriction-policy` a seguir atualiza a política de restrição de reprodução com o ARN da política especificada para desativar a imposição estrita de origem. Isso não afeta o stream contínuo do canal associado; você deverá interromper e reiniciar o stream para que as alterações sejam aplicadas. ``` aws ivs update-playback-restriction-policy \ --arn "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ" \ --no-enable-strict-origin-enforcement ``` Resultado: ``` { "playbackRestrictionPolicy": { "arn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ", "allowedCountries": [ "US", "MX" ], "allowedOrigins": [ "https://www.website1.com", "https://www.website2.com" ], "enableStrictOriginEnforcement": false, "name": "test-playback-restriction-policy", "tags": { "key1": "value1", "key2": "value2" } } } ``` Para obter mais informações, consulte [Conteúdo e espectadores indesejados](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html) no *Guia do usuário do IVS Low-Latency*. + Para ver detalhes da API, consulte [UpdatePlaybackRestrictionPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/update-playback-restriction-policy.html) na *Referência de comandos da AWS CLI*. # Exemplos do Chat do Amazon IVS usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o Chat do Amazon IVS. *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 ### `create-chat-token` O código de exemplo a seguir mostra como usar `create-chat-token`. **AWS CLI** **Para criar um token de chat** O exemplo `create-chat-token` a seguir cria um token de chat criptografado usado para estabelecer uma conexão WebSocket individual com uma sala. O token é válido por um minuto e uma conexão (sessão) estabelecida com o token é válida pela duração especificada. ``` aws ivschat create-chat-token \ --roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6", \ --userId" "11231234" \ --capabilities "SEND_MESSAGE", \ --sessionDurationInMinutes" 30 ``` Resultado: ``` { "token": "ACEGmnoq#1rstu2...BDFH3vxwy!4hlm!#5", "sessionExpirationTime": "2022-03-16T04:44:09+00:00" "state": "CREATING", "tokenExpirationTime": "2022-03-16T03:45:09+00:00" } ``` Para obter mais informações, consulte [Etapa 3: autenticar e autorizar clientes de chat](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) no *Guia do usuário do Amazon Interactive Video Service*. + Para ver detalhes da API, consulte [CreateChatToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/create-chat-token.html) na *Referência de comandos da AWS CLI*. ### `create-logging-configuration` O código de exemplo a seguir mostra como usar `create-logging-configuration`. **AWS CLI** **Para criar um recurso de chat LoggingConfiguration** O exemplo `create-logging-configuration` a seguir cria um recurso LoggingConfiguration que permite aos clientes armazenar e gravar as mensagens enviadas. ``` aws ivschat create-logging-configuration \ --destination-configuration s3={bucketName=demo-logging-bucket} \ --name "test-logging-config" \ --tags "key1=value1, key2=value2" ``` Resultado: ``` { "arn": "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ", "createTime": "2022-09-14T17:48:00.653000+00:00", "destinationConfiguration": { "s3": { "bucketName": "demo-logging-bucket" } }, "id": "ABcdef34ghIJ", "name": "test-logging-config", "state": "ACTIVE", "tags": { "key1" : "value1", "key2" : "value2" }, "updateTime": "2022-09-14T17:48:01.104000+00:00" } ``` Para obter mais informações, consulte [Conceitos básicos do Chat do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) no *Guia do usuário do Amazon Interactive Video Service*. + Para ver detalhes da API, consulte [CreateLoggingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/create-logging-configuration.html) na *Referência de comandos da AWS CLI*. ### `create-room` O código de exemplo a seguir mostra como usar `create-room`. **AWS CLI** **Para criar uma sala** O exemplo `create-room` a seguir cria uma nova sala. ``` aws ivschat create-room \ --name "test-room-1" \ --logging-configuration-identifiers "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" \ --maximum-message-length 256 \ --maximum-message-rate-per-second 5 ``` Resultado: ``` { "arn": "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6", "id": "g1H2I3j4k5L6", "createTime": "2022-03-16T04:44:09+00:00", "loggingConfigurationIdentifiers": ["arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"], "maximumMessageLength": 256, "maximumMessageRatePerSecond": 5, "name": "test-room-1", "tags": {} "updateTime": "2022-03-16T07:22:09+00:00" } ``` Para obter mais informações, consulte [Etapa 2: criar uma sala de chat](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) no *Guia do usuário do Amazon Interactive Video Service*. + Para ver detalhes da API, consulte [CreateRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/create-room.html) na *Referência de comandos da AWS CLI*. ### `delete-logging-configuration` O código de exemplo a seguir mostra como usar `delete-logging-configuration`. **AWS CLI** **Para excluir um recurso de chat LoggingConfiguration** O exemplo `delete-logging-configuration` a seguir exclui o recurso de LoggingConfiguration do ARN especificado. ``` aws ivschat delete-logging-configuration \ --identifier "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" ``` Este comando não produz saída. Para obter mais informações, consulte [Conceitos básicos do Chat do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) no *Guia do usuário do Amazon Interactive Video Service*. + Para ver detalhes da API, consulte [DeleteLoggingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/delete-logging-configuration.html) na *Referência de comandos da AWS CLI*. ### `delete-message` O código de exemplo a seguir mostra como usar `delete-message`. **AWS CLI** **Para excluir mensagens de uma sala especificada** O exemplo `delete-message` a seguir envia um evento para a sala especificada que direciona os clientes a excluírem a mensagem especificada: ou seja, retirá-la da exibição e excluí-la do histórico de chat do cliente. ``` aws ivschat delete-message \ --roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \ --id "ABC123def456" \ --reason "Message contains profanity" ``` Resultado: ``` { "id": "12345689012" } ``` Para obter mais informações, consulte [Conceitos básicos do Chat do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) no *Guia do usuário do Amazon Interactive Video Service*. + Consulte detalhes da API em [DeleteMessage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/delete-message.html) na *Referência de comandos da AWS CLI*. ### `delete-room` O código de exemplo a seguir mostra como usar `delete-room`. **AWS CLI** **Para excluir uma sala** O exemplo `delete-room` a seguir exclui a sala especificada. Os clientes conectados são desconectados. Em caso de sucesso, ele retorna HTTP 204 com um corpo de resposta vazio. ``` aws ivschat delete-room \ --identifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" ``` Este comando não produz saída. Para obter mais informações, consulte [Conceitos básicos do Chat do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) no *Guia do usuário do Amazon Interactive Video Service*. + Para ver detalhes da API, consulte [DeleteRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/delete-room.html) na *Referência de comandos da AWS CLI*. ### `disconnect-user` O código de exemplo a seguir mostra como usar `disconnect-user`. **AWS CLI** **Como desconectar um usuário de uma sala** O exemplo `disconnect-user` a seguir desconecta todas as conexões do usuário especificado da sala especificada. Em caso de sucesso, ele retorna HTTP 200 com um corpo de resposta vazio. ``` aws ivschat disconnect-user \ --roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \ --userId "ABC123def456" \ --reason "Violated terms of service" ``` Este comando não produz saída. Para obter mais informações, consulte [Conceitos básicos do Chat do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) no *Guia do usuário do Amazon Interactive Video Service*. + Para ver detalhes da API, consulte [DisconnectUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/disconnect-user.html) na *Referência de comandos da AWS CLI*. ### `get-logging-configuration` O código de exemplo a seguir mostra como usar `get-logging-configuration`. **AWS CLI** **Para obter informações sobre um recurso LoggingConfiguration** O exemplo `get-logging-configuration` a seguir obtém informações sobre o recurso de LoggingConfiguration do ARN especificado. ``` aws ivschat get-logging-configuration \ --identifier "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" ``` Resultado: ``` { "arn": "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ", "createTime": "2022-09-14T17:48:00.653000+00:00", "destinationConfiguration": { "s3": { "bucketName": "demo-logging-bucket" } }, "id": "ABcdef34ghIJ", "name": "test-logging-config", "state": "ACTIVE", "tags": { "key1" : "value1", "key2" : "value2" }, "updateTime": "2022-09-14T17:48:01.104000+00:00" } ``` Para obter mais informações, consulte [Conceitos básicos do Chat do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) no *Guia do usuário do Amazon Interactive Video Service*. + Para ver detalhes da API, consulte [GetLoggingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/get-logging-configuration.html) na *Referência de comandos da AWS CLI*. ### `get-room` O código de exemplo a seguir mostra como usar `get-room`. **AWS CLI** **Para obter a sala especificada** O exemplo `get-room` a seguir obtém as informações sobre a sala especificada. ``` aws ivschat get-room \ --identifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" ``` Resultado: ``` { "arn": "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6", "createTime": "2022-03-16T04:44:09+00:00", "id": "g1H2I3j4k5L6", "loggingConfigurationIdentifiers": ["arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"], "maximumMessageLength": 256, "maximumMessageRatePerSecond": 5, "name": "test-room-1", "tags": {}, "updateTime": "2022-03-16T07:22:09+00:00" } ``` Para obter mais informações, consulte [Conceitos básicos do Chat do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) no *Guia do usuário do Amazon Interactive Video Service*. + Para ver detalhes da API, consulte [GetRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/get-room.html) na *Referência de comandos da AWS CLI*. ### `list-logging-configurations` O código de exemplo a seguir mostra como usar `list-logging-configurations`. **AWS CLI** **Para obter informações resumidas sobre todas as configurações de log para o usuário na região da AWS em que a solicitação da API é processada** O exemplo `list-logging-configurations` a seguir lista informações sobre todos os recursos da LoggingConfiguration para o usuário na região da AWS onde a solicitação da API é processada. ``` aws ivschat list-logging-configurations \ --max-results 2 \ --next-token "" ``` Resultado: ``` { "nextToken": "set-2", "loggingConfigurations": [ { "arn": "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ", "createTime": "2022-09-14T17:48:00.653000+00:00", "destinationConfiguration": { "s3": { "bucketName": "demo-logging-bucket" } }, "id": "ABcdef34ghIJ", "name": "test-logging-config", "state": "ACTIVE", "tags": { "key1" : "value1", "key2" : "value2" }, "updateTime": "2022-09-14T17:48:01.104000+00:00" } ... ] } ``` Para obter mais informações, consulte [Conceitos básicos do Chat do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) no *Guia do usuário do Amazon Interactive Video Service*. + Para ver detalhes da API, consulte [ListLoggingConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/list-logging-configurations.html) na *Referência de comandos da AWS CLI*. ### `list-rooms` O código de exemplo a seguir mostra como usar `list-rooms`. **AWS CLI** **Para obter informações resumidas sobre todas as suas salas na região atual** O exemplo `list-rooms` a seguir obtém informações resumidas sobre todas as salas na região da AWS em que a solicitação é processada. Os resultados são classificados em ordem decrescente de updateTime. ``` aws ivschat list-rooms \ --logging-configuration-identifier "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" \ --max-results 10 \ --next-token "" ``` Resultado: ``` { "nextToken": "page3", "rooms": [ { "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6", "createTime": "2022-03-16T04:44:09+00:00", "id": "g1H2I3j4k5L6", "loggingConfigurationIdentifiers": ["arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"], "name": "test-room-1", "tags": {}, "updateTime": "2022-03-16T07:22:09+00:00" } ] } ``` Para obter mais informações, consulte [Conceitos básicos do Chat do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) no *Guia do usuário do Amazon Interactive Video Service*. + Para ver detalhes da API, consulte [ListRooms](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/list-rooms.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar todas as tags de um recurso AWS (por exemplo: sala)** O exemplo `list-tags-for-resource` a seguir lista todas as tags do recurso ARN (Amazon Resource Name) especificado. ``` aws ivschat list-tags-for-resource \ --resource-arn arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6 ``` Resultado: ``` { "tags": { "key1": "value1", "key2": "value2" } } ``` Para obter mais informações, consulte [Tags](https://docs.aws.amazon.com/ivs/latest/APIReference/Welcome.html) na *Referência da API do Amazon Interactive Video Service*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `send-event` O código de exemplo a seguir mostra como usar `send-event`. **AWS CLI** **Como enviar um evento para uma sala** O exemplo `send-event` a seguir envia o evento determinado para a sala especificada. ``` aws ivschat send-event \ --roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \ --eventName "SystemMessage" \ --attributes \ "msgType"="user-notification", \ "msgText"="This chat room will close in 15 minutes." ``` Resultado: ``` { "id": "12345689012" } ``` Para obter mais informações, consulte [Conceitos básicos do Chat do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) no *Guia do usuário do Amazon Interactive Video Service*. + Para ver os detalhes da API, consulte [SendEvent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/send-event.html) na *referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Para adicionar ou atualizar tags de um recurso AWS (por exemplo: sala)** O exemplo `tag-resource` a adiciona ou atualiza as tags do recurso ARN (Amazon Resource Name) especificado. Em caso de sucesso, ele retorna HTTP 200 com um corpo de resposta vazio. ``` aws ivschat tag-resource \ --resource-arn arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6 \ --tags "tagkey1=tagkeyvalue1, tagkey2=tagkeyvalue2" ``` Este comando não produz saída. Para obter mais informações, consulte [Tags](https://docs.aws.amazon.com/ivs/latest/APIReference/Welcome.html) na *Referência da API do Amazon Interactive Video Service*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover tags de um recurso AWS (por exemplo: sala)** O exemplo `untag-resource` a seguir remove as tags especificadas do recurso ARN (Amazon Resource Name) especificado. Em caso de sucesso, ele retorna HTTP 200 com um corpo de resposta vazio. ``` aws ivschat untag-resource \ --resource-arn arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6 \ --tag-keys "tagkey1, tagkey2" ``` Este comando não produz saída. Para obter mais informações, consulte [Tags](https://docs.aws.amazon.com/ivs/latest/APIReference/Welcome.html) na *Referência da API do Amazon Interactive Video Service*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-logging-configuration` O código de exemplo a seguir mostra como usar `update-logging-configuration`. **AWS CLI** **Para atualizar uma configuração log de uma sala** O exemplo `update-logging-configuration` a seguir atualiza um recurso LoggingConfiguration com os dados fornecidos. ``` aws ivschat update-logging-configuration \ --destination-configuration s3={bucketName=demo-logging-bucket} \ --identifier "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" \ --name "test-logging-config" ``` Resultado: ``` { "arn": "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ", "createTime": "2022-09-14T17:48:00.653000+00:00", "destinationConfiguration": { "s3": { "bucketName": "demo-logging-bucket" } }, "id": "ABcdef34ghIJ", "name": "test-logging-config", "state": "ACTIVE", "tags": { "key1" : "value1", "key2" : "value2" }, "updateTime": "2022-09-14T17:48:01.104000+00:00" } ``` Para obter mais informações, consulte [Conceitos básicos do Chat do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) no *Guia do usuário do Amazon Interactive Video Service*. + Para ver detalhes da API, consulte [UpdateLoggingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/update-logging-configuration.html) na *Referência de comandos da AWS CLI*. ### `update-room` O código de exemplo a seguir mostra como usar `update-room`. **AWS CLI** **Para atualizar a configuração de uma sala** O exemplo `update-room` a seguir atualiza a configuração da sala especificada com os dados fornecidos. ``` aws ivschat update-room \ --identifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \ --logging-configuration-identifiers "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" \ --name "chat-room-a" \ --maximum-message-length 256 \ --maximum-message-rate-per-second 5 ``` Resultado: ``` { "arn": "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6", "createTime": "2022-03-16T04:44:09+00:00", "id": "g1H2I3j4k5L6", "loggingConfigurationIdentifiers": ["arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"], "maximumMessageLength": 256, "maximumMessageRatePerSecond": 5, "name": "chat-room-a", "tags": {}, "updateTime": "2022-03-16T07:22:09+00:00" } ``` Para obter mais informações, consulte [Conceitos básicos do Chat do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) no *Guia do usuário do Amazon Interactive Video Service*. + Para ver detalhes da API, consulte [UpdateRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/update-room.html) na *Referência de comandos da AWS CLI*. # Exemplos de Streaming em tempo real do Amazon IVS usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o streaming em tempo real do Amazon IVS. *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 ### `create-encoder-configuration` O código de exemplo a seguir mostra como usar `create-encoder-configuration`. **AWS CLI** **Para criar uma configuração de codificador de composição** O exemplo `create-encoder-configuration` a seguir cria um codificador de composição com as propriedades especificadas. ``` aws ivs-realtime create-encoder-configuration \ --name test-ec --video bitrate=3500000,framerate=30.0,height=1080,width=1920 ``` Resultado: ``` { "encoderConfiguration": { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef", "name": "test-ec", "tags": {}, "video": { "bitrate": 3500000, "framerate": 30, "height": 1080, "width": 1920 } } } ``` Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) e *Service Quotas do Amazon IVS*. + Para ver detalhes da API, consulte [CreateEncoderConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/create-encoder-configuration.html) na *Referência de comandos da AWS CLI*. ### `create-ingest-configuration` O código de exemplo a seguir mostra como usar `create-ingest-configuration`. **AWS CLI** **Como criar uma configuração de ingestão** O exemplo de `create-ingest-configuration` a seguir cria uma configuração de ingestão usando o protocolo RTMPS. ``` aws ivs-realtime create-ingest-configuration \ --name ingest1 \ --ingest-protocol rtmps ``` Resultado: ``` { "ingestConfiguration": { "name": "ingest1", "arn": "arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234", "ingestProtocol": "RTMPS", "streamKey": "rt_123456789012_us-west-2_AbCdEfGh1234_abcd1234efgh5678ijkl9012MNOP34", "stageArn": "", "participantId": "xyZ654abC321", "state": "INACTIVE", "userId": "", "tags": {} } } ``` Consulte mais informações em [Ingestão de streams do IVS \$1 Streaming em tempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html) no *Guia do usuário do Amazon Interactive Video Service*. + Consulte detalhes da API em [CreateIngestConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/create-ingest-configuration.html) na *Referência de comandos da AWS CLI*. ### `create-participant-token` O código de exemplo a seguir mostra como usar `create-participant-token`. **AWS CLI** **Para criar um token de participante de palco** O exemplo `create-participant-token` a seguir cria um token de participante para o palco especificado. ``` aws ivs-realtime create-participant-token \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --user-id bob ``` Resultado: ``` { "participantToken": { "expirationTime": "2023-03-07T09:47:43+00:00", "participantId": "ABCDEfghij01234KLMN6789", "token": "abcd1234defg5678" } } ``` Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html) e *Service Quotas do Amazon IVS*. + Para ver detalhes da API, consulte [CreateParticipantToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/create-participant-token.html) na *Referência de comandos da AWS CLI*. ### `create-stage` O código de exemplo a seguir mostra como usar `create-stage`. **AWS CLI** **Exemplo 1: criar um palco** O exemplo `create-stage` a seguir cria um token de participante para o palco especificado. ``` aws ivs-realtime create-stage \ --name stage1 \ --participant-token-configurations userId=alice ``` Resultado: ``` { "participantTokens": [ { "participantId": "ABCDEfghij01234KLMN5678", "token": "a1b2c3d4567890ab", "userId": "alice" } ], "stage": { "activeSessionId": "st-a1b2c3d4e5f6g", "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh", "autoParticipantRecordingConfiguration": { "storageConfigurationArn": "", "mediaTypes": [ "AUDIO_VIDEO" ], "thumbnailConfiguration": { "targetIntervalSeconds": 60, "storage": [ "SEQUENTIAL" ], "recordingMode": "DISABLED" }, "recordingReconnectWindowSeconds": 0, "hlsConfiguration": { "targetSegmentDurationSeconds": 6 }, "recordParticipantReplicas": true }, "endpoints": { "events": "wss://global.events.live-video.net", "rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/", "rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/", "whip": "https://9x0y8z7s6t5u.global-bm.whip.live-video.net" }, "name": "stage1", "tags": {} } } ``` Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*. **Exemplo 2: criar um estágio e configurar a gravação de participantes individuais** O exemplo `create-stage` a seguir cria um palco e a configura a gravação individual do participante. ``` aws ivs-realtime create-stage \ --name stage1 \ --auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", "recordingReconnectWindowSeconds": 100, \ "hlsConfiguration": {"targetSegmentDurationSeconds": 5}}' ``` Resultado: ``` { "stage": { "activeSessionId": "st-a1b2c3d4e5f6g", "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh", "autoParticipantRecordingConfiguration": { "storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh" "mediaTypes": [ "AUDIO_VIDEO" ], "thumbnailConfiguration": { "targetIntervalSeconds": 60, "storage": [ "SEQUENTIAL" ], "recordingMode": "DISABLED" }, "recordingReconnectWindowSeconds": 100, "hlsConfiguration": { "targetSegmentDurationSeconds": 5 }, "recordParticipantReplicas": true }, "endpoints": { "events": "wss://global.events.live-video.net", "rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/", "rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/", "whip": "https://9x0y8z7s6t5u.global-bm.whip.live-video.net" }, "name": "stage1", "tags": {} } } ``` Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*. **Exemplo 3: criar um estágio e configurar a gravação de participantes individuais com a gravação de miniatura habilitada** O exemplo de `create-stage` a seguir cria um estágio e configura a gravação individual do participante com a gravação de miniatura habilitada. ``` aws ivs-realtime create-stage \ --name stage1 \ --auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", \ "thumbnailConfiguration": {"recordingMode": "INTERVAL","storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}}' ``` Resultado: ``` { "stage": { "activeSessionId": "st-a1b2c3d4e5f6g", "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh", "autoParticipantRecordingConfiguration": { "storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", "mediaTypes": [ "AUDIO_VIDEO" ], "thumbnailConfiguration": { "targetIntervalSeconds": 60, "storage": [ "SEQUENTIAL" ], "recordingMode": "INTERVAL" }, "recordingReconnectWindowSeconds": 0, "hlsConfiguration": { "targetSegmentDurationSeconds": 6 }, "recordParticipantReplicas": true }, "endpoints": { "events": "wss://global.events.live-video.net", "rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/", "rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/", "whip": "https://9x0y8z7s6t5u.global-bm.whip.live-video.net" }, "name": "stage1", "tags": {} } } ``` Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*. + Para ver detalhes da API, consulte [CreateStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/create-stage.html) na *Referência de comandos da AWS CLI*. ### `create-storage-configuration` O código de exemplo a seguir mostra como usar `create-storage-configuration`. **AWS CLI** **Para criar uma configuração de armazenamento de composição** O exemplo `create-storage-configuration` a seguir cria uma configuração de armazenamento de composição com as propriedades especificadas. ``` aws ivs-realtime create-storage-configuration \ --name "test-sc" --s3 "bucketName=amzn-s3-demo-bucket" ``` Resultado: ``` { "storageConfiguration": { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABabCDcdEFef", "name": "test-sc", "s3": { "bucketName": "amzn-s3-demo-bucket" }, "tags": {} } } ``` Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) e *Service Quotas do Amazon IVS*. + Para ver detalhes da API, consulte [CreateStorageConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/create-storage-configuration.html) na *Referência de comandos da AWS CLI*. ### `delete-encoder-configuration` O código de exemplo a seguir mostra como usar `delete-encoder-configuration`. **AWS CLI** **Para excluir uma configuração de codificador de composição** O seguinte `delete-encoder-configuration` exclui a configuração do codificador de composição especificada pelo ARN (Amazon Resource Name) fornecido. ``` aws ivs-realtime delete-encoder-configuration \ --arn "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" ``` Este comando não produz saída. Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) e *Service Quotas do Amazon IVS*. + Para ver detalhes da API, consulte [DeleteEncoderConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/delete-encoder-configuration.html) na *Referência de comandos da AWS CLI*. ### `delete-ingest-configuration` O código de exemplo a seguir mostra como usar `delete-ingest-configuration`. **AWS CLI** **Exemplo 1: como excluir uma configuração de ingestão inativa** O exemplo de `delete-ingest-configuration` a seguir exclui a configuração de ingestão inativa para um nome de recurso da Amazon (ARN) de configuração de ingestão especificado. ``` aws ivs-realtime delete-ingest-configuration \ --arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234 ``` Este comando não produz saída. Consulte mais informações em [Ingestão de streams do IVS \$1 Streaming em tempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html) no *Guia do usuário do Amazon Interactive Video Service*. **Exemplo 2: como forçar a exclusão de uma configuração de ingestão inativa** O exemplo de `delete-ingest-configuration` a seguir força a exclusão da configuração de ingestão ativa para um nome de recurso da Amazon (ARN) de configuração de ingestão especificado. ``` aws ivs-realtime delete-ingest-configuration \ --arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234 \ --force ``` Este comando não produz saída. Consulte mais informações em [Ingestão de streams do IVS \$1 Streaming em tempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html) no *Guia do usuário do Amazon Interactive Video Service*. + Consulte detalhes da API em [DeleteIngestConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/delete-ingest-configuration.html) na *Referência de comandos da AWS CLI*. ### `delete-public-key` O código de exemplo a seguir mostra como usar `delete-public-key`. **AWS CLI** **Para excluir uma chave pública** O exemplo `delete-public-key` a seguir exclui a chave pública especificada. ``` aws ivs-realtime delete-public-key \ --arn arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2 ``` Este comando não produz saída. Para obter mais informações, consulte [Distribuir tokens de participantes](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html) no *Guia do usuário de streaming em tempo real do Amazon IVS*. + Para ver detalhes da API, consulte [DeletePublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/delete-public-key.html) na *Referência de comandos da AWS CLI*. ### `delete-stage` O código de exemplo a seguir mostra como usar `delete-stage`. **AWS CLI** **Para excluir uma estágio** O exemplo `delete-stage` a seguir exclui o palco especificado. ``` aws ivs-realtime delete-stage \ --arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh ``` Este comando não produz saída. Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html) e *Service Quotas do Amazon IVS*. + Para ver detalhes da API, consulte [DeleteStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/delete-stage.html) na *Referência de comandos da AWS CLI*. ### `delete-storage-configuration` O código de exemplo a seguir mostra como usar `delete-storage-configuration`. **AWS CLI** **Para excluir uma configuração de armazenamento de composição** O seguinte `delete-storage-configuration` exclui a configuração de armazenamento de composição especificada pelo ARN (Amazon Resource Name) fornecido. ``` aws ivs-realtime delete-storage-configuration \ --arn "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABabCDcdEFef" ``` Este comando não produz saída. Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) e *Service Quotas do Amazon IVS*. + Para ver detalhes da API, consulte [DeleteStorageConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/delete-storage-configuration.html) na *Referência de comandos da AWS CLI*. ### `disconnect-participant` O código de exemplo a seguir mostra como usar `disconnect-participant`. **AWS CLI** **Como desconectar um participante do palco** O exemplo `disconnect-participant` a seguir desconecta o participante especificado do palco especificada. ``` aws ivs-realtime disconnect-participant \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --participant-id ABCDEfghij01234KLMN5678 ``` Este comando não produz saída. Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html) e *Service Quotas do Amazon IVS*. + Para ver detalhes da API, consulte [DisconnectParticipant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/disconnect-participant.html) na *Referência de comandos da AWS CLI*. ### `get-composition` O código de exemplo a seguir mostra como usar `get-composition`. **AWS CLI** **Exemplo 1: obter uma composição com configurações de layout padrão** O exemplo `get-composition` a seguir obtém a composição do ARN (Amazon Resource Name) especificado. ``` aws ivs-realtime get-composition \ --arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh" ``` Resultado: ``` { "composition": { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh", "destinations": [ { "configuration": { "channel": { "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" }, "name": "" }, "id": "AabBCcdDEefF", "startTime": "2023-10-16T23:26:00+00:00", "state": "ACTIVE" }, { "configuration": { "name": "", "s3": { "encoderConfigurationArns": [ "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" ], "recordingConfiguration": { "format": "HLS", "hlsConfiguration": { "targetSegmentDurationSeconds": 2 } }, "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE", } }, "detail": { "s3": { "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite" } }, "id": "GHFabcgefABC", "startTime": "2023-10-16T23:26:00+00:00", "state": "STARTING" } ], "layout": { "grid": { "featuredParticipantAttribute": "", "gridGap": 2, "omitStoppedVideo": false, "participantOrderAttribute": "", "videoAspectRatio": "VIDEO", "videoFillMode": "" } }, "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd", "startTime": "2023-10-16T23:24:00+00:00", "state": "ACTIVE", "tags": {} } } ``` Para ter mais informações, consulte [Gravação composta do IVS \$1 Streaming em tempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html) no *Guia do usuário do Amazon Interactive Video Service*. **Exemplo 2: obter uma composição com layout PiP** O exemplo `get-composition` a seguir obtém a composição do ARN (Amazon Resource Name) especificado, usando o layout PiP. ``` aws ivs-realtime get-composition \ --arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/wxyzWXYZpqrs" ``` Resultado: ``` { "composition": { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/wxyzWXYZpqrs", "destinations": [ { "configuration": { "channel": { "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" }, "name": "" }, "id": "AabBCcdDEefF", "startTime": "2023-10-16T23:26:00+00:00", "state": "ACTIVE" }, { "configuration": { "name": "", "s3": { "encoderConfigurationArns": [ "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" ], "recordingConfiguration": { "format": "HLS", "hlsConfiguration": { "targetSegmentDurationSeconds": 2 } }, "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE" } }, "detail": { "s3": { "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite" } }, "id": "GHFabcgefABC", "startTime": "2023-10-16T23:26:00+00:00", "state": "STARTING" } ], "layout": { "pip": { "featuredParticipantAttribute": "abcdefg", "gridGap": 0, "omitStoppedVideo": false, "participantOrderAttribute": "", "pipBehavior": "STATIC", "pipOffset": 0, "pipParticipantAttribute": "", "pipPosition": "BOTTOM_RIGHT", "videoFillMode": "COVER" } }, "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd", "startTime": "2023-10-16T23:24:00+00:00", "state": "ACTIVE", "tags": {} } } ``` Para ter mais informações, consulte [Gravação composta do IVS \$1 Streaming em tempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html) no *Guia do usuário do Amazon Interactive Video Service*. **Exemplo 3: como obter uma composição com a gravação de miniatura habilitada** O exemplo de `get-composition` a seguir obtém a composição para o ARN (nome do recurso da Amazon) especificado, que tem a gravação de miniatura habilitada com as configurações padrão. ``` aws ivs-realtime get-composition \ --arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh" ``` Resultado: ``` { "composition": { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh", "destinations": [ { "configuration": { "channel": { "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" }, "name": "" }, "id": "AabBCcdDEefF", "startTime": "2023-10-16T23:26:00+00:00", "state": "ACTIVE" }, { "configuration": { "name": "", "s3": { "encoderConfigurationArns": [ "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" ], "recordingConfiguration": { "format": "HLS", "hlsConfiguration": { "targetSegmentDurationSeconds": 2 } }, "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE", "thumbnailConfigurations": [ { "targetIntervalSeconds": 60, "storage": [ "SEQUENTIAL" ], } ] } }, "detail": { "s3": { "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite" } }, "id": "GHFabcgefABC", "startTime": "2023-10-16T23:26:00+00:00", "state": "STARTING" } ], "layout": { "grid": { "featuredParticipantAttribute": "" "gridGap": 2, "omitStoppedVideo": false, "participantOrderAttribute": "", "videoAspectRatio": "VIDEO", "videoFillMode": "" } }, "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd", "startTime": "2023-10-16T23:24:00+00:00", "state": "ACTIVE", "tags": {} } } ``` Para ter mais informações, consulte [Gravação composta do IVS \$1 Streaming em tempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html) no *Guia do usuário do Amazon Interactive Video Service*. + Para ver detalhes da API, consulte [GetComposition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-composition.html) na *Referência de comandos da AWS CLI*. ### `get-encoder-configuration` O código de exemplo a seguir mostra como usar `get-encoder-configuration`. **AWS CLI** **Para obter uma configuração de codificador de composição** O exemplo `get-encoder-configuration` a seguir obtém a configuração do codificador de composição especificada pelo ARN (Amazon Resource Name) fornecido. ``` aws ivs-realtime get-encoder-configuration \ --arn "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/abcdABCDefgh" ``` Resultado: ``` { "encoderConfiguration": { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/abcdABCDefgh", "name": "test-ec", "tags": {}, "video": { "bitrate": 3500000, "framerate": 30, "height": 1080, "width": 1920 } } } ``` Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) e *Service Quotas do Amazon IVS*. + Para ver detalhes da API, consulte [GetEncoderConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-encoder-configuration.html) na *Referência de comandos da AWS CLI*. ### `get-ingest-configuration` O código de exemplo a seguir mostra como usar `get-ingest-configuration`. **AWS CLI** **Como obter informações de configuração de ingestão** O exemplo de `get-ingest-configuration` a seguir obtém a configuração de ingestão para um nome de recurso da Amazon (ARN) de configuração de ingestão especificado. ``` aws ivs-realtime get-ingest-configuration \ --arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234 ``` Resultado: ``` { "ingestConfiguration": { "name": "ingest1", "arn": "arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234", "ingestProtocol": "RTMPS", "streamKey": "rt_123456789012_us-west-2_AbCdEfGh1234_abcd1234efgh5678ijkl9012MNOP34", "stageArn": "", "participantId": "xyZ654abC321", "state": "INACTIVE", "userId": "", "tags": {} } } ``` Consulte mais informações em [Ingestão de streams do IVS \$1 Streaming em tempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html) no *Guia do usuário do Amazon Interactive Video Service*. + Consulte detalhes da API em [GetIngestConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-ingest-configuration.html) na *Referência de comandos da AWS CLI*. ### `get-participant` O código de exemplo a seguir mostra como usar `get-participant`. **AWS CLI** **Exemplo 1: obter um participante do palco** O exemplo `get-participant` a seguir obtém o participante do palco para um ID de participante e ID de sessão especificados no ARN (Amazon Resource Name) especificado do estágio. ``` aws ivs-realtime get-participant \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g \ --participant-id abCDEf12GHIj ``` Resultado: ``` { "participant": { "browserName": "Google Chrome", "browserVersion": "116", "firstJoinTime": "2023-04-26T20:30:34+00:00", "ispName": "Comcast", "osName": "Microsoft Windows 10 Pro", "osVersion": "10.0.19044", "participantId": "abCDEf12GHIj", "published": true, "recordingS3BucketName": "bucket-name", "recordingS3Prefix": "abcdABCDefgh/st-a1b2c3d4e5f6g/abCDEf12GHIj/1234567890", "recordingState": "ACTIVE", "sdkVersion": "", "state": "CONNECTED", "userId": "" } } ``` Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*. **Exemplo 2: obter um participante do palco que foi replicado para outro palco** O exemplo `get-participant` a seguir obtém o participante do palco para um ID de participante e ID de sessão especificados no nome do recurso da Amazon (ARN) especificado do palco, quando o participante também foi replicado para outro palco. ``` aws ivs-realtime get-participant \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g \ --participant-id abCDEf12GHIj ``` Resultado: ``` { "participant": { "browserName": "Google Chrome", "browserVersion": "116", "firstJoinTime": "2023-04-26T20:30:34+00:00", "ispName": "Comcast", "osName": "Microsoft Windows 10 Pro", "osVersion": "10.0.19044", "participantId": "abCDEf12GHIj", "published": true, "recordingS3BucketName": "bucket-name", "recordingS3Prefix": "abcdABCDefgh/st-a1b2c3d4e5f6g/abCDEf12GHIj/1234567890", "recordingState": "ACTIVE", "replicationState": "ACTIVE", "replicationType": "SOURCE", "sdkVersion": "", "state": "CONNECTED", "userId": "" } } ``` Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*. **Exemplo 3: obter um participante do palco que foi replicado para outro palco** O exemplo `get-participant` a seguir obtém o participante do palco para um ID de participante e ID de sessão especificados no nome do recurso da Amazon (ARN) especificado do palco, quando o participante foi replicado de outro palco. ``` aws ivs-realtime get-participant \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g \ --participant-id abCDEf12GHIj ``` Resultado: ``` { "participant": { "browserName": "Google Chrome", "browserVersion": "116", "firstJoinTime": "2023-04-26T20:30:34+00:00", "ispName": "Comcast", "osName": "Microsoft Windows 10 Pro", "osVersion": "10.0.19044", "participantId": "abCDEf12GHIj", "published": true, "recordingS3BucketName": "bucket-name", "recordingS3Prefix": "abcdABCDefgh/st-a1b2c3d4e5f6g/abCDEf12GHIj/1234567890", "recordingState": "ACTIVE", "replicationState": "ACTIVE", "replicationType": "REPLICA", "sdkVersion": "", "state": "CONNECTED", "userId": "" } } ``` Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*. + Para ver detalhes da API, consulte [GetParticipant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-participant.html) na *Referência de comandos da AWS CLI*. ### `get-public-key` O código de exemplo a seguir mostra como usar `get-public-key`. **AWS CLI** **Para obter uma chave pública existente usada para assinar tokens de participantes do palco** O exemplo `get-public-key` a seguir obtém uma chave pública especificada pelo ARN fornecido para assinar tokens de participantes do palco. ``` aws ivs-realtime get-public-key \ --arn arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2 ``` Resultado: ``` { "publicKey": { "arn": "arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2", "name": "", "publicKeyMaterial": "-----BEGIN PUBLIC KEY-----\nMHYwEAYHKoZIzj0CAQYFK4EEACIDYgAEqVWUtqs6EktQMR1sCYmEzGvRwtaycI16\n9pmzcpiWu/uhNStGlteJ5odRfRwVkoQUMnSZXTCcbn9bBTTmiWo4mJcFOOAzsthH\n0UAb8NdD4tUE0At4a9hYP9IETEXAMPLE\n-----END PUBLIC KEY-----", "fingerprint": "12:a3:44:56:bc:7d:e8:9f:10:2g:34:hi:56:78:90:12", "tags": {} } } ``` Para obter mais informações, consulte [Distribuir tokens de participantes](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html) no *Guia do usuário de streaming em tempo real do Amazon IVS*. + Para ver detalhes da API, consulte [GetPublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-public-key.html) na *Referência de comandos da AWS CLI*. ### `get-stage-session` O código de exemplo a seguir mostra como usar `get-stage-session`. **AWS CLI** **Para obter uma sessão de palco** O exemplo `get-stage-session` a seguir obtém a sessão de palco para um ID de sessão especificados no ARN (Amazon Resource Name) do palco especificado. ``` aws ivs-realtime get-stage-session \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g ``` Resultado: ``` { "stageSession": { "endTime": "2023-04-26T20:36:29+00:00", "sessionId": "st-a1b2c3d4e5f6g", "startTime": "2023-04-26T20:30:29.602000+00:00" } } ``` Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html) e *Service Quotas do Amazon IVS*. + Para ver detalhes da API, consulte [GetStageSession](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-stage-session.html) na *Referência de comandos da AWS CLI*. ### `get-stage` O código de exemplo a seguir mostra como usar `get-stage`. **AWS CLI** **Para obter as informações de configuração de um palco** O exemplo `get-stage` a seguir obtém a configuração de palco para um ARN (Amazon Resource Name) especificado. ``` aws ivs-realtime get-stage \ --arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh ``` Resultado: ``` { "stage": { "activeSessionId": "st-a1b2c3d4e5f6g", "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh", "autoParticipantRecordingConfiguration": { "storageConfigurationArn": "", "mediaTypes": [ "AUDIO_VIDEO" ], "thumbnailConfiguration": { "targetIntervalSeconds": 60, "storage": [ "SEQUENTIAL" ], "recordingMode": "DISABLED" }, "recordingReconnectWindowSeconds": 0, "hlsConfiguration": { "targetSegmentDurationSeconds": 6 }, "recordParticipantReplicas": true }, "endpoints": { "events": "wss://global.events.live-video.net", "rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/", "rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/", "whip": "https://9x0y8z7s6t5u.global-bm.whip.live-video.net" }, "name": "test", "tags": {} } } ``` Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*. + Para ver detalhes da API, consulte [GetStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-stage.html) na *Referência de comandos da AWS CLI*. ### `get-storage-configuration` O código de exemplo a seguir mostra como usar `get-storage-configuration`. **AWS CLI** **Para obter uma configuração de armazenamento de composição** O exemplo `get-storage-configuration` a seguir obtém a configuração de armazenamento da composição especificada pelo ARN (Amazon Resource Name) fornecido. ``` aws ivs-realtime get-storage-configuration \ --name arn "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh" ``` Resultado: ``` { "storageConfiguration": { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh", "name": "test-sc", "s3": { "bucketName": "amzn-s3-demo-bucket" }, "tags": {} } } ``` Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) e *Service Quotas do Amazon IVS*. + Para ver detalhes da API, consulte [GetStorageConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-storage-configuration.html) na *Referência de comandos da AWS CLI*. ### `import-public-key` O código de exemplo a seguir mostra como usar `import-public-key`. **AWS CLI** **Para importar uma chave pública existente usada para assinar tokens de participantes do palco** O exemplo `import-public-key` a seguir importa uma chave pública de um arquivo de material, para ser usada para assinar tokens de participantes do palco. ``` aws ivs-realtime import-public-key \ --public-key-material="`cat public.pem`" ``` Resultado: ``` { "publicKey": { "arn": "arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2", "name": "", "publicKeyMaterial": "-----BEGIN PUBLIC KEY-----\nMHYwEAYHKoZIzj0CAQYFK4EEACIDYgAEqVWUtqs6EktQMR1sCYmEzGvRwtaycI16\n9pmzcpiWu/uhNStGlteJ5odRfRwVkoQUMnSZXTCcbn9bBTTmiWo4mJcFOOAzsthH\n0UAb8NdD4tUE0At4a9hYP9IETEXAMPLE\n-----END PUBLIC KEY-----", "fingerprint": "12:a3:44:56:bc:7d:e8:9f:10:2g:34:hi:56:78:90:12", "tags": {} } } ``` Para obter mais informações, consulte [Distribuir tokens de participantes](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html) no *Guia do usuário de streaming em tempo real do Amazon IVS*. + Para ver detalhes da API, consulte [ImportPublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/import-public-key.html) na *Referência de comandos da AWS CLI*. ### `list-compositions` O código de exemplo a seguir mostra como usar `list-compositions`. **AWS CLI** **Para obter uma lista de composições** O seguinte `list-compositions` lista todas as composições da sua conta da AWS, na região da AWS em que a solicitação da API é processada. ``` aws ivs-realtime list-compositions ``` Resultado: ``` { "compositions": [ { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh", "destinations": [ { "id": "AabBCcdDEefF", "startTime": "2023-10-16T23:25:23+00:00", "state": "ACTIVE" } ], "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd", "startTime": "2023-10-16T23:25:21+00:00", "state": "ACTIVE", "tags": {} }, { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/ABcdabCDefgh", "destinations": [ { "endTime": "2023-10-16T23:25:00.786512+00:00", "id": "aABbcCDdeEFf", "startTime": "2023-10-16T23:24:01+00:00", "state": "STOPPED" }, { "endTime": "2023-10-16T23:25:00.786512+00:00", "id": "deEFfaABbcCD", "startTime": "2023-10-16T23:24:01+00:00", "state": "STOPPED" } ], "endTime": "2023-10-16T23:25:00+00:00", "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/efghabcdABCD", "startTime": "2023-10-16T23:24:00+00:00", "state": "STOPPED", "tags": {} } ] } ``` Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) e *Service Quotas do Amazon IVS*. + Para ver detalhes da API, consulte [ListCompositions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-compositions.html) na *Referência de comandos da AWS CLI*. ### `list-encoder-configurations` O código de exemplo a seguir mostra como usar `list-encoder-configurations`. **AWS CLI** **Para listar as configurações do codificador de composição** O seguinte `list-encoder-configurations` lista todas as configurações do codificador de composição da sua conta da AWS, na região da AWS em que a solicitação da API é processada. ``` aws ivs-realtime list-encoder-configurations ``` Resultado: ``` { "encoderConfigurations": [ { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/abcdABCDefgh", "name": "test-ec-1", "tags": {} }, { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABCefgEFGabc", "name": "test-ec-2", "tags": {} } ] } ``` Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) e *Service Quotas do Amazon IVS*. + Para ver detalhes da API, consulte [ListEncoderConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-encoder-configurations.html) na *Referência de comandos da AWS CLI*. ### `list-ingest-configurations` O código de exemplo a seguir mostra como usar `list-ingest-configurations`. **AWS CLI** **Como obter informações de resumo sobre todas as configurações de ingestão** O exemplo de `list-ingest-configurations` a seguir lista todas as configurações de ingestão da sua conta da AWS, na região da AWS em que a solicitação de API é processada. ``` aws ivs-realtime list-ingest-configurations ``` Resultado: ``` { "ingestConfigurations": [ { "name": "", "arn": "arn:aws:ivs:us-west-2:123456789012:ingest-configuration/XYZuvwSt4567", "ingestProtocol": "RTMPS", "stageArn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh", "participnatId": "abC789Xyz456", "state": "INACTIVE" "userId": "", } ] } ``` Consulte mais informações em [Ingestão de streams do IVS \$1 Streaming em tempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html) no *Guia do usuário do Amazon Interactive Video Service*. + Consulte detalhes da API em [ListIngestConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-ingest-configurations.html) na *Referência de comandos da AWS CLI*. ### `list-participant-events` O código de exemplo a seguir mostra como usar `list-participant-events`. **AWS CLI** **Exemplo 1: obter uma lista de eventos de participantes do palco** O exemplo `list-participant-events` a seguir lista todos os eventos de participantes para um ID de participante e ID de sessão especificados no ARN (Amazon Resource Name) especificado do estágio. ``` aws ivs-realtime list-participant-events \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g \ --participant-id abCDEf12GHIj ``` Resultado: ``` { "events": [ { "eventTime": "2023-04-26T20:36:28+00:00", "name": "LEFT", "participantId": "abCDEf12GHIj" }, { "eventTime": "2023-04-26T20:36:28+00:00", "name": "PUBLISH_STOPPED", "participantId": "abCDEf12GHIj" }, { "eventTime": "2023-04-26T20:30:34+00:00", "name": "JOINED", "participantId": "abCDEf12GHIj" }, { "eventTime": "2023-04-26T20:30:34+00:00", "name": "PUBLISH_STARTED", "participantId": "abCDEf12GHIj" } ] } ``` Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*. **Exemplo 2: obter uma lista de eventos de participantes do palco, bem como interromper e iniciar a replicação de participantes** O exemplo `list-participant-events` a seguir lista todos os eventos de participantes para um ID de sessão especificado do nome do recurso da Amazon (ARN) especificado do palco, em que um participante é replicado para outro palco. ``` aws ivs-realtime list-participant-events \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g \ --participant-id abCDEf12GHIj ``` Resultado: ``` { "events": [ { "eventTime": "2025-04-26T20:36:28+00:00", "name": "LEFT", "participantId": "abCDEf12GHIj" }, { "eventTime": "2025-04-26T20:36:28+00:00", "name": "PUBLISH_STOPPED", "participantId": "abCDEf12GHIj" }, { "eventTime": "2025-04-26T20:30:34+00:00", "name": "JOINED", "participantId": "abCDEf12GHIj" }, { "eventTime": "2025-04-26T20:30:34+00:00", "name": "PUBLISH_STARTED", "participantId": "abCDEf12GHIj" }, { "name": "REPLICATION_STARTED", "participantId": "abCDEf12GHIj", "eventTime": "2025-04-26T20:30:34+00:00", "destinationStageArn": "arn:aws:ivs:us-west-2:12345678901:stage/ABCDabcdefgh", "destinationSessionId": "st-b1c2d3e4f5g6a" }, { "name": "REPLICATION_STOPPED", "participantId": "abCDEf12GHIj", "eventTime": "2025-04-26T20:32:34+00:00", "destinationStageArn": "arn:aws:ivs:us-west-2:12345678901:stage/ABCDabcdefgh", "destinationSessionId": "st-b1c2d3e4f5g6a" } ] } ``` Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*. + Para ver detalhes da API, consulte [ListParticipantEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-participant-events.html) na *Referência de comandos da AWS CLI*. ### `list-participant-replicas` O código de exemplo a seguir mostra como usar `list-participant-replicas`. **AWS CLI** **Como obter uma lista de réplicas de participantes do palco** O exemplo `list-participant-replicas` a seguir lista todos os participantes do palco replicados do nome do recurso da Amazon (ARN) do palco de origem especificado para outro palco. ``` aws ivs-realtime list-participant-replicas \ --source-stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --participant-id abCDEf12GHIj ``` Resultado: ``` { "replicas": [ { "sourceStageArn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh", "participantId": "abCDEf12GHIj", "sourceSessionId": "st-a1b2c3d4e5f6g", "destinationStageArn": "arn:aws:ivs:us-west-2:012345678901:stage/ABCDabcdefgh", "destinationSessionId": "st-b1c2d3e4f5g6a", "replicationState": "ACTIVE" } ] } ``` Para ter mais informações, consulte [Replicação de participantes do IVS](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-participant-replication.html) no *Guia do usuário do streaming em tempo real do Amazon IVS*. + Para ver detalhes da API, consulte [ListParticipantReplicas](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-participant-replicas.html) na *Referência de comandos da AWS CLI*. ### `list-participants` O código de exemplo a seguir mostra como usar `list-participants`. **AWS CLI** **Exemplo 1: obter uma lista de participantes do palco** O exemplo `list-participants` a seguir lista todos os participantes para um ID de sessão especificado no ARN (Amazon Resource Name) do palco especificado. ``` aws ivs-realtime list-participants \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g ``` Resultado: ``` { "participants": [ { "firstJoinTime": "2023-04-26T20:30:34+00:00", "participantId": "abCDEf12GHIj", "published": true, "recordingState": "STOPPED", "state": "DISCONNECTED", "userId": "" } ] } ``` Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*. **Exemplo 2: obter uma lista de participantes do palco, quando um participante foi replicado para outro palco** O exemplo `list-participants` a seguir lista todos os participantes para um ID de sessão especificado de um nome do recurso da Amazon (ARN), quando um participante foi replicado para outro palco. ``` aws ivs-realtime list-participants \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g ``` Resultado: ``` { "participants": [ { "firstJoinTime": "2023-04-26T20:30:34+00:00", "participantId": "abCDEf12GHIj", "published": true, "recordingState": "STOPPED", "state": "DISCONNECTED", "userId": "", "replicationState": "ACTIVE", "replicationType": "SOURCE", "sourceStageArn": "", "sourceSessionId": "" } ] } ``` Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*. **Exemplo 3: obter uma lista de participantes do palco, quando um participante foi replicado de outro palco** O exemplo `list-participants` a seguir lista todos os participantes para um ID de sessão especificado de um nome do recurso da Amazon (ARN), quando um participante foi replicado de outro palco. ``` aws ivs-realtime list-participants \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g ``` Resultado: ``` { "participants": [ { "firstJoinTime": "2023-04-26T20:30:34+00:00", "participantId": "abCDEf12GHIj", "published": true, "recordingState": "STOPPED", "state": "DISCONNECTED", "userId": "", "replicationState": "ACTIVE", "replicationType": "REPLICA", "sourceStageArn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh", "sourceSessionId": "st-a1b2c3d4e5f6g" } ] } ``` Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*. + Para ver detalhes da API, consulte [ListParticipants](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-participants.html) na *Referência de comandos da AWS CLI*. ### `list-public-keys` O código de exemplo a seguir mostra como usar `list-public-keys`. **AWS CLI** **Para listar chaves públicas existentes disponíveis para assinar tokens de participantes do palco** O exemplo `list-public-keys` a seguir lista todas as chaves públicas disponíveis para os tokens dos participantes na região da AWS em que a solicitação da API é processada. ``` aws ivs-realtime list-public-keys ``` Resultado: ``` { "publicKeys": [ { "arn": "arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2", "name": "", "tags": {} }, { "arn": "arn:aws:ivs:us-west-2:123456789012:public-key/3bcdABCDefg4", "name": "", "tags": {} } ] } ``` Para obter mais informações, consulte [Distribuir tokens de participantes](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html) no *Guia do usuário de streaming em tempo real do Amazon IVS*. + Para ver detalhes da API, consulte [ListPublicKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-public-keys.html) na *Referência de comandos da AWS CLI*. ### `list-stage-sessions` O código de exemplo a seguir mostra como usar `list-stage-sessions`. **AWS CLI** **Para obter uma lista das sessões de palco** O exemplo `list-stage-sessions` a seguir lista todas as sessões para o ARN (Amazon Resource Name) do palco especificado. ``` aws ivs-realtime list-stage-sessions \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh ``` Resultado: ``` { "stageSessions": [ { "endTime": "2023-04-26T20:36:29+00:00", "sessionId": "st-a1b2c3d4e5f6g", "startTime": "2023-04-26T20:30:29.602000+00:00" } ] } ``` Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html) e *Service Quotas do Amazon IVS*. + Para ver detalhes da API, consulte [ListStageSessions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-stage-sessions.html) na *Referência de comandos da AWS CLI*. ### `list-stages` O código de exemplo a seguir mostra como usar `list-stages`. **AWS CLI** **Para obter informações resumidas sobre todos os palcos** O seguinte `list-stages` lista todos os palcos da sua conta da AWS, na região da AWS em que a solicitação da API é processada. ``` aws ivs-realtime list-stages ``` Resultado: ``` { "stages": [ { "activeSessionId": "st-a1b2c3d4e5f6g", "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh", "name": "stage1", "tags": {} }, { "activeSessionId": "st-a123bcd456efg", "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcd1234ABCD", "name": "stage2", "tags": {} }, { "activeSessionId": "st-abcDEF1234ghi", "arn": "arn:aws:ivs:us-west-2:123456789012:stage/ABCD1234efgh", "name": "stage3", "tags": {} } ] } ``` Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) e *Service Quotas do Amazon IVS*. + Para ver detalhes da API, consulte [ListStages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-stages.html) na *Referência de comandos da AWS CLI*. ### `list-storage-configurations` O código de exemplo a seguir mostra como usar `list-storage-configurations`. **AWS CLI** **Para listar as configurações de armazenamento de composição** O seguinte `list-storage-configurations` lista todas as configurações de armazenamento de composição da sua conta da AWS, na região da AWS em que a solicitação da API é processada. ``` aws ivs-realtime list-storage-configurations ``` Resultado: ``` { "storageConfigurations": [ { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh", "name": "test-sc-1", "s3": { "bucketName": "amzn-s3-demo-bucket-1" }, "tags": {} }, { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABCefgEFGabc", "name": "test-sc-2", "s3": { "bucketName": "amzn-s3-demo-bucket-2" }, "tags": {} } ] } ``` Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) e *Service Quotas do Amazon IVS*. + Para ver detalhes da API, consulte [ListStorageConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-storage-configurations.html) na *Referência de comandos da AWS CLI*. ### `start-composition` O código de exemplo a seguir mostra como usar `start-composition`. **AWS CLI** **Exemplo 1: iniciar uma composição com configurações de layout padrão** O exemplo `start-composition` a seguir inicia uma composição para o palco especificado a ser transmitida para os locais especificados. ``` aws ivs-realtime start-composition \ --stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \ --destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \ "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \ {"s3":{"encoderConfigurationArns":["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \ "recordingConfiguration": {"hlsConfiguration": {"targetSegmentDurationSeconds": 5}}, \ "storageConfigurationArn":"arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"}}]' ``` Resultado: ``` { "composition": { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh", "destinations": [ { "configuration": { "channel": { "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" }, "name": "" }, "id": "AabBCcdDEefF", "state": "STARTING" }, { "configuration": { "name": "", "s3": { "encoderConfigurationArns": [ "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" ], "recordingConfiguration": { "format": "HLS", "hlsConfiguration": { "targetSegmentDurationSeconds": 5 } }, "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE" } }, "detail": { "s3": { "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite" } }, "id": "GHFabcgefABC", "state": "STARTING" } ], "layout": { "grid": { "featuredParticipantAttribute": "" "gridGap": 2, "omitStoppedVideo": false, "participantOrderAttribute": "", "videoAspectRatio": "VIDEO", "videoFillMode": "" } }, "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd", "startTime": "2023-10-16T23:24:00+00:00", "state": "STARTING", "tags": {} } } ``` Para ter mais informações, consulte [Gravação composta do IVS \$1 Streaming em tempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html) no *Guia do usuário do Amazon Interactive Video Service*. **Exemplo 2: iniciar uma composição com layout PiP** O exemplo `start-composition` a seguir inicia uma composição para o palco especificado a ser transmitida para os locais especificados usando o layout PiP. ``` aws ivs-realtime start-composition \ --stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \ --destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \ "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \ {"s3":{"encoderConfigurationArns":["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \ "storageConfigurationArn":"arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"}}]' \ --layout pip='{featuredParticipantAttribute="abcdefg"}' ``` Resultado: ``` { "composition": { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/wxyzWXYZpqrs", "destinations": [ { "configuration": { "channel": { "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" }, "name": "" }, "id": "AabBCcdDEefF", "state": "STARTING" }, { "configuration": { "name": "", "s3": { "encoderConfigurationArns": [ "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" ], "recordingConfiguration": { "format": "HLS", "hlsConfiguration": { "targetSegmentDurationSeconds": 2 } }, "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE" } }, "detail": { "s3": { "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite" } }, "id": "GHFabcgefABC", "state": "STARTING" } ], "layout": { "pip": { "featuredParticipantAttribute": "abcdefg", "gridGap": 0, "omitStoppedVideo": false, "participantOrderAttribute": "", "pipBehavior": "STATIC", "pipOffset": 0, "pipParticipantAttribute": "", "pipPosition": "BOTTOM_RIGHT", "videoFillMode": "COVER" } }, "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd", "startTime": "2023-10-16T23:24:00+00:00", "state": "STARTING", "tags": {} } } ``` Para ter mais informações, consulte [Gravação composta do IVS \$1 Streaming em tempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html) no *Guia do usuário do Amazon Interactive Video Service*. **Exemplo 3: como iniciar uma composição com a gravação de miniatura habilitada** O exemplo de `start-composition` a seguir inicia uma composição para o estágio especificado a ser transmitida para os locais especificados com a gravação de miniatura habilitada. ``` aws ivs-realtime start-composition \ --stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \ --destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \ "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \ {"s3": {"encoderConfigurationArns": ["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \ "storageConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE", \ "thumbnailConfigurations": [{"storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}]}}]' ``` Resultado: ``` { "composition": { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh", "destinations": [ { "configuration": { "channel": { "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" }, "name": "" }, "id": "AabBCcdDEefF", "state": "STARTING" }, { "configuration": { "name": "", "s3": { "encoderConfigurationArns": [ "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" ], "recordingConfiguration": { "format": "HLS", "hlsConfiguration": { "targetSegmentDurationSeconds": 2 } }, "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE", "thumbnailConfigurations": [ { "targetIntervalSeconds": 60, "storage": [ "SEQUENTIAL" ] } ] } }, "detail": { "s3": { "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite" } }, "id": "GHFabcgefABC", "state": "STARTING" } ], "layout": { "grid": { "featuredParticipantAttribute": "" "gridGap": 2, "omitStoppedVideo": false, "participantOrderAttribute": "", "videoAspectRatio": "VIDEO", "videoFillMode": "" } }, "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd", "startTime": "2023-10-16T23:24:00+00:00", "state": "STARTING", "tags": {} } } ``` Para obter mais informações, consulte [Gravação composta (streaming em tempo real)](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html) no *Guia do usuário do Amazon Interactive Video Service*. **Exemplo 4: iniciar uma composição usando o layout de grade com a ordenação personalizada dos participantes** O exemplo de `start-composition` a seguir inicia uma composição para o palco especificado a ser transmitida para os locais especificados usando o layout de grade com ordenação personalizada dos participantes. ``` aws ivs-realtime start-composition \ --stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \ --destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \ "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \ {"s3": {"encoderConfigurationArns": ["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \ "storageConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE", \ "thumbnailConfigurations": [{"storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}]}}]' \ --layout grid='{participantOrderAttribute="abcdefg"}' ``` Resultado: ``` { "composition": { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh", "destinations": [ { "configuration": { "channel": { "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" }, "name": "" }, "id": "AabBCcdDEefF", "state": "STARTING" }, { "configuration": { "name": "", "s3": { "encoderConfigurationArns": [ "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" ], "recordingConfiguration": { "format": "HLS", "hlsConfiguration": { "targetSegmentDurationSeconds": 2 } }, "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE", "thumbnailConfigurations": [ { "targetIntervalSeconds": 60, "storage": [ "SEQUENTIAL" ] } ] } }, "detail": { "s3": { "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite" } }, "id": "GHFabcgefABC", "state": "STARTING" } ], "layout": { "grid": { "featuredParticipantAttribute": "" "gridGap": 2, "omitStoppedVideo": false, "participantOrderAttribute": "abcdefg", "videoAspectRatio": "VIDEO", "videoFillMode": "" } }, "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd", "startTime": "2023-10-16T23:24:00+00:00", "state": "STARTING", "tags": {} } } ``` Para ter mais informações, consulte [Gravação composta do IVS \$1 Streaming em tempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html) no *Guia do usuário do Amazon Interactive Video Service*. + Para ver detalhes da API, consulte [StartComposition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/start-composition.html) na *Referência de comandos da AWS CLI*. ### `start-participant-replication` O código de exemplo a seguir mostra como usar `start-participant-replication`. **AWS CLI** **Como iniciar a replicação de um participante de um palco para outro** O exemplo `start-participant-replication` a seguir replica um participante de um palco de origem para um palco de destino e cada palco é especificado pelo nome do recurso da Amazon (ARN) correspondente. ``` aws ivs-realtime start-participant-replication \ --source-stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --destination-stage-arn arn:aws:ivs:us-west-2:234567890123:stage/bcdABCDefghi \ --participant-id abCDEf12GHIj ``` Resultado: ``` { "accessControlAllowOrigin": "*", "accessControlExposeHeaders": "Access-Control-Allow-Origin,Access-Control-Expose-Headers,Cache-Control,Content-Length, \ Content-Security-Policy,Content-Type,date,Strict-Transport-Security,x-amz-apigw-id,x-amzn-errormessage,x-amzn-errortype, \ x-amzn-requestid,x-amzn-trace-id,X-Content-Type-Options,X-Frame-Options", "cacheControl": "no-store, no-cache", "contentSecurityPolicy": "default-src 'self'; upgrade-insecure-requests;", "strictTransportSecurity": "max-age:47304000; includeSubDomains", "xContentTypeOptions": "nosniff", "xFrameOptions": "DENY" } ``` Para ter mais informações, consulte [Replicação de participantes do IVS](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-participant-replication.html) no *Guia do usuário do streaming em tempo real do Amazon IVS*. + Para ver detalhes da API, consulte [StartParticipantReplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/start-participant-replication.html) na *Referência de comandos da AWS CLI*. ### `stop-composition` O código de exemplo a seguir mostra como usar `stop-composition`. **AWS CLI** **Como parar uma composição** O seguinte `stop-composition` interrompe a composição especificada pelo ARN (Amazon Resource Name) fornecido. ``` aws ivs-realtime stop-composition \ --arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh" ``` Este comando não produz saída. Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) e *Service Quotas do Amazon IVS*. + Para ver detalhes da API, consulte [StopComposition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/stop-composition.html) na *Referência de comandos da AWS CLI*. ### `stop-participant-replication` O código de exemplo a seguir mostra como usar `stop-participant-replication`. **AWS CLI** **Como interromper a replicação de um participante de um palco para outro** O exemplo `stop-participant-replication` a seguir interrompe a replicação de um participante de um palco de origem para um palco de destino e cada estágio é especificado pelo nome do recurso da Amazon (ARN) correspondente. ``` aws ivs-realtime stop-participant-replication \ --source-stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --destination-stage-arn arn:aws:ivs:us-west-2:234567890123:stage/bcdABCDefghi \ --participant-id abCDEf12GHIj ``` Resultado: ``` { "accessControlAllowOrigin": "*", "accessControlExposeHeaders": "Access-Control-Allow-Origin,Access-Control-Expose-Headers,Cache-Control,Content-Length, \ Content-Security-Policy,Content-Type,date,Strict-Transport-Security,x-amz-apigw-id,x-amzn-errormessage,x-amzn-errortype, \ x-amzn-requestid,x-amzn-trace-id,X-Content-Type-Options,X-Frame-Options", "cacheControl": "no-store, no-cache", "contentSecurityPolicy": "default-src 'self'; upgrade-insecure-requests;", "strictTransportSecurity": "max-age:47304000; includeSubDomains", "xContentTypeOptions": "nosniff", "xFrameOptions": "DENY" } ``` Para ter mais informações, consulte [Replicação de participantes do IVS](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-participant-replication.html) no *Guia do usuário do streaming em tempo real do Amazon IVS*. + Para ver detalhes da API, consulte [StopParticipantReplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/stop-participant-replication.html) na *Referência de comandos da AWS CLI*. ### `update-ingest-configuration` O código de exemplo a seguir mostra como usar `update-ingest-configuration`. **AWS CLI** **Como atualizar uma configuração de ingestão** O exemplo de `update-inegst-configuration` a seguir atualiza uma configuração de ingestão para anexá-la a um estágio. ``` aws ivs-realtime update-ingest-configuration \ --arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234 \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh ``` Resultado: ``` { "ingestConfiguration": { "name": "ingest1", "arn": "arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234", "ingestProtocol": "RTMPS", "streamKey": "rt_123456789012_us-west-2_AbCdEfGh1234_abcd1234efgh5678ijkl9012MNOP34", "stageArn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh", "participantId": "xyZ654abC321", "state": "INACTIVE", "userId": "", "tags": {} } } ``` Consulte mais informações em [Ingestão de streams do IVS \$1 Streaming em tempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html) no *Guia do usuário do Amazon Interactive Video Service*. + Consulte detalhes da API em [UpdateIngestConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/update-ingest-configuration.html) na *Referência de comandos da AWS CLI*. ### `update-stage` O código de exemplo a seguir mostra como usar `update-stage`. **AWS CLI** **Exemplo 1: atualizar a configuração de um palco** O exemplo de `update-stage` a seguir atualiza um estágio para um ARN de estágio especificado para atualizar o nome do estágio e configurar a gravação individual de participantes com a gravação de miniatura habilitada. ``` aws ivs-realtime update-stage \ --arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", "recordingReconnectWindowSeconds": 100, \ "thumbnailConfiguration": {"recordingMode": "INTERVAL","storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}} \ "hlsConfiguration": {"targetSegmentDurationSeconds": 5}}' \ --name stage1a ``` Resultado: ``` { "stage": { "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh", "autoParticipantRecordingConfiguration": { "mediaTypes": [ "AUDIO_VIDEO" ], "storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", "thumbnailConfiguration": { "targetIntervalSeconds": 60, "storage": [ "SEQUENTIAL" ], "recordingMode": "INTERVAL" }, "recordingReconnectWindowSeconds": 100, "hlsConfiguration": { "targetSegmentDurationSeconds": 5 }, "recordParticipantReplicas": true }, "endpoints": { "events": "wss://global.events.live-video.net", "rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/", "rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/", "whip": "https://1a2b3c4d5e6f.global-bm.whip.live-video.net" }, "name": "stage1a", "tags": {} } } ``` Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*. **Exemplo 2: atualizar a configuração de um palco, bem como desabilitar a gravação de réplicas de participantes** O exemplo `update-stage` a seguir atualiza um palco para um ARN de palco especificado a fim de atualizar o nome do palco e configurar a gravação de participantes individuais com a gravação de miniatura habilitada e a gravação de réplicas de participantes desabilitada. ``` aws ivs-realtime update-stage \ --arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", "recordingReconnectWindowSeconds": 100, \ "thumbnailConfiguration": {"recordingMode": "INTERVAL","storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}, "recordParticipantReplicas":false} \ "hlsConfiguration": {"targetSegmentDurationSeconds": 5}}' \ --name stage1a ``` Resultado: ``` { "stage": { "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh", "autoParticipantRecordingConfiguration": { "mediaTypes": [ "AUDIO_VIDEO" ], "storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", "thumbnailConfiguration": { "targetIntervalSeconds": 60, "storage": [ "SEQUENTIAL" ], "recordingMode": "INTERVAL" }, "recordingReconnectWindowSeconds": 100, "hlsConfiguration": { "targetSegmentDurationSeconds": 5 }, "recordParticipantReplicas": false }, "endpoints": { "events": "wss://global.events.live-video.net", "rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/", "rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/", "whip": "https://1a2b3c4d5e6f.global-bm.whip.live-video.net" }, "name": "stage1a", "tags": {} } } ``` Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*. + Para ver detalhes da API, consulte [UpdateStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/update-stage.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon Kendra usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o Amazon Kendra. *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 ### `create-data-source` O código de exemplo a seguir mostra como usar `create-data-source`. **AWS CLI** **Para criar um conector de fonte de dados do Amazon Kendra** O seguinte `create-data-source` cria e configura um conector de fonte de dados do Amazon Kendra. É possível usar `describe-data-source` para visualizar o status de um conector de fonte de dados e ler qualquer mensagem de erro se o status mostrar que um conector de fonte de dados "FALHOU" em ser completamente criado. ``` aws kendra create-data-source \ --name "example data source 1" \ --description "Example data source 1 for example index 1 contains the first set of example documents" \ --tags '{"Key": "test resources", "Value": "kendra"}, {"Key": "test resources", "Value": "aws"}' \ --role-arn "arn:aws:iam::my-account-id:role/KendraRoleForS3TemplateConfigDataSource" \ --index-id exampleindex1 \ --language-code "es" \ --schedule "0 0 18 ? * TUE,MON,WED,THU,FRI,SAT *" \ --configuration '{"TemplateConfiguration": {"Template": file://s3schemaconfig.json}}' \ --type "TEMPLATE" \ --custom-document-enrichment-configuration '{"PostExtractionHookConfiguration": {"LambdaArn": "arn:aws:iam::my-account-id:function/my-function-ocr-docs", "S3Bucket": "s3://amzn-s3-demo-bucket/scanned-image-text-example-docs"}, "RoleArn": "arn:aws:iam:my-account-id:role/KendraRoleForCDE"}' \ --vpc-configuration '{"SecurityGroupIds": ["sg-1234567890abcdef0"], "SubnetIds": ["subnet-1c234","subnet-2b134"]}' ``` Resultado: ``` { "Id": "exampledatasource1" } ``` Para obter mais informações, consulte [Introdução a um índice e conector de fonte de dados do Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html) no *Guia do desenvolvedor do Amazon Kendra*. + Para ver detalhes da API, consulte [CreateDataSource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/create-data-source.html) na *Referência de comandos da AWS CLI*. ### `create-index` O código de exemplo a seguir mostra como usar `create-index`. **AWS CLI** **Para criar um índice do Amazon Kendra** O seguinte `create-index` cria e configura um índice do Amazon Kendra. É possível usar `describe-index` para visualizar o status de um índice e ler qualquer mensagem de erro se o status mostrar que um índice "FALHOU" em ser completamente criado. ``` aws kendra create-index \ --name "example index 1" \ --description "Example index 1 contains the first set of example documents" \ --tags '{"Key": "test resources", "Value": "kendra"}, {"Key": "test resources", "Value": "aws"}' \ --role-arn "arn:aws:iam::my-account-id:role/KendraRoleForExampleIndex" \ --edition "DEVELOPER_EDITION" \ --server-side-encryption-configuration '{"KmsKeyId": "my-kms-key-id"}' \ --user-context-policy "USER_TOKEN" \ --user-token-configurations '{"JsonTokenTypeConfiguration": {"GroupAttributeField": "groupNameField", "UserNameAttributeField": "userNameField"}}' ``` Resultado: ``` { "Id": index1 } ``` Para obter mais informações, consulte [Introdução a um índice e conector de fonte de dados do Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html) no *Guia do desenvolvedor do Amazon Kendra*. + Para ver detalhes da API, consulte [CreateIndex](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/create-index.html) na *Referência de comandos da AWS CLI*. ### `describe-data-source` O código de exemplo a seguir mostra como usar `describe-data-source`. **AWS CLI** **Para obter informações sobre um conector de fonte de dados do Amazon Kendra** O comando `describe-data-source` a seguir obtém informações sobre um conector de fonte de dados do Amazon Kendra. É possível visualizar a configuração de um conector de fonte de dados e ler qualquer mensagem de erro se o status mostrar que um conector de fonte de dados "FALHOU" em ser completamente criado. ``` aws kendra describe-data-source \ --id exampledatasource1 \ --index-id exampleindex1 ``` Resultado: ``` { "Configuration": { "TemplateConfiguration": { "Template": { "connectionConfiguration": { "repositoryEndpointMetadata": { "BucketName": "amzn-s3-demo-bucket" } }, "repositoryConfigurations": { "document":{ "fieldMappings": [ { "indexFieldName":"_document_title", "indexFieldType":"STRING", "dataSourceFieldName": "title" }, { "indexFieldName":"_last_updated_at", "indexFieldType":"DATE", "dataSourceFieldName": "modified_date" } ] } }, "additionalProperties": { "inclusionPatterns": [ "*.txt", "*.doc", "*.docx" ], "exclusionPatterns": [ "*.json" ], "inclusionPrefixes": [ "PublicExampleDocsFolder" ], "exclusionPrefixes": [ "PrivateDocsFolder/private" ], "aclConfigurationFilePath": "ExampleDocsFolder/AclConfig.json", "metadataFilesPrefix": "metadata" }, "syncMode": "FULL_CRAWL", "type" : "S3", "version": "1.0.0" } } }, "CreatedAt": 2024-02-25T13:30:10+00:00, "CustomDocumentEnrichmentConfiguration": { "PostExtractionHookConfiguration": { "LambdaArn": "arn:aws:iam::my-account-id:function/my-function-ocr-docs", "S3Bucket": "s3://amzn-s3-demo-bucket/scanned-image-text-example-docs/function" }, "RoleArn": "arn:aws:iam:my-account-id:role/KendraRoleForCDE" } "Description": "Example data source 1 for example index 1 contains the first set of example documents", "Id": exampledatasource1, "IndexId": exampleindex1, "LanguageCode": "en", "Name": "example data source 1", "RoleArn": "arn:aws:iam::my-account-id:role/KendraRoleForS3TemplateConfigDataSource", "Schedule": "0 0 18 ? * TUE,MON,WED,THU,FRI,SAT *", "Status": "ACTIVE", "Type": "TEMPLATE", "UpdatedAt": 1709163615, "VpcConfiguration": { "SecurityGroupIds": ["sg-1234567890abcdef0"], "SubnetIds": ["subnet-1c234","subnet-2b134"] } } ``` Para obter mais informações, consulte [Introdução a um índice e conector de fonte de dados do Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html) no *Guia do desenvolvedor do Amazon Kendra*. + Para ver detalhes da API, consulte [DescribeDataSource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/describe-data-source.html) na *Referência de comandos da AWS CLI*. ### `describe-index` O código de exemplo a seguir mostra como usar `describe-index`. **AWS CLI** **Para obter informações sobre um índice da Amazon Kendra** O seguinte `describe-index` obtém informações sobre um índice do Amazon Kendra. É possível usar para visualizar o status de um índice e ler qualquer mensagem de erro se o status mostrar que um índice "FALHOU" em ser completamente criado. ``` aws kendra describe-index \ --id exampleindex1 ``` Resultado: ``` { "CapacityUnits": { "QueryCapacityUnits": 0, "StorageCapacityUnits": 0 }, "CreatedAt": 2024-02-25T12:30:10+00:00, "Description": "Example index 1 contains the first set of example documents", "DocumentMetadataConfigurations": [ { "Name": "_document_title", "Relevance": { "Importance": 8 }, "Search": { "Displayable": true, "Facetable": false, "Searchable": true, "Sortable": false }, "Type": "STRING_VALUE" }, { "Name": "_document_body", "Relevance": { "Importance": 5 }, "Search": { "Displayable": true, "Facetable": false, "Searchable": true, "Sortable": false }, "Type": "STRING_VALUE" }, { "Name": "_last_updated_at", "Relevance": { "Importance": 6, "Duration": "2628000s", "Freshness": true }, "Search": { "Displayable": true, "Facetable": false, "Searchable": true, "Sortable": true }, "Type": "DATE_VALUE" }, { "Name": "department_custom_field", "Relevance": { "Importance": 7, "ValueImportanceMap": { "Human Resources" : 4, "Marketing and Sales" : 2, "Research and innvoation" : 3, "Admin" : 1 } }, "Search": { "Displayable": true, "Facetable": true, "Searchable": true, "Sortable": true }, "Type": "STRING_VALUE" } ], "Edition": "DEVELOPER_EDITION", "Id": "index1", "IndexStatistics": { "FaqStatistics": { "IndexedQuestionAnswersCount": 10 }, "TextDocumentStatistics": { "IndexedTextBytes": 1073741824, "IndexedTextDocumentsCount": 1200 } }, "Name": "example index 1", "RoleArn": "arn:aws:iam::my-account-id:role/KendraRoleForExampleIndex", "ServerSideEncryptionConfiguration": { "KmsKeyId": "my-kms-key-id" }, "Status": "ACTIVE", "UpdatedAt": 1709163615, "UserContextPolicy": "USER_TOKEN", "UserTokenConfigurations": [ { "JsonTokenTypeConfiguration": { "GroupAttributeField": "groupNameField", "UserNameAttributeField": "userNameField" } } ] } ``` Para obter mais informações, consulte [Introdução a um índice e conector de fonte de dados do Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html) no *Guia do desenvolvedor do Amazon Kendra*. + Para ver detalhes da API, consulte [DescribeIndex](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/describe-index.html) na *Referência de comandos da AWS CLI*. ### `update-data-source` O código de exemplo a seguir mostra como usar `update-data-source`. **AWS CLI** **Para atualizar um conector de fonte de dados do Amazon Kendra** O seguinte `update-data-source` atualiza a configuração de um conector de fonte de dados do Amazon Kendra. Se a ação for bem-sucedida, o serviço não retornará: ou nenhuma saída, ou o código de status HTTP 200, ou o código de retorno 0 da AWS CLI. É possível usar `describe-data-source` para visualizar a configuração e o status de um conector de fonte de dados. ``` aws kendra update-data-source \ --id exampledatasource1 \ --index-id exampleindex1 \ --name "new name for example data source 1" \ --description "new description for example data source 1" \ --role-arn arn:aws:iam::my-account-id:role/KendraNewRoleForExampleDataSource \ --configuration '{"TemplateConfiguration": {"Template": file://s3schemanewconfig.json}}' \ --custom-document-enrichment-configuration '{"PostExtractionHookConfiguration": {"LambdaArn": "arn:aws:iam::my-account-id:function/my-function-ocr-docs", "S3Bucket": "s3://amzn-s3-demo-bucket/scanned-image-text-example-docs"}, "RoleArn": "arn:aws:iam:my-account-id:role/KendraNewRoleForCDE"}' \ --language-code "es" \ --schedule "0 0 18 ? * MON,WED,FRI *" \ --vpc-configuration '{"SecurityGroupIds": ["sg-1234567890abcdef0"], "SubnetIds": ["subnet-1c234","subnet-2b134"]}' ``` Este comando não produz saída. Para obter mais informações, consulte [Introdução a um índice e conector de fonte de dados do Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html) no *Guia do desenvolvedor do Amazon Kendra*. + Para ver detalhes da API, consulte [UpdateDataSource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/update-data-source.html) na *Referência de comandos da AWS CLI*. ### `update-index` O código de exemplo a seguir mostra como usar `update-index`. **AWS CLI** **Para atualizar um índice do Amazon Kendra** O seguinte `update-index` atualiza a configuração de um índice do Amazon Kendra. Se a ação for bem-sucedida, o serviço não retornará: ou nenhuma saída, ou o código de status HTTP 200, ou o código de retorno 0 da AWS CLI. É possível usar `describe-index` para visualizar a configuração e o status de um índice. ``` aws kendra update-index \ --id enterpriseindex1 \ --name "new name for Enterprise Edition index 1" \ --description "new description for Enterprise Edition index 1" \ --role-arn arn:aws:iam::my-account-id:role/KendraNewRoleForEnterpriseIndex \ --capacity-units '{"QueryCapacityUnits": 2, "StorageCapacityUnits": 1}' \ --document-metadata-configuration-updates '{"Name": "_document_title", "Relevance": {"Importance": 6}}, {"Name": "_last_updated_at", "Relevance": {"Importance": 8}}' \ --user-context-policy "USER_TOKEN" \ --user-token-configurations '{"JsonTokenTypeConfiguration": {"GroupAttributeField": "groupNameField", "UserNameAttributeField": "userNameField"}}' ``` Este comando não produz saída. Para obter mais informações, consulte [Introdução a um índice e conector de fonte de dados do Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html) no *Guia do desenvolvedor do Amazon Kendra*. + Para ver detalhes da API, consulte [UpdateIndex](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/update-index.html) na *Referência de comandos da AWS CLI*. # Exemplos do Kinesis usando o AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface 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 ### `add-tags-to-stream` O código de exemplo a seguir mostra como usar `add-tags-to-stream`. **AWS CLI** **Para adicionar tags a um fluxo de dados** O exemplo `add-tags-to-stream` a seguir atribui uma tag com a chave `samplekey` e o valor `example` ao fluxo especificado. ``` aws kinesis add-tags-to-stream \ --stream-name samplestream \ --tags samplekey=example ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar tags a fluxos](https://docs.aws.amazon.com/streams/latest/dev/tagging.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams*. + Para ver detalhes da API, consulte [AddTagsToStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/add-tags-to-stream.html) na *Referência de comandos da AWS CLI*. ### `create-stream` O código de exemplo a seguir mostra como usar `create-stream`. **AWS CLI** **Como criar um fluxo de dados** O exemplo de `create-stream` a seguir cria um fluxo de dados chamado samplestream com três fragmentos. ``` aws kinesis create-stream \ --stream-name samplestream \ --shard-count 3 ``` Este comando não produz saída. Para obter mais informações, consulte [Criar um fluxo](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-create-stream.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams*. + Consulte detalhes da API em [CreateStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/create-stream.html) na *Referência de comandos da AWS CLI*. ### `decrease-stream-retention-period` O código de exemplo a seguir mostra como usar `decrease-stream-retention-period`. **AWS CLI** **Como diminuir o período de retenção do fluxo de dados** O exemplo `decrease-stream-retention-period` a seguir reduz o período de retenção (o período em que os registros de dados ficam acessíveis depois de serem adicionados ao fluxo) de um fluxo chamado samplestream para 48 horas. ``` aws kinesis decrease-stream-retention-period \ --stream-name samplestream \ --retention-period-hours 48 ``` Este comando não produz saída. Para obter mais informações, consulte [Alterar o período de retenção de dados](https://docs.aws.amazon.com/streams/latest/dev/kinesis-extended-retention.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams*. + Para ver detalhes da API, consulte [DecreaseStreamRetentionPeriod](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/decrease-stream-retention-period.html) na *Referência de comandos da AWS CLI*. ### `delete-stream` O código de exemplo a seguir mostra como usar `delete-stream`. **AWS CLI** **Como excluir um fluxo de dados** O exemplo de `delete-stream` a seguir exclui o fluxo de dados especificado. ``` aws kinesis delete-stream \ --stream-name samplestream ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir um fluxo](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-delete-stream.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams*. + Consulte detalhes da API em [DeleteStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/delete-stream.html) na *Referência de comandos da AWS CLI*. ### `deregister-stream-consumer` O código de exemplo a seguir mostra como usar `deregister-stream-consumer`. **AWS CLI** **Como cancelar o registro de um consumidor de fluxo de dados** O exemplo `deregister-stream-consumer` a seguir cancela o registro do consumidor especificado do fluxo de dados especificado. ``` aws kinesis deregister-stream-consumer \ --stream-arn arn:aws:kinesis:us-west-2:123456789012:stream/samplestream \ --consumer-name KinesisConsumerApplication ``` Este comando não produz saída. Para obter mais informações, consulte [Desenvolver consumidores com Fan-Out aprimorado usando a API Kinesis Data Streams](https://docs.aws.amazon.com/streams/latest/dev/building-enhanced-consumers-api.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams*. + Para ver detalhes da API, consulte [DeregisterStreamConsumer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/deregister-stream-consumer.html) na *Referência de comandos da AWS CLI*. ### `describe-limits` O código de exemplo a seguir mostra como usar `describe-limits`. **AWS CLI** **Para descrever os limites de fragmentos** O exemplo `describe-limits` a seguir mostra os limites e uso de fragmentos na conta da AWS atual. ``` aws kinesis describe-limits ``` Resultado: ``` { "ShardLimit": 500, "OpenShardCount": 29 } ``` Para obter mais informações, consulte [Refragmentar um fluxo](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-resharding.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams*. + Para ver detalhes da API, consulte [DescribeLimits](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/describe-limits.html) na *Referência de comandos da AWS CLI*. ### `describe-stream-consumer` O código de exemplo a seguir mostra como usar `describe-stream-consumer`. **AWS CLI** **Para descrever um consumidor de fluxo de dados** O exemplo `describe-stream-consumer` a seguir retorna a descrição do consumidor especificado, registrado com o fluxo de dados especificado. ``` aws kinesis describe-stream-consumer \ --stream-arn arn:aws:kinesis:us-west-2:012345678912:stream/samplestream \ --consumer-name KinesisConsumerApplication ``` Resultado: ``` { "ConsumerDescription": { "ConsumerName": "KinesisConsumerApplication", "ConsumerARN": "arn:aws:kinesis:us-west-2:123456789012:stream/samplestream/consumer/KinesisConsumerApplication:1572383852", "ConsumerStatus": "ACTIVE", "ConsumerCreationTimestamp": 1572383852.0, "StreamARN": "arn:aws:kinesis:us-west-2:123456789012:stream/samplestream" } } ``` Para obter mais informações, consulte [Ler dados do Amazon Kinesis Data Streams](https://docs.aws.amazon.com/streams/latest/dev/building-consumers.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams*. + Para ver detalhes da API, consulte [DescribeStreamConsumer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/describe-stream-consumer.html) na *Referência de comandos da AWS CLI*. ### `describe-stream-summary` O código de exemplo a seguir mostra como usar `describe-stream-summary`. **AWS CLI** **Para descrever um resumo de um fluxo de dados** O exemplo `describe-stream-summary` a seguir fornece uma descrição resumida (sem a lista de fragmentos) do fluxo de dados especificado. ``` aws kinesis describe-stream-summary \ --stream-name samplestream ``` Resultado: ``` { "StreamDescriptionSummary": { "StreamName": "samplestream", "StreamARN": "arn:aws:kinesis:us-west-2:123456789012:stream/samplestream", "StreamStatus": "ACTIVE", "RetentionPeriodHours": 48, "StreamCreationTimestamp": 1572297168.0, "EnhancedMonitoring": [ { "ShardLevelMetrics": [] } ], "EncryptionType": "NONE", "OpenShardCount": 3, "ConsumerCount": 0 } } ``` Para obter mais informações, consulte [Criar e gerenciar fluxos](https://docs.aws.amazon.com/streams/latest/dev/working-with-streams.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams*. + Para ver detalhes da API, consulte [DescribeStreamSummary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/describe-stream-summary.html) na *Referência de comandos da AWS CLI*. ### `describe-stream` O código de exemplo a seguir mostra como usar `describe-stream`. **AWS CLI** **Como descrever um fluxo de dados** O exemplo de `describe-stream` a seguir retorna detalhes sobre o fluxo de dados especificado. ``` aws kinesis describe-stream \ --stream-name samplestream ``` Resultado: ``` { "StreamDescription": { "Shards": [ { "ShardId": "shardId-000000000000", "HashKeyRange": { "StartingHashKey": "0", "EndingHashKey": "113427455640312821154458202477256070484" }, "SequenceNumberRange": { "StartingSequenceNumber": "49600871682957036442365024926191073437251060580128653314" } }, { "ShardId": "shardId-000000000001", "HashKeyRange": { "StartingHashKey": "113427455640312821154458202477256070485", "EndingHashKey": "226854911280625642308916404954512140969" }, "SequenceNumberRange": { "StartingSequenceNumber": "49600871682979337187563555549332609155523708941634633746" } }, { "ShardId": "shardId-000000000002", "HashKeyRange": { "StartingHashKey": "226854911280625642308916404954512140970", "EndingHashKey": "340282366920938463463374607431768211455" }, "SequenceNumberRange": { "StartingSequenceNumber": "49600871683001637932762086172474144873796357303140614178" } } ], "StreamARN": "arn:aws:kinesis:us-west-2:123456789012:stream/samplestream", "StreamName": "samplestream", "StreamStatus": "ACTIVE", "RetentionPeriodHours": 24, "EnhancedMonitoring": [ { "ShardLevelMetrics": [] } ], "EncryptionType": "NONE", "KeyId": null, "StreamCreationTimestamp": 1572297168.0 } } ``` Para obter mais informações, consulte [Criar e gerenciar fluxos](https://docs.aws.amazon.com/streams/latest/dev/working-with-streams.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams*. + Consulte detalhes da API em [DescribeStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/describe-stream.html) na *Referência de comandos da AWS CLI*. ### `disable-enhanced-monitoring` O código de exemplo a seguir mostra como usar `disable-enhanced-monitoring`. **AWS CLI** **Para desativar o monitoramento aprimorado para métricas em nível de fragmentos** O exemplo `disable-enhanced-monitoring` a seguir desativa o monitoramento aprimorado do fluxo de dados do Kinesis para métricas em nível de fragmentos. ``` aws kinesis disable-enhanced-monitoring \ --stream-name samplestream --shard-level-metrics ALL ``` Resultado: ``` { "StreamName": "samplestream", "CurrentShardLevelMetrics": [ "IncomingBytes", "OutgoingRecords", "IteratorAgeMilliseconds", "IncomingRecords", "ReadProvisionedThroughputExceeded", "WriteProvisionedThroughputExceeded", "OutgoingBytes" ], "DesiredShardLevelMetrics": [] } ``` Para obter mais informações, consulte [Monitorar fluxos no Amazon Kinesis Data Streams](https://docs.aws.amazon.com/streams/latest/dev/monitoring.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams*. + Para ver detalhes da API, consulte [DisableEnhancedMonitoring](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/disable-enhanced-monitoring.html) na *Referência de comandos da AWS CLI*. ### `enable-enhanced-monitoring` O código de exemplo a seguir mostra como usar `enable-enhanced-monitoring`. **AWS CLI** **Como ativar o monitoramento aprimorado para métricas em nível de fragmentos** O exemplo `enable-enhanced-monitoring` a seguir ativa o monitoramento aprimorado do fluxo de dados do Kinesis para métricas em nível de fragmentos. ``` aws kinesis enable-enhanced-monitoring \ --stream-name samplestream \ --shard-level-metrics ALL ``` Resultado: ``` { "StreamName": "samplestream", "CurrentShardLevelMetrics": [], "DesiredShardLevelMetrics": [ "IncomingBytes", "OutgoingRecords", "IteratorAgeMilliseconds", "IncomingRecords", "ReadProvisionedThroughputExceeded", "WriteProvisionedThroughputExceeded", "OutgoingBytes" ] } ``` Para obter mais informações, consulte [Monitorar fluxos no Amazon Kinesis Data Streams](https://docs.aws.amazon.com/streams/latest/dev/monitoring.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams*. + Para ver detalhes da API, consulte [EnableEnhancedMonitoring](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/enable-enhanced-monitoring.html) na *Referência de comandos da AWS CLI*. ### `get-records` O código de exemplo a seguir mostra como usar `get-records`. **AWS CLI** **Como obter registros de um fragmento** O exemplo de `get-records` a seguir obtém registros de dados do fragmento de um fluxo de dados do Kinesis usando o iterador de fragmento especificado. ``` aws kinesis get-records \ --shard-iterator AAAAAAAAAAF7/0mWD7IuHj1yGv/TKuNgx2ukD5xipCY4cy4gU96orWwZwcSXh3K9tAmGYeOZyLZrvzzeOFVf9iN99hUPw/w/b0YWYeehfNvnf1DYt5XpDJghLKr3DzgznkTmMymDP3R+3wRKeuEw6/kdxY2yKJH0veaiekaVc4N2VwK/GvaGP2Hh9Fg7N++q0Adg6fIDQPt4p8RpavDbk+A4sL9SWGE1 ``` Resultado: ``` { "Records": [], "MillisBehindLatest": 80742000 } ``` Para obter mais informações, consulte [Developing Consumers Using the Kinesis Data Streams API with the AWS SDK for Java](https://docs.aws.amazon.com/streams/latest/dev/developing-consumers-with-sdk.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams*. + Para ver detalhes da API, consulte [GetRecords](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/get-records.html) na *Referência de comandos da AWS CLI*. ### `get-shard-iterator` O código de exemplo a seguir mostra como usar `get-shard-iterator`. **AWS CLI** **Para obter um iterador de fragmentos** O exemplo `get-shard-iterator` a seguir usa o tipo iterador de fragmento `AT_SEQUENCE_NUMBER` e gera um iterador de fragmento para começar a ler os registros de dados exatamente da posição indicada pelo número de sequência especificado. ``` aws kinesis get-shard-iterator \ --stream-name samplestream \ --shard-id shardId-000000000001 \ --shard-iterator-type LATEST ``` Resultado: ``` { "ShardIterator": "AAAAAAAAAAFEvJjIYI+3jw/4aqgH9FifJ+n48XWTh/IFIsbILP6o5eDueD39NXNBfpZ10WL5K6ADXk8w+5H+Qhd9cFA9k268CPXCz/kebq1TGYI7Vy+lUkA9BuN3xvATxMBGxRY3zYK05gqgvaIRn94O8SqeEqwhigwZxNWxID3Ej7YYYcxQi8Q/fIrCjGAy/n2r5Z9G864YpWDfN9upNNQAR/iiOWKs" } ``` Para obter mais informações, consulte [Developing Consumers Using the Kinesis Data Streams API with the AWS SDK for Java](https://docs.aws.amazon.com/streams/latest/dev/developing-consumers-with-sdk.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams*. + Para ver detalhes da API, consulte [GetShardIterator](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/get-shard-iterator.html) na *Referência de comandos da AWS CLI*. ### `increase-stream-retention-period` O código de exemplo a seguir mostra como usar `increase-stream-retention-period`. **AWS CLI** **Como aumentar o período de retenção do fluxo de dados** O exemplo `increase-stream-retention-period` a seguir aumenta o período de retenção (o período em que os registros de dados ficam acessíveis depois de serem adicionados ao fluxo) do fluxo especificado para 168 horas. ``` aws kinesis increase-stream-retention-period \ --stream-name samplestream \ --retention-period-hours 168 ``` Este comando não produz saída. Para obter mais informações, consulte [Alterar o período de retenção de dados](https://docs.aws.amazon.com/streams/latest/dev/kinesis-extended-retention.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams*. + Para ver detalhes da API, consulte [IncreaseStreamRetentionPeriod](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/increase-stream-retention-period.html) na *Referência de comandos da AWS CLI*. ### `list-shards` O código de exemplo a seguir mostra como usar `list-shards`. **AWS CLI** **Para listar fragmentos em um fluxo de dados** O exemplo `list-shards` a seguir lista todos os fragmentos no fluxo especificado, começando com o fragmento cujo ID segue imediatamente o `exclusive-start-shard-id` especificado por `shardId-000000000000`. ``` aws kinesis list-shards \ --stream-name samplestream \ --exclusive-start-shard-id shardId-000000000000 ``` Resultado: ``` { "Shards": [ { "ShardId": "shardId-000000000001", "HashKeyRange": { "StartingHashKey": "113427455640312821154458202477256070485", "EndingHashKey": "226854911280625642308916404954512140969" }, "SequenceNumberRange": { "StartingSequenceNumber": "49600871682979337187563555549332609155523708941634633746" } }, { "ShardId": "shardId-000000000002", "HashKeyRange": { "StartingHashKey": "226854911280625642308916404954512140970", "EndingHashKey": "340282366920938463463374607431768211455" }, "SequenceNumberRange": { "StartingSequenceNumber": "49600871683001637932762086172474144873796357303140614178" } } ] } ``` Para obter mais informações, consulte [Listar fragmentos](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-list-shards.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams*. + Para ver detalhes da API, consulte [ListShards](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/list-shards.html) na *Referência de comandos da AWS CLI*. ### `list-streams` O código de exemplo a seguir mostra como usar `list-streams`. **AWS CLI** **Para listar fluxos de dados** O exemplo de `list-streams` a seguir lista todos os fluxos de dados ativos na conta e região atuais. ``` aws kinesis list-streams ``` Resultado: ``` { "StreamNames": [ "samplestream", "samplestream1" ] } ``` Para obter mais informações, consulte [Listar fluxos](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-list-streams.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams*. + Consulte detalhes da API em [ListStreams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/list-streams.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-stream` O código de exemplo a seguir mostra como usar `list-tags-for-stream`. **AWS CLI** **Para listar tags para um fluxo de dados** O exemplo `list-tags-for-stream` a seguir lista as tags anexadas ao fluxo de dados especificado. ``` aws kinesis list-tags-for-stream \ --stream-name samplestream ``` Resultado: ``` { "Tags": [ { "Key": "samplekey", "Value": "example" } ], "HasMoreTags": false } ``` Para obter mais informações, consulte [Adicionar tags a fluxos](https://docs.aws.amazon.com/streams/latest/dev/tagging.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams*. + Para ver detalhes da API, consulte [ListTagsForStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/list-tags-for-stream.html) na *Referência de comandos da AWS CLI*. ### `merge-shards` O código de exemplo a seguir mostra como usar `merge-shards`. **AWS CLI** **Para mesclar dois fragmentos** O exemplo `merge-shards` a seguir mescla dois fragmentos adjacentes com IDs de ShardID-000000000000 e ShardID-000000000001 no fluxo de dados especificado e os combina em um único fragmento. ``` aws kinesis merge-shards \ --stream-name samplestream \ --shard-to-merge shardId-000000000000 \ --adjacent-shard-to-merge shardId-000000000001 ``` Este comando não produz saída. Para obter mais informações, consulte [Mesclar dois fragmentos](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-resharding-merge.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams*. + Para ver detalhes da API, consulte [MergeShards](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/merge-shards.html) na *Referência de comandos da AWS CLI*. ### `put-record` O código de exemplo a seguir mostra como usar `put-record`. **AWS CLI** **Como gravar um registro em um fluxo de dados** O exemplo de `put-record` a seguir grava um único registro de dados no fluxo de dados especificado usando a chave de partição especificada. ``` aws kinesis put-record \ --stream-name samplestream \ --data sampledatarecord \ --partition-key samplepartitionkey ``` Resultado: ``` { "ShardId": "shardId-000000000009", "SequenceNumber": "49600902273357540915989931256901506243878407835297513618", "EncryptionType": "KMS" } ``` Para obter mais informações, consulte [Desenvolver produtores usando a API do Amazon Kinesis Data Streams com o AWS SDK for Java](https://docs.aws.amazon.com/streams/latest/dev/developing-producers-with-sdk.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams*. + Consulte detalhes da API em [PutRecord](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/put-record.html) na *Referência de comandos da AWS CLI*. ### `put-records` O código de exemplo a seguir mostra como usar `put-records`. **AWS CLI** **Para gravar vários registros em um fluxo de dados** O exemplo `put-records` a seguir grava um registro de dados usando a chave de partição especificada e outro registro de dados usando uma chave de partição diferente em uma única chamada. ``` aws kinesis put-records \ --stream-name samplestream \ --records Data=blob1,PartitionKey=partitionkey1 Data=blob2,PartitionKey=partitionkey2 ``` Resultado: ``` { "FailedRecordCount": 0, "Records": [ { "SequenceNumber": "49600883331171471519674795588238531498465399900093808706", "ShardId": "shardId-000000000004" }, { "SequenceNumber": "49600902273357540915989931256902715169698037101720764562", "ShardId": "shardId-000000000009" } ], "EncryptionType": "KMS" } ``` Para obter mais informações, consulte [Desenvolver produtores usando a API do Amazon Kinesis Data Streams com o AWS SDK for Java](https://docs.aws.amazon.com/streams/latest/dev/developing-producers-with-sdk.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams*. + Para ver detalhes da API, consulte [PutRecords](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/put-records.html) na *Referência de comandos da AWS CLI*. ### `register-stream-consumer` O código de exemplo a seguir mostra como usar `register-stream-consumer`. **AWS CLI** **Para registrar um consumidor de fluxo de dados** O exemplo `register-stream-consumer` a seguir registra um consumidor chamado `KinesisConsumerApplication` com o fluxo de dados especificado. ``` aws kinesis register-stream-consumer \ --stream-arn arn:aws:kinesis:us-west-2:012345678912:stream/samplestream \ --consumer-name KinesisConsumerApplication ``` Resultado: ``` { "Consumer": { "ConsumerName": "KinesisConsumerApplication", "ConsumerARN": "arn:aws:kinesis:us-west-2: 123456789012:stream/samplestream/consumer/KinesisConsumerApplication:1572383852", "ConsumerStatus": "CREATING", "ConsumerCreationTimestamp": 1572383852.0 } } ``` Para obter mais informações, consulte [Desenvolver consumidores com Fan-Out aprimorado usando a API Kinesis Data Streams](https://docs.aws.amazon.com/streams/latest/dev/building-enhanced-consumers-api.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams*. + Para ver detalhes da API, consulte [RegisterStreamConsumer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/register-stream-consumer.html) na *Referência de comandos da AWS CLI*. ### `remove-tags-from-stream` O código de exemplo a seguir mostra como usar `remove-tags-from-stream`. **AWS CLI** **Para remover tags de um fluxo de dados** O exemplo `remove-tags-from-stream` a seguir remove a tag com uma chave especificada do fluxo de dados especificado. ``` aws kinesis remove-tags-from-stream \ --stream-name samplestream \ --tag-keys samplekey ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar tags a fluxos](https://docs.aws.amazon.com/streams/latest/dev/tagging.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams*. + Para ver detalhes da API, consulte [RemoveTagsFromStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/remove-tags-from-stream.html) na *Referência de comandos da AWS CLI*. ### `split-shard` O código de exemplo a seguir mostra como usar `split-shard`. **AWS CLI** **Como dividir fragmentos** O exemplo `split-shard` a seguir divide o fragmento especificado em dois novos fragmentos usando uma nova chave de hash inicial de 10. ``` aws kinesis split-shard \ --stream-name samplestream \ --shard-to-split shardId-000000000000 \ --new-starting-hash-key 10 ``` Este comando não produz saída. Para obter mais informações, consulte [Dividir um fragmento](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-resharding-split.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams*. + Para ver detalhes da API, consulte [SplitShard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/split-shard.html) na *Referência de comandos da AWS CLI*. ### `start-stream-encryption` O código de exemplo a seguir mostra como usar `start-stream-encryption`. **AWS CLI** **Para habilitar a criptografia de fluxo de dados** O exemplo `start-stream-encryption` a seguir ativa a criptografia do lado do servidor para o fluxo especificado, usando a chave do AWS KMS especificada. ``` aws kinesis start-stream-encryption \ --encryption-type KMS \ --key-id arn:aws:kms:us-west-2:012345678912:key/a3c4a7cd-728b-45dd-b334-4d3eb496e452 \ --stream-name samplestream ``` Este comando não produz saída. Para obter mais informações, consulte [Proteção de dados no Amazon Kinesis Data Streams](https://docs.aws.amazon.com/streams/latest/dev/server-side-encryption.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams.* + Para obter detalhes a API, consulte [StartStreamEncryption](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/start-stream-encryption.html) na *Referência de comandos da AWS CLI*. ### `stop-stream-encryption` O código de exemplo a seguir mostra como usar `stop-stream-encryption`. **AWS CLI** **Para desativar a criptografia do fluxo de dados** O exemplo `stop-stream-encryption` a seguir desativa a criptografia do lado do servidor para o fluxo especificado, usando a chave do AWS KMS especificada. ``` aws kinesis start-stream-encryption \ --encryption-type KMS \ --key-id arn:aws:kms:us-west-2:012345678912:key/a3c4a7cd-728b-45dd-b334-4d3eb496e452 \ --stream-name samplestream ``` Este comando não produz saída. Para obter mais informações, consulte [Proteção de dados no Amazon Kinesis Data Streams](https://docs.aws.amazon.com/streams/latest/dev/server-side-encryption.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams.* + Para ver detalhes da API, consulte [StopStreamEncryption](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/stop-stream-encryption.html) na *Referência de comandos da AWS CLI*. ### `update-shard-count` O código de exemplo a seguir mostra como usar `update-shard-count`. **AWS CLI** **Para atualizar a contagem de fragmentos em um fluxo de dados** O exemplo `update-shard-count` a seguir atualiza a contagem de fragmentos do fluxo de dados especificado para 6. Este exemplo usa escala uniforme, que cria fragmentos do mesmo tamanho. ``` aws kinesis update-shard-count \ --stream-name samplestream \ --scaling-type UNIFORM_SCALING \ --target-shard-count 6 ``` Resultado: ``` { "StreamName": "samplestream", "CurrentShardCount": 3, "TargetShardCount": 6 } ``` Para obter mais informações, consulte [Refragmentar um fluxo](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-resharding.html) no *Guia do desenvolvedor do Amazon Kinesis Data Streams*. + Para ver detalhes da API, consulte [UpdateShardCount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/update-shard-count.html) na *Referência de comandos da AWS CLI*. # AWS KMS Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o AWS KMS. *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 ### `cancel-key-deletion` O código de exemplo a seguir mostra como usar `cancel-key-deletion`. **AWS CLI** **Como programar a exclusão de uma chave do KMS gerenciada pelo cliente** O exemplo `cancel-key-deletion` a seguir cancela a exclusão agendada de uma chave do KMS gerenciada pelo cliente. ``` aws kms cancel-key-deletion \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` Resultado: ``` { "KeyId": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab" } ``` Quando o comando `cancel-key-deletion` é bem-sucedido, a exclusão programada é cancelada. No entanto, o estado da chave do KMS será `Disabled`, portanto, não é possível usar a chave do KMS em operações de criptografia. Para restaurar sua funcionalidade, use o comando `enable-key`. Para obter mais informações, consulte [Programação e cancelamento de exclusão de chaves](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#deleting-keys-scheduling-key-deletion) no *Guia do desenvolvedor do AWS Key Management Service*. + Para ver detalhes da API, consulte [CancelKeyDeletion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/cancel-key-deletion.html) na *Referência de comandos da AWS CLI*. ### `connect-custom-key-store` O código de exemplo a seguir mostra como usar `connect-custom-key-store`. **AWS CLI** **Como conectar um repositório de chaves personalizado** O exemplo `connect-custom-key-store` a seguir reconecta o repositório de chaves personalizadas especificado. É possível usar um comando como esse para conectar um repositório de chaves personalizado pela primeira vez ou para reconectar um repositório de chaves que foi desconectado. É possível usar esse comando para conectar um repositório de chaves do AWS CloudHSM ou um repositório de chaves externo. ``` aws kms connect-custom-key-store \ --custom-key-store-id cks-1234567890abcdef0 ``` Esse comando não retorna nenhuma saída. Use o comando `describe-custom-key-stores` para verificar se o comando está em vigor. Para obter informações sobre como conectar um repositório de chaves do AWS CloudHSM, consulte [Conectar e desconectar um repositório de chaves do AWS CloudHSM](https://docs.aws.amazon.com/kms/latest/developerguide/disconnect-keystore.html) no *Guia do desenvolvedor do AWS Key Management Service*. Para obter informações sobre como conectar um repositório de chaves externo, consulte [Conectar e desconectar um repositório de chaves externo](https://docs.aws.amazon.com/kms/latest/developerguide/xks-connect-disconnect.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Para ver detalhes da API, consulte [ConnectCustomKeyStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/connect-custom-key-store.html) na *Referência de comandos da AWS CLI*. ### `create-alias` O código de exemplo a seguir mostra como usar `create-alias`. **AWS CLI** **Como criar um alias para uma chave do KMS** O comando `create-alias` a seguir cria um alias com o nome `example-alias` para a chave do KMS identificada pelo ID de chave `1234abcd-12ab-34cd-56ef-1234567890ab`. Os nomes de alias devem começar com `alias/`. Não use nomes de alias que comecem com `alias/aws`. Eles são reservados para uso pela AWS. ``` aws kms create-alias \ --alias-name alias/example-alias \ --target-key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` Esse comando não retorna resultados. Use o `list-aliases` comando para visualizar o novo alias. Para obter mais informações, consulte [Using aliases](https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Consulte detalhes da API em [CreateAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/create-alias.html) na *Referência de comandos da AWS CLI*. ### `create-custom-key-store` O código de exemplo a seguir mostra como usar `create-custom-key-store`. **AWS CLI** **Exemplo 1: criar um repositório de chaves do AWS CloudHSM** O exemplo `create-custom-key-store` a seguir cria um repositório de chaves do AWS CloudHSM apoiado por um cluster do AWS CloudHSM usando os parâmetros necessários. Também é possível adicionar o `custom-key-store-type``parameter with the default value: ``AWS_CLOUDHSM`. Para especificar a entrada do arquivo para o comando `trust-anchor-certificate` na AWS CLI, é necessário o prefixo `file://`. ``` aws kms create-custom-key-store \ --custom-key-store-name ExampleCloudHSMKeyStore \ --cloud-hsm-cluster-id cluster-1a23b4cdefg \ --key-store-password kmsPswd \ --trust-anchor-certificate file://customerCA.crt ``` Resultado: ``` { "CustomKeyStoreId": cks-1234567890abcdef0 } ``` Para obter mais informações, consulte [Criar um repositório de chaves do AWS CloudHSM](https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html) no *Guia do desenvolvedor do AWS Key Management Service*. **Exemplo 2: criar um repositório de chaves externo com conectividade de endpoint público** O exemplo `create-custom-key-store` a seguir cria um repositório de chaves externo (XKS) que se comunica com o AWS KMS pela Internet. Neste exemplo, o `XksProxyUriPath` usa um prefixo opcional de`example-prefix`. OBSERVAÇÃO: se a versão 1.0 da AWS CLI está sendo usada, execute o comando a seguir antes de especificar um parâmetro com um valor HTTP ou HTTPS, como o parâmetro XksProxyUriEndpoint. ``` aws configure set cli_follow_urlparam false ``` Caso contrário, a versão 1.0 da AWS substitui o valor do parâmetro pelo conteúdo encontrado nesse endereço de URI. ``` aws kms create-custom-key-store \ --custom-key-store-name ExamplePublicEndpointXKS \ --custom-key-store-type EXTERNAL_KEY_STORE \ --xks-proxy-connectivity PUBLIC_ENDPOINT \ --xks-proxy-uri-endpoint "https://myproxy.xks.example.com" \ --xks-proxy-uri-path "/example-prefix/kms/xks/v1" \ --xks-proxy-authentication-credential "AccessKeyId=ABCDE12345670EXAMPLE, RawSecretAccessKey=DXjSUawnel2fr6SKC7G25CNxTyWKE5PF9XX6H/u9pSo=" ``` Resultado: ``` { "CustomKeyStoreId": cks-2234567890abcdef0 } ``` Para obter mais informações, consulte [Criar um repositório de chaves externo](https://docs.aws.amazon.com/kms/latest/developerguide/create-keystorecreate-xks-keystore.html) no *Guia do desenvolvedor do AWS Key Management Service*. **Exemplo 3: criar um repositório de chaves externo com conectividade de serviço de endpoint da VPC** O exemplo `create-custom-key-store` a seguir cria um repositório de chaves externo (XKS) que usa um serviço de endpoint da VPC da Amazon para se comunicar com o AWS KMS. OBSERVAÇÃO: se a versão 1.0 da AWS CLI está sendo usada, execute o comando a seguir antes de especificar um parâmetro com um valor HTTP ou HTTPS, como o parâmetro XksProxyUriEndpoint. ``` aws configure set cli_follow_urlparam false ``` Caso contrário, a versão 1.0 da AWS substitui o valor do parâmetro pelo conteúdo encontrado nesse endereço de URI. ``` aws kms create-custom-key-store \ --custom-key-store-name ExampleVPCEndpointXKS \ --custom-key-store-type EXTERNAL_KEY_STORE \ --xks-proxy-connectivity VPC_ENDPOINT_SERVICE \ --xks-proxy-uri-endpoint "https://myproxy-private.xks.example.com" \ --xks-proxy-uri-path "/kms/xks/v1" \ --xks-proxy-vpc-endpoint-service-name "com.amazonaws.vpce.us-east-1.vpce-svc-example1" \ --xks-proxy-authentication-credential "AccessKeyId=ABCDE12345670EXAMPLE, RawSecretAccessKey=DXjSUawnel2fr6SKC7G25CNxTyWKE5PF9XX6H/u9pSo=" ``` Resultado: ``` { "CustomKeyStoreId": cks-3234567890abcdef0 } ``` Para obter mais informações, consulte [Criar um repositório de chaves externo](https://docs.aws.amazon.com/kms/latest/developerguide/create-keystorecreate-xks-keystore.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Para ver detalhes da API, consulte [CreateCustomKeyStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/create-custom-key-store.html) na *Referência de comandos da AWS CLI*. ### `create-grant` O código de exemplo a seguir mostra como usar `create-grant`. **AWS CLI** **Como criar uma concessão** O exemplo de `create-grant` a seguir cria uma concessão que permite que o usuário `exampleUser` use o comando `decrypt` na chave do KMS `1234abcd-12ab-34cd-56ef-1234567890ab` de exemplo. A entidade principal descontinuada é o perfil `adminRole`. A concessão usa a restrição de concessão `EncryptionContextSubset` para conceder essa permissão apenas quando o contexto de criptografia na solicitação `decrypt` incluir o par de chave/valor `"Department": "IT"`. ``` aws kms create-grant \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --grantee-principal arn:aws:iam::123456789012:user/exampleUser \ --operations Decrypt \ --constraints EncryptionContextSubset={Department=IT} \ --retiring-principal arn:aws:iam::123456789012:role/adminRole ``` Resultado: ``` { "GrantId": "1a2b3c4d2f5e69f440bae30eaec9570bb1fb7358824f9ddfa1aa5a0dab1a59b2", "GrantToken": "" } ``` Use o `list-grants` comando para visualizar informações detalhadas sobre a concessão. Para obter mais informações, consulte [Grants in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/grants.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Consulte detalhes da API em [CreateGrant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/create-grant.html) na *Referência de comandos da AWS CLI*. ### `create-key` O código de exemplo a seguir mostra como usar `create-key`. **AWS CLI** **Exemplo 1: como criar uma chave do KMS gerenciada pelo cliente no AWS KMS** O exemplo de `create-key` a seguir cria uma chave do KMS de criptografia simétrica. Não é necessário especificar parâmetros para criar a chave básica do KMS (uma chave de criptografia simétrica). Os valores padrão desses parâmetros criam uma chave de criptografia simétrica. Como esse comando não especifica uma política de chave, a chave do KMS adota a [política de chave padrão](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) para chaves do KMS criadas programaticamente. Use o comando `get-key-policy` para visualizar a política de chave. Use o comando `put-key-policy` para alterar a política de chave. ``` aws kms create-key ``` O comando `create-key` retorna os metadados da chave, incluindo o ID da chave e o ARN da nova chave do KMS. Use esses valores para identificar a chave do KMS em outras operações do AWS KMS. A saída não inclui as tags. Use `list-resource-tags command` para visualizar as tags de uma chave do KMS. Resultado: ``` { "KeyMetadata": { "AWSAccountId": "111122223333", "Arn": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "CreationDate": "2017-07-05T14:04:55-07:00", "CurrentKeyMaterialId": "0b7fd7ddbac6eef27907413567cad8c810e2883dc8a7534067a82ee1142fc1e6", "CustomerMasterKeySpec": "SYMMETRIC_DEFAULT", "Description": "", "Enabled": true, "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", "KeyManager": "CUSTOMER", "KeySpec": "SYMMETRIC_DEFAULT", "KeyState": "Enabled", "KeyUsage": "ENCRYPT_DECRYPT", "MultiRegion": false, "Origin": "AWS_KMS" "EncryptionAlgorithms": [ "SYMMETRIC_DEFAULT" ] } } ``` Observação: o comando `create-key` não permite especificar um alias. Use o comando `create-alias` para especificar um alias para a nova chave do KMS. Para obter mais informações, consulte [Creating keys](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) no *Guia do desenvolvedor do AWS Key Management Service*. **Exemplo 2: como criar uma chave RSA assimétrica do KMS para criptografia e decodificação** O exemplo de `create-key` a seguir cria uma chave do KMS que contém um par de chaves RSA assimétrico para criptografia e descriptografia. A especificação da chave e o uso da chave não podem ser alterados depois que a chave é criada. ``` aws kms create-key \ --key-spec RSA_4096 \ --key-usage ENCRYPT_DECRYPT ``` Resultado: ``` { "KeyMetadata": { "Arn": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "AWSAccountId": "111122223333", "CreationDate": "2021-04-05T14:04:55-07:00", "CustomerMasterKeySpec": "RSA_4096", "Description": "", "Enabled": true, "EncryptionAlgorithms": [ "RSAES_OAEP_SHA_1", "RSAES_OAEP_SHA_256" ], "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", "KeyManager": "CUSTOMER", "KeySpec": "RSA_4096", "KeyState": "Enabled", "KeyUsage": "ENCRYPT_DECRYPT", "MultiRegion": false, "Origin": "AWS_KMS" } } ``` Para obter mais informações, consulte [Asymmetric keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) no *Guia do desenvolvedor do AWS Key Management Service*. **Exemplo 3: como criar uma chave do KMS de curva elíptica assimétrica para assinatura e verificação** Como criar uma chave do KMS assimétrica que contém um par de chaves com curva elíptica (ECC) assimétrica para assinatura e verificação. O parâmetro `--key-usage` é obrigatório, embora `SIGN_VERIFY` seja o único valor válido para chaves ECC do KMS. A especificação da chave e o uso da chave não podem ser alterados depois que a chave é criada. ``` aws kms create-key \ --key-spec ECC_NIST_P521 \ --key-usage SIGN_VERIFY ``` Resultado: ``` { "KeyMetadata": { "Arn": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "AWSAccountId": "111122223333", "CreationDate": "2019-12-02T07:48:55-07:00", "CustomerMasterKeySpec": "ECC_NIST_P521", "Description": "", "Enabled": true, "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", "KeyManager": "CUSTOMER", "KeySpec": "ECC_NIST_P521", "KeyState": "Enabled", "KeyUsage": "SIGN_VERIFY", "MultiRegion": false, "Origin": "AWS_KMS", "SigningAlgorithms": [ "ECDSA_SHA_512" ] } } ``` Para obter mais informações, consulte [Asymmetric keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) no *Guia do desenvolvedor do AWS Key Management Service*. **Exemplo 4: criar uma chave ML-DSA assimétrica do KMS para assinatura e verificação** Este exemplo cria uma chave do algoritmo de assinatura digital baseado em rede de módulos (ML-DSA) para assinatura e verificação. O parâmetro key-usage é obrigatório, embora `SIGN_VERIFY` seja o único valor válido para chaves ML-DSA. ``` aws kms create-key \ --key-spec ML_DSA_65 \ --key-usage SIGN_VERIFY ``` Resultado: ``` { "KeyMetadata": { "Arn": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "AWSAccountId": "111122223333", "CreationDate": "2019-12-02T07:48:55-07:00", "Description": "", "Enabled": true, "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", "KeyManager": "CUSTOMER", "KeySpec": "ML_DSA_65", "KeyState": "Enabled", "KeyUsage": "SIGN_VERIFY", "MultiRegion": false, "Origin": "AWS_KMS", "SigningAlgorithms": [ "ML_DSA_SHAKE_256" ] } } ``` Para obter mais informações, consulte [Asymmetric keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) no *Guia do desenvolvedor do AWS Key Management Service*. **Exemplo 5: criar uma chave HMAC do KMS** O exemplo de `create-key` a seguir cria uma chave do KMS com HMAC de 384 bits. O valor `GENERATE_VERIFY_MAC` é obrigatório para o parâmetro `--key-usage`, mesmo que seja o único valor válido para chaves do KMS com HMAC. ``` aws kms create-key \ --key-spec HMAC_384 \ --key-usage GENERATE_VERIFY_MAC ``` Resultado: ``` { "KeyMetadata": { "Arn": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "AWSAccountId": "111122223333", "CreationDate": "2022-04-05T14:04:55-07:00", "CustomerMasterKeySpec": "HMAC_384", "Description": "", "Enabled": true, "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", "KeyManager": "CUSTOMER", "KeySpec": "HMAC_384", "KeyState": "Enabled", "KeyUsage": "GENERATE_VERIFY_MAC", "MacAlgorithms": [ "HMAC_SHA_384" ], "MultiRegion": false, "Origin": "AWS_KMS" } } ``` Para obter mais informações, consulte [HMAC keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) no *Guia do desenvolvedor do AWS Key Management Service*. **Exemplo 6: criar uma chave do KMS primária multirregional** O exemplo de `create-key` a seguir cria uma chave primária de criptografia simétrica multirregional. Como os valores padrão de todos os parâmetros criam uma chave de criptografia simétrica, somente o parâmetro `--multi-region` é necessário para a chave do KMS. Na AWS CLI, especifique o nome do parâmetro para indicar que o parâmetro booleano é verdadeiro. ``` aws kms create-key \ --multi-region ``` Resultado: ``` { "KeyMetadata": { "Arn": "arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef12345678990ab", "AWSAccountId": "111122223333", "CreationDate": "2021-09-02T016:15:21-09:00", "CurrentKeyMaterialId": "0b7fd7ddbac6eef27907413567cad8c810e2883dc8a7534067a82ee1142fc1e6", "CustomerMasterKeySpec": "SYMMETRIC_DEFAULT", "Description": "", "Enabled": true, "EncryptionAlgorithms": [ "SYMMETRIC_DEFAULT" ], "KeyId": "mrk-1234abcd12ab34cd56ef12345678990ab", "KeyManager": "CUSTOMER", "KeySpec": "SYMMETRIC_DEFAULT", "KeyState": "Enabled", "KeyUsage": "ENCRYPT_DECRYPT", "MultiRegion": true, "MultiRegionConfiguration": { "MultiRegionKeyType": "PRIMARY", "PrimaryKey": { "Arn": "arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef12345678990ab", "Region": "us-west-2" }, "ReplicaKeys": [] }, "Origin": "AWS_KMS" } } ``` Para obter mais informações, consulte [Asymmetric keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) no *Guia do desenvolvedor do AWS Key Management Service*. **Exemplo 7: criar uma chave do KMS para material de chave importada** O exemplo de `create-key` a seguir cria uma chave do KMS sem material de chave. Quando a operação for concluída, você poderá importar seu próprio material de chave na chave do KMS. Defina o parâmetro `--origin` como `EXTERNAL` para criar a chave do KMS. ``` aws kms create-key \ --origin EXTERNAL ``` Resultado: ``` { "KeyMetadata": { "Arn": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "AWSAccountId": "111122223333", "CreationDate": "2019-12-02T07:48:55-07:00", "CustomerMasterKeySpec": "SYMMETRIC_DEFAULT", "Description": "", "Enabled": false, "EncryptionAlgorithms": [ "SYMMETRIC_DEFAULT" ], "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", "KeyManager": "CUSTOMER", "KeySpec": "SYMMETRIC_DEFAULT", "KeyState": "PendingImport", "KeyUsage": "ENCRYPT_DECRYPT", "MultiRegion": false, "Origin": "EXTERNAL" } } ``` Para obter mais informações, consulte [Importing key material in AWS KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) no *Guia do desenvolvedor do AWS Key Management Service*. **Exemplo 6: como criar uma chave do KMS em um repositório de chaves do AWS CloudHSM** O exemplo de `create-key` a seguir cria uma chave do KMS no repositório de chaves do AWS CloudHSM especificado. A operação cria a chave do KMS e seus metadados no AWS KMS e cria o material da chave no cluster do AWS CloudHSM associado ao repositório de chaves personalizadas. Os parâmetros `--custom-key-store-id` e `--origin` são obrigatórios. ``` aws kms create-key \ --origin AWS_CLOUDHSM \ --custom-key-store-id cks-1234567890abcdef0 ``` Resultado: ``` { "KeyMetadata": { "Arn": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "AWSAccountId": "111122223333", "CloudHsmClusterId": "cluster-1a23b4cdefg", "CreationDate": "2019-12-02T07:48:55-07:00", "CustomerMasterKeySpec": "SYMMETRIC_DEFAULT", "CustomKeyStoreId": "cks-1234567890abcdef0", "Description": "", "Enabled": true, "EncryptionAlgorithms": [ "SYMMETRIC_DEFAULT" ], "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", "KeyManager": "CUSTOMER", "KeySpec": "SYMMETRIC_DEFAULT", "KeyState": "Enabled", "KeyUsage": "ENCRYPT_DECRYPT", "MultiRegion": false, "Origin": "AWS_CLOUDHSM" } } ``` Para obter mais informações, consulte [AWS CloudHSM key stores](https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html) no *Guia do desenvolvedor do AWS Key Management Service*. **Exemplo 8: criar uma chave do KMS em um repositório de chaves externo** O exemplo de `create-key` a seguir cria uma chave do KMS no repositório de chaves externo especificado. Os parâmetros `--custom-key-store-id`, `--origin` e `--xks-key-id` são obrigatórios neste comando. O parâmetro `--xks-key-id` especifica o ID de uma chave de criptografia simétrica existente no gerenciador de chaves externo. Essa chave serve como o material de chave externo para a chave do KMS. O valor do parâmetro `--origin` deve ser `EXTERNAL_KEY_STORE`. O parâmetro `custom-key-store-id` deve identificar um repositório de chaves externo conectado ao proxy do repositório de chaves externo. ``` aws kms create-key \ --origin EXTERNAL_KEY_STORE \ --custom-key-store-id cks-9876543210fedcba9 \ --xks-key-id bb8562717f809024 ``` Resultado: ``` { "KeyMetadata": { "Arn": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "AWSAccountId": "111122223333", "CreationDate": "2022-12-02T07:48:55-07:00", "CustomerMasterKeySpec": "SYMMETRIC_DEFAULT", "CustomKeyStoreId": "cks-9876543210fedcba9", "Description": "", "Enabled": true, "EncryptionAlgorithms": [ "SYMMETRIC_DEFAULT" ], "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", "KeyManager": "CUSTOMER", "KeySpec": "SYMMETRIC_DEFAULT", "KeyState": "Enabled", "KeyUsage": "ENCRYPT_DECRYPT", "MultiRegion": false, "Origin": "EXTERNAL_KEY_STORE", "XksKeyConfiguration": { "Id": "bb8562717f809024" } } } ``` Para obter mais informações, consulte [External key stores](https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Consulte detalhes da API em [CreateKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/create-key.html) na *Referência de comandos da AWS CLI*. ### `decrypt` O código de exemplo a seguir mostra como usar `decrypt`. **AWS CLI** **Exemplo 1: como descriptografar uma mensagem criptografada com uma chave simétrica do KMS (Linux e macOS)** O exemplo de comando `decrypt` a seguir demonstra a forma recomendada de descriptografar dados com a AWS CLI. Esta versão mostra como descriptografar dados com uma chave simétrica do KMS. Forneça o texto cifrado em um arquivo. No valor do parâmetro `--ciphertext-blob`, use o prefixo `fileb://`, que instrui a CLI a ler os dados de um arquivo binário. Se o arquivo não estiver no diretório atual, digite o caminho completo para o arquivo. Para obter mais informações sobre a leitura de valores de parâmetro da AWS CLI de um arquivo, consulte Carregar os parâmetros da AWS CLI de um arquivo (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-file.html) no *Guia do usuário da AWS Command Line Interface* e Best Practices for Local File Parameters (https://aws.amazon.com/blogs/developer/best-practices-for-local-file-parameters/) no *AWS Command Line Tool Blog*. Especifique a chave do KMS para descriptografar o texto cifrado. O parâmetro `--key-id` não é necessário ao descriptografar com uma chave do KMS simétrica. O AWS KMS pode obter o ID de chave da chave do KMS usada para criptografar os dados dos metadados no texto cifrado. Porém, sempre é uma prática recomendada especificar a chave do KMS que você está usando. Esta prática garante que você use a chave do KMS desejada e impede que você descriptografe um texto cifrado acidentalmente usando uma chave do KMS em que você não confia. Solicite a saída de texto simples como um valor de texto. O parâmetro `--query` instrui a CLI obter somente o valor do campo `Plaintext` da saída. O parâmetro `--output` retorna a saída como texto. Decodifique o texto simples em Base64 e salve-o em um arquivo. O seguinte exemplo canaliza ( \$1 ) o valor do parâmetro `Plaintext` para o utilitário Base64, que o decodifica. Em seguida, ele redireciona ( > ) a saída decodificada para o arquivo `ExamplePlaintext`. Antes de executar esse comando, substitua o ID de chave de exemplo por um ID de chave válido da sua conta da AWS. ``` aws kms decrypt \ --ciphertext-blob fileb://ExampleEncryptedFile \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --output text \ --query Plaintext | base64 \ --decode > ExamplePlaintextFile ``` Este comando não produz saída. A saída do comando `decrypt` é decodificada em base64 e salva em um arquivo. Para obter mais informações, consulte [Decrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html) na *Referência da API do AWS Key Management Service*. **Exemplo 2: como descriptografar uma mensagem criptografada com uma chave simétrica do KMS (prompt de comando do Windows)** O exemplo a seguir é igual ao anterior, mas ele usa o utilitário `certutil` para decodificar em Base64 os dados em texto simples. Esse procedimento requer dois comandos, conforme mostrado nos exemplos a seguir. Antes de executar esse comando, substitua o ID de chave de exemplo por um ID de chave válido da sua conta da AWS. ``` aws kms decrypt ^ --ciphertext-blob fileb://ExampleEncryptedFile ^ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ^ --output text ^ --query Plaintext > ExamplePlaintextFile.base64 ``` Execute o comando `certutil`. ``` certutil -decode ExamplePlaintextFile.base64 ExamplePlaintextFile ``` Resultado: ``` Input Length = 18 Output Length = 12 CertUtil: -decode command completed successfully. ``` Para obter mais informações, consulte [Decrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html) na *Referência da API do AWS Key Management Service*. **Exemplo 3: como descriptografar uma mensagem criptografada com uma chave assimétrica do KMS (Linux e macOS)** O exemplo de comando `decrypt` a seguir mostra como descriptografar dados criptografados sob uma chave RSA assimétrica do KMS. Ao usar uma chave assimétrica do KMS, o parâmetro `encryption-algorithm`, que especifica o algoritmo usado para criptografar o texto simples, é necessário. Antes de executar esse comando, substitua o ID de chave de exemplo por um ID de chave válido da sua conta da AWS. ``` aws kms decrypt \ --ciphertext-blob fileb://ExampleEncryptedFile \ --key-id 0987dcba-09fe-87dc-65ba-ab0987654321 \ --encryption-algorithm RSAES_OAEP_SHA_256 \ --output text \ --query Plaintext | base64 \ --decode > ExamplePlaintextFile ``` Este comando não produz saída. A saída do comando `decrypt` é decodificada em base64 e salva em um arquivo. Para obter mais informações, consulte [Asymmetric keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Consulte detalhes da API em [Decrypt](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/decrypt.html) na *Referência de comandos da AWS CLI*. ### `delete-alias` O código de exemplo a seguir mostra como usar `delete-alias`. **AWS CLI** **Como excluir um alias do AWS KMS** O exemplo de `delete-alias` a seguir exclui o alias `alias/example-alias`. O nome de alias deve começar com alias/. ``` aws kms delete-alias \ --alias-name alias/example-alias ``` Este comando não produz saída. Use o `list-aliases` comando para localizar o alias. Para obter mais informações, consulte [Deleting an alias](https://docs.aws.amazon.com/kms/latest/developerguide/alias-manage.html#alias-delete) no *Guia do desenvolvedor do AWS Key Management Service*. + Consulte detalhes da API em [DeleteAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/delete-alias.html) na *Referência de comandos da AWS CLI*. ### `delete-custom-key-store` O código de exemplo a seguir mostra como usar `delete-custom-key-store`. **AWS CLI** **Para excluir um repositório de chaves personalizado** O exemplo `delete-custom-key-store` a seguir exclui o repositório de chaves personalizado especificado. A exclusão de um repositório de chaves do AWS CloudHSM não afeta o cluster do CloudHSM associado. A exclusão de um repositório de chaves externo não afeta o proxy do repositório de chaves externo, o gerenciador de chaves externas ou chaves externas associadas. **OBSERVAÇÃO:** antes de excluir um repositório de chaves personalizado, é necessário agendar a exclusão de todas as chaves KMS no repositório de chaves personalizadas e esperar que essas chaves KMS sejam excluídas. Então, é necessário desconectar o repositório de chaves personalizado. Para obter ajuda para descobrir as chaves do KMS em seu repositório de chaves personalizado, consulte [Excluir um repositório de chaves do AWS CloudHSM (API)](https://docs.aws.amazon.com/kms/latest/developerguide/delete-keystore.html#delete-keystore-api) no *Guia do desenvolvedor do AWS Key Management Service*. ``` delete-custom-key-store \ --custom-key-store-id cks-1234567890abcdef0 ``` Esse comando não retorna nenhuma saída. Para verificar se o repositório de chaves personalizadas excluído, use o comando `describe-custom-key-stores`. Para obter informações sobre como excluir um repositório de chaves do AWS CloudHSM, consulte [Excluir um repositório de chaves do AWS CloudHSM](https://docs.aws.amazon.com/kms/latest/developerguide/delete-keystore.html) no *Guia do desenvolvedor do AWS Key Management Service*. Para obter informações sobre como excluir repositórios de chaves externos, consulte [Excluir um repositório de chaves externo](https://docs.aws.amazon.com/kms/latest/developerguide/delete-xks.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Para ver detalhes da API, consulte [DeleteCustomKeyStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/delete-custom-key-store.html) na *Referência de comandos da AWS CLI*. ### `delete-imported-key-material` O código de exemplo a seguir mostra como usar `delete-imported-key-material`. **AWS CLI** **Para excluir material de chave importado de uma chave do KMS** O exemplo `delete-imported-key-material` a seguir exclui o material de chave importado para uma chave do KMS. ``` aws kms delete-imported-key-material \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` Resultado: ``` { "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", "KeyMaterialId": "0b7fd7ddbac6eef27907413567cad8c810e2883dc8a7534067a82ee1142fc1e6" } ``` Para ter mais informações, consulte [Deleting imported key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-delete-key-material.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Para ver detalhes da API, consulte [DeleteImportedKeyMaterial](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/delete-imported-key-material.html) na *Referência de comandos da AWS CLI*. ### `derive-shared-secret` O código de exemplo a seguir mostra como usar `derive-shared-secret`. **AWS CLI** **Como derivar um segredo compartilhado** O exemplo `derive-shared-secret` a seguir deriva um segredo compartilhado usando um algoritmo de acordo de chave. É necessário usar um par de chave do KMS de curva elíptica assimétrica recomendado pela NIST (ECC) ou SM2 (somente nas regiões da China) com um valor de `KeyUsage` igual a `KEY_AGREEMENT` para chamar DeriveSharedSecret. ``` aws kms derive-shared-secret \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --key-agreement-algorithm ECDH \ --public-key "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvH3Yj0wbkLEpUl95Cv1cJVjsVNSjwGq3tCLnzXfhVwVvmzGN8pYj3U8nKwgouaHbBWNJYjP5VutbbkKS4Kv4GojwZBJyHN17kmxo8yTjRmjR15SKIQ8cqRA2uaERMLnpztIXdZp232PQPbWGxDyXYJ0aJ5EFSag" ``` Resultado: ``` { "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", "SharedSecret": "MEYCIQCKZLWyTk5runarx6XiAkU9gv3lbwPO/pHa+DXFehzdDwIhANwpsIV2g/9SPWLLsF6p/hiSskuIXMTRwqrMdVKWTMHG", "KeyAgreementAlgorithm": "ECDH", "KeyOrigin": "AWS_KMS" } ``` Para obter mais informações, consulte [DeriveSharedSecret](https://docs.aws.amazon.com/kms/latest/APIReference/API_DeriveSharedSecret.html) na *Referência da API do AWS Key Management Service*. + Para ver detalhes da API, consulte [DeriveSharedSecret](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/derive-shared-secret.html) na *Referência de comandos da AWS CLI*. ### `describe-custom-key-stores` O código de exemplo a seguir mostra como usar `describe-custom-key-stores`. **AWS CLI** **Exemplo 1: obter detalhes sobre um repositório de chaves do AWS CloudHSM** O exemplo `describe-custom-key-store` a seguir exibe os detalhes sobre o repositório de chaves AWS CloudHSM especificado. O comando é o mesmo para todos os tipos de repositório de chaves personalizadas, mas a saída difere conforme o tipo de repositório de chaves e, para um repositório de chaves externo, conforme sua opção de conectividade. Por padrão, esse comando exibe informações sobre todos os repositórios de chave personalizados na conta e região. Para exibir informações sobre um repositório de chaves personalizado específico, use o parâmetro `custom-key-store-name` ou `custom-key-store-id`. ``` aws kms describe-custom-key-stores \ --custom-key-store-name ExampleCloudHSMKeyStore ``` A saída desse comando inclui detalhes úteis sobre o repositório de chaves do AWS CloudHSM, incluindo seu estado de conexão (`ConnectionState`). Se o estado da conexão é `FAILED`, o resultado também inclui um campo `ConnectionErrorCode` que descreve o problema. Resultado: ``` { "CustomKeyStores": [ { "CloudHsmClusterId": "cluster-1a23b4cdefg", "ConnectionState": "CONNECTED", "CreationDate": "2022-04-05T14:04:55-07:00", "CustomKeyStoreId": "cks-1234567890abcdef0", "CustomKeyStoreName": "ExampleExternalKeyStore", "TrustAnchorCertificate": "" } ] } ``` Para obter mais informações, consulte [Visualizar um repositório de chaves do AWS CloudHSM](https://docs.aws.amazon.com/kms/latest/developerguide/view-keystore.html) no *Guia do desenvolvedor do AWS Key Management Service*. **Exemplo 2: obter detalhes sobre um repositório de chaves externo com conectividade de endpoint público** O exemplo `describe-custom-key-store` a seguir exibe os detalhes sobre o repositório de chaves externo. O comando é o mesmo para todos os tipos de repositório de chaves personalizadas, mas a saída difere conforme o tipo de repositório de chaves e, para um repositório de chaves externo, conforme sua opção de conectividade. Por padrão, esse comando exibe informações sobre todos os repositórios de chave personalizados na conta e região. Para exibir informações sobre um repositório de chaves personalizado específico, use o parâmetro `custom-key-store-name` ou `custom-key-store-id`. ``` aws kms describe-custom-key-stores \ --custom-key-store-id cks-9876543210fedcba9 ``` A saída desse comando inclui detalhes úteis sobre o repositório de chaves externo, incluindo seu estado de conexão (`ConnectionState`). Se o estado da conexão é `FAILED`, o resultado também inclui um campo `ConnectionErrorCode` que descreve o problema. Resultado: ``` { "CustomKeyStores": [ { "CustomKeyStoreId": "cks-9876543210fedcba9", "CustomKeyStoreName": "ExampleXKS", "ConnectionState": "CONNECTED", "CreationDate": "2022-12-02T07:48:55-07:00", "CustomKeyStoreType": "EXTERNAL_KEY_STORE", "XksProxyConfiguration": { "AccessKeyId": "ABCDE12345670EXAMPLE", "Connectivity": "PUBLIC_ENDPOINT", "UriEndpoint": "https://myproxy.xks.example.com", "UriPath": "/example-prefix/kms/xks/v1" } } ] } ``` Para obter mais informações, consulte [Visualizar um repositório de chaves externo](https://docs.aws.amazon.com/kms/latest/developerguide/view-xks-keystore.html) no *Guia do desenvolvedor do AWS Key Management Service*. **Exemplo 3: obter detalhes sobre um repositório de chaves externo com conectividade de serviço de endpoint da VPC** O exemplo `describe-custom-key-store` a seguir exibe os detalhes sobre o repositório de chaves externo. O comando é o mesmo para todos os tipos de repositório de chaves personalizadas, mas a saída difere conforme o tipo de repositório de chaves e, para um repositório de chaves externo, conforme sua opção de conectividade. Por padrão, esse comando exibe informações sobre todos os repositórios de chave personalizados na conta e região. Para exibir informações sobre um repositório de chaves personalizado específico, use o parâmetro `custom-key-store-name` ou `custom-key-store-id`. ``` aws kms describe-custom-key-stores \ --custom-key-store-id cks-2234567890abcdef0 ``` A saída desse comando inclui detalhes úteis sobre o repositório de chaves externo, incluindo seu estado de conexão (`ConnectionState`). Se o estado da conexão é `FAILED`, o resultado também inclui um campo `ConnectionErrorCode` que descreve o problema. Resultado: ``` { "CustomKeyStores": [ { "CustomKeyStoreId": "cks-3234567890abcdef0", "CustomKeyStoreName": "ExampleVPCExternalKeyStore", "ConnectionState": "CONNECTED", "CreationDate": "2022-12-22T07:48:55-07:00", "CustomKeyStoreType": "EXTERNAL_KEY_STORE", "XksProxyConfiguration": { "AccessKeyId": "ABCDE12345670EXAMPLE", "Connectivity": "VPC_ENDPOINT_SERVICE", "UriEndpoint": "https://myproxy-private.xks.example.com", "UriPath": "/kms/xks/v1", "VpcEndpointServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-example1" } } ] } ``` Para obter mais informações, consulte [Visualizar um repositório de chaves externo](https://docs.aws.amazon.com/kms/latest/developerguide/view-xks-keystore.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Para ver detalhes da API, consulte [DescribeCustomKeyStores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/describe-custom-key-stores.html) na *Referência de comandos da AWS CLI*. ### `describe-key` O código de exemplo a seguir mostra como usar `describe-key`. **AWS CLI** **Exemplo 1: como localizar informações detalhadas sobre uma chave do KMS** O exemplo de `describe-key` a seguir obtém informações detalhadas sobre a chave gerenciada da AWS para o Amazon S3 na conta e região do exemplo. Você pode usar esse comando para encontrar detalhes sobre chaves gerenciadas pela AWS e pelo cliente. Use o parâmetro `key-id` para especificar a chave do KMS. Este exemplo usa um valor de nome de alias, mas você pode usar um ID de chave, o ARN da chave, o nome do alias ou o ARN do alias neste comando. ``` aws kms describe-key \ --key-id alias/aws/s3 ``` Resultado: ``` { "KeyMetadata": { "AWSAccountId": "846764612917", "KeyId": "b8a9477d-836c-491f-857e-07937918959b", "Arn": "arn:aws:kms:us-west-2:846764612917:key/b8a9477d-836c-491f-857e-07937918959b", "CurrentKeyMaterialId": "0b7fd7ddbac6eef27907413567cad8c810e2883dc8a7534067a82ee1142fc1e6", "CreationDate": 2017-06-30T21:44:32.140000+00:00, "Enabled": true, "Description": "Default KMS key that protects my S3 objects when no other key is defined", "KeyUsage": "ENCRYPT_DECRYPT", "KeyState": "Enabled", "Origin": "AWS_KMS", "KeyManager": "AWS", "CustomerMasterKeySpec": "SYMMETRIC_DEFAULT", "EncryptionAlgorithms": [ "SYMMETRIC_DEFAULT" ] } } ``` Para obter mais informações, consulte [Viewing keys](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html) no *Guia do desenvolvedor do AWS Key Management Service*. **Exemplo 2: como obter detalhes sobre uma chave RSA assimétrica do KMS** O exemplo de `describe-key` a seguir obtém informações detalhadas sobre uma chave RSA assimétrica do KMS usada para assinatura e verificação. ``` aws kms describe-key \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` Resultado: ``` { "KeyMetadata": { "AWSAccountId": "111122223333", "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", "Arn": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "CreationDate": "2019-12-02T19:47:14.861000+00:00", "CustomerMasterKeySpec": "RSA_2048", "Enabled": false, "Description": "", "KeyState": "Disabled", "Origin": "AWS_KMS", "MultiRegion": false, "KeyManager": "CUSTOMER", "KeySpec": "RSA_2048", "KeyUsage": "SIGN_VERIFY", "SigningAlgorithms": [ "RSASSA_PKCS1_V1_5_SHA_256", "RSASSA_PKCS1_V1_5_SHA_384", "RSASSA_PKCS1_V1_5_SHA_512", "RSASSA_PSS_SHA_256", "RSASSA_PSS_SHA_384", "RSASSA_PSS_SHA_512" ] } } ``` **Exemplo 3: como obter detalhes sobre uma chave de réplica multirregional** O exemplo de `describe-key` a seguir os obtém metadados de uma chave de réplica multirregional. Essa chave multirregional é uma chave de criptografia simétrica. A saída de um comando `describe-key` para qualquer chave multirregional retorna informações sobre a chave primária e todas as suas réplicas. ``` aws kms describe-key \ --key-id arn:aws:kms:ap-northeast-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab ``` Resultado: ``` { "KeyMetadata": { "MultiRegion": true, "AWSAccountId": "111122223333", "Arn": "arn:aws:kms:ap-northeast-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab", "CreationDate": "2021-06-28T21:09:16.114000+00:00", "CurrentKeyMaterialId": "0b7fd7ddbac6eef27907413567cad8c810e2883dc8a7534067a82ee1142fc1e6", "Description": "", "Enabled": true, "KeyId": "mrk-1234abcd12ab34cd56ef1234567890ab", "KeyManager": "CUSTOMER", "KeyState": "Enabled", "KeyUsage": "ENCRYPT_DECRYPT", "Origin": "AWS_KMS", "CustomerMasterKeySpec": "SYMMETRIC_DEFAULT", "EncryptionAlgorithms": [ "SYMMETRIC_DEFAULT" ], "MultiRegionConfiguration": { "MultiRegionKeyType": "PRIMARY", "PrimaryKey": { "Arn": "arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab", "Region": "us-west-2" }, "ReplicaKeys": [ { "Arn": "arn:aws:kms:eu-west-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab", "Region": "eu-west-1" }, { "Arn": "arn:aws:kms:ap-northeast-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab", "Region": "ap-northeast-1" }, { "Arn": "arn:aws:kms:sa-east-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab", "Region": "sa-east-1" } ] } } } ``` **Exemplo 4: como obter detalhes sobre uma chave do KMS com HMAC** O exemplo de `describe-key` a seguir obtém informações detalhadas sobre uma chave do KMS com HMAC. ``` aws kms describe-key \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` Resultado: ``` { "KeyMetadata": { "AWSAccountId": "123456789012", "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", "Arn": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab", "CreationDate": "2022-04-03T22:23:10.194000+00:00", "Enabled": true, "Description": "Test key", "KeyUsage": "GENERATE_VERIFY_MAC", "KeyState": "Enabled", "Origin": "AWS_KMS", "KeyManager": "CUSTOMER", "CustomerMasterKeySpec": "HMAC_256", "MacAlgorithms": [ "HMAC_SHA_256" ], "MultiRegion": false } } ``` + Consulte detalhes da API em [DescribeKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/describe-key.html) na *Referência de comandos da AWS CLI*. ### `disable-key-rotation` O código de exemplo a seguir mostra como usar `disable-key-rotation`. **AWS CLI** **Para desativar a rotação automática de uma chave do KMS** O exemplo `disable-key-rotation` a seguir desativa a rotação automática de uma chave do KMS gerenciada pelo cliente. Para reativar a rotação automática, use o comando `enable-key-rotation`. ``` aws kms disable-key-rotation \ --key-id arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab ``` Este comando não produz saída. Para verificar se a rotação automática está desativada para a chave do KMS, use o comando `get-key-rotation-status`. Para obter mais informações, consulte [Rotacionar chaves](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Para ver detalhes da API, consulte [DisableKeyRotation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/disable-key-rotation.html) na *Referência de comandos da AWS CLI*. ### `disable-key` O código de exemplo a seguir mostra como usar `disable-key`. **AWS CLI** **Como desativar uma chave do KMS temporariamente** O exemplo `disable-key` a seguir desabilita uma chave do KMS gerenciada pelo cliente. Use o `enable-key` comando para reabilitar a chave do KMS. ``` aws kms disable-key \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` Este comando não produz saída. Para obter mais informações, consulte [Enabling and Disabling Keys](https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Consulte detalhes da API em [DisableKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/disable-key.html) na *Referência de comandos da AWS CLI*. ### `disconnect-custom-key-store` O código de exemplo a seguir mostra como usar `disconnect-custom-key-store`. **AWS CLI** **Como desconectar um repositório de chaves personalizado** O exemplo `disconnect-custom-key-store` a seguir desconecta um repositório de chaves personalizado do cluster do AWS CloudHSM. Pode ser desejável desconectar um repositório de chaves para solucionar um problema, atualizar suas configurações ou impedir que as chaves do KMS no repositório de chaves sejam usadas em operações criptográficas. Esse comando é o mesmo para todos os repositórios de chaves personalizados, inclusive os armazenamentos de chaves do AWS CloudHSM e repositórios de chaves externos. Antes de executar um comando como esse, substitua o ID de exemplo do armazenamento de chaves personalizado por um válido. ``` $ aws kms disconnect-custom-key-store \ --custom-key-store-id cks-1234567890abcdef0 ``` Este comando não produz saída. Para confirmar a efetividade do comando, use o comando `describe-custom-key-stores`. Para obter mais informações sobre como desconectar um repositório de chaves do AWS CloudHSM, consulte [Conectar e desconectar um repositório de chaves do AWS CloudHSM](https://docs.aws.amazon.com/kms/latest/developerguide/disconnect-keystore.html) no *Guia do desenvolvedor do AWS Key Management Service*. Para obter mais informações sobre como desconectar um repositório de chaves externo, consulte [Conectar e desconectar um repositório de chaves externo](https://docs.aws.amazon.com/kms/latest/developerguide/xks-connect-disconnect.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Para ver detalhes da API, consulte [DisconnectCustomKeyStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/disconnect-custom-key-store.html) na *Referência de comandos da AWS CLI*. ### `enable-key-rotation` O código de exemplo a seguir mostra como usar `enable-key-rotation`. **AWS CLI** **Como ativar a rotação automática de uma chave do KMS** O exemplo de `enable-key-rotation` a seguir viabiliza a alternância automática de uma chave do KMS gerenciada pelo cliente com um período de alternância de 180 dias. A chave do KMS será alternada em um ano (aproximadamente 365 dias) a partir da data em que esse comando for concluído e todos os anos a partir de então. O parâmetro `--key-id` identifica a chave do KMS. Este exemplo usa o valor do ARN da chave, mas é possível usar o ID da chave ou o ARN da chave do KMS. O parâmetro `--rotation-period-in-days` especifica o número de dias entre as datas de cada rotação. Especifique um valor entre 90 e 2.560 dias. Se nenhum valor for especificado, o valor padrão será de 365 dias. ``` aws kms enable-key-rotation \ --key-id arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab \ --rotation-period-in-days 180 ``` Este comando não produz saída. Use o `get-key-rotation-status` comando para verificar se a chave KMS está habilitada. Para obter mais informações, consulte [Rotacionar chaves](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Para ver detalhes da API, consulte [EnableKeyRotation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/enable-key-rotation.html) na *Referência de comandos da AWS CLI*. ### `enable-key` O código de exemplo a seguir mostra como usar `enable-key`. **AWS CLI** **Para habilitar uma chave do KMS** O exemplo de `enable-key` a seguir habilita uma chave gerenciada pelo cliente. Você pode usar um comando como esse para habilitar uma chave do KMS que foi temporariamente desabilitada usando o comando `disable-key`. Você também pode usá-lo para habilitar uma chave do KMS que está desabilitada porque foi programada para exclusão, mas a exclusão foi cancelada. Use o parâmetro `key-id` para especificar a chave do KMS. Este exemplo usa um valor de ID de chave, mas você pode usar um ID de chave ou o valor do ARN da chave neste comando. Antes de executar esse comando, substitua o ID da chave de exemplo por um ID válido. ``` aws kms enable-key \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` Este comando não produz saída. Use o `describe-key` comando para verificar se a chave KMS está habilitada. Consulte os valores dos campos `KeyState` e `Enabled` na saída `describe-key`. Para obter mais informações, consulte [Enabling and Disabling Keys](https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Consulte detalhes da API em [EnableKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/enable-key.html) na *Referência de comandos da AWS CLI*. ### `encrypt` O código de exemplo a seguir mostra como usar `encrypt`. **AWS CLI** **Exemplo 1: como criptografar o conteúdo de um arquivo no Linux ou no macOS** O comando `encrypt` a seguir demonstra a forma recomendada de criptografar dados com a AWS CLI. ``` aws kms encrypt \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --plaintext fileb://ExamplePlaintextFile \ --output text \ --query CiphertextBlob | base64 \ --decode > ExampleEncryptedFile ``` O comando realiza diversas ações: Usa o parâmetro `--plaintext` para indicar os dados a serem criptografados. Esse valor de parâmetro deve ser codificado em base64. O valor do parâmetro `plaintext` deve ser codificado em base64, ou você deve usar o prefixo `fileb://`, que informa a AWS CLI para que leia os dados binários do arquivo. Se o arquivo não estiver no diretório atual, digite o caminho completo do arquivo. Por exemplo: `fileb:///var/tmp/ExamplePlaintextFile` ou `fileb://C:\Temp\ExamplePlaintextFile`. Para ter mais informações sobre a leitura de valores de parâmetros da AWS CLI em um arquivo, consulte [Carregar um parâmetro de um arquivo](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-file) na *Referência de comandos da AWS Command Line Interface* e [Best Practices for Local File Parameters](https://blogs.aws.amazon.com/cli/post/TxLWWN1O25V1HE/Best-Practices-for-Local-File-Parameters) no AWS Developer Tools Blog. Usa o `--output` e o `--query` para controlar a saída do comando. Esses parâmetros extraem os dados criptografados, denominados *texto cifrado* da saída do comando. Para ter mais informações sobre como controlar a saída, consulte [Controle de saída do comando](https://docs.aws.amazon.com/cli/latest/userguide/controlling-output.html) no *Guia do usuário da AWS Command Line Interface*. Usa o utilitário `base64` para decodificar a saída extraída para dados binários. O texto cifrado exibido por um comando `encrypt` bem-sucedido é um texto codificado em base64. Você deve codificar o texto antes de usar a AWS CLI para descriptografá-lo. Salva o texto cifrado binário em um arquivo. A parte final do comando (`> ExampleEncryptedFile`) salva o texto cifrado binário em um arquivo para facilitar a descriptografia. Consulte os exemplos de descriptografia para ver um comando de exemplo que usa a AWS CLI para descriptografar dados. **Exemplo 2: como usar a AWS CLI para criptografar dados no Windows** Esse exemplo é igual ao exemplo anterior, mas usa a ferramenta `certutil` em vez do `base64`. Esse procedimento requer dois comandos, conforme mostrado no exemplo a seguir. ``` aws kms encrypt \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --plaintext fileb://ExamplePlaintextFile \ --output text \ --query CiphertextBlob > C:\Temp\ExampleEncryptedFile.base64 certutil -decode C:\Temp\ExampleEncryptedFile.base64 C:\Temp\ExampleEncryptedFile ``` **Exemplo 3: criptografia com uma chave do KMS assimétrica** O comando `encrypt` a seguir mostra como criptografar texto simples com uma chave assimétrica do KMS. O parâmetro `--encryption-algorithm` é obrigatório. Como em todos os comandos da `encrypt` CLI, o parâmetro `plaintext` deve ser codificado em base64 ou você deve usar o prefixo `fileb://`, que informa a AWS CLI para ler os dados binários do arquivo. ``` aws kms encrypt \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --encryption-algorithm RSAES_OAEP_SHA_256 \ --plaintext fileb://ExamplePlaintextFile \ --output text \ --query CiphertextBlob | base64 \ --decode > ExampleEncryptedFile ``` Este comando não produz saída. + Consulte detalhes da API em [Encrypt](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/encrypt.html) na *Referência de comandos da AWS CLI*. ### `generate-data-key-pair-without-plaintext` O código de exemplo a seguir mostra como usar `generate-data-key-pair-without-plaintext`. **AWS CLI** **Para gerar um par de chaves de dados assimétricos ECC NIST P** O exemplo `generate-data-key-pair-without-plaintext` a seguir solicita um par de chaves ECC NIST P384 para uso fora da AWS. O comando retorna uma chave pública de texto descriptografado e uma cópia da chave privada criptografada na chave do KMS especificada. Ele não retorna uma chave privada de texto descriptografado. É possível armazenar a chave privada criptografada com os dados criptografados com segurança, e chamar o AWS KMS para descriptografar a chave privada quando precisar usá-la. Para solicitar um par de chaves de dados assimétricos ECC NIST P384, use o parâmetro `key-pair-spec` com um valor de `ECC_NIST_P384`. A chave do KMS especificada deve ser uma chave de criptografia simétrica do KMS, ou seja, uma chave do KMS com um valor de `KeySpec` igual a `SYMMETRIC_DEFAULT`. OBSERVAÇÃO: os valores na saída deste exemplo são truncados para exibição. ``` aws kms generate-data-key-pair-without-plaintext \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --key-pair-spec ECC_NIST_P384 ``` Resultado: ``` { "PrivateKeyCiphertextBlob": "AQIDAHi6LtupRpdKl2aJTzkK6FbhOtQkMlQJJH3PdtHvS/y+hAFFxmiD134doUDzMGmfCEtcAAAHaTCCB2UGCSqGSIb3DQEHBqCCB1...", "PublicKey": "MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEA3A3eGMyPrvSn7+LdlJE1oUoQV5HpEuHAVbdOyND+NmYDH/mL1OSIEuLrcdZ5hrMH4pk83r40l...", "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "KeyMaterialId": "0b7fd7ddbac6eef27907413567cad8c810e2883dc8a7534067a82ee1142fc1e6", "KeyPairSpec": "ECC_NIST_P384" } ``` As `PublicKey` e `PrivateKeyCiphertextBlob` são retornadas no formato codificado em base64. Para obter mais informações, consulte [Pares de chaves de dados](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-key-pairs) no *Guia do desenvolvedor do AWS Key Management Service*. + Para ver detalhes da API, consulte [GenerateDataKeyPairWithoutPlaintext](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/generate-data-key-pair-without-plaintext.html) na *Referência de comandos da AWS CLI*. ### `generate-data-key-pair` O código de exemplo a seguir mostra como usar `generate-data-key-pair`. **AWS CLI** **Para gerar um par de chaves de dados assimétricos RSA de 2048 bits** O exemplo `generate-data-key-pair` a seguir solicita uma par de chave de dados assimétrico RSA de 2048 bits para uso fora da AWS. O comando retorna uma chave de dados em texto simples para uso e exclusão imediatos e uma cópia da chave de dados criptografada na chave do KMS especificada. A chave de dados criptografada pode ser armazenada com segurança junto com os dados criptografados. Para solicitar um par de chave de dados assimétrico RSA de 2048 bits, use o parâmetro `key-pair-spec` com o valor `RSA_2048`. A chave do KMS especificada deve ser uma chave de criptografia simétrica do KMS, ou seja, uma chave do KMS com um valor de `KeySpec` igual a `SYMMETRIC_DEFAULT`. OBSERVAÇÃO: os valores na saída deste exemplo são truncados para exibição. ``` aws kms generate-data-key-pair \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --key-pair-spec RSA_2048 ``` Resultado: ``` { "PrivateKeyCiphertextBlob": "AQIDAHi6LtupRpdKl2aJTzkK6FbhOtQkMlQJJH3PdtHvS/y+hAFFxmiD134doUDzMGmfCEtcAAAHaTCCB2UGCSqGSIb3DQEHBqCCB1...", "PrivateKeyPlaintext": "MIIG/QIBADANBgkqhkiG9w0BAQEFAASCBucwggbjAgEAAoIBgQDcDd4YzI+u9Kfv4t2UkTWhShBXkekS4cBVt07I0P42ZgMf+YvU5IgS4ut...", "PublicKey": "MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEA3A3eGMyPrvSn7+LdlJE1oUoQV5HpEuHAVbdOyND+NmYDH/mL1OSIEuLrcdZ5hrMH4pk83r40l...", "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "KeyMaterialId": "0b7fd7ddbac6eef27907413567cad8c810e2883dc8a7534067a82ee1142fc1e6" "KeyPairSpec": "RSA_2048" } ``` As `PublicKey`, `PrivateKeyPlaintext` e `PrivateKeyCiphertextBlob` são retornadas no formato codificado em base64. Para obter mais informações, consulte [Pares de chaves de dados](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-key-pairs) no *Guia do desenvolvedor do AWS Key Management Service*. + Para ver detalhes da API, consulte [GenerateDataKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/generate-data-key-pair.html) na *Referência de comandos da AWS CLI*. ### `generate-data-key-without-plaintext` O código de exemplo a seguir mostra como usar `generate-data-key-without-plaintext`. **AWS CLI** **Como gerar uma chave de dados simétrica de 256 bits sem uma chave de texto simples** O exemplo de `generate-data-key-without-plaintext` a seguir solicita uma cópia criptografada de uma chave de dados simétrica de 256 bits para uso externo à AWS. Você pode chamar o AWS KMS para descriptografar a chave de dados quando quiser usá-la. Use o parâmetro `key-spec` com um valor de `AES_256` para solicitar uma chave de dados de 256 bits. Use o parâmetro `key-spec` com um valor de `AES_128` para solicitar uma chave de dados de 128 bits. Para todos os outros comprimentos de chave de dados, use o parâmetro `number-of-bytes`. A chave do KMS especificada deve ser uma chave de criptografia simétrica do KMS, ou seja, uma chave do KMS com um valor de especificação de chave de SYMMETRIC\$1DEFAULT. ``` aws kms generate-data-key-without-plaintext \ --key-id "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" \ --key-spec AES_256 ``` Resultado: ``` { "CiphertextBlob": "AQEDAHjRYf5WytIc0C857tFSnBaPn2F8DgfmThbJlGfR8P3WlwAAAH4wfAYJKoZIhvcNAQcGoG8wbQIBADBoBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDEFogL", "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "KeyMaterialId": "0b7fd7ddbac6eef27907413567cad8c810e2883dc8a7534067a82ee1142fc1e6" } ``` A `CiphertextBlob` (chave de dados criptografada) é retornada em um formato codificado em base64. Para obter mais informações, consulte [Data keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys) no *Guia do desenvolvedor do AWS Key Management Service*. + Consulte detalhes da API em [GenerateDataKeyWithoutPlaintext](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/generate-data-key-without-plaintext.html) na *Referência de comandos da AWS CLI*. ### `generate-data-key` O código de exemplo a seguir mostra como usar `generate-data-key`. **AWS CLI** **Exemplo 1: como gerar uma chave de dados simétrica de 256 bits** O exemplo `generate-data-key` a seguir solicita uma chave de dados simétrica de 256 bits para uso externo à AWS. O comando retorna uma chave de dados em texto simples para uso e exclusão imediatos e uma cópia da chave de dados criptografada na chave do KMS especificada. A chave de dados criptografada pode ser armazenada com segurança junto com os dados criptografados. Use o parâmetro `key-spec` com um valor de `AES_256` para solicitar uma chave de dados de 256 bits. Use o parâmetro `key-spec` com um valor de `AES_128` para solicitar uma chave de dados de 128 bits. Para todos os outros comprimentos de chave de dados, use o parâmetro `number-of-bytes`. A chave do KMS especificada deve ser uma chave de criptografia simétrica do KMS, ou seja, uma chave do KMS com um valor de especificação de chave de SYMMETRIC\$1DEFAULT. ``` aws kms generate-data-key \ --key-id alias/ExampleAlias \ --key-spec AES_256 ``` Resultado: ``` { "Plaintext": "VdzKNHGzUAzJeRBVY+uUmofUGGiDzyB3+i9fVkh3piw=", "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "KeyMaterialId": "0b7fd7ddbac6eef27907413567cad8c810e2883dc8a7534067a82ee1142fc1e6", "CiphertextBlob": "AQEDAHjRYf5WytIc0C857tFSnBaPn2F8DgfmThbJlGfR8P3WlwAAAH4wfAYJKoZIhvcNAQcGoG8wbQIBADBoBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDEFogLqPWZconQhwHAIBEIA7d9AC7GeJJM34njQvg4Wf1d5sw0NIo1MrBqZa+YdhV8MrkBQPeac0ReRVNDt9qleAt+SHgIRF8P0H+7U=" } ``` A `Plaintext` (chave de dados em texto simples) e a `CiphertextBlob` (chave de dados criptografada) são retornadas no formato codificado em base64. Para obter mais informações, consulte [Data keys](https://docs.aws.amazon.com/kms/latest/developerguide/data-keys.html) no *Guia do desenvolvedor do AWS Key Management Service*. **Exemplo 2: como gerar uma chave de dados simétrica de 512 bits** O exemplo de `generate-data-key` a seguir solicita uma chave de dados simétrica de 512 bits para criptografia e descriptografia. O comando retorna uma chave de dados em texto simples para uso e exclusão imediatos e uma cópia da chave de dados criptografada na chave do KMS especificada. A chave de dados criptografada pode ser armazenada com segurança junto com os dados criptografados. Use o parâmetro `number-of-bytes` para solicitar um comprimento de chave diferente de 128 ou 256 bits. Para solicitar uma chave de dados de 512 bits, o exemplo a seguir usa o parâmetro `number-of-bytes` com um valor de 64 (bytes). A chave do KMS especificada deve ser uma chave de criptografia simétrica do KMS, ou seja, uma chave do KMS com um valor de especificação de chave de SYMMETRIC\$1DEFAULT. OBSERVAÇÃO: os valores na saída deste exemplo são truncados para exibição. ``` aws kms generate-data-key \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --number-of-bytes 64 ``` Resultado: ``` { "CiphertextBlob": "AQIBAHi6LtupRpdKl2aJTzkK6FbhOtQkMlQJJH3PdtHvS/y+hAEnX/QQNmMwDfg2korNMEc8AAACaDCCAmQGCSqGSIb3DQEHBqCCAlUwggJRAgEAMIICSgYJKoZ...", "Plaintext": "ty8Lr0Bk6OF07M2BWt6qbFdNB+G00ZLtf5MSEb4al3R2UKWGOp06njAwy2n72VRm2m7z/Pm9Wpbvttz6a4lSo9hgPvKhZ5y6RTm4OovEXiVfBveyX3DQxDzRSwbKDPk/...", "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "KeyMaterialId": "0b7fd7ddbac6eef27907413567cad8c810e2883dc8a7534067a82ee1142fc1e6" } ``` `Plaintext` (chave de dados em texto simples) e `CiphertextBlob` (chave de dados criptografada) são retornadas no formato codificado em base64. Para obter mais informações, consulte [Data keys](https://docs.aws.amazon.com/kms/latest/developerguide/data-keys.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Consulte detalhes da API em [GenerateDataKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/generate-data-key.html) na *Referência de comandos da AWS CLI*. ### `generate-mac` O código de exemplo a seguir mostra como usar `generate-mac`. **AWS CLI** **Exemplo 1: gerar um HMAC para uma mensagem** O comando `generate-mac` a seguir gera um HMAC para uma mensagem, uma chave HMAC do KMS e um algoritmo MAC. A chave HMAC especificada do KMS deve ser compatível com o algoritmo. Na AWS CLI v2, o valor do parâmetro `message` deve ser codificado em base64. Também é possível salvar a mensagem em um arquivo e usar o prefixo `fileb://`, que instrui a AWS CLI a ler dados binários do arquivo. Antes de executar esse comando, substitua o ID de chave de exemplo por um ID de chave válido da sua conta da AWS. O ID da chave deverá representar uma chave HMAC do KMS com o uso da chave `GENERATE_VERIFY_MAC`. ``` msg=(echo 'Hello World' | base64) aws kms generate-mac \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --message fileb://Message \ --mac-algorithm HMAC_SHA_384 ``` Resultado: ``` { "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "Mac": "", "MacAlgorithm": "HMAC_SHA_384" } ``` Para ter mais informações sobre como usar chaves HMAC do KMS no AWS KMS, consulte [HMAC keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) no *Guia do desenvolvedor do AWS Key Management Service*. **Exemplo 2: salvar um HMAC em um arquivo (Linux e macOS)** O exemplo `generate-mac` a seguir gera um HMAC para uma mensagem curta armazenada em um arquivo local. O comando também obtém a propriedade `Mac` da resposta, decodifica a resposta em base64 e salva a resposta no arquivo ExampleMac. É possível usar o arquivo MAC em um comando `verify-mac` que verifique o MAC. O comando `generate-mac` requer uma mensagem codificada em base64 e um algoritmo MAC compatível com sua chave HMAC do KMS. Para obter os algoritmos MAC compatíveis com sua chave do KMS, use o comando `describe-key`. Antes de executar esse comando, substitua o ID de chave de exemplo por um ID de chave válido da sua conta da AWS. O ID da chave deve representar uma chave assimétrica do KMS com o uso da chave GENERATE\$1VERIFY\$1MAC. ``` echo 'hello world' | base64 > EncodedMessage aws kms generate-mac \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --message fileb://EncodedMessage \ --mac-algorithm HMAC_SHA_384 \ --output text \ --query Mac | base64 --decode > ExampleMac ``` Este comando não produz saída. Este exemplo extrai a propriedade `Mac` da saída e a salva em um arquivo. Para ter mais informações sobre como usar chaves HMAC do KMS no AWS KMS, consulte [HMAC keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Para ver detalhes da API, consulte [GenerateMac](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/generate-mac.html) na *Referência de comandos da AWS CLI*. ### `generate-random` O código de exemplo a seguir mostra como usar `generate-random`. **AWS CLI** **Exemplo 1: como gerar uma string de bytes aleatória de 256 bits (Linux ou macOS)** O exemplo de `generate-random` a seguir gera uma string de bytes aleatórios de 256 bits (32 bytes) codificada em base64. O exemplo decodifica a string de bytes e a salva no arquivo aleatório. Ao executar esse comando, use o parâmetro `number-of-bytes` para especificar o tamanho do valor aleatório em bytes. Você não especifica uma chave do KMS ao executar esse comando. A sequência de bytes aleatória não está relacionada a nenhuma chave do KMS. Por padrão, o AWS KMS gera o número aleatório. No entanto, se você especificar um [repositório de chaves personalizado](https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html), a sequência de bytes aleatória será gerada no cluster do AWS CloudHSM associado ao repositório de chaves personalizado. Este exemplo usa os seguintes parâmetros e valores: Ele usa o parâmetro obrigatório `--number-of-bytes` com o valor de `32` para solicitar uma string de 32 bytes (256 bits). Ele usa o parâmetro `--output` com o valor de `text` para direcionar a AWS CLI a retornar a saída como texto em vez de um JSON. Ele usa `--query parameter` para extrair o valor da propriedade `Plaintext` da resposta. Ele canaliza ( \$1 ) a saída do comando para o utilitário `base64`, que decodifica a saída extraída. Ele usa o operador de redirecionamento ( > ) para salvar a string de bytes decodificada no arquivo `ExampleRandom`. Ele usa o operador de redirecionamento ( > ) para salvar o texto cifrado binário em um arquivo. ``` aws kms generate-random \ --number-of-bytes 32 \ --output text \ --query Plaintext | base64 --decode > ExampleRandom ``` Este comando não produz saída. Para obter mais informações, consulte [GenerateRandom](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateRandom.html) na *Referência da API do AWS Key Management Service*. **Exemplo 2: como gerar um número aleatório de 256 bits (prompt de comando do Windows)** O exemplo a seguir usa o comando `generate-random` para gerar uma string aleatória de 256 bits (32 bytes) codificada em base64. O exemplo decodifica a string de bytes e a salva no arquivo aleatório. Esse exemplo é igual ao exemplo anterior, mas usa o utilitário `certutil` no Windows para decodificar em base64 a string de bytes aleatória antes de salvá-la em um arquivo. Primeiro, gere uma string de bytes aleatória codificada em base64 e salve-a em um arquivo temporário (`ExampleRandom.base64`). ``` aws kms generate-random \ --number-of-bytes 32 \ --output text \ --query Plaintext > ExampleRandom.base64 ``` Como a saída do comando `generate-random` é salva em um arquivo, esse exemplo não produz nenhuma saída. Use o comando `certutil -decode` para decodificar a string de bytes codificada em base64 no arquivo `ExampleRandom.base64`. Em seguida, ele salva a string de bytes decodificada no arquivo `ExampleRandom`. ``` certutil -decode ExampleRandom.base64 ExampleRandom ``` Resultado: ``` Input Length = 18 Output Length = 12 CertUtil: -decode command completed successfully. ``` Para obter mais informações, consulte [GenerateRandom](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateRandom.html) na *Referência da API do AWS Key Management Service*. + Consulte detalhes da API em [GenerateRandom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/generate-random.html) na *Referência de comandos da AWS CLI*. ### `get-key-policy` O código de exemplo a seguir mostra como usar `get-key-policy`. **AWS CLI** **Como copiar uma política de chave de uma chave do KMS para outra chave do KMS** O exemplo de `get-key-policy` a seguir obtém a política de chave de uma chave do KMS e a salva em um arquivo de texto. Em seguida, ele substitui a política de uma chave diferente do KMS usando o arquivo de texto como a entrada da política. Como o parâmetro `--policy` de `put-key-policy` requer uma string, você deve usar a opção `--output text` para retornar a saída como uma string de texto em vez de JSON. ``` aws kms get-key-policy \ --policy-name default \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --query Policy \ --output text > policy.txt aws kms put-key-policy \ --policy-name default \ --key-id 0987dcba-09fe-87dc-65ba-ab0987654321 \ --policy file://policy.txt ``` Este comando não produz saída. Para obter mais informações, consulte [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) na *Referência da API do AWS KMS*. + Consulte detalhes da API em [GetKeyPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/get-key-policy.html) na *Referência de comandos da AWS CLI*. ### `get-key-rotation-status` O código de exemplo a seguir mostra como usar `get-key-rotation-status`. **AWS CLI** **Para recuperar o status de rotação de uma chave do KMS.** O exemplo `get-key-rotation-status` a seguir retorna informações sobre o status de rotação da chave do KMS especificada, incluindo se a rotação automática está ativada, o período de rotação e a próxima data de rotação programada. É possível usar esse comando em chaves do KMS gerenciadas pelo cliente e chaves do KMS gerenciadas pela AWS. No entanto, todas as chaves do KMS gerenciadas pela AWS são alternadas automaticamente a cada ano. ``` aws kms get-key-rotation-status \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` Resultado: ``` { "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", "KeyRotationEnabled": true, "NextRotationDate": "2024-02-14T18:14:33.587000+00:00", "RotationPeriodInDays": 365 } ``` Para obter mais informações, consulte [Rotacionar chaves](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Para ver detalhes da API, consulte [GetKeyRotationStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/get-key-rotation-status.html) na *Referência de comandos da AWS CLI*. ### `get-parameters-for-import` O código de exemplo a seguir mostra como usar `get-parameters-for-import`. **AWS CLI** **Para obter os itens necessários para importar material de chave para uma chave do KMS** O exemplo `get-parameters-for-import` a seguir obtém a chave pública e o token de importação necessários para importar material de chave para uma chave do KMS. Ao usar o comando `import-key-material`, certifique-se de usar o token de importação e o material da chave criptografados pela chave pública que foram retornados no mesmo comando `get-parameters-for-import`. Além disso, o algoritmo de encapsulamento especificado neste comando deve ser usado para criptografar o material de chave com a chave pública. Use o parâmetro `key-id` para especificar a chave do KMS. Este exemplo usa um valor de ID de chave, mas é possível usar o ID ou ARN da chave neste comando. ``` aws kms get-parameters-for-import \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --wrapping-algorithm RSAES_OAEP_SHA_256 \ --wrapping-key-spec RSA_2048 ``` Resultado: ``` { "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "PublicKey": "", "ImportToken": "", "ParametersValidTo": 1593893322.32 } ``` Para obter mais informações, consulte [Baixar a chave pública e o token de importação](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-get-public-key-and-token.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Para ver detalhes da API, consulte [GetParametersForImport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/get-parameters-for-import.html) na *Referência de comandos da AWS CLI*. ### `get-public-key` O código de exemplo a seguir mostra como usar `get-public-key`. **AWS CLI** **Exemplo 1: baixar a chave pública de uma chave do KMS assimétrica** O exemplo `get-public-key` a seguir baixa a chave pública de uma chave do KMS assimétrica. Além de retornar a chave pública, a saída inclui informações necessárias para usar a chave pública com segurança fora do AWS KMS, inclusive o uso da chave e os algoritmos de criptografia compatíveis. ``` aws kms get-public-key \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` Resultado: ``` { "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "PublicKey": "jANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAl5epvg1/QtJhxSi2g9SDEVg8QV/...", "CustomerMasterKeySpec": "RSA_4096", "KeyUsage": "ENCRYPT_DECRYPT", "EncryptionAlgorithms": [ "RSAES_OAEP_SHA_1", "RSAES_OAEP_SHA_256" ] } ``` Para obter mais informações sobre o uso de chaves assimétricas do KMS no AWS KMS, consulte [Chaves assimétricas no AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) no *Guia do desenvolvedor do AWS Key Management Service*. **Exemplo 2: converter uma chave pública para o formato DER (Linux e macOS)** O exemplo `get-public-key` a seguir baixa a chave pública de uma chave do KMS assimétrica e a salva em um arquivo DER. Ao usar o comando `get-public-key` na AWS CLI, ele retorna uma chave pública X.509 codificada em DER, que é codificada em Base64. Este exemplo obtém o valor da propriedade `PublicKey` como texto. Ele decodifica a `PublicKey` em Base64 e a salva no arquivo `public_key.der`. O parâmetro `output` retorna a saída como texto, em vez de JSON. O parâmetro `--query` obtém somente a propriedade `PublicKey`, não as propriedades necessárias para usar a chave pública com segurança fora do AWS KMS. Antes de executar esse comando, substitua o ID de chave de exemplo por um ID de chave válido da sua conta da AWS. ``` aws kms get-public-key \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --output text \ --query PublicKey | base64 --decode > public_key.der ``` Este comando não produz saída. Para obter mais informações sobre o uso de chaves assimétricas do KMS no AWS KMS, consulte [Chaves assimétricas no AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Para ver detalhes da API, consulte [GetPublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/get-public-key.html) na *Referência de comandos da AWS CLI*. ### `import-key-material` O código de exemplo a seguir mostra como usar `import-key-material`. **AWS CLI** **Para importar o material de chave para uma chave do KMS** O exemplo `import-key-material` a seguir carrega material da chave em uma chave do KMS que criada sem material de chave. O estado da chave do KMS deve ser `PendingImport`. Esse comando usa o material da chave criptografada com a chave pública que o comando `get-parameters-for-import` retornou. Ele também usa o token de importação do mesmo comando `get-parameters-for-import`. O parâmetro `expiration-model` indica que o material da chave expira automaticamente na data e hora especificadas pelo parâmetro `valid-to`. Quando o material de chave expira, o AWS KMS exclui o material de chave, o estado da chave do KMS é alterado para `Pending import` e a chave do KMS se torna inutilizável. Para restaurar a chave do KMS, é necessário reimportar o mesmo material de chave. Para usar outro material de chave, é necessário criar uma nova chave do KMS. Antes de executar esse comando, substitua o ID de chave de exemplo por um ID ou ARN de chave válidos da sua conta da AWS. ``` aws kms import-key-material \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --encrypted-key-material fileb://EncryptedKeyMaterial.bin \ --import-token fileb://ImportToken.bin \ --expiration-model KEY_MATERIAL_EXPIRES \ --valid-to 2021-09-21T19:00:00Z ``` Resultado: ``` { "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", "KeyMaterialId": "0b7fd7ddbac6eef27907413567cad8c810e2883dc8a7534067a82ee1142fc1e6" } ``` Para obter mais informações sobre como importar material de chave, consulte [Importar material de chave](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Para ver detalhes da API, consulte [ImportKeyMaterial](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/import-key-material.html) na *Referência de comandos da AWS CLI*. ### `list-aliases` O código de exemplo a seguir mostra como usar `list-aliases`. **AWS CLI** **Exemplo 1: listar todos os aliases em uma conta e região da AWS** O exemplo a seguir usa o comando `list-aliases` para listar todos os aliases na região padrão da conta da AWS. A saída inclui aliases associados às chaves do KMS gerenciadas pela AWS e pelo cliente. ``` aws kms list-aliases ``` Resultado: ``` { "Aliases": [ { "AliasArn": "arn:aws:kms:us-west-2:111122223333:alias/testKey", "AliasName": "alias/testKey", "TargetKeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" }, { "AliasArn": "arn:aws:kms:us-west-2:111122223333:alias/FinanceDept", "AliasName": "alias/FinanceDept", "TargetKeyId": "0987dcba-09fe-87dc-65ba-ab0987654321" }, { "AliasArn": "arn:aws:kms:us-west-2:111122223333:alias/aws/dynamodb", "AliasName": "alias/aws/dynamodb", "TargetKeyId": "1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d" }, { "AliasArn": "arn:aws:kms:us-west-2:111122223333:alias/aws/ebs", "AliasName": "alias/aws/ebs", "TargetKeyId": "0987ab65-43cd-21ef-09ab-87654321cdef" }, ... ] } ``` **Exemplo 2: como listar todos os aliases de uma chave específica do KMS** O exemplo a seguir usa o comando `list-aliases` e seu parâmetro `key-id` para listar todos os aliases associados a uma determinada chave do KMS. Cada alias é associado a apenas um chave do KMS, mas uma chave do KMS pode ter vários aliases. Esse comando é muito útil porque o console do AWS KMS lista somente um alias para cada chave do KMS. Você deve usar o comando `list-aliases` para localizar todos os aliases de uma chave do KMS. Este exemplo usa o ID de chave da chave do KMS no parâmetro `--key-id`, mas você pode usar um ID de chave, o ARN da chave, o nome do alias ou o ARN do alias neste comando. ``` aws kms list-aliases --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` Resultado: ``` { "Aliases": [ { "TargetKeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", "AliasArn": "arn:aws:kms:us-west-2:111122223333:alias/oregon-test-key", "AliasName": "alias/oregon-test-key" }, { "TargetKeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", "AliasArn": "arn:aws:kms:us-west-2:111122223333:alias/project121-test", "AliasName": "alias/project121-test" } ] } ``` Para obter mais informações, consulte [Working with aliases](https://docs.aws.amazon.com/kms/latest/developerguide/programming-aliases.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Consulte detalhes da API em [ListAliases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/list-aliases.html) na *Referência de comandos da AWS CLI*. ### `list-grants` O código de exemplo a seguir mostra como usar `list-grants`. **AWS CLI** **Como visualizar as concessões de uma chave do AWS KMS** O exemplo de `list-grants` a seguir exibe todas as concessões da chave especificada do KMS gerenciada pela AWS para o Amazon DynamoDB na conta. Essa concessão permite que o DynamoDB use a chave do KMS em seu nome para criptografar uma tabela do DynamoDB antes de gravá-la no disco. Você pode usar um comando como esse para visualizar as concessões nas chaves do KMS gerenciadas pela AWS e nas chaves do KMS gerenciadas pelo cliente na conta e na região da AWS. Este comando usa o parâmetro `key-id` com um ID de chave para identificar a chave do KMS. Você pode usar um ID de chave ou o ARN da chave para identificar a chave do KMS. Para obter o ID da chave ou o ARN da chave de uma chave do KMS gerenciada pela AWS, use o comando `list-keys` ou o `list-aliases`. ``` aws kms list-grants \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` O resultado mostra que a concessão fornece ao Amazon DynamoDB permissão para usar a chave do KMS para operações criptográficas e permite que ele visualize detalhes sobre a chave do KMS (`DescribeKey`) e descontinue concessões (`RetireGrant`). A restrição `EncryptionContextSubset` limita a permissão às solicitações que incluem os pares de contexto de criptografia especificados. Como resultado, as permissões na concessão são efetivas somente na conta especificada e na tabela do DynamoDB. ``` { "Grants": [ { "Constraints": { "EncryptionContextSubset": { "aws:dynamodb:subscriberId": "123456789012", "aws:dynamodb:tableName": "Services" } }, "IssuingAccount": "arn:aws:iam::123456789012:root", "Name": "8276b9a6-6cf0-46f1-b2f0-7993a7f8c89a", "Operations": [ "Decrypt", "Encrypt", "GenerateDataKey", "ReEncryptFrom", "ReEncryptTo", "RetireGrant", "DescribeKey" ], "GrantId": "1667b97d27cf748cf05b487217dd4179526c949d14fb3903858e25193253fe59", "KeyId": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab", "RetiringPrincipal": "dynamodb.us-west-2.amazonaws.com", "GranteePrincipal": "dynamodb.us-west-2.amazonaws.com", "CreationDate": "2021-05-13T18:32:45.144000+00:00" } ] } ``` Para obter mais informações, consulte [Grants in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/grants.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Consulte detalhes da API em [ListGrants](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/list-grants.html) na *Referência de comandos da AWS CLI*. ### `list-key-policies` O código de exemplo a seguir mostra como usar `list-key-policies`. **AWS CLI** **Como obter os nomes das políticas de chave de uma chave do KMS** O exemplo de `list-key-policies` a seguir obtém os nomes das políticas de chave de uma chave gerenciada pelo cliente na conta e região de exemplo. Você pode usar esse comando para encontrar os nomes das políticas de chave de chaves gerenciadas pela AWS e pelo cliente. Como o único nome de política de chave válido é `default`, esse comando não é muito útil. Use o parâmetro `key-id` para especificar a chave do KMS. Este exemplo usa um valor de ID de chave, mas você pode usar um ID de chave ou o ARN da chave neste comando. ``` aws kms list-key-policies \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` Resultado: ``` { "PolicyNames": [ "default" ] } ``` Para obter mais informações sobre as políticas de chave do AWS KMS, consulte [Using Key Policies in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Consulte detalhes da API em [ListKeyPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/list-key-policies.html) na *Referência de comandos da AWS CLI*. ### `list-key-rotations` O código de exemplo a seguir mostra como usar `list-key-rotations`. **AWS CLI** **Para recuperar informações sobre todas as rotações de materiais de chave concluídas** O exemplo `list-key-rotations` a seguir lista informações sobre todas as rotações de materiais de chave concluídas para a chave do KMS especificada. ``` aws kms list-key-rotations \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` Resultado: ``` { "Rotations": [ { "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", "RotationDate": "2024-03-02T10:11:36.564000+00:00", "RotationType": "AUTOMATIC" }, { "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", "RotationDate": "2024-04-05T15:14:47.757000+00:00", "RotationType": "ON_DEMAND" } ], "Truncated": false } ``` Para obter mais informações, consulte [Rotacionar chaves](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Para ver detalhes da API, consulte [ListKeyRotations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/list-key-rotations.html) na *Referência de comandos da AWS CLI*. ### `list-keys` O código de exemplo a seguir mostra como usar `list-keys`. **AWS CLI** **Como obter chaves do KMS em uma conta e região** O exemplo `list-keys` a seguir obtém as chaves do KMS em uma conta e região. Esse comando retorna chaves gerenciadas pela AWS e pelo cliente. ``` aws kms list-keys ``` Resultado: ``` { "Keys": [ { "KeyArn": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" }, { "KeyArn": "arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321", "KeyId": "0987dcba-09fe-87dc-65ba-ab0987654321" }, { "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d", "KeyId": "1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d" } ] } ``` Para obter mais informações, consulte [Viewing Keys](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Consulte detalhes da API em [ListKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/list-keys.html) na *Referência de comandos da AWS CLI*. ### `list-resource-tags` O código de exemplo a seguir mostra como usar `list-resource-tags`. **AWS CLI** **Para obter as tags em uma chave do KMS** O exemplo `list-resource-tags` a seguir obtém as tags de uma chave do KMS. Para adicionar ou substituir tags de recursos das chaves do KMS, use o comando `tag-resource`. A saída mostra que essa chave do KMS tem duas tags de recursos, cada uma com uma chave e um valor. Use o parâmetro `key-id` para especificar a chave do KMS. Este exemplo usa um valor de ID de chave, mas você pode usar um ID de chave ou o ARN da chave neste comando. ``` aws kms list-resource-tags \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` Resultado: ``` { "Tags": [ { "TagKey": "Dept", "TagValue": "IT" }, { "TagKey": "Purpose", "TagValue": "Test" } ], "Truncated": false } ``` Para obter mais informações sobre como usar tags no AWS KMS, consulte [Marcar chaves](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Para ver detalhes da API, consulte [ListResourceTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/list-resource-tags.html) na *Referência de comandos da AWS CLI*. ### `list-retirable-grants` O código de exemplo a seguir mostra como usar `list-retirable-grants`. **AWS CLI** **Como visualizar as concessões que uma entidade principal pode retirar** O exemplo `list-retirable-grants` a seguir exibe todas as concessões que o usuário `ExampleAdmin` pode retirar das chaves do KMS em uma conta e região da AWS. É possível usar uma linha de comando como essa para visualizar as concessões que qualquer entidade principal da conta pode retirar nas chaves do KMS na conta e região da AWS. O valor do parâmetro obrigatório `retiring-principal` deve ser o nome do recurso da Amazon (ARN) de uma conta, usuário ou perfil. Não é possível especificar um serviço para o valor de `retiring-principal` neste comando, mesmo que um serviço seja a entidade principal que esteja retirando. Para encontrar as concessões nas quais um determinado serviço é a entidade principal que esteja retirando, use o comando `list-grants`. A saída mostra que o usuário `ExampleAdmin` tem permissão para retirar concessões em duas chaves do KMS diferentes na conta e região. Além da entidade principal que está retirando, a conta tem permissão para retirar qualquer concessão desta conta. ``` aws kms list-retirable-grants \ --retiring-principal arn:aws:iam::111122223333:user/ExampleAdmin ``` Resultado: ``` { "Grants": [ { "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "GrantId": "156b69c63cb154aa21f59929ff19760717be8d9d82b99df53e18b94a15a5e88e", "Name": "", "CreationDate": 2021-01-14T20:17:36.419000+00:00, "GranteePrincipal": "arn:aws:iam::111122223333:user/ExampleUser", "RetiringPrincipal": "arn:aws:iam::111122223333:user/ExampleAdmin", "IssuingAccount": "arn:aws:iam::111122223333:root", "Operations": [ "Encrypt" ], "Constraints": { "EncryptionContextSubset": { "Department": "IT" } } }, { "KeyId": "arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321", "GrantId": "8c94d1f12f5e69f440bae30eaec9570bb1fb7358824f9ddfa1aa5a0dab1a59b2", "Name": "", "CreationDate": "2021-02-02T19:49:49.638000+00:00", "GranteePrincipal": "arn:aws:iam::111122223333:role/ExampleRole", "RetiringPrincipal": "arn:aws:iam::111122223333:user/ExampleAdmin", "IssuingAccount": "arn:aws:iam::111122223333:root", "Operations": [ "Decrypt" ], "Constraints": { "EncryptionContextSubset": { "Department": "IT" } } } ], "Truncated": false } ``` Para obter mais informações, consulte [Grants in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/grants.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Para ver detalhes da API, consulte [ListRetirableGrants](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/list-retirable-grants.html) na *Referência de comandos da AWS CLI*. ### `put-key-policy` O código de exemplo a seguir mostra como usar `put-key-policy`. **AWS CLI** **Como alterar a política de chaves de uma chave do KMS** O exemplo de `put-key-policy` a seguir altera a política de chave de uma chave gerenciada pelo cliente. Para começar, crie uma política de chave e salve-a em um arquivo JSON local. Neste exemplo, o arquivo é `key_policy.json`. Você também pode especificar a política de chave como o valor da string do parâmetro `policy`. A primeira instrução nesta política de chave fornece à conta da AWS permissão para usar as políticas do IAM para controlar o acesso à chave do KMS. A segunda instrução fornece permissão de usuário ao `test-user` para executar os comandos `describe-key` e `list-keys` na chave do KMS. Conteúdo de `key_policy.json`: ``` { "Version":"2012-10-17", "Id" : "key-default-1", "Statement" : [ { "Sid" : "Enable IAM User Permissions", "Effect" : "Allow", "Principal" : { "AWS" : "arn:aws:iam::111122223333:root" }, "Action" : "kms:*", "Resource" : "*" }, { "Sid" : "Allow Use of Key", "Effect" : "Allow", "Principal" : { "AWS" : "arn:aws:iam::111122223333:user/test-user" }, "Action" : [ "kms:DescribeKey", "kms:ListKeys" ], "Resource" : "*" } ] } ``` Este exemplo usa o ID de chave para identificar a chave do KMS, mas também é possível usar um ARN de chave. O comando usa o parâmetro `policy` para especificar a política de chave. Para indicar que a política está em um arquivo, ela usa o prefixo `file://` necessário. Esse prefixo é necessário para identificar arquivos em todos os sistemas operacionais compatíveis. Por fim, o comando usa o parâmetro `policy-name` com um valor `default`. Se não for especificado um nome de política, o valor padrão será `default`. O único valor válido é `default`. ``` aws kms put-key-policy \ --policy-name default \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --policy file://key_policy.json ``` Esse comando não produz nenhuma saída. Use o comando `get-key-policy` para verificar se o comando está em vigor. O comando de exemplo a seguir recupera a política de chave da mesma chave do KMS. O parâmetro `output` com o valor `text` retorna um formato de texto fácil de ler. ``` aws kms get-key-policy \ --policy-name default \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --output text ``` Resultado: ``` { "Version":"2012-10-17", "Id" : "key-default-1", "Statement" : [ { "Sid" : "Enable IAM User Permissions", "Effect" : "Allow", "Principal" : { "AWS" : "arn:aws:iam::111122223333:root" }, "Action" : "kms:*", "Resource" : "*" }, { "Sid" : "Allow Use of Key", "Effect" : "Allow", "Principal" : { "AWS" : "arn:aws:iam::111122223333:user/test-user" }, "Action" : [ "kms:Describe", "kms:List" ], "Resource" : "*" } ] } ``` Para obter mais informações, consulte [Changing a Key Policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-modifying.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Consulte detalhes da API em [PutKeyPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/put-key-policy.html) na *Referência de comandos da AWS CLI*. ### `re-encrypt` O código de exemplo a seguir mostra como usar `re-encrypt`. **AWS CLI** **Exemplo 1: como criptografar novamente uma mensagem criptografada com uma chave simétrica diferente do KMS (Linux e macOS).** O exemplo de comando `re-encrypt` a seguir demonstra a forma recomendada de recriptografar dados com a AWS CLI. Forneça o texto cifrado em um arquivo. No valor do parâmetro `--ciphertext-blob`, use o prefixo `fileb://`, que instrui a CLI a ler os dados de um arquivo binário. Se o arquivo não estiver no diretório atual, digite o caminho completo para o arquivo. Para ter mais informações sobre como ler valores de parâmetro da AWS CLI por meio de um arquivo, consulte [Carregar um parâmetro de um arquivo na AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-file.html) no *Guia do usuário da versão 2 da AWS Command Line Interface* e [Best Practices for Local File Parameters](https://aws.amazon.com/blogs/developer/best-practices-for-local-file-parameters/) no *AWS Developer Tools Blog*. Especifique a chave do KMS, que descriptografa o texto cifrado. O parâmetro `--source-key-id` não é obrigatório ao descriptografar com chaves do KMS de criptografia simétrica. O AWS KMS pode recuperar a chave do KMS que foi usada para criptografar os dados dos metadados no blob de texto cifrado. Porém, sempre é uma prática recomendada especificar a chave do KMS que você está usando. Essa prática garante que você use a chave do KMS desejada e impede que você descriptografe um texto cifrado acidentalmente usando uma chave do KMS em que você não confia. Especifique a chave do KMS de destino, que criptografa os dados novamente. O parâmetro `--destination-key-id` é sempre obrigatório. Este exemplo usa um ARN de chave, mas você pode usar qualquer identificador de chave válido. Solicite a saída de texto simples como um valor de texto. O parâmetro `--query` informa à CLI para obter somente o valor do campo `Plaintext` da saída. O parâmetro `--output` retorna a saída como texto. Decodifique o texto simples em Base64 e salve-o em um arquivo. O seguinte exemplo canaliza ( \$1 ) o valor do parâmetro `Plaintext` para o utilitário Base64, que o decodifica. Em seguida, ele redireciona ( > ) a saída decodificada para o arquivo `ExamplePlaintext`. Antes de executar esse comando, substitua os IDs de chave de exemplo por identificadores de chave válidos de sua conta da AWS. ``` aws kms re-encrypt \ --ciphertext-blob fileb://ExampleEncryptedFile \ --source-key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --destination-key-id 0987dcba-09fe-87dc-65ba-ab0987654321 \ --query CiphertextBlob \ --output text | base64 --decode > ExampleReEncryptedFile ``` Este comando não produz saída. A saída do comando `re-encrypt` é decodificada em base64 e salva em um arquivo. Para ter mais informações, consulte [ReEncrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_ReEncrypt.html) na *Referência de API do AWS Key Management Service*. **Exemplo 2: como criptografar novamente uma mensagem criptografada com uma chave simétrica diferente do KMS (prompt de comando do Windows).** O exemplo de comando `re-encrypt` a seguir é o mesmo que o anterior, mas ele usa o utilitário `certutil` para decodificar em Base64 os dados em texto simples. Esse procedimento requer dois comandos, conforme mostrado nos exemplos a seguir. Antes de executar esse comando, substitua o ID de chave de exemplo por um ID de chave válido da sua conta da AWS. ``` aws kms re-encrypt ^ --ciphertext-blob fileb://ExampleEncryptedFile ^ --source-key-id 1234abcd-12ab-34cd-56ef-1234567890ab ^ --destination-key-id 0987dcba-09fe-87dc-65ba-ab0987654321 ^ --query CiphertextBlob ^ --output text > ExampleReEncryptedFile.base64 ``` Em seguida, use o utilitário `certutil`. ``` certutil -decode ExamplePlaintextFile.base64 ExamplePlaintextFile ``` Resultado: ``` Input Length = 18 Output Length = 12 CertUtil: -decode command completed successfully. ``` Para ter mais informações, consulte [ReEncrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_ReEncrypt.html) na *Referência de API do AWS Key Management Service*. + Consulte detalhes da API em [ReEncrypt](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/re-encrypt.html) na *Referência de comandos da AWS CLI*. ### `retire-grant` O código de exemplo a seguir mostra como usar `retire-grant`. **AWS CLI** **Como descontinuar uma concessão em uma chave mestra do cliente** O exemplo de `retire-grant` a seguir exclui a concessão de uma chave do KMS. O comando de exemplo a seguir especifica os parâmetros `grant-id` e `key-id`. O valor do parâmetro `key-id` deve ser o ARN de chave da chave do KMS. ``` aws kms retire-grant \ --grant-id 1234a2345b8a4e350500d432bccf8ecd6506710e1391880c4f7f7140160c9af3 \ --key-id arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab ``` Este comando não produz saída. Use o comando `list-grants` para confirmar a descontinuação da concessão. Para obter mais informações, consulte [Retiring and revoking grants](https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete) no *Guia do desenvolvedor do AWS Key Management Service*. + Consulte detalhes da API em [RetireGrant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/retire-grant.html) na *Referência de comandos da AWS CLI*. ### `revoke-grant` O código de exemplo a seguir mostra como usar `revoke-grant`. **AWS CLI** **Como revogar uma concessão em uma chave mestra do cliente** O exemplo de `revoke-grant` a seguir exclui a concessão de uma chave do KMS. O comando de exemplo a seguir especifica os parâmetros `grant-id` e `key-id`. O valor do parâmetro `key-id` pode ser o ID ou o ARN de chave da chave do KMS. ``` aws kms revoke-grant \ --grant-id 1234a2345b8a4e350500d432bccf8ecd6506710e1391880c4f7f7140160c9af3 \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` Este comando não produz saída. Use o comando `list-grants` para confirmar que a concessão foi revogada. Para obter mais informações, consulte [Retiring and revoking grants](https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete) no *Guia do desenvolvedor do AWS Key Management Service*. + Consulte detalhes da API em [RevokeGrant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/revoke-grant.html) na *Referência de comandos da AWS CLI*. ### `rotate-key-on-demand` O código de exemplo a seguir mostra como usar `rotate-key-on-demand`. **AWS CLI** **Como realizar a rotação sob demanda de uma chave do KMS** O exemplo `rotate-key-on-demand` a seguir inicia imediatamente a rotação do material de chave para a chave do KMS especificada. ``` aws kms rotate-key-on-demand \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` Resultado: ``` { "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" } ``` Para obter mais informações, consulte [Como realizar uma rotação de chave sob demanda](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotating-keys-on-demand) no *Guia do desenvolvedor do AWS Key Management Service*. + Para ver detalhes da API, consulte [RotateKeyOnDemand](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/rotate-key-on-demand.html) na *Referência de comandos da AWS CLI*. ### `schedule-key-deletion` O código de exemplo a seguir mostra como usar `schedule-key-deletion`. **AWS CLI** **Como programar a exclusão de uma chave do KMS gerenciada pelo cliente.** O exemplo de `schedule-key-deletion` a seguir programa a chave do KMS gerenciada pelo cliente especificada pala ser excluída em 15 dias. O parâmetro `--key-id` identifica a chave do KMS. Este exemplo usa o valor do ARN da chave, mas você pode usar o ID da chave ou o ARN da chave do KMS. O parâmetro `--pending-window-in-days` especifica a duração do período de espera (7 a 30 dias). Por padrão, o período de espera é de 30 dias. Este exemplo especifica o valor de 15, que informa à AWS para excluir a chave do KMS permanentemente 15 dias após a conclusão do comando. ``` aws kms schedule-key-deletion \ --key-id arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab \ --pending-window-in-days 15 ``` A resposta inclui o ARN da chave, o estado da chave, o período de espera (`PendingWindowInDays`) e a data de exclusão no horário Unix. Use o console do AWS KMS para visualizar a data de exclusão no horário local. As chaves do KMS no estado `PendingDeletion` não podem ser usadas em operações criptográficas. ``` { "KeyId": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab", "DeletionDate": "2022-06-18T23:43:51.272000+00:00", "KeyState": "PendingDeletion", "PendingWindowInDays": 15 } ``` Para obter mais informações, consulte [Deleting keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Consulte detalhes da API em [ScheduleKeyDeletion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/schedule-key-deletion.html) na *Referência de comandos da AWS CLI*. ### `sign` O código de exemplo a seguir mostra como usar `sign`. **AWS CLI** **Exemplo 1: gerar uma assinatura digital para uma mensagem** O exemplo de `sign` a seguir gera uma assinatura criptográfica para uma mensagem curta. A saída do comando inclui um campo `Signature` codificado em base 64 que pode ser verificado usando o comando `verify`. É necessário especificar uma mensagem para assinar e um algoritmo de assinatura compatível com sua chave do KMS assimétrica. Para obter os algoritmos de assinatura para sua chave do KMS, use o comando `describe-key`. Na AWS CLI v2, o valor do parâmetro `message` deve ser codificado em base64. Também é possível salvar a mensagem em um arquivo e usar o prefixo `fileb://`, que instrui a AWS CLI a ler dados binários do arquivo. Antes de executar esse comando, substitua o ID de chave de exemplo por um ID de chave válido da sua conta da AWS. O ID da chave deverá representar uma chave assimétrica do KMS com o uso da chave SIGN\$1VERIFY. ``` msg=(echo 'Hello World' | base64) aws kms sign \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --message fileb://UnsignedMessage \ --message-type RAW \ --signing-algorithm RSASSA_PKCS1_V1_5_SHA_256 ``` Resultado: ``` { "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "Signature": "ABCDEFhpyVYyTxbafE74ccSvEJLJr3zuoV1Hfymz4qv+/fxmxNLA7SE1SiF8lHw80fKZZ3bJ...", "SigningAlgorithm": "RSASSA_PKCS1_V1_5_SHA_256" } ``` Para obter mais informações sobre o uso de chaves assimétricas do KMS no AWS KMS, consulte [Chaves assimétricas no AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) no *Guia do desenvolvedor do AWS Key Management Service*. **Exemplo 2: salvar uma assinatura digital em um arquivo (Linux e macOS)** O exemplo de `sign` a seguir gera uma assinatura criptográfica para uma mensagem curta armazenada em um arquivo local. O comando também obtém a propriedade `Signature` da resposta, decodifica a resposta em base64 e salva a resposta no arquivo ExampleSignature. É possível usar o arquivo de assinatura em um comando `verify` que verifique a assinatura. O comando `sign` requer uma mensagem codificada em base64 e um algoritmo de assinatura compatível com sua chave assimétrica do KMS. Para obter os algoritmos de assinatura compatíveis com sua chave do KMS, use o comando `describe-key`. Antes de executar esse comando, substitua o ID de chave de exemplo por um ID de chave válido da sua conta da AWS. O ID da chave deve representar uma chave KMS assimétrica com o uso da chave SIGN\$1VERIFY. ``` echo 'hello world' | base64 > EncodedMessage aws kms sign \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --message fileb://EncodedMessage \ --message-type RAW \ --signing-algorithm RSASSA_PKCS1_V1_5_SHA_256 \ --output text \ --query Signature | base64 --decode > ExampleSignature ``` Este comando não produz saída. Este exemplo extrai a propriedade `Signature` da saída e a salva em um arquivo. Para obter mais informações sobre o uso de chaves assimétricas do KMS no AWS KMS, consulte [Chaves assimétricas no AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Para ver detalhes da API, consulte [Sign](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/sign.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Para adicionar uma tag a uma chave do KMS** O exemplo de `tag-resource` a seguir adiciona as tags `"Purpose":"Test"` e `"Dept":"IT"` a uma chave do KMS gerenciada pelo cliente. É possível usar tags como essas para identificar chaves do KMS e criar categorias de chaves do KMS para permissões e auditoria. Use o parâmetro `key-id` para especificar a chave do KMS. Este exemplo usa um valor de ID de chave, mas você pode usar um ID de chave ou o ARN da chave neste comando. ``` aws kms tag-resource \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --tags TagKey='Purpose',TagValue='Test' TagKey='Dept',TagValue='IT' ``` Este comando não produz saída. Para visualizar as tags em uma chave do AWS KMS, use o comando `list-resource-tags`. Para obter mais informações sobre como usar tags no AWS KMS, consulte [Marcar chaves](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para excluir uma tag de uma chave do KMS** O exemplo `untag-resource` a seguir exclui a tag com a chave `"Purpose"` de uma chave do KMS gerenciada pelo cliente. Use o parâmetro `key-id` para especificar a chave do KMS. Este exemplo usa um valor de ID de chave, mas você pode usar um ID de chave ou o ARN da chave neste comando. Antes de executar esse comando, substitua o ID de chave de exemplo por um ID de chave válido da sua conta da AWS. ``` aws kms untag-resource \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --tag-key 'Purpose' ``` Este comando não produz saída. Para visualizar as tags em uma chave do AWS KMS, use o comando `list-resource-tags`. Para obter mais informações sobre como usar tags no AWS KMS, consulte [Marcar chaves](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-alias` O código de exemplo a seguir mostra como usar `update-alias`. **AWS CLI** **Como associar um alias a uma chave do KMS diferente** O exemplo de `update-alias` a seguir associa o alias `alias/test-key` a uma chave do KMS diferente. O parâmetro `--alias-name` especifica o alias. O valor do nome do alias deve começar com `alias/`. O parâmetro `--target-key-id` especifica a chave do KMS que deve ser associada ao alias. Não é necessário especificar a chave do KMS atual para o alias. ``` aws kms update-alias \ --alias-name alias/test-key \ --target-key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` Este comando não produz saída. Use o `list-aliases` comando para localizar o alias. Para obter mais informações, consulte [Updating aliases](https://docs.aws.amazon.com/kms/latest/developerguide/alias-manage.html#alias-update) no *Guia do desenvolvedor do AWS Key Management Service*. + Consulte detalhes da API em [UpdateAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/update-alias.html) na *Referência de comandos da AWS CLI*. ### `update-custom-key-store` O código de exemplo a seguir mostra como usar `update-custom-key-store`. **AWS CLI** **Exemplo 1: editar o nome amigável de um repositório de chaves personalizado** O exemplo `update-custom-key-store` a seguir altera o nome do repositório de chaves personalizado. Este exemplo funciona para um repositório de chaves do AWS CloudHSM ou repositório de chaves externo. Use o `custom-key-store-id` para identificar o repositório de chaves. Use o parâmetro `new-custom-key-store-name` para especificar o novo nome amigável. Para atualizar o nome amigável de um repositório de chaves do AWS CloudHSM, é necessário primeiro desconectar o repositório de chaves, por exemplo, usando o comando `disconnect-custom-key-store`. É possível atualizar o nome amigável de um repositório de chaves externo enquanto ele está conectado ou desconectado. Para descobrir o estado da conexão do repositório de chaves personalizado, use o comando `describe-custom-key-store`. ``` aws kms update-custom-key-store \ --custom-key-store-id cks-1234567890abcdef0 \ --new-custom-key-store-name ExampleKeyStore ``` Esse comando não retorna nenhuma saída. Para verificar se o comando foi bem-sucedido, use um comando `describe-custom-key-stores`. Para obter mais informações sobre a atualização de um repositório de chaves do AWS CloudHSM, consulte [Editar as configurações do repositório de chaves do AWS CloudHSM](https://docs.aws.amazon.com/kms/latest/developerguide/update-keystore.html) no *Guia do desenvolvedor do AWS Key Management Service*. Para obter mais informações sobre a atualização de um repositório de chaves externo, consulte [Editar as propriedades do repositório de chaves externo](https://docs.aws.amazon.com/kms/latest/developerguide/update-xks-keystore.html) no *Guia do desenvolvedor do AWS Key Management Service*. **Exemplo 2: editar a senha kmsuser de um repositório de chaves do AWS CloudHSM** O exemplo `update-custom-key-store` a seguir atualiza o valor da senha `kmsuser` para a senha atual do `kmsuser` no cluster do CloudHSM associado ao repositório de chaves especificado. Esse comando não altera a senha `kmsuser` do cluster. Ele apenas informa ao AWS KMS a senha atual. Se o KMS não tiver a senha atual `kmsuser`, ele não poderá se conectar ao repositório de chaves do AWS CloudHSM. **OBSERVAÇÃO:** antes de atualizar um repositório de chaves do AWS CloudHSM, é necessário desconectá-lo. Use o comando `disconnect-custom-key-store`. Depois que o comando for concluído, é possível reconectar o repositório de chaves do AWS CloudHSM. Use o comando `connect-custom-key-store`. ``` aws kms update-custom-key-store \ --custom-key-store-id cks-1234567890abcdef0 \ --key-store-password ExamplePassword ``` Esse comando não retorna nenhuma saída. Use o comando `describe-custom-key-stores` para verificar se a alteração foi concluída. Para obter mais informações sobre a atualização de um repositório de chaves do AWS CloudHSM, consulte [Editar as configurações do repositório de chaves do AWS CloudHSM](https://docs.aws.amazon.com/kms/latest/developerguide/update-keystore.html) no *Guia do desenvolvedor do AWS Key Management Service*. **Exemplo 3: editar o cluster AWS CloudHSM de um repositório de chaves do AWS CloudHSM** O exemplo a seguir altera o cluster do AWS CloudHSM associado a um repositório de chaves do AWS CloudHSM por um cluster relacionado, como um backup diferente do mesmo cluster. **OBSERVAÇÃO:** antes de atualizar um repositório de chaves do AWS CloudHSM, é necessário desconectá-lo. Use o comando `disconnect-custom-key-store`. Depois que o comando for concluído, é possível reconectar o repositório de chaves do AWS CloudHSM. Use o comando `connect-custom-key-store`. ``` aws kms update-custom-key-store \ --custom-key-store-id cks-1234567890abcdef0 \ --cloud-hsm-cluster-id cluster-1a23b4cdefg ``` Esse comando não retorna nenhuma saída. Use o comando `describe-custom-key-stores` para verificar se a alteração foi concluída. Para obter mais informações sobre a atualização de um repositório de chaves do AWS CloudHSM, consulte [Editar as configurações do repositório de chaves do AWS CloudHSM](https://docs.aws.amazon.com/kms/latest/developerguide/update-keystore.html) no *Guia do desenvolvedor do AWS Key Management Service*. **Exemplo 4: editar a credencial de autenticação de proxy de um repositório de chaves externo** O exemplo a seguir atualiza a credencial de autenticação de proxy do repositório de chaves externo. É necessário especificar a `raw-secret-access-key` e o `access-key-id`, mesmo que apenas um dos valores estejam sendo alterados. É possível usar esse atributo para corrigir uma credencial inválida ou para alterar a credencial quando o proxy do repositório de chaves externo faz a rotação. Estabeleça a credencial de autenticação de proxy do AWS KMS em seu repositório de chaves externo. Em seguida, use esse comando para fornecer a credencial ao AWS KMS. O AWS KMS usa essa credencial para assinar suas solicitações no proxy de repositório de chaves externo. É possível atualizar a credencial de autenticação de proxy enquanto o repositório de chaves externo está conectado ou desconectado. Para descobrir o estado da conexão do repositório de chaves personalizado, use o comando `describe-custom-key-store`. ``` aws kms update-custom-key-store \ --custom-key-store-id cks-1234567890abcdef0 \ --xks-proxy-authentication-credential "AccessKeyId=ABCDE12345670EXAMPLE, RawSecretAccessKey=DXjSUawnel2fr6SKC7G25CNxTyWKE5PF9XX6H/u9pSo=" ``` Esse comando não retorna nenhuma saída. Use o comando `describe-custom-key-stores` para verificar se a alteração foi concluída. Para obter mais informações sobre a atualização de um repositório de chaves externo, consulte [Editar as propriedades do repositório de chaves externo](https://docs.aws.amazon.com/kms/latest/developerguide/update-xks-keystore.html) no *Guia do desenvolvedor do AWS Key Management Service*. **Exemplo 5: editar a conectividade de proxy de um repositório de chaves externo** O exemplo a seguir altera a opção de conectividade de proxy de repositório de chaves externo de conectividade de endpoint público para conectividade de serviço de endpoint da VPC. Além de alterar o valor de `xks-proxy-connectivity`, é necessário alterar o valor de `xks-proxy-uri-endpoint` para refletir o nome DNS privado associado ao serviço de endpoint da VPC. Também é necessário adicionar um valor de `xks-proxy-vpc-endpoint-service-name`. **OBSERVAÇÃO:** antes de atualizar a conectividade proxy de um repositório externo, é necessário desconectá-lo. Use o comando `disconnect-custom-key-store`. Depois que o comando for concluído, é possível reconectar o repositório de chaves externo usando o comando `connect-custom-key-store`. ``` aws kms update-custom-key-store \ --custom-key-store-id cks-1234567890abcdef0 \ --xks-proxy-connectivity VPC_ENDPOINT_SERVICE \ --xks-proxy-uri-endpoint "https://myproxy-private.xks.example.com" \ --xks-proxy-vpc-endpoint-service-name "com.amazonaws.vpce.us-east-1.vpce-svc-example" ``` Esse comando não retorna nenhuma saída. Use o comando `describe-custom-key-stores` para verificar se a alteração foi concluída. Para obter mais informações sobre a atualização de um repositório de chaves externo, consulte [Editar as propriedades do repositório de chaves externo](https://docs.aws.amazon.com/kms/latest/developerguide/update-xks-keystore.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Para ver detalhes da API, consulte [UpdateCustomKeyStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/update-custom-key-store.html) na *Referência de comandos da AWS CLI*. ### `update-key-description` O código de exemplo a seguir mostra como usar `update-key-description`. **AWS CLI** **Exemplo 1: adicionar ou alterar uma descrição em uma chave do KMS gerenciada pelo cliente** O exemplo `update-key-description` a seguir adiciona uma descrição uma chave do KMS gerenciada pelo cliente. É possível usar o mesmo comando para alterar uma descrição existente. O parâmetro `--key-id` identifica a chave do KMS no comando. Este exemplo usa o valor do ARN da chave, mas é possível usar o ID da chave ou o ARN da chave do KMS. O parâmetro `--description` especifica a nova descrição. O valor desse parâmetro substitui a descrição atual da chave do KMS, se houver. ``` aws kms update-key-description \ --key-id arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab \ --description "IT Department test key" ``` Este comando não produz saída. Para visualizar a descrição de uma chave do KMS, use o comando `describe-key`. Para obter mais informações, consulte [UpdateKeyDescription](https://docs.aws.amazon.com/cli/latest/reference/kms/update-key-description.html) na *Referência da API do AWS Key Management Service*. **Exemplo 2: excluir a descrição de uma chave do KMS gerenciada pelo cliente** O exemplo `update-key-description` a seguir adiciona uma descrição uma chave do KMS gerenciada pelo cliente. O parâmetro `--key-id` identifica a chave do KMS no comando. Este exemplo usa o valor do ID da chave, mas é possível usar o ID da chave ou o ARN da chave da chave do KMS. O parâmetro `--description` com um valor de string vazia (") exclui a descrição existente. ``` aws kms update-key-description \ --key-id 0987dcba-09fe-87dc-65ba-ab0987654321 \ --description '' ``` Este comando não produz saída. Para visualizar a descrição de uma chave do KMS, use o comando describe-key. Para obter mais informações, consulte [UpdateKeyDescription](https://docs.aws.amazon.com/cli/latest/reference/kms/update-key-description.html) na *Referência da API do AWS Key Management Service*. + Para ver detalhes da API, consulte [UpdateKeyDescription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/update-key-description.html) na *Referência de comandos da AWS CLI*. ### `verify-mac` O código de exemplo a seguir mostra como usar `verify-mac`. **AWS CLI** **Exemplo 1: verificar um HMAC** O comando `verify-mac` a seguir verifica um HMAC para uma mensagem específica, chaves HMAC do KMS e o algoritmo MAC. Um valor “true” no campo MacValid na resposta indica que o HMAC é válido. Na AWS CLI v2, o valor do parâmetro `message` deve ser codificado em base64. Também é possível salvar a mensagem em um arquivo e usar o prefixo `fileb://`, que instrui a AWS CLI a ler dados binários do arquivo. O MAC especificado não pode ter codificação em base64. Para obter ajuda na decodificação do MAC que o comando `generate-mac` retorna, consulte os exemplos do comando `generate-mac`. Antes de executar esse comando, substitua o ID de chave de exemplo por um ID de chave válido da sua conta da AWS. O ID da chave deverá representar uma chave HMAC do KMS com o uso da chave `GENERATE_VERIFY_MAC`. ``` msg=(echo 'Hello World' | base64) aws kms verify-mac \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --message fileb://Message \ --mac-algorithm HMAC_SHA_384 \ --mac fileb://ExampleMac ``` Resultado: ``` { "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "MacValid": true, "MacAlgorithm": "HMAC_SHA_384" } ``` Para ter mais informações sobre como usar chaves HMAC do KMS no AWS KMS, consulte [HMAC keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Para ver detalhes da API, consulte [VerifyMac](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/verify-mac.html) na *Referência de comandos da AWS CLI*. ### `verify` O código de exemplo a seguir mostra como usar `verify`. **AWS CLI** **Como verificar uma assinatura digital** O comando `verify` a seguir verifica uma assinatura criptográfica para uma mensagem curta codificada em base64. O ID da chave, a mensagem, o tipo de mensagem e o algoritmo de assinatura devem ser os mesmos usados para assinar a mensagem. Na AWS CLI v2, o valor do parâmetro `message` deve ser codificado em base64. Também é possível salvar a mensagem em um arquivo e usar o prefixo `fileb://`, que instrui a AWS CLI a ler dados binários do arquivo. A assinatura que especificada não pode ter codificação base64. Para obter ajuda na decodificação da assinatura retornada pelo comando `sign`, consulte os exemplos do comando `sign`. A saída do comando inclui um campo booleano `SignatureValid` que indica que a assinatura foi verificada. Se a validação da assinatura falhar, o comando `verify` também falhará. Antes de executar esse comando, substitua o ID de chave de exemplo por um ID de chave válido da sua conta da AWS. ``` aws kms verify \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --message fileb://EncodedMessage \ --message-type RAW \ --signing-algorithm RSASSA_PKCS1_V1_5_SHA_256 \ --signature fileb://ExampleSignature ``` Resultado: ``` { "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "SignatureValid": true, "SigningAlgorithm": "RSASSA_PKCS1_V1_5_SHA_256" } ``` Para obter mais informações sobre o uso de chaves assimétricas do KMS no AWS KMS, consulte [Usar chaves assimétricas](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) no *Guia do desenvolvedor do AWS Key Management Service*. + Para ver detalhes da API, consulte [Verify](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/verify.html) na *Referência de comandos da AWS CLI*. # Exemplos de Lake Formation usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Lake Formation. *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-lf-tags-to-resource` O código de exemplo a seguir mostra como usar `add-lf-tags-to-resource`. **AWS CLI** **Para anexar uma ou mais tags LF a um recurso existente** O exemplo `add-lf-tags-to-resource` a seguir anexa a tag LF fornecida ao recurso da tabela. ``` aws lakeformation add-lf-tags-to-resource \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "CatalogId": "123456789111", "Resource": { "Table": { "CatalogId": "123456789111", "DatabaseName": "tpc", "Name": "dl_tpc_promotion" } }, "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "analyst" ] }] } ``` Resultado: ``` { "Failures": [] } ``` Para obter mais informações, consulte [Atribuir tags LF aos recursos do Data Catalog](https://docs.aws.amazon.com/lake-formation/latest/dg/TBAC-assigning-tags.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [AddLfTagsToResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/add-lf-tags-to-resource.html) na *Referência de comandos da AWS CLI*. ### `batch-grant-permissions` O código de exemplo a seguir mostra como usar `batch-grant-permissions`. **AWS CLI** **Como conceder permissões em massa sobre recursos às entidades principais** O exemplo `batch-grant-permissions` a seguir concede acesso em massa a recursos específicos para as entidades principais. ``` aws lakeformation batch-grant-permissions \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "CatalogId": "123456789111", "Entries": [{ "Id": "1", "Principal": { "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-developer" }, "Resource": { "Table": { "CatalogId": "123456789111", "DatabaseName": "tpc", "Name": "dl_tpc_promotion" } }, "Permissions": [ "ALL" ], "PermissionsWithGrantOption": [ "ALL" ] }, { "Id": "2", "Principal": { "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-developer" }, "Resource": { "Table": { "CatalogId": "123456789111", "DatabaseName": "tpc", "Name": "dl_tpc_customer" } }, "Permissions": [ "ALL" ], "PermissionsWithGrantOption": [ "ALL" ] }, { "Id": "3", "Principal": { "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-business-analyst" }, "Resource": { "Table": { "CatalogId": "123456789111", "DatabaseName": "tpc", "Name": "dl_tpc_promotion" } }, "Permissions": [ "ALL" ], "PermissionsWithGrantOption": [ "ALL" ] }, { "Id": "4", "Principal": { "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-developer" }, "Resource": { "DataCellsFilter": { "TableCatalogId": "123456789111", "DatabaseName": "tpc", "TableName": "dl_tpc_item", "Name": "developer_item" } }, "Permissions": [ "SELECT" ], "PermissionsWithGrantOption": [] } ] } ``` Resultado: ``` { "Failures": [] } ``` Para obter mais informações, consulte [Conceder e revogar permissões em recursos Data Catalog](https://docs.aws.amazon.com/lake-formation/latest/dg/granting-catalog-permissions.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [BatchGrantPermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/batch-grant-permissions.html) na *Referência de comandos da AWS CLI*. ### `batch-revoke-permissions` O código de exemplo a seguir mostra como usar `batch-revoke-permissions`. **AWS CLI** **Como revogar permissões em massa sobre recursos às entidades principais** O exemplo `batch-revoke-permissions` a seguir revoga acesso em massa a recursos específicos para as entidades principais. ``` aws lakeformation batch-revoke-permissions \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "CatalogId": "123456789111", "Entries": [{ "Id": "1", "Principal": { "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-developer" }, "Resource": { "Table": { "CatalogId": "123456789111", "DatabaseName": "tpc", "Name": "dl_tpc_promotion" } }, "Permissions": [ "ALL" ], "PermissionsWithGrantOption": [ "ALL" ] }, { "Id": "2", "Principal": { "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-business-analyst" }, "Resource": { "Table": { "CatalogId": "123456789111", "DatabaseName": "tpc", "Name": "dl_tpc_promotion" } }, "Permissions": [ "ALL" ], "PermissionsWithGrantOption": [ "ALL" ] } ] } ``` Resultado: ``` { "Failures": [] } ``` Para obter mais informações, consulte [Conceder e revogar permissões em recursos Data Catalog](https://docs.aws.amazon.com/lake-formation/latest/dg/granting-catalog-permissions.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [BatchRevokePermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/batch-revoke-permissions.html) na *Referência de comandos da AWS CLI*. ### `cancel-transaction` O código de exemplo a seguir mostra como usar `cancel-transaction`. **AWS CLI** **Como cancelar uma transação** O exemplo `cancel-transaction` a seguir cancela uma transação. ``` aws lakeformation cancel-transaction \ --transaction-id='b014d972ca8347b89825e33c5774aec4' ``` Este comando não produz saída. Para obter mais informações, consulte [Ler e gravar no data lake dentro das transações](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [CancelTransaction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/cancel-transaction.html) na *Referência de comandos da AWS CLI*. ### `commit-transaction` O código de exemplo a seguir mostra como usar `commit-transaction`. **AWS CLI** **Como confirmar uma transação** O exemplo `commit-transaction` a seguir confirma uma transação. ``` aws lakeformation commit-transaction \ --transaction-id='b014d972ca8347b89825e33c5774aec4' ``` Resultado: ``` { "TransactionStatus": "committed" } ``` Para obter mais informações, consulte [Ler e gravar no data lake dentro das transações](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [CommitTransaction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/commit-transaction.html) na *Referência de comandos da AWS CLI*. ### `create-data-cells-filter` O código de exemplo a seguir mostra como usar `create-data-cells-filter`. **AWS CLI** **Exemplo 1: criar um filtro de células de dados** O exemplo `create-data-cells-filter` a seguir cria um filtro de célula de dados para permitir que se conceda acesso a determinadas colunas com base na condição da linha. ``` aws lakeformation create-data-cells-filter \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "TableData": { "ColumnNames": ["p_channel_details", "p_start_date_sk", "p_promo_name"], "DatabaseName": "tpc", "Name": "developer_promotion", "RowFilter": { "FilterExpression": "p_promo_name='ese'" }, "TableCatalogId": "123456789111", "TableName": "dl_tpc_promotion" } } ``` Este comando não produz saída. Para obter mais informações, consulte [Filtrar dados e segurança de células no Lake Formation](https://docs.aws.amazon.com/lake-formation/latest/dg/data-filtering.html) no *Guia do desenvolvedor do AWS Lake Formation*. **Exemplo 2: criar um filtro de coluna** O exemplo `create-data-cells-filter` a seguir cria um filtro de célula de dados para permitir que se conceda acesso a determinadas colunas. ``` aws lakeformation create-data-cells-filter \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "TableData": { "ColumnNames": ["p_channel_details", "p_start_date_sk", "p_promo_name"], "DatabaseName": "tpc", "Name": "developer_promotion_allrows", "RowFilter": { "AllRowsWildcard": {} }, "TableCatalogId": "123456789111", "TableName": "dl_tpc_promotion" } } ``` Este comando não produz saída. Para obter mais informações, consulte [Filtrar dados e segurança de células no Lake Formation](https://docs.aws.amazon.com/lake-formation/latest/dg/data-filtering.html) no *Guia do desenvolvedor do AWS Lake Formation*. **Exemplo 3: criar um filtro de dados com colunas de exclusão** O exemplo `create-data-cells-filter` a seguir cria um filtro de célula de dados para permitir que se conceda acesso a todas as colunas, exceto as especificadas. ``` aws lakeformation create-data-cells-filter \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "TableData": { "ColumnWildcard": { "ExcludedColumnNames": ["p_channel_details", "p_start_date_sk"] }, "DatabaseName": "tpc", "Name": "developer_promotion_excludecolumn", "RowFilter": { "AllRowsWildcard": {} }, "TableCatalogId": "123456789111", "TableName": "dl_tpc_promotion" } } ``` Este comando não produz saída. Para obter mais informações, consulte [Filtrar dados e segurança de células no Lake Formation](https://docs.aws.amazon.com/lake-formation/latest/dg/data-filtering.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [CreateDataCellsFilter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/create-data-cells-filter.html) na *Referência de comandos da AWS CLI*. ### `create-lf-tag` O código de exemplo a seguir mostra como usar `create-lf-tag`. **AWS CLI** **Para criar uma tag do LF** O exemplo `create-lf-tag` a seguir cria uma tag do LF com os nomes e valores especificados. ``` aws lakeformation create-lf-tag \ --catalog-id '123456789111' \ --tag-key 'usergroup' \ --tag-values '["developer","analyst","campaign"]' ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar tags LF para controle de acesso a metadados](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-tags.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [CreateLfTag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/create-lf-tag.html) na *Referência de comandos da AWS CLI*. ### `delete-data-cells-filter` O código de exemplo a seguir mostra como usar `delete-data-cells-filter`. **AWS CLI** **Para excluir o filtro de células de dados** O exemplo `delete-data-cells-filter` a seguir exclui um determinado filtro de célula de dados. ``` aws lakeformation delete-data-cells-filter \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "TableCatalogId": "123456789111", "DatabaseName": "tpc", "TableName": "dl_tpc_promotion", "Name": "developer_promotion" } ``` Este comando não produz saída. Para obter mais informações, consulte [Filtrar dados e segurança de células no Lake Formation](https://docs.aws.amazon.com/lake-formation/latest/dg/data-filtering.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [DeleteDataCellsFilter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/delete-data-cells-filter.html) na *Referência de comandos da AWS CLI*. ### `delete-lf-tag` O código de exemplo a seguir mostra como usar `delete-lf-tag`. **AWS CLI** **Para excluir a definição de uma tag LF** O exemplo `delete-lf-tag` a seguir exclui a definição da tag LF. ``` aws lakeformation delete-lf-tag \ --catalog-id '123456789111' \ --tag-key 'usergroup' ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar tags LF para controle de acesso a metadados](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-tags.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [DeleteLfTag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/delete-lf-tag.html) na *Referência de comandos da AWS CLI*. ### `delete-objects-on-cancel` O código de exemplo a seguir mostra como usar `delete-objects-on-cancel`. **AWS CLI** **Para excluir o objeto quando a transação é cancelada** O exemplo `delete-objects-on-cancel` a seguir exclui o objeto s3 listado quando a transação é cancelada. ``` aws lakeformation delete-objects-on-cancel \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "CatalogId": "012345678901", "DatabaseName": "tpc", "TableName": "dl_tpc_household_demographics_gov", "TransactionId": "1234d972ca8347b89825e33c5774aec4", "Objects": [{ "Uri": "s3://lf-data-lake-012345678901/target/dl_tpc_household_demographics_gov/run-unnamed-1-part-block-0-r-00000-snappy-ff26b17504414fe88b302cd795eabd00.parquet", "ETag": "1234ab1fc50a316b149b4e1f21a73800" }] } ``` Este comando não produz saída. Para obter mais informações, consulte [Ler e gravar no data lake dentro das transações](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [DeleteObjectsOnCancel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/delete-objects-on-cancel.html) na *Referência de comandos da AWS CLI*. ### `deregister-resource` O código de exemplo a seguir mostra como usar `deregister-resource`. **AWS CLI** **Como cancelar o registro do armazenamento em data lake** O exemplo `deregister-resource` a seguir cancela o registro do recurso conforme gerenciado pelo Lake Formation. ``` aws lakeformation deregister-resource \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "ResourceArn": "arn:aws:s3:::lf-emr-athena-result-123" } ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar uma localização do Amazon S3 ao seu data lake](https://docs.aws.amazon.com/lake-formation/latest/dg/register-data-lake.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [DeregisterResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/deregister-resource.html) na *Referência de comandos da AWS CLI*. ### `describe-transaction` O código de exemplo a seguir mostra como usar `describe-transaction`. **AWS CLI** **Para recuperar os detalhes de uma transação** O exemplo `describe-transaction` a seguir retorna os detalhes de uma única transação. ``` aws lakeformation describe-transaction \ --transaction-id='8cb4b1a7cc8d486fbaca9a64e7d9f5ce' ``` Resultado: ``` { "TransactionDescription": { "TransactionId": "12345972ca8347b89825e33c5774aec4", "TransactionStatus": "committed", "TransactionStartTime": "2022-08-10T14:29:04.046000+00:00", "TransactionEndTime": "2022-08-10T14:29:09.681000+00:00" } } ``` Para obter mais informações, consulte [Ler e gravar no data lake dentro das transações](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [DescribeTransaction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/describe-transaction.html) na *Referência de comandos da AWS CLI*. ### `extend-transaction` O código de exemplo a seguir mostra como usar `extend-transaction`. **AWS CLI** **Como estender uma transação** O exemplo `extend-transaction` a seguir estende uma transação. ``` aws lakeformation extend-transaction \ --transaction-id='8cb4b1a7cc8d486fbaca9a64e7d9f5ce' ``` Este comando não produz saída. Para obter mais informações, consulte [Ler e gravar no data lake dentro das transações](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [ExtendTransaction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/extend-transaction.html) na *Referência de comandos da AWS CLI*. ### `get-data-lake-settings` O código de exemplo a seguir mostra como usar `get-data-lake-settings`. **AWS CLI** **Para recuperar as configurações do data lake gerenciado pelo AWS Lake Formation** O exemplo `get-data-lake-settings` a seguir recupera a lista de administradores de data lake e outras configurações de data lake. ``` aws lakeformation get-data-lake-settings \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "CatalogId": "123456789111" } ``` Resultado: ``` { "DataLakeSettings": { "DataLakeAdmins": [{ "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-admin" }], "CreateDatabaseDefaultPermissions": [], "CreateTableDefaultPermissions": [ { "Principal": { "DataLakePrincipalIdentifier": "IAM_ALLOWED_PRINCIPALS" }, "Permissions": [ "ALL" ] } ], "TrustedResourceOwners": [], "AllowExternalDataFiltering": true, "ExternalDataFilteringAllowList": [{ "DataLakePrincipalIdentifier": "123456789111" }], "AuthorizedSessionTagValueList": [ "Amazon EMR" ] } } ``` Para obter mais informações, consulte [Alterando as configurações de segurança padrão do seu data lake](https://docs.aws.amazon.com/lake-formation/latest/dg/change-settings.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para receber detalhes da API, consulte [GetDataLakeSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-data-lake-settings.html) na *Referência de comandos da AWS CLI*. ### `get-effective-permissions-for-path` O código de exemplo a seguir mostra como usar `get-effective-permissions-for-path`. **AWS CLI** **Para recuperar permissões em recursos localizados em um caminho específico** O exemplo `get-effective-permissions-for-path` a seguir retorna as permissões do Lake Formation para uma tabela ou recurso de banco de dados especificado localizado em um caminho no Amazon S3. ``` aws lakeformation get-effective-permissions-for-path \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "CatalogId": "123456789111", "ResourceArn": "arn:aws:s3:::lf-data-lake-123456789111" } ``` Resultado: ``` { "Permissions": [{ "Principal": { "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-campaign-manager" }, "Resource": { "Database": { "Name": "tpc" } }, "Permissions": [ "DESCRIBE" ], "PermissionsWithGrantOption": [] }, { "Principal": { "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:role/EMR-RuntimeRole" }, "Resource": { "Database": { "Name": "tpc" } }, "Permissions": [ "ALL" ], "PermissionsWithGrantOption": [] }, { "Principal": { "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:saml-provider/oktaSAMLProvider:user/emr-developer" }, "Resource": { "Database": { "Name": "tpc" } }, "Permissions": [ "ALL", "DESCRIBE" ], "PermissionsWithGrantOption": [] }, { "Principal": { "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-admin" }, "Resource": { "Database": { "Name": "tpc" } }, "Permissions": [ "ALL", "ALTER", "CREATE_TABLE", "DESCRIBE", "DROP" ], "PermissionsWithGrantOption": [ "ALL", "ALTER", "CREATE_TABLE", "DESCRIBE", "DROP" ] }, { "Principal": { "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:role/LF-GlueServiceRole" }, "Resource": { "Database": { "Name": "tpc" } }, "Permissions": [ "CREATE_TABLE" ], "PermissionsWithGrantOption": [] } ], "NextToken": "E5SlJDSTZleUp6SWpvaU9UQTNORE0zTXpFeE5Ua3pJbjE5TENKbGVIQnBjbUYwYVc5dUlqcDdJbk5sWTI5dVpITWlPakUyTm==" } ``` Para obter mais informações, consulte [Gerenciar permissões do Lake Formation](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-permissions.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [GetEffectivePermissionsForPath](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-effective-permissions-for-path.html) na *Referência de comandos da AWS CLI*. ### `get-lf-tag` O código de exemplo a seguir mostra como usar `get-lf-tag`. **AWS CLI** **Para recuperar a definição da tag LF** O exemplo `get-lf-tag` a seguir recupera a definição da tag LF. ``` aws lakeformation get-lf-tag \ --catalog-id '123456789111' \ --tag-key 'usergroup' ``` Resultado: ``` { "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "analyst", "campaign", "developer" ] } ``` Para obter mais informações, consulte [Gerenciar tags LF para controle de acesso a metadados](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-tags.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [GetLfTag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-lf-tag.html) na *Referência de comandos da AWS CLI*. ### `get-query-state` O código de exemplo a seguir mostra como usar `get-query-state`. **AWS CLI** **Para recuperar o estado de uma consulta enviada** O exemplo `get-query-state` a seguir retorna o estado de uma consulta enviada anteriormente. ``` aws lakeformation get-query-state \ --query-id='1234273f-4a62-4cda-8d98-69615ee8be9b' ``` Resultado: ``` { "State": "FINISHED" } ``` Para obter mais informações, consulte [Operações de dados transacionais](https://docs.aws.amazon.com/lake-formation/latest/dg/transactions-data-operations.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [GetQueryState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-query-state.html) na *Referência de comandos da AWS CLI*. ### `get-query-statistics` O código de exemplo a seguir mostra como usar `get-query-statistics`. **AWS CLI** **Para recuperar estatísticas de consulta** O exemplo `get-query-statistics` a seguir recupera estatísticas sobre o planejamento e a execução de uma consulta. ``` aws lakeformation get-query-statistics \ --query-id='1234273f-4a62-4cda-8d98-69615ee8be9b' ``` Resultado: ``` { "ExecutionStatistics": { "AverageExecutionTimeMillis": 0, "DataScannedBytes": 0, "WorkUnitsExecutedCount": 0 }, "PlanningStatistics": { "EstimatedDataToScanBytes": 43235, "PlanningTimeMillis": 2377, "QueueTimeMillis": 440, "WorkUnitsGeneratedCount": 1 }, "QuerySubmissionTime": "2022-08-11T02:14:38.641870+00:00" } ``` Para obter mais informações, consulte [Operações de dados transacionais](https://docs.aws.amazon.com/lake-formation/latest/dg/transactions-data-operations.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [GetQueryStatistics](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-query-statistics.html) na *Referência de comandos da AWS CLI*. ### `get-resource-lf-tags` O código de exemplo a seguir mostra como usar `get-resource-lf-tags`. **AWS CLI** **Para listar tags LF** O exemplo `list-lf-tags` a seguir retorna uma lista de tags LF que o solicitante tem permissão para visualizar. ``` aws lakeformation list-lf-tags \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "CatalogId": "123456789111", "ResourceShareType": "ALL", "MaxResults": 2 } ``` Resultado: ``` { "LFTags": [{ "CatalogId": "123456789111", "TagKey": "category", "TagValues": [ "private", "public" ] }, { "CatalogId": "123456789111", "TagKey": "group", "TagValues": [ "analyst", "campaign", "developer" ] }], "NextToken": "kIiwiZXhwaXJhdGlvbiI6eyJzZWNvbmRzIjoxNjYwMDY4dCI6ZmFsc2V9" } ``` Para obter mais informações, consulte [Gerenciar tags LF para controle de acesso a metadados](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-tags.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [GetResourceLfTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-resource-lf-tags.html) na *Referência de comandos da AWS CLI*. ### `get-table-objects` O código de exemplo a seguir mostra como usar `get-table-objects`. **AWS CLI** **Para listar objetos da tabela controlada** O exemplo `get-table-objects` a seguir retorna o conjunto de objetos do Amazon S3 que compõem a tabela controlada especificada. ``` aws lakeformation get-table-objects \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "CatalogId": "012345678901", "DatabaseName": "tpc", "TableName": "dl_tpc_household_demographics_gov", "QueryAsOfTime": "2022-08-10T15:00:00" } ``` Resultado: ``` { "Objects": [{ "PartitionValues": [], "Objects": [{ "Uri": "s3://lf-data-lake-012345678901/target/dl_tpc_household_demographics_gov/run-unnamed-1-part-block-0-r-00000-snappy-ff26b17504414fe88b302cd795eabd00.parquet", "ETag": "12345b1fc50a316b149b4e1f21a73800", "Size": 43235 }] }] } ``` Para obter mais informações, consulte [Ler e gravar no data lake dentro das transações](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [GetTableObjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-table-objects.html) na *Referência de comandos da AWS CLI*. ### `get-work-unit-results` O código de exemplo a seguir mostra como usar `get-work-unit-results`. **AWS CLI** **Para recuperar unidades de trabalho de uma determinada consulta** O exemplo `get-work-unit-results` a seguir retorna as unidades de trabalho resultantes da consulta. ``` aws lakeformation get-work-units \ --query-id='1234273f-4a62-4cda-8d98-69615ee8be9b' \ --work-unit-id '0' \ --work-unit-token 'B2fMSdmQXe9umX8Ux8XCo4=' outfile ``` Resultado: ``` outfile with Blob content. ``` Para obter mais informações, consulte [Operações de dados transacionais](https://docs.aws.amazon.com/lake-formation/latest/dg/transactions-data-operations.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [GetWorkUnitResults](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-work-unit-results.html) na *Referência de comandos da AWS CLI*. ### `get-work-units` O código de exemplo a seguir mostra como usar `get-work-units`. **AWS CLI** **Para recuperar unidades de trabalho** O exemplo `get-work-units` a seguir recupera as unidades de trabalho geradas pela operação StartQueryPlanning. ``` aws lakeformation get-work-units \ --query-id='1234273f-4a62-4cda-8d98-69615ee8be9b' ``` Resultado: ``` { "WorkUnitRanges": [{ "WorkUnitIdMax": 0, "WorkUnitIdMin": 0, "WorkUnitToken": "1234eMAk4kLO4umqEL4Z5WuxL04AXwABABVhd3MtY3J5cHRvLXB1YmxpYy1rZXkAREEwYm9QbkhINmFYTWphbmMxZW1PQmEyMGlUb0JFbXNlWmRYc0NmckRIR1dmQ0hjY2YzNFdMcmNXb2JGZmhEK0QvZz09AAEAB2F3cy1rbXMAS2Fybjphd3M6a21zOnVzLWVhc3QtMTo3MDkxNTAyNDkyNDk6a2V5L2VmYmI3NDUyLTY1MjYtNGJiOS1iNmZhLTEzYzJkMTM3MmU2OQC4AQIBAHg6eWNF2ZrQATTAuPDJVCEAQSyIF67vX+f88jzGrYq22gE6jkQlpOB+Oet2eqNUmFudAAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMCOEWRdafowek3RUmAgEQgDsYZZE84nnnbNmvsqCBPLh19nLQ10mUWOg9IfiaOwefEn6L920V0x1LpJACo7MtIBLXnbGcz2dFDZjFygIAAAAADAAAEAAAAAAAAAAAAAAAAAAQSQf8XDSI5pvR4Fx4JsrS/////wAAAAEAAAAAAAAAAAAAAAEAAACX3/w5h75QAPomfKH+cyEKYU1yccUmBl+VSojiGOtdsUk7vcjYXUUboYm3dvqRqX2s4gROMOn+Ij8R0/8jYmnHkpvyAFNVRPyETyIKg7k5Z9+5I1c2d3446Jw/moWGGxjH8AEG9h27ytmOhozxDOEi/F2ZoXz6wlGDfGUo/2WxCkYOhTyNaw6TM+7drTM7yrW4iNVLUM0LX0xnFjIAhLhooWJek6vjQZUAZzBlAjBH8okRtYP8R7AY2Wls/hqFBhG0V4l42AC0LxsuZbMQrE2SzWZUZ0E9Uew7/n0cyX4CMQDR79INyv4ysMByW9kKGGKyba+cCNklExMR+btBQBmMuB2fMSdmQXe9umX8Ux8XCo4=" }], "QueryId": "1234273f-4a62-4cda-8d98-69615ee8be9b" } ``` Para obter mais informações, consulte [Operações de dados transacionais](https://docs.aws.amazon.com/lake-formation/latest/dg/transactions-data-operations.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [GetWorkUnits](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-work-units.html) na *Referência de comandos da AWS CLI*. ### `grant-permissions` O código de exemplo a seguir mostra como usar `grant-permissions`. **AWS CLI** **Exemplo 1: conceder permissões à entidade principal sobre recursos usando tags LF** O exemplo `grant-permissions` a seguir concede TODAS as permissões à entidade principal no recurso de banco de dados que corresponde à política da tag do LF. ``` aws lakeformation grant-permissions \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "CatalogId": "123456789111", "Principal": { "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-admin" }, "Resource": { "LFTagPolicy": { "CatalogId": "123456789111", "ResourceType": "DATABASE", "Expression": [{ "TagKey": "usergroup", "TagValues": [ "analyst", "developer" ] }] } }, "Permissions": [ "ALL" ], "PermissionsWithGrantOption": [ "ALL" ] } ``` Este comando não produz saída. Para obter mais informações, consulte [Conceder e revogar permissões em recursos Data Catalog](https://docs.aws.amazon.com/lake-formation/latest/dg/granting-catalog-permissions.html) no *Guia do desenvolvedor do AWS Lake Formation*. **Exemplo 2: conceder permissões em nível de coluna à entidade principal** O exemplo `grant-permissions` a seguir concede à entidade principal permissão para selecionar uma coluna específica. ``` aws lakeformation grant-permissions \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "CatalogId": "123456789111", "Principal": { "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-developer" }, "Resource": { "TableWithColumns": { "CatalogId": "123456789111", "ColumnNames": ["p_end_date_sk"], "DatabaseName": "tpc", "Name": "dl_tpc_promotion" } }, "Permissions": [ "SELECT" ], "PermissionsWithGrantOption": [] } ``` Este comando não produz saída. Para obter mais informações, consulte [Conceder e revogar permissões em recursos Data Catalog](https://docs.aws.amazon.com/lake-formation/latest/dg/granting-catalog-permissions.html) no *Guia do desenvolvedor do AWS Lake Formation*. **Exemplo 3: conceder permissões de tabela à entidade principal** O exemplo `grant-permissions` a seguir concede à entidade principal permissão de seleção em todas as tabelas de um determinado banco de dados. ``` aws lakeformation grant-permissions \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "CatalogId": "123456789111", "Principal": { "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-developer" }, "Resource": { "Table": { "CatalogId": "123456789111", "DatabaseName": "tpc", "TableWildcard": {} } }, "Permissions": [ "SELECT" ], "PermissionsWithGrantOption": [] } ``` Este comando não produz saída. Para obter mais informações, consulte [Conceder e revogar permissões em recursos Data Catalog](https://docs.aws.amazon.com/lake-formation/latest/dg/granting-catalog-permissions.html) no *Guia do desenvolvedor do AWS Lake Formation*. **Exemplo 4: conceder permissões das tags do LF à entidade principal** O exemplo `grant-permissions` a seguir concede à entidade principal permissão associada a tags LF. ``` aws lakeformation grant-permissions \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "CatalogId": "123456789111", "Principal": { "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-developer" }, "Resource": { "LFTag": { "CatalogId": "123456789111", "TagKey": "category", "TagValues": [ "private", "public" ] } }, "Permissions": [ "ASSOCIATE" ], "PermissionsWithGrantOption": [] } ``` Este comando não produz saída. Para obter mais informações, consulte [Conceder e revogar permissões em recursos Data Catalog](https://docs.aws.amazon.com/lake-formation/latest/dg/granting-catalog-permissions.html) no *Guia do desenvolvedor do AWS Lake Formation*. **Exemplo 5: conceder permissões de locais de dados à entidade principal** O exemplo `grant-permissions` a seguir concede à entidade principal permissões de localização de dados. ``` aws lakeformation grant-permissions \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "CatalogId": "123456789111", "Principal": { "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-developer" }, "Resource": { "DataLocation": { "CatalogId": "123456789111", "ResourceArn": "arn:aws:s3:::lf-data-lake-123456789111" } }, "Permissions": [ "DATA_LOCATION_ACCESS" ], "PermissionsWithGrantOption": [] } ``` Este comando não produz saída. Para obter mais informações, consulte [Conceder e revogar permissões em recursos Data Catalog](https://docs.aws.amazon.com/lake-formation/latest/dg/granting-catalog-permissions.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [GrantPermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/grant-permissions.html) na *Referência de comandos da AWS CLI*. ### `list-data-cells-filter` O código de exemplo a seguir mostra como usar `list-data-cells-filter`. **AWS CLI** **Para listar filtros de células de dados** O exemplo `list-data-cells-filter` a seguir lista os filtros de dados para uma determinada tabela. ``` aws lakeformation list-data-cells-filter \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "MaxResults": 2, "Table": { "CatalogId": "123456789111", "DatabaseName": "tpc", "Name": "dl_tpc_promotion" } } ``` Resultado: ``` { "DataCellsFilters": [{ "TableCatalogId": "123456789111", "DatabaseName": "tpc", "TableName": "dl_tpc_promotion", "Name": "developer_promotion", "RowFilter": { "FilterExpression": "p_promo_name='ese'" }, "ColumnNames": [ "p_channel_details", "p_start_date_sk", "p_purpose", "p_promo_id", "p_promo_name", "p_end_date_sk", "p_discount_active" ] }, { "TableCatalogId": "123456789111", "DatabaseName": "tpc", "TableName": "dl_tpc_promotion", "Name": "developer_promotion_allrows", "RowFilter": { "FilterExpression": "TRUE", "AllRowsWildcard": {} }, "ColumnNames": [ "p_channel_details", "p_start_date_sk", "p_promo_name" ] } ], "NextToken": "2MDA2MTgwNiwibmFub3MiOjE0MDAwMDAwMH19" } ``` Para obter mais informações, consulte [Filtrar dados e segurança de células no Lake Formation](https://docs.aws.amazon.com/lake-formation/latest/dg/data-filtering.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [ListDataCellsFilter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/list-data-cells-filter.html) na *Referência de comandos da AWS CLI*. ### `list-permissions` O código de exemplo a seguir mostra como usar `list-permissions`. **AWS CLI** **Exemplo 1: recuperar a lista das permissões da entidade principal ao recurso** O exemplo `list-permissions` a seguir retorna uma lista de permissões da entidade principal aos recursos de banco de dados. ``` aws lakeformation list-permissions \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "CatalogId": "123456789111", "ResourceType": "DATABASE", "MaxResults": 2 } ``` Resultado: ``` { "PrincipalResourcePermissions": [{ "Principal": { "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-campaign-manager" }, "Resource": { "Database": { "CatalogId": "123456789111", "Name": "tpc" } }, "Permissions": [ "DESCRIBE" ], "PermissionsWithGrantOption": [] }], "NextToken": "E5SlJDSTZleUp6SWpvaU9UQTNORE0zTXpFeE5Ua3pJbjE5TENKbGVIQnBjbUYwYVc5dUlqcDdJbk5sWTI5dVpITWlPakUyTm" } ``` Para obter mais informações, consulte [Gerenciar permissões do Lake Formation](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-permissions.html) no *Guia do desenvolvedor do AWS Lake Formation*. **Exemplo 2: recuperar a lista das permissões da entidade principal à tabela com filtros de dados** O exemplo `list-permissions` a seguir lista as permissões concedidas à entidade principal sobre a tabela com filtros de dados. ``` aws lakeformation list-permissions \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "CatalogId": "123456789111", "Resource": { "Table": { "CatalogId": "123456789111", "DatabaseName": "tpc", "Name": "dl_tpc_customer" } }, "IncludeRelated": "TRUE", "MaxResults": 10 } ``` Resultado: ``` { "PrincipalResourcePermissions": [{ "Principal": { "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:role/Admin" }, "Resource": { "Table": { "CatalogId": "123456789111", "DatabaseName": "customer", "Name": "customer_invoice" } }, "Permissions": [ "ALL", "ALTER", "DELETE", "DESCRIBE", "DROP", "INSERT" ], "PermissionsWithGrantOption": [ "ALL", "ALTER", "DELETE", "DESCRIBE", "DROP", "INSERT" ] }, { "Principal": { "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:role/Admin" }, "Resource": { "TableWithColumns": { "CatalogId": "123456789111", "DatabaseName": "customer", "Name": "customer_invoice", "ColumnWildcard": {} } }, "Permissions": [ "SELECT" ], "PermissionsWithGrantOption": [ "SELECT" ] }, { "Principal": { "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:role/Admin" }, "Resource": { "DataCellsFilter": { "TableCatalogId": "123456789111", "DatabaseName": "customer", "TableName": "customer_invoice", "Name": "dl_us_customer" } }, "Permissions": [ "DESCRIBE", "SELECT", "DROP" ], "PermissionsWithGrantOption": [] } ], "NextToken": "VyeUFjY291bnRQZXJtaXNzaW9ucyI6ZmFsc2V9" } ``` Para obter mais informações, consulte [Gerenciar permissões do Lake Formation](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-permissions.html) no *Guia do desenvolvedor do AWS Lake Formation*. **Exemplo 3: recuperar a lista das permissões da entidade principal às tags LF** O exemplo `list-permissions` a seguir lista as permissões concedidas à entidade principal sobre as tags LF. ``` aws lakeformation list-permissions \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "CatalogId": "123456789111", "Resource": { "LFTag": { "CatalogId": "123456789111", "TagKey": "category", "TagValues": [ "private" ] } }, "MaxResults": 10 } ``` Resultado: ``` { "PrincipalResourcePermissions": [{ "Principal": { "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-admin" }, "Resource": { "LFTag": { "CatalogId": "123456789111", "TagKey": "category", "TagValues": [ "*" ] } }, "Permissions": [ "DESCRIBE" ], "PermissionsWithGrantOption": [ "DESCRIBE" ] }, { "Principal": { "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-admin" }, "Resource": { "LFTag": { "CatalogId": "123456789111", "TagKey": "category", "TagValues": [ "*" ] } }, "Permissions": [ "ASSOCIATE" ], "PermissionsWithGrantOption": [ "ASSOCIATE" ] } ], "NextToken": "EJwY21GMGFXOXVJanA3SW5Ocm1pc3Npb25zIjpmYWxzZX0=" } ``` Para obter mais informações, consulte [Gerenciar permissões do Lake Formation](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-permissions.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [ListPermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/list-permissions.html) na *Referência de comandos da AWS CLI*. ### `list-resources` O código de exemplo a seguir mostra como usar `list-resources`. **AWS CLI** **Para listar os recursos gerenciados pelo Lake Formation** O exemplo `list-resources` a seguir lista os recursos que correspondem à condição gerenciada pelo Lake Formation. ``` aws lakeformation list-resources \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "FilterConditionList": [{ "Field": "ROLE_ARN", "ComparisonOperator": "CONTAINS", "StringValueList": [ "123456789111" ] }], "MaxResults": 10 } ``` Resultado: ``` { "ResourceInfoList": [{ "ResourceArn": "arn:aws:s3:::lf-data-lake-123456789111", "RoleArn": "arn:aws:iam::123456789111:role/LF-GlueServiceRole", "LastModified": "2022-07-21T02:12:46.669000+00:00" }, { "ResourceArn": "arn:aws:s3:::lf-emr-test-123456789111", "RoleArn": "arn:aws:iam::123456789111:role/EMRLFS3Role", "LastModified": "2022-07-29T16:22:03.211000+00:00" } ] } ``` Para obter mais informações, consulte [Gerenciar permissões do Lake Formation](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-permissions.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [ListResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/list-resources.html) na *Referência de comandos da AWS CLI*. ### `list-transactions` O código de exemplo a seguir mostra como usar `list-transactions`. **AWS CLI** **Para listar todos os detalhes das transações** O exemplo `list-transactions` a seguir retorna metadados sobre transações e seu status. ``` aws lakeformation list-transactions \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "CatalogId": "123456789111", "StatusFilter": "ALL", "MaxResults": 3 } ``` Resultado: ``` { "Transactions": [{ "TransactionId": "1234569f08804cb790d950d4d0fe485e", "TransactionStatus": "committed", "TransactionStartTime": "2022-08-10T14:32:29.220000+00:00", "TransactionEndTime": "2022-08-10T14:32:33.751000+00:00" }, { "TransactionId": "12345972ca8347b89825e33c5774aec4", "TransactionStatus": "committed", "TransactionStartTime": "2022-08-10T14:29:04.046000+00:00", "TransactionEndTime": "2022-08-10T14:29:09.681000+00:00" }, { "TransactionId": "12345daf6cb047dbba8ad9b0414613b2", "TransactionStatus": "committed", "TransactionStartTime": "2022-08-10T13:56:51.261000+00:00", "TransactionEndTime": "2022-08-10T13:56:51.547000+00:00" } ], "NextToken": "77X1ebypsI7os+X2lhHsZLGNCDK3nNGpwRdFpicSOHgcX1/QMoniUAKcpR3kj3ts3PVdMA==" } ``` Para obter mais informações, consulte [Ler e gravar no data lake dentro das transações](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [ListTransactions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/list-transactions.html) na *Referência de comandos da AWS CLI*. ### `put-data-lake-settings` O código de exemplo a seguir mostra como usar `put-data-lake-settings`. **AWS CLI** **Como definir as configurações do data lake gerenciado pelo AWS Lake Formation** O exemplo `put-data-lake-settings` a seguir define a lista de administradores de data lake e outras configurações de data lake. ``` aws lakeformation put-data-lake-settings \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "DataLakeSettings": { "DataLakeAdmins": [{ "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-admin" } ], "CreateDatabaseDefaultPermissions": [], "CreateTableDefaultPermissions": [], "TrustedResourceOwners": [], "AllowExternalDataFiltering": true, "ExternalDataFilteringAllowList": [{ "DataLakePrincipalIdentifier ": "123456789111" }], "AuthorizedSessionTagValueList": ["Amazon EMR"] } } ``` Este comando não produz saída. Para obter mais informações, consulte [Alterando as configurações de segurança padrão do seu data lake](https://docs.aws.amazon.com/lake-formation/latest/dg/change-settings.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [PutDataLakeSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/put-data-lake-settings.html) na *Referência de comandos da AWS CLI*. ### `register-resource` O código de exemplo a seguir mostra como usar `register-resource`. **AWS CLI** **Exemplo 1: registrar o armazenamento do data lake usando o Service Linked Role** O exemplo `register-resource` a seguir registra o recurso conforme gerenciado pelo Lake Formation usando o Service Linked Role. ``` aws lakeformation register-resource \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "ResourceArn": "arn:aws:s3:::lf-emr-athena-result-123", "UseServiceLinkedRole": true } ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar uma localização do Amazon S3 ao seu data lake](https://docs.aws.amazon.com/lake-formation/latest/dg/register-data-lake.html) no *Guia do desenvolvedor do AWS Lake Formation*. **Exemplo 2: registrar o armazenamento do data lake usando um perfil personalizado** O exemplo `register-resource` a seguir registra o recurso conforme gerenciado pelo Lake Formation usando um perfil personalizado. ``` aws lakeformation register-resource \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "ResourceArn": "arn:aws:s3:::lf-emr-athena-result-123", "UseServiceLinkedRole": false, "RoleArn": "arn:aws:iam::123456789111:role/LF-GlueServiceRole" } ``` Este comando não produz saída. Para obter mais informações, consulte [Adicionar uma localização do Amazon S3 ao seu data lake](https://docs.aws.amazon.com/lake-formation/latest/dg/register-data-lake.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [RegisterResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/register-resource.html) na *Referência de comandos da AWS CLI*. ### `remove-lf-tags-from-resource` O código de exemplo a seguir mostra como usar `remove-lf-tags-from-resource`. **AWS CLI** **Para remover uma tag do LF de um recurso** O exemplo `remove-lf-tags-from-resource` a seguir remove a associação da tag do LF ao recurso da tabela. ``` aws lakeformation remove-lf-tags-from-resource \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "CatalogId": "123456789111", "Resource": { "Table": { "CatalogId": "123456789111", "DatabaseName": "tpc", "Name": "dl_tpc_promotion" } }, "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] } ``` Resultado: ``` { "Failures": [] } ``` Para obter mais informações, consulte [Atribuir tags LF aos recursos do Data Catalog](https://docs.aws.amazon.com/lake-formation/latest/dg/TBAC-assigning-tags.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [RemoveLfTagsFromResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/remove-lf-tags-from-resource.html) na *Referência de comandos da AWS CLI*. ### `revoke-permissions` O código de exemplo a seguir mostra como usar `revoke-permissions`. **AWS CLI** **Como revogar permissões da entidade principal a recursos** O exemplo `revoke-permissions` a seguir revoga o acesso da entidade principal à tabela específica de um determinado banco de dados. ``` aws lakeformation revoke-permissions \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "CatalogId": "123456789111", "Principal": { "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-developer" }, "Resource": { "Table": { "CatalogId": "123456789111", "DatabaseName": "tpc", "Name": "dl_tpc_promotion" } }, "Permissions": [ "ALL" ], "PermissionsWithGrantOption": [] } ``` Este comando não produz saída. Para obter mais informações, consulte [Conceder e revogar permissões em recursos Data Catalog](https://docs.aws.amazon.com/lake-formation/latest/dg/granting-catalog-permissions.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [RevokePermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/revoke-permissions.html) na *Referência de comandos da AWS CLI*. ### `search-databases-by-lf-tags` O código de exemplo a seguir mostra como usar `search-databases-by-lf-tags`. **AWS CLI** **Como pesquisar recursos de banco de dados por tags do LF** O exemplo `search-databases-by-lf-tags` a seguir pesquisa recursos de banco de dados que correspondem à expressão da tag do LF. ``` aws lakeformation search-databases-by-lf-tags \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "MaxResults": 1, "CatalogId": "123456789111", "Expression": [{ "TagKey": "usergroup", "TagValues": [ "developer" ] }] } ``` Resultado: ``` { "DatabaseList": [{ "Database": { "CatalogId": "123456789111", "Name": "tpc" }, "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] }] } ``` Para obter mais informações, consulte [Visualizar recursos atribuídos com uma tag do LF](https://docs.aws.amazon.com/lake-formation/latest/dg/TBAC-view-tag-resources.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [SearchDatabasesByLfTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/search-databases-by-lf-tags.html) na *Referência de comandos da AWS CLI*. ### `search-tables-by-lf-tags` O código de exemplo a seguir mostra como usar `search-tables-by-lf-tags`. **AWS CLI** **Como pesquisar recursos de tabela por tags do LF** O exemplo `search-tables-by-lf-tags` a seguir pesquisa recursos de tabela que correspondem à expressão da tag do LF. ``` aws lakeformation search-tables-by-lf-tags \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "MaxResults": 2, "CatalogId": "123456789111", "Expression": [{ "TagKey": "usergroup", "TagValues": [ "developer" ] }] } ``` Resultado: ``` { "NextToken": "c2VhcmNoQWxsVGFnc0luVGFibGVzIjpmYWxzZX0=", "TableList": [{ "Table": { "CatalogId": "123456789111", "DatabaseName": "tpc", "Name": "dl_tpc_item" }, "LFTagOnDatabase": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }], "LFTagsOnTable": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }], "LFTagsOnColumns": [{ "Name": "i_item_desc", "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] }, { "Name": "i_container", "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] }, { "Name": "i_wholesale_cost", "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] }, { "Name": "i_manufact_id", "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] }, { "Name": "i_brand_id", "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] }, { "Name": "i_formulation", "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] }, { "Name": "i_current_price", "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] }, { "Name": "i_size", "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] }, { "Name": "i_rec_start_date", "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] }, { "Name": "i_manufact", "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] }, { "Name": "i_item_sk", "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] }, { "Name": "i_manager_id", "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] }, { "Name": "i_item_id", "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] }, { "Name": "i_class_id", "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] }, { "Name": "i_class", "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] }, { "Name": "i_category", "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] }, { "Name": "i_category_id", "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] }, { "Name": "i_brand", "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] }, { "Name": "i_units", "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] }, { "Name": "i_rec_end_date", "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] }, { "Name": "i_color", "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] }, { "Name": "i_product_name", "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] } ] }] } ``` Para obter mais informações, consulte [Visualizar recursos atribuídos com uma tag do LF](https://docs.aws.amazon.com/lake-formation/latest/dg/TBAC-view-tag-resources.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [SearchTablesByLfTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/search-tables-by-lf-tags.html) na *Referência de comandos da AWS CLI.* ### `start-query-planning` O código de exemplo a seguir mostra como usar `start-query-planning`. **AWS CLI** **Como processar a declaração de consulta** O exemplo `start-query-planning` a seguir envia uma solicitação para processar uma declaração de consulta. ``` aws lakeformation start-query-planning \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "QueryPlanningContext": { "CatalogId": "012345678901", "DatabaseName": "tpc" }, "QueryString": "select * from dl_tpc_household_demographics_gov where hd_income_band_sk=9" } ``` Resultado: ``` { "QueryId": "772a273f-4a62-4cda-8d98-69615ee8be9b" } ``` Para obter mais informações, consulte [Ler e gravar no data lake dentro das transações](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [StartQueryPlanning](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/start-query-planning.html) na *Referência de comandos da AWS CLI*. ### `start-transaction` O código de exemplo a seguir mostra como usar `start-transaction`. **AWS CLI** **Para iniciar uma nova transação** O exemplo `start-transaction` a seguir inicia uma nova transação e retorna seu ID de transação. ``` aws lakeformation start-transaction \ --transaction-type = 'READ_AND_WRITE' ``` Resultado: ``` { "TransactionId": "b014d972ca8347b89825e33c5774aec4" } ``` Para obter mais informações, consulte [Ler e gravar no data lake dentro das transações](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [StartTransaction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/start-transaction.html) na *Referência de comandos da AWS CLI*. ### `update-lf-tag` O código de exemplo a seguir mostra como usar `update-lf-tag`. **AWS CLI** **Para atualizar a definição de uma tag LF** O exemplo `update-lf-tag` a seguir atualiza a definição da tag LF. ``` aws lakeformation update-lf-tag \ --catalog-id '123456789111' \ --tag-key 'usergroup' \ --tag-values-to-add '["admin"]' ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar tags LF para controle de acesso a metadados](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-tags.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [UpdateLfTag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/update-lf-tag.html) na *Referência de comandos da AWS CLI*. ### `update-table-objects` O código de exemplo a seguir mostra como usar `update-table-objects`. **AWS CLI** **Para modificar objetos da tabela controlada** O exemplo `update-table-objects` a seguir adiciona objetos S3 fornecidos à tabela controlada especificada. ``` aws lakeformation update-table-objects \ --cli-input-json file://input.json ``` Conteúdo de `input.json`: ``` { "CatalogId": "012345678901", "DatabaseName": "tpc", "TableName": "dl_tpc_household_demographics_gov", "TransactionId": "12347a9f75424b9b915f6ff201d2a190", "WriteOperations": [{ "AddObject": { "Uri": "s3://lf-data-lake-012345678901/target/dl_tpc_household_demographics_gov/run-unnamed-1-part-block-0-r-00000-snappy-ff26b17504414fe88b302cd795eabd00.parquet", "ETag": "1234ab1fc50a316b149b4e1f21a73800", "Size": 42200 } }] } ``` Este comando não produz saída. Para obter mais informações, consulte [Ler e gravar no data lake dentro das transações](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html) no *Guia do desenvolvedor do AWS Lake Formation*. + Para ver detalhes da API, consulte [UpdateTableObjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/update-table-objects.html) na *Referência de comandos da AWS CLI*. # Exemplos do Lambda usando o AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface 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-layer-version-permission` O código de exemplo a seguir mostra como usar `add-layer-version-permission`. **AWS CLI** **Para adicionar permissões a uma versão de camada** O exemplo `add-layer-version-permission` a seguir concede permissão para a conta especificada usar a versão 1 da camada `my-layer`. ``` aws lambda add-layer-version-permission \ --layer-name my-layer \ --statement-id xaccount \ --action lambda:GetLayerVersion \ --principal 123456789012 \ --version-number 1 ``` Resultado: ``` { "RevisionId": "35d87451-f796-4a3f-a618-95a3671b0a0c", "Statement": { "Sid":"xaccount", "Effect":"Allow", "Principal":{ "AWS":"arn:aws:iam::210987654321:root" }, "Action":"lambda:GetLayerVersion", "Resource":"arn:aws:lambda:us-east-2:123456789012:layer:my-layer:1" } } ``` Para obter mais informações, consulte [Camadas do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) no *Guia do desenvolvedor do AWS Lambda*. + Para ver detalhes da API, consulte [AddLayerVersionPermission](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/add-layer-version-permission.html) na *Referência de comandos da AWS CLI*. ### `add-permission` O código de exemplo a seguir mostra como usar `add-permission`. **AWS CLI** **Para remover permissões de uma função do Lambda existente** O exemplo `add-permission` a seguir concede permissão ao serviço do Amazon SNS para invocar uma função chamada `my-function`. ``` aws lambda add-permission \ --function-name my-function \ --action lambda:InvokeFunction \ --statement-id sns \ --principal sns.amazonaws.com ``` Resultado: ``` { "Statement": { "Sid":"sns", "Effect":"Allow", "Principal":{ "Service":"sns.amazonaws.com" }, "Action":"lambda:InvokeFunction", "Resource":"arn:aws:lambda:us-east-2:123456789012:function:my-function" } } ``` Para obter mais informações, consulte [Como usar políticas baseadas em recursos para o AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html) no *Guia do desenvolvedor do AWS Lambda*. + Para ver detalhes da API, consulte [AddPermission](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/add-permission.html) na *Referência de comandos da AWS CLI*. ### `create-alias` O código de exemplo a seguir mostra como usar `create-alias`. **AWS CLI** **Para criar um alias para uma função do Lambda** O seguinte exemplo de `create-alias` cria um alias chamado `LIVE` que aponta para a versão 1 da função `my-function` do Lambda. ``` aws lambda create-alias \ --function-name my-function \ --description "alias for live version of function" \ --function-version 1 \ --name LIVE ``` Resultado: ``` { "FunctionVersion": "1", "Name": "LIVE", "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:LIVE", "RevisionId": "873282ed-4cd3-4dc8-a069-d0c647e470c6", "Description": "alias for live version of function" } ``` Para obter mais informações, consulte [Configurar aliases da função do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html) no *Guia do desenvolvedor do AWS Lambda*. + Consulte detalhes da API em [CreateAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/create-alias.html) na *Referência de comandos da AWS CLI*. ### `create-event-source-mapping` O código de exemplo a seguir mostra como usar `create-event-source-mapping`. **AWS CLI** **Para criar um mapeamento entre a fonte de um evento e uma função do AWS Lambda** O exemplo `create-event-source-mapping` a seguir cria um mapeamento entre uma fila SQS e a função do Lambda `my-function`. ``` aws lambda create-event-source-mapping \ --function-name my-function \ --batch-size 5 \ --event-source-arn arn:aws:sqs:us-west-2:123456789012:mySQSqueue ``` Resultado: ``` { "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "StateTransitionReason": "USER_INITIATED", "LastModified": 1569284520.333, "BatchSize": 5, "State": "Creating", "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:mySQSqueue" } ``` Para obter mais informações, consulte [Mapeamento da origem do evento do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html) no *Guia do desenvolvedor do AWS Lambda*. + Para ver detalhes da API, consulte [CreateEventSourceMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/create-event-source-mapping.html) na *Referência de comandos da AWS CLI*. ### `create-function` O código de exemplo a seguir mostra como usar `create-function`. **AWS CLI** **Criar uma função do Lambda** O exemplo `create-function` a seguir cria uma função do Lambda denominada `my-function`. ``` aws lambda create-function \ --function-name my-function \ --runtime nodejs22.x \ --zip-file fileb://my-function.zip \ --handler my-function.handler \ --role arn:aws:iam::123456789012:role/service-role/MyTestFunction-role-tges6bf4 ``` Conteúdo de `my-function.zip`: ``` This file is a deployment package that contains your function code and any dependencies. ``` Resultado: ``` { "TracingConfig": { "Mode": "PassThrough" }, "CodeSha256": "PFn4S+er27qk+UuZSTKEQfNKG/XNn7QJs90mJgq6oH8=", "FunctionName": "my-function", "CodeSize": 308, "RevisionId": "873282ed-4cd3-4dc8-a069-d0c647e470c6", "MemorySize": 128, "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", "Version": "$LATEST", "Role": "arn:aws:iam::123456789012:role/service-role/MyTestFunction-role-zgur6bf4", "Timeout": 3, "LastModified": "2025-10-14T22:26:11.234+0000", "Handler": "my-function.handler", "Runtime": "nodejs22.x", "Description": "" } ``` Para obter mais informações, consulte [Configurar memória para uma função do Lambda](https://docs.aws.amazon.com/lambda/latest/dg/configuration-memory.html) no *Guia do desenvolvedor do AWS Lambda*. + Consulte detalhes da API em [CreateFunction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/create-function.html) em *AWS CLI Command Reference*. ### `delete-alias` O código de exemplo a seguir mostra como usar `delete-alias`. **AWS CLI** **Para excluir um alias de uma função do Lambda** O seguinte exemplo de `delete-alias` exclui o alias chamado `LIVE` da função `my-function` do Lambda. ``` aws lambda delete-alias \ --function-name my-function \ --name LIVE ``` Este comando não produz saída. Para obter mais informações, consulte [Configurar aliases da função do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html) no *Guia do desenvolvedor do AWS Lambda*. + Consulte detalhes da API em [DeleteAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/delete-alias.html) na *Referência de comandos da AWS CLI*. ### `delete-event-source-mapping` O código de exemplo a seguir mostra como usar `delete-event-source-mapping`. **AWS CLI** **Para excluir um mapeamento entre a fonte de um evento e uma função do AWS Lambda** O exemplo `delete-event-source-mapping` a seguir exclui um mapeamento entre uma fila SQS e a função do Lambda `my-function`. ``` aws lambda delete-event-source-mapping \ --uuid a1b2c3d4-5678-90ab-cdef-11111EXAMPLE ``` Resultado: ``` { "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "StateTransitionReason": "USER_INITIATED", "LastModified": 1569285870.271, "BatchSize": 5, "State": "Deleting", "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:mySQSqueue" } ``` Para obter mais informações, consulte [Mapeamento da origem do evento do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html) no *Guia do desenvolvedor do AWS Lambda*. + Para ver detalhes da API, consulte [DeleteEventSourceMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/delete-event-source-mapping.html) na *Referência de comandos da AWS CLI*. ### `delete-function-concurrency` O código de exemplo a seguir mostra como usar `delete-function-concurrency`. **AWS CLI** **Para remover o limite reservado de execução simultânea de uma função** O seguinte exemplo de `delete-function-concurrency` exclui o limite reservado de execução simultânea da função `my-function`. ``` aws lambda delete-function-concurrency \ --function-name my-function ``` Este comando não produz saída. Para obter mais informações, consulte [Como reservar simultaneidade para uma função do Lambda](https://docs.aws.amazon.com/lambda/latest/dg/per-function-concurrency.html) no *Guia do desenvolvedor do AWS Lambda*. + Consulte detalhes da API em [DeleteFunctionConcurrency](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/delete-function-concurrency.html) na *Referência de comandos da AWS CLI*. ### `delete-function-event-invoke-config` O código de exemplo a seguir mostra como usar `delete-function-event-invoke-config`. **AWS CLI** **Para excluir uma configuração de invocação assíncrona** O exemplo `delete-function-event-invoke-config` a seguir exclui a configuração de invocação assíncrona provisionada para o alias `GREEN` da função especificada. ``` aws lambda delete-function-event-invoke-config --function-name my-function:GREEN ``` + Para ver detalhes da API, consulte [DeleteFunctionEventInvokeConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/delete-function-event-invoke-config.html) na *Referência de comandos da AWS CLI*. ### `delete-function` O código de exemplo a seguir mostra como usar `delete-function`. **AWS CLI** **Exemplo 1: excluir uma função do Lambda pelo nome da função** O exemplo de `delete-function` a seguir exclui a função do Lambda denominada `my-function` ao especificar o nome da função. ``` aws lambda delete-function \ --function-name my-function ``` Este comando não produz saída. **Exemplo 2: excluir uma função do Lambda pelo ARN da função** O exemplo `delete-function` a seguir exclui a função do Lambda denominada `my-function` ao especificar o ARN da função. ``` aws lambda delete-function \ --function-name arn:aws:lambda:us-west-2:123456789012:function:my-function ``` Este comando não produz saída. **Exemplo 3: excluir uma função do Lambda pelo ARN parcial da função** O exemplo `delete-function` a seguir exclui a função do Lambda denominada `my-function` ao especificar o ARN parcial da função. ``` aws lambda delete-function \ --function-name 123456789012:function:my-function ``` Este comando não produz saída. Para obter mais informações, consulte [Configurar opções da função do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/resource-model.html) no *Guia do desenvolvedor do AWS Lambda*. + Consulte detalhes da API em [DeleteFunction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/delete-function.html) em *Referência de comandos da AWS CLI*. ### `delete-layer-version` O código de exemplo a seguir mostra como usar `delete-layer-version`. **AWS CLI** **Para excluir uma versão de uma camada do Lambda** O exemplo `delete-layer-version` a seguir exclui a versão 2 da camada chamada `my-layer`. ``` aws lambda delete-layer-version \ --layer-name my-layer \ --version-number 2 ``` Este comando não produz saída. Para obter mais informações, consulte [Camadas do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) no *Guia do desenvolvedor do AWS Lambda*. + Para ver detalhes da API, consulte [DeleteLayerVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/delete-layer-version.html) na *Referência de comandos da AWS CLI*. ### `delete-provisioned-concurrency-config` O código de exemplo a seguir mostra como usar `delete-provisioned-concurrency-config`. **AWS CLI** **Para excluir uma configuração de simultaneidade provisionada** O seguinte exemplo de `delete-provisioned-concurrency-config` exclui a configuração de simultaneidade provisionada para o alias `GREEN` da função especificada. ``` aws lambda delete-provisioned-concurrency-config \ --function-name my-function \ --qualifier GREEN ``` + Consulte detalhes da API em [DeleteProvisionedConcurrencyConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/delete-provisioned-concurrency-config.html) na *Referência de comandos da AWS CLI*. ### `get-account-settings` O código de exemplo a seguir mostra como usar `get-account-settings`. **AWS CLI** **Para recuperar detalhes sobre sua conta em uma região da AWS** O seguinte exemplo de `get-account-settings` mostra os limites do Lambda e as informações de uso da sua conta. ``` aws lambda get-account-settings ``` Resultado: ``` { "AccountLimit": { "CodeSizeUnzipped": 262144000, "UnreservedConcurrentExecutions": 1000, "ConcurrentExecutions": 1000, "CodeSizeZipped": 52428800, "TotalCodeSize": 80530636800 }, "AccountUsage": { "FunctionCount": 4, "TotalCodeSize": 9426 } } ``` Para obter mais informações, consulte [Limites do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/limits.html) no *Guia do desenvolvedor do AWS Lambda*. + Consulte detalhes da API em [GetAccountSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/get-account-settings.html) na *Referência de comandos da AWS CLI*. ### `get-alias` O código de exemplo a seguir mostra como usar `get-alias`. **AWS CLI** **Para recuperar detalhes sobre um alias de função** O seguinte exemplo de `get-alias` mostra os detalhes do alias chamado `LIVE` na função `my-function` do Lambda. ``` aws lambda get-alias \ --function-name my-function \ --name LIVE ``` Resultado: ``` { "FunctionVersion": "3", "Name": "LIVE", "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:LIVE", "RevisionId": "594f41fb-b85f-4c20-95c7-6ca5f2a92c93", "Description": "alias for live version of function" } ``` Para obter mais informações, consulte [Configurar aliases da função do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html) no *Guia do desenvolvedor do AWS Lambda*. + Consulte detalhes da API em [GetAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/get-alias.html) na *Referência de comandos da AWS CLI*. ### `get-event-source-mapping` O código de exemplo a seguir mostra como usar `get-event-source-mapping`. **AWS CLI** **Para recuperar detalhes sobre um mapeamento da origem do evento** O exemplo `get-event-source-mapping` a seguir exibe os detalhes do mapeamento entre uma fila SQS e a função do Lambda `my-function`. ``` aws lambda get-event-source-mapping \ --uuid "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" ``` Resultado: ``` { "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "StateTransitionReason": "USER_INITIATED", "LastModified": 1569284520.333, "BatchSize": 5, "State": "Enabled", "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:mySQSqueue" } ``` Para obter mais informações, consulte [Mapeamento da origem do evento do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html) no *Guia do desenvolvedor do AWS Lambda*. + Para ver detalhes da API, consulte [GetEventSourceMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/get-event-source-mapping.html) na *Referência de comandos da AWS CLI*. ### `get-function-concurrency` O código de exemplo a seguir mostra como usar `get-function-concurrency`. **AWS CLI** **Para visualizar a configuração de simultaneidade reservada para uma função** O seguinte exemplo de `get-function-concurrency` recupera a configuração de simultaneidade reservada para a função especificada. ``` aws lambda get-function-concurrency \ --function-name my-function ``` Resultado: ``` { "ReservedConcurrentExecutions": 250 } ``` + Consulte detalhes da API em [GetFunctionConcurrency](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/get-function-concurrency.html) na *Referência de comandos da AWS CLI*. ### `get-function-configuration` O código de exemplo a seguir mostra como usar `get-function-configuration`. **AWS CLI** **Para recuperar as configurações específicas da versão de uma função do Lambda** O seguinte exemplo de `get-function-configuration` mostra as configurações da versão 2 da função `my-function`. ``` aws lambda get-function-configuration \ --function-name my-function:2 ``` Resultado: ``` { "FunctionName": "my-function", "LastModified": "2019-09-26T20:28:40.438+0000", "RevisionId": "e52502d4-9320-4688-9cd6-152a6ab7490d", "MemorySize": 256, "Version": "2", "Role": "arn:aws:iam::123456789012:role/service-role/my-function-role-uy3l9qyq", "Timeout": 3, "Runtime": "nodejs10.x", "TracingConfig": { "Mode": "PassThrough" }, "CodeSha256": "5tT2qgzYUHaqwR716pZ2dpkn/0J1FrzJmlKidWoaCgk=", "Description": "", "VpcConfig": { "SubnetIds": [], "VpcId": "", "SecurityGroupIds": [] }, "CodeSize": 304, "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:2", "Handler": "index.handler" } ``` Para obter mais informações, consulte [Configurar opções da função do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/resource-model.html) no *Guia do desenvolvedor do AWS Lambda*. + Consulte detalhes da API em [GetFunctionConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/get-function-configuration.html) na *Referência de comandos da AWS CLI*. ### `get-function-event-invoke-config` O código de exemplo a seguir mostra como usar `get-function-event-invoke-config`. **AWS CLI** **Como visualizar uma configuração de invocação assíncrona** O exemplo `get-function-event-invoke-config` a seguir recupera a configuração de invocação assíncrona provisionada para o alias `BLUE` da função especificada. ``` aws lambda get-function-event-invoke-config \ --function-name my-function:BLUE ``` Resultado: ``` { "LastModified": 1577824396.653, "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE", "MaximumRetryAttempts": 0, "MaximumEventAgeInSeconds": 3600, "DestinationConfig": { "OnSuccess": {}, "OnFailure": { "Destination": "arn:aws:sqs:us-east-2:123456789012:failed-invocations" } } } ``` + Para ver detalhes da API, consulte [GetFunctionEventInvokeConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/get-function-event-invoke-config.html) na *Referência de comandos da AWS CLI*. ### `get-function` O código de exemplo a seguir mostra como usar `get-function`. **AWS CLI** **Recuperar informações sobre uma função** O exemplo `get-function` a seguir mostra informações sobre a função `my-function`. ``` aws lambda get-function \ --function-name my-function ``` Resultado: ``` { "Concurrency": { "ReservedConcurrentExecutions": 100 }, "Code": { "RepositoryType": "S3", "Location": "https://awslambda-us-west-2-tasks.s3.us-west-2.amazonaws.com/snapshots/123456789012/my-function..." }, "Configuration": { "TracingConfig": { "Mode": "PassThrough" }, "Version": "$LATEST", "CodeSha256": "5tT2qgzYUHoqwR616pZ2dpkn/0J1FrzJmlKidWaaCgk=", "FunctionName": "my-function", "VpcConfig": { "SubnetIds": [], "VpcId": "", "SecurityGroupIds": [] }, "MemorySize": 128, "RevisionId": "28f0fb31-5c5c-43d3-8955-03e76c5c1075", "CodeSize": 304, "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", "Handler": "index.handler", "Role": "arn:aws:iam::123456789012:role/service-role/helloWorldPython-role-uy3l9qyq", "Timeout": 3, "LastModified": "2025-09-24T18:20:35.054+0000", "Runtime": "nodejs22.x", "Description": "" } } ``` Para obter mais informações, consulte [Configurar memória para uma função do Lambda](https://docs.aws.amazon.com/lambda/latest/dg/configuration-memory.html) no *Guia do desenvolvedor do AWS Lambda*. + Consulte detalhes da API em [GetFunction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/get-function.html) na *Referência de comandos da AWS CLI*. ### `get-layer-version-by-arn` O código de exemplo a seguir mostra como usar `get-layer-version-by-arn`. **AWS CLI** **Para recuperar informações sobre uma versão de camada do Lambda** O exemplo `get-layer-version-by-arn` a seguir exibe informações sobre a versão da camada com o nome do recurso da Amazon (ARN) especificado. ``` aws lambda get-layer-version-by-arn \ --arn "arn:aws:lambda:us-west-2:123456789012:layer:AWSLambda-Python311-SciPy1x:2" ``` Resultado: ``` { "LayerVersionArn": "arn:aws:lambda:us-west-2:123456789012:layer:AWSLambda-Python311-SciPy1x:2", "Description": "AWS Lambda SciPy layer for Python 3.11 (scipy-1.1.0, numpy-1.15.4) https://github.com/scipy/scipy/releases/tag/v1.1.0 https://github.com/numpy/numpy/releases/tag/v1.15.4", "CreatedDate": "2023-10-12T10:09:38.398+0000", "LayerArn": "arn:aws:lambda:us-west-2:123456789012:layer:AWSLambda-Python311-SciPy1x", "Content": { "CodeSize": 41784542, "CodeSha256": "GGmv8ocUw4cly0T8HL0Vx/f5V4RmSCGNjDIslY4VskM=", "Location": "https://awslambda-us-west-2-layers.s3.us-west-2.amazonaws.com/snapshots/123456789012/..." }, "Version": 2, "CompatibleRuntimes": [ "python3.11" ], "LicenseInfo": "SciPy: https://github.com/scipy/scipy/blob/main/LICENSE.txt, NumPy: https://github.com/numpy/numpy/blob/main/LICENSE.txt" } ``` Para obter mais informações, consulte [Camadas do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) no *Guia do desenvolvedor do AWS Lambda*. + Para ver detalhes da API, consulte [GetLayerVersionByArn](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/get-layer-version-by-arn.html) na *Referência de comandos da AWS CLI*. ### `get-layer-version-policy` O código de exemplo a seguir mostra como usar `get-layer-version-policy`. **AWS CLI** **Para recuperar a política de permissões para uma versão de camada do Lambda** O exemplo `get-layer-version-policy` a seguir exibe informações de política sobre a versão 1 da camada chamada `my-layer`. ``` aws lambda get-layer-version-policy \ --layer-name my-layer \ --version-number 1 ``` Resultado: ``` { "Policy": { "Version":"2012-10-17", "Id":"default", "Statement": [ { "Sid":"xaccount", "Effect":"Allow", "Principal": {"AWS":"arn:aws:iam::123456789012:root"}, "Action":"lambda:GetLayerVersion", "Resource":"arn:aws:lambda:us-west-2:123456789012:layer:my-layer:1" } ] }, "RevisionId": "c68f21d2-cbf0-4026-90f6-1375ee465cd0" } ``` Para obter mais informações, consulte [Camadas do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) no *Guia do desenvolvedor do AWS Lambda*. + Para ver detalhes da API, consulte [GetLayerVersionPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/get-layer-version-policy.html) na *Referência de comandos da AWS CLI*. ### `get-layer-version` O código de exemplo a seguir mostra como usar `get-layer-version`. **AWS CLI** **Para recuperar informações sobre uma versão de camada do Lambda** O exemplo `get-layer-version` a seguir exibe informações sobre a versão 1 da camada chamada `my-layer`. ``` aws lambda get-layer-version \ --layer-name my-layer \ --version-number 1 ``` Resultado: ``` { "Content": { "Location": "https://awslambda-us-east-2-layers.s3.us-east-2.amazonaws.com/snapshots/123456789012/my-layer-4aaa2fbb-ff77-4b0a-ad92-5b78a716a96a?versionId=27iWyA73cCAYqyH...", "CodeSha256": "tv9jJO+rPbXUUXuRKi7CwHzKtLDkDRJLB3cC3Z/ouXo=", "CodeSize": 169 }, "LayerArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer", "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer:1", "Description": "My Python layer", "CreatedDate": "2018-11-14T23:03:52.894+0000", "Version": 1, "LicenseInfo": "MIT", "CompatibleRuntimes": [ "python3.10", "python3.11" ] } ``` Para obter mais informações, consulte [Camadas do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) no *Guia do desenvolvedor do AWS Lambda*. + Para ver detalhes da API, consulte [GetLayerVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/get-layer-version.html) na *Referência de comandos da AWS CLI*. ### `get-policy` O código de exemplo a seguir mostra como usar `get-policy`. **AWS CLI** **Para recuperar a política do IAM baseada em recursos para uma função, versão ou alias** O seguinte exemplo de `get-policy` mostra informações de política sobre a função `my-function` do Lambda. ``` aws lambda get-policy \ --function-name my-function ``` Resultado: ``` { "Policy": { "Version":"2012-10-17", "Id":"default", "Statement": [ { "Sid":"iot-events", "Effect":"Allow", "Principal": {"Service":"iotevents.amazonaws.com"}, "Action":"lambda:InvokeFunction", "Resource":"arn:aws:lambda:us-west-2:123456789012:function:my-function" } ] }, "RevisionId": "93017fc9-59cb-41dc-901b-4845ce4bf668" } ``` Para obter mais informações, consulte [Como usar políticas baseadas em recursos para o AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html) no *Guia do desenvolvedor do AWS Lambda*. + Consulte detalhes da API em [GetPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/get-policy.html) na *Referência de comandos da AWS CLI*. ### `get-provisioned-concurrency-config` O código de exemplo a seguir mostra como usar `get-provisioned-concurrency-config`. **AWS CLI** **Para visualizar uma configuração de simultaneidade provisionada** O seguinte exemplo de `get-provisioned-concurrency-config` mostra detalhes da configuração de simultaneidade provisionada para o alias `BLUE` da função especificada. ``` aws lambda get-provisioned-concurrency-config \ --function-name my-function \ --qualifier BLUE ``` Resultado: ``` { "RequestedProvisionedConcurrentExecutions": 100, "AvailableProvisionedConcurrentExecutions": 100, "AllocatedProvisionedConcurrentExecutions": 100, "Status": "READY", "LastModified": "2019-12-31T20:28:49+0000" } ``` + Consulte detalhes da API em [GetProvisionedConcurrencyConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/get-provisioned-concurrency-config.html) na *Referência de comandos da AWS CLI*. ### `invoke` O código de exemplo a seguir mostra como usar `invoke`. **AWS CLI** **Exemplo 1: invocar uma função do Lambda de forma síncrona** O exemplo de `invoke` a seguir invoca a função `my-function` de forma síncrona. A opção `cli-binary-format` será necessária se você estiver usando a AWS CLI versão 2. Para obter mais informações, consulte [Opções de linha de comando globais compatíveis da AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html#cli-configure-options-list) no *Guia do usuário da AWS Command Line Interface*. ``` aws lambda invoke \ --function-name my-function \ --cli-binary-format raw-in-base64-out \ --payload '{ "name": "Bob" }' \ response.json ``` Resultado: ``` { "ExecutedVersion": "$LATEST", "StatusCode": 200 } ``` Consulte mais informações em [Invocar uma função do Lambda de modo síncrono](https://docs.aws.amazon.com/lambda/latest/dg/invocation-sync.html) no *Guia do desenvolvedor do AWS Lambda*. **Exemplo 2: invocar uma função do Lambda de forma assíncrona** O exemplo `invoke` a seguir invoca a função `my-function` de forma assíncrona. A opção `cli-binary-format` será necessária se você estiver usando a AWS CLI versão 2. Para obter mais informações, consulte [Opções de linha de comando globais compatíveis da AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html#cli-configure-options-list) no *Guia do usuário da AWS Command Line Interface*. ``` aws lambda invoke \ --function-name my-function \ --invocation-type Event \ --cli-binary-format raw-in-base64-out \ --payload '{ "name": "Bob" }' \ response.json ``` Resultado: ``` { "StatusCode": 202 } ``` Consulte mais informações em [Invocar uma função do Lambda de modo assíncrono](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html) no *Guia do desenvolvedor do AWS Lambda*. + Consulte detalhes da API em [Invocar](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/invoke.html) na *Referência de comandos da AWS CLI*. ### `list-aliases` O código de exemplo a seguir mostra como usar `list-aliases`. **AWS CLI** **Para recuperar a lista de aliases para uma função do Lambda** O seguinte exemplo de `list-aliases` mostra a lista de aliases da função do Lambda `my-function`. ``` aws lambda list-aliases \ --function-name my-function ``` Resultado: ``` { "Aliases": [ { "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:BETA", "RevisionId": "a410117f-ab16-494e-8035-7e204bb7933b", "FunctionVersion": "2", "Name": "BETA", "Description": "alias for beta version of function" }, { "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:LIVE", "RevisionId": "21d40116-f8b1-40ba-9360-3ea284da1bb5", "FunctionVersion": "1", "Name": "LIVE", "Description": "alias for live version of function" } ] } ``` Para obter mais informações, consulte [Configurar aliases da função do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html) no *Guia do desenvolvedor do AWS Lambda*. + Consulte detalhes da API em [ListAliases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/list-aliases.html) na *Referência de comandos da AWS CLI*. ### `list-event-source-mappings` O código de exemplo a seguir mostra como usar `list-event-source-mappings`. **AWS CLI** **Para listar os mapeamentos da origem de eventos para uma função** O seguinte exemplo de `list-event-source-mappings` mostra a lista de mapeamentos da origem de eventos para a função do Lambda `my-function`. ``` aws lambda list-event-source-mappings \ --function-name my-function ``` Resultado: ``` { "EventSourceMappings": [ { "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "StateTransitionReason": "USER_INITIATED", "LastModified": 1569284520.333, "BatchSize": 5, "State": "Enabled", "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:mySQSqueue" } ] } ``` Para obter mais informações, consulte [Mapeamento da origem do evento do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html) no *Guia do desenvolvedor do AWS Lambda*. + Para ver detalhes da API, consulte [ListEventSourceMappings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/list-event-source-mappings.html) na *Referência de comandos da AWS CLI*. ### `list-function-event-invoke-configs` O código de exemplo a seguir mostra como usar `list-function-event-invoke-configs`. **AWS CLI** **Como visualizar uma lista de configurações de invocação assíncrona** O exemplo `list-function-event-invoke-configs` a seguir lista as configurações de invocação assíncrona provisionadas para a função especificada. ``` aws lambda list-function-event-invoke-configs \ --function-name my-function ``` Resultado: ``` { "FunctionEventInvokeConfigs": [ { "LastModified": 1577824406.719, "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:GREEN", "MaximumRetryAttempts": 2, "MaximumEventAgeInSeconds": 1800 }, { "LastModified": 1577824396.653, "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE", "MaximumRetryAttempts": 0, "MaximumEventAgeInSeconds": 3600 } ] } ``` + Para ver detalhes da API, consulte [ListFunctionEventInvokeConfigs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/list-function-event-invoke-configs.html) na *Referência de comandos da AWS CLI*. ### `list-functions` O código de exemplo a seguir mostra como usar `list-functions`. **AWS CLI** **Recuperar uma lista de funções do Lambda** O exemplo de `list-functions` a seguir exibe uma lista de todas as funções do usuário atual. ``` aws lambda list-functions ``` Resultado: ``` { "Functions": [ { "TracingConfig": { "Mode": "PassThrough" }, "Version": "$LATEST", "CodeSha256": "dBG9m8SGdmlEjw/JYXlhhvCrAv5TxvXsbL/RMr0fT/I=", "FunctionName": "helloworld", "MemorySize": 128, "RevisionId": "1718e831-badf-4253-9518-d0644210af7b", "CodeSize": 294, "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:helloworld", "Handler": "helloworld.handler", "Role": "arn:aws:iam::123456789012:role/service-role/MyTestFunction-role-zgur6bf4", "Timeout": 3, "LastModified": "2025-09-23T18:32:33.857+0000", "Runtime": "nodejs22.x", "Description": "" }, { "TracingConfig": { "Mode": "PassThrough" }, "Version": "$LATEST", "CodeSha256": "sU0cJ2/hOZevwV/lTxCuQqK3gDZP3i8gUoqUUVRmY6E=", "FunctionName": "my-function", "VpcConfig": { "SubnetIds": [], "VpcId": "", "SecurityGroupIds": [] }, "MemorySize": 256, "RevisionId": "93017fc9-59cb-41dc-901b-4845ce4bf668", "CodeSize": 266, "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", "Handler": "index.handler", "Role": "arn:aws:iam::123456789012:role/service-role/helloWorldPython-role-uy3l9qyq", "Timeout": 3, "LastModified": "2025-10-01T16:47:28.490+0000", "Runtime": "nodejs22.x", "Description": "" }, { "Layers": [ { "CodeSize": 41784542, "Arn": "arn:aws:lambda:us-west-2:420165488524:layer:AWSLambda-Python37-SciPy1x:2" }, { "CodeSize": 4121, "Arn": "arn:aws:lambda:us-west-2:123456789012:layer:pythonLayer:1" } ], "TracingConfig": { "Mode": "PassThrough" }, "Version": "$LATEST", "CodeSha256": "ZQukCqxtkqFgyF2cU41Avj99TKQ/hNihPtDtRcc08mI=", "FunctionName": "my-python-function", "VpcConfig": { "SubnetIds": [], "VpcId": "", "SecurityGroupIds": [] }, "MemorySize": 128, "RevisionId": "80b4eabc-acf7-4ea8-919a-e874c213707d", "CodeSize": 299, "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-python-function", "Handler": "lambda_function.lambda_handler", "Role": "arn:aws:iam::123456789012:role/service-role/my-python-function-role-z5g7dr6n", "Timeout": 3, "LastModified": "2025-10-01T19:40:41.643+0000", "Runtime": "python3.11", "Description": "" } ] } ``` Para obter mais informações, consulte [Configurar memória para uma função do Lambda](https://docs.aws.amazon.com/lambda/latest/dg/configuration-memory.html) no *Guia do desenvolvedor do AWS Lambda*. + Consulte detalhes da API em [ListFunctions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/list-functions.html) na *Referência de comandos da AWS CLI*. ### `list-layer-versions` O código de exemplo a seguir mostra como usar `list-layer-versions`. **AWS CLI** **Para listar as versões de uma camada do AWS Lambda** O exemplo `list-layers-versions` a seguir exibe informações de política sobre as versões da camada chamada `my-layer`. ``` aws lambda list-layer-versions \ --layer-name my-layer ``` Resultado: ``` { "Layers": [ { "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer:2", "Version": 2, "Description": "My layer", "CreatedDate": "2023-11-15T00:37:46.592+0000", "CompatibleRuntimes": [ "python3.10", "python3.11" ] } ] } ``` Para obter mais informações, consulte [Camadas do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) no *Guia do desenvolvedor do AWS Lambda*. + Para ver detalhes da API, consulte [ListLayerVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/list-layer-versions.html) na *Referência de comandos da AWS CLI*. ### `list-layers` O código de exemplo a seguir mostra como usar `list-layers`. **AWS CLI** **Para listaras camadas compatíveis com o runtime de uma função.** O exemplo `list-layers` a seguir exibe informações sobre as camadas compatíveis com o runtime do Python 3.11. ``` aws lambda list-layers \ --compatible-runtime python3.11 ``` Resultado: ``` { "Layers": [ { "LayerName": "my-layer", "LayerArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer", "LatestMatchingVersion": { "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer:2", "Version": 2, "Description": "My layer", "CreatedDate": "2023-11-15T00:37:46.592+0000", "CompatibleRuntimes": [ "python3.10", "python3.11" ] } } ] } ``` Para obter mais informações, consulte [Camadas do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) no *Guia do desenvolvedor do AWS Lambda*. + Para ver detalhes da API, consulte [ListLayers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/list-layers.html) na *Referência de comandos da AWS CLI*. ### `list-provisioned-concurrency-configs` O código de exemplo a seguir mostra como usar `list-provisioned-concurrency-configs`. **AWS CLI** **Para obter uma lista de configurações de simultaneidade provisionada** O seguinte exemplo de `list-provisioned-concurrency-configs` lista as configurações de simultaneidade provisionada para a função especificada. ``` aws lambda list-provisioned-concurrency-configs \ --function-name my-function ``` Resultado: ``` { "ProvisionedConcurrencyConfigs": [ { "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:GREEN", "RequestedProvisionedConcurrentExecutions": 100, "AvailableProvisionedConcurrentExecutions": 100, "AllocatedProvisionedConcurrentExecutions": 100, "Status": "READY", "LastModified": "2019-12-31T20:29:00+0000" }, { "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE", "RequestedProvisionedConcurrentExecutions": 100, "AvailableProvisionedConcurrentExecutions": 100, "AllocatedProvisionedConcurrentExecutions": 100, "Status": "READY", "LastModified": "2019-12-31T20:28:49+0000" } ] } ``` + Consulte detalhes da API em [ListProvisionedConcurrencyConfigs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/list-provisioned-concurrency-configs.html) na *Referência de comandos da AWS CLI*. ### `list-tags` O código de exemplo a seguir mostra como usar `list-tags`. **AWS CLI** **Para recuperar a lista de tags para uma função do Lambda** O seguinte exemplo de `list-tags` mostra as tags anexadas à função `my-function` do Lambda. ``` aws lambda list-tags \ --resource arn:aws:lambda:us-west-2:123456789012:function:my-function ``` Resultado: ``` { "Tags": { "Category": "Web Tools", "Department": "Sales" } } ``` Para obter mais informações, consulte [Como marcar funções do Lambda](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) no *Guia do desenvolvedor do AWS Lambda*. + Consulte detalhes da API em [ListTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/list-tags.html) na *Referência de comandos da AWS CLI*. ### `list-versions-by-function` O código de exemplo a seguir mostra como usar `list-versions-by-function`. **AWS CLI** **Para recuperar uma lista de versões de uma função** O seguinte exemplo de `list-versions-by-function` mostra a lista de versões da função `my-function` do Lambda. ``` aws lambda list-versions-by-function \ --function-name my-function ``` Resultado: ``` { "Versions": [ { "TracingConfig": { "Mode": "PassThrough" }, "Version": "$LATEST", "CodeSha256": "sU0cJ2/hOZevwV/lTxCuQqK3gDZP3i8gUoqUUVRmY6E=", "FunctionName": "my-function", "VpcConfig": { "SubnetIds": [], "VpcId": "", "SecurityGroupIds": [] }, "MemorySize": 256, "RevisionId": "93017fc9-59cb-41dc-901b-4845ce4bf668", "CodeSize": 266, "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:$LATEST", "Handler": "index.handler", "Role": "arn:aws:iam::123456789012:role/service-role/helloWorldPython-role-uy3l9qyq", "Timeout": 3, "LastModified": "2019-10-01T16:47:28.490+0000", "Runtime": "nodejs10.x", "Description": "" }, { "TracingConfig": { "Mode": "PassThrough" }, "Version": "1", "CodeSha256": "5tT2qgzYUHoqwR616pZ2dpkn/0J1FrzJmlKidWaaCgk=", "FunctionName": "my-function", "VpcConfig": { "SubnetIds": [], "VpcId": "", "SecurityGroupIds": [] }, "MemorySize": 256, "RevisionId": "949c8914-012e-4795-998c-e467121951b1", "CodeSize": 304, "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:1", "Handler": "index.handler", "Role": "arn:aws:iam::123456789012:role/service-role/helloWorldPython-role-uy3l9qyq", "Timeout": 3, "LastModified": "2019-09-26T20:28:40.438+0000", "Runtime": "nodejs10.x", "Description": "new version" }, { "TracingConfig": { "Mode": "PassThrough" }, "Version": "2", "CodeSha256": "sU0cJ2/hOZevwV/lTxCuQqK3gDZP3i8gUoqUUVRmY6E=", "FunctionName": "my-function", "VpcConfig": { "SubnetIds": [], "VpcId": "", "SecurityGroupIds": [] }, "MemorySize": 256, "RevisionId": "cd669f21-0f3d-4e1c-9566-948837f2e2ea", "CodeSize": 266, "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:2", "Handler": "index.handler", "Role": "arn:aws:iam::123456789012:role/service-role/helloWorldPython-role-uy3l9qyq", "Timeout": 3, "LastModified": "2019-10-01T16:47:28.490+0000", "Runtime": "nodejs10.x", "Description": "newer version" } ] } ``` Para obter mais informações, consulte [Configurar aliases da função do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html) no *Guia do desenvolvedor do AWS Lambda*. + Consulte detalhes da API em [ListVersionsByFunction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/list-versions-by-function.html) na *Referência de comandos da AWS CLI*. ### `publish-layer-version` O código de exemplo a seguir mostra como usar `publish-layer-version`. **AWS CLI** **Para criar uma versão da camada do Lambda** O exemplo `publish-layer-version` a seguir cria uma nova versão da camada da biblioteca Python. O comando recupera o conteúdo da camada de um arquivo chamado `layer.zip` no bucket S3 especificado. ``` aws lambda publish-layer-version \ --layer-name my-layer \ --description "My Python layer" \ --license-info "MIT" \ --content S3Bucket=lambda-layers-us-west-2-123456789012,S3Key=layer.zip \ --compatible-runtimes python3.10 python3.11 ``` Resultado: ``` { "Content": { "Location": "https://awslambda-us-west-2-layers.s3.us-west-2.amazonaws.com/snapshots/123456789012/my-layer-4aaa2fbb-ff77-4b0a-ad92-5b78a716a96a?versionId=27iWyA73cCAYqyH...", "CodeSha256": "tv9jJO+rPbXUUXuRKi7CwHzKtLDkDRJLB3cC3Z/ouXo=", "CodeSize": 169 }, "LayerArn": "arn:aws:lambda:us-west-2:123456789012:layer:my-layer", "LayerVersionArn": "arn:aws:lambda:us-west-2:123456789012:layer:my-layer:1", "Description": "My Python layer", "CreatedDate": "2023-11-14T23:03:52.894+0000", "Version": 1, "LicenseInfo": "MIT", "CompatibleRuntimes": [ "python3.10", "python3.11" ] } ``` Para obter mais informações, consulte [Camadas do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) no *Guia do desenvolvedor do AWS Lambda*. + Para ver detalhes da API, consulte [PublishLayerVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/publish-layer-version.html) na *Referência de comandos da AWS CLI*. ### `publish-version` O código de exemplo a seguir mostra como usar `publish-version`. **AWS CLI** **Para publicar uma nova versão de uma função** O seguinte exemplo de `publish-version` publica uma nova versão da função `my-function` do Lambda. ``` aws lambda publish-version \ --function-name my-function ``` Resultado: ``` { "TracingConfig": { "Mode": "PassThrough" }, "CodeSha256": "dBG9m8SGdmlEjw/JYXlhhvCrAv5TxvXsbL/RMr0fT/I=", "FunctionName": "my-function", "CodeSize": 294, "RevisionId": "f31d3d39-cc63-4520-97d4-43cd44c94c20", "MemorySize": 128, "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:3", "Version": "2", "Role": "arn:aws:iam::123456789012:role/service-role/MyTestFunction-role-zgur6bf4", "Timeout": 3, "LastModified": "2019-09-23T18:32:33.857+0000", "Handler": "my-function.handler", "Runtime": "nodejs10.x", "Description": "" } ``` Para obter mais informações, consulte [Configurar aliases da função do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html) no *Guia do desenvolvedor do AWS Lambda*. + Consulte detalhes da API em [PublishVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/publish-version.html) na *Referência de comandos da AWS CLI*. ### `put-function-concurrency` O código de exemplo a seguir mostra como usar `put-function-concurrency`. **AWS CLI** **Para configurar um limite de simultaneidade reservado para uma função** O seguinte exemplo de `put-function-concurrency` configura 100 execuções simultâneas reservadas para a função `my-function`. ``` aws lambda put-function-concurrency \ --function-name my-function \ --reserved-concurrent-executions 100 ``` Resultado: ``` { "ReservedConcurrentExecutions": 100 } ``` Para obter mais informações, consulte [Como reservar simultaneidade para uma função do Lambda](https://docs.aws.amazon.com/lambda/latest/dg/per-function-concurrency.html) no *Guia do desenvolvedor do AWS Lambda*. + Consulte detalhes da API em [PutFunctionConcurrency](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/put-function-concurrency.html) na *Referência de comandos da AWS CLI*. ### `put-function-event-invoke-config` O código de exemplo a seguir mostra como usar `put-function-event-invoke-config`. **AWS CLI** **Como configurar o tratamento de erros para invocação assíncrona** O exemplo `put-function-event-invoke-config` a seguir define a duração máxima do evento para uma hora e desativa as novas tentativas para a função especificada. ``` aws lambda put-function-event-invoke-config \ --function-name my-function \ --maximum-event-age-in-seconds 3600 \ --maximum-retry-attempts 0 ``` Resultado: ``` { "LastModified": 1573686021.479, "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:$LATEST", "MaximumRetryAttempts": 0, "MaximumEventAgeInSeconds": 3600, "DestinationConfig": { "OnSuccess": {}, "OnFailure": {} } } ``` + Para ver detalhes da API, consulte [PutFunctionEventInvokeConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/put-function-event-invoke-config.html) na *Referência de comandos da AWS CLI*. ### `put-provisioned-concurrency-config` O código de exemplo a seguir mostra como usar `put-provisioned-concurrency-config`. **AWS CLI** **Para alocar a simultaneidade provisionada** O seguinte exemplo de `put-provisioned-concurrency-config` aloca 100 simultaneidades provisionadas para o alias `BLUE` da função especificada. ``` aws lambda put-provisioned-concurrency-config \ --function-name my-function \ --qualifier BLUE \ --provisioned-concurrent-executions 100 ``` Resultado: ``` { "Requested ProvisionedConcurrentExecutions": 100, "Allocated ProvisionedConcurrentExecutions": 0, "Status": "IN_PROGRESS", "LastModified": "2019-11-21T19:32:12+0000" } ``` + Consulte detalhes da API em [PutProvisionedConcurrencyConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/put-provisioned-concurrency-config.html) na *Referência de comandos da AWS CLI*. ### `remove-layer-version-permission` O código de exemplo a seguir mostra como usar `remove-layer-version-permission`. **AWS CLI** **Para excluir permissões de versão da camada** O exemplo `remove-layer-version-permission` a seguir exclui a permissão de uma conta para configurar uma versão de camada. ``` aws lambda remove-layer-version-permission \ --layer-name my-layer \ --statement-id xaccount \ --version-number 1 ``` Este comando não produz saída. Para obter mais informações, consulte [Camadas do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) no *Guia do desenvolvedor do AWS Lambda*. + Para ver detalhes da API, consulte [RemoveLayerVersionPermission](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/remove-layer-version-permission.html) na *Referência de comandos da AWS CLI*. ### `remove-permission` O código de exemplo a seguir mostra como usar `remove-permission`. **AWS CLI** **Para remover permissões de uma função do Lambda existente** O seguinte exemplo de `remove-permission` remove permissão para invocar uma função chamada `my-function`. ``` aws lambda remove-permission \ --function-name my-function \ --statement-id sns ``` Este comando não produz saída. Para obter mais informações, consulte [Como usar políticas baseadas em recursos para o AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html) no *Guia do desenvolvedor do AWS Lambda*. + Consulte detalhes da API em [RemovePermission](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/remove-permission.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Para adicionar tags a uma função do Lambda existente** O seguinte exemplo de `tag-resource` adiciona uma tag com o nome de chave `DEPARTMENT` e um valor de `Department A` à função do Lambda especificada. ``` aws lambda tag-resource \ --resource arn:aws:lambda:us-west-2:123456789012:function:my-function \ --tags "DEPARTMENT=Department A" ``` Este comando não produz saída. Para obter mais informações, consulte [Como marcar funções do Lambda](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) no *Guia do desenvolvedor do AWS Lambda*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover tags de uma função do Lambda existente** O seguinte exemplo de `untag-resource` remove a tag com o nome de chave `DEPARTMENT` da função `my-function` do Lambda. ``` aws lambda untag-resource \ --resource arn:aws:lambda:us-west-2:123456789012:function:my-function \ --tag-keys DEPARTMENT ``` Este comando não produz saída. Para obter mais informações, consulte [Como marcar funções do Lambda](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) no *Guia do desenvolvedor do AWS Lambda*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-alias` O código de exemplo a seguir mostra como usar `update-alias`. **AWS CLI** **Para atualizar um alias de função** O seguinte exemplo de `update-alias` atualiza um alias chamado `LIVE` que aponta para a versão 3 da função `my-function` do Lambda. ``` aws lambda update-alias \ --function-name my-function \ --function-version 3 \ --name LIVE ``` Resultado: ``` { "FunctionVersion": "3", "Name": "LIVE", "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:LIVE", "RevisionId": "594f41fb-b85f-4c20-95c7-6ca5f2a92c93", "Description": "alias for live version of function" } ``` Para obter mais informações, consulte [Configurar aliases da função do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html) no *Guia do desenvolvedor do AWS Lambda*. + Consulte detalhes da API em [UpdateAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/update-alias.html) na *Referência de comandos da AWS CLI*. ### `update-event-source-mapping` O código de exemplo a seguir mostra como usar `update-event-source-mapping`. **AWS CLI** **Para atualizar um mapeamento entre a origem de um evento e uma função do AWS Lambda** O exemplo `update-event-source-mapping` a seguir atualiza o tamanho do lote para 8 no mapeamento especificado. ``` aws lambda update-event-source-mapping \ --uuid "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" \ --batch-size 8 ``` Resultado: ``` { "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "StateTransitionReason": "USER_INITIATED", "LastModified": 1569284520.333, "BatchSize": 8, "State": "Updating", "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:mySQSqueue" } ``` Para obter mais informações, consulte [Mapeamento da origem do evento do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html) no *Guia do desenvolvedor do AWS Lambda*. + Para ver detalhes da API, consulte [UpdateEventSourceMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/update-event-source-mapping.html) na *Referência de comandos da AWS CLI*. ### `update-function-code` O código de exemplo a seguir mostra como usar `update-function-code`. **AWS CLI** **Atualizar o código de uma função do Lambda** O exemplo de `update-function-code` a seguir substitui o código da versão não publicada (\$1LATEST) da função `my-function` pelo conteúdo do arquivo zip especificado. ``` aws lambda update-function-code \ --function-name my-function \ --zip-file fileb://my-function.zip ``` Resultado: ``` { "FunctionName": "my-function", "LastModified": "2019-09-26T20:28:40.438+0000", "RevisionId": "e52502d4-9320-4688-9cd6-152a6ab7490d", "MemorySize": 256, "Version": "$LATEST", "Role": "arn:aws:iam::123456789012:role/service-role/my-function-role-uy3l9qyq", "Timeout": 3, "Runtime": "nodejs10.x", "TracingConfig": { "Mode": "PassThrough" }, "CodeSha256": "5tT2qgzYUHaqwR716pZ2dpkn/0J1FrzJmlKidWoaCgk=", "Description": "", "VpcConfig": { "SubnetIds": [], "VpcId": "", "SecurityGroupIds": [] }, "CodeSize": 304, "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", "Handler": "index.handler" } ``` Para obter mais informações, consulte [Configurar opções da função do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/resource-model.html) no *Guia do desenvolvedor do AWS Lambda*. + Consulte detalhes da API em [UpdateFunctionCode](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/update-function-code.html) na *Referência de comandos da AWS CLI*. ### `update-function-configuration` O código de exemplo a seguir mostra como usar `update-function-configuration`. **AWS CLI** **Modificar a configuração de uma função** O exemplo de `update-function-configuration` a seguir modifica o tamanho da memória para 256 MB para a versão não publicada (\$1LATEST) da função `my-function`. ``` aws lambda update-function-configuration \ --function-name my-function \ --memory-size 256 ``` Resultado: ``` { "FunctionName": "my-function", "LastModified": "2019-09-26T20:28:40.438+0000", "RevisionId": "e52502d4-9320-4688-9cd6-152a6ab7490d", "MemorySize": 256, "Version": "$LATEST", "Role": "arn:aws:iam::123456789012:role/service-role/my-function-role-uy3l9qyq", "Timeout": 3, "Runtime": "nodejs10.x", "TracingConfig": { "Mode": "PassThrough" }, "CodeSha256": "5tT2qgzYUHaqwR716pZ2dpkn/0J1FrzJmlKidWoaCgk=", "Description": "", "VpcConfig": { "SubnetIds": [], "VpcId": "", "SecurityGroupIds": [] }, "CodeSize": 304, "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", "Handler": "index.handler" } ``` Para obter mais informações, consulte [Configurar opções da função do AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/resource-model.html) no *Guia do desenvolvedor do AWS Lambda*. + Consulte detalhes da API em [UpdateFunctionConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/update-function-configuration.html) na *Referência de comandos da AWS CLI*. ### `update-function-event-invoke-config` O código de exemplo a seguir mostra como usar `update-function-event-invoke-config`. **AWS CLI** **Para atualizar uma configuração de invocação assíncrona** O exemplo `update-function-event-invoke-config` a seguir adiciona um destino em caso de falha à configuração de invocação assíncrona existente para a função especificada. ``` aws lambda update-function-event-invoke-config \ --function-name my-function \ --destination-config '{"OnFailure":{"Destination": "arn:aws:sqs:us-east-2:123456789012:destination"}}' ``` Resultado: ``` { "LastModified": 1573687896.493, "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:$LATEST", "MaximumRetryAttempts": 0, "MaximumEventAgeInSeconds": 3600, "DestinationConfig": { "OnSuccess": {}, "OnFailure": { "Destination": "arn:aws:sqs:us-east-2:123456789012:destination" } } } ``` + Para ver detalhes da API, consulte [UpdateFunctionEventInvokeConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/update-function-event-invoke-config.html) na *Referência de comandos da AWS CLI*. # Exemplos do License Manager usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o License 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 ### `create-license-configuration` O código de exemplo a seguir mostra como usar `create-license-configuration`. **AWS CLI** **Exemplo 1: criar uma configuração de licença** O exemplo `create-license-configuration` a seguir cria uma configuração de licença com um limite fixo de 10 núcleos. ``` aws license-manager create-license-configuration --name my-license-configuration \ --license-counting-type Core \ --license-count 10 \ --license-count-hard-limit ``` Resultado: ``` { "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba41EXAMPLE1111" } ``` **Exemplo 2: criar uma configuração de licença** O exemplo `create-license-configuration` a seguir cria uma configuração de licença com um limite flexível de 100 vCPUs. Ele usa uma regra para ativar a otimização de vCPUs. ``` aws license-manager create-license-configuration --name my-license-configuration --license-counting-type vCPU \ --license-count 100 \ --license-rules "#honorVcpuOptimization=true" ``` Resultado: ``` { "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba41EXAMPLE2222" } ``` + Para ver detalhes da API, consulte [CreateLicenseConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/create-license-configuration.html) na *Referência de comandos da AWS CLI*. ### `delete-license-configuration` O código de exemplo a seguir mostra como usar `delete-license-configuration`. **AWS CLI** **Para excluir uma configuração de licença** O exemplo `delete-license-configuration` a seguir exclui o perfil da configuração de licença especificada. ``` aws license-manager delete-license-configuration \ --license-configuration-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE ``` Este comando não produz saída. + Para ver detalhes da API, consulte [DeleteLicenseConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/delete-license-configuration.html) na *Referência de comandos da AWS CLI*. ### `get-license-configuration` O código de exemplo a seguir mostra como usar `get-license-configuration`. **AWS CLI** **Para obter informações sobre a configuração da licença** O exemplo `get-license-configuration` a seguir exibe os detalhes da configuração de licença especificada. ``` aws license-manager get-license-configuration \ --license-configuration-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE ``` Resultado: ``` { "LicenseConfigurationId": "lic-38b658717b87478aaa7c00883EXAMPLE", "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE", "Name": "my-license-configuration", "LicenseCountingType": "vCPU", "LicenseRules": [], "LicenseCountHardLimit": false, "ConsumedLicenses": 0, "Status": "AVAILABLE", "OwnerAccountId": "123456789012", "ConsumedLicenseSummaryList": [ { "ResourceType": "EC2_INSTANCE", "ConsumedLicenses": 0 }, { "ResourceType": "EC2_HOST", "ConsumedLicenses": 0 }, { "ResourceType": "SYSTEMS_MANAGER_MANAGED_INSTANCE", "ConsumedLicenses": 0 } ], "ManagedResourceSummaryList": [ { "ResourceType": "EC2_INSTANCE", "AssociationCount": 0 }, { "ResourceType": "EC2_HOST", "AssociationCount": 0 }, { "ResourceType": "EC2_AMI", "AssociationCount": 2 }, { "ResourceType": "SYSTEMS_MANAGER_MANAGED_INSTANCE", "AssociationCount": 0 } ] } ``` + Para ver detalhes da API, consulte [GetLicenseConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/get-license-configuration.html) na *Referência de comandos da AWS CLI*. ### `get-service-settings` O código de exemplo a seguir mostra como usar `get-service-settings`. **AWS CLI** **Para obter as configurações do License Manager** O exemplo `get-service-settings` a seguir exibe as configurações de serviço do License Manager na região atual. ``` aws license-manager get-service-settings ``` Veja a seguir um exemplo de saída se a descoberta de recursos entre contas estiver desativada. ``` { "OrganizationConfiguration": { "EnableIntegration": false }, "EnableCrossAccountsDiscovery": false } ``` Veja a seguir um exemplo de saída se a descoberta de recursos entre contas estiver ativada. ``` { "S3BucketArn": "arn:aws:s3:::aws-license-manager-service-c22d6279-35c4-47c4-bb", "OrganizationConfiguration": { "EnableIntegration": true }, "EnableCrossAccountsDiscovery": true } ``` + Para ver detalhes da API, consulte [GetServiceSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/get-service-settings.html) na *Referência de comandos da AWS CLI*. ### `list-associations-for-license-configuration` O código de exemplo a seguir mostra como usar `list-associations-for-license-configuration`. **AWS CLI** **Para obter associações para uma configuração de licença** O exemplo `list-associations-for-license-configuration` a seguir exibe informações detalhadas das associações da configuração de licença especificada. ``` aws license-manager list-associations-for-license-configuration \ --license-configuration-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE ``` Resultado: ``` { "LicenseConfigurationAssociations": [ { "ResourceArn": "arn:aws:ec2:us-west-2::image/ami-1234567890abcdef0", "ResourceType": "EC2_AMI", "ResourceOwnerId": "123456789012", "AssociationTime": 1568825118.617 }, { "ResourceArn": "arn:aws:ec2:us-west-2::image/ami-0abcdef1234567890", "ResourceType": "EC2_AMI", "ResourceOwnerId": "123456789012", "AssociationTime": 1568825118.946 } ] } ``` + Para ver detalhes da API, consulte [ListAssociationsForLicenseConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/list-associations-for-license-configuration.html) na *Referência de comandos da AWS CLI*. ### `list-license-configurations` O código de exemplo a seguir mostra como usar `list-license-configurations`. **AWS CLI** **Exemplo 1: listar todas as suas configurações de licença** O exemplo `list-license-configurations` a seguir lista todas as configurações de licença. ``` aws license-manager list-license-configurations ``` Resultado: ``` { "LicenseConfigurations": [ { "LicenseConfigurationId": "lic-6eb6586f508a786a2ba4f56c1EXAMPLE", "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE", "Name": "my-license-configuration", "LicenseCountingType": "Core", "LicenseRules": [], "LicenseCount": 10, "LicenseCountHardLimit": true, "ConsumedLicenses": 0, "Status": "AVAILABLE", "OwnerAccountId": "123456789012", "ConsumedLicenseSummaryList": [ { "ResourceType": "EC2_INSTANCE", "ConsumedLicenses": 0 }, { "ResourceType": "EC2_HOST", "ConsumedLicenses": 0 }, { "ResourceType": "SYSTEMS_MANAGER_MANAGED_INSTANCE", "ConsumedLicenses": 0 } ], "ManagedResourceSummaryList": [ { "ResourceType": "EC2_INSTANCE", "AssociationCount": 0 }, { "ResourceType": "EC2_HOST", "AssociationCount": 0 }, { "ResourceType": "EC2_AMI", "AssociationCount": 0 }, { "ResourceType": "SYSTEMS_MANAGER_MANAGED_INSTANCE", "AssociationCount": 0 } ] }, { ... } ] } ``` **Exemplo 2: listar uma configuração de licença específica** O exemplo `list-license-configurations` a seguir lista apenas a configuração específica da licença. ``` aws license-manager list-license-configurations \ --license-configuration-arns arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE ``` + Para ver detalhes da API, consulte [ListLicenseConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/list-license-configurations.html) na *Referência de comandos da AWS CLI*. ### `list-license-specifications-for-resource` O código de exemplo a seguir mostra como usar `list-license-specifications-for-resource`. **AWS CLI** **Para listar as configurações de licença de um recurso** O exemplo `list-license-specifications-for-resource` a seguir lista as configurações de licença associadas à Imagem de máquina da Amazon (AMI) especificada. ``` aws license-manager list-license-specifications-for-resource \ --resource-arn arn:aws:ec2:us-west-2::image/ami-1234567890abcdef0 ``` Resultado: ``` { "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE" } ``` + Para ver detalhes da API, consulte [ListLicenseSpecificationsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/list-license-specifications-for-resource.html) na *Referência de comandos da AWS CLI*. ### `list-resource-inventory` O código de exemplo a seguir mostra como usar `list-resource-inventory`. **AWS CLI** **Para listar recursos no inventário de recursos** O exemplo `list-resource-inventory` a seguir lista os recursos gerenciados usando o inventário do Systems Manager. ``` aws license-manager list-resource-inventory ``` Resultado: ``` { "ResourceInventoryList": [ { "Platform": "Red Hat Enterprise Linux Server", "ResourceType": "EC2Instance", "PlatformVersion": "7.4", "ResourceArn": "arn:aws:ec2:us-west-2:1234567890129:instance/i-05d3cdfb05bd36376", "ResourceId": "i-05d3cdfb05bd36376", "ResourceOwningAccountId": "1234567890129" }, { "Platform": "Amazon Linux", "ResourceType": "EC2Instance", "PlatformVersion": "2", "ResourceArn": "arn:aws:ec2:us-west-2:1234567890129:instance/i-0b1d036cfd4594808", "ResourceId": "i-0b1d036cfd4594808", "ResourceOwningAccountId": "1234567890129" }, { "Platform": "Microsoft Windows Server 2019 Datacenter", "ResourceType": "EC2Instance", "PlatformVersion": "10.0.17763", "ResourceArn": "arn:aws:ec2:us-west-2:1234567890129:instance/i-0cdb3b54a2a8246ad", "ResourceId": "i-0cdb3b54a2a8246ad", "ResourceOwningAccountId": "1234567890129" } ] } ``` + Para ver detalhes da API, consulte [ListResourceInventory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/list-resource-inventory.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar as tags de uma configuração de licença** O exemplo `list-tags-for-resource` a seguir lista as tags da configuração da licença especificada. ``` aws license-manager list-tags-for-resource \ --resource-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE ``` Resultado: ``` { "Tags": [ { "Key": "project", "Value": "lima" } ] } ``` + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `list-usage-for-license-configuration` O código de exemplo a seguir mostra como usar `list-usage-for-license-configuration`. **AWS CLI** **Para listar as licenças em uso para uma configuração de licença** O exemplo `list-usage-for-license-configuration` a seguir lista informações sobre os recursos que usam licenças para a configuração de licença especificada. Por exemplo, se o tipo de licença for vCPU, todas as instâncias consomem uma licença por vCPU. ``` aws license-manager list-usage-for-license-configuration \ --license-configuration-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE ``` Resultado: ``` { "LicenseConfigurationUsageList": [ { "ResourceArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-04a636d18e83cfacb", "ResourceType": "EC2_INSTANCE", "ResourceStatus": "running", "ResourceOwnerId": "123456789012", "AssociationTime": 1570892850.519, "ConsumedLicenses": 2 } ] } ``` + Para ver detalhes da API, consulte [ListUsageForLicenseConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/list-usage-for-license-configuration.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Para adicionar uma tag a uma configuração de licença** O exemplo `tag-resource` a seguir adiciona a tag especificada (nome e valor da chave) à configuração da licença especificada. ``` aws license-manager tag-resource \ --tags Key=project,Value=lima \ --resource-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE ``` Este comando não produz saída. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover tags de uma configuração de licença** O exemplo `untag-resource` a seguir remove a tag especificada (nome e valor da chave) da configuração da licença especificada. ``` aws license-manager untag-resource \ --tag-keys project \ --resource-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE ``` Este comando não produz saída. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-license-configuration` O código de exemplo a seguir mostra como usar `update-license-configuration`. **AWS CLI** **Para atualizar uma configuração de licença** O exemplo `update-license-configuration` a seguir atualiza a configuração da licença especificada para remover o limite fixo. ``` aws license-manager update-license-configuration \ --no-license-count-hard-limit \ --license-configuration-arn arn:aws:license-manager:us-west-2:880185128111:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE ``` Este comando não produz saída. O exemplo `update-license-configuration` a seguir atualiza a configuração da licença especificada para alterar seu status para `DISABLED`. ``` aws license-manager update-license-configuration \ --license-configuration-status DISABLED --license-configuration-arn arn:aws:license-manager:us-west-2:880185128111:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE ``` Este comando não produz saída. + Para ver detalhes da API, consulte [UpdateLicenseConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/update-license-configuration.html) na *Referência de comandos da AWS CLI*. ### `update-license-specifications-for-resource` O código de exemplo a seguir mostra como usar `update-license-specifications-for-resource`. **AWS CLI** **Para atualizar as configurações de licença de um recurso** O exemplo `update-license-specifications-for-resource` a seguir substitui a configuração de licença associada à Imagem de máquina da Amazon (AMI) especificada removendo uma configuração de licença e adicionando outra. ``` aws license-manager update-license-specifications-for-resource \ --resource-arn arn:aws:ec2:us-west-2::image/ami-1234567890abcdef0 \ --remove-license-specifications LicenseConfigurationArn=arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE \ --add-license-specifications LicenseConfigurationArn=arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-42b6deb06e5399a980d555927EXAMPLE ``` Este comando não produz saída. + Para ver detalhes da API, consulte [UpdateLicenseSpecificationsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/update-license-specifications-for-resource.html) na *Referência de comandos da AWS CLI*. ### `update-service-settings` O código de exemplo a seguir mostra como usar `update-service-settings`. **AWS CLI** **Para atualizar as configurações do License Manager** O exemplo `update-service-settings` a seguir permite a descoberta de recursos entre contas para o License Manager na região da AWS atual. O bucket do Amazon S3 é a sincronização de dados de recursos necessária para o inventário do Systems Manager. ``` aws license-manager update-service-settings \ --organization-configuration EnableIntegration=true \ --enable-cross-accounts-discovery \ --s3-bucket-arn arn:aws:s3:::aws-license-manager-service-abcd1234EXAMPLE ``` Este comando não produz saída. + Para ver detalhes da API, consulte [UpdateServiceSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/update-service-settings.html) na *Referência de comandos da AWS CLI*. # Lightsail Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Lightsail. *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 ### `allocate-static-ip` O código de exemplo a seguir mostra como usar `allocate-static-ip`. **AWS CLI** **Para criar um IP estático** O exemplo `allocate-static-ip` a seguir cria o IP estático especificado, que pode ser anexado a uma instância. ``` aws lightsail allocate-static-ip \ --static-ip-name StaticIp-1 ``` Resultado: ``` { "operations": [ { "id": "b5d06d13-2f19-4683-889f-dEXAMPLEed79", "resourceName": "StaticIp-1", "resourceType": "StaticIp", "createdAt": 1571071325.076, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": true, "operationType": "AllocateStaticIp", "status": "Succeeded", "statusChangedAt": 1571071325.274 } ] } ``` + Para ver detalhes da API, consulte [AllocateStaticIp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/allocate-static-ip.html) na *Referência de comandos da AWS CLI*. ### `attach-disk` O código de exemplo a seguir mostra como usar `attach-disk`. **AWS CLI** **Como conectar um disco de armazenamento em bloco a uma instância** O exemplo `attach-disk` a seguir anexa o disco `Disk-1` à instância `WordPress_Multisite-1` com o caminho do disco de `/dev/xvdf` ``` aws lightsail attach-disk \ --disk-name Disk-1 \ --disk-path /dev/xvdf \ --instance-name WordPress_Multisite-1 ``` Resultado: ``` { "operations": [ { "id": "10a08267-19ce-43be-b913-6EXAMPLE7e80", "resourceName": "Disk-1", "resourceType": "Disk", "createdAt": 1571071465.472, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": false, "operationDetails": "WordPress_Multisite-1", "operationType": "AttachDisk", "status": "Started", "statusChangedAt": 1571071465.472 }, { "id": "2912c477-5295-4539-88c9-bEXAMPLEd1f0", "resourceName": "WordPress_Multisite-1", "resourceType": "Instance", "createdAt": 1571071465.474, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": false, "operationDetails": "Disk-1", "operationType": "AttachDisk", "status": "Started", "statusChangedAt": 1571071465.474 } ] } ``` + Para ver detalhes da API, consulte [AttachDisk](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/attach-disk.html) na *Referência de comandos da AWS CLI*. ### `attach-instances-to-load-balancer` O código de exemplo a seguir mostra como usar `attach-instances-to-load-balancer`. **AWS CLI** **Como anexar instâncias a um balanceador de carga** O exemplo `attach-instances-to-load-balancer` a seguir anexa instâncias `MEAN-1`, `MEAN-2`, e `MEAN-3` ao balanceador de carga `LoadBalancer-1`. ``` aws lightsail attach-instances-to-load-balancer \ --instance-names {"MEAN-1","MEAN-2","MEAN-3"} \ --load-balancer-name LoadBalancer-1 ``` Resultado: ``` { "operations": [ { "id": "8055d19d-abb2-40b9-b527-1EXAMPLE3c7b", "resourceName": "LoadBalancer-1", "resourceType": "LoadBalancer", "createdAt": 1571071699.892, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": false, "operationDetails": "MEAN-2", "operationType": "AttachInstancesToLoadBalancer", "status": "Started", "statusChangedAt": 1571071699.892 }, { "id": "c35048eb-8538-456a-a118-0EXAMPLEfb73", "resourceName": "MEAN-2", "resourceType": "Instance", "createdAt": 1571071699.887, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": false, "operationDetails": "LoadBalancer-1", "operationType": "AttachInstancesToLoadBalancer", "status": "Started", "statusChangedAt": 1571071699.887 }, { "id": "910d09e0-adc5-4372-bc2e-0EXAMPLEd891", "resourceName": "LoadBalancer-1", "resourceType": "LoadBalancer", "createdAt": 1571071699.882, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": false, "operationDetails": "MEAN-3", "operationType": "AttachInstancesToLoadBalancer", "status": "Started", "statusChangedAt": 1571071699.882 }, { "id": "178b18ac-43e8-478c-9bed-1EXAMPLE4755", "resourceName": "MEAN-3", "resourceType": "Instance", "createdAt": 1571071699.901, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": false, "operationDetails": "LoadBalancer-1", "operationType": "AttachInstancesToLoadBalancer", "status": "Started", "statusChangedAt": 1571071699.901 }, { "id": "fb62536d-2a98-4190-a6fc-4EXAMPLE7470", "resourceName": "LoadBalancer-1", "resourceType": "LoadBalancer", "createdAt": 1571071699.885, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": false, "operationDetails": "MEAN-1", "operationType": "AttachInstancesToLoadBalancer", "status": "Started", "statusChangedAt": 1571071699.885 }, { "id": "787dac0d-f98d-46c3-8571-3EXAMPLE5a85", "resourceName": "MEAN-1", "resourceType": "Instance", "createdAt": 1571071699.901, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": false, "operationDetails": "LoadBalancer-1", "operationType": "AttachInstancesToLoadBalancer", "status": "Started", "statusChangedAt": 1571071699.901 } ] } ``` + Para ver detalhes da API, consulte [AttachInstancesToLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/attach-instances-to-load-balancer.html) na *Referência de comandos da AWS CLI*. ### `attach-load-balancer-tls-certificate` O código de exemplo a seguir mostra como usar `attach-load-balancer-tls-certificate`. **AWS CLI** **Como anexar um certificado TLS a um balanceador de carga** O exemplo `attach-load-balancer-tls-certificate` a seguir anexa o certificado TLS do balanceador de carga `Certificate2` ao balanceador de carga `LoadBalancer-1`. ``` aws lightsail attach-load-balancer-tls-certificate \ --certificate-name Certificate2 \ --load-balancer-name LoadBalancer-1 ``` Resultado: ``` { "operations": [ { "id": "cf1ad6e3-3cbb-4b8a-a7f2-3EXAMPLEa118", "resourceName": "LoadBalancer-1", "resourceType": "LoadBalancer", "createdAt": 1571072255.416, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": true, "operationDetails": "Certificate2", "operationType": "AttachLoadBalancerTlsCertificate", "status": "Succeeded", "statusChangedAt": 1571072255.416 }, { "id": "dae1bcfb-d531-4c06-b4ea-bEXAMPLEc04e", "resourceName": "Certificate2", "resourceType": "LoadBalancerTlsCertificate", "createdAt": 1571072255.416, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": true, "operationDetails": "LoadBalancer-1", "operationType": "AttachLoadBalancerTlsCertificate", "status": "Succeeded", "statusChangedAt": 1571072255.416 } ] } ``` + Para ver detalhes da API, consulte [AttachLoadBalancerTlsCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/attach-load-balancer-tls-certificate.html) na *Referência de comandos da AWS CLI*. ### `attach-static-ip` O código de exemplo a seguir mostra como usar `attach-static-ip`. **AWS CLI** **Como associar um IP estático a uma instância** O exemplo `attach-static-ip` a seguir anexa IP estático `StaticIp-1` à instância `MEAN-1`. ``` aws lightsail attach-static-ip \ --static-ip-name StaticIp-1 \ --instance-name MEAN-1 ``` Resultado: ``` { "operations": [ { "id": "45e6fa13-4808-4b8d-9292-bEXAMPLE20b2", "resourceName": "StaticIp-1", "resourceType": "StaticIp", "createdAt": 1571072569.375, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": true, "operationDetails": "MEAN-1", "operationType": "AttachStaticIp", "status": "Succeeded", "statusChangedAt": 1571072569.375 }, { "id": "9ee09a17-863c-4e51-8a6d-3EXAMPLE5475", "resourceName": "MEAN-1", "resourceType": "Instance", "createdAt": 1571072569.376, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": true, "operationDetails": "StaticIp-1", "operationType": "AttachStaticIp", "status": "Succeeded", "statusChangedAt": 1571072569.376 } ] } ``` + Para ver detalhes da API, consulte [AttachStaticIp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/attach-static-ip.html) na *Referência de comandos da AWS CLI*. ### `close-instance-public-ports` O código de exemplo a seguir mostra como usar `close-instance-public-ports`. **AWS CLI** **Como fechar as portas de firewall de uma instância** O exemplo `close-instance-public-ports` a seguir fecha a porta TCP `22` na instância `MEAN-2`. ``` aws lightsail close-instance-public-ports \ --instance-name MEAN-2 \ --port-info fromPort=22,protocol=TCP,toPort=22 ``` Resultado: ``` { "operation": { "id": "4f328636-1c96-4649-ae6d-1EXAMPLEf446", "resourceName": "MEAN-2", "resourceType": "Instance", "createdAt": 1571072845.737, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": true, "operationDetails": "22/tcp", "operationType": "CloseInstancePublicPorts", "status": "Succeeded", "statusChangedAt": 1571072845.737 } } ``` + Para ver detalhes da API, consulte [CloseInstancePublicPorts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/close-instance-public-ports.html) na *Referência de comandos da AWS CLI*. ### `copy-snapshot` O código de exemplo a seguir mostra como usar `copy-snapshot`. **AWS CLI** **Exemplo 1: copiar um snapshot dentro da mesma região da AWS** O exemplo `copy-snapshot` a seguir copia o snapshot da instância `MEAN-1-1571075291` como snapshot da instância `MEAN-1-Copy` na mesma região da AWS `us-west-2`. ``` aws lightsail copy-snapshot \ --source-snapshot-name MEAN-1-1571075291 \ --target-snapshot-name MEAN-1-Copy \ --source-region us-west-2 ``` Resultado: ``` { "operations": [ { "id": "ced16fc1-f401-4556-8d82-1EXAMPLEb982", "resourceName": "MEAN-1-Copy", "resourceType": "InstanceSnapshot", "createdAt": 1571075581.498, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": false, "operationDetails": "us-west-2:MEAN-1-1571075291", "operationType": "CopySnapshot", "status": "Started", "statusChangedAt": 1571075581.498 } ] } ``` Para obter mais informações, consulte [Copiar snapshots de uma região da AWS a outra no Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-copying-snapshots-from-one-region-to-another) no *Guia do desenvolvedor do Lightsail*. **Exemplo 2: copiar um snapshot de uma região da AWS para outra** O exemplo `copy-snapshot` a seguir copia o snapshot da instância `MEAN-1-1571075291` como snapshot da instância `MEAN-1-1571075291-Copy` da região da AWS `us-west-2` para `us-east-1`. ``` aws lightsail copy-snapshot \ --source-snapshot-name MEAN-1-1571075291 \ --target-snapshot-name MEAN-1-1571075291-Copy \ --source-region us-west-2 \ --region us-east-1 ``` Resultado: ``` { "operations": [ { "id": "91116b79-119c-4451-b44a-dEXAMPLEd97b", "resourceName": "MEAN-1-1571075291-Copy", "resourceType": "InstanceSnapshot", "createdAt": 1571075695.069, "location": { "availabilityZone": "all", "regionName": "us-east-1" }, "isTerminal": false, "operationDetails": "us-west-2:MEAN-1-1571075291", "operationType": "CopySnapshot", "status": "Started", "statusChangedAt": 1571075695.069 } ] } ``` Para obter mais informações, consulte [Copiar snapshots de uma região da AWS a outra no Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-copying-snapshots-from-one-region-to-another) no *Guia do desenvolvedor do Lightsail*. **Exemplo 3: copiar um snapshot automático na mesma região da AWS** O exemplo `copy-snapshot` a seguir copia o snapshot automático `2019-10-14` da instância `WordPress-1` como snapshot manual `WordPress-1-10142019` na região da AWS `us-west-2`. ``` aws lightsail copy-snapshot \ --source-resource-name WordPress-1 \ --restore-date 2019-10-14 \ --target-snapshot-name WordPress-1-10142019 \ --source-region us-west-2 ``` Resultado: ``` { "operations": [ { "id": "be3e6754-cd1d-48e6-ad9f-2EXAMPLE1805", "resourceName": "WordPress-1-10142019", "resourceType": "InstanceSnapshot", "createdAt": 1571082412.311, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": false, "operationDetails": "us-west-2:WordPress-1", "operationType": "CopySnapshot", "status": "Started", "statusChangedAt": 1571082412.311 } ] } ``` Para obter mais informações, consulte [Manter snapshots automáticos de instâncias ou de discos no Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots) no *Guia do desenvolvedor do Lightsail*. **Exemplo 4: copiar um snapshot automático de uma região da AWS para outra** O exemplo `copy-snapshot` a seguir copia o snapshot automático `2019-10-14` da instância `WordPress-1` como snapshot manual `WordPress-1-10142019` da região da AWS `us-west-2` para a `us-east-1`. ``` aws lightsail copy-snapshot \ --source-resource-name WordPress-1 \ --restore-date 2019-10-14 \ --target-snapshot-name WordPress-1-10142019 \ --source-region us-west-2 \ --region us-east-1 ``` Resultado: ``` { "operations": [ { "id": "dffa128b-0b07-476e-b390-bEXAMPLE3775", "resourceName": "WordPress-1-10142019", "resourceType": "InstanceSnapshot", "createdAt": 1571082493.422, "location": { "availabilityZone": "all", "regionName": "us-east-1" }, "isTerminal": false, "operationDetails": "us-west-2:WordPress-1", "operationType": "CopySnapshot", "status": "Started", "statusChangedAt": 1571082493.422 } ] } ``` Para obter mais informações, consulte [Manter snapshots automáticos de instâncias ou de discos no Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots) no *Guia do desenvolvedor do Lightsail*. + Para ver detalhes da API, consulte [CopySnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/copy-snapshot.html) na *Referência de comandos da AWS CLI*. ### `create-disk-from-snapshot` O código de exemplo a seguir mostra como usar `create-disk-from-snapshot`. **AWS CLI** **Para criar um disco a partir de um snapshot** O exemplo `create-disk-from-snapshot` a seguir cria um disco de armazenamento em bloco chamado `Disk-2` a partir do snapshot do disco de armazenamento em bloco especificado. O disco é criado na região da AWS e zona de disponibilidade especificadas, com espaço de armazenamento de 32 GB. ``` aws lightsail create-disk-from-snapshot \ --disk-name Disk-2 \ --disk-snapshot-name Disk-1-1566839161 \ --availability-zone us-west-2a \ --size-in-gb 32 ``` Resultado: ``` { "operations": [ { "id": "d42b605d-5ef1-4b4a-8791-7a3e8b66b5e7", "resourceName": "Disk-2", "resourceType": "Disk", "createdAt": 1569624941.471, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": false, "operationType": "CreateDiskFromSnapshot", "status": "Started", "statusChangedAt": 1569624941.791 } ] } ``` Para obter mais informações, consulte [Criar um disco de armazenamento em bloco a partir de um snapshot no Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/create-new-block-storage-disk-from-snapshot) no *Guia do desenvolvedor do Lightsail*. + Para ver detalhes da API, consulte [CreateDiskFromSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-disk-from-snapshot.html) na *Referência de comandos da AWS CLI*. ### `create-disk-snapshot` O código de exemplo a seguir mostra como usar `create-disk-snapshot`. **AWS CLI** **Exemplo 1: criar um snapshot de um disco** O exemplo `create-disk-snapshot` a seguir cria um snapshot chamado `DiskSnapshot-1` do disco de armazenamento em bloco especificado. ``` aws lightsail create-disk-snapshot \ --disk-name Disk-1 \ --disk-snapshot-name DiskSnapshot-1 ``` Resultado: ``` { "operations": [ { "id": "fa74c6d2-03a3-4f42-a7c7-792f124d534b", "resourceName": "DiskSnapshot-1", "resourceType": "DiskSnapshot", "createdAt": 1569625129.739, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": false, "operationDetails": "Disk-1", "operationType": "CreateDiskSnapshot", "status": "Started", "statusChangedAt": 1569625129.739 }, { "id": "920a25df-185c-4528-87cd-7b85f5488c06", "resourceName": "Disk-1", "resourceType": "Disk", "createdAt": 1569625129.739, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": false, "operationDetails": "DiskSnapshot-1", "operationType": "CreateDiskSnapshot", "status": "Started", "statusChangedAt": 1569625129.739 } ] } ``` **Exemplo 2: criar um snapshot do disco de sistema de uma instância** O exemplo `create-disk-snapshot` a seguir cria um snapshot do disco do sistema da instância especificada. ``` aws lightsail create-disk-snapshot \ --instance-name WordPress-1 \ --disk-snapshot-name SystemDiskSnapshot-1 ``` Resultado: ``` { "operations": [ { "id": "f508cf1c-6597-42a6-a4c3-4aebd75af0d9", "resourceName": "SystemDiskSnapshot-1", "resourceType": "DiskSnapshot", "createdAt": 1569625294.685, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": false, "operationDetails": "WordPress-1", "operationType": "CreateDiskSnapshot", "status": "Started", "statusChangedAt": 1569625294.685 }, { "id": "0bb9f712-da3b-4d99-b508-3bf871d989e5", "resourceName": "WordPress-1", "resourceType": "Instance", "createdAt": 1569625294.685, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": false, "operationDetails": "SystemDiskSnapshot-1", "operationType": "CreateDiskSnapshot", "status": "Started", "statusChangedAt": 1569625294.685 } ] } ``` Para obter mais informações, consulte [Snapshots no Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/understanding-instance-snapshots-in-amazon-lightsail) e [Criar um snapshot do volume raiz de uma instância no Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-create-an-instance-root-volume-snapshot) no *Guia do desenvolvedor do Lightsail*. + Para ver detalhes da API, consulte [CreateDiskSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-disk-snapshot.html) na *Referência de comandos da AWS CLI*. ### `create-disk` O código de exemplo a seguir mostra como usar `create-disk`. **AWS CLI** **Para criar um disco de armazenamento em bloco** O exemplo `create-disk` a seguir cria o disco de armazenamento em bloco `Disk-1` na região da AWS e zona de disponibilidade especificadas, com espaço de armazenamento de 32 GB. ``` aws lightsail create-disk \ --disk-name Disk-1 \ --availability-zone us-west-2a \ --size-in-gb 32 ``` Resultado: ``` { "operations": [ { "id": "1c85e2ec-86ba-4697-b936-77f4d3dc013a", "resourceName": "Disk-1", "resourceType": "Disk", "createdAt": 1569449220.36, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": false, "operationType": "CreateDisk", "status": "Started", "statusChangedAt": 1569449220.588 } ] } ``` + Para ver detalhes da API, consulte [CreateDisk](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-disk.html) na *Referência de comandos da AWS CLI*. ### `create-domain-entry` O código de exemplo a seguir mostra como usar `create-domain-entry`. **AWS CLI** **Para criar uma entrada de domínio (registro DNS)** O exemplo `create-domain-entry` a seguir cria um registro DNS (A) para o ápice do domínio especificado que aponta para o endereço IP de uma instância. **Observação:** as operações de API relacionadas com o domínio do Lightsail estão disponíveis somente na região da `us-east-1`. Se seu perfil de CLI estiver configurado para usar uma região diferente, é necessário incluir o parâmetro `--region us-east-1`, ou o comando falhará. ``` aws lightsail create-domain-entry \ --region us-east-1 \ --domain-name example.com \ --domain-entry name=example.com,type=A,target=192.0.2.0 ``` Resultado: ``` { "operation": { "id": "5be4494d-56f4-41fc-8730-693dcd0ef9e2", "resourceName": "example.com", "resourceType": "Domain", "createdAt": 1569865296.519, "location": { "availabilityZone": "all", "regionName": "global" }, "isTerminal": true, "operationType": "CreateDomainEntry", "status": "Succeeded", "statusChangedAt": 1569865296.519 } } ``` Para obter mais informações, consulte [DNS no Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/understanding-dns-in-amazon-lightsail) e [Criar uma zona de DNS para gerenciar os registros de DNS do domínio no Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-how-to-create-dns-entry) no *Guia do desenvolvedor do Lightsail*. + Para ver detalhes da API, consulte [CreateDomainEntry](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-domain-entry.html) na *Referência de comandos da AWS CLI*. ### `create-domain` O código de exemplo a seguir mostra como usar `create-domain`. **AWS CLI** **Para criar um domínio (zona DNS)** O exemplo `create-domain` a seguir cria uma zona DNS para o domínio especificado. **Observação:** as operações de API relacionadas com o domínio do Lightsail estão disponíveis somente na região da `us-east-1`. Se seu perfil de CLI estiver configurado para usar uma região diferente, é necessário incluir o parâmetro `--region us-east-1`, ou o comando falhará. ``` aws lightsail create-domain \ --region us-east-1 \ --domain-name example.com ``` Resultado: ``` { "operation": { "id": "64e522c8-9ae1-4c05-9b65-3f237324dc34", "resourceName": "example.com", "resourceType": "Domain", "createdAt": 1569864291.92, "location": { "availabilityZone": "all", "regionName": "global" }, "isTerminal": true, "operationType": "CreateDomain", "status": "Succeeded", "statusChangedAt": 1569864292.109 } } ``` Para obter mais informações, consulte [DNS no Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/understanding-dns-in-amazon-lightsail) e [Criar uma zona de DNS para gerenciar os registros de DNS do domínio no Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-how-to-create-dns-entry) no *Guia do desenvolvedor do Lightsail*. + Para ver detalhes da API, consulte [CreateDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-domain.html) na *Referência de comandos da AWS CLI*. ### `create-instance-snapshot` O código de exemplo a seguir mostra como usar `create-instance-snapshot`. **AWS CLI** **Para criar um snapshot da instância** O exemplo `create-instance-snapshot` a seguir cria um snapshot da instância especificada. ``` aws lightsail create-instance-snapshot \ --instance-name WordPress-1 \ --instance-snapshot-name WordPress-Snapshot-1 ``` Resultado: ``` { "operations": [ { "id": "4c3db559-9dd0-41e7-89c0-2cb88c19786f", "resourceName": "WordPress-Snapshot-1", "resourceType": "InstanceSnapshot", "createdAt": 1569866438.48, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": false, "operationDetails": "WordPress-1", "operationType": "CreateInstanceSnapshot", "status": "Started", "statusChangedAt": 1569866438.48 }, { "id": "c04fdc45-2981-488c-88b5-d6d2fd759a6a", "resourceName": "WordPress-1", "resourceType": "Instance", "createdAt": 1569866438.48, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": false, "operationDetails": "WordPress-Snapshot-1", "operationType": "CreateInstanceSnapshot", "status": "Started", "statusChangedAt": 1569866438.48 } ] } ``` + Para ver detalhes da API, consulte [CreateInstanceSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-instance-snapshot.html) na *Referência de comandos da AWS CLI*. ### `create-instances-from-snapshot` O código de exemplo a seguir mostra como usar `create-instances-from-snapshot`. **AWS CLI** **Para criar uma instância a partir de um snapshot** O exemplo `create-instances-from-snapshot` a seguir cria uma instância a partir do snapshot da instância especificada, na região da AWS e zona de disponibilidade especificadas, usando o pacote de USD 12. **Observação:** o pacote indicado deve ter especificações iguais ou maiores do que o pacote da instância original usado para criar o snapshot. ``` aws lightsail create-instances-from-snapshot \ --instance-snapshot-name WordPress-1-1569866208 \ --instance-names WordPress-2 \ --availability-zone us-west-2a \ --bundle-id small_3_0 ``` Resultado: ``` { "operations": [ { "id": "003f8271-b711-464d-b9b8-7f3806cb496e", "resourceName": "WordPress-2", "resourceType": "Instance", "createdAt": 1569865914.908, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": false, "operationType": "CreateInstancesFromSnapshot", "status": "Started", "statusChangedAt": 1569865914.908 } ] } ``` + Para ver detalhes da API, consulte [CreateInstancesFromSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-instances-from-snapshot.html) na *Referência de comandos da AWS CLI*. ### `create-instances` O código de exemplo a seguir mostra como usar `create-instances`. **AWS CLI** **Exemplo 1: criar uma única instância** O exemplo `create-instances` a seguir cria uma instância na região da AWS e zona de disponibilidade especificadas, usando o esquema WordPress e o pacote de USD 5,00. ``` aws lightsail create-instances \ --instance-names Instance-1 \ --availability-zone us-west-2a \ --blueprint-id wordpress \ --bundle-id nano_3_0 ``` Resultado: ``` { "operations": [ { "id": "9a77158f-7be3-4d6d-8054-cf5ae2b720cc", "resourceName": "Instance-1", "resourceType": "Instance", "createdAt": 1569447986.061, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": false, "operationType": "CreateInstance", "status": "Started", "statusChangedAt": 1569447986.061 } ] } ``` **Exemplo 2: criar várias instâncias ao mesmo tempo** O exemplo `create-instances` a seguir cria três instâncias na região da AWS e zona de disponibilidade especificadas, usando o esquema WordPress e o pacote de USD 5,00. ``` aws lightsail create-instances \ --instance-names {"Instance1","Instance2","Instance3"} \ --availability-zone us-west-2a \ --blueprint-id wordpress \ --bundle-id nano_3_0 ``` Resultado: ``` { "operations": [ { "id": "5492f015-9d2e-48c6-8eea-b516840e6903", "resourceName": "Instance1", "resourceType": "Instance", "createdAt": 1569448780.054, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": false, "operationType": "CreateInstance", "status": "Started", "statusChangedAt": 1569448780.054 }, { "id": "c58b5f46-2676-44c8-b95c-3ad375898515", "resourceName": "Instance2", "resourceType": "Instance", "createdAt": 1569448780.054, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": false, "operationType": "CreateInstance", "status": "Started", "statusChangedAt": 1569448780.054 }, { "id": "a5ad8006-9bee-4499-9eb7-75e42e6f5882", "resourceName": "Instance3", "resourceType": "Instance", "createdAt": 1569448780.054, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": false, "operationType": "CreateInstance", "status": "Started", "statusChangedAt": 1569448780.054 } ] } ``` + Para ver detalhes da API, consulte [CreateInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-instances.html) na *Referência de comandos da AWS CLI*. ### `create-key-pair` O código de exemplo a seguir mostra como usar `create-key-pair`. **AWS CLI** **Para criar um par de chaves** O exemplo `create-key-pair` a seguir cria um par de chaves que pode ser usado para autenticar e conectar a uma instância. ``` aws lightsail create-key-pair \ --key-pair-name MyPersonalKeyPair ``` A saída fornece o valor base64 da chave privada que pode ser usada para autenticar instâncias que usam o par de chaves criado. **Observação:** copie e cole o valor base64 da chave privada em um local seguro, pois ele não pode ser recuperado posteriormente. ``` { "keyPair": { "name": "MyPersonalKeyPair", "arn": "arn:aws:lightsail:us-west-2:111122223333:KeyPair/55025c71-198f-403b-b42f-a69433e724fb", "supportCode": "621291663362/MyPersonalKeyPair", "createdAt": 1569866556.567, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "resourceType": "KeyPair" }, "publicKeyBase64": "ssh-rsa ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCV0xUEwx96amPERH7K1bVT1tTFl9OmNk6o7m5YVHk9xlOdMbDRbFvhtXvw4jzJXXz5pBMxWOaGMz5K8QyTVOznoqp13Z8SBooH29hgmBNXiII1XPzEwqbj8mfo1+YVM5s5VuxWwm+BHUgedGUXno6uF7agqxZNO1kPLJBIVTW26SSYBJ0tE+y804UyVsjrbUqCaMXDhmfXpWulMPwuXhwcKh7e8hwoTfkiX0E6Ql+KqF/MiA3w6DCjEqvvdIO7SiEZJFsuGNfYDDN3w60Rel5MUhmn3OJdn4y/A7NWb3IxL4pPfVE4rgFRKU8n1jp9kwRnlVMVBOWuGXk6n+H6M2f1 ", "privateKeyBase64": "-----BEGIN RSA PRIVATE KEY-----EXAMPLETCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC\nVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6\nb24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsEXAMPLEd\nBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN\nMTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD\nVQQHEwdTZWF0dGxlMQ8wDQEXAMPLEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z\nb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt\nYXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMEXAMPLE4GmWIWJ\n21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T\nrDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE\nIbb3OhjZnzcvQAaREXAMPLEMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4\nnUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb\nFFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OEXAMPLELvjx79LjSTb\nNYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=\n-----END RSA PRIVATE KEY-----", "operation": { "id": "67f984db-9994-45fe-ad38-59bafcaf82ef", "resourceName": "MyPersonalKeyPair", "resourceType": "KeyPair", "createdAt": 1569866556.567, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": true, "operationType": "CreateKeyPair", "status": "Succeeded", "statusChangedAt": 1569866556.704 } } ``` + Consulte detalhes da API em [CreateKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-key-pair.html) na *Referência de comandos da AWS CLI*. ### `create-load-balancer-tls-certificate` O código de exemplo a seguir mostra como usar `create-load-balancer-tls-certificate`. **AWS CLI** **Para criar um certificado TLS para um balanceador de carga** O exemplo `create-load-balancer-tls-certificate` a seguir cria um certificado TLS anexado ao balanceador de carga especificado. O certificado criado se aplica aos domínios especificados. **Observação:** somente dois certificados podem ser criados para um balanceador de carga. ``` aws lightsail create-load-balancer-tls-certificate \ --certificate-alternative-names abc.example.com \ --certificate-domain-name example.com \ --certificate-name MySecondCertificate \ --load-balancer-name MyFirstLoadBalancer ``` Resultado: ``` { "operations": [ { "id": "be663aed-cb46-41e2-9b23-e2f747245bd4", "resourceName": "MySecondCertificate", "resourceType": "LoadBalancerTlsCertificate", "createdAt": 1569867364.971, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": true, "operationDetails": "MyFirstLoadBalancer", "operationType": "CreateLoadBalancerTlsCertificate", "status": "Succeeded", "statusChangedAt": 1569867365.219 }, { "id": "f3dfa930-969e-41cc-ac7d-337178716f6d", "resourceName": "MyFirstLoadBalancer", "resourceType": "LoadBalancer", "createdAt": 1569867364.971, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": true, "operationDetails": "MySecondCertificate", "operationType": "CreateLoadBalancerTlsCertificate", "status": "Succeeded", "statusChangedAt": 1569867365.219 } ] } ``` + Para ver detalhes da API, consulte [CreateLoadBalancerTlsCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-load-balancer-tls-certificate.html) na *Referência de comandos da AWS CLI*. ### `create-load-balancer` O código de exemplo a seguir mostra como usar `create-load-balancer`. **AWS CLI** **Para criar um balanceador de carga** O exemplo `create-load-balancer` a seguir cria um balanceador de carga com um certificado TLS. O certificado TLS se aplica aos domínios especificados e encaminha o tráfego para instâncias na porta 80. ``` aws lightsail create-load-balancer \ --certificate-alternative-names www.example.com test.example.com \ --certificate-domain-name example.com \ --certificate-name Certificate-1 \ --instance-port 80 \ --load-balancer-name LoadBalancer-1 ``` Resultado: ``` { "operations": [ { "id": "cc7b920a-83d8-4762-a74e-9174fe1540be", "resourceName": "LoadBalancer-1", "resourceType": "LoadBalancer", "createdAt": 1569867169.406, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": false, "operationType": "CreateLoadBalancer", "status": "Started", "statusChangedAt": 1569867169.406 }, { "id": "658ed43b-f729-42f3-a8e4-3f8024d3c98d", "resourceName": "LoadBalancer-1", "resourceType": "LoadBalancerTlsCertificate", "createdAt": 1569867170.193, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": true, "operationDetails": "LoadBalancer-1", "operationType": "CreateLoadBalancerTlsCertificate", "status": "Succeeded", "statusChangedAt": 1569867170.54 }, { "id": "4757a342-5181-4870-b1e0-227eebc35ab5", "resourceName": "LoadBalancer-1", "resourceType": "LoadBalancer", "createdAt": 1569867170.193, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": true, "operationDetails": "Certificate-1", "operationType": "CreateLoadBalancerTlsCertificate", "status": "Succeeded", "statusChangedAt": 1569867170.54 } ] } ``` Para obter mais informações, consulte [balanceadores de carga do Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/understanding-lightsail-load-balancers) no *Guia do desenvolvedor do Lightsail*. + Consulte detalhes da API em [CreateLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-load-balancer.html) na *Referência de comandos da AWS CLI*. ### `create-relational-database-from-snapshot` O código de exemplo a seguir mostra como usar `create-relational-database-from-snapshot`. **AWS CLI** **Para criar um banco de dados gerenciado a partir de um snapshot** O exemplo `create-relational-database-from-snapshot` a seguir cria um banco de dados gerenciado a partir do snapshot na região da AWS e zona de disponibilidade especificadas, usando o pacote de banco de dados padrão de USD 15. **Observação:** o pacote indicado deve ter especificações iguais ou maiores do que o pacote da instância original usado para criar o snapshot. ``` aws lightsail create-relational-database-from-snapshot \ --relational-database-snapshot-name Database-Oregon-1-1566839359 \ --relational-database-name Database-1 \ --availability-zone us-west-2a \ --relational-database-bundle-id micro_1_0 \ --no-publicly-accessible ``` Resultado: ``` { "operations": [ { "id": "ad6d9193-9d5c-4ea1-97ae-8fe6de600b4c", "resourceName": "Database-1", "resourceType": "RelationalDatabase", "createdAt": 1569867916.938, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": false, "operationType": "CreateRelationalDatabaseFromSnapshot", "status": "Started", "statusChangedAt": 1569867918.643 } ] } ``` + Para ver detalhes da API, consulte [CreateRelationalDatabaseFromSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-relational-database-from-snapshot.html) na *Referência de comandos da AWS CLI*. ### `create-relational-database-snapshot` O código de exemplo a seguir mostra como usar `create-relational-database-snapshot`. **AWS CLI** **Para criar um snapshot de seu banco de dados gerenciado** O exemplo `create-relational-database-snapshot` a seguir cria um snapshot do banco de dados gerenciado especificado. ``` aws lightsail create-relational-database-snapshot \ --relational-database-name Database1 \ --relational-database-snapshot-name RelationalDatabaseSnapshot1 ``` Resultado: ``` { "operations": [ { "id": "853667fb-ea91-4c02-8d20-8fc5fd43b9eb", "resourceName": "RelationalDatabaseSnapshot1", "resourceType": "RelationalDatabaseSnapshot", "createdAt": 1569868074.645, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": false, "operationDetails": "Database1", "operationType": "CreateRelationalDatabaseSnapshot", "status": "Started", "statusChangedAt": 1569868074.645 }, { "id": "fbafa521-3cac-4be8-9773-1c143780b239", "resourceName": "Database1", "resourceType": "RelationalDatabase", "createdAt": 1569868074.645, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": false, "operationDetails": "RelationalDatabaseSnapshot1", "operationType": "CreateRelationalDatabaseSnapshot", "status": "Started", "statusChangedAt": 1569868074.645 } ] } ``` + Para ver detalhes da API, consulte [CreateRelationalDatabaseSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-relational-database-snapshot.html) na *Referência de comandos da AWS CLI*. ### `create-relational-database` O código de exemplo a seguir mostra como usar `create-relational-database`. **AWS CLI** **Para criar um banco de dados gerenciado** O exemplo `create-relational-database` a seguir cria um banco de dados gerenciado na região da AWS e zona de disponibilidade especificadas, usando o mecanismo de banco de dados MySQL 5.6 (mysql\$15\$16) e o pacote de banco de dados padrão de USD 15 (micro\$11\$10). O banco de dados gerenciado é pré-preenchido com um nome de usuário principal e não pode ser acessado publicamente. ``` aws lightsail create-relational-database \ --relational-database-name Database-1 \ --availability-zone us-west-2a \ --relational-database-blueprint-id mysql_5_6 \ --relational-database-bundle-id micro_1_0 \ --master-database-name dbmaster \ --master-username user \ --no-publicly-accessible ``` Resultado: ``` { "operations": [ { "id": "b52bedee-73ed-4798-8d2a-9c12df89adcd", "resourceName": "Database-1", "resourceType": "RelationalDatabase", "createdAt": 1569450017.244, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": false, "operationType": "CreateRelationalDatabase", "status": "Started", "statusChangedAt": 1569450018.637 } ] } ``` + Para ver detalhes da API, consulte [CreateRelationalDatabase](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-relational-database.html) na *Referência de comandos da AWS CLI*. ### `delete-auto-snapshot` O código de exemplo a seguir mostra como usar `delete-auto-snapshot`. **AWS CLI** **Para excluir um snapshot automático** O exemplo `delete-auto-snapshot` a seguir exclui o snapshot automático `2019-10-10` da instância `WordPress-1`. ``` aws lightsail delete-auto-snapshot \ --resource-name WordPress-1 \ --date 2019-10-10 ``` Resultado: ``` { "operations": [ { "id": "31c36e09-3d52-46d5-b6d8-7EXAMPLE534a", "resourceName": "WordPress-1", "resourceType": "Instance", "createdAt": 1571088141.501, "location": { "availabilityZone": "us-west-2", "regionName": "us-west-2" }, "isTerminal": true, "operationDetails": "DeleteAutoSnapshot-2019-10-10", "operationType": "DeleteAutoSnapshot", "status": "Succeeded" } ] } ``` Para obter mais informações, consulte [Excluir snapshots automáticos de instâncias ou de discos no Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-deleting-automatic-snapshots) no *Guia do desenvolvedor do Lightsail*. + Para ver detalhes da API, consulte [DeleteAutoSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-auto-snapshot.html) na *Referência de comandos da AWS CLI*. ### `delete-disk-snapshot` O código de exemplo a seguir mostra como usar `delete-disk-snapshot`. **AWS CLI** **Para excluir um snapshot de um disco de armazenamento em bloco** O exemplo `delete-disk-snapshot` a seguir exclui o snapshot especificado de um disco de armazenamento em bloco ``` aws lightsail delete-disk-snapshot \ --disk-snapshot-name DiskSnapshot-1 ``` Resultado: ``` { "operations": [ { "id": "d1e5766d-b81e-4595-ad5d-02afbccfcd5d", "resourceName": "DiskSnapshot-1", "resourceType": "DiskSnapshot", "createdAt": 1569873552.79, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": true, "operationType": "DeleteDiskSnapshot", "status": "Succeeded", "statusChangedAt": 1569873552.79 } ] } ``` + Para ver detalhes da API, consulte [DeleteDiskSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-disk-snapshot.html) na *Referência de comandos da AWS CLI*. ### `delete-disk` O código de exemplo a seguir mostra como usar `delete-disk`. **AWS CLI** **Para excluir um disco de armazenamento em bloco** O exemplo `delete-disk` a seguir exclui o disco de armazenamento em bloco especificado. ``` aws lightsail delete-disk \ --disk-name Disk-1 ``` Resultado: ``` { "operations": [ { "id": "6378c70f-4d75-4f7a-ab66-730fca0bb2fc", "resourceName": "Disk-1", "resourceType": "Disk", "createdAt": 1569872887.864, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": true, "operationType": "DeleteDisk", "status": "Succeeded", "statusChangedAt": 1569872887.864 } ] } ``` + Para ver detalhes da API, consulte [DeleteDisk](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-disk.html) na *Referência de comandos da AWS CLI*. ### `delete-domain-entry` O código de exemplo a seguir mostra como usar `delete-domain-entry`. **AWS CLI** **Para excluir uma entrada de domínio (registro DNS)** O exemplo `delete-domain-entry` a seguir exclui a entrada de domínio especificada de um domínio existente. **Observação:** as operações de API relacionadas com o domínio do Lightsail estão disponíveis somente na região da `us-east-1`. Se seu perfil de CLI estiver configurado para usar uma região diferente, é necessário incluir o parâmetro `--region us-east-1`, ou o comando falhará. ``` aws lightsail delete-domain-entry \ --region us-east-1 \ --domain-name example.com \ --domain-entry name=123.example.com,target=192.0.2.0,type=A ``` Resultado: ``` { "operation": { "id": "06eacd01-d785-420e-8daa-823150c7dca1", "resourceName": "example.com ", "resourceType": "Domain", "createdAt": 1569874157.005, "location": { "availabilityZone": "all", "regionName": "global" }, "isTerminal": true, "operationType": "DeleteDomainEntry", "status": "Succeeded", "statusChangedAt": 1569874157.005 } } ``` + Para ver detalhes da API, consulte [DeleteDomainEntry](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-domain-entry.html) na *Referência de comandos da AWS CLI*. ### `delete-domain` O código de exemplo a seguir mostra como usar `delete-domain`. **AWS CLI** **Para excluir um domínio (zona DNS)** O exemplo `delete-domain` a seguir exclui o domínio especificado e todas as entradas no domínio (registros DNS). **Observação:** as operações de API relacionadas com o domínio do Lightsail estão disponíveis somente na região da `us-east-1`. Se seu perfil de CLI estiver configurado para usar uma região diferente, é necessário incluir o parâmetro `--region us-east-1`, ou o comando falhará. ``` aws lightsail delete-domain \ --region us-east-1 \ --domain-name example.com ``` Resultado: ``` { "operation": { "id": "fcef5265-5af1-4a46-a3d7-90b5e18b9b32", "resourceName": "example.com", "resourceType": "Domain", "createdAt": 1569873788.13, "location": { "availabilityZone": "all", "regionName": "global" }, "isTerminal": true, "operationType": "DeleteDomain", "status": "Succeeded", "statusChangedAt": 1569873788.13 } } ``` + Para ver detalhes da API, consulte [DeleteDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-domain.html) na *Referência de comandos da AWS CLI*. ### `delete-instance-snapshot` O código de exemplo a seguir mostra como usar `delete-instance-snapshot`. **AWS CLI** **título** O exemplo `delete-instance-snapshot` a seguir exclui o snapshot especificado de uma instância. ``` aws lightsail delete-instance-snapshot \ --instance-snapshot-name WordPress-1-Snapshot-1 ``` Resultado: ``` { "operations": [ { "id": "14dad182-976a-46c6-bfd4-9480482bf0ea", "resourceName": "WordPress-1-Snapshot-1", "resourceType": "InstanceSnapshot", "createdAt": 1569874524.562, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": true, "operationType": "DeleteInstanceSnapshot", "status": "Succeeded", "statusChangedAt": 1569874524.562 } ] } ``` + Para ver detalhes da API, consulte [DeleteInstanceSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-instance-snapshot.html) na *Referência da API AWS CLI*. ### `delete-instance` O código de exemplo a seguir mostra como usar `delete-instance`. **AWS CLI** **Para excluir uma instância** O exemplo `delete-instance` a seguir exclui a instância especificada. ``` aws lightsail delete-instance \ --instance-name WordPress-1 ``` Resultado: ``` { "operations": [ { "id": "d77345a3-8f80-4d2e-b47d-aaa622718df2", "resourceName": "Disk-1", "resourceType": "Disk", "createdAt": 1569874357.469, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": false, "operationDetails": "WordPress-1", "operationType": "DetachDisk", "status": "Started", "statusChangedAt": 1569874357.469 }, { "id": "708fa606-2bfd-4e48-a2c1-0b856585b5b1", "resourceName": "WordPress-1", "resourceType": "Instance", "createdAt": 1569874357.465, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": false, "operationDetails": "Disk-1", "operationType": "DetachDisk", "status": "Started", "statusChangedAt": 1569874357.465 }, { "id": "3187e823-8acb-405d-b098-fad5ceb17bec", "resourceName": "WordPress-1", "resourceType": "Instance", "createdAt": 1569874357.829, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": true, "operationType": "DeleteInstance", "status": "Succeeded", "statusChangedAt": 1569874357.829 } ] } ``` + Para ver detalhes da API, consulte [DeleteInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-instance.html) na *Referência de comandos da AWS CLI*. ### `delete-key-pair` O código de exemplo a seguir mostra como usar `delete-key-pair`. **AWS CLI** **Para excluir um par de chaves** O exemplo `delete-key-pair` a seguir exclui o par de chaves especificado. ``` aws lightsail delete-key-pair \ --key-pair-name MyPersonalKeyPair ``` Resultado: ``` { "operation": { "id": "81621463-df38-4810-b866-6e801a15abbf", "resourceName": "MyPersonalKeyPair", "resourceType": "KeyPair", "createdAt": 1569874626.466, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": true, "operationType": "DeleteKeyPair", "status": "Succeeded", "statusChangedAt": 1569874626.685 } } ``` + Consulte detalhes da API em [DeleteKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-key-pair.html) na *Referência de comandos da AWS CLI*. ### `delete-known-host-keys` O código de exemplo a seguir mostra como usar `delete-known-host-keys`. **AWS CLI** **Para excluir chaves de host conhecidas de uma instância** O exemplo `delete-known-host-keys` a seguir exclui a chave de host conhecida de uma instância especificada. ``` aws lightsail delete-known-host-keys \ --instance-name Instance-1 ``` Resultado: ``` { "operations": [ { "id": "c61afe9c-45a4-41e6-a97e-d212364da3f5", "resourceName": "Instance-1", "resourceType": "Instance", "createdAt": 1569874760.201, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": true, "operationType": "DeleteKnownHostKeys", "status": "Succeeded", "statusChangedAt": 1569874760.201 } ] } ``` Para obter mais informações, consulte [Solução de problemas de conexão com o cliente Amazon Lightsail SSH ou RDP baseado em navegador](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-troubleshooting-browser-based-ssh-rdp-client-connection) no *Guia do desenvolvedor do Lightsail*. + Para ver detalhes da API, consulte [DeleteKnownHostKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-known-host-keys.html) na *Referência de comandos da AWS CLI*. ### `delete-load-balancer-tls-certificate` O código de exemplo a seguir mostra como usar `delete-load-balancer-tls-certificate`. **AWS CLI** **Para excluir um certificado TLS de um balanceador de carga** O exemplo `delete-load-balancer-tls-certificate` a seguir exclui o certificado TLS especificado do balanceador de carga especificado. ``` aws lightsail delete-load-balancer-tls-certificate \ --load-balancer-name MyFirstLoadBalancer \ --certificate-name MyFirstCertificate ``` Resultado: ``` { "operations": [ { "id": "50bec274-e45e-4caa-8a69-b763ef636583", "resourceName": "MyFirstCertificate", "resourceType": "LoadBalancerTlsCertificate", "createdAt": 1569874989.48, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": false, "operationType": "DeleteLoadBalancerTlsCertificate", "status": "Started", "statusChangedAt": 1569874989.48 }, { "id": "78c58cdc-a59a-4b27-8213-500638634a8f", "resourceName": "MyFirstLoadBalancer", "resourceType": "LoadBalancer", "createdAt": 1569874989.48, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": false, "operationType": "DeleteLoadBalancerTlsCertificate", "status": "Started", "statusChangedAt": 1569874989.48 } ] } ``` + Para ver detalhes da API, consulte [DeleteLoadBalancerTlsCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-load-balancer-tls-certificate.html) na *Referência de comandos da AWS CLI*. ### `delete-load-balancer` O código de exemplo a seguir mostra como usar `delete-load-balancer`. **AWS CLI** **Como excluir um balanceador de carga** O exemplo `delete-load-balancer` a seguir exclui o balanceador de carga especificado e quaisquer certificados TLS associados. ``` aws lightsail delete-load-balancer \ --load-balancer-name MyFirstLoadBalancer ``` Resultado: ``` { "operations": [ { "id": "a8c968c7-72a3-4680-a714-af8f03eea535", "resourceName": "MyFirstLoadBalancer", "resourceType": "LoadBalancer", "createdAt": 1569875092.125, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": true, "operationType": "DeleteLoadBalancer", "status": "Succeeded", "statusChangedAt": 1569875092.125 }, { "id": "f91a29fc-8ce3-4e69-a227-ea70ca890bf5", "resourceName": "MySecondCertificate", "resourceType": "LoadBalancerTlsCertificate", "createdAt": 1569875091.938, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": false, "operationType": "DeleteLoadBalancerTlsCertificate", "status": "Started", "statusChangedAt": 1569875091.938 }, { "id": "cf64c060-154b-4eb4-ba57-84e2e41563d6", "resourceName": "MyFirstLoadBalancer", "resourceType": "LoadBalancer", "createdAt": 1569875091.94, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": false, "operationType": "DeleteLoadBalancerTlsCertificate", "status": "Started", "statusChangedAt": 1569875091.94 } ] } ``` Para obter mais informações, consulte *guia*. + Consulte detalhes da API em [DeleteLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-load-balancer.html) na *Referência de comandos da AWS CLI*. ### `delete-relational-database-snapshot` O código de exemplo a seguir mostra como usar `delete-relational-database-snapshot`. **AWS CLI** **Para excluir um snapshot de um banco de dados gerenciado** O exemplo `delete-relational-database-snapshot` a seguir exclui o snapshot especificado de um banco de dados gerenciado. ``` aws lightsail delete-relational-database-snapshot \ --relational-database-snapshot-name Database-Oregon-1-1566839359 ``` Resultado: ``` { "operations": [ { "id": "b99acae8-735b-4823-922f-30af580e3729", "resourceName": "Database-Oregon-1-1566839359", "resourceType": "RelationalDatabaseSnapshot", "createdAt": 1569875293.58, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": true, "operationType": "DeleteRelationalDatabaseSnapshot", "status": "Succeeded", "statusChangedAt": 1569875293.58 } ] } ``` + Para ver detalhes da API, consulte [DeleteRelationalDatabaseSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-relational-database-snapshot.html) na *Referência de comandos da AWS CLI*. ### `delete-relational-database` O código de exemplo a seguir mostra como usar `delete-relational-database`. **AWS CLI** **Para excluir um banco de dados gerenciado** O exemplo `delete-relational-database` a seguir exclui o banco de dados gerenciado especificado. ``` aws lightsail delete-relational-database \ --relational-database-name Database-1 ``` Resultado: ``` { "operations": [ { "id": "3b0c41c1-053d-46f0-92a3-14f76141dc86", "resourceName": "Database-1", "resourceType": "RelationalDatabase", "createdAt": 1569875210.999, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": false, "operationType": "DeleteRelationalDatabase", "status": "Started", "statusChangedAt": 1569875210.999 }, { "id": "01ddeae8-a87a-4a4b-a1f3-092c71bf9180", "resourceName": "Database-1", "resourceType": "RelationalDatabase", "createdAt": 1569875211.029, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": false, "operationDetails": "Database-1-FinalSnapshot-1569875210793", "operationType": "CreateRelationalDatabaseSnapshot", "status": "Started", "statusChangedAt": 1569875211.029 }, { "id": "74d73681-30e8-4532-974e-1f23cd3f9f73", "resourceName": "Database-1-FinalSnapshot-1569875210793", "resourceType": "RelationalDatabaseSnapshot", "createdAt": 1569875211.029, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": false, "operationDetails": "Database-1", "operationType": "CreateRelationalDatabaseSnapshot", "status": "Started", "statusChangedAt": 1569875211.029 } ] } ``` + Para ver detalhes da API, consulte [DeleteRelationalDatabase](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-relational-database.html) na *Referência de comandos da AWS CLI*. ### `detach-static-ip` O código de exemplo a seguir mostra como usar `detach-static-ip`. **AWS CLI** **Como desassociar um IP estático de uma instância** O exemplo `detach-static-ip` a seguir desassocia o IP estático `StaticIp-1` de qualquer instância anexada. ``` aws lightsail detach-static-ip \ --static-ip-name StaticIp-1 ``` Resultado: ``` { "operations": [ { "id": "2a43d8a3-9f2d-4fe7-bdd0-eEXAMPLE3cf3", "resourceName": "StaticIp-1", "resourceType": "StaticIp", "createdAt": 1571088261.999, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": true, "operationDetails": "MEAN-1", "operationType": "DetachStaticIp", "status": "Succeeded", "statusChangedAt": 1571088261.999 }, { "id": "41a7d40c-74e8-4d2e-a837-cEXAMPLEf747", "resourceName": "MEAN-1", "resourceType": "Instance", "createdAt": 1571088262.022, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": true, "operationDetails": "StaticIp-1", "operationType": "DetachStaticIp", "status": "Succeeded", "statusChangedAt": 1571088262.022 } ] } ``` + Para ver detalhes da API, consulte [DetachStaticIp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/detach-static-ip.html) na *Referência de comandos da AWS CLI*. ### `get-active-names` O código de exemplo a seguir mostra como usar `get-active-names`. **AWS CLI** **Para obter nomes de recursos ativos** O exemplo `get-active-names` a seguir retorna os nomes dos recursos ativos na região da AWS configurada. ``` aws lightsail get-active-names ``` Resultado: ``` { "activeNames": [ "WordPress-1", "StaticIp-1", "MEAN-1", "Plesk_Hosting_Stack_on_Ubuntu-1" ] } ``` + Para ver detalhes da API, consulte [GetActiveNames](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-active-names.html) na *Referência de comandos da AWS CLI*. ### `get-auto-snapshots` O código de exemplo a seguir mostra como usar `get-auto-snapshots`. **AWS CLI** **Para obter os snapshots automáticos disponíveis de uma instância** O exemplo `get-auto-snapshots` a seguir retorna os snapshots automáticos disponíveis para a instância `WordPress-1`. ``` aws lightsail get-auto-snapshots \ --resource-name WordPress-1 ``` Resultado: ``` { "resourceName": "WordPress-1", "resourceType": "Instance", "autoSnapshots": [ { "date": "2019-10-14", "createdAt": 1571033872.0, "status": "Success", "fromAttachedDisks": [] }, { "date": "2019-10-13", "createdAt": 1570947473.0, "status": "Success", "fromAttachedDisks": [] }, { "date": "2019-10-12", "createdAt": 1570861072.0, "status": "Success", "fromAttachedDisks": [] }, { "date": "2019-10-11", "createdAt": 1570774672.0, "status": "Success", "fromAttachedDisks": [] } ] } ``` Para obter mais informações, consulte [Manter snapshots automáticos de instâncias ou de discos no Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots) no *Guia do desenvolvedor do Lightsail*. + Para ver detalhes da API, consulte [GetAutoSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-auto-snapshots.html) na *Referência de comandos da AWS CLI*. ### `get-blueprints` O código de exemplo a seguir mostra como usar `get-blueprints`. **AWS CLI** **Para obter os esquemas para novas instâncias** O exemplo `get-blueprints` a seguir mostra detalhes sobre todos os esquemas disponíveis que podem ser usados para criar novas instâncias no Amazon Lightsail. ``` aws lightsail get-blueprints ``` Resultado: ``` { "blueprints": [ { "blueprintId": "wordpress", "name": "WordPress", "group": "wordpress", "type": "app", "description": "Bitnami, the leaders in application packaging, and Automattic, the experts behind WordPress, have teamed up to offer this official WordPress image. This image is a pre-configured, ready-to-run image for running WordPress on Amazon Lightsail. WordPress is the world's most popular content management platform. Whether it's for an enterprise or small business website, or a personal or corporate blog, content authors can easily create content using its new Gutenberg editor, and developers can extend the base platform with additional features. Popular plugins like Jetpack, Akismet, All in One SEO Pack, WP Mail, Google Analytics for WordPress, and Amazon Polly are all pre-installed in this image. Let's Encrypt SSL certificates are supported through an auto-configuration script.", "isActive": true, "minPower": 0, "version": "6.5.3-0", "versionCode": "1", "productUrl": "https://aws.amazon.com/marketplace/pp/B00NN8Y43U", "licenseUrl": "https://aws.amazon.com/marketplace/pp/B00NN8Y43U#pdp-usage", "platform": "LINUX_UNIX" }, { "blueprintId": "lamp_8_bitnami", "name": "LAMP (PHP 8)", "group": "lamp_8", "type": "app", "description": "LAMP with PHP 8.X packaged by Bitnami enables you to quickly start building your websites and applications by providing a coding framework. As a developer, it provides standalone project directories to store your applications. This blueprint is configured for production environments. It includes SSL auto-configuration with Let's Encrypt certificates, and the latest releases of PHP, Apache, and MariaDB on Linux. This application also includes phpMyAdmin, PHP main modules and Composer.", "isActive": true, "minPower": 0, "version": "8.2.18-4", "versionCode": "1", "productUrl": "https://aws.amazon.com/marketplace/pp/prodview-6g3gzfcih6dvu", "licenseUrl": "https://aws.amazon.com/marketplace/pp/prodview-6g3gzfcih6dvu#pdp-usage", "platform": "LINUX_UNIX" }, { "blueprintId": "nodejs", "name": "Node.js", "group": "node", "type": "app", "description": "Node.js packaged by Bitnami is a pre-configured, ready to run image for Node.js on Amazon EC2. It includes the latest version of Node.js, Apache, Python and Redis. The image supports multiple Node.js applications, each with its own virtual host and project directory. It is configured for production use and is secure by default, as all ports except HTTP, HTTPS and SSH ports are closed. Let's Encrypt SSL certificates are supported through an auto-configuration script. Developers benefit from instant access to a secure, update and consistent Node.js environment without having to manually install and configure multiple components and libraries.", "isActive": true, "minPower": 0, "version": "18.20.2-0", "versionCode": "1", "productUrl": "https://aws.amazon.com/marketplace/pp/B00NNZUAKO", "licenseUrl": "https://aws.amazon.com/marketplace/pp/B00NNZUAKO#pdp-usage", "platform": "LINUX_UNIX" }, ... } ] } ``` + Para ver detalhes da API, consulte [GetBlueprints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-blueprints.html) na *Referência de comandos da AWS CLI*. ### `get-bundles` O código de exemplo a seguir mostra como usar `get-bundles`. **AWS CLI** **Para obter os pacotes de novas instâncias** O exemplo `get-bundles` a seguir mostra detalhes sobre todos os pacotes disponíveis que podem ser usados para criar novas instâncias no Amazon Lightsail. ``` aws lightsail get-bundles ``` Resultado: ``` { "bundles": [ { "price": 5.0, "cpuCount": 2, "diskSizeInGb": 20, "bundleId": "nano_3_0", "instanceType": "nano", "isActive": true, "name": "Nano", "power": 298, "ramSizeInGb": 0.5, "transferPerMonthInGb": 1024, "supportedPlatforms": [ "LINUX_UNIX" ] }, { "price": 7.0, "cpuCount": 2, "diskSizeInGb": 40, "bundleId": "micro_3_0", "instanceType": "micro", "isActive": true, "name": "Micro", "power": 500, "ramSizeInGb": 1.0, "transferPerMonthInGb": 2048, "supportedPlatforms": [ "LINUX_UNIX" ] }, { "price": 12.0, "cpuCount": 2, "diskSizeInGb": 60, "bundleId": "small_3_0", "instanceType": "small", "isActive": true, "name": "Small", "power": 1000, "ramSizeInGb": 2.0, "transferPerMonthInGb": 3072, "supportedPlatforms": [ "LINUX_UNIX" ] }, ... } ] } ``` + Para ver detalhes da API, consulte [GetBundles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-bundles.html) na *Referência de comandos da AWS CLI*. ### `get-cloud-formation-stack-records` O código de exemplo a seguir mostra como usar `get-cloud-formation-stack-records`. **AWS CLI** **Para obter os registros da pilha do CloudFormation e suas pilhas associadas** O exemplo `get-cloud-formation-stack-records` a seguir exibe detalhes sobre os registros de pilha do CloudFormation e suas pilhas associadas usadas para criar recursos do Amazon EC2 com base nos snapshots do Amazon Lightsail exportados. ``` aws lightsail get-cloud-formation-stack-records ``` Resultado: ``` { "cloudFormationStackRecords": [ { "name": "CloudFormationStackRecord-588a4243-e2d1-490d-8200-3a7513ecebdf", "arn": "arn:aws:lightsail:us-west-2:111122223333:CloudFormationStackRecord/28d646ab-27bc-48d9-a422-1EXAMPLE6d37", "createdAt": 1565301666.586, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "resourceType": "CloudFormationStackRecord", "state": "Succeeded", "sourceInfo": [ { "resourceType": "ExportSnapshotRecord", "name": "ExportSnapshotRecord-e02f23d7-0453-4aa9-9c95-91aa01a141dd", "arn": "arn:aws:lightsail:us-west-2:111122223333:ExportSnapshotRecord/f12b8792-f3ea-4d6f-b547-2EXAMPLE8796" } ], "destinationInfo": { "id": "arn:aws:cloudformation:us-west-2:111122223333:stack/Lightsail-Stack-588a4243-e2d1-490d-8200-3EXAMPLEebdf/063203b0-ba28-11e9-838b-0EXAMPLE8b00", "service": "Aws::CloudFormation::Stack" } } ] } ``` + Para ver detalhes da API, consulte [GetCloudFormationStackRecords](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-cloud-formation-stack-records.html) na *Referência de comandos da AWS CLI*. ### `get-disk-snapshot` O código de exemplo a seguir mostra como usar `get-disk-snapshot`. **AWS CLI** **Para obter informações sobre um snapshot de disco** O exemplo `get-disk-snapshot` a seguir exibe detalhes sobre o snapshot do disco `Disk-1-1566839161`. ``` aws lightsail get-disk-snapshot \ --disk-snapshot-name Disk-1-1566839161 ``` Resultado: ``` { "diskSnapshot": { "name": "Disk-1-1566839161", "arn": "arn:aws:lightsail:us-west-2:111122223333:DiskSnapshot/e2d0fa53-8ee0-41a0-8e56-0EXAMPLE1051", "supportCode": "6EXAMPLE3362/snap-0EXAMPLE06100d09", "createdAt": 1566839163.749, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "resourceType": "DiskSnapshot", "tags": [], "sizeInGb": 8, "state": "completed", "progress": "100%", "fromDiskName": "Disk-1", "fromDiskArn": "arn:aws:lightsail:us-west-2:111122223333:Disk/c21cfb0a-07f2-44ae-9a23-bEXAMPLE8096", "isFromAutoSnapshot": false } } ``` Para obter mais informações, consulte *guia*. + Para ver detalhes da API, consulte [GetDiskSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-disk-snapshot.html) na * Referência do comando da AWS CLI*. ### `get-disk-snapshots` O código de exemplo a seguir mostra como usar `get-disk-snapshots`. **AWS CLI** **Para obter informações sobre todos os snapshots de disco** O exemplo `get-disk-snapshots` a seguir exibe detalhes sobre todos os snapshots de disco na região da AWS configurada. ``` aws lightsail get-disk-snapshots ``` Resultado: ``` { "diskSnapshots": [ { "name": "Disk-2-1571090588", "arn": "arn:aws:lightsail:us-west-2:111122223333:DiskSnapshot/32e889a9-38d4-4687-9f21-eEXAMPLE7839", "supportCode": "6EXAMPLE3362/snap-0EXAMPLE1ca192a4", "createdAt": 1571090591.226, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "resourceType": "DiskSnapshot", "tags": [], "sizeInGb": 8, "state": "completed", "progress": "100%", "fromDiskName": "Disk-2", "fromDiskArn": "arn:aws:lightsail:us-west-2:111122223333:Disk/6a343ff8-6341-422d-86e2-bEXAMPLE16c2", "isFromAutoSnapshot": false }, { "name": "Disk-1-1566839161", "arn": "arn:aws:lightsail:us-west-2:111122223333:DiskSnapshot/e2d0fa53-8ee0-41a0-8e56-0EXAMPLE1051", "supportCode": "6EXAMPLE3362/snap-0EXAMPLEe06100d09", "createdAt": 1566839163.749, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "resourceType": "DiskSnapshot", "tags": [], "sizeInGb": 8, "state": "completed", "progress": "100%", "fromDiskName": "Disk-1", "fromDiskArn": "arn:aws:lightsail:us-west-2:111122223333:Disk/c21cfb0a-07f2-44ae-9a23-bEXAMPLE8096", "isFromAutoSnapshot": false } ] } ``` + Para ver detalhes da API, consulte [GetDiskSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-disk-snapshots.html) na *Referência de comandos da AWS CLI*. ### `get-disk` O código de exemplo a seguir mostra como usar `get-disk`. **AWS CLI** **Para obter informações sobre um disco de armazenamento em bloco** O exemplo `get-disk` a seguir exibe detalhes sobre o disco `Disk-1`. ``` aws lightsail get-disk \ --disk-name Disk-1 ``` Resultado: ``` { "disk": { "name": "Disk-1", "arn": "arn:aws:lightsail:us-west-2:111122223333:Disk/c21cfb0a-07f2-44ae-9a23-bEXAMPLE8096", "supportCode": "6EXAMPLE3362/vol-0EXAMPLEf2f88b32f", "createdAt": 1566585439.587, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "resourceType": "Disk", "tags": [], "sizeInGb": 8, "isSystemDisk": false, "iops": 100, "path": "/dev/xvdf", "state": "in-use", "attachedTo": "WordPress_Multisite-1", "isAttached": true, "attachmentState": "attached" } } ``` Para obter mais informações, consulte *guia*. + Para ver detalhes da API, consulte [GetDisk](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-disk.html) na *Referência de comandos da AWS CLI*. ### `get-disks` O código de exemplo a seguir mostra como usar `get-disks`. **AWS CLI** **Para obter informações sobre todos os discos de armazenamento em bloco** O exemplo `get-disks` a seguir exibe detalhes sobre todos os discos na região da AWS configurada. ``` aws lightsail get-disks ``` Resultado: ``` { "disks": [ { "name": "Disk-2", "arn": "arn:aws:lightsail:us-west-2:111122223333:Disk/6a343ff8-6341-422d-86e2-bEXAMPLE16c2", "supportCode": "6EXAMPLE3362/vol-0EXAMPLE929602087", "createdAt": 1571090461.634, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "resourceType": "Disk", "tags": [], "sizeInGb": 8, "isSystemDisk": false, "iops": 100, "state": "available", "isAttached": false, "attachmentState": "detached" }, { "name": "Disk-1", "arn": "arn:aws:lightsail:us-west-2:111122223333:Disk/c21cfb0a-07f2-44ae-9a23-bEXAMPLE8096", "supportCode": "6EXAMPLE3362/vol-0EXAMPLEf2f88b32f", "createdAt": 1566585439.587, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "resourceType": "Disk", "tags": [], "sizeInGb": 8, "isSystemDisk": false, "iops": 100, "path": "/dev/xvdf", "state": "in-use", "attachedTo": "WordPress_Multisite-1", "isAttached": true, "attachmentState": "attached" } ] } ``` + Para ver detalhes da API, consulte [GetDisks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-disks.html) na *Referência de comandos da AWS CLI*. ### `get-domain` O código de exemplo a seguir mostra como usar `get-domain`. **AWS CLI** **Para obter informações sobre um domínio** O exemplo `get-domain` a seguir exibe detalhes sobre o domínio `example.com`. **Observação:** as operações de API relacionadas com o domínio do Lightsail estão disponíveis somente na região da AWS `us-east-1`. Se seu perfil de CLI estiver configurado para usar uma região diferente, é necessário incluir o parâmetro "--region us-east-1", ou o comando falhará. ``` aws lightsail get-domain \ --domain-name example.com \ --region us-east-1 ``` Resultado: ``` { "domain": { "name": "example.com", "arn": "arn:aws:lightsail:global:111122223333:Domain/28cda903-3f15-44b2-9baf-3EXAMPLEb304", "supportCode": "6EXAMPLE3362//hostedzone/ZEXAMPLEONGSC1", "createdAt": 1570728588.6, "location": { "availabilityZone": "all", "regionName": "global" }, "resourceType": "Domain", "tags": [], "domainEntries": [ { "id": "-1682899164", "name": "example.com", "target": "192.0.2.0", "isAlias": false, "type": "A" }, { "id": "1703104243", "name": "example.com", "target": "ns-137.awsdns-17.com", "isAlias": false, "type": "NS" }, { "id": "-1038331153", "name": "example.com", "target": "ns-1710.awsdns-21.co.uk", "isAlias": false, "type": "NS" }, { "id": "-2107289565", "name": "example.com", "target": "ns-692.awsdns-22.net", "isAlias": false, "type": "NS" }, { "id": "1582095705", "name": "example.com", "target": "ns-1436.awsdns-51.org", "isAlias": false, "type": "NS" }, { "id": "-1769796132", "name": "example.com", "target": "ns-1710.awsdns-21.co.uk. awsdns-hostmaster.amazon.com. 1 7200 900 1209600 86400", "isAlias": false, "type": "SOA" } ] } } ``` + Para ver detalhes da API, consulte [GetDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-domain.html) na *Referência de comandos da AWS CLI*. ### `get-domains` O código de exemplo a seguir mostra como usar `get-domains`. **AWS CLI** **Para obter informações sobre todos os domínios** O exemplo `get-domains` a seguir exibe detalhes sobre todos os domínios na região da AWS configurada. **Observação:** as operações de API relacionadas com o domínio do Lightsail estão disponíveis somente na região da AWS `us-east-1`. Se seu perfil de CLI estiver configurado para usar uma região diferente, é necessário incluir o parâmetro `--region us-east-1`, ou o comando falhará. ``` aws lightsail get-domains \ --region us-east-1 ``` Resultado: ``` { "domains": [ { "name": "example.com", "arn": "arn:aws:lightsail:global:111122223333:Domain/28cda903-3f15-44b2-9baf-3EXAMPLEb304", "supportCode": "6EXAMPLE3362//hostedzone/ZEXAMPLEONGSC1", "createdAt": 1570728588.6, "location": { "availabilityZone": "all", "regionName": "global" }, "resourceType": "Domain", "tags": [], "domainEntries": [ { "id": "-1682899164", "name": "example.com", "target": "192.0.2.0", "isAlias": false, "type": "A" }, { "id": "1703104243", "name": "example.com", "target": "ns-137.awsdns-17.com", "isAlias": false, "type": "NS" }, { "id": "-1038331153", "name": "example.com", "target": "ns-4567.awsdns-21.co.uk", "isAlias": false, "type": "NS" }, { "id": "-2107289565", "name": "example.com", "target": "ns-333.awsdns-22.net", "isAlias": false, "type": "NS" }, { "id": "1582095705", "name": "example.com", "target": "ns-1111.awsdns-51.org", "isAlias": false, "type": "NS" }, { "id": "-1769796132", "name": "example.com", "target": "ns-1234.awsdns-21.co.uk. awsdns-hostmaster.amazon.com. 1 7200 900 1209600 86400", "isAlias": false, "type": "SOA" }, { "id": "1029454894", "name": "_dead6a124ede046a0319eb44a4eb3cbc.example.com", "target": "_be133b0a0899fb7b6bf79d9741d1a383.hkvuiqjoua.acm-validations.aws", "isAlias": false, "type": "CNAME" } ] }, { "name": "example.net", "arn": "arn:aws:lightsail:global:111122223333:Domain/9c9f0d70-c92e-4753-86c2-6EXAMPLE029d", "supportCode": "6EXAMPLE3362//hostedzone/ZEXAMPLE5TPKMV", "createdAt": 1556661071.384, "location": { "availabilityZone": "all", "regionName": "global" }, "resourceType": "Domain", "tags": [], "domainEntries": [ { "id": "-766320943", "name": "example.net", "target": "192.0.2.2", "isAlias": false, "type": "A" }, { "id": "-453913825", "name": "example.net", "target": "ns-123.awsdns-10.net", "isAlias": false, "type": "NS" }, { "id": "1553601564", "name": "example.net", "target": "ns-4444.awsdns-47.co.uk", "isAlias": false, "type": "NS" }, { "id": "1653797661", "name": "example.net", "target": "ns-7890.awsdns-61.org", "isAlias": false, "type": "NS" }, { "id": "706414698", "name": "example.net", "target": "ns-123.awsdns-44.com", "isAlias": false, "type": "NS" }, { "id": "337271745", "name": "example.net", "target": "ns-4444.awsdns-47.co.uk. awsdns-hostmaster.amazon.com. 1 7200 900 1209600 86400", "isAlias": false, "type": "SOA" }, { "id": "-1785431096", "name": "www.example.net", "target": "192.0.2.2", "isAlias": false, "type": "A" } ] }, { "name": "example.org", "arn": "arn:aws:lightsail:global:111122223333:Domain/f0f13ba3-3df0-4fdc-8ebb-1EXAMPLEf26e", "supportCode": "6EXAMPLE3362//hostedzone/ZEXAMPLEAFO38", "createdAt": 1556661199.106, "location": { "availabilityZone": "all", "regionName": "global" }, "resourceType": "Domain", "tags": [], "domainEntries": [ { "id": "2065301345", "name": "example.org", "target": "192.0.2.4", "isAlias": false, "type": "A" }, { "id": "-447198516", "name": "example.org", "target": "ns-123.awsdns-45.com", "isAlias": false, "type": "NS" }, { "id": "136463022", "name": "example.org", "target": "ns-9999.awsdns-15.co.uk", "isAlias": false, "type": "NS" }, { "id": "1395941679", "name": "example.org", "target": "ns-555.awsdns-01.net", "isAlias": false, "type": "NS" }, { "id": "872052569", "name": "example.org", "target": "ns-6543.awsdns-38.org", "isAlias": false, "type": "NS" }, { "id": "1001949377", "name": "example.org", "target": "ns-1234.awsdns-15.co.uk. awsdns-hostmaster.amazon.com. 1 7200 900 1209600 86400", "isAlias": false, "type": "SOA" }, { "id": "1046191192", "name": "www.example.org", "target": "192.0.2.4", "isAlias": false, "type": "A" } ] } ] } ``` + Para ver detalhes da API, consulte [GetDomains](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-domains.html) na *Referência de comandos da AWS CLI*. ### `get-export-snapshot-record` O código de exemplo a seguir mostra como usar `get-export-snapshot-record`. **AWS CLI** **Para obter os registros dos snapshots exportados para o Amazon EC2** O exemplo `get-export-snapshot-record` a seguir exibe detalhes sobre snapshots de instância ou disco do Amazon Lightsail exportados para o Amazon EC2. ``` aws lightsail get-export-snapshot-records ``` Resultado: ``` { "exportSnapshotRecords": [ { "name": "ExportSnapshotRecord-d2da10ce-0b3c-4ae1-ab3a-2EXAMPLEa586", "arn": "arn:aws:lightsail:us-west-2:111122223333:ExportSnapshotRecord/076c7060-b0cc-4162-98f0-2EXAMPLEe28e", "createdAt": 1543534665.678, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "resourceType": "ExportSnapshotRecord", "state": "Succeeded", "sourceInfo": { "resourceType": "InstanceSnapshot", "createdAt": 1540339310.706, "name": "WordPress-512MB-Oregon-1-1540339219", "arn": "arn:aws:lightsail:us-west-2:111122223333:InstanceSnapshot/5446f534-ed60-4c17-b4a5-bEXAMPLEf8b7", "fromResourceName": "WordPress-512MB-Oregon-1", "fromResourceArn": "arn:aws:lightsail:us-west-2:111122223333:Instance/4b8f1f24-e4d1-4cf3-88ff-cEXAMPLEa397", "instanceSnapshotInfo": { "fromBundleId": "nano_2_0", "fromBlueprintId": "wordpress_4_9_8", "fromDiskInfo": [ { "path": "/dev/sda1", "sizeInGb": 20, "isSystemDisk": true } ] } }, "destinationInfo": { "id": "ami-0EXAMPLEc0d65058e", "service": "Aws::EC2::Image" } }, { "name": "ExportSnapshotRecord-1c94e884-40ff-4fe1-9302-0EXAMPLE14c2", "arn": "arn:aws:lightsail:us-west-2:111122223333:ExportSnapshotRecord/fb392ce8-6567-4013-9bfd-3EXAMPLE5b4c", "createdAt": 1543432110.2, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "resourceType": "ExportSnapshotRecord", "state": "Succeeded", "sourceInfo": { "resourceType": "InstanceSnapshot", "createdAt": 1540833603.545, "name": "LAMP_PHP_5-512MB-Oregon-1-1540833565", "arn": "arn:aws:lightsail:us-west-2:111122223333:InstanceSnapshot/82334399-b5f2-49ec-8382-0EXAMPLEe45f", "fromResourceName": "LAMP_PHP_5-512MB-Oregon-1", "fromResourceArn": "arn:aws:lightsail:us-west-2:111122223333:Instance/863b9f35-ab1e-4418-bdd2-1EXAMPLEbab2", "instanceSnapshotInfo": { "fromBundleId": "nano_2_0", "fromBlueprintId": "lamp_5_6_37_2", "fromDiskInfo": [ { "path": "/dev/sda1", "sizeInGb": 20, "isSystemDisk": true } ] } }, "destinationInfo": { "id": "ami-0EXAMPLE7c5ec84e2", "service": "Aws::EC2::Image" } } ] } ``` + Para ver detalhes da API, consulte [GetExportSnapshotRecord](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-export-snapshot-record.html) na *Referência de comandos da AWS CLI*. ### `get-instance-access-details` O código de exemplo a seguir mostra como usar `get-instance-access-details`. **AWS CLI** **Para obter informações sobre a chave do host de uma instância** O exemplo `get-instance-access-details` a seguir exibe as informações sobre a chave do host por instância `WordPress_Multisite-1`. ``` aws lightsail get-instance-access-details \ --instance-name WordPress_Multisite-1 ``` Resultado: ``` { "accessDetails": { "certKey": "ssh-rsa-cert-v01@openssh.com AEXAMPLEaC1yc2EtY2VydC12MDFAb3BlbnNzaC5jb20AAAAgNf076Dt3ppmPd0fPxZVMmS491aEAYYH9cHqAJ3fNML8AAAADAQABAAABAQD4APep5Ta2gHLk7m/vEXAMPLE2eBWJyQvn7ol/i0+s966h5sx8qUD79lPB7q5UESd5VZGFtytrykfQJnjiwqe7EV5agzvjblLj26Fb37EKda9HVfCOu8pWbvky7Tyn9w299a6CsG5o8HrkOymDE2c59lYxXGkilKo5I9aZLBAdXn3t3oKtq9zsjYGjyEmarPYoVDT1ft8HaUGu4aCv1peI0+ZEXAMPLEAWaucW9Huh0WYN5yrmL252c4v13JTVmytaEZvLvt5itVoWXQY0ZDyrLUcZSKxyq5n00Mgvj2fiZdt+xMfQM9xVz0rXZmqx8uJidJpRgLCMTviofwQJU/K1EXAMPLEAAAAAAAABAAAALS00MzMzMDU4MzA4ODg1MTY2NjM4Onp6UWlndHk4UElRSG9STitOTG5QSEE9PQAAAAsAAAAHYml0bmFtaQAAAABdpPL7AAEXAMPLEgcAAAAAAAAAggAAABVwZXJtaXQtWDExLWZvcndhcmRpbmcAAAAAAAAAF3Blcm1pdC1hZ2VudC1mb3J3YXJkaW5nAAAAAAAAABZwZXJtaXQtEXAMPLEmb3J3YXJkaW5nAAAAAAAAAApwZXJtaXQtcHR5AAAAAAAAAA5wZXJtaXQtdXNlci1yYwAAAAAAAAAAAAACFwAAAAdzc2gtcnNhAAAAAwEAAQEXAMPLECqCbiK9b450HtRD1ZpiksT6oxc8U7nLNkVFC1j7JqZvP9ee3ux+LiB+ozNbUA0cdNL9Y67x7qPv/R7XhTc21+2A+8+GuVpK/Kz9dqDMKNAEXAMPLE+YYN+tiXm7Y8OgziK+7iDB7xUuQ4vghmn4+qgz9mKwYgWvVe2+0XLuV7cnWPB7iUlHQg+E3LUKrV4ZFw9pj7X2dFdNKfMxwWgI1ISWKimEXAMPLEeHjrf1Rqc/QH6TpWCvPfcx8uvwVqdwTfkE/SfA5BCzbGGI1UmIUadh8nHcb5FamQ1hK7kECy47K/x9FMn/KwmM7pCwJbSLDMO7n9bnbvck6m8ZoB2N2YLMG5dW7BerEXAMPLEobqfdtyYJHHel1EyyEJs1fWNU3D5JIGlgzcPAV+ZlbQyUCZXf0oslSa+HE85fO/FRq9SVSBSHrmbeb0frlPhgMzgSmqLeyhlbr6wwWIDbREXAMPLEJZ49H7RdQxdKyYrZPWvRgcr0qI2EL0tAajnpQQ8UZqeO9/Aqter0xN5PhFL0J49OWTacwCGRAjLhibAx7K1t/1ZXWo6c+ijq8clll327EXAMPLE/e89GC89KcmKCxfGQniDAUgF8UqofIbq3ZOUgiAAYCVXclI4L68NhVXyoWuQXPBRQSEXAMPLEWm74tDL9tFN3c7tSe/Oz0cTR+4sAAAIPAAAAB3NzaC1yc2EAAAIAQnG/L0DqiSnLrWhEox4aHqMgd0m0oLLAYx6OQH9F0TM9EXAMPLE961rzSCMon7ZgsWNnL0OwZQgDG+rtJ4N0B7HOVwns4ynUFbzNQ3qFGGeE3lKwX1L41vV1iSy7sDk8aI0LmrKJi1LE1Qc1l8uboRlwoXOYEXAMPLEaUCeX+10+WEXAMPLEg6Y4U4ZvE2B3xyRdpvysb5TGFNtk5qPslacnVkoLOGsZZXMpLGJnG4OBpQLLtpj9sNMxAgZPCAUjhkqkQWYJxJzvFN7sUMOArUwKPFJE2kaEXAMPLEOUrVGBbCTioRztlPsxY7hoXm73N929eZpNhxP3U+nxO9O4NUZ2pTWbVSUaV1gm6pug9xbwNO1Im21t34JeLlKTqxcJ6zzS8W0c0KKpAm5c4hWkseMbyutS2jav/4hiS+BhrYgptzfwe5qRXEXAMPLEHZQr3YfGzYoBJ/lLK3NHhxOihhsfAYwMei0BFZT1F/7CT3IH4iitEkIgodi06/Mw6UDqMPozyQCK1lEA6LFhYCOZG9drWcoRa74lM4kY9TP028Za8gDMh1WpkXLq9Gixon5OHP8aM/sEXAMPLEr2+fnkw+1BtoO5L6+VKoPlXaGqZ/fBYEXAMPLEAMQHjnLM1JYNvtEEPhp+TNzXHzuixWf/Ht04m0AVpXrzIDXaS1O2tXY=", "ipAddress": "192.0.2.0", "privateKey": "-----BEGIN RSA PRIVATE KEY-----\nEXAMPLEBAAKCAQEA+AD3qeU2toBy5O5v7wnRLVo/tngVickL5+6Jf4tPrPeuoebM\nfKlA+/ZTwe6uVBEneVWRhbcra8pH0CZ44sKnuxFeWoM7425S49uhW9+xCnWvR1Xw\njrvKVm75Mu08p/cNvfWugrBuaPB65DspgxNnOfZWMVxpIpSqOSPWmSwQHV597d6C\nrEXAMPLEo8hJmqz2KFQ09X7fB2lBruGgr9aXiNPmWmovYKqwFmrnFvR7odFmDecq\n5EXAMPLE9dyU1ZsrWhGby77eYrVaFl0GNGQ8qy1HGUiscquZ9NDIL49n4mXbfsTH\n0EXAMPLE12ZqsfLiYnSaUYCwjE74qH8ECVPytQIDAQABAoIBAHeZV9Z58JHAjifz\nCEXAMPLEEqC3doOVDgXSlkKI92qNo4z2VcUEho878paCuVVXVHcCGgSnGeyIh2tN\nMEXAMPLESohR427BhH3YLA+3Z5SIvnejbTgYPfLC37B8khTaYqkqMvdZiFVZK5qn\nIEXAMPLEM93oF9eSZCjcLKB/jGHsfb0eCDMP8BshHE2beuqzVMoK1DxOnvoP3+Fp\nAEXAMPLESq6pDpCo9YVUX8g1u3Ro9cPl2LXHDy+oVEY5KhbZQJ7VU1I72WOvppWW\nOEXAMPLEkgYlq7p6qYtYcSgTEjz14gDiMfQ7SyHB3alkIoNONQ9ZPaWHyJvymeud\noQTNuz0CgYEA/LFWNTEZrzdzdR1kJmyNRmAermU0B6utyNENChAlHGSHkB+1lVSh\nbEXAMPLEQo9ooUeW5UxO3YwacZLoDT1mwxw1Ptc1+PNycZoLe1fE9UdARrdmGTob\n8l7CPLSXp3xuR8VqSp2fnIc7hfiQs/NrPX9gm/EOrB0we0RKyDSzWScCgYEA+z/r\niob+nJZq0YbnOSuP6oMULP4vnWniWj8MIhUJU53LwSAM8DeJdONKDdkuiOd52aAL\nVgn7nLo88rVWKhJwVc4tu/rNgZLcR3bP4+kL6zand0KQnMLyOzNA2Ys26aa5udH1\nqWl0WTt9WEm/h10ndC1knOMectrvsG17b38y5sMCgYEA54NiRGGz8oCPW6GN/FZA\nKEXAMPLE5tw34GEH3Uxlc9n3CejDaQmczOATwX4nIwRZDEqWyYZcS0btg1jhGiBD\nYEXAMPLEkc8Z71L/agZEAaVCEog9FqfSqwB+XTfoKh8qur74X1yCu9p6gof1q6k9\neEXAMPLEchJcNNOg4ETIfMkCgYBdVORRhE4mqvWpOdzA7v66FdEz2YSkjAXKkmsW\naEXAMPLE8Z/8yBSmuBv1Qv03XA12my462uB92uzzGAuW+1yBc2Kn1sXqYTy0y1z0\ngEXAMPLEBogjw4MqHKL1bPKMHyQU8/q24PaYgzHPzy13wlH6pTYf1XqlHdE2D6Vv\nyEXAMPLEgQC3i/kVVhky/2XRwRVlC7JO2Bg3QGTx38hpmDa5IuofKANjA+Wa3/zy\nbEXAMPLE6ytQgD9GN/YtBq+uhO+2ZkvXPL+CWRi0ZRXpPwYDBBFU9Cw0AuWWGlL8\nwEXAMPLExMlcysRgcWB9RNgf3AuOpFd2i6XT/riNsvvkpmJ+VooU8g==\n-----END RSA PRIVATE KEY-----\n", "protocol": "ssh", "instanceName": "WordPress_Multisite-1", "username": "bitnami", "hostKeys": [ { "algorithm": "ssh-rsa", "publicKey": "AEXAMPLEaC1yc2EAAAADAQABAAABAQCoeR9ieZTjQ3pXCHczuAYZFjlF7t+uBkXuqeGMRex78pCvmS+DiEXAMPLEuJ1Q8dcKhrQL4HpXbD9dosVCTaJnJwb4MQqsuSVFdHFzy3guP+BKclWqtxJEXAMPLEsBGqZZlrIv6a9bTA0TCplZ8AD+hSRTaSXXqg6FT+Qf16IktH0XlMs7xIEXAMPLEmNtjCpzZiGXDHzytoMvUgwa8uHPp44Og36EUu4VqQxoUHPJKoXvcQizyk3K8ym0hP0TpDZhD8cqwRfd6EHp4Q1br/Ot6y9HwvykEXAMPLEAfbKjbR42+u6+OSlkr4d339q2U1sTDytJhhs8HUel1wTfGRfp", "witnessedAt": 1570744377.699, "fingerprintSHA1": "SHA1:GEXAMPLEMoYgUg0ucadqU9Bt3Lk", "fingerprintSHA256": "SHA256:IEXAMPLEcB5vgxnAUoJawbdZ+MwELhIp6FUxuwq/LIU" }, { "algorithm": "ssh-ed25519", "publicKey": "AEXAMPLEaC1lZDI1NTE5AAAAIC1gwGPDfGaONxEXAMPLEJX3UNap781QxHQmn8nzlrUv", "witnessedAt": 1570744377.697, "fingerprintSHA1": "SHA1:VEXAMPLE5ReqSmTgv03sSUw9toU", "fingerprintSHA256": "SHA256:0EXAMPLEdE6tI95k3TJpG+qhJbAoknB0yz9nAEaDt3A" }, { "algorithm": "ecdsa-sha2-nistp256", "publicKey": "AEXAMPLEZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABEXAMPLE9B4mZy8YSsZW7cixCDq5yHSAAxjJkDo54C+EnKlDCsYtUkxxEXAMPLE6VOWL2z63RTKa2AUPgd8irjxWI=", "witnessedAt": 1570744377.707, "fingerprintSHA1": "SHA1:UEXAMPLEOYCfXsCf2G6tDg+7YG0", "fingerprintSHA256": "SHA256:wEXAMPLEQ9a/iEXAMPLEhRufm6U9vFU4cpkMPHnBsNA" } ] } } ``` + Para ver detalhes da API, consulte [GetInstanceAccessDetails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-instance-access-details.html) na *Referência de comandos da AWS CLI*. ### `get-instance-metric-data` O código de exemplo a seguir mostra como usar `get-instance-metric-data`. **AWS CLI** **Para obter dados métricos de uma instância** O exemplo `get-instance-metric-data` a seguir retorna a porcentagem média de `CPUUtilization` a cada `7200` segundos (2 horas) entre `1571342400` e `1571428800` para a instância `MEAN-1`. Recomenda-se o uso de um conversor de horário unix para identificar os horários de início e término. ``` aws lightsail get-instance-metric-data \ --instance-name MEAN-1 \ --metric-name CPUUtilization \ --period 7200 \ --start-time 1571342400 \ --end-time 1571428800 \ --unit Percent \ --statistics Average ``` Resultado: ``` { "metricName": "CPUUtilization", "metricData": [ { "average": 0.26113718770120725, "timestamp": 1571342400.0, "unit": "Percent" }, { "average": 0.26861268928111953, "timestamp": 1571392800.0, "unit": "Percent" }, { "average": 0.28187475104748777, "timestamp": 1571378400.0, "unit": "Percent" }, { "average": 0.2651936960458352, "timestamp": 1571421600.0, "unit": "Percent" }, { "average": 0.2561856213712188, "timestamp": 1571371200.0, "unit": "Percent" }, { "average": 0.3021383254607764, "timestamp": 1571356800.0, "unit": "Percent" }, { "average": 0.2618381649223539, "timestamp": 1571407200.0, "unit": "Percent" }, { "average": 0.26331929394825787, "timestamp": 1571400000.0, "unit": "Percent" }, { "average": 0.2576348407007818, "timestamp": 1571385600.0, "unit": "Percent" }, { "average": 0.2513008454658378, "timestamp": 1571364000.0, "unit": "Percent" }, { "average": 0.26329974562758346, "timestamp": 1571414400.0, "unit": "Percent" }, { "average": 0.2667092536656445, "timestamp": 1571349600.0, "unit": "Percent" } ] } ``` + Para ver detalhes da API, consulte [GetInstanceMetricData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-instance-metric-data.html) na *Referência de comandos da AWS CLI*. ### `get-instance-port-states` O código de exemplo a seguir mostra como usar `get-instance-port-states`. **AWS CLI** **Para obter informações sobre o firewall em uma instância** O exemplo `get-instance-port-states` a seguir retorna as portas de firewall configuradas para a instância `MEAN-1`. ``` aws lightsail get-instance-port-states \ --instance-name MEAN-1 ``` Resultado: ``` { "portStates": [ { "fromPort": 80, "toPort": 80, "protocol": "tcp", "state": "open" }, { "fromPort": 22, "toPort": 22, "protocol": "tcp", "state": "open" }, { "fromPort": 443, "toPort": 443, "protocol": "tcp", "state": "open" } ] } ``` + Para ver detalhes da API, consulte [GetInstancePortStates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-instance-port-states.html) na *Referência de comandos da AWS CLI*. ### `get-instance-snapshot` O código de exemplo a seguir mostra como usar `get-instance-snapshot`. **AWS CLI** **Para obter informações sobre um snapshot de instância específico** O exemplo `get-instance-snapshot` a seguir exibe os detalhes do snapshot da instância especificada. ``` aws lightsail get-instance-snapshot \ --instance-snapshot-name MEAN-1-1571419854 ``` Resultado: ``` { "instanceSnapshot": { "name": "MEAN-1-1571419854", "arn": "arn:aws:lightsail:us-west-2:111122223333:InstanceSnapshot/ac54700c-48a8-40fd-b065-2EXAMPLEac8f", "supportCode": "6EXAMPLE3362/ami-0EXAMPLE67a73020d", "createdAt": 1571419891.927, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "resourceType": "InstanceSnapshot", "tags": [], "state": "available", "fromAttachedDisks": [], "fromInstanceName": "MEAN-1", "fromInstanceArn": "arn:aws:lightsail:us-west-2:111122223333:Instance/bd470fc5-a68b-44c5-8dbc-8EXAMPLEbada", "fromBlueprintId": "mean", "fromBundleId": "medium_3_0", "isFromAutoSnapshot": false, "sizeInGb": 80 } } ``` + Para ver detalhes da API, consulte [GetInstanceSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-instance-snapshot.html) na *Referência de comandos da AWS CLI*. ### `get-instance-snapshots` O código de exemplo a seguir mostra como usar `get-instance-snapshots`. **AWS CLI** **Para obter informações sobre todos os snapshots da sua instância** O exemplo `get-instance-snapshots` a seguir exibe detalhes sobre todos os snapshots da instância na região da AWS configurada. ``` aws lightsail get-instance-snapshots ``` Resultado: ``` { "instanceSnapshots": [ { "name": "MEAN-1-1571421498", "arn": "arn:aws:lightsail:us-west-2:111122223333:InstanceSnapshot/a20e6ebe-b0ee-4ae4-a750-3EXAMPLEcb0c", "supportCode": "6EXAMPLE3362/ami-0EXAMPLEe33cabfa1", "createdAt": 1571421527.755, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "resourceType": "InstanceSnapshot", "tags": [ { "key": "no_delete" } ], "state": "available", "fromAttachedDisks": [], "fromInstanceName": "MEAN-1", "fromInstanceArn": "arn:aws:lightsail:us-west-2:111122223333:Instance/1761aa0a-6038-4f25-8b94-2EXAMPLE19fd", "fromBlueprintId": "wordpress", "fromBundleId": "micro_3_0", "isFromAutoSnapshot": false, "sizeInGb": 40 }, { "name": "MEAN-1-1571419854", "arn": "arn:aws:lightsail:us-west-2:111122223333:InstanceSnapshot/ac54700c-48a8-40fd-b065-2EXAMPLEac8f", "supportCode": "6EXAMPLE3362/ami-0EXAMPLE67a73020d", "createdAt": 1571419891.927, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "resourceType": "InstanceSnapshot", "tags": [], "state": "available", "fromAttachedDisks": [], "fromInstanceName": "MEAN-1", "fromInstanceArn": "arn:aws:lightsail:us-west-2:111122223333:Instance/bd470fc5-a68b-44c5-8dbc-8EXAMPLEbada", "fromBlueprintId": "mean", "fromBundleId": "medium_3_0", "isFromAutoSnapshot": false, "sizeInGb": 80 } ] } ``` + Para ver detalhes da API, consulte [GetInstanceSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-instance-snapshots.html) na *Referência de comandos da AWS CLI*. ### `get-instance-state` O código de exemplo a seguir mostra como usar `get-instance-state`. **AWS CLI** **Para obter informações sobre o estado de uma instância** O exemplo `get-instance-state` a seguir retorna o estado da instância de banco especificada. ``` aws lightsail get-instance-state \ --instance-name MEAN-1 ``` Resultado: ``` { "state": { "code": 16, "name": "running" } } ``` + Para ver detalhes da API, consulte [GetInstanceState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-instance-state.html) na *Referência de comandos da AWS CLI*. ### `get-instance` O código de exemplo a seguir mostra como usar `get-instance`. **AWS CLI** **Para obter informações sobre uma instância** O exemplo `get-instance` a seguir exibe detalhes sobre a instância `MEAN-1`. ``` aws lightsail get-instance \ --instance-name MEAN-1 ``` Resultado: ``` { "instance": { "name": "MEAN-1", "arn": "arn:aws:lightsail:us-west-2:111122223333:Instance/bd470fc5-a68b-44c5-8dbc-EXAMPLE4bada", "supportCode": "6EXAMPLE3362/i-05EXAMPLE407c97d3", "createdAt": 1570635023.124, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "resourceType": "Instance", "tags": [], "blueprintId": "mean", "blueprintName": "MEAN", "bundleId": "medium_3_0", "isStaticIp": false, "privateIpAddress": "192.0.2.0", "publicIpAddress": "192.0.2.0", "hardware": { "cpuCount": 2, "disks": [ { "createdAt": 1570635023.124, "sizeInGb": 80, "isSystemDisk": true, "iops": 240, "path": "/dev/xvda", "attachedTo": "MEAN-1", "attachmentState": "attached" } ], "ramSizeInGb": 4.0 }, "networking": { "monthlyTransfer": { "gbPerMonthAllocated": 4096 }, "ports": [ { "fromPort": 80, "toPort": 80, "protocol": "tcp", "accessFrom": "Anywhere (0.0.0.0/0)", "accessType": "public", "commonName": "", "accessDirection": "inbound" }, { "fromPort": 22, "toPort": 22, "protocol": "tcp", "accessFrom": "Anywhere (0.0.0.0/0)", "accessType": "public", "commonName": "", "accessDirection": "inbound" }, { "fromPort": 443, "toPort": 443, "protocol": "tcp", "accessFrom": "Anywhere (0.0.0.0/0)", "accessType": "public", "commonName": "", "accessDirection": "inbound" } ] }, "state": { "code": 16, "name": "running" }, "username": "bitnami", "sshKeyName": "MyKey" } } ``` + Para ver detalhes da API, consulte [GetInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-instance.html) na *Referência de comandos da AWS CLI*. ### `get-instances` O código de exemplo a seguir mostra como usar `get-instances`. **AWS CLI** **Para obter informações sobre todas as instâncias** O exemplo `get-instances` a seguir exibe detalhes sobre todas as instâncias na região da AWS configurada. ``` aws lightsail get-instances ``` Resultado: ``` { "instances": [ { "name": "Windows_Server_2022-1", "arn": "arn:aws:lightsail:us-west-2:111122223333:Instance/0f44fbb9-8f55-4e47-a25e-EXAMPLE04763", "supportCode": "62EXAMPLE362/i-0bEXAMPLE71a686b9", "createdAt": 1571332358.665, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "resourceType": "Instance", "tags": [], "blueprintId": "windows_server_2022", "blueprintName": "Windows Server 2022", "bundleId": "large_win_3_0", "isStaticIp": false, "privateIpAddress": "192.0.2.0", "publicIpAddress": "192.0.2.0", "hardware": { "cpuCount": 1, "disks": [ { "createdAt": 1571332358.665, "sizeInGb": 160, "isSystemDisk": true, "iops": 180, "path": "/dev/sda1", "attachedTo": "Windows_Server_2022-1", "attachmentState": "attached" }, { "name": "my-disk-for-windows-server", "arn": "arn:aws:lightsail:us-west-2:111122223333:Disk/4123a81c-484c-49ea-afea-5EXAMPLEda87", "supportCode": "6EXAMPLE3362/vol-0EXAMPLEb2b99ca3d", "createdAt": 1571355063.494, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "resourceType": "Disk", "tags": [], "sizeInGb": 128, "isSystemDisk": false, "iops": 384, "path": "/dev/xvdf", "state": "in-use", "attachedTo": "Windows_Server_2022-1", "isAttached": true, "attachmentState": "attached" } ], "ramSizeInGb": 8.0 }, "networking": { "monthlyTransfer": { "gbPerMonthAllocated": 3072 }, "ports": [ { "fromPort": 80, "toPort": 80, "protocol": "tcp", "accessFrom": "Anywhere (0.0.0.0/0)", "accessType": "public", "commonName": "", "accessDirection": "inbound" }, { "fromPort": 22, "toPort": 22, "protocol": "tcp", "accessFrom": "Anywhere (0.0.0.0/0)", "accessType": "public", "commonName": "", "accessDirection": "inbound" }, { "fromPort": 3389, "toPort": 3389, "protocol": "tcp", "accessFrom": "Anywhere (0.0.0.0/0)", "accessType": "public", "commonName": "", "accessDirection": "inbound" } ] }, "state": { "code": 16, "name": "running" }, "username": "Administrator", "sshKeyName": "LightsailDefaultKeyPair" }, { "name": "MEAN-1", "arn": "arn:aws:lightsail:us-west-2:111122223333:Instance/bd470fc5-a68b-44c5-8dbc-8EXAMPLEbada", "supportCode": "6EXAMPLE3362/i-0EXAMPLEa407c97d3", "createdAt": 1570635023.124, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "resourceType": "Instance", "tags": [], "blueprintId": "mean", "blueprintName": "MEAN", "bundleId": "medium_3_0", "isStaticIp": false, "privateIpAddress": "192.0.2.0", "publicIpAddress": "192.0.2.0", "hardware": { "cpuCount": 2, "disks": [ { "name": "Disk-1", "arn": "arn:aws:lightsail:us-west-2:111122223333:Disk/c21cfb0a-07f2-44ae-9a23-bEXAMPLE8096", "supportCode": "6EXAMPLE3362/vol-0EXAMPLEf2f88b32f", "createdAt": 1566585439.587, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "resourceType": "Disk", "tags": [ { "key": "test" } ], "sizeInGb": 8, "isSystemDisk": false, "iops": 240, "path": "/dev/xvdf", "state": "in-use", "attachedTo": "MEAN-1", "isAttached": true, "attachmentState": "attached" }, { "createdAt": 1570635023.124, "sizeInGb": 80, "isSystemDisk": true, "iops": 240, "path": "/dev/sda1", "attachedTo": "MEAN-1", "attachmentState": "attached" } ], "ramSizeInGb": 4.0 }, "networking": { "monthlyTransfer": { "gbPerMonthAllocated": 4096 }, "ports": [ { "fromPort": 80, "toPort": 80, "protocol": "tcp", "accessFrom": "Anywhere (0.0.0.0/0)", "accessType": "public", "commonName": "", "accessDirection": "inbound" }, { "fromPort": 22, "toPort": 22, "protocol": "tcp", "accessFrom": "Anywhere (0.0.0.0/0)", "accessType": "public", "commonName": "", "accessDirection": "inbound" }, { "fromPort": 443, "toPort": 443, "protocol": "tcp", "accessFrom": "Anywhere (0.0.0.0/0)", "accessType": "public", "commonName": "", "accessDirection": "inbound" } ] }, "state": { "code": 16, "name": "running" }, "username": "bitnami", "sshKeyName": "MyTestKey" } ] } ``` + Para ver detalhes da API, consulte [GetInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-instances.html) na *Referência de comandos da AWS CLI*. ### `get-key-pair` O código de exemplo a seguir mostra como usar `get-key-pair`. **AWS CLI** **Para obter informações sobre um par de chaves** O exemplo `get-key-pair` a seguir exibe os detalhes sobre o par de chaves especificado. ``` aws lightsail get-key-pair \ --key-pair-name MyKey1 ``` Resultado: ``` { "keyPair": { "name": "MyKey1", "arn": "arn:aws:lightsail:us-west-2:111122223333:KeyPair/19a4efdf-3054-43d6-91fd-eEXAMPLE21bf", "supportCode": "6EXAMPLE3362/MyKey1", "createdAt": 1571255026.975, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "resourceType": "KeyPair", "tags": [], "fingerprint": "00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:gg:hh:ii:jj" } } ``` + Para ver detalhes da API, consulte [GetKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-key-pair.html) na *Referência de comandos da AWS CLI*. ### `get-key-pairs` O código de exemplo a seguir mostra como usar `get-key-pairs`. **AWS CLI** **Para obter informações sobre todos os pares de chaves** O exemplo `get-key-pairs` a seguir exibe detalhes sobre todos os pares de chaves na região da AWS configurada. ``` aws lightsail get-key-pairs ``` Resultado: ``` { "keyPairs": [ { "name": "MyKey1", "arn": "arn:aws:lightsail:us-west-2:111122223333:KeyPair/19a4efdf-3054-43d6-91fd-eEXAMPLE21bf", "supportCode": "6EXAMPLE3362/MyKey1", "createdAt": 1571255026.975, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "resourceType": "KeyPair", "tags": [], "fingerprint": "00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:gg:hh:ii:jj" } ] } ``` + Para ver detalhes da API, consulte [GetKeyPairs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-key-pairs.html) na *Referência de comandos da AWS CLI*. ### `get-load-balancer-tls-certificates` O código de exemplo a seguir mostra como usar `get-load-balancer-tls-certificates`. **AWS CLI** **Para obter informações sobre os certificados TLS de um balanceador de carga** O exemplo `get-load-balancer-tls-certificates` a seguir exibe os detalhes dos certificados TLS do balanceador de carga especificado. ``` aws lightsail get-load-balancer-tls-certificates \ --load-balancer-name LoadBalancer-1 ``` Resultado: ``` { "tlsCertificates": [ { "name": "example-com", "arn": "arn:aws:lightsail:us-west-2:111122223333:LoadBalancerTlsCertificate/d7bf4643-6a02-4cd4-b3c4-fEXAMPLE9b4d", "supportCode": "6EXAMPLE3362/arn:aws:acm:us-west-2:333322221111:certificate/9af8e32c-a54e-4a67-8c63-cEXAMPLEb314", "createdAt": 1571678025.3, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "resourceType": "LoadBalancerTlsCertificate", "loadBalancerName": "LoadBalancer-1", "isAttached": false, "status": "ISSUED", "domainName": "example.com", "domainValidationRecords": [ { "name": "_dEXAMPLE4ede046a0319eb44a4eb3cbc.example.com.", "type": "CNAME", "value": "_bEXAMPLE0899fb7b6bf79d9741d1a383.hkvuiqjoua.acm-validations.aws.", "validationStatus": "SUCCESS", "domainName": "example.com" } ], "issuedAt": 1571678070.0, "issuer": "Amazon", "keyAlgorithm": "RSA-2048", "notAfter": 1605960000.0, "notBefore": 1571616000.0, "serial": "00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff", "signatureAlgorithm": "SHA256WITHRSA", "subject": "CN=example.com", "subjectAlternativeNames": [ "example.com" ] } ] } ``` + Para ver detalhes da API, consulte [GetLoadBalancerTlsCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-load-balancer-tls-certificates.html) na *Referência de comandos da AWS CLI*. ### `get-load-balancer` O código de exemplo a seguir mostra como usar `get-load-balancer`. **AWS CLI** **Para obter informações sobre um balanceador de carga** O exemplo `get-load-balancer` a seguir exibe os detalhes do balanceador de carga especificado. ``` aws lightsail get-load-balancer \ --load-balancer-name LoadBalancer-1 ``` Resultado: ``` { "loadBalancer": { "name": "LoadBalancer-1", "arn": "arn:aws:lightsail:us-west-2:111122223333:LoadBalancer/40486b2b-1ad0-4152-83e4-cEXAMPLE6f4b", "supportCode": "6EXAMPLE3362/arn:aws:elasticloadbalancing:us-west-2:333322221111:loadbalancer/app/bEXAMPLE128cb59d86f946a9395dd304/1EXAMPLE8dd9d77e", "createdAt": 1571677906.723, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "resourceType": "LoadBalancer", "tags": [], "dnsName": "bEXAMPLE128cb59d86f946a9395dd304-1486911371.us-west-2.elb.amazonaws.com", "state": "active", "protocol": "HTTP", "publicPorts": [ 80 ], "healthCheckPath": "/", "instancePort": 80, "instanceHealthSummary": [ { "instanceName": "MEAN-3", "instanceHealth": "healthy" }, { "instanceName": "MEAN-1", "instanceHealth": "healthy" }, { "instanceName": "MEAN-2", "instanceHealth": "healthy" } ], "tlsCertificateSummaries": [ { "name": "example-com", "isAttached": false } ], "configurationOptions": { "SessionStickinessEnabled": "false", "SessionStickiness_LB_CookieDurationSeconds": "86400" } } } ``` + Para ver detalhes da API, consulte [GetLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-load-balancer.html) na *Referência de comandos da AWS CLI*. ### `get-load-balancers` O código de exemplo a seguir mostra como usar `get-load-balancers`. **AWS CLI** **Para obter informações sobre todos os balanceadores de carga** O exemplo `get-load-balancers` a seguir exibe detalhes sobre todos os balanceadores de carga na região da AWS configurada. ``` aws lightsail get-load-balancers ``` Resultado: ``` { "loadBalancers": [ { "name": "LoadBalancer-1", "arn": "arn:aws:lightsail:us-west-2:111122223333:LoadBalancer/40486b2b-1ad0-4152-83e4-cEXAMPLE6f4b", "supportCode": "6EXAMPLE3362/arn:aws:elasticloadbalancing:us-west-2:333322221111:loadbalancer/app/bEXAMPLE128cb59d86f946a9395dd304/1EXAMPLE8dd9d77e", "createdAt": 1571677906.723, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "resourceType": "LoadBalancer", "tags": [], "dnsName": "bEXAMPLE128cb59d86f946a9395dd304-1486911371.us-west-2.elb.amazonaws.com", "state": "active", "protocol": "HTTP", "publicPorts": [ 80 ], "healthCheckPath": "/", "instancePort": 80, "instanceHealthSummary": [ { "instanceName": "MEAN-3", "instanceHealth": "healthy" }, { "instanceName": "MEAN-1", "instanceHealth": "healthy" }, { "instanceName": "MEAN-2", "instanceHealth": "healthy" } ], "tlsCertificateSummaries": [ { "name": "example-com", "isAttached": false } ], "configurationOptions": { "SessionStickinessEnabled": "false", "SessionStickiness_LB_CookieDurationSeconds": "86400" } } ] } ``` + Para ver detalhes da API, consulte [GetLoadBalancers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-load-balancers.html) na *Referência de comandos da AWS CLI*. ### `get-operation` O código de exemplo a seguir mostra como usar `get-operation`. **AWS CLI** **Para obter informações sobre uma única operação** O exemplo `get-operation` a seguir exibe os detalhes sobre a operação especificada. ``` aws lightsail get-operation \ --operation-id e5700e8a-daf2-4b49-bc01-3EXAMPLE910a ``` Resultado: ``` { "operation": { "id": "e5700e8a-daf2-4b49-bc01-3EXAMPLE910a", "resourceName": "Instance-1", "resourceType": "Instance", "createdAt": 1571679872.404, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": true, "operationType": "CreateInstance", "status": "Succeeded", "statusChangedAt": 1571679890.304 } } ``` + Para ver detalhes da API, consulte [GetOperation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-operation.html) na *Referência de comandos da AWS CLI*. ### `get-operations-for-resource` O código de exemplo a seguir mostra como usar `get-operations-for-resource`. **AWS CLI** **Para obter todas as operações de um recurso** O exemplo `get-operations-for-resource` a seguir exibe os detalhes sobre todas as operação do recurso especificado. ``` aws lightsail get-operations-for-resource \ --resource-name LoadBalancer-1 ``` Resultado: ``` { "operations": [ { "id": "e2973046-43f8-4252-a4b4-9EXAMPLE69ce", "resourceName": "LoadBalancer-1", "resourceType": "LoadBalancer", "createdAt": 1571678786.071, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": true, "operationDetails": "MEAN-1", "operationType": "DetachInstancesFromLoadBalancer", "status": "Succeeded", "statusChangedAt": 1571679087.57 }, { "id": "2d742a18-0e7f-48c8-9705-3EXAMPLEf98a", "resourceName": "LoadBalancer-1", "resourceType": "LoadBalancer", "createdAt": 1571678782.784, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": true, "operationDetails": "MEAN-1", "operationType": "AttachInstancesToLoadBalancer", "status": "Succeeded", "statusChangedAt": 1571678798.465 }, { "id": "6c700fcc-4246-40ab-952b-1EXAMPLEdac2", "resourceName": "LoadBalancer-1", "resourceType": "LoadBalancer", "createdAt": 1571678775.297, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": true, "operationDetails": "MEAN-3", "operationType": "AttachInstancesToLoadBalancer", "status": "Succeeded", "statusChangedAt": 1571678842.806 }, ... } ] } ``` + Para ver detalhes da API, consulte [GetOperationsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-operations-for-resource.html) na *Referência de comandos da AWS CLI*. ### `get-operations` O código de exemplo a seguir mostra como usar `get-operations`. **AWS CLI** **Para obter informações sobre todas as operações** O exemplo `get-operations` a seguir exibe detalhes sobre todas as operações na região da AWS configurada. ``` aws lightsail get-operations ``` Resultado: ``` { "operations": [ { "id": "e5700e8a-daf2-4b49-bc01-3EXAMPLE910a", "resourceName": "Instance-1", "resourceType": "Instance", "createdAt": 1571679872.404, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": true, "operationType": "CreateInstance", "status": "Succeeded", "statusChangedAt": 1571679890.304 }, { "id": "701a3339-930e-4914-a9f9-7EXAMPLE68d7", "resourceName": "WordPress-1", "resourceType": "Instance", "createdAt": 1571678786.072, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": true, "operationDetails": "LoadBalancer-1", "operationType": "DetachInstancesFromLoadBalancer", "status": "Succeeded", "statusChangedAt": 1571679086.399 }, { "id": "e2973046-43f8-4252-a4b4-9EXAMPLE69ce", "resourceName": "LoadBalancer-1", "resourceType": "LoadBalancer", "createdAt": 1571678786.071, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": true, "operationDetails": "WordPress-1", "operationType": "DetachInstancesFromLoadBalancer", "status": "Succeeded", "statusChangedAt": 1571679087.57 }, ... } ] } ``` + Para ver detalhes da API, consulte [GetOperations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-operations.html) na *Referência de comandos da AWS CLI*. ### `get-regions` O código de exemplo a seguir mostra como usar `get-regions`. **AWS CLI** **Para obter todas as regiões da AWS do Amazon Lightsail** O exemplo `get-regions` a seguir exibe detalhes sobre todas as regiões da AWS do Amazon Lightsail. ``` aws lightsail get-regions ``` Resultado: ``` { "regions": [ { "continentCode": "NA", "description": "This region is recommended to serve users in the eastern United States", "displayName": "Virginia", "name": "us-east-1", "availabilityZones": [], "relationalDatabaseAvailabilityZones": [] }, { "continentCode": "NA", "description": "This region is recommended to serve users in the eastern United States", "displayName": "Ohio", "name": "us-east-2", "availabilityZones": [], "relationalDatabaseAvailabilityZones": [] }, { "continentCode": "NA", "description": "This region is recommended to serve users in the northwestern United States, Alaska, and western Canada", "displayName": "Oregon", "name": "us-west-2", "availabilityZones": [], "relationalDatabaseAvailabilityZones": [] }, ... } ] } ``` + Para ver detalhes da API, consulte [GetRegions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-regions.html) na *Referência de comandos da AWS CLI*. ### `get-relational-database-blueprints` O código de exemplo a seguir mostra como usar `get-relational-database-blueprints`. **AWS CLI** **Para obter os esquemas para novos bancos de dados relacionais** O exemplo `get-relational-database-blueprints` a seguir mostra detalhes sobre todos os esquemas de banco de dados relacional disponíveis para a criação de novos bancos de dados relacionais no Amazon Lightsail. ``` aws lightsail get-relational-database-blueprints ``` Resultado: ``` { "blueprints": [ { "blueprintId": "mysql_5_6", "engine": "mysql", "engineVersion": "5.6.44", "engineDescription": "MySQL Community Edition", "engineVersionDescription": "MySQL 5.6.44", "isEngineDefault": false }, { "blueprintId": "mysql_5_7", "engine": "mysql", "engineVersion": "5.7.26", "engineDescription": "MySQL Community Edition", "engineVersionDescription": "MySQL 5.7.26", "isEngineDefault": true }, { "blueprintId": "mysql_8_0", "engine": "mysql", "engineVersion": "8.0.16", "engineDescription": "MySQL Community Edition", "engineVersionDescription": "MySQL 8.0.16", "isEngineDefault": false }, { "blueprintId": "postgres_9_6", "engine": "postgres", "engineVersion": "9.6.15", "engineDescription": "PostgreSQL", "engineVersionDescription": "PostgreSQL 9.6.15-R1", "isEngineDefault": false }, { "blueprintId": "postgres_10", "engine": "postgres", "engineVersion": "10.10", "engineDescription": "PostgreSQL", "engineVersionDescription": "PostgreSQL 10.10-R1", "isEngineDefault": false }, { "blueprintId": "postgres_11", "engine": "postgres", "engineVersion": "11.5", "engineDescription": "PostgreSQL", "engineVersionDescription": "PostgreSQL 11.5-R1", "isEngineDefault": true } ] } ``` + Para ver detalhes da API, consulte [GetRelationalDatabaseBlueprints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-relational-database-blueprints.html) na *Referência de comandos da AWS CLI*. ### `get-relational-database-bundles` O código de exemplo a seguir mostra como usar `get-relational-database-bundles`. **AWS CLI** **Para obter os pacotes para novos bancos de dados relacionais** O exemplo `get-relational-database-bundles` a seguir mostra detalhes sobre todos os pacotes de banco de dados relacional disponíveis para a criação de novos bancos de dados relacionais no Amazon Lightsail. Observe que a resposta não inclui pacotes inativos porque o indicador `--include-inactive` não está especificado no comando. Não é possível usar pacotes inativos para criar novos bancos de dados relacionais. ``` aws lightsail get-relational-database-bundles ``` Resultado: ``` { "bundles": [ { "bundleId": "micro_2_0", "name": "Micro", "price": 15.0, "ramSizeInGb": 1.0, "diskSizeInGb": 40, "transferPerMonthInGb": 100, "cpuCount": 2, "isEncrypted": true, "isActive": true }, { "bundleId": "micro_ha_2_0", "name": "Micro with High Availability", "price": 30.0, "ramSizeInGb": 1.0, "diskSizeInGb": 40, "transferPerMonthInGb": 100, "cpuCount": 2, "isEncrypted": true, "isActive": true }, { "bundleId": "small_2_0", "name": "Small", "price": 30.0, "ramSizeInGb": 2.0, "diskSizeInGb": 80, "transferPerMonthInGb": 100, "cpuCount": 2, "isEncrypted": true, "isActive": true }, { "bundleId": "small_ha_2_0", "name": "Small with High Availability", "price": 60.0, "ramSizeInGb": 2.0, "diskSizeInGb": 80, "transferPerMonthInGb": 100, "cpuCount": 2, "isEncrypted": true, "isActive": true }, { "bundleId": "medium_2_0", "name": "Medium", "price": 60.0, "ramSizeInGb": 4.0, "diskSizeInGb": 120, "transferPerMonthInGb": 100, "cpuCount": 2, "isEncrypted": true, "isActive": true }, { "bundleId": "medium_ha_2_0", "name": "Medium with High Availability", "price": 120.0, "ramSizeInGb": 4.0, "diskSizeInGb": 120, "transferPerMonthInGb": 100, "cpuCount": 2, "isEncrypted": true, "isActive": true }, { "bundleId": "large_2_0", "name": "Large", "price": 115.0, "ramSizeInGb": 8.0, "diskSizeInGb": 240, "transferPerMonthInGb": 200, "cpuCount": 2, "isEncrypted": true, "isActive": true }, { "bundleId": "large_ha_2_0", "name": "Large with High Availability", "price": 230.0, "ramSizeInGb": 8.0, "diskSizeInGb": 240, "transferPerMonthInGb": 200, "cpuCount": 2, "isEncrypted": true, "isActive": true } ] } ``` Para obter mais informações, consulte [Criar um banco de dados no Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-a-database) no *Guia do desenvolvedor do Amazon Lightsail*. + Para ver detalhes da API, consulte [GetRelationalDatabaseBundles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-relational-database-bundles.html) na *Referência de comandos da AWS CLI*. ### `get-relational-database-events` O código de exemplo a seguir mostra como usar `get-relational-database-events`. **AWS CLI** **Para obter os eventos de um banco de dados relacional** O exemplo `get-relational-database-events` a seguir exibe detalhes sobre eventos nas últimas 17 horas (1020 minutos) para o banco de dados relacional especificado. ``` aws lightsail get-relational-database-events \ --relational-database-name Database-1 \ --duration-in-minutes 1020 ``` Resultado: ``` { "relationalDatabaseEvents": [ { "resource": "Database-1", "createdAt": 1571654146.553, "message": "Backing up Relational Database", "eventCategories": [ "backup" ] }, { "resource": "Database-1", "createdAt": 1571654249.98, "message": "Finished Relational Database backup", "eventCategories": [ "backup" ] } ] } ``` + Para ver detalhes da API, consulte [GetRelationalDatabaseEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-relational-database-events.html) na *Referência de comandos da AWS CLI*. ### `get-relational-database-log-events` O código de exemplo a seguir mostra como usar `get-relational-database-log-events`. **AWS CLI** **Para obter os eventos de logs de um banco de dados relacional** O exemplo `get-relational-database-log-events` a seguir exibe detalhes sobre o log especificado entre `1570733176` e `1571597176` para o banco de dados relacional `Database1`. As informações retornadas estão configuradas para começar a partir de `head`. Recomenda-se o uso de um conversor de horário unix para identificar os horários de início e término. ``` aws lightsail get-relational-database-log-events \ --relational-database-name Database1 \ --log-stream-name error \ --start-from-head \ --start-time 1570733176 \ --end-time 1571597176 ``` Resultado: ``` { "resourceLogEvents": [ { "createdAt": 1570820267.0, "message": "2019-10-11 18:57:47 20969 [Warning] IP address '192.0.2.0' could not be resolved: Name or service not known" }, { "createdAt": 1570860974.0, "message": "2019-10-12 06:16:14 20969 [Warning] IP address '8192.0.2.0' could not be resolved: Temporary failure in name resolution" }, { "createdAt": 1570860977.0, "message": "2019-10-12 06:16:17 20969 [Warning] IP address '192.0.2.0' could not be resolved: Temporary failure in name resolution" }, { "createdAt": 1570860979.0, "message": "2019-10-12 06:16:19 20969 [Warning] IP address '192.0.2.0' could not be resolved: Temporary failure in name resolution" }, { "createdAt": 1570860981.0, "message": "2019-10-12 06:16:21 20969 [Warning] IP address '192.0.2.0' could not be resolved: Temporary failure in name resolution" }, { "createdAt": 1570860982.0, "message": "2019-10-12 06:16:22 20969 [Warning] IP address '192.0.2.0' could not be resolved: Temporary failure in name resolution" }, { "createdAt": 1570860984.0, "message": "2019-10-12 06:16:24 20969 [Warning] IP address '192.0.2.0' could not be resolved: Temporary failure in name resolution" }, { "createdAt": 1570860986.0, "message": "2019-10-12 06:16:26 20969 [Warning] IP address '192.0.2.0' could not be resolved: Temporary failure in name resolution" }, ... } ], "nextBackwardToken": "eEXAMPLEZXJUZXh0IjoiZnRWb3F3cUpRSlQ5NndMYThxelRUZlFhR3J6c2dKWEEvM2kvajZMZzVVVWpqRDN0YjFXTjNrak5pRk9iVFRZdjkwVGlpZGw5NFJGSFRQTEdJSjdpQnFCRk5CZFJlYTZaSXpScStuZjJEYXhqM2grUFVJOEpIYlU5YWJ2QitvQWN5cEFyVUo3VDk1QWY3bVF6MEwvcVovVldZdGc9Iiwibm9uY2UiOiJBNHpzdWMvUkZZKzRvUzhEIiwiY2lwaGVyIjoiQUVTL0dDTS9Ob1BhZGEXAMPLEQ==", "nextForwardToken": "eEXAMPLEZXJUZXh0IjoiT09Lb0Z6ZFRJbHhaNEQ5N2tPbkkwRmwwNUxPZjFTbFFwUklQbzlSaWgvMWVXbEk4aG56VHg4bW1Gb3grbDVodUVNZEdiZXN0TzVYcjlLK1FUdFB2RlJLS2FMcU05WkN3Rm1uVzBkOFpDR2g0b1BBVlg2NVFGNDNPazZzRXJieHRuU0xzdkRNTkFUMTZibU9HM2YyaGxiS0hUUDA9Iiwibm9uY2UiOiJFQmI4STQ3cU5aWXNXZ0g4IiwiY2lwaGVyIjoiQUVTL0dDTS9Ob1BhZGEXAMPLEQ==" } ``` + Para ver detalhes da API, consulte [GetRelationalDatabaseLogEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-relational-database-log-events.html) na *Referência de comandos da AWS CLI*. ### `get-relational-database-log-streams` O código de exemplo a seguir mostra como usar `get-relational-database-log-streams`. **AWS CLI** **Para obter os fluxos de logs de um banco de dados relacional** O exemplo `get-relational-database-log-streams` a seguir retorna todos os fluxos de logs disponíveis para o banco de dados relacional especificado. ``` aws lightsail get-relational-database-log-streams \ --relational-database-name Database1 ``` Resultado: ``` { "logStreams": [ "audit", "error", "general", "slowquery" ] } ``` + Para ver detalhes da API, consulte [GetRelationalDatabaseLogStreams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-relational-database-log-streams.html) na *Referência de comandos da AWS CLI*. ### `get-relational-database-master-user-password` O código de exemplo a seguir mostra como usar `get-relational-database-master-user-password`. **AWS CLI** **Para obter a senha do usuário primário de um banco de dados relacional** O exemplo `get-relational-database-master-user-password` a seguir retorna informações sobre a senha de usuário primário para o banco de dados relacional especificado. ``` aws lightsail get-relational-database-master-user-password \ --relational-database-name Database-1 ``` Resultado: ``` { "masterUserPassword": "VEXAMPLEec.9qvx,_t<)Wkf)kwboM,>2", "createdAt": 1571259453.959 } ``` + Para ver detalhes da API, consulte [GetRelationalDatabaseMasterUserPassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-relational-database-master-user-password.html) na *Referência de comandos da AWS CLI*. ### `get-relational-database-metric-data` O código de exemplo a seguir mostra como usar `get-relational-database-metric-data`. **AWS CLI** **Para obter dados métricos de um banco de dados relacional** O exemplo `get-relational-database-metric-data` a seguir retorna a soma da contagem da métrica `DatabaseConnections` durante o período de 24 horas (`86400` segundos) entre `1570733176` e `1571597176` para o banco de dados relacional `Database1`. Recomenda-se o uso de um conversor de horário unix para identificar os horários de início e término. ``` aws lightsail get-relational-database-metric-data \ --relational-database-name Database1 \ --metric-name DatabaseConnections \ --period 86400 \ --start-time 1570733176 \ --end-time 1571597176 \ --unit Count \ --statistics Sum ``` Resultado: ``` { "metricName": "DatabaseConnections", "metricData": [ { "sum": 1.0, "timestamp": 1571510760.0, "unit": "Count" }, { "sum": 1.0, "timestamp": 1570733160.0, "unit": "Count" }, { "sum": 1.0, "timestamp": 1570992360.0, "unit": "Count" }, { "sum": 0.0, "timestamp": 1571251560.0, "unit": "Count" }, { "sum": 721.0, "timestamp": 1570819560.0, "unit": "Count" }, { "sum": 1.0, "timestamp": 1571078760.0, "unit": "Count" }, { "sum": 2.0, "timestamp": 1571337960.0, "unit": "Count" }, { "sum": 684.0, "timestamp": 1570905960.0, "unit": "Count" }, { "sum": 0.0, "timestamp": 1571165160.0, "unit": "Count" }, { "sum": 1.0, "timestamp": 1571424360.0, "unit": "Count" } ] } ``` + Para ver detalhes da API, consulte [GetRelationalDatabaseMetricData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-relational-database-metric-data.html) na *Referência de comandos da AWS CLI*. ### `get-relational-database-parameters` O código de exemplo a seguir mostra como usar `get-relational-database-parameters`. **AWS CLI** **Para obter parâmetros de um banco de dados relacional** O exemplo `get-relational-database-parameters` a seguir retorna informações sobre todos os parâmetros disponíveis para o banco de dados relacional especificado. ``` aws lightsail get-relational-database-parameters \ --relational-database-name Database-1 ``` Resultado: ``` { "parameters": [ { "allowedValues": "0,1", "applyMethod": "pending-reboot", "applyType": "dynamic", "dataType": "boolean", "description": "Automatically set all granted roles as active after the user has authenticated successfully.", "isModifiable": true, "parameterName": "activate_all_roles_on_login", "parameterValue": "0" }, { "allowedValues": "0,1", "applyMethod": "pending-reboot", "applyType": "static", "dataType": "boolean", "description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", "isModifiable": false, "parameterName": "allow-suspicious-udfs" }, { "allowedValues": "0,1", "applyMethod": "pending-reboot", "applyType": "dynamic", "dataType": "boolean", "description": "Sets the autocommit mode", "isModifiable": true, "parameterName": "autocommit" }, { "allowedValues": "0,1", "applyMethod": "pending-reboot", "applyType": "static", "dataType": "boolean", "description": "Controls whether the server autogenerates SSL key and certificate files in the data directory, if they do not already exist.", "isModifiable": false, "parameterName": "auto_generate_certs" }, ... } ] } ``` Para obter mais informações, consulte [Atualizar parâmetros do banco de dados no Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-updating-database-parameters) no *Guia do desenvolvedor do Lightsail*. + Para ver detalhes da API, consulte [GetRelationalDatabaseParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-relational-database-parameters.html) na *Referência de comandos da AWS CLI*. ### `get-relational-database-snapshot` O código de exemplo a seguir mostra como usar `get-relational-database-snapshot`. **AWS CLI** **Para obter informações sobre um snapshot de um banco de dados relacional** O exemplo `get-relational-database-snapshot` a seguir exibe detalhes sobre o snapshot do banco de dados relacional especificado. ``` aws lightsail get-relational-database-snapshot \ --relational-database-snapshot-name Database-1-1571350042 ``` Resultado: ``` { "relationalDatabaseSnapshot": { "name": "Database-1-1571350042", "arn": "arn:aws:lightsail:us-west-2:111122223333:RelationalDatabaseSnapshot/0389bbad-4b85-4c3d-9EXAMPLEaee3643d2", "supportCode": "6EXAMPLE3362/ls-8EXAMPLE2ba7ad041451946fafc2ad19cfbd9eb2", "createdAt": 1571350046.238, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "resourceType": "RelationalDatabaseSnapshot", "tags": [], "engine": "mysql", "engineVersion": "8.0.16", "sizeInGb": 40, "state": "available", "fromRelationalDatabaseName": "Database-1", "fromRelationalDatabaseArn": "arn:aws:lightsail:us-west-2:111122223333:RelationalDatabase/7ea932b1-b85a-4bd5-9b3e-bEXAMPLE8cc4", "fromRelationalDatabaseBundleId": "micro_1_0", "fromRelationalDatabaseBlueprintId": "mysql_8_0" } } ``` + Para ver detalhes da API, consulte [GetRelationalDatabaseSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-relational-database-snapshot.html) na *Referência de comandos da AWS CLI*. ### `get-relational-database-snapshots` O código de exemplo a seguir mostra como usar `get-relational-database-snapshots`. **AWS CLI** **Para obter informações sobre todos os snapshot de banco de dados relacional** O exemplo `get-relational-database-snapshots` a seguir exibe detalhes sobre todos os snapshots de banco de dados relacional na região da AWS configurada. ``` aws lightsail get-relational-database-snapshots ``` Resultado: ``` { "relationalDatabaseSnapshots": [ { "name": "Database-1-1571350042", "arn": "arn:aws:lightsail:us-west-2:111122223333:RelationalDatabaseSnapshot/0389bbad-4b85-4c3d-9861-6EXAMPLE43d2", "supportCode": "6EXAMPLE3362/ls-8EXAMPLE2ba7ad041451946fafc2ad19cfbd9eb2", "createdAt": 1571350046.238, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "resourceType": "RelationalDatabaseSnapshot", "tags": [], "engine": "mysql", "engineVersion": "8.0.16", "sizeInGb": 40, "state": "available", "fromRelationalDatabaseName": "Database-1", "fromRelationalDatabaseArn": "arn:aws:lightsail:us-west-2:111122223333:RelationalDatabase/7ea932b1-b85a-4bd5-9b3e-bEXAMPLE8cc4", "fromRelationalDatabaseBundleId": "micro_1_0", "fromRelationalDatabaseBlueprintId": "mysql_8_0" }, { "name": "Database1-Console", "arn": "arn:aws:lightsail:us-west-2:111122223333:RelationalDatabaseSnapshot/8b94136e-06ec-4b1a-a3fb-5EXAMPLEe1e9", "supportCode": "6EXAMPLE3362/ls-9EXAMPLE14b000d34c8d1c432734e137612d5b5c", "createdAt": 1571249981.025, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "resourceType": "RelationalDatabaseSnapshot", "tags": [ { "key": "test" } ], "engine": "mysql", "engineVersion": "5.6.44", "sizeInGb": 40, "state": "available", "fromRelationalDatabaseName": "Database1", "fromRelationalDatabaseArn": "arn:aws:lightsail:us-west-2:111122223333:RelationalDatabase/a6161cb7-4535-4f16-9dcf-8EXAMPLE3d4e", "fromRelationalDatabaseBundleId": "micro_1_0", "fromRelationalDatabaseBlueprintId": "mysql_5_6" } ] } ``` + Para ver detalhes da API, consulte [GetRelationalDatabaseSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-relational-database-snapshots.html) na *Referência de comandos da AWS CLI*. ### `get-relational-database` O código de exemplo a seguir mostra como usar `get-relational-database`. **AWS CLI** **Para obter informações sobre um banco de dados relacional** O exemplo `get-relational-database` a seguir exibe detalhes sobre o banco de dados relacional especificado. ``` aws lightsail get-relational-database \ --relational-database-name Database-1 ``` Resultado: ``` { "relationalDatabase": { "name": "Database-1", "arn": "arn:aws:lightsail:us-west-2:111122223333:RelationalDatabase/7ea932b1-b85a-4bd5-9b3e-bEXAMPLE8cc4", "supportCode": "6EXAMPLE3362/ls-9EXAMPLE8ad863723b62cc8901a8aa6e794ae0d2", "createdAt": 1571259453.795, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "resourceType": "RelationalDatabase", "tags": [], "relationalDatabaseBlueprintId": "mysql_8_0", "relationalDatabaseBundleId": "micro_1_0", "masterDatabaseName": "dbmaster", "hardware": { "cpuCount": 1, "diskSizeInGb": 40, "ramSizeInGb": 1.0 }, "state": "available", "backupRetentionEnabled": false, "pendingModifiedValues": {}, "engine": "mysql", "engineVersion": "8.0.16", "masterUsername": "dbmasteruser", "parameterApplyStatus": "in-sync", "preferredBackupWindow": "10:01-10:31", "preferredMaintenanceWindow": "sat:11:14-sat:11:44", "publiclyAccessible": true, "masterEndpoint": { "port": 3306, "address": "ls-9EXAMPLE8ad863723b62ccEXAMPLEa6e794ae0d2.czowadgeezqi.us-west-2.rds.amazonaws.com" }, "pendingMaintenanceActions": [] } } ``` + Para ver detalhes da API, consulte [GetRelationalDatabase](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-relational-database.html) na *Referência de comandos da AWS CLI*. ### `get-relational-databases` O código de exemplo a seguir mostra como usar `get-relational-databases`. **AWS CLI** **Para obter informações sobre todos os bancos de dados relacionais** O exemplo `get-relational-databases` a seguir exibe detalhes sobre todos os bancos de dados relacionais na região AWS configurada. ``` aws lightsail get-relational-databases ``` Resultado: ``` { "relationalDatabases": [ { "name": "MySQL", "arn": "arn:aws:lightsail:us-west-2:111122223333:RelationalDatabase/8529020c-3ab9-4d51-92af-5EXAMPLE8979", "supportCode": "6EXAMPLE3362/ls-3EXAMPLEa995d8c3b06b4501356e5f2f28e1aeba", "createdAt": 1554306019.155, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "resourceType": "RelationalDatabase", "tags": [], "relationalDatabaseBlueprintId": "mysql_8_0", "relationalDatabaseBundleId": "micro_1_0", "masterDatabaseName": "dbmaster", "hardware": { "cpuCount": 1, "diskSizeInGb": 40, "ramSizeInGb": 1.0 }, "state": "available", "backupRetentionEnabled": true, "pendingModifiedValues": {}, "engine": "mysql", "engineVersion": "8.0.15", "latestRestorableTime": 1571686200.0, "masterUsername": "dbmasteruser", "parameterApplyStatus": "in-sync", "preferredBackupWindow": "07:51-08:21", "preferredMaintenanceWindow": "tue:12:18-tue:12:48", "publiclyAccessible": true, "masterEndpoint": { "port": 3306, "address": "ls-3EXAMPLEa995d8c3b06b4501356e5f2fEXAMPLEa.czowadgeezqi.us-west-2.rds.amazonaws.com" }, "pendingMaintenanceActions": [] }, { "name": "Postgres", "arn": "arn:aws:lightsail:us-west-2:111122223333:RelationalDatabase/e9780b6b-d0ab-4af2-85f1-1EXAMPLEac68", "supportCode": "6EXAMPLE3362/ls-3EXAMPLEb4fffb5cec056220c734713e14bd5fcd", "createdAt": 1554306000.814, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "resourceType": "RelationalDatabase", "tags": [], "relationalDatabaseBlueprintId": "postgres_11", "relationalDatabaseBundleId": "micro_1_0", "masterDatabaseName": "dbmaster", "hardware": { "cpuCount": 1, "diskSizeInGb": 40, "ramSizeInGb": 1.0 }, "state": "available", "backupRetentionEnabled": true, "pendingModifiedValues": {}, "engine": "postgres", "engineVersion": "11.1", "latestRestorableTime": 1571686339.0, "masterUsername": "dbmasteruser", "parameterApplyStatus": "in-sync", "preferredBackupWindow": "06:19-06:49", "preferredMaintenanceWindow": "sun:10:19-sun:10:49", "publiclyAccessible": false, "masterEndpoint": { "port": 5432, "address": "ls-3EXAMPLEb4fffb5cec056220c734713eEXAMPLEd.czowadgeezqi.us-west-2.rds.amazonaws.com" }, "pendingMaintenanceActions": [] } ] } ``` + Para ver detalhes da API, consulte [GetRelationalDatabases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-relational-databases.html) na *Referência de comandos da AWS CLI*. ### `get-static-ip` O código de exemplo a seguir mostra como usar `get-static-ip`. **AWS CLI** **Para obter informações sobre um IP estático** O exemplo `get-static-ip` a seguir exibe os detalhes do IP estático especificado. ``` aws lightsail get-static-ip \ --static-ip-name StaticIp-1 ``` Resultado: ``` { "staticIp": { "name": "StaticIp-1", "arn": "arn:aws:lightsail:us-west-2:111122223333:StaticIp/2257cd76-1f0e-4ac0-82e2-2EXAMPLE23ad", "supportCode": "6EXAMPLE3362/192.0.2.0", "createdAt": 1571071325.076, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "resourceType": "StaticIp", "ipAddress": "192.0.2.0", "isAttached": false } } ``` + Para ver detalhes da API, consulte [GetStaticIp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-static-ip.html) na *Referência de comandos da AWS CLI*. ### `get-static-ips` O código de exemplo a seguir mostra como usar `get-static-ips`. **AWS CLI** **Para obter informações sobre todos os IP estáticos** O exemplo `get-static-ips` a seguir exibe detalhes sobre todos os IPs estáticos na região da AWS configurada. ``` aws lightsail get-static-ips ``` Resultado: ``` { "staticIps": [ { "name": "StaticIp-1", "arn": "arn:aws:lightsail:us-west-2:111122223333:StaticIp/2257cd76-1f0e-4ac0-8EXAMPLE16f9423ad", "supportCode": "6EXAMPLE3362/192.0.2.0", "createdAt": 1571071325.076, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "resourceType": "StaticIp", "ipAddress": "192.0.2.0", "isAttached": false }, { "name": "StaticIP-2", "arn": "arn:aws:lightsail:us-west-2:111122223333:StaticIp/c61edb40-e5f0-4fd6-ae7c-8EXAMPLE19f8", "supportCode": "6EXAMPLE3362/192.0.2.2", "createdAt": 1568305385.681, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "resourceType": "StaticIp", "ipAddress": "192.0.2.2", "attachedTo": "WordPress-1", "isAttached": true } ] } ``` + Para ver detalhes da API, consulte [GetStaticIps](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-static-ips.html) na *Referência de comandos da AWS CLI*. ### `is-vpc-peered` O código de exemplo a seguir mostra como usar `is-vpc-peered`. **AWS CLI** **Como identificar se sua nuvem privada virtual Amazon Lightsail está emparelhada** O exemplo `is-vpc-peered` a seguir retorna o status de emparelhamento da nuvem privada virtual (VPC) Amazon Lightsail para a região da AWS especificada. ``` aws lightsail is-vpc-peered \ --region us-west-2 ``` Resultado: ``` { "isPeered": true } ``` + Para ver detalhes da API, consulte [IsVpcPeered](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/is-vpc-peered.html) na *Referência de comandos da AWS CLI*. ### `open-instance-public-ports` O código de exemplo a seguir mostra como usar `open-instance-public-ports`. **AWS CLI** **Como abrir as portas de firewall de uma instância** O exemplo `open-instance-public-ports` a seguir abre a porta TCP 22 na instância especificada. ``` aws lightsail open-instance-public-ports \ --instance-name MEAN-2 \ --port-info fromPort=22,protocol=TCP,toPort=22 ``` Resultado: ``` { "operation": { "id": "719744f0-a022-46f2-9f11-6EXAMPLE4642", "resourceName": "MEAN-2", "resourceType": "Instance", "createdAt": 1571072906.849, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": true, "operationDetails": "22/tcp", "operationType": "OpenInstancePublicPorts", "status": "Succeeded", "statusChangedAt": 1571072906.849 } } ``` + Para ver detalhes da API, consulte [OpenInstancePublicPorts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/open-instance-public-ports.html) na *Referência de comandos da AWS CLI*. ### `peer-vpc` O código de exemplo a seguir mostra como usar `peer-vpc`. **AWS CLI** **Como emparelhar a nuvem privada virtual do Amazon Lightsail** O exemplo `peer-vpc` a seguir retorna o status de emparelhamento da nuvem privada virtual (VPC) do Amazon Lightsail para a região da AWS especificada. ``` aws lightsail peer-vpc \ --region us-west-2 ``` Resultado: ``` { "operation": { "id": "787e846a-54ac-497f-bce2-9EXAMPLE5d91", "resourceName": "vpc-0EXAMPLEa5261efb3", "resourceType": "PeeredVpc", "createdAt": 1571694233.104, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": true, "operationDetails": "vpc-e2b3eb9b", "operationType": "PeeredVpc", "status": "Succeeded", "statusChangedAt": 1571694233.104 } } ``` + Para ver detalhes da API, consulte [PeerVpc](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/peer-vpc.html) na *Referência de comandos da AWS CLI*. ### `reboot-instance` O código de exemplo a seguir mostra como usar `reboot-instance`. **AWS CLI** **Como reinicializar uma instância** O exemplo `reboot-instance` a seguir reinicializa a instância especificada. ``` aws lightsail reboot-instance \ --instance-name MEAN-1 ``` Resultado: ``` { "operations": [ { "id": "2b679f1c-8b71-4bb4-8e97-8EXAMPLEed93", "resourceName": "MEAN-1", "resourceType": "Instance", "createdAt": 1571694445.49, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": true, "operationDetails": "", "operationType": "RebootInstance", "status": "Succeeded", "statusChangedAt": 1571694445.49 } ] } ``` + Para ver detalhes da API, consulte [RebootInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/reboot-instance.html) na *Referência de comandos da AWS CLI*. ### `reboot-relational-database` O código de exemplo a seguir mostra como usar `reboot-relational-database`. **AWS CLI** **Como reinicializar um banco de dados relacional** O exemplo `reboot-relational-database` a seguir reinicializa o banco de dados relacional especificado. ``` aws lightsail reboot-relational-database \ --relational-database-name Database-1 ``` Resultado: ``` { "operations": [ { "id": "e4c980c0-3137-496c-9c91-1EXAMPLEdec2", "resourceName": "Database-1", "resourceType": "RelationalDatabase", "createdAt": 1571694532.91, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": false, "operationDetails": "", "operationType": "RebootRelationalDatabase", "status": "Started", "statusChangedAt": 1571694532.91 } ] } ``` + Para ver detalhes da API, consulte [RebootRelationalDatabase](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/reboot-relational-database.html) na *Referência de comandos da AWS CLI*. ### `release-static-ip` O código de exemplo a seguir mostra como usar `release-static-ip`. **AWS CLI** **Para excluir um IP estático** O exemplo `release-static-ip` a seguir exclui o IP estático especificado. ``` aws lightsail release-static-ip \ --static-ip-name StaticIp-1 ``` Resultado: ``` { "operations": [ { "id": "e374c002-dc6d-4c7f-919f-2EXAMPLE13ce", "resourceName": "StaticIp-1", "resourceType": "StaticIp", "createdAt": 1571694962.003, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": true, "operationType": "ReleaseStaticIp", "status": "Succeeded", "statusChangedAt": 1571694962.003 } ] } ``` + Para ver detalhes da API, consulte [ReleaseStaticIp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/release-static-ip.html) na *Referência de comandos da AWS CLI*. ### `start-instance` O código de exemplo a seguir mostra como usar `start-instance`. **AWS CLI** **Para iniciar uma instância** O exemplo `start-instance` a seguir inicia a instância especificada. ``` aws lightsail start-instance \ --instance-name WordPress-1 ``` Resultado: ``` { "operations": [ { "id": "f88d2a93-7cea-4165-afce-2d688cb18f23", "resourceName": "WordPress-1", "resourceType": "Instance", "createdAt": 1571695583.463, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": false, "operationType": "StartInstance", "status": "Started", "statusChangedAt": 1571695583.463 } ] } ``` + Para ver detalhes da API, consulte [StartInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/start-instance.html) na *Referência de comandos da AWS CLI*. ### `start-relational-database` O código de exemplo a seguir mostra como usar `start-relational-database`. **AWS CLI** **Para iniciar um banco de dados relacional** O exemplo `start-relational-database` a seguir reinicializa o banco de dados relacional especificado. ``` aws lightsail start-relational-database \ --relational-database-name Database-1 ``` Resultado: ``` { "operations": [ { "id": "4d5294ec-a38a-4fda-9e37-aEXAMPLE0d24", "resourceName": "Database-1", "resourceType": "RelationalDatabase", "createdAt": 1571695998.822, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": false, "operationType": "StartRelationalDatabase", "status": "Started", "statusChangedAt": 1571695998.822 } ] } ``` + Para ver detalhes da API, consulte [StartRelationalDatabase](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/start-relational-database.html) na *Referência de comandos da AWS CLI*. ### `stop-instance` O código de exemplo a seguir mostra como usar `stop-instance`. **AWS CLI** **Como interromper uma instância** O exemplo `stop-instance` a seguir interrompe a instância especificada. ``` aws lightsail stop-instance \ --instance-name WordPress-1 ``` Resultado: ``` { "operations": [ { "id": "265357e2-2943-4d51-888a-1EXAMPLE7585", "resourceName": "WordPress-1", "resourceType": "Instance", "createdAt": 1571695471.134, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": false, "operationType": "StopInstance", "status": "Started", "statusChangedAt": 1571695471.134 } ] } ``` + Para ver detalhes da API, consulte [StopInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/stop-instance.html) na *Referência de comandos da AWS CLI*. ### `stop-relational-database` O código de exemplo a seguir mostra como usar `stop-relational-database`. **AWS CLI** **Como interromper um banco de dados relacional** O exemplo `stop-relational-database` a seguir interrompe o banco de dados relacional especificado. ``` aws lightsail stop-relational-database \ --relational-database-name Database-1 ``` Resultado: ``` { "operations": [ { "id": "cc559c19-4adb-41e4-b75b-5EXAMPLE4e61", "resourceName": "Database-1", "resourceType": "RelationalDatabase", "createdAt": 1571695526.29, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": false, "operationType": "StopRelationalDatabase", "status": "Started", "statusChangedAt": 1571695526.29 } ] } ``` + Para ver detalhes da API, consulte [StopRelationalDatabase](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/stop-relational-database.html) na *Referência de comandos da AWS CLI*. ### `unpeer-vpc` O código de exemplo a seguir mostra como usar `unpeer-vpc`. **AWS CLI** **Para remover o emparelhamento de uma nuvem privada virtual do Amazon Lightsail** O exemplo `unpeer-vpc` a seguir remove o emparelhamento da nuvem privada virtual (VPC) do Amazon Lightsail para a região AWS especificada. ``` aws lightsail unpeer-vpc \ --region us-west-2 ``` Resultado: ``` { "operation": { "id": "531aca64-7157-47ab-84c6-eEXAMPLEd898", "resourceName": "vpc-0EXAMPLEa5261efb3", "resourceType": "PeeredVpc", "createdAt": 1571694109.945, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "isTerminal": true, "operationDetails": "vpc-e2b3eb9b", "operationType": "UnpeeredVpc", "status": "Succeeded", "statusChangedAt": 1571694109.945 } } ``` + Para ver detalhes da API, consulte [UnpeerVpc](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/unpeer-vpc.html) na *Referência de comandos da AWS CLI*. # Exemplos do Macie usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface 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 ### `describe-buckets` O código de exemplo a seguir mostra como usar `describe-buckets`. **AWS CLI** **Como consultar dados sobre um ou mais buckets do S3 monitorados e analisados pelo Amazon Macie em sua conta** O exemplo de `describe-buckets` a seguir consulta os metadados de todos os buckets do S3 cujos nomes começam com amzn-s3-demo-bucket e estão na região da AWS atual. ``` aws macie2 describe-buckets \ --criteria '{"bucketName":{"prefix":"amzn-s3-demo-bucket"}}' ``` Resultado: ``` { "buckets": [ { "accountId": "123456789012", "allowsUnencryptedObjectUploads": "FALSE", "automatedDiscoveryMonitoringStatus": "MONITORED", "bucketArn": "arn:aws:s3:::amzn-s3-demo-bucket1", "bucketCreatedAt": "2020-05-18T19:54:00+00:00", "bucketName": "amzn-s3-demo-bucket1", "classifiableObjectCount": 13, "classifiableSizeInBytes": 1592088, "jobDetails": { "isDefinedInJob": "TRUE", "isMonitoredByJob": "TRUE", "lastJobId": "08c81dc4a2f3377fae45c9ddaEXAMPLE", "lastJobRunTime": "2024-08-19T14:55:30.270000+00:00" }, "lastAutomatedDiscoveryTime": "2024-10-22T19:11:25.364000+00:00", "lastUpdated": "2024-10-25T07:33:06.337000+00:00", "objectCount": 13, "objectCountByEncryptionType": { "customerManaged": 0, "kmsManaged": 2, "s3Managed": 7, "unencrypted": 4, "unknown": 0 }, "publicAccess": { "effectivePermission": "NOT_PUBLIC", "permissionConfiguration": { "accountLevelPermissions": { "blockPublicAccess": { "blockPublicAcls": true, "blockPublicPolicy": true, "ignorePublicAcls": true, "restrictPublicBuckets": true } }, "bucketLevelPermissions": { "accessControlList": { "allowsPublicReadAccess": false, "allowsPublicWriteAccess": false }, "blockPublicAccess": { "blockPublicAcls": true, "blockPublicPolicy": true, "ignorePublicAcls": true, "restrictPublicBuckets": true }, "bucketPolicy": { "allowsPublicReadAccess": false, "allowsPublicWriteAccess": false } } } }, "region": "us-west-2", "replicationDetails": { "replicated": false, "replicatedExternally": false, "replicationAccounts": [] }, "sensitivityScore": 78, "serverSideEncryption": { "kmsMasterKeyId": null, "type": "NONE" }, "sharedAccess": "NOT_SHARED", "sizeInBytes": 4549746, "sizeInBytesCompressed": 0, "tags": [ { "key": "Division", "value": "HR" }, { "key": "Team", "value": "Recruiting" } ], "unclassifiableObjectCount": { "fileType": 0, "storageClass": 0, "total": 0 }, "unclassifiableObjectSizeInBytes": { "fileType": 0, "storageClass": 0, "total": 0 }, "versioning": true }, { "accountId": "123456789012", "allowsUnencryptedObjectUploads": "TRUE", "automatedDiscoveryMonitoringStatus": "MONITORED", "bucketArn": "arn:aws:s3:::amzn-s3-demo-bucket2", "bucketCreatedAt": "2020-11-25T18:24:38+00:00", "bucketName": "amzn-s3-demo-bucket2", "classifiableObjectCount": 8, "classifiableSizeInBytes": 133810, "jobDetails": { "isDefinedInJob": "TRUE", "isMonitoredByJob": "FALSE", "lastJobId": "188d4f6044d621771ef7d65f2EXAMPLE", "lastJobRunTime": "2024-07-09T19:37:11.511000+00:00" }, "lastAutomatedDiscoveryTime": "2024-10-24T19:11:25.364000+00:00", "lastUpdated": "2024-10-25T07:33:06.337000+00:00", "objectCount": 8, "objectCountByEncryptionType": { "customerManaged": 0, "kmsManaged": 0, "s3Managed": 8, "unencrypted": 0, "unknown": 0 }, "publicAccess": { "effectivePermission": "NOT_PUBLIC", "permissionConfiguration": { "accountLevelPermissions": { "blockPublicAccess": { "blockPublicAcls": true, "blockPublicPolicy": true, "ignorePublicAcls": true, "restrictPublicBuckets": true } }, "bucketLevelPermissions": { "accessControlList": { "allowsPublicReadAccess": false, "allowsPublicWriteAccess": false }, "blockPublicAccess": { "blockPublicAcls": true, "blockPublicPolicy": true, "ignorePublicAcls": true, "restrictPublicBuckets": true }, "bucketPolicy": { "allowsPublicReadAccess": false, "allowsPublicWriteAccess": false } } } }, "region": "us-west-2", "replicationDetails": { "replicated": false, "replicatedExternally": false, "replicationAccounts": [] }, "sensitivityScore": 95, "serverSideEncryption": { "kmsMasterKeyId": null, "type": "AES256" }, "sharedAccess": "EXTERNAL", "sizeInBytes": 175978, "sizeInBytesCompressed": 0, "tags": [ { "key": "Division", "value": "HR" }, { "key": "Team", "value": "Recruiting" } ], "unclassifiableObjectCount": { "fileType": 3, "storageClass": 0, "total": 3 }, "unclassifiableObjectSizeInBytes": { "fileType": 2999826, "storageClass": 0, "total": 2999826 }, "versioning": true } ] } ``` Para obter mais informações, consulte [Filtrar seu inventário de buckets S3](https://docs.aws.amazon.com/macie/latest/user/monitoring-s3-inventory-filter.html) no *Guia do usuário do Amazon Macie*. + Para ver detalhes da API, consulte [DescribeBuckets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/macie2/describe-buckets.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon Managed Grafana usando AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Amazon Managed Grafana. *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 ### `list-workspaces` O código de exemplo a seguir mostra como usar `list-workspaces`. **AWS CLI** **Listar espaços de trabalho da conta na região especificada pela credencial do usuário** O exemplo `list-workspaces` a seguir lista os espaços de trabalho da Grafana para a região da conta. ``` aws grafana list-workspaces ``` Resultado: ``` { "workspaces": [ { "authentication": { "providers": [ "AWS_SSO" ] }, "created": "2022-04-04T16:20:21.796000-07:00", "description": "to test tags", "endpoint": "g-949e7b44df.grafana-workspace.us-east-1.amazonaws.com", "grafanaVersion": "8.2", "id": "g-949e7b44df", "modified": "2022-04-04T16:20:21.796000-07:00", "name": "testtag2", "notificationDestinations": [ "SNS" ], "status": "ACTIVE" }, { "authentication": { "providers": [ "AWS_SSO" ] }, "created": "2022-04-20T10:22:15.115000-07:00", "description": "ww", "endpoint": "g-bffa51ed1b.grafana-workspace.us-east-1.amazonaws.com", "grafanaVersion": "8.2", "id": "g-bffa51ed1b", "modified": "2022-04-20T10:22:15.115000-07:00", "name": "ww", "notificationDestinations": [ "SNS" ], "status": "ACTIVE" } ] } ``` + Para ver detalhes da API, consulte [ListWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/grafana/list-workspaces.html) na *Referência de comandos da AWS CLI*. # Exemplos do MediaConnect usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o MediaConnect. *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-flow-outputs` O código de exemplo a seguir mostra como usar `add-flow-outputs`. **AWS CLI** **Para adicionar saídas a um fluxo** O exemplo `add-flow-outputs` a seguir adiciona saídas ao fluxo especificado. ``` aws mediaconnect add-flow-outputs \ --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame \ --outputs Description='NYC stream',Destination=192.0.2.12,Name=NYC,Port=3333,Protocol=rtp-fec,SmoothingLatency=100 Description='LA stream',Destination=203.0.113.9,Name=LA,Port=4444,Protocol=rtp-fec,SmoothingLatency=100 ``` Resultado: ``` { "Outputs": [ { "Port": 3333, "OutputArn": "arn:aws:mediaconnect:us-east-1:111122223333:output:2-3aBC45dEF67hiJ89-c34de5fG678h:NYC", "Name": "NYC", "Description": "NYC stream", "Destination": "192.0.2.12", "Transport": { "Protocol": "rtp-fec", "SmoothingLatency": 100 } }, { "Port": 4444, "OutputArn": "arn:aws:mediaconnect:us-east-1:111122223333:output:2-987655dEF67hiJ89-c34de5fG678h:LA", "Name": "LA", "Description": "LA stream", "Destination": "203.0.113.9", "Transport": { "Protocol": "rtp-fec", "SmoothingLatency": 100 } } ], "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame" } ``` Para obter mais informações, consulte [Adicionar saídas a um fluxo](https://docs.aws.amazon.com/mediaconnect/latest/ug/outputs-add.html) no *Guia do usuário do AWS Elemental MediaConnect*. + Para ver detalhes da API, consulte [AddFlowOutputs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/add-flow-outputs.html) na *Referência de comandos da AWS CLI*. ### `create-flow` O código de exemplo a seguir mostra como usar `create-flow`. **AWS CLI** **Para criar um fluxo** O exemplo `create-flow` a seguir cria um fluxo com a configuração especificada. ``` aws mediaconnect create-flow \ --availability-zone us-west-2c \ --name ExampleFlow \ --source Description='Example source, backup',IngestPort=1055,Name=BackupSource,Protocol=rtp,WhitelistCidr=10.24.34.0/23 ``` Resultado: ``` { "Flow": { "FlowArn": "arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:ExampleFlow", "AvailabilityZone": "us-west-2c", "EgressIp": "54.245.71.21", "Source": { "IngestPort": 1055, "SourceArn": "arn:aws:mediaconnect:us-east-1:123456789012:source:2-3aBC45dEF67hiJ89-c34de5fG678h:BackupSource", "Transport": { "Protocol": "rtp", "MaxBitrate": 80000000 }, "Description": "Example source, backup", "IngestIp": "54.245.71.21", "WhitelistCidr": "10.24.34.0/23", "Name": "mySource" }, "Entitlements": [], "Name": "ExampleFlow", "Outputs": [], "Status": "STANDBY", "Description": "Example source, backup" } } ``` Para obter mais informações, consulte [Criar um fluxo](https://docs.aws.amazon.com/mediaconnect/latest/ug/flows-create.html) no *Guia do usuário do AWS Elemental MediaConnect*. + Para ver detalhes da API, consulte [CreateFlow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/create-flow.html) na *Referência de comandos da AWS CLI*. ### `delete-flow` O código de exemplo a seguir mostra como usar `delete-flow`. **AWS CLI** **Para excluir um fluxo** O exemplo `delete-flow` a seguir exclui o fluxo especificado. ``` aws mediaconnect delete-flow \ --flow-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow ``` Resultado: ``` { "FlowArn": "arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow", "Status": "DELETING" } ``` Para obter mais informações, consulte [Excluir um fluxo](https://docs.aws.amazon.com/mediaconnect/latest/ug/flows-delete.html) no *Guia do usuário do AWS Elemental MediaConnect*. + Para ver detalhes da API, consulte [DeleteFlow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/delete-flow.html) na *Referência de comandos da AWS CLI*. ### `describe-flow` O código de exemplo a seguir mostra como usar `describe-flow`. **AWS CLI** **Para visualizar os detalhes de um fluxo** O exemplo `describe-flow` a seguir exibe os detalhes do fluxo especificado, como ARN, zona de disponibilidade, status, origem, direitos e saídas. ``` aws mediaconnect describe-flow \ --flow-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow ``` Resultado: ``` { "Flow": { "EgressIp": "54.201.4.39", "AvailabilityZone": "us-west-2c", "Status": "ACTIVE", "FlowArn": "arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow", "Entitlements": [ { "EntitlementArn": "arn:aws:mediaconnect:us-west-2:123456789012:entitlement:1-AaBb11CcDd22EeFf-34DE5fG12AbC:MyEntitlement", "Description": "Assign to this account", "Name": "MyEntitlement", "Subscribers": [ "444455556666" ] } ], "Description": "NYC awards show", "Name": "AwardsShow", "Outputs": [ { "Port": 2355, "Name": "NYC", "Transport": { "SmoothingLatency": 0, "Protocol": "rtp-fec" }, "OutputArn": "arn:aws:mediaconnect:us-east-1:123456789012:output:2-3aBC45dEF67hiJ89-c34de5fG678h:NYC", "Destination": "192.0.2.0" }, { "Port": 3025, "Name": "LA", "Transport": { "SmoothingLatency": 0, "Protocol": "rtp-fec" }, "OutputArn": "arn:aws:mediaconnect:us-east-1:123456789012:output:2-987655dEF67hiJ89-c34de5fG678h:LA", "Destination": "192.0.2.0" } ], "Source": { "IngestIp": "54.201.4.39", "SourceArn": "arn:aws:mediaconnect:us-east-1:123456789012:source:3-4aBC56dEF78hiJ90-4de5fG6Hi78Jk:ShowSource", "Transport": { "MaxBitrate": 80000000, "Protocol": "rtp" }, "IngestPort": 1069, "Description": "Saturday night show", "Name": "ShowSource", "WhitelistCidr": "10.24.34.0/23" } } } ``` Para obter mais informações, consulte [Visualizar detalhes do canal](https://docs.aws.amazon.com/mediaconnect/latest/ug/flows-view-details.html) no *Guia do usuário do AWS Elemental MediaConnect*. + Para ver detalhes da API, consulte [DescribeFlow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/describe-flow.html) na *Referência de comandos da AWS CLI*. ### `grant-flow-entitlements` O código de exemplo a seguir mostra como usar `grant-flow-entitlements`. **AWS CLI** **Como conceder um direito em um fluxo** O exemplo `grant-flow-entitlements` a seguir concede um direito ao fluxo existente especificado para compartilhar seu conteúdo com outra conta da AWS. ``` aws mediaconnect grant-flow-entitlements \ --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame \ --entitlements Description='For AnyCompany',Encryption={"Algorithm=aes128,KeyType=static-key,RoleArn=arn:aws:iam::111122223333:role/MediaConnect-ASM,SecretArn=arn:aws:secretsmanager:us-west-2:111122223333:secret:mySecret1"},Name=AnyCompany_Entitlement,Subscribers=444455556666 Description='For Example Corp',Name=ExampleCorp,Subscribers=777788889999 ``` Resultado: ``` { "Entitlements": [ { "Name": "AnyCompany_Entitlement", "EntitlementArn": "arn:aws:mediaconnect:us-west-2:111122223333:entitlement:1-11aa22bb11aa22bb-3333cccc4444:AnyCompany_Entitlement", "Subscribers": [ "444455556666" ], "Description": "For AnyCompany", "Encryption": { "SecretArn": "arn:aws:secretsmanager:us-west-2:111122223333:secret:mySecret1", "Algorithm": "aes128", "RoleArn": "arn:aws:iam::111122223333:role/MediaConnect-ASM", "KeyType": "static-key" } }, { "Name": "ExampleCorp", "EntitlementArn": "arn:aws:mediaconnect:us-west-2:111122223333:entitlement:1-3333cccc4444dddd-1111aaaa2222:ExampleCorp", "Subscribers": [ "777788889999" ], "Description": "For Example Corp" } ], "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame" } ``` Para obter mais informações, consulte [Conceder um direito a um fluxo](https://docs.aws.amazon.com/mediaconnect/latest/ug/entitlements-grant.html) no *Guia do usuário do AWS Elemental MediaConnect*. + Para ver detalhes da API, consulte [GrantFlowEntitlements](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/grant-flow-entitlements.html) na *Referência de comandos da AWS CLI*. ### `list-entitlements` O código de exemplo a seguir mostra como usar `list-entitlements`. **AWS CLI** **Como visualizar uma lista de direitos** O exemplo `list-entitlements` a seguir exibe uma lista de todos os direitos concedidos à conta. ``` aws mediaconnect list-entitlements ``` Resultado: ``` { "Entitlements": [ { "EntitlementArn": "arn:aws:mediaconnect:us-west-2:111122223333:entitlement:1-11aa22bb11aa22bb-3333cccc4444:MyEntitlement", "EntitlementName": "MyEntitlement" } ] } ``` Para obter mais informações, consulte [ListEntitlements](https://docs.aws.amazon.com/mediaconnect/latest/api/v1-entitlements.html) na *Referência da API AWS Elemental MediaConnect*. + Para ver detalhes da API, consulte [ListEntitlements](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/list-entitlements.html) na *Referência de comandos da AWS CLI*. ### `list-flows` O código de exemplo a seguir mostra como usar `list-flows`. **AWS CLI** **Como visualizar uma lista de fluxos** O exemplo `list-flows` a seguir exibe uma lista de fluxos. ``` aws mediaconnect list-flows ``` Resultado: ``` { "Flows": [ { "Status": "STANDBY", "SourceType": "OWNED", "AvailabilityZone": "us-west-2a", "Description": "NYC awards show", "Name": "AwardsShow", "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow" }, { "Status": "STANDBY", "SourceType": "OWNED", "AvailabilityZone": "us-west-2c", "Description": "LA basketball game", "Name": "BasketballGame", "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BasketballGame" } ] } ``` Para obter mais informações, consulte [Visualizar uma lista de fluxos](https://docs.aws.amazon.com/mediaconnect/latest/ug/flows-view-list.html) no *Guia do usuário do AWS Elemental MediaConnect*. + Para ver detalhes da API, consulte [ListFlows](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/list-flows.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar as tags de um recurso MediaConnect** O exemplo `list-tags-for-resource` a seguir exibe as chaves de tag e valores associados ao recurso do MediaConnect especificado. ``` aws mediaconnect list-tags-for-resource \ --resource-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BasketballGame ``` Resultado: ``` { "Tags": { "region": "west", "stage": "prod" } } ``` Para obter mais informações, consulte [ListTagsForResource, TagResource, UntagResource](https://docs.aws.amazon.com/mediaconnect/latest/api/tags-resourcearn.html) na *Referência da API AWS Elemental MediaConnect*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `remove-flow-output` O código de exemplo a seguir mostra como usar `remove-flow-output`. **AWS CLI** **Para remover uma saída de um fluxo** O exemplo `remove-flow-output` a seguir remove uma saída do fluxo especificado. ``` aws mediaconnect remove-flow-output \ --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame \ --output-arn arn:aws:mediaconnect:us-east-1:111122223333:output:2-3aBC45dEF67hiJ89-c34de5fG678h:NYC ``` Resultado: ``` { "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame", "OutputArn": "arn:aws:mediaconnect:us-east-1:111122223333:output:2-3aBC45dEF67hiJ89-c34de5fG678h:NYC" } ``` Para obter mais informações, consulte [Remover saídas de um fluxo](https://docs.aws.amazon.com/mediaconnect/latest/ug/outputs-remove.html) no *Guia do usuário do AWS Elemental MediaConnect*. + Para ver detalhes da API, consulte [RemoveFlowOutput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/remove-flow-output.html) na *Referência de comandos da AWS CLI*. ### `revoke-flow-entitlement` O código de exemplo a seguir mostra como usar `revoke-flow-entitlement`. **AWS CLI** **Como revogar um direito** O exemplo `revoke-flow-entitlement` a seguir revoga um direito no fluxo especificado. ``` aws mediaconnect revoke-flow-entitlement \ --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame \ --entitlement-arn arn:aws:mediaconnect:us-west-2:111122223333:entitlement:1-11aa22bb11aa22bb-3333cccc4444:AnyCompany_Entitlement ``` Resultado: ``` { "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame", "EntitlementArn": "arn:aws:mediaconnect:us-west-2:111122223333:entitlement:1-11aa22bb11aa22bb-3333cccc4444:AnyCompany_Entitlement" } ``` Para obter mais informações, consulte [Revogar um direito](https://docs.aws.amazon.com/mediaconnect/latest/ug/entitlements-revoke.html) no *Guia do usuário do AWS Elemental MediaConnect*. + Para ver detalhes da API, consulte [RevokeFlowEntitlement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/revoke-flow-entitlement.html) na *Referência de comandos da AWS CLI*. ### `start-flow` O código de exemplo a seguir mostra como usar `start-flow`. **AWS CLI** **Para iniciar um fluxo** O exemplo `start-flow` a seguir inicia o fluxo especificado. ``` aws mediaconnect start-flow \ --flow-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow ``` Este comando não produz saída. Resultado: ``` { "FlowArn": "arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow", "Status": "STARTING" } ``` Para obter mais informações, consulte [Iniciar um fluxo](https://docs.aws.amazon.com/mediaconnect/latest/ug/flows-start.html) no *Guia do usuário do AWS Elemental MediaConnect*. + Para ver detalhes da API, consulte [StartFlow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/start-flow.html) na *Referência de comandos da AWS CLI*. ### `stop-flow` O código de exemplo a seguir mostra como usar `stop-flow`. **AWS CLI** **Como interromper um fluxo** O exemplo `stop-flow` a seguir interrompe o fluxo especificado. ``` aws mediaconnect stop-flow \ --flow-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow ``` Resultado: ``` { "Status": "STOPPING", "FlowArn": "arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow" } ``` Para obter mais informações, consulte [Interromper um fluxo](https://docs.aws.amazon.com/mediaconnect/latest/ug/flows-stop.html) no *Guia do usuário do AWS Elemental MediaConnect*. + Para ver detalhes da API, consulte [StopFlow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/stop-flow.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Para adicionar tags a um recurso MediaConnect** O exemplo `tag-resource` a seguir adiciona uma tag com o nome de chave e valor ao recurso MediaConnect especificado. ``` aws mediaconnect tag-resource \ --resource-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BasketballGame --tags region=west ``` Este comando não produz saída. Para obter mais informações, consulte [ListTagsForResource, TagResource, UntagResource](https://docs.aws.amazon.com/mediaconnect/latest/api/tags-resourcearn.html) na *Referência da API AWS Elemental MediaConnect*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover as tags de um recurso MediaConnect** O exemplo `untag-resource` a seguir remove a tag com o nome de chave especificado e seu valor associado de um recurso MediaConnect. ``` aws mediaconnect untag-resource \ --resource-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BasketballGame \ --tag-keys region ``` Este comando não produz saída. Para obter mais informações, consulte [ListTagsForResource, TagResource, UntagResource](https://docs.aws.amazon.com/mediaconnect/latest/api/tags-resourcearn.html) na *Referência da API AWS Elemental MediaConnect*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-flow-entitlement` O código de exemplo a seguir mostra como usar `update-flow-entitlement`. **AWS CLI** **Para atualizar um direito** O exemplo `update-flow-entitlement` a seguir atualiza o direito especificado com uma nova descrição e um novo assinante. ``` aws mediaconnect update-flow-entitlement \ --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame \ --entitlement-arn arn:aws:mediaconnect:us-west-2:111122223333:entitlement:1-11aa22bb11aa22bb-3333cccc4444:AnyCompany_Entitlement \ --description 'For AnyCompany Affiliate' \ --subscribers 777788889999 ``` Resultado: ``` { "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame", "Entitlement": { "Name": "AnyCompany_Entitlement", "Description": "For AnyCompany Affiliate", "EntitlementArn": "arn:aws:mediaconnect:us-west-2:111122223333:entitlement:1-11aa22bb11aa22bb-3333cccc4444:AnyCompany_Entitlement", "Encryption": { "KeyType": "static-key", "Algorithm": "aes128", "RoleArn": "arn:aws:iam::111122223333:role/MediaConnect-ASM", "SecretArn": "arn:aws:secretsmanager:us-west-2:111122223333:secret:mySecret1" }, "Subscribers": [ "777788889999" ] } } ``` Para obter mais informações, consulte [Atualizar um direito](https://docs.aws.amazon.com/mediaconnect/latest/ug/entitlements-update.html) no *Guia do usuário do AWS Elemental MediaConnect*. + Para ver detalhes da API, consulte [UpdateFlowEntitlement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/update-flow-entitlement.html) na *Referência de comandos da AWS CLI*. ### `update-flow-output` O código de exemplo a seguir mostra como usar `update-flow-output`. **AWS CLI** **Para atualizar uma saída em um fluxo** O exemplo `update-flow-output` a seguir remove uma saída do fluxo especificado. ``` aws mediaconnect update-flow-output \ --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame \ --output-arn arn:aws:mediaconnect:us-east-1:111122223333:output:2-3aBC45dEF67hiJ89-c34de5fG678h:NYC \ --port 3331 ``` Resultado: ``` { "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame", "Output": { "Name": "NYC", "Port": 3331, "Description": "NYC stream", "Transport": { "Protocol": "rtp-fec", "SmoothingLatency": 100 }, "OutputArn": "arn:aws:mediaconnect:us-east-1:111122223333:output:2-3aBC45dEF67hiJ89-c34de5fG678h:NYC", "Destination": "192.0.2.12" } } ``` Para obter mais informações, consulte [Atualizar saídas a um fluxo](https://docs.aws.amazon.com/mediaconnect/latest/ug/outputs-update.html) no *Guia do usuário do AWS Elemental MediaConnect*. + Para ver detalhes da API, consulte [UpdateFlowOutput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/update-flow-output.html) na *Referência de comandos da AWS CLI*. ### `update-flow-source` O código de exemplo a seguir mostra como usar `update-flow-source`. **AWS CLI** **Para atualizar a origem de um fluxo existente** O exemplo `update-flow-source` a seguir atualiza a origem de um fluxo existente. ``` aws mediaconnect update-flow-source \ --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow \ --source-arn arn:aws:mediaconnect:us-east-1:111122223333:source:3-4aBC56dEF78hiJ90-4de5fG6Hi78Jk:ShowSource \ --description 'Friday night show' \ --ingest-port 3344 \ --protocol rtp-fec \ --whitelist-cidr 10.24.34.0/23 ``` Resultado: ``` { "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow", "Source": { "IngestIp": "34.210.136.56", "WhitelistCidr": "10.24.34.0/23", "Transport": { "Protocol": "rtp-fec" }, "IngestPort": 3344, "Name": "ShowSource", "Description": "Friday night show", "SourceArn": "arn:aws:mediaconnect:us-east-1:111122223333:source:3-4aBC56dEF78hiJ90-4de5fG6Hi78Jk:ShowSource" } } ``` Para obter mais informações, consulte [Atualizar a fonte de um fluxo](https://docs.aws.amazon.com/mediaconnect/latest/ug/source-update.html) no *Guia do usuário do AWS Elemental MediaConnect*. + Para ver detalhes da API, consulte [UpdateFlowSource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/update-flow-source.html) na *Referência de comandos da AWS CLI*. # Exemplos do MediaConvert usando o AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o MediaConvert. *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 ### `cancel-job` O código de exemplo a seguir mostra como usar `cancel-job`. **AWS CLI** **Para cancelar um trabalho que está em uma fila** O exemplo `cancel-job` a seguir cancela um trabalho que tenha o ID `1234567891234-abc123`. Não é possível cancelar um trabalho depois que o serviço começar a processá-lo. ``` aws mediaconvert cancel-job \ --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com \ --region region-name-1 \ --id 1234567891234-abc123 ``` Use `describe-endpoints` para obter o endpoint específico da sua conta ou envie o comando sem o endpoint. O serviço retorna um erro e o endpoint. Para obter mais informações, consulte [Working with AWS Elemental MediaConvert Jobs](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-jobs.html) no *Guia do usuário do AWS Elemental MediaConvert*. + Para ver detalhes da API, consulte [CancelJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/cancel-job.html) na *Referência de comandos da AWS CLI*. ### `create-job-template` O código de exemplo a seguir mostra como usar `create-job-template`. **AWS CLI** **Criar um modelo de trabalho** O exemplo `create-job-template` a seguir cria um trabalho com as configurações de transcodificação especificadas em um arquivo `job-template.json` presente no sistema. ``` aws mediaconvert create-job-template \ --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com \ --region region-name-1 \ --name JobTemplate1 \ --cli-input-json file://~/job-template.json ``` Se o arquivo de modelo de trabalho JSON criado usando `get-job-template` for posteriormente modificando, é necessário remover o objeto `JobTemplate`, mas manter o objeto-filho de Configurações dentro dele. Além disso, deve-se remover os seguintes pares de valores-chave: `LastUpdated`, `Arn`, `Type` e `CreatedAt`. É possível especificar a categoria, a descrição, o nome e a fila no arquivo JSON ou na linha de comando. Use `describe-endpoints` para obter o endpoint específico da sua conta ou envie o comando sem o endpoint. O serviço retorna um erro e o endpoint. Se a solicitação for bem-sucedida, o serviço retornará a especificação JSON do modelo de trabalho criado. Para obter mais informações, consulte [Trabalhar com modelos de trabalho do AWS Elemental MediaConvert](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-job-templates.html) no *Guia do usuário do AWS Elemental MediaConvert*. + Para ver detalhes da API, consulte [CreateJobTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/create-job-template.html) na *Referência de comandos da AWS CLI*. ### `create-job` O código de exemplo a seguir mostra como usar `create-job`. **AWS CLI** **Como criar um trabalho** O exemplo de `create-job` a seguir cria um trabalho de transcodificação com as configurações especificadas em um arquivo `job.json` presente no sistema que você usou para enviar o comando. Essa especificação de trabalho JSON pode especificar cada configuração individualmente, fazer referência a um modelo de trabalho ou a predefinições de saída. ``` aws mediaconvert create-job \ --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com \ --region region-name-1 \ --cli-input-json file://~/job.json ``` Você pode usar o console do AWS Elemental MediaConvert para gerar a especificação do trabalho JSON escolhendo as configurações do trabalho e depois selecionando **Mostrar JSON de trabalho** na parte inferior da seção **Trabalho**. Use `describe-endpoints` para obter o endpoint específico da sua conta ou envie o comando sem o endpoint. O serviço retorna um erro e o endpoint. Se a solicitação for bem-sucedida, o serviço retornará a especificação do trabalho JSON enviado com a solicitação. Para obter mais informações, consulte [Working with AWS Elemental MediaConvert Jobs](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-jobs.html) no *Guia do usuário do AWS Elemental MediaConvert*. + Consulte detalhes da API em [CreateJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/create-job.html) na *Referência de comandos da AWS CLI*. ### `create-preset` O código de exemplo a seguir mostra como usar `create-preset`. **AWS CLI** **Para criar uma predefinição de saída personalizada** O exemplo `create-preset` a seguir cria uma predefinição de saída personalizada com base nas configurações de saída especificadas no arquivo `preset.json`. É possível especificar a categoria, a descrição e o nome no arquivo JSON ou na linha de comando. ``` aws mediaconvert create-preset \ --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com --region region-name-1 \ --cli-input-json file://~/preset.json ``` Se o arquivo de pré-definições JSON for criado usando `get-preset` e o arquivo de saída for posteriormente modificando, é necessário remover os seguintes pares de valores-chave: `LastUpdated`, `Arn`, `Type` e `CreatedAt`. Use `describe-endpoints` para obter o endpoint específico da sua conta ou envie o comando sem o endpoint. O serviço retorna um erro e o endpoint. Para obter mais informações, consulte [Trabalhar com pré-definições de saída com o AWS Elemental MediaConvert](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-presets.html) no *Guia do usuário do AWS Elemental MediaConvert*. + Para ver detalhes da API, consulte [CreatePreset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/create-preset.html) na *Referência de comandos da AWS CLI*. ### `create-queue` O código de exemplo a seguir mostra como usar `create-queue`. **AWS CLI** **Para criar uma fila personalizada** O exemplo `create-queue` a seguir cria uma fila de transcodificação personalizada. ``` aws mediaconvert create-queue \ --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com \ --region region-name-1 \ --name Queue1 \ --description "Keep this queue empty unless job is urgent." ``` Use `describe-endpoints` para obter o endpoint específico da sua conta ou envie o comando sem o endpoint. O serviço retorna um erro e o endpoint. Resultado: ``` { "Queue": { "Status": "ACTIVE", "Name": "Queue1", "LastUpdated": 1518034928, "Arn": "arn:aws:mediaconvert:region-name-1:012345678998:queues/Queue1", "Type": "CUSTOM", "CreatedAt": 1518034928, "Description": "Keep this queue empty unless job is urgent." } } ``` Para obter mais informações, consulte [Trabalhar com filas no AWS Elemental MediaConvert](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html) no *Guia do usuário do AWS Elemental MediaConvert*. + Consulte detalhes da API em [CreateQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/create-queue.html) na *Referência de comandos da AWS CLI*. ### `delete-job-template` O código de exemplo a seguir mostra como usar `delete-job-template`. **AWS CLI** **Para excluir um modelo de trabalho** O exemplo `delete-job-template` a seguir exclui o modelo de trabalho personalizado especificado. ``` aws mediaconvert delete-job-template \ --name "DASH Streaming" \ --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com ``` Este comando não produz saída. Execute `aws mediaconvert list-job-templates` para confirmar que seu modelo foi excluído. Para obter mais informações, consulte [Trabalhar com modelos de trabalho do AWS Elemental MediaConvert](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-job-templates.html) no *Guia do usuário do AWS Elemental MediaConvert*. + Para ver detalhes da API, consulte [DeleteJobTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/delete-job-template.html) na *Referência de comandos da AWS CLI*. ### `delete-preset` O código de exemplo a seguir mostra como usar `delete-preset`. **AWS CLI** **Para excluir uma fila sob demanda** O exemplo `delete-preset` a seguir exclui a pré-definição personalizada especificada. ``` aws mediaconvert delete-preset \ --name SimpleMP4 \ --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com ``` Este comando não produz saída. Execute `aws mediaconvert list-presets` para confirmar que a pré-definição foi excluída. Para obter mais informações, consulte [Trabalhar com pré-definições de saída com o AWS Elemental MediaConvert](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-presets.html) no *Guia do usuário do AWS Elemental MediaConvert*. + Para ver detalhes da API, consulte [DeletePreset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/delete-preset.html) na *Referência de comandos da AWS CLI*. ### `delete-queue` O código de exemplo a seguir mostra como usar `delete-queue`. **AWS CLI** **Para excluir uma fila sob demanda** O exemplo `delete-queue` a seguir exclui a fila sob demanda personalizada especificada. Não é possível excluir sua fila padrão. Não é possível excluir uma fila reservada que tenha um plano de preços ativo ou que contenha tarefas não processadas. ``` aws mediaconvert delete-queue \ --name Customer1 \ --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com ``` Este comando não produz saída. Execute `aws mediaconvert list-queues` para confirmar que a fila foi excluída. Para obter mais informações, consulte [Trabalhar com filas no AWS Elemental MediaConvert](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html) no *Guia do usuário do AWS Elemental MediaConvert*. + Consulte detalhes da API em [DeleteQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/delete-queue.html) na *Referência de comandos da AWS CLI*. ### `describe-endpoints` O código de exemplo a seguir mostra como usar `describe-endpoints`. **AWS CLI** **Para obter o endpoint específico da conta** O exemplo `describe-endpoints` a seguir recupera o endpoint necessário para enviar qualquer outra solicitação ao serviço. ``` aws mediaconvert describe-endpoints ``` Resultado: ``` { "Endpoints": [ { "Url": "https://abcd1234.mediaconvert.region-name-1.amazonaws.com" } ] } ``` Para obter mais informações, consulte [Conceitos básicos do MediaConvert usando a API](https://docs.aws.amazon.com/mediaconvert/latest/apireference/getting-started.html) na *Referência da API do AWS MediaConvert*. + Para ver detalhes da API, consulte [DescribeEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/describe-endpoints.html) na *Referência de comandos da AWS CLI*. ### `get-job-template` O código de exemplo a seguir mostra como usar `get-job-template`. **AWS CLI** **Obtenha detalhes sobre um modelo de trabalho** O exemplo `get-job-template` a seguir exibe a definição JSON do modelo de trabalho personalizado especificado. ``` aws mediaconvert get-job-template \ --name "DASH Streaming" \ --endpoint-url https://abcd1234.mediaconvert.us-east-1.amazonaws.com ``` Resultado: ``` { "JobTemplate": { "StatusUpdateInterval": "SECONDS_60", "LastUpdated": 1568652998, "Description": "Create a DASH streaming ABR stack", "CreatedAt": 1568652998, "Priority": 0, "Name": "DASH Streaming", "Settings": { ...... }, "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:jobTemplates/DASH Streaming", "Type": "CUSTOM" } } ``` Para obter mais informações, consulte [Trabalhar com modelos de trabalho do AWS Elemental MediaConvert](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-job-templates.html) no *Guia do usuário do AWS Elemental MediaConvert*. + Para ver detalhes da API, consulte [GetJobTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/get-job-template.html) na *Referência de comandos da AWS CLI*. ### `get-job` O código de exemplo a seguir mostra como usar `get-job`. **AWS CLI** **Como obter detalhes de um trabalho específico** O exemplo a seguir solicita as informações do trabalho com o ID `1234567890987-1ab2c3` que, neste exemplo, resultou em erro. ``` aws mediaconvert get-job \ --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com \ --region region-name-1 \ --id 1234567890987-1ab2c3 ``` Use `describe-endpoints` para obter o endpoint específico da sua conta ou envie o comando sem o endpoint. O serviço retorna um erro e o endpoint. Se a solicitação for bem-sucedida, o serviço retornará um arquivo JSON com as informações do trabalho, incluindo as configurações do trabalho, quaisquer erros retornados e outros dados do trabalho, da seguinte forma: ``` { "Job": { "Status": "ERROR", "Queue": "arn:aws:mediaconvert:region-name-1:012345678998:queues/Queue1", "Settings": { ...... }, "ErrorMessage": "Unable to open input file [s3://my-input-bucket/file-name.mp4]: [Failed probe/open: [Failed to read data: AssumeRole failed]]", "ErrorCode": 1434, "Role": "arn:aws:iam::012345678998:role/MediaConvertServiceRole", "Arn": "arn:aws:mediaconvert:us-west-1:012345678998:jobs/1234567890987-1ab2c3", "UserMetadata": {}, "Timing": { "FinishTime": 1517442131, "SubmitTime": 1517442103, "StartTime": 1517442104 }, "Id": "1234567890987-1ab2c3", "CreatedAt": 1517442103 } } ``` Para obter mais informações, consulte [Working with AWS Elemental MediaConvert Jobs](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-jobs.html) no *Guia do usuário do AWS Elemental MediaConvert*. + Consulte detalhes da API em [GetJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/get-job.html) na *Referência de comandos da AWS CLI*. ### `get-preset` O código de exemplo a seguir mostra como usar `get-preset`. **AWS CLI** **Para obter detalhes de uma pré-definição específica** O exemplo `get-preset` a seguir solicita a definição JSON da pré-definição personalizada especificada. ``` aws mediaconvert get-preset \ --name SimpleMP4 \ --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com ``` Resultado: ``` { "Preset": { "Description": "Creates basic MP4 file. No filtering or preproccessing.", "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:presets/SimpleMP4", "LastUpdated": 1568843141, "Name": "SimpleMP4", "Settings": { "ContainerSettings": { "Mp4Settings": { "FreeSpaceBox": "EXCLUDE", "CslgAtom": "INCLUDE", "MoovPlacement": "PROGRESSIVE_DOWNLOAD" }, "Container": "MP4" }, "AudioDescriptions": [ { "LanguageCodeControl": "FOLLOW_INPUT", "AudioTypeControl": "FOLLOW_INPUT", "CodecSettings": { "AacSettings": { "RawFormat": "NONE", "CodecProfile": "LC", "AudioDescriptionBroadcasterMix": "NORMAL", "SampleRate": 48000, "Bitrate": 96000, "RateControlMode": "CBR", "Specification": "MPEG4", "CodingMode": "CODING_MODE_2_0" }, "Codec": "AAC" } } ], "VideoDescription": { "RespondToAfd": "NONE", "TimecodeInsertion": "DISABLED", "Sharpness": 50, "ColorMetadata": "INSERT", "CodecSettings": { "H264Settings": { "FramerateControl": "INITIALIZE_FROM_SOURCE", "SpatialAdaptiveQuantization": "ENABLED", "Softness": 0, "Telecine": "NONE", "CodecLevel": "AUTO", "QualityTuningLevel": "SINGLE_PASS", "UnregisteredSeiTimecode": "DISABLED", "Slices": 1, "Syntax": "DEFAULT", "GopClosedCadence": 1, "AdaptiveQuantization": "HIGH", "EntropyEncoding": "CABAC", "InterlaceMode": "PROGRESSIVE", "ParControl": "INITIALIZE_FROM_SOURCE", "NumberBFramesBetweenReferenceFrames": 2, "GopSizeUnits": "FRAMES", "RepeatPps": "DISABLED", "CodecProfile": "MAIN", "FieldEncoding": "PAFF", "GopSize": 90.0, "SlowPal": "DISABLED", "SceneChangeDetect": "ENABLED", "GopBReference": "DISABLED", "RateControlMode": "CBR", "FramerateConversionAlgorithm": "DUPLICATE_DROP", "FlickerAdaptiveQuantization": "DISABLED", "DynamicSubGop": "STATIC", "MinIInterval": 0, "TemporalAdaptiveQuantization": "ENABLED", "Bitrate": 400000, "NumberReferenceFrames": 3 }, "Codec": "H_264" }, "AfdSignaling": "NONE", "AntiAlias": "ENABLED", "ScalingBehavior": "DEFAULT", "DropFrameTimecode": "ENABLED" } }, "Type": "CUSTOM", "CreatedAt": 1568841521 } } ``` Para obter mais informações, consulte [Trabalhar com pré-definições de saída com o AWS Elemental MediaConvert](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-presets.html) no *Guia do usuário do AWS Elemental MediaConvert*. + Para ver detalhes da API, consulte [GetPreset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/get-preset.html) na *Referência de comandos da AWS CLI*. ### `get-queue` O código de exemplo a seguir mostra como usar `get-queue`. **AWS CLI** **Para obter detalhes de uma fila** O exemplo `get-queue` a seguir recupera detalhes sobre a fila personalizada especificada. ``` aws mediaconvert get-queue \ --name Customer1 \ --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com ``` Resultado: ``` { "Queue": { "LastUpdated": 1526428502, "Type": "CUSTOM", "SubmittedJobsCount": 0, "Status": "ACTIVE", "PricingPlan": "ON_DEMAND", "CreatedAt": 1526428502, "ProgressingJobsCount": 0, "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:queues/Customer1", "Name": "Customer1" } } ``` Para obter mais informações, consulte [Trabalhar com filas no AWS Elemental MediaConvert](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html) no *Guia do usuário do AWS Elemental MediaConvert*. + Para ver detalhes da API, consulte [GetQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/get-queue.html) na *Referência de comandos da AWS CLI*. ### `list-job-templates` O código de exemplo a seguir mostra como usar `list-job-templates`. **AWS CLI** **Exemplo 1: listar seus modelos de trabalho personalizados** O exemplo `list-job-templates` a seguir lista todos os modelos de trabalho personalizados na região atual. Para listar os modelos de trabalho do sistema, consulte o próximo exemplo. ``` aws mediaconvert list-job-templates \ --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com ``` Resultado: ``` { "JobTemplates": [ { "Description": "Create a DASH streaming ABR stack", "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:jobTemplates/DASH Streaming", "Name": "DASH Streaming", "LastUpdated": 1568653007, "Priority": 0, "Settings": { ...... }, "Type": "CUSTOM", "StatusUpdateInterval": "SECONDS_60", "CreatedAt": 1568653007 }, { "Description": "Create a high-res file", "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:jobTemplates/File", "Name": "File", "LastUpdated": 1568653007, "Priority": 0, "Settings": { ...... }, "Type": "CUSTOM", "StatusUpdateInterval": "SECONDS_60", "CreatedAt": 1568653023 } ] } ``` **Exemplo 2: listar os modelos de trabalho do sistema do MediaConvert** O exemplo `list-job-templates` a seguir lista todos os modelos de trabalho do sistema. ``` aws mediaconvert list-job-templates \ --endpoint-url https://abcd1234.mediaconvert.us-east-1.amazonaws.com \ --list-by SYSTEM ``` Resultado: ``` { "JobTemplates": [ { "CreatedAt": 1568321779, "Arn": "arn:aws:mediaconvert:us-east-1:123456789012:jobTemplates/System-Generic_Mp4_Hev1_Avc_Aac_Sdr_Qvbr", "Name": "System-Generic_Mp4_Hev1_Avc_Aac_Sdr_Qvbr", "Description": "GENERIC, MP4, AVC + HEV1(HEVC,SDR), AAC, SDR, QVBR", "Category": "GENERIC", "Settings": { "AdAvailOffset": 0, "OutputGroups": [ { "Outputs": [ { "Extension": "mp4", "Preset": "System-Generic_Hd_Mp4_Avc_Aac_16x9_Sdr_1280x720p_30Hz_5Mbps_Qvbr_Vq9", "NameModifier": "_Generic_Hd_Mp4_Avc_Aac_16x9_Sdr_1280x720p_30Hz_5000Kbps_Qvbr_Vq9" }, { "Extension": "mp4", "Preset": "System-Generic_Hd_Mp4_Avc_Aac_16x9_Sdr_1920x1080p_30Hz_10Mbps_Qvbr_Vq9", "NameModifier": "_Generic_Hd_Mp4_Avc_Aac_16x9_Sdr_1920x1080p_30Hz_10000Kbps_Qvbr_Vq9" }, { "Extension": "mp4", "Preset": "System-Generic_Sd_Mp4_Avc_Aac_16x9_Sdr_640x360p_30Hz_0.8Mbps_Qvbr_Vq7", "NameModifier": "_Generic_Sd_Mp4_Avc_Aac_16x9_Sdr_640x360p_30Hz_800Kbps_Qvbr_Vq7" }, { "Extension": "mp4", "Preset": "System-Generic_Hd_Mp4_Hev1_Aac_16x9_Sdr_1280x720p_30Hz_4Mbps_Qvbr_Vq9", "NameModifier": "_Generic_Hd_Mp4_Hev1_Aac_16x9_Sdr_1280x720p_30Hz_4000Kbps_Qvbr_Vq9" }, { "Extension": "mp4", "Preset": "System-Generic_Hd_Mp4_Hev1_Aac_16x9_Sdr_1920x1080p_30Hz_8Mbps_Qvbr_Vq9", "NameModifier": "_Generic_Hd_Mp4_Hev1_Aac_16x9_Sdr_1920x1080p_30Hz_8000Kbps_Qvbr_Vq9" }, { "Extension": "mp4", "Preset": "System-Generic_Uhd_Mp4_Hev1_Aac_16x9_Sdr_3840x2160p_30Hz_12Mbps_Qvbr_Vq9", "NameModifier": "_Generic_Uhd_Mp4_Hev1_Aac_16x9_Sdr_3840x2160p_30Hz_12000Kbps_Qvbr_Vq9" } ], "OutputGroupSettings": { "FileGroupSettings": { }, "Type": "FILE_GROUP_SETTINGS" }, "Name": "File Group" } ] }, "Type": "SYSTEM", "LastUpdated": 1568321779 }, ...... ] } ``` Para obter mais informações, consulte [Trabalhar com modelos de trabalho do AWS Elemental MediaConvert](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-job-templates.html) no *Guia do usuário do AWS Elemental MediaConvert*. + Para ver detalhes da API, consulte [ListJobTemplates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/list-job-templates.html) na *Referência de comandos da AWS CLI*. ### `list-jobs` O código de exemplo a seguir mostra como usar `list-jobs`. **AWS CLI** **Como obter detalhes de todos os trabalhos de uma região** O exemplo a seguir solicita as informações de todos os trabalhos na região especificada. ``` aws mediaconvert list-jobs \ --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com \ --region region-name-1 ``` Use `describe-endpoints` para obter o endpoint específico da sua conta ou envie o comando sem o endpoint. O serviço retorna um erro e o endpoint. Para obter mais informações, consulte [Working with AWS Elemental MediaConvert Jobs](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-jobs.html) no *Guia do usuário do AWS Elemental MediaConvert*. + Consulte detalhes da API em [ListJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/list-jobs.html) na *Referência de comandos da AWS CLI*. ### `list-presets` O código de exemplo a seguir mostra como usar `list-presets`. **AWS CLI** **Exemplo 1: listar suas predefinições de saída personalizadas** O exemplo `list-presets` a seguir lista suas predefinições de saída personalizadas. Para listar as pré-definições do sistema, consulte o próximo exemplo. ``` aws mediaconvert list-presets \ --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com ``` Resultado: ``` { "Presets": [ { "Name": "SimpleMP4", "CreatedAt": 1568841521, "Settings": { ...... }, "Arn": "arn:aws:mediaconvert:us-east-1:003235472598:presets/SimpleMP4", "Type": "CUSTOM", "LastUpdated": 1568843141, "Description": "Creates basic MP4 file. No filtering or preproccessing." }, { "Name": "SimpleTS", "CreatedAt": 1568843113, "Settings": { ... truncated for brevity ... }, "Arn": "arn:aws:mediaconvert:us-east-1:003235472598:presets/SimpleTS", "Type": "CUSTOM", "LastUpdated": 1568843113, "Description": "Create a basic transport stream." } ] } ``` **Exemplo 2: listar as predefinições de saída do sistema** O exemplo `list-presets` a seguir lista as predefinições de sistema do MediaConvert disponíveis. Para listar suas predefinições personalizadas, consulte o exemplo anterior. ``` aws mediaconvert list-presets \ --list-by SYSTEM \ --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com ``` Resultado: ``` { "Presets": [ { "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:presets/System-Avc_16x9_1080p_29_97fps_8500kbps", "Name": "System-Avc_16x9_1080p_29_97fps_8500kbps", "CreatedAt": 1568321789, "Description": "Wifi, 1920x1080, 16:9, 29.97fps, 8500kbps", "LastUpdated": 1568321789, "Type": "SYSTEM", "Category": "HLS", "Settings": { ...... } }, ...... { "Arn": "arn:aws:mediaconvert:us-east-1:123456789012:presets/System-Xdcam_HD_1080i_29_97fps_35mpbs", "Name": "System-Xdcam_HD_1080i_29_97fps_35mpbs", "CreatedAt": 1568321790, "Description": "XDCAM MPEG HD, 1920x1080i, 29.97fps, 35mbps", "LastUpdated": 1568321790, "Type": "SYSTEM", "Category": "MXF", "Settings": { ...... } } ] } ``` Para obter mais informações, consulte [Trabalhar com pré-definições de saída com o AWS Elemental MediaConvert](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-presets.html) no *Guia do usuário do AWS Elemental MediaConvert*. + Para ver detalhes da API, consulte [ListPresets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/list-presets.html) na *Referência de comandos da AWS CLI*. ### `list-queues` O código de exemplo a seguir mostra como usar `list-queues`. **AWS CLI** **Para listar as filas** O exemplo `list-queues` a seguir lista todas as filas MediaConvert. ``` aws mediaconvert list-queues \ --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com ``` Resultado: ``` { "Queues": [ { "PricingPlan": "ON_DEMAND", "Type": "SYSTEM", "Status": "ACTIVE", "CreatedAt": 1503451595, "Name": "Default", "SubmittedJobsCount": 0, "ProgressingJobsCount": 0, "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:queues/Default", "LastUpdated": 1534549158 }, { "PricingPlan": "ON_DEMAND", "Type": "CUSTOM", "Status": "ACTIVE", "CreatedAt": 1537460025, "Name": "Customer1", "SubmittedJobsCount": 0, "Description": "Jobs we run for our cusotmer.", "ProgressingJobsCount": 0, "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:queues/Customer1", "LastUpdated": 1537460025 }, { "ProgressingJobsCount": 0, "Status": "ACTIVE", "Name": "transcode-library", "SubmittedJobsCount": 0, "LastUpdated": 1564066204, "ReservationPlan": { "Status": "ACTIVE", "ReservedSlots": 1, "PurchasedAt": 1564066203, "Commitment": "ONE_YEAR", "ExpiresAt": 1595688603, "RenewalType": "EXPIRE" }, "PricingPlan": "RESERVED", "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:queues/transcode-library", "Type": "CUSTOM", "CreatedAt": 1564066204 } ] } ``` Para obter mais informações, consulte [Trabalhar com filas no AWS Elemental MediaConvert](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html) no *Guia do usuário do AWS Elemental MediaConvert*. + Consulte detalhes da API em [ListQueues](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/list-queues.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar as tags de uma fila, modelo de trabalho ou predefinição de saída do MediaConvert** O exemplo `list-tags-for-resource` a seguir lista as tags da pré-definição de saída especificada. ``` aws mediaconvert list-tags-for-resource \ --arn arn:aws:mediaconvert:us-west-2:123456789012:presets/SimpleMP4 \ --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com ``` Resultado: ``` { "ResourceTags": { "Tags": { "customer": "zippyVideo" }, "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:presets/SimpleMP4" } } ``` Para obter mais informações, consulte [Adicionar tags em filas, modelos de trabalho e pré-definições de saída do AWS Elemental MediaConvert](https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-queues-templates-presets.html) no *Guia do usuário do AWS Elemental MediaConvert*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `update-job-template` O código de exemplo a seguir mostra como usar `update-job-template`. **AWS CLI** **Para alterar um modelo de trabalho** O exemplo `update-job-template` a seguir substitui a definição JSON do modelo de trabalho especificado pela definição JSON no arquivo fornecido. aws mediaconvert update-job-template --name File1 --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com --cli-input-json file://\$1/job-template-update.json Conteúdo de `job-template-update.json`: ``` { "Description": "A simple job template that generates a single file output.", "Queue": "arn:aws:mediaconvert:us-east-1:012345678998:queues/Default", "Name": "SimpleFile", "Settings": { "OutputGroups": [ { "Name": "File Group", "Outputs": [ { "ContainerSettings": { "Container": "MP4", "Mp4Settings": { "CslgAtom": "INCLUDE", "FreeSpaceBox": "EXCLUDE", "MoovPlacement": "PROGRESSIVE_DOWNLOAD" } }, "VideoDescription": { "ScalingBehavior": "DEFAULT", "TimecodeInsertion": "DISABLED", "AntiAlias": "ENABLED", "Sharpness": 50, "CodecSettings": { "Codec": "H_264", "H264Settings": { "InterlaceMode": "PROGRESSIVE", "NumberReferenceFrames": 3, "Syntax": "DEFAULT", "Softness": 0, "GopClosedCadence": 1, "GopSize": 90, "Slices": 1, "GopBReference": "DISABLED", "SlowPal": "DISABLED", "SpatialAdaptiveQuantization": "ENABLED", "TemporalAdaptiveQuantization": "ENABLED", "FlickerAdaptiveQuantization": "DISABLED", "EntropyEncoding": "CABAC", "Bitrate": 400000, "FramerateControl": "INITIALIZE_FROM_SOURCE", "RateControlMode": "CBR", "CodecProfile": "MAIN", "Telecine": "NONE", "MinIInterval": 0, "AdaptiveQuantization": "HIGH", "CodecLevel": "AUTO", "FieldEncoding": "PAFF", "SceneChangeDetect": "ENABLED", "QualityTuningLevel": "SINGLE_PASS", "FramerateConversionAlgorithm": "DUPLICATE_DROP", "UnregisteredSeiTimecode": "DISABLED", "GopSizeUnits": "FRAMES", "ParControl": "INITIALIZE_FROM_SOURCE", "NumberBFramesBetweenReferenceFrames": 2, "RepeatPps": "DISABLED", "DynamicSubGop": "STATIC" } }, "AfdSignaling": "NONE", "DropFrameTimecode": "ENABLED", "RespondToAfd": "NONE", "ColorMetadata": "INSERT" }, "AudioDescriptions": [ { "AudioTypeControl": "FOLLOW_INPUT", "CodecSettings": { "Codec": "AAC", "AacSettings": { "AudioDescriptionBroadcasterMix": "NORMAL", "Bitrate": 96000, "RateControlMode": "CBR", "CodecProfile": "LC", "CodingMode": "CODING_MODE_2_0", "RawFormat": "NONE", "SampleRate": 48000, "Specification": "MPEG4" } }, "LanguageCodeControl": "FOLLOW_INPUT" } ] } ], "OutputGroupSettings": { "Type": "FILE_GROUP_SETTINGS", "FileGroupSettings": {} } } ], "AdAvailOffset": 0 }, "StatusUpdateInterval": "SECONDS_60", "Priority": 0 } ``` O sistema retorna a carga útil JSON que enviada com a solicitação, mesmo quando a solicitação resulta em um erro. Portanto, o JSON retornado não é necessariamente a nova definição do modelo de trabalho. Como a carga útil do JSON pode ser longa, talvez seja necessário rolar para cima para ver as mensagens de erro. Para obter mais informações, consulte [Trabalhar com modelos de trabalho do AWS Elemental MediaConvert](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-job-templates.html) no *Guia do usuário do AWS Elemental MediaConvert*. + Para ver detalhes da API, consulte [UpdateJobTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/update-job-template.html) na *Referência de comandos da AWS CLI*. ### `update-preset` O código de exemplo a seguir mostra como usar `update-preset`. **AWS CLI** **Para alterar uma predefinição** O exemplo `update-preset` a seguir substitui a descrição da pré-definição especificada. ``` aws mediaconvert update-preset \ --name Customer1 \ --description "New description text." --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com ``` Este comando não produz saída. Resultado: ``` { "Preset": { "Arn": "arn:aws:mediaconvert:us-east-1:003235472598:presets/SimpleMP4", "Settings": { ...... }, "Type": "CUSTOM", "LastUpdated": 1568938411, "Description": "New description text.", "Name": "SimpleMP4", "CreatedAt": 1568938240 } } ``` Para obter mais informações, consulte [Trabalhar com pré-definições de saída com o AWS Elemental MediaConvert](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-presets.html) no *Guia do usuário do AWS Elemental MediaConvert*. + Para ver detalhes da API, consulte [UpdatePreset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/update-preset.html) na *Referência de comandos da AWS CLI*. ### `update-queue` O código de exemplo a seguir mostra como usar `update-queue`. **AWS CLI** **Para alterar uma fila** O exemplo `update-queue` a seguir pausa a fila especificada, alterando seu status para `PAUSED`. ``` aws mediaconvert update-queue \ --name Customer1 \ --status PAUSED --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com ``` Resultado: ``` { "Queue": { "LastUpdated": 1568839845, "Status": "PAUSED", "ProgressingJobsCount": 0, "CreatedAt": 1526428516, "Arn": "arn:aws:mediaconvert:us-west-1:123456789012:queues/Customer1", "Name": "Customer1", "SubmittedJobsCount": 0, "PricingPlan": "ON_DEMAND", "Type": "CUSTOM" } } ``` Para obter mais informações, consulte [Trabalhar com filas no AWS Elemental MediaConvert](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html) no *Guia do usuário do AWS Elemental MediaConvert*. + Para ver detalhes da API, consulte [UpdateQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/update-queue.html) na *Referência de comandos da AWS CLI*. # Exemplos do MediaLive usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o MediaLive. *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 ### `create-channel` O código de exemplo a seguir mostra como usar `create-channel`. **AWS CLI** **Para criar um canal** O exemplo `create-channel` a seguir cria um canal transmitindo um arquivo JSON que contenha os parâmetros que serão especificados. O canal neste exemplo ingere uma entrada HLS PULL que se conecta a uma fonte que contém vídeo, áudio e legendas incorporadas. O canal cria um grupo de saída HLS com um servidor Akamai como destino. O grupo de saída contém duas saídas: uma para vídeo H.265 e áudio AAC e outra para legendas Web-VTT, somente em inglês. O JSON desse canal de exemplo inclui os parâmetros mínimos necessários para um canal que usa uma entrada HLS PULL e que produz um grupo de saída HLS com a Akamai como destino. O JSON contém as seguintes seções principais: `InputAttachments`, que especifica uma fonte para o áudio e uma fonte para as legendas. Ele não especifica um seletor de vídeo, o que significa que o MediaLive extrai o primeiro vídeo encontrado na fonte. `Destinations`, que contém os dois endereços IP (URLs) para o único grupo de saída nesse canal. Esses endereços exigem senhas. `EncoderSettings`, que contém subseções. `AudioDescriptions`, que especifica que o canal contém um ativo de saída de áudio, que usa a fonte de InputAttachments e produz áudio no formato AAC. `CaptionDescriptions`, que especifica que o canal contém um ativo de saída de legendas, que usa a fonte de InputAttachments e produz legendas no formato Web-VTT. `VideoDescriptions`, que especifica que o canal contém um ativo de saída de vídeo, com a resolução especificada. `OutputGroups`, que especifica os grupos de saída. Neste exemplo, o grupo de recursos é chamado de `Akamai`. A conexão é feita usando HLS PUT. O grupo de saída contém duas saídas. Uma saída é para o ativo de vídeo (chamado `Video_high`) e o ativo de áudio (chamado `Audio_EN`). Uma saída é para o ativo de legendas (chamado `WebVTT_EN`). Neste exemplo, alguns dos parâmetros não contêm valor ou contêm parâmetros vazios aninhados. Por exemplo, OutputSettings para a saída `Video_and_audio` contém vários parâmetros aninhados que terminam em um parâmetro M3u8Settings vazio. Esse parâmetro deve ser incluído, mas é possível omitir um, vários ou todos os seus filhos, o que significa que o filho assumirá seu valor padrão ou será nulo. Todos os parâmetros que se aplicam a esse canal de exemplo, mas que não estão especificados nesse arquivo, assumirão o valor padrão, serão definidos como nulos ou terão um valor exclusivo gerado pelo MediaLive. ``` aws medialive create-channel \ --cli-input-json file://channel-in-hls-out-hls-akamai.json ``` Conteúdo de `channel-in-hls-out-hls-akamai.json`: ``` { "Name": "News_West", "RoleArn": "arn:aws:iam::111122223333:role/MediaLiveAccessRole", "InputAttachments": [ { "InputAttachmentName": "local_news", "InputId": "1234567", "InputSettings": { "AudioSelectors": [ { "Name": "English-Audio", "SelectorSettings": { "AudioLanguageSelection": { "LanguageCode": "EN" } } } ], "CaptionSelectors": [ { "LanguageCode": "ENE", "Name": "English_embedded" } ] } } ], "Destinations": [ { "Id": "akamai-server-west", "Settings": [ { "PasswordParam": "/medialive/examplecorp1", "Url": "http://203.0.113.55/news/news_west", "Username": "examplecorp" }, { "PasswordParam": "/medialive/examplecorp2", "Url": "http://203.0.113.82/news/news_west", "Username": "examplecorp" } ] } ], "EncoderSettings": { "AudioDescriptions": [ { "AudioSelectorName": "English-Audio", "CodecSettings": { "AacSettings": {} }, "Name": "Audio_EN" } ], "CaptionDescriptions": [ { "CaptionSelectorName": "English_embedded", "DestinationSettings": { "WebvttDestinationSettings": {} }, "Name": "WebVTT_EN" } ], "VideoDescriptions": [ { "Height": 720, "Name": "Video_high", "Width": 1280 } ], "OutputGroups": [ { "Name": "Akamai", "OutputGroupSettings": { "HlsGroupSettings": { "Destination": { "DestinationRefId": "akamai-server-west" }, "HlsCdnSettings": { "HlsBasicPutSettings": {} } } }, "Outputs": [ { "AudioDescriptionNames": [ "Audio_EN" ], "OutputName": "Video_and_audio", "OutputSettings": { "HlsOutputSettings": { "HlsSettings": { "StandardHlsSettings": { "M3u8Settings": {} } }, "NameModifier": "_1" } }, "VideoDescriptionName": "Video_high" }, { "CaptionDescriptionNames": [ "WebVTT_EN" ], "OutputName": "Captions-WebVTT", "OutputSettings": { "HlsOutputSettings": { "HlsSettings": { "StandardHlsSettings": { "M3u8Settings": {} } }, "NameModifier": "_2" } } } ] } ], "TimecodeConfig": { "Source": "EMBEDDED" } } } ``` **Saída:** A saída repete o conteúdo do arquivo JSON, além dos valores a seguir. Todos os parâmetros são ordenados alfabeticamente. `ARN` para o canal. A última parte do ARN é o ID exclusivo do canal. `EgressEndpoints` está em branco neste canal de exemplo porque é usado somente para entradas PUSH. Quando aplicável, mostra os endereços no MediaLive para os quais o conteúdo é enviado. `OutputGroups`, `Outputs`. Mostram todos os parâmetros do grupo de saída e das saídas, incluindo os que não foram incluídos, mas que são relevantes para esse canal. Os parâmetros podem estar vazios (talvez indicando que o parâmetro ou atributo está desativado nessa configuração de canal) ou podem mostrar o valor padrão que será aplicado. `LogLevel` está definido como padrão (DESATIVADO). `Tags` é definido como padrão (nulo). `PipelinesRunningCount` e `State` mostram o status atual do canal. Para obter ajuda, consulte [Criar um canal a partir do zero](https://docs.aws.amazon.com/medialive/latest/ug/creating-channel-scratch.html) no *Guia do usuário do AWS Elemental MediaLive*. + Para ver detalhes da API, consulte [CreateChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medialive/create-channel.html) na *Referência de comandos da AWS CLI*. ### `create-input` O código de exemplo a seguir mostra como usar `create-input`. **AWS CLI** **Para criar uma entrada** O exemplo `create-input` a seguir cria uma entrada `HLS PULL` passando um arquivo JSON que contém os parâmetros que se aplicam a esse tipo de entrada. O JSON desse exemplo de entrada especifica duas fontes (endereços) para a entrada, a fim de oferecer suporte à redundância na ingestão. Esses endereços exigem senhas. ``` aws medialive create-input \ --cli-input-json file://input-hls-pull-news.json ``` Conteúdo de `input-hls-pull-news.json`: ``` { "Name": "local_news", "RequestId": "cli000059", "Sources": [ { "Url": "https://203.0.113.13/newschannel/anytownusa.m3u8", "Username": "examplecorp", "PasswordParam": "/medialive/examplecorp1" }, { "Url": "https://198.51.100.54/fillervideos/oceanwaves.mp4", "Username": "examplecorp", "PasswordParam": "examplecorp2" } ], "Type": "URL_PULL" } ``` **Saída:** A saída repete o conteúdo do arquivo JSON, além dos valores a seguir. Todos os parâmetros são ordenados alfabeticamente. `Arn` para a entrada. A última parte do ARN é o ID de entrada exclusivo `Attached Channels`, que é sempre vazio para uma entrada recém-criada `Destinations`, que está vazio neste exemplo porque é usado somente com uma entrada PUSH `Id` para a entrada, o mesmo que o ID no ARN `MediaConnectFlows`, que está vazio neste exemplo porque é usado somente com uma entrada do tipo MediaConnect `SecurityGroups`, que está vazio neste exemplo porque é usado somente com uma entrada PUSH `State` é o estado desta entrada `Tags`, que está vazio (o padrão para esse parâmetro). Para obter mais informações, consulte [Criar uma entrada](https://docs.aws.amazon.com/medialive/latest/ug/create-input.html) no *Guia do usuário do AWS Elemental MediaLive*. + Para ver detalhes da API, consulte [CreateInput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medialive/create-input.html) na *Referência de comandos da AWS CLI*. # Exemplos do MediaPackage usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o MediaPackage. *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 ### `create-channel` O código de exemplo a seguir mostra como usar `create-channel`. **AWS CLI** **Para criar um canal** O comando `create-channel` a seguir cria um canal chamado `sportschannel` na conta atual. ``` aws mediapackage create-channel --id sportschannel ``` Resultado: ``` { "Arn": "arn:aws:mediapackage:us-west-2:111222333:channels/6d345804ec3f46c9b454a91d4a80d0e0", "HlsIngest": { "IngestEndpoints": [ { "Id": "6d345804ec3f46c9b454a91d4a80d0e0", "Password": "generatedwebdavpassword1", "Url": "https://f31c86aed53b815a.mediapackage.us-west-2.amazonaws.com/in/v2/6d345804ec3f46c9b454a91d4a80d0e0/6d345804ec3f46c9b454a91d4a80d0e0/channel", "Username": "generatedwebdavusername1" }, { "Id": "2daa32878af24803b24183727211b8ff", "Password": "generatedwebdavpassword2", "Url": "https://6ebbe7e04c4b0afa.mediapackage.us-west-2.amazonaws.com/in/v2/6d345804ec3f46c9b454a91d4a80d0e0/2daa32878af24803b24183727211b8ff/channel", "Username": "generatedwebdavusername2" } ] }, "Id": "sportschannel", "Tags": { "region": "west" } } ``` Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/mediapackage/latest/ug/channels-create.html) no *Guia do usuário do AWS Elemental MediaPackage.* + Para ver detalhes da API, consulte [CreateChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/create-channel.html) na *Referência de comandos da AWS CLI*. ### `create-origin-endpoint` O código de exemplo a seguir mostra como usar `create-origin-endpoint`. **AWS CLI** **Para criar um endpoint de origem** O comando `create-origin-endpoint` a seguir cria um endpoint de origem chamado `cmafsports` com as configurações de pacote fornecidas em um arquivo JSON e as configurações de endpoint especificadas. ``` aws mediapackage create-origin-endpoint \ --channel-id sportschannel \ --id cmafsports \ --cmaf-package file://file/path/cmafpkg.json --description "cmaf output of sports" \ --id cmaf_sports \ --manifest-name sports_channel \ --startover-window-seconds 300 \ --tags region=west,media=sports \ --time-delay-seconds 10 ``` Resultado: ``` { "Arn": "arn:aws:mediapackage:us-west-2:111222333:origin_endpoints/1dc6718be36f4f34bb9cd86bc50925e6", "ChannelId": "sportschannel", "CmafPackage": { "HlsManifests": [ { "AdMarkers": "PASSTHROUGH", "Id": "cmaf_sports_endpoint", "IncludeIframeOnlyStream": true, "ManifestName": "index", "PlaylistType": "EVENT", "PlaylistWindowSeconds": 300, "ProgramDateTimeIntervalSeconds": 300, "Url": "https://c4af3793bf76b33c.mediapackage.us-west-2.amazonaws.com/out/v1/1dc6718be36f4f34bb9cd86bc50925e6/cmaf_sports_endpoint/index.m3u8" } ], "SegmentDurationSeconds": 2, "SegmentPrefix": "sportschannel" }, "Description": "cmaf output of sports", "Id": "cmaf_sports", "ManifestName": "sports_channel", "StartoverWindowSeconds": 300, "Tags": { "region": "west", "media": "sports" }, "TimeDelaySeconds": 10, "Url": "", "Whitelist": [] } ``` Para obter mais informações, consulte [Criar um endpoint](https://docs.aws.amazon.com/mediapackage/latest/ug/endpoints-create.html) no *Guia do usuário do AWS Elemental MediaPackage.* + Para ver detalhes da API, consulte [CreateOriginEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/create-origin-endpoint.html) na *Referência de comandos da AWS CLI*. ### `delete-channel` O código de exemplo a seguir mostra como usar `delete-channel`. **AWS CLI** **Para excluir um canal** O comando `delete-channel` a seguir o canal chamado `test`. ``` aws mediapackage delete-channel \ --id test ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir um canal](https://docs.aws.amazon.com/mediapackage/latest/ug/channels-delete.html) no *Guia do usuário do AWS Elemental MediaPackage*. + Para ver detalhes da API, consulte [DeleteChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/delete-channel.html) na *Referência de comandos da AWS CLI*. ### `delete-origin-endpoint` O código de exemplo a seguir mostra como usar `delete-origin-endpoint`. **AWS CLI** **Para excluir um endpoint** O comando `delete-origin-endpoint` a seguir exclui o endpoint de origem chamado `tester2`. ``` aws mediapackage delete-origin-endpoint \ --id tester2 ``` Para obter mais informações, consulte [Excluir um endpoint](https://docs.aws.amazon.com/mediapackage/latest/ug/endpoints-delete.html) no *Guia do usuário do AWS Elemental MediaPackage*. + Para ver detalhes da API, consulte [DeleteOriginEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/delete-origin-endpoint.html) na *Referência de comandos da AWS CLI*. ### `describe-channel` O código de exemplo a seguir mostra como usar `describe-channel`. **AWS CLI** **Para descrever um canal** O comando `describe-channel` a seguir exibe todos os detalhes do canal chamado `test`. ``` aws mediapackage describe-channel \ --id test ``` Resultado: ``` { "Arn": "arn:aws:mediapackage:us-west-2:111222333:channels/584797f1740548c389a273585dd22a63", "HlsIngest": { "IngestEndpoints": [ { "Id": "584797f1740548c389a273585dd22a63", "Password": "webdavgeneratedpassword1", "Url": "https://9be9c4405c474882.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/584797f1740548c389a273585dd22a63/channel", "Username": "webdavgeneratedusername1" }, { "Id": "7d187c8616fd455f88aaa5a9fcf74442", "Password": "webdavgeneratedpassword2", "Url": "https://7bf454c57220328d.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/7d187c8616fd455f88aaa5a9fcf74442/channel", "Username": "webdavgeneratedusername2" } ] }, "Id": "test", "Tags": {} } ``` Para obter mais informações, consulte Visualizar detalhes do canal no *Guia do usuário do AWS Elemental MediaPackage* + Para ver detalhes da API, consulte [DescribeChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/describe-channel.html) na *Referência de comandos da AWS CLI*. ### `describe-origin-endpoint` O código de exemplo a seguir mostra como usar `describe-origin-endpoint`. **AWS CLI** **Para descrever um endpoint de origem** O comando `describe-origin-endpoint` a seguir exibe todos os detalhes do endpoint de origem chamado `cmaf_sports`. ``` aws mediapackage describe-origin-endpoint \ --id cmaf_sports ``` Resultado: ``` { "Arn": "arn:aws:mediapackage:us-west-2:111222333:origin_endpoints/1dc6718be36f4f34bb9cd86bc50925e6", "ChannelId": "sportschannel", "CmafPackage": { "HlsManifests": [ { "AdMarkers": "NONE", "Id": "cmaf_sports_endpoint", "IncludeIframeOnlyStream": false, "PlaylistType": "EVENT", "PlaylistWindowSeconds": 60, "ProgramDateTimeIntervalSeconds": 0, "Url": "https://c4af3793bf76b33c.mediapackage.us-west-2.amazonaws.com/out/v1/1dc6718be36f4f34bb9cd86bc50925e6/cmaf_sports_endpoint/index.m3u8" } ], "SegmentDurationSeconds": 2, "SegmentPrefix": "sportschannel" }, "Id": "cmaf_sports", "ManifestName": "index", "StartoverWindowSeconds": 0, "Tags": { "region": "west", "media": "sports" }, "TimeDelaySeconds": 0, "Url": "", "Whitelist": [] } ``` Para obter mais informações, consulte [Visualizar um único endpoint](https://docs.aws.amazon.com/mediapackage/latest/ug/endpoints-view-one.html) no *Guia do usuário do AWS Elemental MediaPackage*. + Para ver detalhes da API, consulte [DescribeOriginEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/describe-origin-endpoint.html) na *Referência de comandos da AWS CLI*. ### `list-channels` O código de exemplo a seguir mostra como usar `list-channels`. **AWS CLI** **Para listar todos os canais** O comando `list-channels` a seguir lista todos os canais configurados na conta da AWS atual. ``` aws mediapackage list-channels ``` Resultado: ``` { "Channels": [ { "Arn": "arn:aws:mediapackage:us-west-2:111222333:channels/584797f1740548c389a273585dd22a63", "HlsIngest": { "IngestEndpoints": [ { "Id": "584797f1740548c389a273585dd22a63", "Password": "webdavgeneratedpassword1", "Url": "https://9be9c4405c474882.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/584797f1740548c389a273585dd22a63/channel", "Username": "webdavgeneratedusername1" }, { "Id": "7d187c8616fd455f88aaa5a9fcf74442", "Password": "webdavgeneratedpassword2", "Url": "https://7bf454c57220328d.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/7d187c8616fd455f88aaa5a9fcf74442/channel", "Username": "webdavgeneratedusername2" } ] }, "Id": "test", "Tags": {} } ] } ``` Para obter mais informações, consulte [Como visualizar detalhes do canal](https://docs.aws.amazon.com/mediapackage/latest/ug/channels-view.html) no *Guia do usuário do AWS Elemental MediaPackage*. + Consulte detalhes da API em [ListChannels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/list-channels.html) na *Referência de comandos da AWS CLI*. ### `list-origin-endpoints` O código de exemplo a seguir mostra como usar `list-origin-endpoints`. **AWS CLI** **Para listar todos os endpoints de origem de um canal** O comando `list-origin-endpoints` a seguir lista todos endpoints de origem que estão configurados no canal `test`. ``` aws mediapackage list-origin-endpoints \ --channel-id test ``` Resultado: ``` { "OriginEndpoints": [ { "Arn": "arn:aws:mediapackage:us-west-2:111222333:origin_endpoints/247cff871f2845d3805129be22f2c0a2", "ChannelId": "test", "DashPackage": { "ManifestLayout": "FULL", "ManifestWindowSeconds": 60, "MinBufferTimeSeconds": 30, "MinUpdatePeriodSeconds": 15, "PeriodTriggers": [], "Profile": "NONE", "SegmentDurationSeconds": 2, "SegmentTemplateFormat": "NUMBER_WITH_TIMELINE", "StreamSelection": { "MaxVideoBitsPerSecond": 2147483647, "MinVideoBitsPerSecond": 0, "StreamOrder": "ORIGINAL" }, "SuggestedPresentationDelaySeconds": 25 }, "Id": "tester2", "ManifestName": "index", "StartoverWindowSeconds": 0, "Tags": {}, "TimeDelaySeconds": 0, "Url": "https://8343f7014c0ea438.mediapackage.us-west-2.amazonaws.com/out/v1/247cff871f2845d3805129be22f2c0a2/index.mpd", "Whitelist": [] }, { "Arn": "arn:aws:mediapackage:us-west-2:111222333:origin_endpoints/869e237f851549e9bcf10e3bc2830839", "ChannelId": "test", "HlsPackage": { "AdMarkers": "NONE", "IncludeIframeOnlyStream": false, "PlaylistType": "EVENT", "PlaylistWindowSeconds": 60, "ProgramDateTimeIntervalSeconds": 0, "SegmentDurationSeconds": 6, "StreamSelection": { "MaxVideoBitsPerSecond": 2147483647, "MinVideoBitsPerSecond": 0, "StreamOrder": "ORIGINAL" }, "UseAudioRenditionGroup": false }, "Id": "tester", "ManifestName": "index", "StartoverWindowSeconds": 0, "Tags": {}, "TimeDelaySeconds": 0, "Url": "https://8343f7014c0ea438.mediapackage.us-west-2.amazonaws.com/out/v1/869e237f851549e9bcf10e3bc2830839/index.m3u8", "Whitelist": [] } ] } ``` Para obter mais informações, consulte [Visualizar todos os endpoints associados a um canal](https://docs.aws.amazon.com/mediapackage/latest/ug/endpoints-view-all.html) no *Guia do usuário do AWS Elemental MediaPackage*. + Consulte detalhes da API em [ListOriginEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/list-origin-endpoints.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar tags atribuídas a um recurso** O comando `list-tags-for-resource` a seguir lista todas as tags atribuídas ao recurso especificado. ``` aws mediapackage list-tags-for-resource \ --resource-arn arn:aws:mediapackage:us-west-2:111222333:channels/6d345804ec3f46c9b454a91d4a80d0e0 ``` Resultado: ``` { "Tags": { "region": "west" } } ``` Para obter mais informações, consulte [Atribuir tags a recursos no AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/tagging.html) no *Guia do usuário do AWS Elemental MediaPackage*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `rotate-ingest-endpoint-credentials` O código de exemplo a seguir mostra como usar `rotate-ingest-endpoint-credentials`. **AWS CLI** **Para rotacionar as credenciais de ingestão** O comando `rotate-ingest-endpoint-credentials` a seguir rotaciona o nome de usuário WebDAV e a senha para o endpoint de ingestão especificado. ``` aws mediapackage rotate-ingest-endpoint-credentials \ --id test \ --ingest-endpoint-id 584797f1740548c389a273585dd22a63 ``` Resultado: ``` { "Arn": "arn:aws:mediapackage:us-west-2:111222333:channels/584797f1740548c389a273585dd22a63", "HlsIngest": { "IngestEndpoints": [ { "Id": "584797f1740548c389a273585dd22a63", "Password": "webdavregeneratedpassword1", "Url": "https://9be9c4405c474882.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/584797f1740548c389a273585dd22a63/channel", "Username": "webdavregeneratedusername1" }, { "Id": "7d187c8616fd455f88aaa5a9fcf74442", "Password": "webdavgeneratedpassword2", "Url": "https://7bf454c57220328d.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/7d187c8616fd455f88aaa5a9fcf74442/channel", "Username": "webdavgeneratedusername2" } ] }, "Id": "test", "Tags": {} } ``` Para obter mais informações, consulte [Rotacionar credenciais em um URL de entrada](https://docs.aws.amazon.com/mediapackage/latest/ug/channels-rotate-creds) no *Guia do usuário do AWS Elemental MediaPackage*. + Para ver detalhes da API, consulte [RotateIngestEndpointCredentials](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/rotate-ingest-endpoint-credentials.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Adicionar uma tag a um recurso** Os comandos `tag-resource` a seguir adicionam um par de chave-valor `region=west` ao recurso especificado. ``` aws mediapackage tag-resource \ --resource-arn arn:aws:mediapackage:us-west-2:111222333:channels/6d345804ec3f46c9b454a91d4a80d0e0 \ --tags region=west ``` Este comando não produz saída. Para obter mais informações, consulte [Atribuir tags a recursos no AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/tagging.html) no *Guia do usuário do AWS Elemental MediaPackage*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover uma tag de um recurso** O comando `untag-resource` a seguir remove a tag com a chave `region` do canal especificado. ``` aws mediapackage untag-resource \ --resource-arn arn:aws:mediapackage:us-west-2:111222333:channels/6d345804ec3f46c9b454a91d4a80d0e0 \ --tag-keys region ``` Para obter mais informações, consulte [Atribuir tags a recursos no AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/tagging.html) no *Guia do usuário do AWS Elemental MediaPackage*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-channel` O código de exemplo a seguir mostra como usar `update-channel`. **AWS CLI** **Para atualizar um canal** O comando `update-channel` a seguir atualiza o canal chamado `sportschannel` para incluir a descrição`24x7 sports`. ``` aws mediapackage update-channel \ --id sportschannel \ --description "24x7 sports" ``` Resultado: ``` { "Arn": "arn:aws:mediapackage:us-west-2:111222333:channels/6d345804ec3f46c9b454a91d4a80d0e0", "Description": "24x7 sports", "HlsIngest": { "IngestEndpoints": [ { "Id": "6d345804ec3f46c9b454a91d4a80d0e0", "Password": "generatedwebdavpassword1", "Url": "https://f31c86aed53b815a.mediapackage.us-west-2.amazonaws.com/in/v2/6d345804ec3f46c9b454a91d4a80d0e0/6d345804ec3f46c9b454a91d4a80d0e0/channel", "Username": "generatedwebdavusername1" }, { "Id": "2daa32878af24803b24183727211b8ff", "Password": "generatedwebdavpassword2", "Url": "https://6ebbe7e04c4b0afa.mediapackage.us-west-2.amazonaws.com/in/v2/6d345804ec3f46c9b454a91d4a80d0e0/2daa32878af24803b24183727211b8ff/channel", "Username": "generatedwebdavusername2" } ] }, "Id": "sportschannel", "Tags": {} } ``` Para obter mais informações, consulte [Editar um canal](https://docs.aws.amazon.com/mediapackage/latest/ug/channels-edit.html) no *Guia do usuário do AWS Elemental MediaPackage*. + Para ver detalhes da API, consulte [UpdateChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/update-channel.html) na *Referência de comandos da AWS CLI*. ### `update-origin-endpoint` O código de exemplo a seguir mostra como usar `update-origin-endpoint`. **AWS CLI** **Para atualizar um endpoint de origem** O comando `update-origin-endpoint` a seguir atualiza o endpoint de origem chamado `cmaf_sports`. Ele altera o tempo de atraso para `0` segundos. ``` aws mediapackage update-origin-endpoint \ --id cmaf_sports \ --time-delay-seconds 0 ``` Resultado: ``` { "Arn": "arn:aws:mediapackage:us-west-2:111222333:origin_endpoints/1dc6718be36f4f34bb9cd86bc50925e6", "ChannelId": "sportschannel", "CmafPackage": { "HlsManifests": [ { "AdMarkers": "NONE", "Id": "cmaf_sports_endpoint", "IncludeIframeOnlyStream": false, "PlaylistType": "EVENT", "PlaylistWindowSeconds": 60, "ProgramDateTimeIntervalSeconds": 0, "Url": "https://c4af3793bf76b33c.mediapackage.us-west-2.amazonaws.com/out/v1/1dc6718be36f4f34bb9cd86bc50925e6/cmaf_sports_endpoint/index.m3u8" } ], "SegmentDurationSeconds": 2, "SegmentPrefix": "sportschannel" }, "Id": "cmaf_sports", "ManifestName": "index", "StartoverWindowSeconds": 0, "Tags": { "region": "west", "media": "sports" }, "TimeDelaySeconds": 0, "Url": "", "Whitelist": [] } ``` Para obter mais informações, consulte [Editar um endpoint](https://docs.aws.amazon.com/mediapackage/latest/ug/endpoints-edit.html) no *Guia do usuário do AWS Elemental MediaPackage*. + Para ver detalhes da API, consulte [UpdateOriginEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/update-origin-endpoint.html) na *Referência de comandos da AWS CLI*. # Exemplos do MediaPackage VOD usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o MediaPackage VOD. *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 ### `create-asset` O código de exemplo a seguir mostra como usar `create-asset`. **AWS CLI** **Para criar um ativo** O exemplo `create-asset` a seguir cria um ativo chamado `Chicken_Asset` na conta da AWS atual. O ativo ingere o arquivo `30sec_chicken.smil` no MediaPackage. ``` aws mediapackage-vod create-asset \ --id chicken_asset \ --packaging-group-id hls_chicken_gp \ --source-role-arn arn:aws:iam::111122223333:role/EMP_Vod \ --source-arn arn:aws:s3::111122223333:video-bucket/A/30sec_chicken.smil ``` Resultado: ``` { "Arn":"arn:aws:mediapackage-vod:us-west-2:111122223333:assets/chicken_asset", "Id":"chicken_asset", "PackagingGroupId":"hls_chicken_gp", "SourceArn":"arn:aws:s3::111122223333:video-bucket/A/30sec_chicken.smil", "SourceRoleArn":"arn:aws:iam::111122223333:role/EMP_Vod", "EgressEndpoints":[ { "PackagingConfigurationId":"New_config_1", "Url":"https://c75ea2668ab49d02bca7ae10ef31c59e.egress.mediapackage-vod.us-west-2.amazonaws.com/out/v1/6644b55df1744261ab3732a8e5cdaf07/904b06a58c7645e08d57d40d064216ac/f5b2e633ff4942228095d164c10074f3/index.m3u8" }, { "PackagingConfigurationId":"new_hls", "Url":" https://c75ea2668ab49d02bca7ae10ef31c59e.egress.mediapackage-vod.us-west-2.amazonaws.com/out/v1/6644b55df1744261ab3732a8e5cdaf07/fe8f1f00a80e424cb4f8da4095835e9e/7370ec57432343af816332356d2bd5c6/string.m3u8" } ] } ``` Para obter mais informações, consulte [Ingerir um ativo](https://docs.aws.amazon.com/mediapackage/latest/ug/asset-create.html) no *Guia do usuário do AWS Elemental MediaPackage*. + Para ver detalhes da API, consulte [CreateAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage-vod/create-asset.html) na *Referência de comandos da AWS CLI*. ### `create-packaging-configuration` O código de exemplo a seguir mostra como usar `create-packaging-configuration`. **AWS CLI** **Para criar uma configuração de empacotamento** O exemplo `create-packaging-configuration` a seguir cria uma configuração de empacotamento chamada `new_hls` no grupo de pacotes chamado `hls_chicken`. Este exemplo usa um arquivo no disco chamado `hls_pc.json` para fornecer os detalhes. ``` aws mediapackage-vod create-packaging-configuration \ --id new_hls \ --packaging-group-id hls_chicken \ --hls-package file://hls_pc.json ``` Conteúdo de `hls_pc.json`: ``` { "HlsManifests":[ { "AdMarkers":"NONE", "IncludeIframeOnlyStream":false, "ManifestName":"string", "ProgramDateTimeIntervalSeconds":60, "RepeatExtXKey":true, "StreamSelection":{ "MaxVideoBitsPerSecond":1000, "MinVideoBitsPerSecond":0, "StreamOrder":"ORIGINAL" } } ], "SegmentDurationSeconds":6, "UseAudioRenditionGroup":false } ``` Resultado: ``` { "Arn":"arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-configurations/new_hls", "Id":"new_hls", "PackagingGroupId":"hls_chicken", "HlsManifests":{ "SegmentDurationSeconds":6, "UseAudioRenditionGroup":false, "HlsMarkers":[ { "AdMarkers":"NONE", "IncludeIframeOnlyStream":false, "ManifestName":"string", "ProgramDateTimeIntervalSeconds":60, "RepeatExtXKey":true, "StreamSelection":{ "MaxVideoBitsPerSecond":1000, "MinVideoBitsPerSecond":0, "StreamOrder":"ORIGINAL" } } ] } } ``` Para obter mais informações, consulte [Criar uma configuração de empacotamento](https://docs.aws.amazon.com/mediapackage/latest/ug/pkg-cfig-create.html) no *Guia do usuário do AWS Elemental MediaPackage.* + Para ver detalhes da API, consulte [CreatePackagingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage-vod/create-packaging-configuration.html) na *Referência de comandos da AWS CLI*. ### `create-packaging-group` O código de exemplo a seguir mostra como usar `create-packaging-group`. **AWS CLI** **Para criar um grupo de empacotamento** O exemplo `create-packaging-group` a seguir lista todos os grupos de empacotamento configurados na conta da AWS atual. ``` aws mediapackage-vod create-packaging-group \ --id hls_chicken ``` Resultado: ``` { "Arn": "arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-groups/hls_chicken", "Id": "hls_chicken" } ``` Para obter mais informações, consulte [Criar um grupo de empacotamento](https://docs.aws.amazon.com/mediapackage/latest/ug/pkg-group-create.html) no *Guia do usuário do AWS Elemental MediaPackage.* + Para ver detalhes da API, consulte [CreatePackagingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage-vod/create-packaging-group.html) na *Referência de comandos da AWS CLI*. ### `delete-asset` O código de exemplo a seguir mostra como usar `delete-asset`. **AWS CLI** **Para excluir um ativo** O exemplo `delete-asset` a seguir exclui o ativo chamado `30sec_chicken`. ``` aws mediapackage-vod delete-asset \ --id 30sec_chicken ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir um ativo](https://docs.aws.amazon.com/mediapackage/latest/ug/asset-delete.html) no *Guia do usuário do AWS Elemental MediaPackage*. + Para ver detalhes da API, consulte [DeleteAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage-vod/delete-asset.html) na *Referência de comandos da AWS CLI*. ### `delete-packaging-configuration` O código de exemplo a seguir mostra como usar `delete-packaging-configuration`. **AWS CLI** **Para excluir uma configuração de empacotamento** O exemplo `delete-packaging-configuration` a seguir exclui a configuração de empacotamento chamada `CMAF`. ``` aws mediapackage-vod delete-packaging-configuration \ --id CMAF ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir uma configuração de empacotamento](https://docs.aws.amazon.com/mediapackage/latest/ug/pkg-cfig-delete.html) no *Guia do usuário do AWS Elemental MediaPackage.* + Para ver detalhes da API, consulte [DeletePackagingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage-vod/delete-packaging-configuration.html) na *Referência de comandos da AWS CLI*. ### `delete-packaging-group` O código de exemplo a seguir mostra como usar `delete-packaging-group`. **AWS CLI** **Para excluir um grupo de empacotamento** O exemplo `delete-packaging-group` a seguir exclui o grupo de empacotamento chamado `Dash_widevine`. ``` aws mediapackage-vod delete-packaging-group \ --id Dash_widevine ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir um grupo de empacotamento](https://docs.aws.amazon.com/mediapackage/latest/ug/pkg-group-delete.html) no *Guia do usuário do AWS Elemental MediaPackage.* + Para ver detalhes da API, consulte [DeletePackagingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage-vod/delete-packaging-group.html) na *Referência de comandos da AWS CLI*. ### `describe-asset` O código de exemplo a seguir mostra como usar `describe-asset`. **AWS CLI** **Para descrever um ativo** O exemplo `describe-asset` a seguir exibe todos os detalhes do ativo chamado `30sec_chicken`. ``` aws mediapackage-vod describe-asset \ --id 30sec_chicken ``` Resultado: ``` { "Arn":"arn:aws:mediapackage-vod:us-west-2:111122223333:assets/30sec_chicken", "Id":"30sec_chicken", "PackagingGroupId":"Packaging_group_1", "SourceArn":"arn:aws:s3::111122223333:video-bucket/A/30sec_chicken.smil", "SourceRoleArn":"arn:aws:iam::111122223333:role/EMP_Vod", "EgressEndpoints":[ { "PackagingConfigurationId":"DASH", "Url":"https://a5f46a44118ba3e3724ef39ef532e701.egress.mediapackage-vod.us-west-2.amazonaws.com/out/v1/aad7962c569946119c2d5a691be5663c/66c25aff456d463aae0855172b3beb27/4ddfda6da17c4c279a1b8401cba31892/index.mpd" }, { "PackagingConfigurationId":"HLS", "Url":"https://a5f46a44118ba3e3724ef39ef532e701.egress.mediapackage-vod.us-west-2.amazonaws.com/out/v1/aad7962c569946119c2d5a691be5663c/6e5bf286a3414254a2bf0d22ae148d7e/06b5875b4d004c3cbdc4da2dc4d14638/index.m3u8" }, { "PackagingConfigurationId":"CMAF", "Url":"https://a5f46a44118ba3e3724ef39ef532e701.egress.mediapackage-vod.us-west-2.amazonaws.com/out/v1/aad7962c569946119c2d5a691be5663c/628fb5d8d89e4702958b020af27fde0e/05eb062214064238ad6330a443aff7f7/index.m3u8" } ] } ``` Para obter mais informações, consulte [Visualizar detalhes do ativo](https://docs.aws.amazon.com/mediapackage/latest/ug/asset-view.html) no *Guia do usuário do AWS Elemental MediaPackage*. + Para ver detalhes da API, consulte [DescribeAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage-vod/describe-asset.html) na *Referência de comandos da AWS CLI*. ### `describe-packaging-configuration` O código de exemplo a seguir mostra como usar `describe-packaging-configuration`. **AWS CLI** **Para descrever uma configuração de empacotamento** O exemplo `describe-packaging-configuration` a seguir exibe todos os detalhes da configuração de empacotamento chamada `DASH`. ``` aws mediapackage-vod describe-packaging-configuration \ --id DASH ``` Resultado: ``` { "Arn":"arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-configurations/DASH", "Id":"DASH", "PackagingGroupId":"Packaging_group_1", "DashPackage":[ { "SegmentDurationSeconds":"2" }, { "DashManifests":{ "ManifestName":"index", "MinBufferTimeSeconds":"30", "Profile":"NONE" } } ] } ``` Para obter mais informações, consulte [Visualizar os detalhes de uma configuração de empacotamento](https://docs.aws.amazon.com/mediapackage/latest/ug/pkg-cfig-view.html) no *Guia do usuário do AWS Elemental MediaPackage.* + Para ver detalhes da API, consulte [DescribePackagingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage-vod/describe-packaging-configuration.html) na *Referência de comandos da AWS CLI*. ### `describe-packaging-group` O código de exemplo a seguir mostra como usar `describe-packaging-group`. **AWS CLI** **Para descrever um grupo de empacotamento** O exemplo `describe-packaging-group` a seguir exibe todos os detalhes do grupo de empacotamento chamado `Packaging_group_1`. ``` aws mediapackage-vod describe-packaging-group \ --id Packaging_group_1 ``` Resultado: ``` { "Arn": "arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-groups/Packaging_group_1", "Id": "Packaging_group_1" } ``` Para obter mais informações, consulte [Visualizar detalhes do grupo de empacotamento](https://docs.aws.amazon.com/mediapackage/latest/ug/pkg-group-view.html) no *Guia do usuário do AWS Elemental MediaPackage*. + Para ver detalhes da API, consulte [DescribePackagingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage-vod/describe-packaging-group.html) na *Referência de comandos da AWS CLI*. ### `list-assets` O código de exemplo a seguir mostra como usar `list-assets`. **AWS CLI** **Para listar todos os ativos** O exemplo `list-assets` a seguir lista todos os ativos configurados na conta da AWS atual. ``` aws mediapackage-vod list-assets ``` Resultado: ``` { "Assets": [ "Arn": "arn:aws:mediapackage-vod:us-west-2:111122223333:assets/30sec_chicken", "Id": "30sec_chicken", "PackagingGroupId": "Packaging_group_1", "SourceArn": "arn:aws:s3::111122223333:video-bucket/A/30sec_chicken.smil", "SourceRoleArn": "arn:aws:iam::111122223333:role/EMP_Vod" ] } ``` Para obter mais informações, consulte [Visualizar detalhes do ativo](https://docs.aws.amazon.com/mediapackage/latest/ug/asset-view.html) no *Guia do usuário do AWS Elemental MediaPackage*. + Para ver detalhes da API, consulte [ListAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage-vod/list-assets.html) na *Referência de comandos da AWS CLI*. ### `list-packaging-configurations` O código de exemplo a seguir mostra como usar `list-packaging-configurations`. **AWS CLI** **Para listar todas as configurações de empacotamento** O exemplo `list-packaging-configurations` a seguir lista todas as configurações de empacotamento definidas no grupo chamado `Packaging_group_1`. ``` aws mediapackage-vod list-packaging-configurations \ --packaging-group-id Packaging_group_1 ``` Resultado: ``` { "PackagingConfigurations":[ { "Arn":"arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-configurations/CMAF", "Id":"CMAF", "PackagingGroupId":"Packaging_group_1", "CmafPackage":[ { "SegmentDurationSeconds":"2" }, { "HlsManifests":{ "AdMarkers":"NONE", "RepeatExtXKey":"False", "ManifestName":"index", "ProgramDateTimeIntervalSeconds":"0", "IncludeIframeOnlyStream":"False" } } ] }, { "Arn":"arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-configurations/DASH", "Id":"DASH", "PackagingGroupId":"Packaging_group_1", "DashPackage":[ { "SegmentDurationSeconds":"2" }, { "DashManifests":{ "ManifestName":"index", "MinBufferTimeSeconds":"30", "Profile":"NONE" } } ] }, { "Arn":"arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-configurations/HLS", "Id":"HLS", "PackagingGroupId":"Packaging_group_1", "HlsPackage":[ { "SegmentDurationSeconds":"6", "UseAudioRenditionGroup":"False" }, { "HlsManifests":{ "AdMarkers":"NONE", "RepeatExtXKey":"False", "ManifestName":"index", "ProgramDateTimeIntervalSeconds":"0", "IncludeIframeOnlyStream":"False" } } ] }, { "Arn":"arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-configurations/New_config_0_copy", "Id":"New_config_0_copy", "PackagingGroupId":"Packaging_group_1", "HlsPackage":[ { "SegmentDurationSeconds":"6", "UseAudioRenditionGroup":"False" }, { "Encryption":{ "EncryptionMethod":"AWS_128", "SpekeKeyProvider":{ "RoleArn":"arn:aws:iam:111122223333::role/SPEKERole", "Url":"https://lfgubdvs97.execute-api.us-west-2.amazonaws.com/EkeStage/copyProtection/", "SystemIds":[ "81376844-f976-481e-a84e-cc25d39b0b33" ] } } }, { "HlsManifests":{ "AdMarkers":"NONE", "RepeatExtXKey":"False", "ManifestName":"index", "ProgramDateTimeIntervalSeconds":"0", "IncludeIframeOnlyStream":"False" } } ] } ] } ``` Para obter mais informações, consulte [Visualizar os detalhes de uma configuração de empacotamento](https://docs.aws.amazon.com/mediapackage/latest/ug/pkg-cfig-view.html) no *Guia do usuário do AWS Elemental MediaPackage.* + Para ver detalhes da API, consulte [ListPackagingConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage-vod/list-packaging-configurations.html) na *Referência de comandos da AWS CLI*. ### `list-packaging-groups` O código de exemplo a seguir mostra como usar `list-packaging-groups`. **AWS CLI** **Para listar todos os grupos de empacotamento** O exemplo `list-packaging-groups` a seguir lista todos os grupos de empacotamento configurados na conta da AWS atual. ``` aws mediapackage-vod list-packaging-groups ``` Resultado: ``` { "PackagingGroups": [ { "Arn": "arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-groups/Dash_widevine", "Id": "Dash_widevine" }, { "Arn": "arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-groups/Encrypted_HLS", "Id": "Encrypted_HLS" }, { "Arn": "arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-groups/Packaging_group_1", "Id": "Packaging_group_1" } ] } ``` Para obter mais informações, consulte [Visualizar detalhes do grupo de empacotamento](https://docs.aws.amazon.com/mediapackage/latest/ug/pkg-group-view.html) no *Guia do usuário do AWS Elemental MediaPackage*. + Para ver detalhes da API, consulte [ListPackagingGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage-vod/list-packaging-groups.html) na *Referência de comandos da AWS CLI*. # Exemplos de plano de dados do MediaStore usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o plano de dados do MediaStore. *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 ### `delete-object` O código de exemplo a seguir mostra como usar `delete-object`. **AWS CLI** **Para excluir um objeto** O exemplo `delete-object` a seguir exclui o objeto especificado. ``` aws mediastore-data delete-object \ --endpoint=https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ --path=/folder_name/README.md ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir um objeto](https://docs.aws.amazon.com/mediastore/latest/ug/objects-delete.html) no *Guia do usuário do AWS Elemental MediaStore*. + Consulte detalhes da API em [DeleteObject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore-data/delete-object.html) na *Referência de comandos da AWS CLI*. ### `describe-object` O código de exemplo a seguir mostra como usar `describe-object`. **AWS CLI** **Como visualizar os cabeçalhos de um objeto** O exemplo `describe-object` a seguir exibe os cabeçalhos de um objeto no caminho especificado. ``` aws mediastore-data describe-object \ --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ --path events/baseball/setup.jpg ``` Resultado: ``` { "LastModified": "Fri, 19 Jul 2019 21:50:31 GMT", "ContentType": "image/jpeg", "ContentLength": "3860266", "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3" } ``` Para obter mais informações, consulte [Visualizar detalhes de um objeto](https://docs.aws.amazon.com/mediastore/latest/ug/objects-view-details.html) no *Guia do usuário do AWS Elemental MediaStore*. + Para ver detalhes da API, consulte [DescribeObject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore-data/describe-object.html) na *Referência de comandos da AWS CLI*. ### `get-object` O código de exemplo a seguir mostra como usar `get-object`. **AWS CLI** **Exemplo 1: fazer o download de um objeto inteiro** O exemplo `get-object` a seguir faz o download do objeto especificado. ``` aws mediastore-data get-object \ --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ --path events/baseball/setup.jpg setup.jpg ``` Resultado: ``` { "ContentType": "image/jpeg", "StatusCode": 200, "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3", "ContentLength": "3860266", "LastModified": "Fri, 19 Jul 2019 21:50:31 GMT" } ``` **Exemplo 2: fazer download de parte de um objeto** O exemplo `get-object` a seguir faz o download da parte especificada do objeto. ``` aws mediastore-data get-object \ --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ --path events/baseball/setup.jpg setup.jpg \ --range "bytes=0-100" ``` Resultado: ``` { "StatusCode": 206, "LastModified": "Fri, 19 Jul 2019 21:50:31 GMT", "ContentType": "image/jpeg", "ContentRange": "bytes 0-100/3860266", "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3", "ContentLength": "101" } ``` Para obter mais informações, consulte [Fazer download de um objeto](https://docs.aws.amazon.com/mediastore/latest/ug/objects-download.html) no *Guia do usuário do AWS Elemental MediaStore*. + Consulte detalhes da API em [GetObject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore-data/get-object.html) na *Referência de comandos da AWS CLI*. ### `list-items` O código de exemplo a seguir mostra como usar `list-items`. **AWS CLI** **Exemplo 1: visualizar uma lista de itens (objetos e pastas) armazenados em um contêiner** O exemplo `list-items` a seguir exibe uma lista de itens (objetos e pastas) armazenados no contêiner especificado. ``` aws mediastore-data list-items \ --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com ``` Resultado: ``` { "Items": [ { "Type": "OBJECT", "ContentLength": 3784, "Name": "setup.jpg", "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3", "ContentType": "image/jpeg", "LastModified": 1563571859.379 }, { "Type": "FOLDER", "Name": "events" } ] } ``` **Exemplo 2: visualizar uma lista de itens (objetos e pastas) armazenados em uma pasta** O exemplo `list-items` a seguir exibe uma lista de itens (objetos e pastas) armazenados na pasta especificada. ``` aws mediastore-data list-items \ --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ --path events/baseball ``` Resultado: ``` { "Items": [ { "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3", "ContentType": "image/jpeg", "Type": "OBJECT", "ContentLength": 3860266, "LastModified": 1563573031.872, "Name": "setup.jpg" } ] } ``` Para obter mais informações, consulte [Visualizar uma lista de objetos](https://docs.aws.amazon.com/mediastore/latest/ug/objects-view-list.html) no *Guia do usuário do AWS Elemental MediaStore*. + Para ver detalhes da API, consulte [ListItems](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore-data/list-items.html) na *Referência de comandos da AWS CLI*. ### `put-object` O código de exemplo a seguir mostra como usar `put-object`. **AWS CLI** **Exemplo 1: fazer upload de um objeto em um contêiner** O exemplo `put-object` a seguir faz upload de um objeto no contêiner especificado. ``` aws mediastore-data put-object \ --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ --body ReadMe.md \ --path ReadMe.md \ --cache-control "max-age=6, public" \ --content-type binary/octet-stream ``` Resultado: ``` { "ContentSHA256": "f29bc64a9d3732b4b9035125fdb3285f5b6455778edca72414671e0ca3b2e0de", "StorageClass": "TEMPORAL", "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3" } ``` **Exemplo 2: fazer upload de um objeto em uma pasta dentro de um contêiner** O exemplo `put-object` a seguir faz upload de um objeto na pasta especificada dentro de um contêiner. ``` aws mediastore-data put-object \ --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ --body ReadMe.md \ --path /september-events/ReadMe.md \ --cache-control "max-age=6, public" \ --content-type binary/octet-stream ``` Resultado: ``` { "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3", "ContentSHA256": "f29bc64a9d3732b4b9035125fdb3285f5b6455778edca72414671e0ca3b2e0de", "StorageClass": "TEMPORAL" } ``` Para obter mais informações, consulte [Fazer upload de um objeto](https://docs.aws.amazon.com/mediastore/latest/ug/objects-upload.html) no *Guia do usuário do AWS Elemental MediaStore*. + Consulte detalhes da API em [PutObject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore-data/put-object.html) na *Referência de comandos da AWS CLI*. # Exemplos do MediaTailor usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o MediaTailor. *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 ### `delete-playback-configuration` O código de exemplo a seguir mostra como usar `delete-playback-configuration`. **AWS CLI** **Como excluir uma configuração** O comando `delete-playback-configuration` a seguir exclui a configuração salva chamada `campaign_short`. ``` aws mediatailor delete-playback-configuration \ --name campaign_short ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir uma configuração](https://docs.aws.amazon.com/mediatailor/latest/ug/configurations-delete.html) no *Guia do usuário do AWS Elemental MediaTailor*. + Para ver detalhes da API, consulte [DeletePlaybackConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediatailor/delete-playback-configuration.html) na *Referência de comandos da AWS CLI*. ### `get-playback-configuration` O código de exemplo a seguir mostra como usar `get-playback-configuration`. **AWS CLI** **Para descrever uma configuração** O exemplo `get-playback-configuration` a seguir exibe todos os detalhes da configuração chamada `west_campaign`. ``` aws mediatailor get-playback-configuration \ --name west_campaign ``` Resultado: ``` { "AdDecisionServerUrl": "http://your.ads.url", "CdnConfiguration": {}, "DashConfiguration": { "ManifestEndpointPrefix": "https://170c14299689462897d0cc45fc2000bb.mediatailor.us-west-2.amazonaws.com/v1/dash/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/west_campaign/", "MpdLocation": "EMT_DEFAULT", "OriginManifestType": "MULTI_PERIOD" }, "HlsConfiguration": { "ManifestEndpointPrefix": "https://170c14299689462897d0cc45fc2000bb.mediatailor.us-west-2.amazonaws.com/v1/master/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/west_campaign/" }, "Name": "west_campaign", "PlaybackConfigurationArn": "arn:aws:mediatailor:us-west-2:123456789012:playbackConfiguration/west_campaign", "PlaybackEndpointPrefix": "https://170c14299689462897d0cc45fc2000bb.mediatailor.us-west-2.amazonaws.com", "SessionInitializationEndpointPrefix": "https://170c14299689462897d0cc45fc2000bb.mediatailor.us-west-2.amazonaws.com/v1/session/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/west_campaign/", "Tags": {}, "VideoContentSourceUrl": "https://8343f7014c0ea438.mediapackage.us-west-2.amazonaws.com/out/v1/683f0f2ff7cd43a48902e6dcd5e16dcf/index.m3u8" } ``` Para obter mais informações, consulte [Visualizar uma configuração](https://docs.aws.amazon.com/mediatailor/latest/ug/configurations-view.html) no *Guia do usuário do AWS Elemental MediaTailor*. + Para ver detalhes da API, consulte [GetPlaybackConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediatailor/get-playback-configuration.html) na *Referência de comandos da AWS CLI*. ### `list-playback-configurations` O código de exemplo a seguir mostra como usar `list-playback-configurations`. **AWS CLI** **Para listar todas as configurações** O exemplo `list-playback-configurations` a seguir exibe todos os detalhes da configuração da conta da AWS atual. ``` aws mediatailor list-playback-configurations ``` Resultado: ``` { "Items": [ { "AdDecisionServerUrl": "http://your.ads.url", "CdnConfiguration": {}, "DashConfiguration": { "ManifestEndpointPrefix": "https://170c14299689462897d0cc45fc2000bb.mediatailor.us-west-2.amazonaws.com/v1/dash/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/west_campaign/", "MpdLocation": "EMT_DEFAULT", "OriginManifestType": "MULTI_PERIOD" }, "HlsConfiguration": { "ManifestEndpointPrefix": "https://170c14299689462897d0cc45fc2000bb.mediatailor.us-west-2.amazonaws.com/v1/master/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/west_campaign/" }, "Name": "west_campaign", "PlaybackConfigurationArn": "arn:aws:mediatailor:us-west-2:123456789012:playbackConfiguration/west_campaign", "PlaybackEndpointPrefix": "https://170c14299689462897d0cc45fc2000bb.mediatailor.us-west-2.amazonaws.com", "SessionInitializationEndpointPrefix": "https://170c14299689462897d0cc45fc2000bb.mediatailor.us-west-2.amazonaws.com/v1/session/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/west_campaign/", "Tags": {}, "VideoContentSourceUrl": "https://8343f7014c0ea438.mediapackage.us-west-2.amazonaws.com/out/v1/683f0f2ff7cd43a48902e6dcd5e16dcf/index.m3u8" }, { "AdDecisionServerUrl": "http://your.ads.url", "CdnConfiguration": {}, "DashConfiguration": { "ManifestEndpointPrefix": "https://73511f91d6a24ca2b93f3cf1d7cedd67.mediatailor.us-west-2.amazonaws.com/v1/dash/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/sports_campaign/", "MpdLocation": "DISABLED", "OriginManifestType": "MULTI_PERIOD" }, "HlsConfiguration": { "ManifestEndpointPrefix": "https://73511f91d6a24ca2b93f3cf1d7cedd67.mediatailor.us-west-2.amazonaws.com/v1/master/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/sports_campaign/" }, "Name": "sports_campaign", "PlaybackConfigurationArn": "arn:aws:mediatailor:us-west-2:123456789012:playbackConfiguration/sports_campaign", "PlaybackEndpointPrefix": "https://73511f91d6a24ca2b93f3cf1d7cedd67.mediatailor.us-west-2.amazonaws.com", "SessionInitializationEndpointPrefix": "https://73511f91d6a24ca2b93f3cf1d7cedd67.mediatailor.us-west-2.amazonaws.com/v1/session/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/sports_campaign/", "SlateAdUrl": "http://s3.bucket/slate_ad.mp4", "Tags": {}, "VideoContentSourceUrl": "https://c4af3793bf76b33c.mediapackage.us-west-2.amazonaws.com/out/v1/1dc6718be36f4f34bb9cd86bc50925e6/sports_endpoint/index.m3u8" } ] } ``` Para obter mais informações, consulte Visualizar uma configuração no *Guia do usuário do AWS Elemental MediaTailor*. + Para ver detalhes da API, consulte [ListPlaybackConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediatailor/list-playback-configurations.html) na *Referência de comandos da AWS CLI*. ### `put-playback-configuration` O código de exemplo a seguir mostra como usar `put-playback-configuration`. **AWS CLI** **Para criar uma configuração** O comando `put-playback-configuration` a seguir cria uma configuração chamada `campaign_short`. ``` aws mediatailor put-playback-configuration \ --name campaign_short \ --ad-decision-server-url http://your.ads.url \ --video-content-source-url http://video.bucket/index.m3u8 ``` Resultado: ``` { "AdDecisionServerUrl": "http://your.ads.url", "CdnConfiguration": {}, "DashConfiguration": { "ManifestEndpointPrefix": "https://13484114d38f4383bc0d6a7cb879bd00.mediatailor.us-west-2.amazonaws.com/v1/dash/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/campaign_short/", "MpdLocation": "EMT_DEFAULT", "OriginManifestType": "MULTI_PERIOD" }, "HlsConfiguration": { "ManifestEndpointPrefix": "https://13484114d38f4383bc0d6a7cb879bd00.mediatailor.us-west-2.amazonaws.com/v1/master/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/campaign_short/" }, "Name": "campaign_short", "PlaybackConfigurationArn": "arn:aws:mediatailor:us-west-2:123456789012:playbackConfiguration/campaign_short", "PlaybackEndpointPrefix": "https://13484114d38f4383bc0d6a7cb879bd00.mediatailor.us-west-2.amazonaws.com", "SessionInitializationEndpointPrefix": "https://13484114d38f4383bc0d6a7cb879bd00.mediatailor.us-west-2.amazonaws.com/v1/session/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/campaign_short/", "Tags": {}, "VideoContentSourceUrl": "http://video.bucket/index.m3u8" } ``` Para obter mais informações, consulte [Criar uma configuração](https://docs.aws.amazon.com/mediatailor/latest/ug/configurations-create.html) no *Guia do usuário do AWS Elemental MediaTailor*. + Para ver detalhes da API, consulte [PutPlaybackConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediatailor/put-playback-configuration.html) na *Referência de comandos da AWS CLI*. # Exemplos do MemoryDB usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o MemoryDB. *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-snapshot` O código de exemplo a seguir mostra como usar `copy-snapshot`. **AWS CLI** **Para copiar um snapshot** O exemplo `copy-snapshot` a seguir cria uma cópia de um snapshot. ``` aws memorydb copy-snapshot \ --source-snapshot-name my-cluster-snapshot \ --target-snapshot-name my-cluster-snapshot-copy ``` Output ``` { "Snapshot": { "Name": "my-cluster-snapshot-copy", "Status": "creating", "Source": "manual", "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:snapshot/my-cluster-snapshot-copy", "ClusterConfiguration": { "Name": "my-cluster", "Description": " ", "NodeType": "db.r6g.large", "EngineVersion": "6.2", "MaintenanceWindow": "wed:03:00-wed:04:00", "Port": 6379, "ParameterGroupName": "default.memorydb-redis6", "SubnetGroupName": "my-sg", "VpcId": "vpc-xx2574fc", "SnapshotRetentionLimit": 0, "SnapshotWindow": "04:30-05:30", "NumShards": 2 } } } ``` Para obter mais informações, consulte [Copiar um snapshot](https://docs.aws.amazon.com/memorydb/latest/devguide/snapshots-copying.html) no *Guia do usuário do MemoryDB*. + Para ver detalhes da API, consulte [CopySnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/copy-snapshot.html) na *Referência de comandos da AWS CLI*. ### `create-acl` O código de exemplo a seguir mostra como usar `create-acl`. **AWS CLI** **Para criar uma ACL** O exemplo `create-acl` a seguir cria uma nova lista de controle de acesso. ``` aws memorydb create-acl \ --acl-name "new-acl-1" \ --user-names "my-user" ``` Resultado: ``` { "ACL": { "Name": "new-acl-1", "Status": "creating", "UserNames": [ "my-user" ], "MinimumEngineVersion": "6.2", "Clusters": [], "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:acl/new-acl-1" } } ``` Para obter mais informações, consulte [Autenticar usuários com listas de controle de acesso](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.acls.html) no *Guia do usuário do MemoryDB*. + Para ver detalhes da API, consulte [CreateAcl](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/create-acl.html) na *Referência de comandos da AWS CLI*. ### `create-cluster` O código de exemplo a seguir mostra como usar `create-cluster`. **AWS CLI** **Para criar um cluster** O exemplo `create-cluster` a seguir cria um novo cluster. ``` aws memorydb create-cluster \ --cluster-name my-new-cluster \ --node-type db.r6g.large \ --acl-name my-acl \ --subnet-group my-sg ``` Resultado: ``` { "Cluster": { "Name": "my-new-cluster", "Status": "creating", "NumberOfShards": 1, "AvailabilityMode": "MultiAZ", "ClusterEndpoint": { "Port": 6379 }, "NodeType": "db.r6g.large", "EngineVersion": "6.2", "EnginePatchVersion": "6.2.6", "ParameterGroupName": "default.memorydb-redis6", "ParameterGroupStatus": "in-sync", "SubnetGroupName": "my-sg", "TLSEnabled": true, "ARN": "arn:aws:memorydb:us-east-1:49165xxxxxx:cluster/my-new-cluster", "SnapshotRetentionLimit": 0, "MaintenanceWindow": "sat:10:00-sat:11:00", "SnapshotWindow": "07:30-08:30", "ACLName": "my-acl", "AutoMinorVersionUpgrade": true } } ``` Para obter mais informações, consulte [Gerenciar clusters](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.html) no *Guia do usuário do MemoryDB*. + Consulte detalhes da API em [CreateCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/create-cluster.html) na *Referência de comandos da AWS CLI*. ### `create-parameter-group` O código de exemplo a seguir mostra como usar `create-parameter-group`. **AWS CLI** **Para criar um grupo de parâmetros** O exemplo `create-parameter-group` a seguir cria um grupo de parâmetros. ``` aws memorydb create-parameter-group \ --parameter-group-name myRedis6x \ --family memorydb_redis6 \ --description "my-parameter-group" ``` Resultado: ``` { "ParameterGroup": { "Name": "myredis6x", "Family": "memorydb_redis6", "Description": "my-parameter-group", "ARN": "arn:aws:memorydb:us-east-1:49165xxxxxx:parametergroup/myredis6x" } } ``` Para obter mais informações, consulte [Criar um grupo de parâmetros](https://docs.aws.amazon.com/memorydb/latest/devguide/parametergroups.creating.html) no *Guia do usuário do MemoryDB*. + Para ver detalhes da API, consulte [CreateParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/create-parameter-group.html) na *Referência de comandos da AWS CLI*. ### `create-snapshot` O código de exemplo a seguir mostra como usar `create-snapshot`. **AWS CLI** **Para criar um snapshot** O exemplo `create-snapshot` a seguir cria um snapshot. ``` aws memorydb create-snapshot \ --cluster-name my-cluster \ --snapshot-name my-cluster-snapshot ``` Resultado: ``` { "Snapshot": { "Name": "my-cluster-snapshot1", "Status": "creating", "Source": "manual", "ARN": "arn:aws:memorydb:us-east-1:49165xxxxxx:snapshot/my-cluster-snapshot", "ClusterConfiguration": { "Name": "my-cluster", "Description": "", "NodeType": "db.r6g.large", "EngineVersion": "6.2", "MaintenanceWindow": "wed:03:00-wed:04:00", "Port": 6379, "ParameterGroupName": "default.memorydb-redis6", "SubnetGroupName": "my-sg", "VpcId": "vpc-862xxxxc", "SnapshotRetentionLimit": 0, "SnapshotWindow": "04:30-05:30", "NumShards": 2 } } } ``` Para obter mais informações, consulte [Fazer snapshots manuais](https://docs.aws.amazon.com/memorydb/latest/devguide/snapshots-manual.html) no *Guia do usuário do MemoryDB*. + Para ver detalhes da API, consulte [CreateSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/create-snapshot.html) na *Referência de comandos da AWS CLI*. ### `create-subnet-group` O código de exemplo a seguir mostra como usar `create-subnet-group`. **AWS CLI** **Para criar um grupo de sub-redes** O exemplo `create-subnet-group` a seguir cria um grupo de sub-redes. ``` aws memorydb create-subnet-group \ --subnet-group-name mysubnetgroup \ --description "my subnet group" \ --subnet-ids subnet-5623xxxx ``` Resultado: ``` { "SubnetGroup": { "Name": "mysubnetgroup", "Description": "my subnet group", "VpcId": "vpc-86257xxx", "Subnets": [ { "Identifier": "subnet-5623xxxx", "AvailabilityZone": { "Name": "us-east-1a" } } ], "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:subnetgroup/mysubnetgroup" } } ``` Para obter mais informações, consulte [Criar um grupo de sub-redes](https://docs.aws.amazon.com/memorydb/latest/devguide/subnetgroups.creating.html) no *Guia do usuário do MemoryDB*. + Para ver detalhes da API, consulte [CreateSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/create-subnet-group.html) na *Referência de comandos da AWS CLI*. ### `create-user` O código de exemplo a seguir mostra como usar `create-user`. **AWS CLI** **Para criar um usuário** O exemplo `create-user` a seguir cria um novo usuário. ``` aws memorydb create-user \ --user-name user-name-1 \ --access-string "~objects:* ~items:* ~public:*" \ --authentication-mode \ Passwords="enterapasswordhere",Type=password ``` Resultado: ``` { "User": { "Name": "user-name-1", "Status": "active", "AccessString": "off ~objects:* ~items:* ~public:* resetchannels -@all", "ACLNames": [], "MinimumEngineVersion": "6.2", "Authentication": { "Type": "password", "PasswordCount": 1 }, "ARN": "arn:aws:memorydb:us-west-2:491658xxxxxx:user/user-name-1" } } ``` Para obter mais informações, consulte [Autenticar usuários com listas de controle de acesso](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.acls.html) no *Guia do usuário do MemoryDB*. + Consulte detalhes da API em [CreateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/create-user.html) na *Referência de comandos da AWS CLI*. ### `delete-acl` O código de exemplo a seguir mostra como usar `delete-acl`. **AWS CLI** **Para excluir uma ACL** O exemplo `delete-acl` a seguir exclui uma lista de controle de acesso. ``` aws memorydb delete-acl \ --acl-name "new-acl-1" ``` Resultado: ``` { "ACL": { "Name": "new-acl-1", "Status": "deleting", "UserNames": [ "pat" ], "MinimumEngineVersion": "6.2", "Clusters": [], "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:acl/new-acl-1" } } ``` Para obter mais informações, consulte [Autenticar usuários com listas de controle de acesso](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.acls.html) no *Guia do usuário do MemoryDB*. + Para ver detalhes da API, consulte [DeleteAcl](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/delete-acl.html) na *Referência de comandos da AWS CLI*. ### `delete-cluster` O código de exemplo a seguir mostra como usar `delete-cluster`. **AWS CLI** **Para excluir um cluster** O exemplo `delete-cluster` a seguir exclui um cluster. ``` aws memorydb delete-cluster \ --cluster-name my-new-cluster ``` Resultado: ``` { "Cluster": { "Name": "my-new-cluster", "Status": "deleting", "NumberOfShards": 1, "ClusterEndpoint": { "Address": "clustercfg.my-new-cluster.xxxxx.memorydb.us-east-1.amazonaws.com", "Port": 6379 }, "NodeType": "db.r6g.large", "EngineVersion": "6.2", "EnginePatchVersion": "6.2.6", "ParameterGroupName": "default.memorydb-redis6", "ParameterGroupStatus": "in-sync", "SubnetGroupName": "my-sg", "TLSEnabled": true, "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:cluster/my-new-cluster", "SnapshotRetentionLimit": 0, "MaintenanceWindow": "sat:10:00-sat:11:00", "SnapshotWindow": "07:30-08:30", "AutoMinorVersionUpgrade": true } } ``` Para obter mais informações, consulte [Excluir um cluster](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.delete.html) no *Guia do usuário do MemoryDB*. + Consulte detalhes da API em [DeleteCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/delete-cluster.html) na *Referência de comandos da AWS CLI*. ### `delete-parameter-group` O código de exemplo a seguir mostra como usar `delete-parameter-group`. **AWS CLI** **Para excluir um grupo de parâmetros** O exemplo `delete-parameter-group` a seguir exclui um grupo de parâmetros. ``` aws memorydb delete-parameter-group \ --parameter-group-name myRedis6x ``` Resultado: ``` { "ParameterGroup": { "Name": "myredis6x", "Family": "memorydb_redis6", "Description": "my-parameter-group", "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:parametergroup/myredis6x" } } ``` Para obter mais informações, consulte [Excluir um grupo de parâmetros](https://docs.aws.amazon.com/memorydb/latest/devguide/parametergroups.deleting.html) no *Guia do usuário do MemoryDB*. + Para ver detalhes da API, consulte [DeleteParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/delete-parameter-group.html) na *Referência de comandos da AWS CLI*. ### `delete-snapshot` O código de exemplo a seguir mostra como usar `delete-snapshot`. **AWS CLI** **Para excluir um snapshot** O exemplo `delete-snapshot` a seguir exclui um snapshot. ``` aws memorydb delete-snapshot \ --snapshot-name my-cluster-snapshot ``` Resultado: ``` { "Snapshot": { "Name": "my-cluster-snapshot", "Status": "deleting", "Source": "manual", "ARN": "arn:aws:memorydb:us-east-1:49165xxxxxx:snapshot/my-cluster-snapshot", "ClusterConfiguration": { "Name": "my-cluster", "Description": "", "NodeType": "db.r6g.large", "EngineVersion": "6.2", "MaintenanceWindow": "wed:03:00-wed:04:00", "Port": 6379, "ParameterGroupName": "default.memorydb-redis6", "SubnetGroupName": "my-sg", "VpcId": "vpc-862xxxxc", "SnapshotRetentionLimit": 0, "SnapshotWindow": "04:30-05:30", "NumShards": 2 } } } ``` Para obter mais informações, consulte [Excluir um snapshot](https://docs.aws.amazon.com/memorydb/latest/devguide/snapshots-deleting.html) no *Guia do usuário do MemoryDB*. + Consulte detalhes da API em [DeleteSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/delete-snapshot.html) na *Referência de comandos da AWS CLI*. ### `delete-subnet-group` O código de exemplo a seguir mostra como usar `delete-subnet-group`. **AWS CLI** **Para excluir um grupo de sub-redes** O exemplo `delete-subnet-group` a seguir exclui uma sub-rede. ``` aws memorydb delete-subnet-group \ --subnet-group-name mysubnetgroup ``` Resultado: ``` { "SubnetGroup": { "Name": "mysubnetgroup", "Description": "my subnet group", "VpcId": "vpc-86xxxx4fc", "Subnets": [ { "Identifier": "subnet-56xxx61b", "AvailabilityZone": { "Name": "us-east-1a" } } ], "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:subnetgroup/mysubnetgroup" } } ``` Para obter mais informações, consulte [Excluir uma sub-rede](https://docs.aws.amazon.com/memorydb/latest/devguide/subnetgroups.deleting.html) no *Guia do usuário do MemoryDB*. + Para ver detalhes da API, consulte [DeleteSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/delete-subnet-group.html) na *Referência de comandos da AWS CLI*. ### `delete-user` O código de exemplo a seguir mostra como usar `delete-user`. **AWS CLI** **Para excluir um usuário** O exemplo `delete-user` a seguir exclui um usuário. ``` aws memorydb delete-user \ --user-name my-user ``` Resultado: ``` { "User": { "Name": "my-user", "Status": "deleting", "AccessString": "on ~app::* resetchannels -@all +@read", "ACLNames": [ "my-acl" ], "MinimumEngineVersion": "6.2", "Authentication": { "Type": "password", "PasswordCount": 1 }, "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:user/my-user" } } ``` Para obter mais informações, consulte [Autenticar usuários com listas de controle de acesso](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.acls.html) no *Guia do usuário do MemoryDB*. + Consulte detalhes da API em [DeleteUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/delete-user.html) na *Referência de comandos da AWS CLI*. ### `describe-acls` O código de exemplo a seguir mostra como usar `describe-acls`. **AWS CLI** **Como retornar uma lista de ACLs** O comando describe-acls a seguir retorna uma lista de ACLs. ``` aws memorydb describe-acls ``` Resultado: ``` { "ACLs": [ { "Name": "open-access", "Status": "active", "UserNames": [ "default" ], "MinimumEngineVersion": "6.2", "Clusters": [], "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:acl/open-access" }, { "Name": my-acl", "Status": "active", "UserNames": [], "MinimumEngineVersion": "6.2", "Clusters": [ "my-cluster" ], "ARN": "arn:aws:memorydb:us-east-1:49165xxxxxxx:acl/my-acl" } ] } ``` Para obter mais informações, consulte [Autenticar usuários com listas de controle de acesso](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.acls.html) no *Guia do usuário do MemoryDB*. + Para ver detalhes da API, consulte [DescribeAcls](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/describe-acls.html) na *Referência de comandos da AWS CLI*. ### `describe-clusters` O código de exemplo a seguir mostra como usar `describe-clusters`. **AWS CLI** **Como retornar uma lista de clusters** O comando describe-clusters a seguir retorna uma lista de clusters. ``` aws memorydb describe-clusters ``` Resultado: ``` { "Clusters": [ { "Name": "my-cluster", "Status": "available", "NumberOfShards": 2, "ClusterEndpoint": { "Address": "clustercfg.my-cluster.llru6f.memorydb.us-east-1.amazonaws.com", "Port": 6379 }, "NodeType": "db.r6g.large", "EngineVersion": "6.2", "EnginePatchVersion": "6.2.6", "ParameterGroupName": "default.memorydb-redis6", "ParameterGroupStatus": "in-sync", "SecurityGroups": [ { "SecurityGroupId": "sg-0a1434xxxxxc9fae", "Status": "active" } ], "SubnetGroupName": "pat-sg", "TLSEnabled": true, "ARN": "arn:aws:memorydb:us-east-1:49165xxxxxx:cluster/my-cluster", "SnapshotRetentionLimit": 0, "MaintenanceWindow": "wed:03:00-wed:04:00", "SnapshotWindow": "04:30-05:30", "ACLName": "my-acl", "AutoMinorVersionUpgrade": true } ] } ``` Para obter mais informações, consulte [Gerenciar clusters](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.html) no *Guia do usuário do MemoryDB*. + Consulte detalhes da API em [DescribeClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/describe-clusters.html) na *Referência de comandos da AWS CLI*. ### `describe-engine-versions` O código de exemplo a seguir mostra como usar `describe-engine-versions`. **AWS CLI** **Como retornar uma lista das versões do motor** O comando describe-engine-versions a seguir retorna uma lista das versões do motor. ``` aws memorydb describe-engine-versions ``` Resultado: ``` { "EngineVersions": [ { "EngineVersion": "6.2", "EnginePatchVersion": "6.2.6", "ParameterGroupFamily": "memorydb_redis6" } ] } ``` Para obter mais informações, consulte [Versões e atualizações do motor](https://docs.aws.amazon.com/memorydb/latest/devguide/engine-versions.htmll) no *Guia do usuário do MemoryDB*. + Para ver detalhes da API, consulte [DescribeEngineVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/describe-engine-versions.html) na *Referência de comandos da AWS CLI*. ### `describe-events` O código de exemplo a seguir mostra como usar `describe-events`. **AWS CLI** **Como retornar uma lista de eventos** O comando describe-events a seguir retorna uma lista de eventos. ``` aws memorydb describe-events ``` Resultado: ``` { "Events": [ { "SourceName": "my-cluster", "SourceType": "cluster", "Message": "Increase replica count started for replication group my-cluster on 2022-07-22T14:09:01.440Z", "Date": "2022-07-22T07:09:01.443000-07:00" }, { "SourceName": "my-user", "SourceType": "user", "Message": "Create user my-user operation completed.", "Date": "2022-07-22T07:00:02.975000-07:00" } ] } ``` Para obter mais informações, consulte [Monitorar eventos](https://docs.aws.amazon.com/memorydb/latest/devguide/monitoring-events.html) no *Guia do usuário do MemoryDB*. + Para ver detalhes da API, consulte [DescribeEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/describe-events.html) na *Referência de comandos da AWS CLI*. ### `describe-parameter-groups` O código de exemplo a seguir mostra como usar `describe-parameter-groups`. **AWS CLI** **Como retornar uma lista de grupos de parâmetros** O comando describe-parameter-groups a seguir retorna uma lista de grupos de parâmetros. ``` aws memorydb describe-parameter-groups ``` Resultado: ``` { "ParameterGroups": [ { "Name": "default.memorydb-redis6", "Family": "memorydb_redis6", "Description": "Default parameter group for memorydb_redis6", "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:parametergroup/default.memorydb-redis6" } ] } ``` Para obter mais informações, consulte [Configurar parâmetros do motor usando grupos de parâmetros](https://docs.aws.amazon.com/memorydb/latest/devguide/parametergroups.html) no *Guia do usuário do MemoryDB*. + Para ver detalhes da API, consulte [DescribeParameterGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/describe-parameter-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-parameters` O código de exemplo a seguir mostra como usar `describe-parameters`. **AWS CLI** **Como retornar uma lista de parâmetros** O comando describe-parameters a seguir retorna uma lista de parâmetros. ``` aws memorydb describe-parameters ``` Resultado: ``` { "Parameters": [ { "Name": "acllog-max-len", "Value": "128", "Description": "The maximum length of the ACL Log", "DataType": "integer", "AllowedValues": "1-10000", "MinimumEngineVersion": "6.2.4" }, { "Name": "activedefrag", "Value": "no", "Description": "Enabled active memory defragmentation", "DataType": "string", "AllowedValues": "yes,no", "MinimumEngineVersion": "6.2.4" }, { "Name": "active-defrag-cycle-max", "Value": "75", "Description": "Maximal effort for defrag in CPU percentage", "DataType": "integer", "AllowedValues": "1-75", "MinimumEngineVersion": "6.2.4" }, { "Name": "active-defrag-cycle-min", "Value": "5", "Description": "Minimal effort for defrag in CPU percentage", "DataType": "integer", "AllowedValues": "1-75", "MinimumEngineVersion": "6.2.4" }, { "Name": "active-defrag-ignore-bytes", "Value": "104857600", "Description": "Minimum amount of fragmentation waste to start active defrag", "DataType": "integer", "AllowedValues": "1048576-", "MinimumEngineVersion": "6.2.4" }, { "Name": "active-defrag-max-scan-fields", "Value": "1000", "Description": "Maximum number of set/hash/zset/list fields that will be processed from the main dictionary scan", "DataType": "integer", "AllowedValues": "1-1000000", "MinimumEngineVersion": "6.2.4" }, { "Name": "active-defrag-threshold-lower", "Value": "10", "Description": "Minimum percentage of fragmentation to start active defrag", "DataType": "integer", "AllowedValues": "1-100", "MinimumEngineVersion": "6.2.4" }, { "Name": "active-defrag-threshold-upper", "Value": "100", "Description": "Maximum percentage of fragmentation at which we use maximum effort", "DataType": "integer", "AllowedValues": "1-100", "MinimumEngineVersion": "6.2.4" }, { "Name": "active-expire-effort", "Value": "1", "Description": "The amount of effort that redis uses to expire items in the active expiration job", "DataType": "integer", "AllowedValues": "1-10", "MinimumEngineVersion": "6.2.4" }, { "Name": "activerehashing", "Value": "yes", "Description": "Apply rehashing or not", "DataType": "string", "AllowedValues": "yes,no", "MinimumEngineVersion": "6.2.4" }, { "Name": "client-output-buffer-limit-normal-hard-limit", "Value": "0", "Description": "Normal client output buffer hard limit in bytes", "DataType": "integer", "AllowedValues": "0-", "MinimumEngineVersion": "6.2.4" }, { "Name": "client-output-buffer-limit-normal-soft-limit", "Value": "0", "Description": "Normal client output buffer soft limit in bytes", "DataType": "integer", "AllowedValues": "0-", "MinimumEngineVersion": "6.2.4" }, { "Name": "client-output-buffer-limit-normal-soft-seconds", "Value": "0", "Description": "Normal client output buffer soft limit in seconds", "DataType": "integer", "AllowedValues": "0-", "MinimumEngineVersion": "6.2.4" }, { "Name": "client-output-buffer-limit-pubsub-hard-limit", "Value": "33554432", "Description": "Pubsub client output buffer hard limit in bytes", "DataType": "integer", "AllowedValues": "0-", "MinimumEngineVersion": "6.2.4" }, { "Name": "client-output-buffer-limit-pubsub-soft-limit", "Value": "8388608", "Description": "Pubsub client output buffer soft limit in bytes", "DataType": "integer", "AllowedValues": "0-", "MinimumEngineVersion": "6.2.4" }, { "Name": "client-output-buffer-limit-pubsub-soft-seconds", "Value": "60", "Description": "Pubsub client output buffer soft limit in seconds", "DataType": "integer", "AllowedValues": "0-", "MinimumEngineVersion": "6.2.4" }, { "Name": "hash-max-ziplist-entries", "Value": "512", "Description": "The maximum number of hash entries in order for the dataset to be compressed", "DataType": "integer", "AllowedValues": "0-", "MinimumEngineVersion": "6.2.4" }, { "Name": "hash-max-ziplist-value", "Value": "64", "Description": "The threshold of biggest hash entries in order for the dataset to be compressed", "DataType": "integer", "AllowedValues": "0-", "MinimumEngineVersion": "6.2.4" }, { "Name": "hll-sparse-max-bytes", "Value": "3000", "Description": "HyperLogLog sparse representation bytes limit", "DataType": "integer", "AllowedValues": "1-16000", "MinimumEngineVersion": "6.2.4" }, { "Name": "lazyfree-lazy-eviction", "Value": "no", "Description": "Perform an asynchronous delete on evictions", "DataType": "string", "AllowedValues": "yes,no", "MinimumEngineVersion": "6.2.4" }, { "Name": "lazyfree-lazy-expire", "Value": "no", "Description": "Perform an asynchronous delete on expired keys", "DataType": "string", "AllowedValues": "yes,no", "MinimumEngineVersion": "6.2.4" }, { "Name": "lazyfree-lazy-server-del", "Value": "no", "Description": "Perform an asynchronous delete on key updates", "DataType": "string", "AllowedValues": "yes,no", "MinimumEngineVersion": "6.2.4" }, { "Name": "lazyfree-lazy-user-del", "Value": "no", "Description": "Specifies whether the default behavior of DEL command acts the same as UNLINK", "DataType": "string", "AllowedValues": "yes,no", "MinimumEngineVersion": "6.2.4" }, { "Name": "lfu-decay-time", "Value": "1", "Description": "The amount of time in minutes to decrement the key counter for LFU eviction policyd", "DataType": "integer", "AllowedValues": "0-", "MinimumEngineVersion": "6.2.4" }, { "Name": "lfu-log-factor", "Value": "10", "Description": "The log factor for incrementing key counter for LFU eviction policy", "DataType": "integer", "AllowedValues": "1-", "MinimumEngineVersion": "6.2.4" }, { "Name": "list-compress-depth", "Value": "0", "Description": "Number of quicklist ziplist nodes from each side of the list to exclude from compression. The head and tail of the list are always uncompressed for fast push/pop operations", "DataType": "integer", "AllowedValues": "0-", "MinimumEngineVersion": "6.2.4" }, { "Name": "maxmemory-policy", "Value": "noeviction", "Description": "Max memory policy", "DataType": "string", "AllowedValues": "volatile-lru,allkeys-lru,volatile-lfu,allkeys-lfu,volatile-random,allkeys-random,volatile-ttl,noeviction", "MinimumEngineVersion": "6.2.4" }, { "Name": "maxmemory-samples", "Value": "3", "Description": "Max memory samples", "DataType": "integer", "AllowedValues": "1-", "MinimumEngineVersion": "6.2.4" }, { "Name": "notify-keyspace-events", "Description": "The keyspace events for Redis to notify Pub/Sub clients about. By default all notifications are disabled", "DataType": "string", "MinimumEngineVersion": "6.2.4" }, { "Name": "set-max-intset-entries", "Value": "512", "Description": "The limit in the size of the set in order for the dataset to be compressed", "DataType": "integer", "AllowedValues": "0-", "MinimumEngineVersion": "6.2.4" }, { "Name": "slowlog-log-slower-than", "Value": "10000", "Description": "The execution time, in microseconds, to exceed in order for the command to get logged. Note that a negative number disables the slow log, while a value of zero forces the logging of every command", "DataType": "integer", "AllowedValues": "-", "MinimumEngineVersion": "6.2.4" }, { "Name": "slowlog-max-len", "Value": "128", "Description": "The length of the slow log. There is no limit to this length. Just be aware that it will consume memory. You can reclaim memory used by the slow log with SLOWLOG RESET.", "DataType": "integer", "AllowedValues": "0-", "MinimumEngineVersion": "6.2.4" }, { "Name": "stream-node-max-bytes", "Value": "4096", "Description": "The maximum size of a single node in a stream in bytes", "DataType": "integer", "AllowedValues": "0-", "MinimumEngineVersion": "6.2.4" }, { "Name": "stream-node-max-entries", "Value": "100", "Description": "The maximum number of items a single node in a stream can contain", "DataType": "integer", "AllowedValues": "0-", "MinimumEngineVersion": "6.2.4" }, { "Name": "tcp-keepalive", "Value": "300", "Description": "If non-zero, send ACKs every given number of seconds", "DataType": "integer", "AllowedValues": "0-", "MinimumEngineVersion": "6.2.4" }, { "Name": "timeout", "Value": "0", "Description": "Close connection if client is idle for a given number of seconds, or never if 0", "DataType": "integer", "AllowedValues": "0,20-", "MinimumEngineVersion": "6.2.4" }, { "Name": "tracking-table-max-keys", "Value": "1000000", "Description": "The maximum number of keys allowed for the tracking table for client side caching", "DataType": "integer", "AllowedValues": "1-100000000", "MinimumEngineVersion": "6.2.4" }, { "Name": "zset-max-ziplist-entries", "Value": "128", "Description": "The maximum number of sorted set entries in order for the dataset to be compressed", "DataType": "integer", "AllowedValues": "0-", "MinimumEngineVersion": "6.2.4" }, { "Name": "zset-max-ziplist-value", "Value": "64", "Description": "The threshold of biggest sorted set entries in order for the dataset to be compressed", "DataType": "integer", "AllowedValues": "0-", "MinimumEngineVersion": "6.2.4" } ] } ``` Para obter mais informações, consulte [Configurar parâmetros do motor usando grupos de parâmetros](https://docs.aws.amazon.com/memorydb/latest/devguide/parametergroups.html) no *Guia do usuário do MemoryDB*. + Consulte detalhes da API em [DescribeParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/describe-parameters.html) na *Referência de comandos da AWS CLI*. ### `describe-snapshots` O código de exemplo a seguir mostra como usar `describe-snapshots`. **AWS CLI** **Como retornar uma lista de snapshots** O comando describe-snapshots a seguir retorna uma lista de snapshots. ``` aws memorydb describe-snapshots ``` Resultado: ``` { "Snapshots": [ { "Name": "my-cluster-snapshot", "Status": "available", "Source": "manual", "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx2:snapshot/my-cluster-snapshot", "ClusterConfiguration": { "Name": "my-cluster", "Description": " ", "NodeType": "db.r6g.large", "EngineVersion": "6.2", "MaintenanceWindow": "wed:03:00-wed:04:00", "Port": 6379, "ParameterGroupName": "default.memorydb-redis6", "SubnetGroupName": "my-sg", "VpcId": "vpc-862574fc", "SnapshotRetentionLimit": 0, "SnapshotWindow": "04:30-05:30", "NumShards": 2 } } } ``` Para obter mais informações, consulte [Fazer snapshots e restaurações](https://docs.aws.amazon.com/memorydb/latest/devguide/snapshots.html) no *Guia do usuário do MemoryDB*. + Consulte detalhes da API em [DescribeSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/describe-snapshots.html) na *Referência de comandos da AWS CLI*. ### `describe-subnet-groups` O código de exemplo a seguir mostra como usar `describe-subnet-groups`. **AWS CLI** **Como retornar uma lista de grupos de sub-redes** O comando describe-subnet-groups a seguir retorna uma lista de grupos de sub-redes. ``` aws memorydb describe-subnet-groups ``` Output ``` { "SubnetGroups": [ { "Name": "my-sg", "Description": "pat-sg", "VpcId": "vpc-86xxx4fc", "Subnets": [ { "Identifier": "subnet-faxx84a6", "AvailabilityZone": { "Name": "us-east-1b" } }, { "Identifier": "subnet-56xxf61b", "AvailabilityZone": { "Name": "us-east-1a" } } ], "ARN": "arn:aws:memorydb:us-east-1:49165xxxxxx:subnetgroup/my-sg" } ] } ``` Para obter mais informações, consulte [Sub-redes e grupos de sub-redes](https://docs.aws.amazon.com/memorydb/latest/devguide/subnetgroups.html) no *Guia do usuário do MemoryDB*. + Para ver detalhes da API, consulte [DescribeSubnetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/describe-subnet-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-users` O código de exemplo a seguir mostra como usar `describe-users`. **AWS CLI** **Como retornar uma lista de usuários** O comando describe-users a seguir retorna uma lista de clusters. ``` aws memorydb describe-users ``` Output ``` { "Users": [ { "Name": "default", "Status": "active", "AccessString": "on ~* &* +@all", "ACLNames": [ "open-access" ], "MinimumEngineVersion": "6.0", "Authentication": { "Type": "no-password" }, "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:user/default" }, { "Name": "my-user", "Status": "active", "AccessString": "off ~objects:* ~items:* ~public:* resetchannels -@all", "ACLNames": [], "MinimumEngineVersion": "6.2", "Authentication": { "Type": "password", "PasswordCount": 2 }, "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:user/my-user" } ] } ``` Para obter mais informações, consulte [Autenticar usuários com listas de controle de acesso](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.acls.html) no *Guia do usuário do MemoryDB*. + Para ver detalhes da API, consulte [DescribeUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/describe-users.html) na *Referência de comandos da AWS CLI*. ### `failover-shard` O código de exemplo a seguir mostra como usar `failover-shard`. **AWS CLI** **Como realizar failover em um fragmento** O comando failover-shard a seguir realiza o failover em um fragmento. ``` aws memorydb failover-shard \ --cluster-name my-cluster --shard-name 0001 ``` Resultado: ``` { "Cluster": { "Name": "my-cluster", "Status": "available", "NumberOfShards": 2, "ClusterEndpoint": { "Address": "clustercfg.my-cluster.xxxxxx.memorydb.us-east-1.amazonaws.com", "Port": 6379 }, "NodeType": "db.r6g.large", "EngineVersion": "6.2", "EnginePatchVersion": "6.2.6", "ParameterGroupName": "default.memorydb-redis6", "ParameterGroupStatus": "in-sync", "SecurityGroups": [ { "SecurityGroupId": "sg-0a143xxxx45c9fae", "Status": "active" } ], "SubnetGroupName": "my-sg", "TLSEnabled": true, "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:cluster/my-cluster", "SnapshotRetentionLimit": 0, "MaintenanceWindow": "wed:03:00-wed:04:00", "SnapshotWindow": "04:30-05:30", "AutoMinorVersionUpgrade": true } } ``` Para obter mais informações, consulte [Minimizar o tempo de inatividade com MultiAZ](https://docs.aws.amazon.com/memorydb/latest/devguide/autofailover.html) no *Guia do usuário do MemoryDB*. + Para ver detalhes da API, consulte [FailoverShard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/failover-shard.html) na *Referência de comandos da AWS CLI*. ### `list-allowed-node-type-updates` O código de exemplo a seguir mostra como usar `list-allowed-node-type-updates`. **AWS CLI** **Como retornar uma lista de atualizações de tipos de nó permitidos** O comando list-allowed-node-type-updates a seguir retorna uma lista de atualizações de tipo de nó disponíveis. ``` aws memorydb list-allowed-node-type-updates ``` Resultado: ``` { "Cluster": { "Name": "my-cluster", "Status": "available", "NumberOfShards": 2, "ClusterEndpoint": { "Address": "clustercfg.my-cluster.xxxxxx.memorydb.us-east-1.amazonaws.com", "Port": 6379 }, "NodeType": "db.r6g.large", "EngineVersion": "6.2", "EnginePatchVersion": "6.2.6", "ParameterGroupName": "default.memorydb-redis6", "ParameterGroupStatus": "in-sync", "SecurityGroups": [ { "SecurityGroupId": "sg-0a143xxxx45c9fae", "Status": "active" } ], "SubnetGroupName": "my-sg", "TLSEnabled": true, "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:cluster/my-cluster", "SnapshotRetentionLimit": 0, "MaintenanceWindow": "wed:03:00-wed:04:00", "SnapshotWindow": "04:30-05:30", "AutoMinorVersionUpgrade": true } } ``` Para obter mais informações, consulte [Escalabilidade](https://docs.aws.amazon.com/memorydb/latest/devguide/scaling.html) no *Guia do usuário do MemoryDB*. + Para ver detalhes da API, consulte [ListAllowedNodeTypeUpdates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/list-allowed-node-type-updates.html) na *Referência de comandos da AWS CLI*. ### `list-tags` O código de exemplo a seguir mostra como usar `list-tags`. **AWS CLI** **Como retornar uma lista de tags** As o comando list-tags a seguir retorna uma lista de tags. ``` aws memorydb list-tags \ --resource-arn arn:aws:memorydb:us-east-1:491658xxxxxx:cluster/my-cluster ``` Resultado: ``` { "TagList": [ { "Key": "mytag", "Value": "myvalue" } ] } ``` Para obter mais informações, consulte [Adicionar tags a recursos](https://docs.aws.amazon.com/memorydb/latest/devguide/tagging-resources.html) no *Guia do usuário do MemoryDB*. + Consulte detalhes da API em [ListTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/list-tags.html) na *Referência de comandos da AWS CLI*. ### `reset-parameter-group` O código de exemplo a seguir mostra como usar `reset-parameter-group`. **AWS CLI** **Como redefinir um grupo de parâmetros** O comando reset-parameter-group a seguir redefine um grupo de parâmetros. ``` aws memorydb reset-parameter-group \ --parameter-group-name my-parameter-group \ --all-parameters ``` Resultado: ``` { "ParameterGroup": { "Name": "my-parameter-group", "Family": "memorydb_redis6", "Description": "my parameter group", "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:parametergroup/my-parameter-group" } } ``` Para obter mais informações, consulte [Configurar parâmetros do motor usando grupos de parâmetros](https://docs.aws.amazon.com/memorydb/latest/devguide/parametergroups.html) no *Guia do usuário do MemoryDB*. + Para ver detalhes da API, consulte [ResetParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/reset-parameter-group.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como marcar um recurso** O comando tag-resource a seguir adiciona uma tag a um recurso. ``` aws memorydb tag-resource \ --resource-arn arn:aws:memorydb:us-east-1:491658xxxxxx:cluster/my-cluster \ --tags Key="mykey",Value="myvalue" ``` Resultado: ``` { "TagList": [ { "Key": "mytag", "Value": "myvalue" }, { "Key": "mykey", "Value": "myvalue" } ] } ``` Para obter mais informações, consulte [Adicionar tags a recursos](https://docs.aws.amazon.com/memorydb/latest/devguide/tagging-resources.html) no *Guia do usuário do MemoryDB*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para atualizar uma ACL** O comando update-acl a seguir atualiza uma ACL adicionando um usuário. ``` aws memorydb untag-resource \ --resource-arn arn:aws:memorydb:us-east-1:491658xxxxx:cluster/my-cluster \ --tag-keys mykey ``` Resultado: ``` { "TagList": [ { "Key": "mytag", "Value": "myvalue" } ] } ``` Para obter mais informações, consulte [Adicionar tags a recursos](https://docs.aws.amazon.com/memorydb/latest/devguide/tagging-resources.html) no *Guia do usuário do MemoryDB*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-cluster` O código de exemplo a seguir mostra como usar `update-cluster`. **AWS CLI** **Para atualizar um cluster** O comando update-cluster a seguir atualiza o grupo de parâmetros de um cluster para my-parameter-group. ``` aws memorydb update-cluster \ --cluster-name my-cluster \ --parameter-group-name my-parameter-group ``` Resultado: ``` { "Cluster": { "Name": "my-cluster", "Status": "available", "NumberOfShards": 2, "AvailabilityMode": "MultiAZ", "ClusterEndpoint": { "Address": "clustercfg.my-cluster.llru6f.memorydb.us-east-1.amazonaws.com", "Port": 6379 }, "NodeType": "db.r6g.large", "EngineVersion": "6.2", "EnginePatchVersion": "6.2.6", "ParameterGroupName": "my-parameter-group", "ParameterGroupStatus": "in-sync", "SecurityGroups": [ { "SecurityGroupId": "sg-0a143xxxxxc9fae", "Status": "active" } ], "SubnetGroupName": "pat-sg", "TLSEnabled": true, "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:cluster/my-cluster", "SnapshotRetentionLimit": 0, "MaintenanceWindow": "wed:03:00-wed:04:00", "SnapshotWindow": "04:30-05:30", "ACLName": "my-acl", "AutoMinorVersionUpgrade": true } } ``` Para obter mais informações, consulte [Modificar um cluster](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.modify.html) no *Guia do usuário do MemoryDB*. + Para ver detalhes da API, consulte [UpdateCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/update-cluster.html) na *Referência de comandos da AWS CLI*. ### `update-parameter-group` O código de exemplo a seguir mostra como usar `update-parameter-group`. **AWS CLI** **Para atualizar um grupo de parâmetros** O comando update-parameter-group a seguir atualiza o grupo de parâmetros. ``` aws memorydb update-parameter-group \ --parameter-group-name my-parameter-group \ --parameter-name-values "ParameterName=activedefrag, ParameterValue=no" ``` Resultado: ``` { "ParameterGroup": { "Name": "my-parameter-group", "Family": "memorydb_redis6", "Description": "my parameter group", "ARN": "arn:aws:memorydb:us-east-1:49165xxxxxx:parametergroup/my-parameter-group" } } ``` Para obter mais informações, consulte [Modificar um grupo de parâmetros](https://docs.aws.amazon.com/memorydb/latest/devguide/parametergroups.modifying.html) no *Guia do usuário do MemoryDB*. + Para ver detalhes da API, consulte [UpdateParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/update-parameter-group.html) na *Referência de comandos da AWS CLI*. ### `update-subnet-group` O código de exemplo a seguir mostra como usar `update-subnet-group`. **AWS CLI** **Para atualizar um grupo de sub-redes** O comando update-subnet-group a seguir atualiza o ID de sub-rede de um grupo de sub-redes. ``` aws memorydb update-subnet-group \ --subnet-group-name my-sg \ --subnet-ids subnet-01f29d458f3xxxxx ``` Resultado: ``` { "SubnetGroup": { "Name": "my-sg-1", "Description": "my-sg", "VpcId": "vpc-09d2cfc01xxxxxxx", "Subnets": [ { "Identifier": "subnet-01f29d458fxxxxxx", "AvailabilityZone": { "Name": "us-east-1a" } } ], "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:subnetgroup/my-sg" } } ``` Para obter mais informações, consulte [Sub-redes e grupos de sub-redes](https://docs.aws.amazon.com/memorydb/latest/devguide/subnetgroups.html) no *Guia do usuário do MemoryDB*. + Para ver detalhes da API, consulte [UpdateSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/update-subnet-group.html) na *Referência de comandos da AWS CLI*. ### `update-user` O código de exemplo a seguir mostra como usar `update-user`. **AWS CLI** **Para atualizar um usuário** O comando `update-user` a seguir modifica a string de acesso de um usuário. ``` aws memorydb update-user \ --user-name my-user \ --access-string "off ~objects:* ~items:* ~public:* resetchannels -@all" ``` Resultado: ``` { "User": { "Name": "my-user", "Status": "modifying", "AccessString": "off ~objects:* ~items:* ~public:* resetchannels -@all", "ACLNames": [ "myt-acl" ], "MinimumEngineVersion": "6.2", "Authentication": { "Type": "password", "PasswordCount": 2 }, "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:user/my-user" } } ``` Para obter mais informações, consulte [Autenticar usuários com listas de controle de acesso](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.acls.html) no *Guia do usuário do MemoryDB*. + Consulte detalhes da API em [UpdateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/update-user.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon MSK usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o Amazon MSK. *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 ### `create-cluster` O código de exemplo a seguir mostra como usar `create-cluster`. **AWS CLI** **Para criar um cluster do Amazon MSK** O exemplo `create-cluster` a seguir cria um cluster MSK chamado `MessagingCluster` com três nós de agente. Um arquivo JSON chamado `brokernodegroupinfo.json` especifica as três sub-redes nas quais o Amazon MSK deverá distribua os nós do agente. Este exemplo não especifica o nível de monitoramento. Portanto, o cluster obtém o nível `DEFAULT`. ``` aws kafka create-cluster \ --cluster-name "MessagingCluster" \ --broker-node-group-info file://brokernodegroupinfo.json \ --kafka-version "2.2.1" \ --number-of-broker-nodes 3 ``` Conteúdo de `brokernodegroupinfo.json`: ``` { "InstanceType": "kafka.m5.xlarge", "BrokerAZDistribution": "DEFAULT", "ClientSubnets": [ "subnet-0123456789111abcd", "subnet-0123456789222abcd", "subnet-0123456789333abcd" ] } ``` Resultado: ``` { "ClusterArn": "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2", "ClusterName": "MessagingCluster", "State": "CREATING" } ``` Para obter mais informações, consulte [Criar um cluster no Amazon MSK](https://docs.aws.amazon.com/msk/latest/developerguide/msk-create-cluster.html) no *Guia do desenvolvedor do Amazon Managed Streaming for Apache Kafka*. + Consulte detalhes da API em [CreateCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kafka/create-cluster.html) na *Referência de comandos da AWS CLI*. ### `create-configuration` O código de exemplo a seguir mostra como usar `create-configuration`. **AWS CLI** **Para excluir uma configuração personalizada do Amazon MSK** O exemplo `create-configuration` a seguir cria uma configuração MSK personalizada com as propriedades do servidor especificadas no arquivo de entrada. ``` aws kafka create-configuration \ --name "CustomConfiguration" \ --description "Topic autocreation enabled; Apache ZooKeeper timeout 2000 ms; Log rolling 604800000 ms." \ --kafka-versions "2.2.1" \ --server-properties file://configuration.txt ``` Conteúdo de `configuration.txt`: ``` auto.create.topics.enable = true zookeeper.connection.timeout.ms = 2000 log.roll.ms = 604800000 ``` Este comando não produz saída. Resultado: ``` { "Arn": "arn:aws:kafka:us-west-2:123456789012:configuration/CustomConfiguration/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2", "CreationTime": "2019-10-09T15:26:05.548Z", "LatestRevision": { "CreationTime": "2019-10-09T15:26:05.548Z", "Description": "Topic autocreation enabled; Apache ZooKeeper timeout 2000 ms; Log rolling 604800000 ms.", "Revision": 1 }, "Name": "CustomConfiguration" } ``` Para obter mais informações, consulte [Operações de configuração do Amazon MSK](https://docs.aws.amazon.com/msk/latest/developerguide/msk-configuration-operations.html) no *Guia do desenvolvedor do Amazon Managed Streaming for Apache Kafka*. + Para ver detalhes da API, consulte [CreateConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kafka/create-configuration.html) na *Referência de comandos da AWS CLI*. ### `describe-cluster` O código de exemplo a seguir mostra como usar `describe-cluster`. **AWS CLI** **Para descrever um cluster** O exemplo `describe-cluster` a seguir descreve um cluster do Amazon MSK. ``` aws kafka describe-cluster \ --cluster-arn arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 ``` Resultado: ``` { "ClusterInfo": { "BrokerNodeGroupInfo": { "BrokerAZDistribution": "DEFAULT", "ClientSubnets": [ "subnet-cbfff283", "subnet-6746046b" ], "InstanceType": "kafka.m5.large", "SecurityGroups": [ "sg-f839b688" ], "StorageInfo": { "EbsStorageInfo": { "VolumeSize": 100 } } }, "ClusterArn": "arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5", "ClusterName": "demo-cluster-1", "CreationTime": "2020-07-09T02:31:36.223000+00:00", "CurrentBrokerSoftwareInfo": { "KafkaVersion": "2.2.1" }, "CurrentVersion": "K3AEGXETSR30VB", "EncryptionInfo": { "EncryptionAtRest": { "DataVolumeKMSKeyId": "arn:aws:kms:us-east-1:123456789012:key/a7ca56d5-0768-4b64-a670-339a9fbef81c" }, "EncryptionInTransit": { "ClientBroker": "TLS_PLAINTEXT", "InCluster": true } }, "EnhancedMonitoring": "DEFAULT", "OpenMonitoring": { "Prometheus": { "JmxExporter": { "EnabledInBroker": false }, "NodeExporter": { "EnabledInBroker": false } } }, "NumberOfBrokerNodes": 2, "State": "ACTIVE", "Tags": {}, "ZookeeperConnectString": "z-2.demo-cluster-1.xuy0sb.c5.kafka.us-east-1.amazonaws.com:2181,z-1.demo-cluster-1.xuy0sb.c5.kafka.us-east-1.amazonaws.com:2181,z-3.demo-cluster-1.xuy0sb.c5.kafka.us-east-1.amazonaws.com:2181" } } ``` Para obter mais informações, consulte [Listar clusters do Amazon MSK](https://docs.aws.amazon.com/msk/latest/developerguide/msk-list-clusters.html) no *Guia do desenvolvedor do Amazon Managed Streaming for Apache Kafka*. + Consulte detalhes da API em [DescribeCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kafka/describe-cluster.html) na *Referência de comandos da AWS CLI*. ### `get-bootstrap-brokers` O código de exemplo a seguir mostra como usar `get-bootstrap-brokers`. **AWS CLI** **Para obter os agentes de bootstrap** O exemplo `get-bootstrap-brokers` a seguir recupera as informações do agente de bootstrap para um cluster do Amazon MSK. ``` aws kafka get-bootstrap-brokers \ --cluster-arn arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 ``` Resultado: ``` { "BootstrapBrokerString": "b-1.demo-cluster-1.xuy0sb.c5.kafka.us-east-1.amazonaws.com:9092,b-2.demo-cluster-1.xuy0sb.c5.kafka.us-east-1.amazonaws.com:9092", "BootstrapBrokerStringTls": "b-1.demo-cluster-1.xuy0sb.c5.kafka.us-east-1.amazonaws.com:9094,b-2.demo-cluster-1.xuy0sb.c5.kafka.us-east-1.amazonaws.com:9094" } ``` Para obter mais informações, consulte [Obter os agentes de bootstrap](https://docs.aws.amazon.com/msk/latest/developerguide/msk-get-bootstrap-brokers.html) no *Guia do desenvolvedor do Amazon Managed Streaming for Apache Kafka*. + Para ver detalhes da API, consulte [GetBootstrapBrokers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kafka/get-bootstrap-brokers.html) na *Referência de comandos da AWS CLI*. ### `list-clusters` O código de exemplo a seguir mostra como usar `list-clusters`. **AWS CLI** **Para listar os clusters disponíveis** O exemplo `list-clusters` a seguir lista todos clusters Amazon MSK em sua conta da AWS. ``` aws kafka list-clusters ``` Resultado: ``` { "ClusterInfoList": [ { "BrokerNodeGroupInfo": { "BrokerAZDistribution": "DEFAULT", "ClientSubnets": [ "subnet-cbfff283", "subnet-6746046b" ], "InstanceType": "kafka.m5.large", "SecurityGroups": [ "sg-f839b688" ], "StorageInfo": { "EbsStorageInfo": { "VolumeSize": 100 } } }, "ClusterArn": "arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5", "ClusterName": "demo-cluster-1", "CreationTime": "2020-07-09T02:31:36.223000+00:00", "CurrentBrokerSoftwareInfo": { "KafkaVersion": "2.2.1" }, "CurrentVersion": "K3AEGXETSR30VB", "EncryptionInfo": { "EncryptionAtRest": { "DataVolumeKMSKeyId": "arn:aws:kms:us-east-1:123456789012:key/a7ca56d5-0768-4b64-a670-339a9fbef81c" }, "EncryptionInTransit": { "ClientBroker": "TLS_PLAINTEXT", "InCluster": true } }, "EnhancedMonitoring": "DEFAULT", "OpenMonitoring": { "Prometheus": { "JmxExporter": { "EnabledInBroker": false }, "NodeExporter": { "EnabledInBroker": false } } }, "NumberOfBrokerNodes": 2, "State": "ACTIVE", "Tags": {}, "ZookeeperConnectString": "z-2.demo-cluster-1.xuy0sb.c5.kafka.us-east-1.amazonaws.com:2181,z-1.demo-cluster-1.xuy0sb.c5.kafka.us-east-1.amazonaws.com:2181,z-3.demo-cluster-1.xuy0sb.c5.kafka.us-east-1.amazonaws.com:2181" } ] } ``` Para obter mais informações, consulte [Listar clusters do Amazon MSK](https://docs.aws.amazon.com/msk/latest/developerguide/msk-list-clusters.html) no *Guia do desenvolvedor do Amazon Managed Streaming for Apache Kafka*. + Consulte detalhes da API em [ListClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kafka/list-clusters.html) na *Referência de comandos da AWS CLI*. ### `update-broker-storage` O código de exemplo a seguir mostra como usar `update-broker-storage`. **AWS CLI** **Para atualizar o armazenamento do EBS dos agentes** O exemplo `update-broker-storage` a seguir atualiza a quantidade de armazenamento do EBS para todos os agentes no cluster. O Amazon MSK define o valor de armazenamento alvo para cada agente de acordo com o valor especificado no exemplo. A versão atual do cluster pode ser obtida descrevendo o cluster ou listando todos os clusters. ``` aws kafka update-broker-storage \ --cluster-arn "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2" \ --current-version "K21V3IB1VIZYYH" \ --target-broker-ebs-volume-info "KafkaBrokerNodeId=ALL,VolumeSizeGB=1100" ``` A saída retorna um ARN para essa operação `update-broker-storage`. Para determinar se essa operação foi concluída, use o comando `describe-cluster-operation` com esse ARN como entrada. ``` { "ClusterArn": "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2", "ClusterOperationArn": "arn:aws:kafka:us-west-2:123456789012:cluster-operation/V123450123/a1b2c3d4-1234-abcd-cdef-22222EXAMPLE-2/a1b2c3d4-abcd-1234-bcde-33333EXAMPLE" } ``` Para obter mais informações, consulte [Atualizar o armazenamento EBS par agentes](https://docs.aws.amazon.com/msk/latest/developerguide/msk-update-storage.html) no *Guia do desenvolvedor do Amazon Managed Streaming for Apache Kafka*. + Para ver detalhes da API, consulte [UpdateBrokerStorage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kafka/update-broker-storage.html) na *Referência de comandos da AWS CLI*. ### `update-cluster-configuration` O código de exemplo a seguir mostra como usar `update-cluster-configuration`. **AWS CLI** **Para atualizar a configuração de um cluster do Amazon MSK** O exemplo `update-cluster-configuration` a seguir atualiza a configuração do cluster MSK existente especificado. Ele usa uma configuração MSK personalizada. ``` aws kafka update-cluster-configuration \ --cluster-arn "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2" \ --configuration-info file://configuration-info.json \ --current-version "K21V3IB1VIZYYH" ``` Conteúdo de `configuration-info.json`: ``` { "Arn": "arn:aws:kafka:us-west-2:123456789012:configuration/CustomConfiguration/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2", "Revision": 1 } ``` A saída retorna um ARN para essa operação `update-cluster-configuration`. Para determinar se essa operação foi concluída, use o comando `describe-cluster-operation` com esse ARN como entrada. ``` { "ClusterArn": "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2", "ClusterOperationArn": "arn:aws:kafka:us-west-2:123456789012:cluster-operation/V123450123/a1b2c3d4-1234-abcd-cdef-22222EXAMPLE-2/a1b2c3d4-abcd-1234-bcde-33333EXAMPLE" } ``` Para obter mais informações, consulte [Atualizar a configuração de um cluster do Amazon MSK](https://docs.aws.amazon.com/msk/latest/developerguide/msk-update-cluster-cofig.html) no *Guia do desenvolvedor do Amazon Managed Streaming for Apache Kafka*. + Para ver detalhes da API, consulte [UpdateClusterConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kafka/update-cluster-configuration.html) na *Referência de comandos da AWS CLI*. # Exemplos do Network Flow Monitor usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o Network Flow Monitor. *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 ### `create-monitor` O código de exemplo a seguir mostra como usar `create-monitor`. **AWS CLI** **Como criar um monitor** O exemplo de `create-monitor` a seguir cria um monitor chamado `demo` na conta especificada. ``` aws networkflowmonitor create-monitor \ --monitor-name demo \ --local-resources type="AWS::EC2::VPC",identifier="arn:aws:ec2:us-east-1:123456789012:vpc/vpc-03ea55eeda25adbb0" \ --scope-arn arn:aws:networkflowmonitor:us-east-1:123456789012:scope/e21cda79-30a0-4c12-9299-d8629d76d8cf ``` Resultado: ``` { "monitorArn": "arn:aws:networkflowmonitor:us-east-1:123456789012:monitor/demo", "monitorName": "demo", "monitorStatus": "ACTIVE", "tags": {} } ``` Consulte mais informações em [Criar um monitor no Network Flow Monitor](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-monitors-create.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [CreateMonitor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/create-monitor.html) na *Referência de comandos da AWS CLI*. ### `create-scope` O código de exemplo a seguir mostra como usar `create-scope`. **AWS CLI** **Como criar um escopo** O exemplo de `create-scope` a seguir cria um escopo que inclui um conjunto de recursos para os quais o Network Flow Monitor gerará métricas de tráfego de rede. ``` aws networkflowmonitor create-scope \ --targets '[{"targetIdentifier":{"targetId":{"accountId":"123456789012"},"targetType":"ACCOUNT"},"region":"us-east-1"}]' ``` Resultado: ``` { "scopeId": "97626f8d-8a21-4b5d-813a-1a0962dd4615", "status": "IN_PROGRESS", "tags": {} } ``` Consulte mais informações em [Componentes e recursos do Network Flow Monitor](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-components.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [CreateScope](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/create-scope.html) na *Referência de comandos da AWS CLI*. ### `delete-monitor` O código de exemplo a seguir mostra como usar `delete-monitor`. **AWS CLI** **Para excluir um monitor** O exemplo de `delete-monitor` a seguir exclui um monitor chamado `demo` na conta especificada. ``` aws networkflowmonitor delete-monitor \ --monitor-name demo ``` Este comando não produz saída. Consulte mais informações em [Excluir um monitor no Network Flow Monitor](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-monitors-delete.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [DeleteMonitor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/delete-monitor.html) na *Referência de comandos da AWS CLI*. ### `delete-scope` O código de exemplo a seguir mostra como usar `delete-scope`. **AWS CLI** **Como excluir um escopo** O exemplo de `delete-scope` a seguir exclui um escopo especificado. ``` aws networkflowmonitor delete-scope \ --scope-id fdc20616-6bb4-4242-a24e-a748e65ca7ac ``` Este comando não produz saída. Consulte mais informações em [Componentes e recursos do Network Flow Monitor](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-components.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [DeleteScope](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/delete-scope.html) na *Referência de comandos da AWS CLI*. ### `get-monitor` O código de exemplo a seguir mostra como usar `get-monitor`. **AWS CLI** **Como recuperar informações sobre um monitor** O exemplo de `get-monitor` a seguir exibe as informações sobre o painel chamado `demo` na conta especificada. ``` aws networkflowmonitor get-monitor \ --monitor-name Demo ``` Resultado: ``` { "monitorArn": "arn:aws:networkflowmonitor:us-east-1:123456789012:monitor/Demo", "monitorName": "Demo", "monitorStatus": "ACTIVE", "localResources": [ { "type": "AWS::EC2::VPC", "identifier": "arn:aws:ec2:us-east-1:123456789012:vpc/vpc-03ea55eeda25adbb0" } ], "remoteResources": [], "createdAt": "2024-12-09T12:21:51.616000-06:00", "modifiedAt": "2024-12-09T12:21:55.412000-06:00", "tags": {} } ``` Consulte mais informações em [Componentes e recursos do Network Flow Monitor](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-components.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [GetMonitor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/get-monitor.html) na *Referência de comandos da AWS CLI*. ### `get-query-results-workload-insights-top-contributors-data` O código de exemplo a seguir mostra como usar `get-query-results-workload-insights-top-contributors-data`. **AWS CLI** **Como recuperar os dados dos principais colaboradores nos insights de workloads** O exemplo de `get-query-results-workload-insights-top-contributors-data` a seguir retorna os dados da consulta especificada. ``` aws networkflowmonitor get-query-results-workload-insights-top-contributors-data \ --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \ --query-id cc4f4ab3-3103-33b8-80ff-d6597a0c6cea ``` Resultado: ``` { "datapoints": [ { "timestamps": [ "2024-12-09T19:00:00+00:00", "2024-12-09T19:05:00+00:00", "2024-12-09T19:10:00+00:00" ], "values": [ 259943.0, 194856.0, 216432.0 ], "label": "use1-az6" } ], "unit": "Bytes" } ``` Consulte mais informações em [Avaliar fluxos de rede com insights de workloads](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-evaluate-flows.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [GetQueryResultsWorkloadInsightsTopContributorsData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/get-query-results-workload-insights-top-contributors-data.html) na *Referência de comandos da AWS CLI*. ### `get-query-results-workload-insights-top-contributors` O código de exemplo a seguir mostra como usar `get-query-results-workload-insights-top-contributors`. **AWS CLI** **Como recuperar os principais colaboradores nos insights de workloads** O exemplo de `get-query-results-workload-insights-top-contributors` a seguir retorna os dados da consulta especificada. ``` aws networkflowmonitor get-query-results-workload-insights-top-contributors \ --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \ --query-id 1fc423d3-b144-37a6-80e6-e2c7d26eea0c ``` Resultado: ``` { "topContributors": [ { "accountId": "123456789012", "localSubnetId": "subnet-0a5b30fb95dca2c14", "localAz": "use1-az6", "localVpcId": "vpc-03ea55eeda25adbb0", "localRegion": "us-east-1", "remoteIdentifier": "", "value": 908443, "localSubnetArn": "arn:aws:ec2:us-east-1:123456789012:subnet/subnet-0a5b30fb95dca2c14", "localVpcArn": "arn:aws:ec2:us-east-1:123456789012:vpc/vpc-03ea55eeda25adbb0" } ] } ``` Consulte mais informações em [Avaliar fluxos de rede com insights de workloads](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-evaluate-flows.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [GetQueryResultsWorkloadInsightsTopContributors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/get-query-results-workload-insights-top-contributors.html) na *Referência de comandos da AWS CLI*. ### `get-query-status-monitor-top-contributors` O código de exemplo a seguir mostra como usar `get-query-status-monitor-top-contributors`. **AWS CLI** **Como recuperar o status da consulta** O exemplo de `get-query-status-monitor-top-contributors` a seguir exibe o status atual da consulta na conta especificada. ``` aws networkflowmonitor get-query-status-monitor-top-contributors \ --monitor-name Demo \ --query-id 5398eabd-bc40-3f5f-aba3-bcb639d3c7ca ``` Resultado: ``` { "status": "SUCCEEDED" } ``` Consulte mais informações em [Avaliar fluxos de rede com insights de workloads](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-evaluate-flows.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [GetQueryStatusMonitorTopContributors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/get-query-status-monitor-top-contributors.html) na *Referência de comandos da AWS CLI*. ### `get-query-status-workload-insights-top-contributors-data` O código de exemplo a seguir mostra como usar `get-query-status-workload-insights-top-contributors-data`. **AWS CLI** **Como recuperar o status da consulta** O exemplo de `get-query-status-workload-insights-top-contributors-data` a seguir exibe o status atual da consulta na conta especificada. ``` aws networkflowmonitor get-query-status-workload-insights-top-contributors-data \ --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \ --query-id 4333754d-8ae1-3f29-b6b7-c36db2e7f8ac ``` Resultado: ``` { "status": "SUCCEEDED" } ``` Consulte mais informações em [Avaliar fluxos de rede com insights de workloads](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-evaluate-flows.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [GetQueryStatusWorkloadInsightsTopContributorsData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/get-query-status-workload-insights-top-contributors-data.html) na *Referência de comandos da AWS CLI*. ### `get-query-status-workload-insights-top-contributors` O código de exemplo a seguir mostra como usar `get-query-status-workload-insights-top-contributors`. **AWS CLI** **Como recuperar o status da consulta** O exemplo de `get-query-status-workload-insights-top-contributors` a seguir exibe o status atual da consulta na conta especificada. ``` aws networkflowmonitor get-query-status-workload-insights-top-contributors \ --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \ --query-id f2a87c70-3e5a-362e-8beb-4747d13d8419 ``` Resultado: ``` { "status": "SUCCEEDED" } ``` Consulte mais informações em [Avaliar fluxos de rede com insights de workloads](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-evaluate-flows.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [GetQueryStatusWorkloadInsightsTopContributors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/get-query-status-workload-insights-top-contributors.html) na *Referência de comandos da AWS CLI*. ### `get-scope` O código de exemplo a seguir mostra como usar `get-scope`. **AWS CLI** **Como recuperar informações sobre um escopo** O exemplo de `get-scope` a seguir exibe informações sobre um escopo, como status, tags, nome e detalhes do destino. ``` aws networkflowmonitor get-scope \ --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf ``` Resultado: ``` { "scopeId": "e21cda79-30a0-4c12-9299-d8629d76d8cf", "status": "SUCCEEDED", "scopeArn": "arn:aws:networkflowmonitor:us-east-1:123456789012:scope/e21cda79-30a0-4c12-9299-d8629d76d8cf", "targets": [ { "targetIdentifier": { "targetId": { "accountId": "123456789012" }, "targetType": "ACCOUNT" }, "region": "us-east-1" } ], "tags": {} } ``` Consulte mais informações em [Componentes e recursos do Network Flow Monitor](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-components.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [GetScope](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/get-scope.html) na *Referência de comandos da AWS CLI*. ### `list-monitors` O código de exemplo a seguir mostra como usar `list-monitors`. **AWS CLI** **Como recuperar uma lista de monitores** O exemplo de `list-monitors` a seguir retorna todos os monitores na conta especificada. ``` aws networkflowmonitor list-monitors ``` Resultado: ``` { "monitors": [ { "monitorArn": "arn:aws:networkflowmonitor:us-east-1:123456789012:monitor/Demo", "monitorName": "Demo", "monitorStatus": "ACTIVE" } ] } ``` Consulte mais informações em [Componentes e recursos do Network Flow Monitor](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-components.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [ListMonitors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/list-monitors.html) na *Referência de comandos da AWS CLI*. ### `list-scopes` O código de exemplo a seguir mostra como usar `list-scopes`. **AWS CLI** **Como recuperar uma lista de escopos** O exemplo de `list-scopes` a seguir lista todos os escopos na conta especificada. ``` aws networkflowmonitor list-scopes ``` Resultado: ``` { "scopes": [ { "scopeId": "fdc20616-6bb4-4242-a24e-a748e65ca7ac", "status": "SUCCEEDED", "scopeArn": "arn:aws:networkflowmonitor:us-east-1:123456789012:scope/fdc20616-6bb4-4242-a24e-a748e65ca7ac" } ] } ``` Consulte mais informações em [Componentes e recursos do Network Flow Monitor](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-components.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [ListScopes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/list-scopes.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Como listar as tags** O exemplo de `list-tags-for-resource` a seguir retorna as tags associadas ao recurso especificado. ``` aws networkflowmonitor list-tags-for-resource \ --resource-arn arn:aws:networkflowmonitor:us-east-1:123456789012:monitor/Demo ``` Resultado: ``` { "tags": { "Value": "Production", "Key": "stack" } } ``` Consulte mais informações em [Etiquetar recursos do Amazon CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Tagging.html) no *Guia do usuário do Amazon CloudWatch*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `start-query-monitor-top-contributors` O código de exemplo a seguir mostra como usar `start-query-monitor-top-contributors`. **AWS CLI** **Como iniciar uma consulta** O exemplo de `start-query-monitor-top-contributors` a seguir inicia a consulta que retorna um ID de consulta para recuperar os principais colaboradores. ``` aws networkflowmonitor start-query-monitor-top-contributors \ --monitor-name Demo \ --start-time 2024-12-09T19:00:00Z \ --end-time 2024-12-09T19:15:00Z \ --metric-name DATA_TRANSFERRED \ --destination-category UNCLASSIFIED ``` Resultado: ``` { "queryId": "aecd3a88-0283-35b0-a17d-6e944dc8531d" } ``` Consulte mais informações em [Avaliar fluxos de rede com insights de workloads](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-evaluate-flows.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [StartQueryMonitorTopContributors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/start-query-monitor-top-contributors.html) na *AWS CLIReferência de comandos*. ### `start-query-workload-insights-top-contributors-data` O código de exemplo a seguir mostra como usar `start-query-workload-insights-top-contributors-data`. **AWS CLI** **Como iniciar uma consulta** O exemplo de `start-query-workload-insights-top-contributors-data` a seguir inicia a consulta que retorna um ID de consulta para recuperar os principais colaboradores. ``` aws networkflowmonitor start-query-workload-insights-top-contributors-data \ --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \ --start-time 2024-12-09T19:00:00Z \ --end-time 2024-12-09T19:15:00Z \ --metric-name DATA_TRANSFERRED \ --destination-category UNCLASSIFIED ``` Resultado: ``` { "queryId": "cc4f4ab3-3103-33b8-80ff-d6597a0c6cea" } ``` Consulte mais informações em [Avaliar fluxos de rede com insights de workloads](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-evaluate-flows.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [StartQueryWorkloadInsightsTopContributorsData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/start-query-workload-insights-top-contributors-data.html) na *Referência de comandos da AWS CLI*. ### `start-query-workload-insights-top-contributors` O código de exemplo a seguir mostra como usar `start-query-workload-insights-top-contributors`. **AWS CLI** **Como iniciar uma consulta** O exemplo de `start-query-workload-insights-top-contributors` a seguir inicia a consulta que retorna um ID de consulta para recuperar os principais colaboradores. ``` aws networkflowmonitor start-query-workload-insights-top-contributors \ --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \ --start-time 2024-12-09T19:00:00Z \ --end-time 2024-12-09T19:15:00Z \ --metric-name DATA_TRANSFERRED \ --destination-category UNCLASSIFIED ``` Resultado: ``` { "queryId": "1fc423d3-b144-37a6-80e6-e2c7d26eea0c" } ``` Consulte mais informações em [Avaliar fluxos de rede com insights de workloads](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-evaluate-flows.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [StartQueryWorkloadInsightsTopContributors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/start-query-workload-insights-top-contributors.html) em *Referência de comandos da AWS CLI*. ### `stop-query-monitor-top-contributors` O código de exemplo a seguir mostra como usar `stop-query-monitor-top-contributors`. **AWS CLI** **Como interromper uma consulta** O exemplo de `stop-query-monitor-top-contributors` a seguir interrompe a consulta na conta especificada. ``` aws networkflowmonitor stop-query-monitor-top-contributors \ --monitor-name Demo \ --query-id aecd3a88-0283-35b0-a17d-6e944dc8531d ``` Este comando não produz saída. Consulte mais informações em [Avaliar fluxos de rede com insights de workloads](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-evaluate-flows.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [StopQueryMonitorTopContributors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/stop-query-monitor-top-contributors.html) na *Referência de comandos da AWS CLI*. ### `stop-query-workload-insights-top-contributors-data` O código de exemplo a seguir mostra como usar `stop-query-workload-insights-top-contributors-data`. **AWS CLI** **Como interromper uma consulta** O exemplo de `stop-query-workload-insights-top-contributors-data` a seguir interrompe a consulta na conta especificada. ``` aws networkflowmonitor stop-query-workload-insights-top-contributors-data \ --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \ --query-id cc4f4ab3-3103-33b8-80ff-d6597a0c6cea ``` Este comando não produz saída. Consulte mais informações em [Avaliar fluxos de rede com insights de workloads](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-evaluate-flows.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [StopQueryWorkloadInsightsTopContributorsData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/stop-query-workload-insights-top-contributors-data.html) na *Referência de comandos da AWS CLI*. ### `stop-query-workload-insights-top-contributors` O código de exemplo a seguir mostra como usar `stop-query-workload-insights-top-contributors`. **AWS CLI** **Como interromper uma consulta** O exemplo de `stop-query-workload-insights-top-contributors` a seguir interrompe a consulta na conta especificada. ``` aws networkflowmonitor stop-query-workload-insights-top-contributors \ --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \ --query-id 1fc423d3-b144-37a6-80e6-e2c7d26eea0c ``` Este comando não produz saída. Consulte mais informações em [Avaliar fluxos de rede com insights de workloads](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-evaluate-flows.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [StopQueryWorkloadInsightsTopContributors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/stop-query-workload-insights-top-contributors.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Para adicionar uma tag ao recurso especificado** O exemplo de `tag-resource` a seguir adiciona uma tag ao monitor na conta especificada. ``` aws networkflowmonitor tag-resource \ --resource-arn arn:aws:networkflowmonitor:us-east-1:123456789012:monitor/Demo \ --tags Key=stack,Value=Production ``` Este comando não produz saída. Consulte mais informações em [Etiquetar recursos do Amazon CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Tagging.html) no *Guia do usuário do Amazon CloudWatch*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Como remover uma tag do recurso especificado** O exemplo de `untag-resource` a seguir remove uma tag do monitor na conta especificada. ``` aws networkflowmonitor untag-resource \ --resource-arn arn:aws:networkflowmonitor:us-east-1:123456789012:monitor/Demo \ --tag-keys stack ``` Este comando não produz saída. Consulte mais informações em [Etiquetar recursos do Amazon CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Tagging.html) no *Guia do usuário do Amazon CloudWatch*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-monitor` O código de exemplo a seguir mostra como usar `update-monitor`. **AWS CLI** **Como atualizar um monitor existente** O exemplo de `update-monitor` a seguir atualiza o monitor chamado `Demo` na conta especificada. ``` aws networkflowmonitor update-monitor \ --monitor-name Demo \ --local-resources-to-add type="AWS::EC2::VPC",identifier="arn:aws:ec2:us-east-1:123456789012:vpc/vpc-048d08dfbec623f94" ``` Resultado: ``` { "monitorArn": "arn:aws:networkflowmonitor:us-east-1:123456789012:monitor/Demo", "monitorName": "Demo", "monitorStatus": "ACTIVE", "tags": { "Value": "Production", "Key": "stack" } } ``` Consulte mais informações em [Componentes e recursos do Network Flow Monitor](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-components.html) no *Guia do usuário do Amazon CloudWatch*. + Para ver detalhes da API, consulte [UpdateMonitor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/update-monitor.html) na *Referência de comandos da AWS CLI*. # Exemplos do Gerenciador de Rede usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o Gerenciador de Rede. *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 ### `associate-customer-gateway` O código de exemplo a seguir mostra como usar `associate-customer-gateway`. **AWS CLI** **Como associar um gateway do cliente** O exemplo `associate-customer-gateway` a seguir associa o gateway do cliente `cgw-11223344556677889` na rede global especificada com o dispositivo`device-07f6fd08867abc123`. ``` aws networkmanager associate-customer-gateway \ --customer-gateway-arn arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-11223344556677889 \ --global-network-id global-network-01231231231231231 \ --device-id device-07f6fd08867abc123 \ --region us-west-2 ``` Resultado: ``` { "CustomerGatewayAssociation": { "CustomerGatewayArn": "arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-11223344556677889", "GlobalNetworkId": "global-network-01231231231231231", "DeviceId": "device-07f6fd08867abc123", "State": "PENDING" } } ``` Para obter mais informações, consulte [Associações do gateway do cliente](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#cgw-association) no *Guia do Transit Gateway Network Manager*. + Para ver detalhes da API, consulte [AssociateCustomerGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/associate-customer-gateway.html) na *Referência de comandos da AWS CLI*. ### `associate-link` O código de exemplo a seguir mostra como usar `associate-link`. **AWS CLI** **Como associar um link** O exemplo `associate-link` a seguir associa o link `link-11112222aaaabbbb1` ao dispositivo `device-07f6fd08867abc123`. O link e o dispositivo estão na rede global especificada. ``` aws networkmanager associate-link \ --global-network-id global-network-01231231231231231 \ --device-id device-07f6fd08867abc123 \ --link-id link-11112222aaaabbbb1 \ --region us-west-2 ``` Resultado: ``` { "LinkAssociation": { "GlobalNetworkId": "global-network-01231231231231231", "DeviceId": "device-07f6fd08867abc123", "LinkId": "link-11112222aaaabbbb1", "LinkAssociationState": "PENDING" } } ``` Para obter mais informações, consulte [Associações de dispositivos e links](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#device-link-association) no *Guia do Transit Gateway Network Manager*. + Para ver detalhes da API, consulte [AssociateLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/associate-link.html) na *Referência de comandos da AWS CLI*. ### `create-core-network` O código de exemplo a seguir mostra como usar `create-core-network`. **AWS CLI** **Para criar uma rede principal** O exemplo `create-core-network` a seguir cria uma rede principal usando uma descrição e tags opcionais em uma rede global AWS Cloud WAN. ``` aws networkmanager create-core-network \ --global-network-id global-network-cdef-EXAMPLE22222 \ --description "Main headquarters location" \ --tags Key=Name,Value="New York City office" ``` Resultado: ``` { "CoreNetwork": { "GlobalNetworkId": "global-network-cdef-EXAMPLE22222", "CoreNetworkId": "core-network-cdef-EXAMPLE33333", "CoreNetworkArn": "arn:aws:networkmanager::987654321012:core-network/core-network-cdef-EXAMPLE33333", "Description": "Main headquarters location", "CreatedAt": "2022-01-10T19:53:59+00:00", "State": "AVAILABLE", "Tags": [ { "Key": "Name", "Value": "New York City office" } ] } } ``` Para obter mais informações, consulte [Redes globais e principais](https://docs.aws.amazon.com/network-manager/latest/cloudwan/cloudwan-core-network-policy.html) no *Guia do usuário do AWS Cloud WAN*. + Para ver detalhes da API, consulte [CreateCoreNetwork](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/create-core-network.html) na *Referência de comandos da AWS CLI*. ### `create-device` O código de exemplo a seguir mostra como usar `create-device`. **AWS CLI** **Para criar um dispositivo** O exemplo `create-device` a seguir cria um dispositivo na rede global especificada. Os detalhes do dispositivo incluem uma descrição, o tipo, o fornecedor, o modelo e o número de série. ``` aws networkmanager create-device --global-network-id global-network-01231231231231231 \ --description "New York office device" \ --type "office device" \ --vendor "anycompany" \ --model "abcabc" \ --serial-number "1234" \ --region us-west-2 ``` Resultado: ``` { "Device": { "DeviceId": "device-07f6fd08867abc123", "DeviceArn": "arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123", "GlobalNetworkId": "global-network-01231231231231231", "Description": "New York office device", "Type": "office device", "Vendor": "anycompany", "Model": "abcabc", "SerialNumber": "1234", "CreatedAt": 1575554005.0, "State": "PENDING" } } ``` Para obter mais informações, consulte [Trabalhar com dispositivos](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#working-with-devices) no *Guia do Transit Gateway Network Manager*. + Para ver detalhes da API, consulte [CreateDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/create-device.html) na *Referência de comandos da AWS CLI*. ### `create-global-network` O código de exemplo a seguir mostra como usar `create-global-network`. **AWS CLI** **Para criar uma rede global** O exemplo `create-global-network` a seguir cria uma rede global. O estado inicial após a criação é `PENDING`. ``` aws networkmanager create-global-network ``` Resultado: ``` { "GlobalNetwork": { "GlobalNetworkId": "global-network-00a77fc0f722dae74", "GlobalNetworkArn": "arn:aws:networkmanager::987654321012:global-network/global-network-00a77fc0f722dae74", "CreatedAt": "2022-03-14T20:31:56+00:00", "State": "PENDING" } } ``` + Para ver detalhes da API, consulte [CreateGlobalNetwork](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/create-global-network.html) na *Referência de comandos da AWS CLI*. ### `create-link` O código de exemplo a seguir mostra como usar `create-link`. **AWS CLI** **Para criar um link** O exemplo `create-link` a seguir cria um link na rede global especificada. O link inclui uma descrição e detalhes sobre o tipo de link, a largura de banda e o provedor. O ID do site indica o site ao qual o link está associado. ``` aws networkmanager create-link \ --global-network-id global-network-01231231231231231 \ --description "VPN Link" \ --type "broadband" \ --bandwidth UploadSpeed=10,DownloadSpeed=20 \ --provider "AnyCompany" \ --site-id site-444555aaabbb11223 \ --region us-west-2 ``` Resultado: ``` { "Link": { "LinkId": "link-11112222aaaabbbb1", "LinkArn": "arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1", "GlobalNetworkId": "global-network-01231231231231231", "SiteId": "site-444555aaabbb11223", "Description": "VPN Link", "Type": "broadband", "Bandwidth": { "UploadSpeed": 10, "DownloadSpeed": 20 }, "Provider": "AnyCompany", "CreatedAt": 1575555811.0, "State": "PENDING" } } ``` Para obter mais informações, consulte [Trabalhar com links](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#working-with-links) no *Guia do Transit Gateway Network Manager*. + Para ver detalhes da API, consulte [CreateLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/create-link.html) na *Referência de comandos da AWS CLI*. ### `create-site` O código de exemplo a seguir mostra como usar `create-site`. **AWS CLI** **Para criar um site** O exemplo `create-site` a seguir cria um site na rede global especificada. Os detalhes do site incluem uma descrição e as informações de localização. ``` aws networkmanager create-site \ --global-network-id global-network-01231231231231231 \ --description "New York head office" \ --location Latitude=40.7128,Longitude=-74.0060 \ --region us-west-2 ``` Resultado: ``` { "Site": { "SiteId": "site-444555aaabbb11223", "SiteArn": "arn:aws:networkmanager::123456789012:site/global-network-01231231231231231/site-444555aaabbb11223", "GlobalNetworkId": "global-network-01231231231231231", "Description": "New York head office", "Location": { "Latitude": "40.7128", "Longitude": "-74.0060" }, "CreatedAt": 1575554300.0, "State": "PENDING" } } ``` Para obter mais informações, consulte [Trabalhar com sites](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#working-with-sites) no *Guia do Transit Gateway Network Manager*. + Para ver detalhes da API, consulte [CreateSite](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/create-site.html) na *Referência de comandos da AWS CLI*. ### `create-vpc-attachment` O código de exemplo a seguir mostra como usar `create-vpc-attachment`. **AWS CLI** **Para criar um anexo VPC** O exemplo `create-vpc-attachment` a seguir cria um anexo VPC compatível com IPv6 em uma rede principal. ``` aws networkmanager create-vpc-attachment \ --core-network-id core-network-0fab62fe438d94db6 \ --vpc-arn arn:aws:ec2:us-east-1:987654321012:vpc/vpc-09f37f69e2786eeb8 \ --subnet-arns arn:aws:ec2:us-east-1:987654321012:subnet/subnet-04ca4e010857e7bb7 \ --Ipv6Support=true ``` Resultado: ``` { "VpcAttachment": { "Attachment": { "CoreNetworkId": "core-network-0fab62fe438d94db6", "AttachmentId": "attachment-05e1da6eba87a06e6", "OwnerAccountId": "987654321012", "AttachmentType": "VPC", "State": "CREATING", "EdgeLocation": "us-east-1", "ResourceArn": "arn:aws:ec2:us-east-1:987654321012:vpc/vpc-09f37f69e2786eeb8", "Tags": [], "CreatedAt": "2022-03-10T20:59:14+00:00", "UpdatedAt": "2022-03-10T20:59:14+00:00" }, "SubnetArns": [ "arn:aws:ec2:us-east-1:987654321012:subnet/subnet-04ca4e010857e7bb7" ], "Options": { "Ipv6Support": true } } } ``` Para obter mais informações, consulte [Criar um anexo](https://docs.aws.amazon.com/vpc/latest/cloudwan/cloudwan-create-attachment.html) no *Guia do usuário do Cloud WAN*. + Para ver detalhes da API, consulte [CreateVpcAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/create-vpc-attachment.html) na *Referência de comandos da AWS CLI*. ### `delete-attachment` O código de exemplo a seguir mostra como usar `delete-attachment`. **AWS CLI** **Para excluir um anexo** O exemplo `delete-attachment` a seguir exclui um anexo do Connect. ``` aws networkmanager delete-attachment \ --attachment-id attachment-01feddaeae26ab68c ``` Resultado: ``` { "Attachment": { "CoreNetworkId": "core-network-0f4b0a9d5ee7761d1", "AttachmentId": "attachment-01feddaeae26ab68c", "OwnerAccountId": "987654321012", "AttachmentType": "CONNECT", "State": "DELETING", "EdgeLocation": "us-east-1", "ResourceArn": "arn:aws:networkmanager::987654321012:attachment/attachment-02c3964448fedf5aa", "CreatedAt": "2022-03-15T19:18:41+00:00", "UpdatedAt": "2022-03-15T19:28:59+00:00" } } ``` Para obter mais informações, consulte [Excluir anexos](https://docs.aws.amazon.com/vpc/latest/cloudwan/cloudwan-attachments-working-with.html#cloudwan-attachments-deleting) no *Guia do usuário do Cloud WAN*. + Para ver detalhes da API, consulte [DeleteAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/delete-attachment.html) na *Referência de comandos da AWS CLI*. ### `delete-bucket-analytics-configuration` O código de exemplo a seguir mostra como usar `delete-bucket-analytics-configuration`. **AWS CLI** **Para excluir uma configuração de análise de um bucket** O exemplo `delete-bucket-analytics-configuration` a seguir recupera a configuração referente ao bucket e ID especificados. ``` aws s3api delete-bucket-analytics-configuration \ --bucket amzn-s3-demo-bucket \ --id 1 ``` Este comando não produz saída. + Consulte detalhes da API em [DeleteBucketAnalyticsConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/delete-bucket-analytics-configuration.html) na *Referência de comandos da AWS CLI*. ### `delete-bucket-metrics-configuration` O código de exemplo a seguir mostra como usar `delete-bucket-metrics-configuration`. **AWS CLI** **Para excluir uma configuração de métricas referente a um bucket** O exemplo `delete-bucket-metrics-configuration` a seguir remove a configuração referente ao bucket e ID especificados. ``` aws s3api delete-bucket-metrics-configuration \ --bucket amzn-s3-demo-bucket \ --id 123 ``` Este comando não produz saída. + Consulte detalhes da API em [DeleteBucketMetricsConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/delete-bucket-metrics-configuration.html) na *Referência de comandos da AWS CLI*. ### `delete-core-network` O código de exemplo a seguir mostra como usar `delete-core-network`. **AWS CLI** **Para excluir uma rede principal** O exemplo `delete-core-network` a seguir exclui uma rede principal de uma rede global Cloud WAN. ``` aws networkmanager delete-core-network \ --core-network-id core-network-0fab62fe438d94db6 ``` Resultado: ``` { "CoreNetwork": { "GlobalNetworkId": "global-network-0d59060f16a73bc41", "CoreNetworkId": "core-network-0fab62fe438d94db6", "Description": "Main headquarters location", "CreatedAt": "2021-12-09T18:31:11+00:00", "State": "DELETING", "Segments": [ { "Name": "dev", "EdgeLocations": [ "us-east-1" ], "SharedSegments": [] } ], "Edges": [ { "EdgeLocation": "us-east-1", "Asn": 64512, "InsideCidrBlocks": [] } ] } } ``` Para obter mais informações, consulte [Redes principais](https://docs.aws.amazon.com/vpc/latest/cloudwan/cloudwan-networks-working-with.html#cloudwan-core-networks) no *Guia do usuário do Cloud WAN*. + Para ver detalhes da API, consulte [DeleteCoreNetwork](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/delete-core-network.html) na *Referência de comandos da AWS CLI*. ### `delete-device` O código de exemplo a seguir mostra como usar `delete-device`. **AWS CLI** **Para excluir um dispositivo** O exemplo `delete-device` a seguir exclui o dispositivo especificado da rede global especificada. ``` aws networkmanager delete-device \ --global-network-id global-network-01231231231231231 \ --device-id device-07f6fd08867abc123 \ --region us-west-2 ``` Resultado: ``` { "Device": { "DeviceId": "device-07f6fd08867abc123", "DeviceArn": "arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123", "GlobalNetworkId": "global-network-01231231231231231", "Description": "New York office device", "Type": "office device", "Vendor": "anycompany", "Model": "abcabc", "SerialNumber": "1234", "SiteId": "site-444555aaabbb11223", "CreatedAt": 1575554005.0, "State": "DELETING" } } ``` Para obter mais informações, consulte [Trabalhar com dispositivos](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#working-with-devices) no *Guia do Transit Gateway Network Manager*. + Para ver detalhes da API, consulte [DeleteDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/delete-device.html) na *Referência de comandos da AWS CLI*. ### `delete-global-network` O código de exemplo a seguir mostra como usar `delete-global-network`. **AWS CLI** **Para excluir uma rede global** O exemplo `delete-global-network` a seguir exclui uma rede global. ``` aws networkmanager delete-global-network \ --global-network-id global-network-052bedddccb193b6b ``` Resultado: ``` { "GlobalNetwork": { "GlobalNetworkId": "global-network-052bedddccb193b6b", "GlobalNetworkArn": "arn:aws:networkmanager::987654321012:global-network/global-network-052bedddccb193b6b", "CreatedAt": "2021-12-09T18:19:12+00:00", "State": "DELETING" } } ``` + Para ver detalhes da API, consulte [DeleteGlobalNetwork](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/delete-global-network.html) na *Referência de comandos da AWS CLI*. ### `delete-link` O código de exemplo a seguir mostra como usar `delete-link`. **AWS CLI** **Para excluir um link** O exemplo `delete-link` a seguir exclui o link especificado da rede global especificada. ``` aws networkmanager delete-link \ --global-network-id global-network-01231231231231231 \ --link-id link-11112222aaaabbbb1 \ --region us-west-2 ``` Resultado: ``` { "Link": { "LinkId": "link-11112222aaaabbbb1", "LinkArn": "arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1", "GlobalNetworkId": "global-network-01231231231231231", "SiteId": "site-444555aaabbb11223", "Description": "VPN Link", "Type": "broadband", "Bandwidth": { "UploadSpeed": 20, "DownloadSpeed": 20 }, "Provider": "AnyCompany", "CreatedAt": 1575555811.0, "State": "DELETING" } } ``` Para obter mais informações, consulte [Trabalhar com links](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#working-with-links) no *Guia do Transit Gateway Network Manager*. + Para ver detalhes da API, consulte [DeleteLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/delete-link.html) na *Referência de comandos da AWS CLI*. ### `delete-public-access-block` O código de exemplo a seguir mostra como usar `delete-public-access-block`. **AWS CLI** **Para excluir a configuração do Bloqueio de Acesso Público para um bucket** O exemplo `delete-public-access-block` a seguir remove a configuração do Bloqueio de Acesso Público no bucket especificado. ``` aws s3api delete-public-access-block \ --bucket amzn-s3-demo-bucket ``` Este comando não produz saída. + Consulte detalhes da API em [DeletePublicAccessBlock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/delete-public-access-block.html) na *Referência de comandos da AWS CLI*. ### `delete-site` O código de exemplo a seguir mostra como usar `delete-site`. **AWS CLI** **Para excluir um site** O exemplo `delete-site` a seguir exclui o site especificado (`site-444555aaabbb11223`) da rede global especificada. ``` aws networkmanager delete-site \ --global-network-id global-network-01231231231231231 \ --site-id site-444555aaabbb11223 \ --region us-west-2 ``` Resultado: ``` { "Site": { "SiteId": "site-444555aaabbb11223", "SiteArn": "arn:aws:networkmanager::123456789012:site/global-network-01231231231231231/site-444555aaabbb11223", "GlobalNetworkId": "global-network-01231231231231231", "Description": "New York head office", "Location": { "Latitude": "40.7128", "Longitude": "-74.0060" }, "CreatedAt": 1575554300.0, "State": "DELETING" } } ``` Para obter mais informações, consulte [Trabalhar com sites](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#working-with-sites) no *Guia do Transit Gateway Network Manager*. + Para ver detalhes da API, consulte [DeleteSite](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/delete-site.html) na *Referência de comandos da AWS CLI*. ### `deregister-transit-gateway` O código de exemplo a seguir mostra como usar `deregister-transit-gateway`. **AWS CLI** **Como cancelar o registro de um gateway de trânsito de uma rede global** O exemplo `deregister-transit-gateway` a seguir cancela o registro do gateway de trânsito especificado da rede global especificada. ``` aws networkmanager deregister-transit-gateway \ --global-network-id global-network-01231231231231231 \ --transit-gateway-arn arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc \ --region us-west-2 ``` Resultado: ``` { "TransitGatewayRegistration": { "GlobalNetworkId": "global-network-01231231231231231", "TransitGatewayArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc", "State": { "Code": "DELETING" } } } ``` Para obter mais informações, consulte [Registro de gateways de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-registrations.html) no *Guia do Transit Gateway Network Manager*. + Para ver detalhes da API, consulte [DeregisterTransitGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/deregister-transit-gateway.html) na *Referência de comandos da AWS CLI*. ### `describe-global-networks` O código de exemplo a seguir mostra como usar `describe-global-networks`. **AWS CLI** **Para descrever suas redes globais** O exemplo `describe-global-networks` a seguir descreve todas as suas redes globais em sua conta. ``` aws networkmanager describe-global-networks \ --region us-west-2 ``` Resultado: ``` { "GlobalNetworks": [ { "GlobalNetworkId": "global-network-01231231231231231", "GlobalNetworkArn": "arn:aws:networkmanager::123456789012:global-network/global-network-01231231231231231", "Description": "Company 1 global network", "CreatedAt": 1575553525.0, "State": "AVAILABLE" } ] } ``` + Para ver detalhes da API, consulte [DescribeGlobalNetworks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/describe-global-networks.html) na *Referência de comandos da AWS CLI*. ### `disassociate-customer-gateway` O código de exemplo a seguir mostra como usar `disassociate-customer-gateway`. **AWS CLI** **Como desassociar um gateway do cliente** O exemplo `disassociate-customer-gateway` a seguir desassocia o gateway do cliente especificado (`cgw-11223344556677889`) da rede global especificada. ``` aws networkmanager disassociate-customer-gateway \ --global-network-id global-network-01231231231231231 \ --customer-gateway-arn arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-11223344556677889 \ --region us-west-2 ``` Resultado: ``` { "CustomerGatewayAssociation": { "CustomerGatewayArn": "arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-11223344556677889", "GlobalNetworkId": "global-network-01231231231231231", "DeviceId": "device-07f6fd08867abc123", "State": "DELETING" } } ``` Para obter mais informações, consulte [Associações do gateway do cliente](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#cgw-association) no *Guia do Transit Gateway Network Manager*. + Para ver detalhes da API, consulte [DisassociateCustomerGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/disassociate-customer-gateway.html) na *Referência de comandos da AWS CLI*. ### `disassociate-link` O código de exemplo a seguir mostra como usar `disassociate-link`. **AWS CLI** **Como desassociar um link** O exemplo `disassociate-link` a seguir desassocia o link especificado do dispositivo `device-07f6fd08867abc123` na rede global especificada. ``` aws networkmanager disassociate-link \ --global-network-id global-network-01231231231231231 \ --device-id device-07f6fd08867abc123 \ --link-id link-11112222aaaabbbb1 \ --region us-west-2 ``` Resultado: ``` { "LinkAssociation": { "GlobalNetworkId": "global-network-01231231231231231", "DeviceId": "device-07f6fd08867abc123", "LinkId": "link-11112222aaaabbbb1", "LinkAssociationState": "DELETING" } } ``` Para obter mais informações, consulte [Associações de dispositivos e links](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#device-link-association) no *Guia do Transit Gateway Network Manager*. + Para ver detalhes da API, consulte [DisassociateLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/disassociate-link.html) na *Referência de comandos da AWS CLI*. ### `get-bucket-analytics-configuration` O código de exemplo a seguir mostra como usar `get-bucket-analytics-configuration`. **AWS CLI** **Para recuperar a configuração de análise de um bucket com um ID específico** O exemplo `get-bucket-analytics-configuration` a seguir recupera a configuração de análise referente ao bucket e ID especificados. ``` aws s3api get-bucket-analytics-configuration \ --bucket amzn-s3-demo-bucket \ --id 1 ``` Resultado: ``` { "AnalyticsConfiguration": { "StorageClassAnalysis": {}, "Id": "1" } } ``` + Consulte detalhes da API em [GetBucketAnalyticsConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/get-bucket-analytics-configuration.html) na *Referência de comandos da AWS CLI*. ### `get-bucket-metrics-configuration` O código de exemplo a seguir mostra como usar `get-bucket-metrics-configuration`. **AWS CLI** **Para recuperar a configuração de métricas de um bucket com um ID específico** O exemplo `get-bucket-metrics-configuration` a seguir exibe a configuração de métricas referente ao bucket e ID especificados. ``` aws s3api get-bucket-metrics-configuration \ --bucket amzn-s3-demo-bucket \ --id 123 ``` Resultado: ``` { "MetricsConfiguration": { "Filter": { "Prefix": "logs" }, "Id": "123" } } ``` + Consulte detalhes da API em [GetBucketMetricsConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/get-bucket-metrics-configuration.html) na *Referência de comandos da AWS CLI*. ### `get-customer-gateway-associations` O código de exemplo a seguir mostra como usar `get-customer-gateway-associations`. **AWS CLI** **Para obter suas associações de gateway do cliente** O exemplo `get-customer-gateway-associations` a seguir obtém as associações de gateway do cliente da rede global especificada. ``` aws networkmanager get-customer-gateway-associations \ --global-network-id global-network-01231231231231231 \ --region us-west-2 ``` Resultado: ``` { "CustomerGatewayAssociations": [ { "CustomerGatewayArn": "arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-11223344556677889", "GlobalNetworkId": "global-network-01231231231231231", "DeviceId": "device-07f6fd08867abc123", "State": "AVAILABLE" } ] } ``` + Para ver detalhes da API, consulte [GetCustomerGatewayAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/get-customer-gateway-associations.html) na *Referência de comandos da AWS CLI*. ### `get-devices` O código de exemplo a seguir mostra como usar `get-devices`. **AWS CLI** **Como configurar o dispositivo** O exemplo `get-devices` a seguir obtém os dispositivos na rede global especificada. ``` aws networkmanager get-devices \ --global-network-id global-network-01231231231231231 \ --region us-west-2 ``` Resultado: ``` { "Devices": [ { "DeviceId": "device-07f6fd08867abc123", "DeviceArn": "arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123", "GlobalNetworkId": "global-network-01231231231231231", "Description": "NY office device", "Type": "office device", "Vendor": "anycompany", "Model": "abcabc", "SerialNumber": "1234", "CreatedAt": 1575554005.0, "State": "AVAILABLE" } ] } ``` + Para ver detalhes da API, consulte [GetDevices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/get-devices.html) na *Referência de comandos da AWS CLI*. ### `get-link-associations` O código de exemplo a seguir mostra como usar `get-link-associations`. **AWS CLI** **Para obter suas associações de links** O exemplo `get-link-associations` a seguir obtém as associações de links na rede global especificada. ``` aws networkmanager get-link-associations \ --global-network-id global-network-01231231231231231 \ --region us-west-2 ``` Resultado: ``` { "LinkAssociations": [ { "GlobalNetworkId": "global-network-01231231231231231", "DeviceId": "device-07f6fd08867abc123", "LinkId": "link-11112222aaaabbbb1", "LinkAssociationState": "AVAILABLE" } ] } ``` + Para ver detalhes da API, consulte [GetLinkAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/get-link-associations.html) na *Referência de comandos da AWS CLI*. ### `get-links` O código de exemplo a seguir mostra como usar `get-links`. **AWS CLI** **Para obter seus links** O exemplo `get-links` a seguir obtém os links na rede global especificada. ``` aws networkmanager get-links \ --global-network-id global-network-01231231231231231 \ --region us-west-2 ``` Resultado: ``` { "Links": [ { "LinkId": "link-11112222aaaabbbb1", "LinkArn": "arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1", "GlobalNetworkId": "global-network-01231231231231231", "SiteId": "site-444555aaabbb11223", "Description": "VPN Link", "Type": "broadband", "Bandwidth": { "UploadSpeed": 10, "DownloadSpeed": 20 }, "Provider": "AnyCompany", "CreatedAt": 1575555811.0, "State": "AVAILABLE" } ] } ``` + Para ver detalhes da API, consulte [GetLinks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/get-links.html) na *Referência de comandos da AWS CLI*. ### `get-object-retention` O código de exemplo a seguir mostra como usar `get-object-retention`. **AWS CLI** **Para recuperar a configuração de retenção de objetos de um objeto** O exemplo de `get-object-retention` a seguir recupera a configuração de retenção de objetos do objeto especificado. ``` aws s3api get-object-retention \ --bucket amzn-s3-demo-bucket-with-object-lock \ --key doc1.rtf ``` Resultado: ``` { "Retention": { "Mode": "GOVERNANCE", "RetainUntilDate": "2025-01-01T00:00:00.000Z" } } ``` + Consulte detalhes da API em [GetObjectRetention](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/get-object-retention.html) na *Referência de comandos da AWS CLI*. ### `get-public-access-block` O código de exemplo a seguir mostra como usar `get-public-access-block`. **AWS CLI** **Para definir ou modificar a configuração do Bloqueio de Acesso Público de um bucket** O exemplo `get-public-access-block` a seguir exibe a configuração do Bloqueio de Acesso Público do bucket especificado. ``` aws s3api get-public-access-block --bucket amzn-s3-demo-bucket ``` Resultado: ``` { "PublicAccessBlockConfiguration": { "IgnorePublicAcls": true, "BlockPublicPolicy": true, "BlockPublicAcls": true, "RestrictPublicBuckets": true } } ``` + Consulte detalhes da API em [GetPublicAccessBlock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/get-public-access-block.html) na *Referência de comandos da AWS CLI*. ### `get-sites` O código de exemplo a seguir mostra como usar `get-sites`. **AWS CLI** **Para obter seus sites** O exemplo `get-sites` a seguir obtém os sites na rede global especificada. ``` aws networkmanager get-sites \ --global-network-id global-network-01231231231231231 \ --region us-west-2 ``` Resultado: ``` { "Sites": [ { "SiteId": "site-444555aaabbb11223", "SiteArn": "arn:aws:networkmanager::123456789012:site/global-network-01231231231231231/site-444555aaabbb11223", "GlobalNetworkId": "global-network-01231231231231231", "Description": "NY head office", "Location": { "Latitude": "40.7128", "Longitude": "-74.0060" }, "CreatedAt": 1575554528.0, "State": "AVAILABLE" } ] } ``` + Para ver detalhes da API, consulte [GetSites](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/get-sites.html) na *Referência de comandos da AWS CLI*. ### `get-transit-gateway-registrations` O código de exemplo a seguir mostra como usar `get-transit-gateway-registrations`. **AWS CLI** **Para obter seus registros de gateways de trânsito** O exemplo `get-transit-gateway-registrations` a seguir obtém os gateways de trânsito registrados na rede global especificada. ``` aws networkmanager get-transit-gateway-registrations \ --global-network-id global-network-01231231231231231 \ --region us-west-2 ``` Resultado: ``` { "TransitGatewayRegistrations": [ { "GlobalNetworkId": "global-network-01231231231231231", "TransitGatewayArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc", "State": { "Code": "AVAILABLE" } } ] } ``` + Para ver detalhes da API, consulte [GetTransitGatewayRegistrations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/get-transit-gateway-registrations.html) na *Referência de comandos da AWS CLI*. ### `get-vpc-attachment` O código de exemplo a seguir mostra como usar `get-vpc-attachment`. **AWS CLI** **Como obter um anexo de VPC** O exemplo `get-vpc-attachment` a seguir recupera informações sobre um anexo de VPC. ``` aws networkmanager get-vpc-attachment \ --attachment-id attachment-03b7ea450134787da ``` Resultado: ``` { "VpcAttachment": { "Attachment": { "CoreNetworkId": "core-network-0522de1b226a5d7b3", "AttachmentId": "attachment-03b7ea450134787da", "OwnerAccountId": "987654321012", "AttachmentType": "VPC", "State": "CREATING", "EdgeLocation": "us-east-1", "ResourceArn": "arn:aws:ec2:us-east-1:987654321012:vpc/vpc-a7c4bbda", "Tags": [ { "Key": "Name", "Value": "DevVPC" } ], "CreatedAt": "2022-03-11T17:48:58+00:00", "UpdatedAt": "2022-03-11T17:48:58+00:00" }, "SubnetArns": [ "arn:aws:ec2:us-east-1:987654321012:subnet/subnet-202cde6c", "arn:aws:ec2:us-east-1:987654321012:subnet/subnet-e5022dba", "arn:aws:ec2:us-east-1:987654321012:subnet/subnet-2387ae02", "arn:aws:ec2:us-east-1:987654321012:subnet/subnet-cda9dffc" ], "Options": { "Ipv6Support": false } } } ``` Para obter mais informações, consulte [Anexos](https://docs.aws.amazon.com/vpc/latest/cloudwan/cloudwan-attachments-working-with.html) no *Guia do usuário do Cloud WAN*. + Para ver detalhes da API, consulte [GetVpcAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/get-vpc-attachment.html) na *Referência de comandos da AWS CLI*. ### `list-bucket-analytics-configurations` O código de exemplo a seguir mostra como usar `list-bucket-analytics-configurations`. **AWS CLI** **Para recuperar uma lista de configurações de análise de um bucket** O exemplo `list-bucket-analytics-configurations` a seguir recupera uma lista de configurações de análise do bucket especificado. ``` aws s3api list-bucket-analytics-configurations \ --bucket amzn-s3-demo-bucket ``` Resultado: ``` { "AnalyticsConfigurationList": [ { "StorageClassAnalysis": {}, "Id": "1" } ], "IsTruncated": false } ``` + Consulte detalhes da API em [ListBucketAnalyticsConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/list-bucket-analytics-configurations.html) na *Referência de comandos da AWS CLI*. ### `list-bucket-metrics-configurations` O código de exemplo a seguir mostra como usar `list-bucket-metrics-configurations`. **AWS CLI** **Para recuperar uma lista de configurações de métrica de um bucket** O exemplo `list-bucket-metrics-configurations` a seguir recupera uma lista de configurações de métricas do bucket especificado. ``` aws s3api list-bucket-metrics-configurations \ --bucket amzn-s3-demo-bucket ``` Resultado: ``` { "IsTruncated": false, "MetricsConfigurationList": [ { "Filter": { "Prefix": "logs" }, "Id": "123" }, { "Filter": { "Prefix": "tmp" }, "Id": "234" } ] } ``` + Para ver detalhes da API, consulte [ListBucketMetricsConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/list-bucket-metrics-configurations.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para listar as tags de um recurso** O exemplo `list-tags-for-resource` a seguir lista as tags para o recurso de dispositivo especificado (`device-07f6fd08867abc123`). ``` aws networkmanager list-tags-for-resource \ --resource-arn arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123 \ --region us-west-2 ``` Resultado: ``` { "TagList": [ { "Key": "Network", "Value": "Northeast" } ] } ``` + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `put-bucket-metrics-configuration` O código de exemplo a seguir mostra como usar `put-bucket-metrics-configuration`. **AWS CLI** **Como definir uma configuração de métricas para um bucket** O exemplo `put-bucket-metrics-configuration` a seguir define a configuração de métricas com ID 123 para o bucket especificado. ``` aws s3api put-bucket-metrics-configuration \ --bucket amzn-s3-demo-bucket \ --id 123 \ --metrics-configuration '{"Id": "123", "Filter": {"Prefix": "logs"}}' ``` Este comando não produz saída. + Para ver detalhes da API, consulte [PutBucketMetricsConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/put-bucket-metrics-configuration.html) na *Referência de comandos da AWS CLI*. ### `put-object-retention` O código de exemplo a seguir mostra como usar `put-object-retention`. **AWS CLI** **Como definir uma configuração de retenção de objetos para um objeto** O exemplo de `put-object-retention` a seguir define uma configuração de retenção de objetos para o objeto especificado até 2025-01-01. ``` aws s3api put-object-retention \ --bucket amzn-s3-demo-bucket-with-object-lock \ --key doc1.rtf \ --retention '{ "Mode": "GOVERNANCE", "RetainUntilDate": "2025-01-01T00:00:00" }' ``` Este comando não produz saída. + Consulte detalhes da API em [PutObjectRetention](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/put-object-retention.html) na *Referência de comandos da AWS CLI*. ### `put-public-access-block` O código de exemplo a seguir mostra como usar `put-public-access-block`. **AWS CLI** **Como definir a configuração do bloqueio de acesso público de um bucket** O exemplo `put-public-access-block` a seguir define uma configuração restritiva de bloqueio de acesso público para o bucket especificado. ``` aws s3api put-public-access-block \ --bucket amzn-s3-demo-bucket \ --public-access-block-configuration "BlockPublicAcls=true,IgnorePublicAcls=true,BlockPublicPolicy=true,RestrictPublicBuckets=true" ``` Este comando não produz saída. + Para ver detalhes da API, consulte [PutPublicAccessBlock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/put-public-access-block.html) na *Referência de comandos da AWS CLI*. ### `register-transit-gateway` O código de exemplo a seguir mostra como usar `register-transit-gateway`. **AWS CLI** **Para registrar um gateway de trânsito em uma rede global** O exemplo `register-transit-gateway` a seguir registra um gateway de trânsito `tgw-123abc05e04123abc` na rede global especificada. ``` aws networkmanager register-transit-gateway \ --global-network-id global-network-01231231231231231 \ --transit-gateway-arn arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc \ --region us-west-2 ``` Resultado: ``` { "TransitGatewayRegistration": { "GlobalNetworkId": "global-network-01231231231231231", "TransitGatewayArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc", "State": { "Code": "PENDING" } } } ``` Para obter mais informações, consulte [Registro de gateways de trânsito](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-registrations.html) no *Guia do Transit Gateway Network Manager*. + Para ver detalhes da API, consulte [RegisterTransitGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/register-transit-gateway.html) na *Referência de comandos da AWS CLI*. ### `reject-attachment` O código de exemplo a seguir mostra como usar `reject-attachment`. **AWS CLI** **Como rejeitar um anexo** O exemplo `reject-attachment` a seguir rejeita uma solicitação de anexo de VPC. ``` aws networkmanager reject-attachment \ --attachment-id attachment-03b7ea450134787da ``` Resultado: ``` { "Attachment": { "CoreNetworkId": "core-network-0522de1b226a5d7b3", "AttachmentId": "attachment-03b7ea450134787da", "OwnerAccountId": "987654321012", "AttachmentType": "VPC", "State": "AVAILABLE", "EdgeLocation": "us-east-1", "ResourceArn": "arn:aws:ec2:us-east-1:987654321012:vpc/vpc-a7c4bbda", "CreatedAt": "2022-03-11T17:48:58+00:00", "UpdatedAt": "2022-03-11T17:51:25+00:00" } } ``` Para obter mais informações, consulte [Aceitação de anexos](https://docs.aws.amazon.com/vpc/latest/cloudwan/cloudwan-attachments-working-with.html#cloudwan-attachments-acceptance) no *Guia do usuário do Cloud WAN*. + Para ver detalhes da API, consulte [RejectAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/reject-attachment.html) na *Referência de comandos da AWS CLI*. ### `start-route-analysis` O código de exemplo a seguir mostra como usar `start-route-analysis`. **AWS CLI** **Para iniciar a análise da rota** O exemplo `start-route-analysis` a seguir inicia a análise entre a origem e o destino, incluindo o `include-return-path` opcional. ``` aws networkmanager start-route-analysis \ --global-network-id global-network-00aa0aaa0b0aaa000 \ --source TransitGatewayAttachmentArn=arn:aws:ec2:us-east-1:503089527312:transit-gateway-attachment/tgw-attach-0d4a2d491bf68c093,IpAddress=10.0.0.0 \ --destination TransitGatewayAttachmentArn=arn:aws:ec2:us-west-1:503089527312:transit-gateway-attachment/tgw-attach-002577f30bb181742,IpAddress=11.0.0.0 \ --include-return-path ``` Resultado: ``` { "RouteAnalysis": { "GlobalNetworkId": "global-network-00aa0aaa0b0aaa000 "OwnerAccountId": "1111222233333", "RouteAnalysisId": "a1873de1-273c-470c-1a2bc2345678", "StartTimestamp": 1695760154.0, "Status": "RUNNING", "Source": { "TransitGatewayAttachmentArn": "arn:aws:ec2:us-east-1:111122223333:transit-gateway-attachment/tgw-attach-1234567890abcdef0, "TransitGatewayArn": "arn:aws:ec2:us-east-1:111122223333:transit-gateway/tgw-abcdef01234567890", "IpAddress": "10.0.0.0" }, "Destination": { "TransitGatewayAttachmentArn": "arn:aws:ec2:us-west-1:555555555555:transit-gateway-attachment/tgw-attach-021345abcdef6789", "TransitGatewayArn": "arn:aws:ec2:us-west-1:111122223333:transit-gateway/tgw-09876543210fedcba0", "IpAddress": "11.0.0.0" }, "IncludeReturnPath": true, "UseMiddleboxes": false } } ``` Para obter mais informações, consulte o [Analisador de rotas](https://docs.aws.amazon.com/network-manager/latest/tgwnm/route-analyzer.html) no *Guia do AWS Global Networks for Transit Gateways*. + Para ver detalhes da API, consulte [StartRouteAnalysis](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/start-route-analysis.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Aplicar marcas a um recurso** O exemplo `tag-resource` a seguir aplica a tag `Network=Northeast` ao dispositivo `device-07f6fd08867abc123`. ``` aws networkmanager tag-resource \ --resource-arn arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123 \ --tags Key=Network,Value=Northeast \ --region us-west-2 ``` Este comando não produz saída. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Como remover as tags de um recurso** O exemplo `untag-resource` a seguir remove a tag com o nome de chave `Network` do dispositivo `device-07f6fd08867abc123`. ``` aws networkmanager untag-resource \ --resource-arn arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123 ] --tag-keys Network \ --region us-west-2 ``` Este comando não produz saída. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-device` O código de exemplo a seguir mostra como usar `update-device`. **AWS CLI** **Para atualizar um dispositivo** O exemplo `update-device` a seguir atualiza o dispositivo `device-07f6fd08867abc123` especificando uma ID do site para o dispositivo. ``` aws networkmanager update-device \ --global-network-id global-network-01231231231231231 \ --device-id device-07f6fd08867abc123 \ --site-id site-444555aaabbb11223 \ --region us-west-2 ``` Resultado: ``` { "Device": { "DeviceId": "device-07f6fd08867abc123", "DeviceArn": "arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123", "GlobalNetworkId": "global-network-01231231231231231", "Description": "NY office device", "Type": "Office device", "Vendor": "anycompany", "Model": "abcabc", "SerialNumber": "1234", "SiteId": "site-444555aaabbb11223", "CreatedAt": 1575554005.0, "State": "UPDATING" } } ``` Para obter mais informações, consulte [Trabalhar com dispositivos](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#working-with-devices) no *Guia do Transit Gateway Network Manager*. + Para ver detalhes da API, consulte [UpdateDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/update-device.html) na *Referência de comandos da AWS CLI*. ### `update-global-network` O código de exemplo a seguir mostra como usar `update-global-network`. **AWS CLI** **Para atualizar uma rede global** O exemplo `update-global-network` a seguir atualiza a descrição da rede global `global-network-01231231231231231`. ``` aws networkmanager update-global-network \ --global-network-id global-network-01231231231231231 \ --description "Head offices" \ --region us-west-2 ``` Resultado: ``` { "GlobalNetwork": { "GlobalNetworkId": "global-network-01231231231231231", "GlobalNetworkArn": "arn:aws:networkmanager::123456789012:global-network/global-network-01231231231231231", "Description": "Head offices", "CreatedAt": 1575553525.0, "State": "UPDATING" } } ``` Para obter mais informações, consulte [Redes globais](https://docs.aws.amazon.com/vpc/latest/tgw/global-networks.html) no *Guia do Transit Gateway Network Manager*. + Para ver detalhes da API, consulte [UpdateGlobalNetwork](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/update-global-network.html) na *Referência de comandos da AWS CLI*. ### `update-link` O código de exemplo a seguir mostra como usar `update-link`. **AWS CLI** **Para atualizar um link** O exemplo `update-link` a seguir atualiza as informações de largura de banda do link `link-11112222aaaabbbb1`. ``` aws networkmanager update-link \ --global-network-id global-network-01231231231231231 \ --link-id link-11112222aaaabbbb1 \ --bandwidth UploadSpeed=20,DownloadSpeed=20 \ --region us-west-2 ``` Resultado: ``` { "Link": { "LinkId": "link-11112222aaaabbbb1", "LinkArn": "arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1", "GlobalNetworkId": "global-network-01231231231231231", "SiteId": "site-444555aaabbb11223", "Description": "VPN Link", "Type": "broadband", "Bandwidth": { "UploadSpeed": 20, "DownloadSpeed": 20 }, "Provider": "AnyCompany", "CreatedAt": 1575555811.0, "State": "UPDATING" } } ``` Para obter mais informações, consulte [Trabalhar com links](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#working-with-links) no *Guia do Transit Gateway Network Manager*. + Para ver detalhes da API, consulte [UpdateLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/update-link.html) na *Referência de comandos da AWS CLI*. ### `update-site` O código de exemplo a seguir mostra como usar `update-site`. **AWS CLI** **Para atualizar um site** O exemplo `update-site` a seguir atualiza a descrição do site `site-444555aaabbb11223` na rede global especificada. ``` aws networkmanager update-site \ --global-network-id global-network-01231231231231231 \ --site-id site-444555aaabbb11223 \ --description "New York Office site" \ --region us-west-2 ``` Resultado: ``` { "Site": { "SiteId": "site-444555aaabbb11223", "SiteArn": "arn:aws:networkmanager::123456789012:site/global-network-01231231231231231/site-444555aaabbb11223", "GlobalNetworkId": "global-network-01231231231231231", "Description": "New York Office site", "Location": { "Latitude": "40.7128", "Longitude": "-74.0060" }, "CreatedAt": 1575554528.0, "State": "UPDATING" } } ``` Para obter mais informações, consulte [Trabalhar com sites](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#working-with-sites) no *Guia do Transit Gateway Network Manager*. + Para ver detalhes da API, consulte [UpdateSite](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/update-site.html) na *Referência de comandos da AWS CLI*. # Exemplos do OpenSearch Service usando o AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o OpenSearch 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 ### `create-elasticsearch-domain` O código de exemplo a seguir mostra como usar `create-elasticsearch-domain`. **AWS CLI** **Criar um domínio do Amazon Elasticsearch Service** O comando `create-elasticsearch-domain` a seguir cria um novo domínio do Amazon Elasticsearch Service em uma VPC e restringe o acesso a um único usuário. O Amazon ES infere o ID da VPC a partir dos IDs especificados da sub-rede e do grupo de segurança. ``` aws es create-elasticsearch-domain \ --domain-name vpc-cli-example \ --elasticsearch-version 6.2 \ --elasticsearch-cluster-config InstanceType=m4.large.elasticsearch,InstanceCount=1 \ --ebs-options EBSEnabled=true,VolumeType=standard,VolumeSize=10 \ --access-policies '{"Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": {"AWS": "arn:aws:iam::123456789012:root" }, "Action":"es:*", "Resource": "arn:aws:es:us-west-1:123456789012:domain/vpc-cli-example/*" } ] }' \ --vpc-options SubnetIds=subnet-1a2a3a4a,SecurityGroupIds=sg-2a3a4a5a ``` Resultado: ``` { "DomainStatus": { "ElasticsearchClusterConfig": { "DedicatedMasterEnabled": false, "InstanceCount": 1, "ZoneAwarenessEnabled": false, "InstanceType": "m4.large.elasticsearch" }, "DomainId": "123456789012/vpc-cli-example", "CognitoOptions": { "Enabled": false }, "VPCOptions": { "SubnetIds": [ "subnet-1a2a3a4a" ], "VPCId": "vpc-3a4a5a6a", "SecurityGroupIds": [ "sg-2a3a4a5a" ], "AvailabilityZones": [ "us-west-1c" ] }, "Created": true, "Deleted": false, "EBSOptions": { "VolumeSize": 10, "VolumeType": "standard", "EBSEnabled": true }, "Processing": true, "DomainName": "vpc-cli-example", "SnapshotOptions": { "AutomatedSnapshotStartHour": 0 }, "ElasticsearchVersion": "6.2", "AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-west-1:123456789012:domain/vpc-cli-example/*\"}]}", "AdvancedOptions": { "rest.action.multi.allow_explicit_index": "true" }, "EncryptionAtRestOptions": { "Enabled": false }, "ARN": "arn:aws:es:us-west-1:123456789012:domain/vpc-cli-example" } } ``` Para obter mais informações, consulte [Criar e gerenciar domínios do Amazon Elasticsearch Service](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html) no *Guia do desenvolvedor do Amazon Elasticsearch Service*. + Para ver detalhes da API, consulte [CreateElasticsearchDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/create-elasticsearch-domain.html) na *Referência de comandos da AWS CLI*. ### `describe-elasticsearch-domain-config` O código de exemplo a seguir mostra como usar `describe-elasticsearch-domain-config`. **AWS CLI** **Obter detalhes da configuração do domínio** O exemplo `describe-elasticsearch-domain-config` a seguir fornece detalhes de configuração para um determinado domínio, juntamente com informações de status para cada componente individual do domínio. ``` aws es describe-elasticsearch-domain-config \ --domain-name cli-example ``` Resultado: ``` { "DomainConfig": { "ElasticsearchVersion": { "Options": "7.4", "Status": { "CreationDate": 1589395034.946, "UpdateDate": 1589395827.325, "UpdateVersion": 8, "State": "Active", "PendingDeletion": false } }, "ElasticsearchClusterConfig": { "Options": { "InstanceType": "c5.large.elasticsearch", "InstanceCount": 1, "DedicatedMasterEnabled": true, "ZoneAwarenessEnabled": false, "DedicatedMasterType": "c5.large.elasticsearch", "DedicatedMasterCount": 3, "WarmEnabled": true, "WarmType": "ultrawarm1.medium.elasticsearch", "WarmCount": 2 }, "Status": { "CreationDate": 1589395034.946, "UpdateDate": 1589395827.325, "UpdateVersion": 8, "State": "Active", "PendingDeletion": false } }, "EBSOptions": { "Options": { "EBSEnabled": true, "VolumeType": "gp2", "VolumeSize": 10 }, "Status": { "CreationDate": 1589395034.946, "UpdateDate": 1589395827.325, "UpdateVersion": 8, "State": "Active", "PendingDeletion": false } }, "AccessPolicies": { "Options": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"*\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/cli-example/*\"}]}", "Status": { "CreationDate": 1589395034.946, "UpdateDate": 1589395827.325, "UpdateVersion": 8, "State": "Active", "PendingDeletion": false } }, "SnapshotOptions": { "Options": { "AutomatedSnapshotStartHour": 0 }, "Status": { "CreationDate": 1589395034.946, "UpdateDate": 1589395827.325, "UpdateVersion": 8, "State": "Active", "PendingDeletion": false } }, "VPCOptions": { "Options": {}, "Status": { "CreationDate": 1591210426.162, "UpdateDate": 1591210426.162, "UpdateVersion": 18, "State": "Active", "PendingDeletion": false } }, "CognitoOptions": { "Options": { "Enabled": false }, "Status": { "CreationDate": 1591210426.163, "UpdateDate": 1591210426.163, "UpdateVersion": 18, "State": "Active", "PendingDeletion": false } }, "EncryptionAtRestOptions": { "Options": { "Enabled": true, "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/1a2a3a4a-1a2a-1a2a-1a2a-1a2a3a4a5a6a" }, "Status": { "CreationDate": 1589395034.946, "UpdateDate": 1589395827.325, "UpdateVersion": 8, "State": "Active", "PendingDeletion": false } }, "NodeToNodeEncryptionOptions": { "Options": { "Enabled": true }, "Status": { "CreationDate": 1589395034.946, "UpdateDate": 1589395827.325, "UpdateVersion": 8, "State": "Active", "PendingDeletion": false } }, "AdvancedOptions": { "Options": { "rest.action.multi.allow_explicit_index": "true" }, "Status": { "CreationDate": 1589395034.946, "UpdateDate": 1589395827.325, "UpdateVersion": 8, "State": "Active", "PendingDeletion": false } }, "LogPublishingOptions": { "Options": {}, "Status": { "CreationDate": 1591210426.164, "UpdateDate": 1591210426.164, "UpdateVersion": 18, "State": "Active", "PendingDeletion": false } }, "DomainEndpointOptions": { "Options": { "EnforceHTTPS": true, "TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07" }, "Status": { "CreationDate": 1589395034.946, "UpdateDate": 1589395827.325, "UpdateVersion": 8, "State": "Active", "PendingDeletion": false } }, "AdvancedSecurityOptions": { "Options": { "Enabled": true, "InternalUserDatabaseEnabled": true }, "Status": { "CreationDate": 1589395034.946, "UpdateDate": 1589827485.577, "UpdateVersion": 14, "State": "Active", "PendingDeletion": false } } } } ``` Para obter mais informações, consulte [Criar e gerenciar domínios do Amazon Elasticsearch Service](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html) no *Guia do desenvolvedor do Amazon Elasticsearch Service*. + Para ver detalhes da API, consulte [DescribeElasticsearchDomainConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/describe-elasticsearch-domain-config.html) na *Referência de comandos da AWS CLI*. ### `describe-elasticsearch-domain` O código de exemplo a seguir mostra como usar `describe-elasticsearch-domain`. **AWS CLI** **Obter detalhes de um único domínio** O exemplo `describe-elasticsearch-domain` a seguir fornece detalhes de configuração para um determinado domínio. ``` aws es describe-elasticsearch-domain \ --domain-name cli-example ``` Resultado: ``` { "DomainStatus": { "DomainId": "123456789012/cli-example", "DomainName": "cli-example", "ARN": "arn:aws:es:us-east-1:123456789012:domain/cli-example", "Created": true, "Deleted": false, "Endpoint": "search-cli-example-1a2a3a4a5a6a7a8a9a0a.us-east-1.es.amazonaws.com", "Processing": false, "UpgradeProcessing": false, "ElasticsearchVersion": "7.4", "ElasticsearchClusterConfig": { "InstanceType": "c5.large.elasticsearch", "InstanceCount": 1, "DedicatedMasterEnabled": true, "ZoneAwarenessEnabled": false, "DedicatedMasterType": "c5.large.elasticsearch", "DedicatedMasterCount": 3, "WarmEnabled": true, "WarmType": "ultrawarm1.medium.elasticsearch", "WarmCount": 2 }, "EBSOptions": { "EBSEnabled": true, "VolumeType": "gp2", "VolumeSize": 10 }, "AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"*\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/cli-example/*\"}]}", "SnapshotOptions": { "AutomatedSnapshotStartHour": 0 }, "CognitoOptions": { "Enabled": false }, "EncryptionAtRestOptions": { "Enabled": true, "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/1a2a3a4a-1a2a-1a2a-1a2a-1a2a3a4a5a6a" }, "NodeToNodeEncryptionOptions": { "Enabled": true }, "AdvancedOptions": { "rest.action.multi.allow_explicit_index": "true" }, "ServiceSoftwareOptions": { "CurrentVersion": "R20200522", "NewVersion": "", "UpdateAvailable": false, "Cancellable": false, "UpdateStatus": "COMPLETED", "Description": "There is no software update available for this domain.", "AutomatedUpdateDate": 0.0 }, "DomainEndpointOptions": { "EnforceHTTPS": true, "TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07" }, "AdvancedSecurityOptions": { "Enabled": true, "InternalUserDatabaseEnabled": true } } } ``` Para obter mais informações, consulte [Criar e gerenciar domínios do Amazon Elasticsearch Service](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html) no *Guia do desenvolvedor do Amazon Elasticsearch Service*. + Para ver detalhes da API, consulte [DescribeElasticsearchDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/describe-elasticsearch-domain.html) na *Referência de comandos da AWS CLI*. ### `describe-elasticsearch-domains` O código de exemplo a seguir mostra como usar `describe-elasticsearch-domains`. **AWS CLI** **Obter detalhes de um ou mais domínios** O exemplo `describe-elasticsearch-domains` a seguir fornece detalhes de configuração para um ou mais domínios. ``` aws es describe-elasticsearch-domains \ --domain-names cli-example-1 cli-example-2 ``` Resultado: ``` { "DomainStatusList": [{ "DomainId": "123456789012/cli-example-1", "DomainName": "cli-example-1", "ARN": "arn:aws:es:us-east-1:123456789012:domain/cli-example-1", "Created": true, "Deleted": false, "Endpoint": "search-cli-example-1-1a2a3a4a5a6a7a8a9a0a.us-east-1.es.amazonaws.com", "Processing": false, "UpgradeProcessing": false, "ElasticsearchVersion": "7.4", "ElasticsearchClusterConfig": { "InstanceType": "c5.large.elasticsearch", "InstanceCount": 1, "DedicatedMasterEnabled": true, "ZoneAwarenessEnabled": false, "DedicatedMasterType": "c5.large.elasticsearch", "DedicatedMasterCount": 3, "WarmEnabled": true, "WarmType": "ultrawarm1.medium.elasticsearch", "WarmCount": 2 }, "EBSOptions": { "EBSEnabled": true, "VolumeType": "gp2", "VolumeSize": 10 }, "AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"*\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/cli-example-1/*\"}]}", "SnapshotOptions": { "AutomatedSnapshotStartHour": 0 }, "CognitoOptions": { "Enabled": false }, "EncryptionAtRestOptions": { "Enabled": true, "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/1a2a3a4a-1a2a-1a2a-1a2a-1a2a3a4a5a6a" }, "NodeToNodeEncryptionOptions": { "Enabled": true }, "AdvancedOptions": { "rest.action.multi.allow_explicit_index": "true" }, "ServiceSoftwareOptions": { "CurrentVersion": "R20200522", "NewVersion": "", "UpdateAvailable": false, "Cancellable": false, "UpdateStatus": "COMPLETED", "Description": "There is no software update available for this domain.", "AutomatedUpdateDate": 0.0 }, "DomainEndpointOptions": { "EnforceHTTPS": true, "TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07" }, "AdvancedSecurityOptions": { "Enabled": true, "InternalUserDatabaseEnabled": true } }, { "DomainId": "123456789012/cli-example-2", "DomainName": "cli-example-2", "ARN": "arn:aws:es:us-east-1:123456789012:domain/cli-example-2", "Created": true, "Deleted": false, "Processing": true, "UpgradeProcessing": false, "ElasticsearchVersion": "7.4", "ElasticsearchClusterConfig": { "InstanceType": "r5.large.elasticsearch", "InstanceCount": 1, "DedicatedMasterEnabled": false, "ZoneAwarenessEnabled": false, "WarmEnabled": false }, "EBSOptions": { "EBSEnabled": true, "VolumeType": "gp2", "VolumeSize": 10 }, "AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Deny\",\"Principal\":{\"AWS\":\"*\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/cli-example-2/*\"}]}", "SnapshotOptions": { "AutomatedSnapshotStartHour": 0 }, "CognitoOptions": { "Enabled": false }, "EncryptionAtRestOptions": { "Enabled": false }, "NodeToNodeEncryptionOptions": { "Enabled": false }, "AdvancedOptions": { "rest.action.multi.allow_explicit_index": "true" }, "ServiceSoftwareOptions": { "CurrentVersion": "", "NewVersion": "", "UpdateAvailable": false, "Cancellable": false, "UpdateStatus": "COMPLETED", "Description": "There is no software update available for this domain.", "AutomatedUpdateDate": 0.0 }, "DomainEndpointOptions": { "EnforceHTTPS": false, "TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07" }, "AdvancedSecurityOptions": { "Enabled": false, "InternalUserDatabaseEnabled": false } } ] } ``` Para obter mais informações, consulte [Criar e gerenciar domínios do Amazon Elasticsearch Service](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html) no *Guia do desenvolvedor do Amazon Elasticsearch Service*. + Para ver detalhes da API, consulte [DescribeElasticsearchDomains](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/describe-elasticsearch-domains.html) na *Referência de comandos da AWS CLI*. ### `describe-reserved-elasticsearch-instances` O código de exemplo a seguir mostra como usar `describe-reserved-elasticsearch-instances`. **AWS CLI** **Visualizar todas as instâncias reservadas** O exemplo `describe-elasticsearch-domains` a seguir fornece um resumo de todas as instâncias que você reservou em uma região. ``` aws es describe-reserved-elasticsearch-instances ``` Resultado: ``` { "ReservedElasticsearchInstances": [{ "FixedPrice": 100.0, "ReservedElasticsearchInstanceOfferingId": "1a2a3a4a5-1a2a-3a4a-5a6a-1a2a3a4a5a6a", "ReservationName": "my-reservation", "PaymentOption": "PARTIAL_UPFRONT", "UsagePrice": 0.0, "ReservedElasticsearchInstanceId": "9a8a7a6a-5a4a-3a2a-1a0a-9a8a7a6a5a4a", "RecurringCharges": [{ "RecurringChargeAmount": 0.603, "RecurringChargeFrequency": "Hourly" }], "State": "payment-pending", "StartTime": 1522872571.229, "ElasticsearchInstanceCount": 3, "Duration": 31536000, "ElasticsearchInstanceType": "m4.2xlarge.elasticsearch", "CurrencyCode": "USD" }] } ``` Para obter mais informações, consulte [Instâncias reservadas](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/aes-ri.html) no *Guia do desenvolvedor do Amazon Elasticsearch Service*. + Para ver detalhes da API, consulte [DescribeReservedElasticsearchInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/describe-reserved-elasticsearch-instances.html) na *Referência de comandos da AWS CLI*. ### `list-domain-names` O código de exemplo a seguir mostra como usar `list-domain-names`. **AWS CLI** **Listar todos os domínios** O exemplo `list-domain-names` a seguir fornece um resumo rápido de todos os domínios na região. ``` aws es list-domain-names ``` Resultado: ``` { "DomainNames": [{ "DomainName": "cli-example-1" }, { "DomainName": "cli-example-2" } ] } ``` Para obter mais informações, consulte [Criar e gerenciar domínios do Amazon Elasticsearch Service](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html) no *Guia do desenvolvedor do Amazon Elasticsearch Service*. + Para ver detalhes da API, consulte [ListDomainNames](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/list-domain-names.html) na *Referência de comandos da AWS CLI*. # Exemplos do Organizations usando o AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Organizations. *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 ### `accept-handshake` O código de exemplo a seguir mostra como usar `accept-handshake`. **AWS CLI** **Como aceitar um handshake de outra conta** Bill, proprietário de uma organização, já havia convidado a conta de Juan para se juntar à sua organização. O exemplo a seguir mostra a conta de Juan aceitando o handshake e, assim, concordando com o convite. ``` aws organizations accept-handshake --handshake-id h-examplehandshakeid111 ``` A saída mostra o seguinte: ``` { "Handshake": { "Action": "INVITE", "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", "RequestedTimestamp": 1481656459.257, "ExpirationTimestamp": 1482952459.257, "Id": "h-examplehandshakeid111", "Parties": [ { "Id": "o-exampleorgid", "Type": "ORGANIZATION" }, { "Id": "juan@example.com", "Type": "EMAIL" } ], "Resources": [ { "Resources": [ { "Type": "MASTER_EMAIL", "Value": "bill@amazon.com" }, { "Type": "MASTER_NAME", "Value": "Org Master Account" }, { "Type": "ORGANIZATION_FEATURE_SET", "Value": "ALL" } ], "Type": "ORGANIZATION", "Value": "o-exampleorgid" }, { "Type": "EMAIL", "Value": "juan@example.com" } ], "State": "ACCEPTED" } } ``` + Para ver detalhes da API, consulte [AcceptHandshake](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/accept-handshake.html) na *Referência de comandos da AWS CLI*. ### `attach-policy` O código de exemplo a seguir mostra como usar `attach-policy`. **AWS CLI** **Como anexar uma política a uma raiz, unidade operacional ou conta** **Exemplo 1** O seguinte exemplo mostra com anexar uma política de controle de serviços (SCP) a uma unidade operacional (OU): ``` aws organizations attach-policy --policy-id p-examplepolicyid111 --target-id ou-examplerootid111-exampleouid111 ``` **Exemplo 2** O seguinte exemplo mostra como anexar uma política de controle de serviços a uma conta: ``` aws organizations attach-policy --policy-id p-examplepolicyid111 --target-id 333333333333 ``` + Consulte detalhes da API em [AttachPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/attach-policy.html) na *Referência de comandos da AWS CLI*. ### `cancel-handshake` O código de exemplo a seguir mostra como usar `cancel-handshake`. **AWS CLI** **Como cancelar um handshake enviado de outra conta** Bill já havia enviado um convite para que a conta de Susan se junte à sua organização. Ele muda de ideia e decide cancelar o convite antes que Susan o aceite. O exemplo a seguir mostra o cancelamento de Bill: ``` aws organizations cancel-handshake --handshake-id h-examplehandshakeid111 ``` A saída inclui um objeto de handshake que mostra que o status agora é `CANCELED`: ``` { "Handshake": { "Id": "h-examplehandshakeid111", "State":"CANCELED", "Action": "INVITE", "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", "Parties": [ { "Id": "o-exampleorgid", "Type": "ORGANIZATION" }, { "Id": "susan@example.com", "Type": "EMAIL" } ], "Resources": [ { "Type": "ORGANIZATION", "Value": "o-exampleorgid", "Resources": [ { "Type": "MASTER_EMAIL", "Value": "bill@example.com" }, { "Type": "MASTER_NAME", "Value": "Master Account" }, { "Type": "ORGANIZATION_FEATURE_SET", "Value": "CONSOLIDATED_BILLING" } ] }, { "Type": "EMAIL", "Value": "anika@example.com" }, { "Type": "NOTES", "Value": "This is a request for Susan's account to join Bob's organization." } ], "RequestedTimestamp": 1.47008383521E9, "ExpirationTimestamp": 1.47137983521E9 } } ``` + Para ver detalhes da API, consulte [CancelHandshake](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/cancel-handshake.html) na *Referência de comandos da AWS CLI*. ### `create-account` O código de exemplo a seguir mostra como usar `create-account`. **AWS CLI** **Como criar uma conta de membro que automaticamente faça parte da organização** O exemplo a seguir mostra como criar uma conta de membro em uma organização. A conta de membro é configurada com o nome Production Account e o endereço de e-mail susan@example.com. O Organizations automaticamente cria um perfil do IAM usando o nome padrão OrganizationAccountAccessRole porque o parâmetro roleName não foi especificado. Além disso, a configuração que permite que perfis ou usuários do IAM com permissões suficientes acessem os dados de faturamento da conta é definida com o valor padrão de ALLOW porque o parâmetro IamUserAccessToBilling não foi especificado. O Organizations automaticamente envia um e-mail de “Boas-vindas à AWS” para Susan: ``` aws organizations create-account --email susan@example.com --account-name "Production Account" ``` A saída inclui um objeto de solicitação que mostra que o status agora é `IN_PROGRESS`: ``` { "CreateAccountStatus": { "State": "IN_PROGRESS", "Id": "car-examplecreateaccountrequestid111" } } ``` Você pode consultar o status atual da solicitação posteriormente. Para fazer isso, forneça o valor de resposta do ID ao comando describe-create-account-status como o valor do parâmetro create-account-request-id. Para obter informações, consulte Creating an AWS Account in Your Organization no *Guia do usuário do AWS Organizations*. + Consulte detalhes da API em [CreateAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/create-account.html) na *Referência de comandos da AWS CLI*. ### `create-organization` O código de exemplo a seguir mostra como usar `create-organization`. **AWS CLI** **Exemplo 1: como criar uma organização** Bill quer criar uma organização usando as credenciais da conta 111111111111. O exemplo a seguir mostra que a conta se torna a conta principal na nova organização. Como ele não especificou um conjunto de recursos, a nova organização usa como padrão todos os recursos habilitados e as políticas de controle de serviços são habilitadas na raiz. ``` aws organizations create-organization ``` A saída inclui um objeto de organização com detalhes sobre a nova organização: ``` { "Organization": { "AvailablePolicyTypes": [ { "Status": "ENABLED", "Type": "SERVICE_CONTROL_POLICY" } ], "MasterAccountId": "111111111111", "MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", "MasterAccountEmail": "bill@example.com", "FeatureSet": "ALL", "Id": "o-exampleorgid", "Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid" } } ``` **Exemplo 2: como criar uma organização apenas com os recursos de faturamento consolidados** O seguinte exemplo cria uma organização compatível apenas com os recursos de faturamento consolidados: ``` aws organizations create-organization --feature-set CONSOLIDATED_BILLING ``` A saída inclui um objeto de organização com detalhes sobre a nova organização: ``` { "Organization": { "Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid", "AvailablePolicyTypes": [], "Id": "o-exampleorgid", "MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", "MasterAccountEmail": "bill@example.com", "MasterAccountId": "111111111111", "FeatureSet": "CONSOLIDATED_BILLING" } } ``` Para obter informações, consulte Criar uma organização no *Guia do usuário do AWS Organizations*. + Consulte detalhes da API em [CreateOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/create-organization.html) na *Referência de comandos da AWS CLI*. ### `create-organizational-unit` O código de exemplo a seguir mostra como usar `create-organizational-unit`. **AWS CLI** **Como criar uma unidade organizacional em uma unidade organizacional raiz ou pai** O seguinte exemplo mostra como criar uma UO chamada AccountingOU: ``` aws organizations create-organizational-unit --parent-id r-examplerootid111 --name AccountingOU ``` A saída inclui um objeto organizationalUnit que contém detalhes sobre a nova UO: ``` { "OrganizationalUnit": { "Id": "ou-examplerootid111-exampleouid111", "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", "Name": "AccountingOU" } } ``` + Consulte detalhes da API em [CreateOrganizationalUnit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/create-organizational-unit.html) na *Referência de comandos da AWS CLI*. ### `create-policy` O código de exemplo a seguir mostra como usar `create-policy`. **AWS CLI** **Exemplo 1: como criar uma política com um arquivo de origem de texto na política JSON** O exemplo a seguir mostra como criar uma política de controle de serviço (SCP) chamada `AllowAllS3Actions`. O conteúdo da política provém de um arquivo chamado `policy.json` presente no computador local. ``` aws organizations create-policy --content file://policy.json --name AllowAllS3Actions, --type SERVICE_CONTROL_POLICY --description "Allows delegation of all S3 actions" ``` A saída inclui um objeto de política com detalhes sobre a nova política: ``` { "Policy": { "Content": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"s3:*\"],\"Resource\":[\"*\"]}]}", "PolicySummary": { "Arn": "arn:aws:organizations::o-exampleorgid:policy/service_control_policy/p-examplepolicyid111", "Description": "Allows delegation of all S3 actions", "Name": "AllowAllS3Actions", "Type":"SERVICE_CONTROL_POLICY" } } } ``` **Exemplo 2: como criar uma política tendo uma política JSON como parâmetro** O exemplo a seguir mostra como criar a mesma SCP, mas, desta vez, incorporando o conteúdo da política como uma string JSON no parâmetro. A string deve ser recuada com barras invertidas antes das aspas duplas para garantir que ela seja tratada como literal no parâmetro (que está entre aspas duplas): ``` aws organizations create-policy --content "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"s3:*\"],\"Resource\":[\"*\"]}]}" --name AllowAllS3Actions --type SERVICE_CONTROL_POLICY --description "Allows delegation of all S3 actions" ``` Para obter mais informações sobre como criar e usar políticas em sua organização, consulte Gerenciamento de políticas organizacionais no *Guia do usuário do AWS Organizations*. + Consulte detalhes da API em [CreatePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/create-policy.html) na *Referência de comandos da AWS CLI*. ### `decline-handshake` O código de exemplo a seguir mostra como usar `decline-handshake`. **AWS CLI** **Como recusar um handshake enviado de outra conta** O exemplo a seguir mostra que Susan, uma administradora proprietária da conta 222222222222, recusa um convite para se juntar à organização de Bill. A operação DeclineHandshake retorna um objeto de handshake, mostrando que o estado agora é DECLINADO: ``` aws organizations decline-handshake --handshake-id h-examplehandshakeid111 ``` A saída inclui um objeto de handshake que mostra o novo estado de `DECLINED`: ``` { "Handshake": { "Id": "h-examplehandshakeid111", "State": "DECLINED", "Resources": [ { "Type": "ORGANIZATION", "Value": "o-exampleorgid", "Resources": [ { "Type": "MASTER_EMAIL", "Value": "bill@example.com" }, { "Type": "MASTER_NAME", "Value": "Master Account" } ] }, { "Type": "EMAIL", "Value": "susan@example.com" }, { "Type": "NOTES", "Value": "This is an invitation to Susan's account to join the Bill's organization." } ], "Parties": [ { "Type": "EMAIL", "Id": "susan@example.com" }, { "Type": "ORGANIZATION", "Id": "o-exampleorgid" } ], "Action": "INVITE", "RequestedTimestamp": 1470684478.687, "ExpirationTimestamp": 1471980478.687, "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111" } } ``` + Para ver detalhes da API, consulte [DeclineHandshake](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/decline-handshake.html) na *Referência de comandos da AWS CLI*. ### `delete-organization` O código de exemplo a seguir mostra como usar `delete-organization`. **AWS CLI** **Como excluir uma organização** O exemplo a seguir mostra como excluir uma organização. Você deve ser administrador da conta principal na organização para poder realizar essa operação. O exemplo pressupõe que você já removeu todas as contas de membro, UOs e políticas da organização: ``` aws organizations delete-organization ``` + Consulte detalhes da API em [DeleteOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/delete-organization.html) na *Referência de comandos da AWS CLI*. ### `delete-organizational-unit` O código de exemplo a seguir mostra como usar `delete-organizational-unit`. **AWS CLI** **Como excluir uma UO** O exemplo a seguir mostra como excluir uma UO. O exemplo pressupõe que você já removeu todas as contas e outras UOs da UO: ``` aws organizations delete-organizational-unit --organizational-unit-id ou-examplerootid111-exampleouid111 ``` + Consulte detalhes da API em [DeleteOrganizationalUnit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/delete-organizational-unit.html) na *Referência de comandos da AWS CLI*. ### `delete-policy` O código de exemplo a seguir mostra como usar `delete-policy`. **AWS CLI** **Como excluir uma política** O exemplo a seguir mostra como excluir uma política de uma organização. O exemplo pressupõe que você já separou a política de todas as entidades: ``` aws organizations delete-policy --policy-id p-examplepolicyid111 ``` + Consulte detalhes da API em [DeletePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/delete-policy.html) na *Referência de comandos da AWS CLI*. ### `describe-account` O código de exemplo a seguir mostra como usar `describe-account`. **AWS CLI** **Para obter os detalhes sobre uma conta** O exemplo a seguir mostra como solicitar os detalhes sobre uma conta: ``` aws organizations describe-account --account-id 555555555555 ``` A saída mostra um objeto de conta com os detalhes da conta: ``` { "Account": { "Id": "555555555555", "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/555555555555", "Name": "Beta account", "Email": "anika@example.com", "JoinedMethod": "INVITED", "JoinedTimeStamp": 1481756563.134, "Status": "ACTIVE" } } ``` + Para ver detalhes da API, consulte [DescribeAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/describe-account.html) na *Referência de comandos da AWS CLI*. ### `describe-create-account-status` O código de exemplo a seguir mostra como usar `describe-create-account-status`. **AWS CLI** **Para obter o status mais recente de uma solicitação de criação de conta** O exemplo a seguir mostra como solicitar o status mais recente de uma solicitação anterior de criação de conta em uma organização. O --request-id especificado vem da resposta da chamada original de create-account. A solicitação de criação de conta mostra pelo campo de status que o Organizations concluiu com êxito a criação da conta. Comando: ``` aws organizations describe-create-account-status --create-account-request-id car-examplecreateaccountrequestid111 ``` Resultado: ``` { "CreateAccountStatus": { "State": "SUCCEEDED", "AccountId": "555555555555", "AccountName": "Beta account", "RequestedTimestamp": 1470684478.687, "CompletedTimestamp": 1470684532.472, "Id": "car-examplecreateaccountrequestid111" } } ``` + Para ver detalhes da API, consulte [DescribeCreateAccountStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/describe-create-account-status.html) na *Referência de comandos da AWS CLI*. ### `describe-handshake` O código de exemplo a seguir mostra como usar `describe-handshake`. **AWS CLI** **Para obter mais informações sobre um handshake** O exemplo a seguir mostra como solicitar detalhes sobre um handshake. O ID do handshake vem da chamada original de `InviteAccountToOrganization`, ou de uma chamada de `ListHandshakesForAccount` ou `ListHandshakesForOrganization`: ``` aws organizations describe-handshake --handshake-id h-examplehandshakeid111 ``` A saída inclui um objeto de handshake que tem todos os detalhes sobre o handshake solicitado: ``` { "Handshake": { "Id": "h-examplehandshakeid111", "State": "OPEN", "Resources": [ { "Type": "ORGANIZATION", "Value": "o-exampleorgid", "Resources": [ { "Type": "MASTER_EMAIL", "Value": "bill@example.com" }, { "Type": "MASTER_NAME", "Value": "Master Account" } ] }, { "Type": "EMAIL", "Value": "anika@example.com" } ], "Parties": [ { "Type": "ORGANIZATION", "Id": "o-exampleorgid" }, { "Type": "EMAIL", "Id": "anika@example.com" } ], "Action": "INVITE", "RequestedTimestamp": 1470158698.046, "ExpirationTimestamp": 1471454698.046, "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111" } } ``` + Para ver detalhes da API, consulte [DescribeHandshake](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/describe-handshake.html) na *Referência de comandos da AWS CLI*. ### `describe-organization` O código de exemplo a seguir mostra como usar `describe-organization`. **AWS CLI** **Para obter informações sobre a organização atual** O exemplo a seguir mostra como solicitar os detalhes sobre uma organização: ``` aws organizations describe-organization ``` A saída inclui um objeto de organização que contém os detalhes sobre a organização: ``` { "Organization": { "MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", "MasterAccountEmail": "bill@example.com", "MasterAccountId": "111111111111", "Id": "o-exampleorgid", "FeatureSet": "ALL", "Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid", "AvailablePolicyTypes": [ { "Status": "ENABLED", "Type": "SERVICE_CONTROL_POLICY" } ] } } ``` + Para ver detalhes da API, consulte [DescribeOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/describe-organization.html) na *Referência de comandos da AWS CLI*. ### `describe-organizational-unit` O código de exemplo a seguir mostra como usar `describe-organizational-unit`. **AWS CLI** **Para obter informações sobre uma OU** O exemplo `describe-organizational-unit` a seguir solicita detalhes sobre uma OU. ``` aws organizations describe-organizational-unit \ --organizational-unit-id ou-examplerootid111-exampleouid111 ``` Resultado: ``` { "OrganizationalUnit": { "Name": "Accounting Group", "Arn": "arn:aws:organizations::123456789012:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", "Id": "ou-examplerootid111-exampleouid111" } } ``` + Para ver detalhes da API, consulte [DescribeOrganizationalUnit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/describe-organizational-unit.html) na *Referência de comandos da AWS CLI*. ### `describe-policy` O código de exemplo a seguir mostra como usar `describe-policy`. **AWS CLI** **Como obter informações sobre uma política** O seguinte exemplo mostra como solicitar informações sobre uma política: ``` aws organizations describe-policy --policy-id p-examplepolicyid111 ``` A saída inclui um objeto de política que contém detalhes sobre a política: ``` { "Policy": { "Content": "{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": \"*\",\n \"Resource\": \"*\"\n }\n ]\n}", "PolicySummary": { "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", "Type": "SERVICE_CONTROL_POLICY", "Id": "p-examplepolicyid111", "AwsManaged": false, "Name": "AllowAllS3Actions", "Description": "Enables admins to delegate S3 permissions" } } } ``` + Consulte detalhes da API em [DescribePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/describe-policy.html) na *Referência de comandos da AWS CLI*. ### `detach-policy` O código de exemplo a seguir mostra como usar `detach-policy`. **AWS CLI** **Como separar uma política de uma raiz, UO ou conta** O seguinte exemplo mostra como separar uma política de uma UO: ``` aws organizations detach-policy --target-id ou-examplerootid111-exampleouid111 --policy-id p-examplepolicyid111 ``` + Para obter detalhes da API, consulte.[DetachPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/detach-policy.html) na *Referência de comandos da AWS CLI*. ### `disable-policy-type` O código de exemplo a seguir mostra como usar `disable-policy-type`. **AWS CLI** **Para desativar um tipo de política em uma raiz** O exemplo a seguir mostra como desativar o tipo de política de controle de serviços (SCP) em uma raiz: ``` aws organizations disable-policy-type --root-id r-examplerootid111 --policy-type SERVICE_CONTROL_POLICY ``` A saída mostra que o elemento de resposta PolicyTypes não inclui mais SERVICE\$1CONTROL\$1POLICY: ``` { "Root": { "PolicyTypes": [], "Name": "Root", "Id": "r-examplerootid111", "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111" } } ``` + Para ver detalhes da API, consulte [DisablePolicyType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/disable-policy-type.html) na *Referência de comandos da AWS CLI*. ### `enable-all-features` O código de exemplo a seguir mostra como usar `enable-all-features`. **AWS CLI** **Como permitir todos os atributos em uma organização** Este exemplo mostra o administrador solicitando que todas as contas convidadas da organização aprovem todos os atributos habilitados na organização. AWS O Organizations envia um e-mail para o endereço registrado em cada conta de membro convidado, solicitando que o proprietário aprove a alteração em todos os atributos aceitando o handshake enviado. Depois que todas as contas de membros convidados aceitarem o handshake, o administrador da organização poderá finalizar a alteração em todos os atributos, e aqueles com as permissões apropriadas poderão criar políticas e aplicá-las às raízes, OUs e contas: ``` aws organizations enable-all-features ``` A saída é um objeto de handshake que é enviado para aprovação de todas as contas de membros convidados: ``` { "Handshake": { "Action": "ENABLE_ALL_FEATURES", "Arn":"arn:aws:organizations::111111111111:handshake/o-exampleorgid/enable_all_features/h-examplehandshakeid111", "ExpirationTimestamp":1.483127868609E9, "Id":"h-examplehandshakeid111", "Parties": [ { "id":"o-exampleorgid", "type":"ORGANIZATION" } ], "requestedTimestamp":1.481831868609E9, "resources": [ { "type":"ORGANIZATION", "value":"o-exampleorgid" } ], "state":"REQUESTED" } } ``` + Para ver detalhes da API, consulte [EnableAllFeatures](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/enable-all-features.html) na *Referência de comandos da AWS CLI*. ### `enable-policy-type` O código de exemplo a seguir mostra como usar `enable-policy-type`. **AWS CLI** **Como ativar o uso de um tipo de política em uma raiz** O exemplo a seguir mostra como ativar o tipo de política de controle de serviços (SCP) em uma raiz: ``` aws organizations enable-policy-type --root-id r-examplerootid111 --policy-type SERVICE_CONTROL_POLICY ``` A saída mostra um objeto raiz com um elemento de resposta policyTypes mostrando que os SCPs agora estão ativados: ``` { "Root": { "PolicyTypes": [ { "Status":"ENABLED", "Type":"SERVICE_CONTROL_POLICY" } ], "Id": "r-examplerootid111", "Name": "Root", "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111" } } ``` + Para ver detalhes da API, consulte [EnablePolicyType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/enable-policy-type.html) na *Referência de comandos da AWS CLI*. ### `invite-account-to-organization` O código de exemplo a seguir mostra como usar `invite-account-to-organization`. **AWS CLI** **Como convidar uma conta para se juntar a uma organização** O exemplo a seguir mostra a conta principal de propriedade de bill@example.com convidando a conta de propriedade de juan@example.com para se juntar a uma organização: ``` aws organizations invite-account-to-organization --target '{"Type": "EMAIL", "Id": "juan@example.com"}' --notes "This is a request for Juan's account to join Bill's organization." ``` A saída inclui uma estrutura de handshake que mostra o que é enviado para a conta convidada: ``` { "Handshake": { "Action": "INVITE", "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", "ExpirationTimestamp": 1482952459.257, "Id": "h-examplehandshakeid111", "Parties": [ { "Id": "o-exampleorgid", "Type": "ORGANIZATION" }, { "Id": "juan@example.com", "Type": "EMAIL" } ], "RequestedTimestamp": 1481656459.257, "Resources": [ { "Resources": [ { "Type": "MASTER_EMAIL", "Value": "bill@amazon.com" }, { "Type": "MASTER_NAME", "Value": "Org Master Account" }, { "Type": "ORGANIZATION_FEATURE_SET", "Value": "FULL" } ], "Type": "ORGANIZATION", "Value": "o-exampleorgid" }, { "Type": "EMAIL", "Value": "juan@example.com" } ], "State": "OPEN" } } ``` + Para ver detalhes da API, consulte [InviteAccountToOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/invite-account-to-organization.html) na *Referência de comandos da AWS CLI*. ### `leave-organization` O código de exemplo a seguir mostra como usar `leave-organization`. **AWS CLI** **Como sair de uma organização como uma conta-membro** O exemplo a seguir mostra o administrador de uma conta de membro solicitando saída da organização da qual é membro atualmente: ``` aws organizations leave-organization ``` + Para ver detalhes da API, consulte [LeaveOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/leave-organization.html) na *Referência de comandos da AWS CLI*. ### `list-accounts-for-parent` O código de exemplo a seguir mostra como usar `list-accounts-for-parent`. **AWS CLI** **Para recuperar uma lista de todas as contas em uma raiz principal ou OU especificada** O exemplo a seguir mostra como solicitar uma lista das contas de uma OU: ``` aws organizations list-accounts-for-parent --parent-id ou-examplerootid111-exampleouid111 ``` A saída inclui uma lista de objetos de resumo da conta. ``` { "Accounts": [ { "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333", "JoinedMethod": "INVITED", "JoinedTimestamp": 1481835795.536, "Id": "333333333333", "Name": "Development Account", "Email": "juan@example.com", "Status": "ACTIVE" }, { "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/444444444444", "JoinedMethod": "INVITED", "JoinedTimestamp": 1481835812.143, "Id": "444444444444", "Name": "Test Account", "Email": "anika@example.com", "Status": "ACTIVE" } ] } ``` + Para ver detalhes da API, consulte [ListAccountsForParent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/list-accounts-for-parent.html) na *Referência de comandos da AWS CLI*. ### `list-accounts` O código de exemplo a seguir mostra como usar `list-accounts`. **AWS CLI** **Para recuperar uma lista de todas as contas de uma organização** O seguinte exemplo mostra como solicitar uma lista das contas de uma organização: ``` aws organizations list-accounts ``` A saída inclui uma lista de objetos de resumo da conta. ``` { "Accounts": [ { "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", "JoinedMethod": "INVITED", "JoinedTimestamp": 1481830215.45, "Id": "111111111111", "Name": "Master Account", "Email": "bill@example.com", "Status": "ACTIVE" }, { "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/222222222222", "JoinedMethod": "INVITED", "JoinedTimestamp": 1481835741.044, "Id": "222222222222", "Name": "Production Account", "Email": "alice@example.com", "Status": "ACTIVE" }, { "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333", "JoinedMethod": "INVITED", "JoinedTimestamp": 1481835795.536, "Id": "333333333333", "Name": "Development Account", "Email": "juan@example.com", "Status": "ACTIVE" }, { "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/444444444444", "JoinedMethod": "INVITED", "JoinedTimestamp": 1481835812.143, "Id": "444444444444", "Name": "Test Account", "Email": "anika@example.com", "Status": "ACTIVE" } ] } ``` + Consulte detalhes da API em [ListAccounts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/list-accounts.html) na *Referência de comandos da AWS CLI*. ### `list-children` O código de exemplo a seguir mostra como usar `list-children`. **AWS CLI** **Para recuperar as contas secundárias e OUs de uma OU principal ou raiz** O exemplo a seguir mostra como listar a raiz ou OU que contém a conta 444444444444: ``` aws organizations list-children --child-type ORGANIZATIONAL_UNIT --parent-id ou-examplerootid111-exampleouid111 ``` A saída mostra as duas OUs secundárias contidas pela principal: ``` { "Children": [ { "Id": "ou-examplerootid111-exampleouid111", "Type":"ORGANIZATIONAL_UNIT" }, { "Id":"ou-examplerootid111-exampleouid222", "Type":"ORGANIZATIONAL_UNIT" } ] } ``` + Para ver detalhes da API, consulte [ListChildren](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/list-children.html) na *Referência de comandos da AWS CLI*. ### `list-create-account-status` O código de exemplo a seguir mostra como usar `list-create-account-status`. **AWS CLI** **Exemplo 1: recuperar uma lista das solicitações de criação de conta feitas na organização atual** O exemplo a seguir mostra como solicitar uma lista de solicitações de criação de conta de uma organização que foram concluídas com êxito: ``` aws organizations list-create-account-status --states SUCCEEDED ``` A saída inclui uma matriz de objetos com informações sobre cada solicitação. ``` { "CreateAccountStatuses": [ { "AccountId": "444444444444", "AccountName": "Developer Test Account", "CompletedTimeStamp": 1481835812.143, "Id": "car-examplecreateaccountrequestid111", "RequestedTimeStamp": 1481829432.531, "State": "SUCCEEDED" } ] } ``` **Exemplo 2: recuperar uma lista das solicitações de criação de conta em andamento feitas na organização atual** O exemplo a seguir obtém uma lista de solicitações de criação de conta em andamento para uma organização: ``` aws organizations list-create-account-status --states IN_PROGRESS ``` A saída inclui uma matriz de objetos com informações sobre cada solicitação. ``` { "CreateAccountStatuses": [ { "State": "IN_PROGRESS", "Id": "car-examplecreateaccountrequestid111", "RequestedTimeStamp": 1481829432.531, "AccountName": "Production Account" } ] } ``` + Para ver detalhes da API, consulte [ListCreateAccountStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/list-create-account-status.html) na *Referência de comandos da AWS CLI*. ### `list-handshakes-for-account` O código de exemplo a seguir mostra como usar `list-handshakes-for-account`. **AWS CLI** **Para recuperar uma lista dos handshakes enviados para uma conta** O exemplo a seguir mostra como obter uma lista de todos os handshakes associados à conta das credenciais que foram usadas para chamar a operação: ``` aws organizations list-handshakes-for-account ``` A saída inclui uma lista de estruturas de handshake com informações sobre cada handshake, incluindo seu estado atual: ``` { "Handshake": { "Action": "INVITE", "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", "ExpirationTimestamp": 1482952459.257, "Id": "h-examplehandshakeid111", "Parties": [ { "Id": "o-exampleorgid", "Type": "ORGANIZATION" }, { "Id": "juan@example.com", "Type": "EMAIL" } ], "RequestedTimestamp": 1481656459.257, "Resources": [ { "Resources": [ { "Type": "MASTER_EMAIL", "Value": "bill@amazon.com" }, { "Type": "MASTER_NAME", "Value": "Org Master Account" }, { "Type": "ORGANIZATION_FEATURE_SET", "Value": "FULL" } ], "Type": "ORGANIZATION", "Value": "o-exampleorgid" }, { "Type": "EMAIL", "Value": "juan@example.com" } ], "State": "OPEN" } } ``` + Para ver detalhes da API, consulte [ListHandshakesForAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/list-handshakes-for-account.html) na *Referência de comandos da AWS CLI*. ### `list-handshakes-for-organization` O código de exemplo a seguir mostra como usar `list-handshakes-for-organization`. **AWS CLI** **Para recuperar uma lista dos handshakes associados a uma organização** O exemplo a seguir mostra como obter uma lista dos handshakes associados à organização atual: ``` aws organizations list-handshakes-for-organization ``` A saída mostra dois handshakes. O primeiro é um convite para a conta de Juan e mostra o estado de OPEN. O segundo é um convite para a conta de Anika e mostra o estado ACEITO: ``` { "Handshakes": [ { "Action": "INVITE", "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", "ExpirationTimestamp": 1482952459.257, "Id": "h-examplehandshakeid111", "Parties": [ { "Id": "o-exampleorgid", "Type": "ORGANIZATION" }, { "Id": "juan@example.com", "Type": "EMAIL" } ], "RequestedTimestamp": 1481656459.257, "Resources": [ { "Resources": [ { "Type": "MASTER_EMAIL", "Value": "bill@amazon.com" }, { "Type": "MASTER_NAME", "Value": "Org Master Account" }, { "Type": "ORGANIZATION_FEATURE_SET", "Value": "FULL" } ], "Type": "ORGANIZATION", "Value": "o-exampleorgid" }, { "Type": "EMAIL", "Value": "juan@example.com" }, { "Type":"NOTES", "Value":"This is an invitation to Juan's account to join Bill's organization." } ], "State": "OPEN" }, { "Action": "INVITE", "State":"ACCEPTED", "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", "ExpirationTimestamp": 1.471797437427E9, "Id": "h-examplehandshakeid222", "Parties": [ { "Id": "o-exampleorgid", "Type": "ORGANIZATION" }, { "Id": "anika@example.com", "Type": "EMAIL" } ], "RequestedTimestamp": 1.469205437427E9, "Resources": [ { "Resources": [ { "Type":"MASTER_EMAIL", "Value":"bill@example.com" }, { "Type":"MASTER_NAME", "Value":"Master Account" } ], "Type":"ORGANIZATION", "Value":"o-exampleorgid" }, { "Type":"EMAIL", "Value":"anika@example.com" }, { "Type":"NOTES", "Value":"This is an invitation to Anika's account to join Bill's organization." } ] } ] } ``` + Para ver detalhes da API, consulte [ListHandshakesForOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/list-handshakes-for-organization.html) na *Referência de comandos da AWS CLI*. ### `list-organizational-units-for-parent` O código de exemplo a seguir mostra como usar `list-organizational-units-for-parent`. **AWS CLI** **Para recuperar uma lista das OUs em uma OU principal ou raiz** O exemplo a seguir mostra como obter uma lista de OUs em uma raiz especificada: ``` aws organizations list-organizational-units-for-parent --parent-id r-examplerootid111 ``` A saída mostra que a raiz especificada contém duas OUs e mostra os detalhes de cada uma: ``` { "OrganizationalUnits": [ { "Name": "AccountingDepartment", "Arn": "arn:aws:organizations::o-exampleorgid:ou/r-examplerootid111/ou-examplerootid111-exampleouid111" }, { "Name": "ProductionDepartment", "Arn": "arn:aws:organizations::o-exampleorgid:ou/r-examplerootid111/ou-examplerootid111-exampleouid222" } ] } ``` + Para ver detalhes da API, consulte [ListOrganizationalUnitsForParent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/list-organizational-units-for-parent.html) na *Referência de comandos da AWS CLI*. ### `list-parents` O código de exemplo a seguir mostra como usar `list-parents`. **AWS CLI** **Para listar as OUs principais ou raízes de uma conta ou OU secundária** O exemplo a seguir mostra como listar a raiz ou OU principal que contém a conta 444444444444: ``` aws organizations list-parents --child-id 444444444444 ``` A saída mostra que a conta especificada está na OU com o ID especificado: ``` { "Parents": [ { "Id": "ou-examplerootid111-exampleouid111", "Type": "ORGANIZATIONAL_UNIT" } ] } ``` + Para ver detalhes da API, consulte [ListParents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/list-parents.html) na *Referência de comandos da AWS CLI*. ### `list-policies-for-target` O código de exemplo a seguir mostra como usar `list-policies-for-target`. **AWS CLI** **Para recuperar uma lista dos SCPs anexados diretamente a uma conta** O exemplo a seguir mostra como obter uma lista de todas as políticas de controle de serviços (SCPs), conforme especificado pelo parâmetro Filter, que estão diretamente anexadas a uma conta: ``` aws organizations list-policies-for-target --filter SERVICE_CONTROL_POLICY --target-id 444444444444 ``` A saída inclui uma lista de estruturas de políticas com informações resumidas. A lista não inclui políticas que se aplicam à conta devido à herança de sua localização na hierarquia de uma OU: ``` { "Policies": [ { "Type": "SERVICE_CONTROL_POLICY", "Name": "AllowAllEC2Actions", "AwsManaged", false, "Id": "p-examplepolicyid222", "Arn": "arn:aws:organizations::o-exampleorgid:policy/service_control_policy/p-examplepolicyid222", "Description": "Enables account admins to delegate permissions for any EC2 actions to users and roles in their accounts." } ] } ``` + Para ver detalhes da API, consulte [ListPoliciesForTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/list-policies-for-target.html) na *Referência de comandos da AWS CLI*. ### `list-policies` O código de exemplo a seguir mostra como usar `list-policies`. **AWS CLI** **Para recuperar uma lista de todas as políticas de um determinado tipo de uma organização** O seguinte exemplo mostra como obter uma lista de SCPs, conforme especificado pelo parâmetro do filtro: ``` aws organizations list-policies --filter SERVICE_CONTROL_POLICY ``` A saída inclui uma lista de políticas com informações resumidas: ``` { "Policies": [ { "Type": "SERVICE_CONTROL_POLICY", "Name": "AllowAllS3Actions", "AwsManaged": false, "Id": "p-examplepolicyid111", "Arn": "arn:aws:organizations::111111111111:policy/service_control_policy/p-examplepolicyid111", "Description": "Enables account admins to delegate permissions for any S3 actions to users and roles in their accounts." }, { "Type": "SERVICE_CONTROL_POLICY", "Name": "AllowAllEC2Actions", "AwsManaged": false, "Id": "p-examplepolicyid222", "Arn": "arn:aws:organizations::111111111111:policy/service_control_policy/p-examplepolicyid222", "Description": "Enables account admins to delegate permissions for any EC2 actions to users and roles in their accounts." }, { "AwsManaged": true, "Description": "Allows access to every operation", "Type": "SERVICE_CONTROL_POLICY", "Id": "p-FullAWSAccess", "Arn": "arn:aws:organizations::aws:policy/service_control_policy/p-FullAWSAccess", "Name": "FullAWSAccess" } ] } ``` + Consulte detalhes da API em [ListPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/list-policies.html) na *Referência de comandos da AWS CLI*. ### `list-roots` O código de exemplo a seguir mostra como usar `list-roots`. **AWS CLI** **Para recuperar uma lista de raízes em uma organização** Este exemplo mostra como obter a lista de raízes de uma organização: ``` aws organizations list-roots ``` A saída inclui uma lista de estruturas de raízes com informações resumidas: ``` { "Roots": [ { "Name": "Root", "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111", "Id": "r-examplerootid111", "PolicyTypes": [ { "Status":"ENABLED", "Type":"SERVICE_CONTROL_POLICY" } ] } ] } ``` + Para ver detalhes da API, consulte [ListRoots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/list-roots.html) na *Referência de comandos da AWS CLI*. ### `list-targets-for-policy` O código de exemplo a seguir mostra como usar `list-targets-for-policy`. **AWS CLI** **Para recuperar uma lista das raízes, OUs e contas às quais uma política está anexada** O exemplo a seguir mostra como obter uma lista de todas as raízes, OUs e contas às quais a política especificada está anexada: ``` aws organizations list-targets-for-policy --policy-id p-FullAWSAccess ``` A saída inclui uma lista de objetos de anexos com informações resumidas sobre raízes, OUs e contas às quais a política está anexada: ``` { "Targets": [ { "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111", "Name": "Root", "TargetId":"r-examplerootid111", "Type":"ROOT" }, { "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333;", "Name": "Developer Test Account", "TargetId": "333333333333", "Type": "ACCOUNT" }, { "Arn":"arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", "Name":"Accounting", "TargetId":"ou-examplerootid111-exampleouid111", "Type":"ORGANIZATIONAL_UNIT" } ] } ``` + Para ver detalhes da API, consulte [ListTargetsForPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/list-targets-for-policy.html) na *Referência de comandos da AWS CLI*. ### `move-account` O código de exemplo a seguir mostra como usar `move-account`. **AWS CLI** **Para mover uma conta entre raízes ou OUs** O exemplo a seguir mostra como mover a conta principal da organização da raiz para uma OU: ``` aws organizations move-account --account-id 333333333333 --source-parent-id r-examplerootid111 --destination-parent-id ou-examplerootid111-exampleouid111 ``` + Para ver detalhes da API, consulte [MoveAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/move-account.html) na *Referência de comandos da AWS CLI*. ### `remove-account-from-organization` O código de exemplo a seguir mostra como usar `remove-account-from-organization`. **AWS CLI** **Para remover uma conta de uma organização como conta principal** O exemplo a seguir mostra como remover uma conta de uma organização: ``` aws organizations remove-account-from-organization --account-id 333333333333 ``` + Para ver detalhes da API, consulte [RemoveAccountFromOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/remove-account-from-organization.html) na *Referência de comandos da AWS CLI*. ### `update-organizational-unit` O código de exemplo a seguir mostra como usar `update-organizational-unit`. **AWS CLI** **Para renomear uma OU** Este exemplo mostra como renomear uma OU: neste exemplo, a OU é renomeada para "AccountingOU": ``` aws organizations update-organizational-unit --organizational-unit-id ou-examplerootid111-exampleouid111 --name AccountingOU ``` A saída mostra o novo nome: ``` { "OrganizationalUnit": { "Id": "ou-examplerootid111-exampleouid111" "Name": "AccountingOU", "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111"" } } ``` + Para ver detalhes da API, consulte [UpdateOrganizationalUnit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/update-organizational-unit.html) na *Referência de comandos da AWS CLI*. ### `update-policy` O código de exemplo a seguir mostra como usar `update-policy`. **AWS CLI** **Exemplo 1: renomear uma política** O exemplo `update-policy` a seguir renomeia uma política e fornece uma nova descrição. ``` aws organizations update-policy \ --policy-id p-examplepolicyid111 \ --name Renamed-Policy \ --description "This description replaces the original." ``` A saída mostra o novo nome e descrição. ``` { "Policy": { "Content": "{\n \"Version\":\"2012-10-17\",\n \"Statement\":{\n \"Effect\":\"Allow\",\n \"Action\":\"ec2:*\",\n \"Resource\":\"*\"\n }\n}\n", "PolicySummary": { "Id": "p-examplepolicyid111", "AwsManaged": false, "Arn":"arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", "Description": "This description replaces the original.", "Name": "Renamed-Policy", "Type": "SERVICE_CONTROL_POLICY" } } } ``` **Exemplo 2: substituir o conteúdo de texto JSON de uma política** O exemplo a seguir mostra como substituir o texto JSON do SCP no exemplo anterior por uma nova string de texto de política JSON que permite S3 em vez de EC2: ``` aws organizations update-policy \ --policy-id p-examplepolicyid111 \ --content "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\",\"Resource\":\"*\"}}" ``` A saída mostra o novo conteúdo: ``` { "Policy": { "Content": "{ \"Version\": \"2012-10-17\", \"Statement\": { \"Effect\": \"Allow\", \"Action\": \"s3:*\", \"Resource\": \"*\" } }", "PolicySummary": { "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", "AwsManaged": false; "Description": "This description replaces the original.", "Id": "p-examplepolicyid111", "Name": "Renamed-Policy", "Type": "SERVICE_CONTROL_POLICY" } } } ``` + Para ver detalhes da API, consulte [UpdatePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/update-policy.html) na *Referência de comandos da AWS CLI*. # AWS Outposts Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o AWS Outposts. *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-outpost-instance-types` O código de exemplo a seguir mostra como usar `get-outpost-instance-types`. **AWS CLI** **Para obter os tipos de instância em seu Outpost** O exemplo `get-outpost-instance-types` a seguir obtém os tipos de instância do Outpost especificado. ``` aws outposts get-outpost-instance-types \ --outpost-id op-0ab23c4567EXAMPLE ``` Resultado: ``` { "InstanceTypes": [ { "InstanceType": "c5d.large" }, { "InstanceType": "i3en.24xlarge" }, { "InstanceType": "m5d.large" }, { "InstanceType": "r5d.large" } ], "OutpostId": "op-0ab23c4567EXAMPLE", "OutpostArn": "arn:aws:outposts:us-west-2:123456789012:outpost/op-0ab23c4567EXAMPLE" } ``` Para obter mais informações, consulte [Executar uma instância no Outpost](https://docs.aws.amazon.com/outposts/latest/userguide/launch-instance.html) no *Guia do usuário do AWS Outposts*. + Para ver detalhes da API, consulte [GetOutpostInstanceTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/outposts/get-outpost-instance-types.html) na *Referência de comandos da AWS CLI*. ### `get-outpost` O código de exemplo a seguir mostra como usar `get-outpost`. **AWS CLI** **Para obter detalhes do Outpost** O exemplo `get-outpost` a seguir exibe os detalhes do Outpost especificado. ``` aws outposts get-outpost \ --outpost-id op-0ab23c4567EXAMPLE ``` Resultado: ``` { "Outpost": { "OutpostId": "op-0ab23c4567EXAMPLE", "OwnerId": "123456789012", "OutpostArn": "arn:aws:outposts:us-west-2:123456789012:outpost/op-0ab23c4567EXAMPLE", "SiteId": "os-0ab12c3456EXAMPLE", "Name": "EXAMPLE", "LifeCycleStatus": "ACTIVE", "AvailabilityZone": "us-west-2a", "AvailabilityZoneId": "usw2-az1", "Tags": {} } } ``` Para obter mais informações, consulte [Trabalhar com Outposts](https://docs.aws.amazon.com/outposts/latest/userguide/work-with-outposts.html) no *Guia do usuário do AWS Outposts*. + Para ver detalhes da API, consulte [GetOutpost](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/outposts/get-outpost.html) na *Referência de comandos da AWS CLI*. ### `list-outposts` O código de exemplo a seguir mostra como usar `list-outposts`. **AWS CLI** **Para listar Outposts** O exemplo `list-outposts` a seguir lista os Outposts em sua conta da AWS. ``` aws outposts list-outposts ``` Resultado: ``` { "Outposts": [ { "OutpostId": "op-0ab23c4567EXAMPLE", "OwnerId": "123456789012", "OutpostArn": "arn:aws:outposts:us-west-2:123456789012:outpost/op-0ab23c4567EXAMPLE", "SiteId": "os-0ab12c3456EXAMPLE", "Name": "EXAMPLE", "Description": "example", "LifeCycleStatus": "ACTIVE", "AvailabilityZone": "us-west-2a", "AvailabilityZoneId": "usw2-az1", "Tags": { "Name": "EXAMPLE" } }, { "OutpostId": "op-4fe3dc21baEXAMPLE", "OwnerId": "123456789012", "OutpostArn": "arn:aws:outposts:us-west-2:123456789012:outpost/op-4fe3dc21baEXAMPLE", "SiteId": "os-0ab12c3456EXAMPLE", "Name": "EXAMPLE2", "LifeCycleStatus": "ACTIVE", "AvailabilityZone": "us-west-2a", "AvailabilityZoneId": "usw2-az1", "Tags": {} } ] } ``` Para obter mais informações, consulte [Trabalhar com Outposts](https://docs.aws.amazon.com/outposts/latest/userguide/work-with-outposts.html) no *Guia do usuário do AWS Outposts*. + Para ver detalhes da API, consulte [ListOutposts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/outposts/list-outposts.html) na *Referência de comandos da AWS CLI*. ### `list-sites` O código de exemplo a seguir mostra como usar `list-sites`. **AWS CLI** **Para listar sites** O exemplo `list-sites` a seguir lista os sites de Outpost disponíveis em sua conta da AWS. ``` aws outposts list-sites ``` Resultado: ``` { "Sites": [ { "SiteId": "os-0ab12c3456EXAMPLE", "AccountId": "123456789012", "Name": "EXAMPLE", "Description": "example", "Tags": {} } ] } ``` Para obter mais informações, consulte [Trabalhar com Outposts](https://docs.aws.amazon.com/outposts/latest/userguide/work-with-outposts.html) no *Guia do usuário do AWS Outposts*. + Para ver detalhes da API, consulte [ListSites](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/outposts/list-sites.html) na *Referência de comandos da AWS CLI*. # AWS Payment Cryptography Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o AWS Payment Cryptography. *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 ### `create-alias` O código de exemplo a seguir mostra como usar `create-alias`. **AWS CLI** **Para criar um alias para uma chave** O exemplo `create-alias` a seguir cria um alias para uma chave. ``` aws payment-cryptography create-alias \ --alias-name alias/sampleAlias1 \ --key-arn arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h ``` Resultado: ``` { "Alias": { "AliasName": "alias/sampleAlias1", "KeyArn": "arn:aws:payment-cryptography:us-west-2:123456789012:key/kwapwa6qaifllw2h" } } ``` Para obter mais informações, consulte [Sobre aliases](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/alias-about.html) no *Guia do usuário do AWS Payment Cryptography*. + Consulte detalhes da API em [CreateAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/create-alias.html) na *Referência de comandos da AWS CLI*. ### `create-key` O código de exemplo a seguir mostra como usar `create-key`. **AWS CLI** **Para criar uma chave** O exemplo `create-key` a seguir gera uma chave TDES 2KEY que pode ser usada para gerar e verificar valores de CVV/CVV2. ``` aws payment-cryptography create-key \ --exportable \ --key-attributes KeyAlgorithm=TDES_2KEY, KeyUsage=TR31_C0_CARD_VERIFICATION_KEY,KeyClass=SYMMETRIC_KEY, KeyModesOfUse={Generate=true,Verify=true} ``` Resultado: ``` { "Key": { "CreateTimestamp": "1686800690", "Enabled": true, "Exportable": true, "KeyArn": "arn:aws:payment-cryptography:us-west-2:123456789012:key/kwapwa6qaifllw2h", "KeyAttributes": { "KeyAlgorithm": "TDES_2KEY", "KeyClass": "SYMMETRIC_KEY", "KeyModesOfUse": { "Decrypt": false, "DeriveKey": false, "Encrypt": false, "Generate": true, "NoRestrictions": false, "Sign": false, "Unwrap": false, "Verify": true, "Wrap": false }, "KeyUsage": "TR31_C0_CARD_VERIFICATION_KEY" }, "KeyCheckValue": "F2E50F", "KeyCheckValueAlgorithm": "ANSI_X9_24", "KeyOrigin": "AWS_PAYMENT_CRYPTOGRAPHY", "KeyState": "CREATE_COMPLETE", "UsageStartTimestamp": "1686800690" } } ``` Para obter mais informações, consulte [Gerar chaves](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/create-keys.html) no *Guia do usuário do AWS Payment Cryptography*. + Consulte detalhes da API em [CreateKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/create-key.html) na *Referência de comandos da AWS CLI*. ### `delete-alias` O código de exemplo a seguir mostra como usar `delete-alias`. **AWS CLI** **Para excluir um alias** O exemplo `delete-alias` a seguir exclui um alias. Isso não afeta a chave. ``` aws payment-cryptography delete-alias \ --alias-name alias/sampleAlias1 ``` Este comando não produz saída. Para obter mais informações, consulte [Sobre aliases](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/alias-about.html) no *Guia do usuário do AWS Payment Cryptography*. + Consulte detalhes da API em [DeleteAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/delete-alias.html) na *Referência de comandos da AWS CLI*. ### `delete-key` O código de exemplo a seguir mostra como usar `delete-key`. **AWS CLI** **Para excluir uma chave** O exemplo `delete-key` a seguir programa a exclusão de uma chave para 7 dias, que é o período de espera padrão. ``` aws payment-cryptography delete-key \ --key-identifier arn:aws:payment-cryptography:us-west-2:123456789012:key/kwapwa6qaifllw2h ``` Resultado: ``` { "Key": { "CreateTimestamp": "1686801198", "DeletePendingTimestamp": "1687405998", "Enabled": true, "Exportable": true, "KeyArn": "arn:aws:payment-cryptography:us-west-2:123456789012:key/kwapwa6qaifllw2h", "KeyAttributes": { "KeyAlgorithm": "TDES_2KEY", "KeyClass": "SYMMETRIC_KEY", "KeyModesOfUse": { "Decrypt": false, "DeriveKey": false, "Encrypt": false, "Generate": true, "NoRestrictions": false, "Sign": false, "Unwrap": false, "Verify": true, "Wrap": false }, "KeyUsage": "TR31_C0_CARD_VERIFICATION_KEY" }, "KeyCheckValue": "F2E50F", "KeyCheckValueAlgorithm": "ANSI_X9_24", "KeyOrigin": "AWS_PAYMENT_CRYPTOGRAPHY", "KeyState": "DELETE_PENDING", "UsageStartTimestamp": "1686801190" } } ``` Para obter mais informações, consulte [Excluir chaves](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-deleting.html) no *Guia do usuário do AWS Payment Cryptography*. + Para ver detalhes da API, consulte [DeleteKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/delete-key.html) na *Referência de comandos da AWS CLI*. ### `export-key` O código de exemplo a seguir mostra como usar `export-key`. **AWS CLI** **Para exportar uma chave** O exemplo `export-key` a seguir exporta uma chave. ``` aws payment-cryptography export-key \ --export-key-identifier arn:aws:payment-cryptography:us-west-2:123456789012:key/lco3w6agsk7zgu2l \ --key-material '{"Tr34KeyBlock": { \ "CertificateAuthorityPublicKeyIdentifier": "arn:aws:payment-cryptography:us-west-2:123456789012:key/ftobshq7pvioc5fx", \ "ExportToken": "export-token-cu4lg26ofcziixny", \ "KeyBlockFormat": "X9_TR34_2012", \ "WrappingKeyCertificate": file://wrapping-key-certificate.pem }}' ``` Conteúdo de `wrapping-key-certificate.pem`: ``` LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUV2VENDQXFXZ0F3SUJBZ0lSQU1ZZS8xMXFUK2svVzlRUDJQOElVdWd3RFFZSktvWklodmNOQVFFTkJRQXcKZ1lreEN6QUpCZ05WQkFZVEFsVlRNUmt3RndZRFZRUUtEQkJCVjFNZ1EzSjVjSFJ2WjNKaGNHaDVNU0V3SHdZRApWUVFMREJoQlYxTWdVR0Y1YldWdWRDQkRjbmx3ZEc5bmNtRndhSGt4RVRBUEJnTlZCQWdNQ0ZacGNtZHBibWxoCk1SVXdFd1lEVlFRRERBd3dOelUxTlRZNU5UTTNOVEF4RWpBUUJnTlZCQWNNQ1VGeWJHbHVaM1J2YmpBZUZ3MHkKTXpBMk1UTXhOelV6TVROYUZ3MHlNekEyTWpBeE9EVXpNVEphTUN3eEZUQVRCZ05WQkFNTUREQTNOVFUxTmprMQpNemMxTURFVE1CRUdBMVVFQlJNS09URTFNRGMzTnpRMk9EQ0NBU0l3RFFZSktvWklodmNOQVFFQkJRQURnZ0VQCkFEQ0NBUW9DZ2dFQkFNUjZsVTZ0SFJwcWtCQmI1Z2FFa0FrbVRxNEgwNUQ2UXR2MS9WemhSaThtNVBFMjVtMFIKVnRtZmsxcUEySi94TEROTEl3dHFDR3BIVldOM0JMdFhuSmh2Y1dNNkI0QlRRVXNicENMbG9PYW1jMGF0UXRmeQo0ZUhoWHJoT2lDMFVpR05zeTc5ZlltTkZ3Q3RrSDhvZzJXTEdYNldXNSszRzlTaFZKR3dhbWpNamtlOVo1a0FhCnJKZHk4Y2tsMTFBTS8wQjVZRFR2TU5KVTcyZnVUMlJ5KzVoRmdFTE14aS8vbGE1TnFCQWp5VTY0cmV3eGdVSjAKZ1pVM3lJU2F2UjFwMElNOFNvZzdXUHlkVlNNTitZeTdLMG1OL3lFa3FZTWQxZWxvS1I0OVV3V0hvdzFMcHVzcwpzMDh5a0diWGxsMnBvZ3NvSmZZaFFGWTc4UmRsTU9vY2dOc0NBd0VBQWFOOE1Ib3dDUVlEVlIwVEJBSXdBREFmCkJnTlZIU01FR0RBV2dCU2tDVlVEZzJGZDdPZWpVSUlVRnBvbUpxWG9FREFkQmdOVkhRNEVGZ1FVZU1sRzJ5dkgKamxsQzM2OUV2U3hIcXBBODVkMHdEZ1lEVlIwUEFRSC9CQVFEQWdXZ01CMEdBMVVkSlFRV01CUUdDQ3NHQVFVRgpCd01CQmdnckJnRUZCUWNEQWpBTkJna3Foa2lHOXcwQkFRMEZBQU9DQWdFQURNS2gxbnhYWWtncVkwYmMwVjA1ClNCUTBlcm5vMmsxbXdRQnhpUDBpcUpMdWNFUnF6b0RzOTBJWTN5SjhjMkMzU2kzU1JrVzBmQUhKR0VucTlzblgKbGdGWnRBZmtNbzR4Wllpb1JGZmY1TWdSOUdNaUZNQnVQS2tIeGxKc0R2NllSbnp1Zmkza1lDT1NzeWE4U2tTMQp2M2l2UEpLcTk3aDBBaThoNFQ3clBtN0NNSnYxZ0JTUEF4UVdtdndES2RrTjFsd0VudmtGdzlLZjhqeVpaNjhGCjlmUFV4Z1RvYm1MSmNialZxaFdsQ3U1VE9mSGNPR2RLRURwZE54RE12ODNZZ1ZaWUszclc4UHVxWWIyWFdMR2IKdmFISXh2RGVnOVJwNDByVVpETGVyalptb0gwUWpEZmxCV1RYK0JqU3ZLMm5yUGpzZzJIUC91S1VncVIwQWM5eAo0UjF5YjU2cHh3eU54TUU2NmFTVWNVQ3F1WTloY1Q3eWxWNjc3REVhRHpLTG1abnpMcWdWZU5PaUtzQTMvTi9hCnI2UW56VjNabEtJbCs5aWZwNTVPaTVLMXFyWFkyeVlPL1V2SXBXZjAxcFNFUERHN0hXSllnaGorbXpDRFVkM24KdldBeHBjUXlYRGlybS8wSkRZTWtuYzhjK2Z4QmxQR3ZiT2cwWldOeVUwSVpqRmx3aDVwUnIrMnRkT3lhRkZrNApWNytmMkpRWXdKZWgzWDdQL0N6WldKMlQvbnVzaVZXd0Y2K0hueDQ2ZHVGTzhXSWJZTnJUU1hTQnFEV04vdWpZCjBwYUhwS1poUTJOVnV1M0t3a2JaTDUzRjBRM09EVjcydGtiTHJyajZvOUNGd3JGUFluV0owSWtsemN0d1VtQ24KNjd5TzlSVjVzcC83YlNxTkhYNFRuNmc9Ci0tLS0tRU5EIENFUlRJRklDQVRFEXAMPLE= ``` Resultado: ``` { "WrappedKey": { "KeyMaterial": "308205A106092A864886F70D010702A08205923082058E020101310D300B06096086480165030402013082031F06092A864886F70D010703A08203100482030C020100318201F4308201F002010030819F308189310B300906035504061302555331193017060355040A0C104157532043727970746F6772617068793121301F060355040B0C18415753205061796D656E742043727970746F6772617068793111300F06035504080C0856697267696E69613115301306035504030C0C3037353535363935333735303112301006035504070C0941726C696E67746F6E021100C61EFF5D6A4FE93F5BD40FD8FF0852E8304506092A864886F70D0101073038300D06096086480165030402010500301806092A864886F70D010108300B0609608648016503040201300D06092A864886F70D0101090400048201008B09AFE9DFF1EA4E97F8651B6B3B51A3BFF68B0365F3956AD34A64B015185BB3FFB3DC7D5812B0D21D58436EAEC131F8110389E2A9F22DA146805A4D818BDCD6AA0387284188CEF5691565A849659C117AAD0042DF5D2C290386710B58A8C63A298C99280EB75861B793302F78299DE64853433227F23DBB383A605DA23620546DCA92B2D3CD8B486339D303844D807C2D6AF17CF1ABF191F63ACFF0E0F8A91AA5B22C1A0D9EE663854D1D76CEE37FE3A0113C8577B57F173ECD69FA752A8A1AEF49AB2A62D39F091FF9AA0FD4CB695D084637DBA7EF7DA2E657BBBF0C5FCC355DB37866B7BBD5AE065DC0FD399A8E0FC19C10943D5059507DC822DED6AFA67A3082010D06092A864886F70D0107013081FF06082A864886F70D030704085050B8007C2CE5608081E8DC683EECE2BF1FC1D209D5F6642E01E58DC76FF7926B576CB6884B6723C63DDE91D8E6C75DFC4E94F1CDDA8A3E863BE8A7E1DFCD2115E251675F73388D022A28247ED66D7892AA57800750A5F84313ACC3616449A703D7DFC770F50C816F224FB038E675FB1751916699FD00585C1B2EA19FECEE696611FA65B4E8516210D884E351201A888A47D874B1ACDDF4AE7F6F59D0780A5BE3E788DD6FB4E6AC1B9D966443881E9998A625CFB10A35D943B21A3ABB902CF68AD6F7FE7B0C18FF05B94C10E254017203541AFF71E440A42C8B915A84B341F923EF657280DB7B19F769E29725FF7E5999859C318202553082025102010130819E308189310B300906035504061302555331193017060355040A0C104157532043727970746F6772617068793121301F060355040B0C18415753205061796D656E742043727970746F6772617068793111300F06035504080C0856697267696E69613115301306035504030C0C3037353535363935333735303112301006035504070C0941726C696E67746F6E02106BD452CE836B7D2A717B69DB8FAF3679300B0609608648016503040201A0818A301806092A864886F70D010903310B06092A864886F70D010703301C06092A864886F70D010905310F170D3233303631333139303234305A301F06092A864886F70D0107013112041044303131324B30544230304530303030302F06092A864886F70D010904312204209AD3A76A89E2F58433DF669174A6F4D4B6B3D60A8A7341712CB666CA6AE4125E300D06092A864886F70D0101010500048201009BA48B242A227AD05243DBB99ACF6249D626CEF086DAFD8B064592EFF1205CFE6713D5FC373D8CD53AF9A88292E143A4B9C1887792E8E7F6310503B1FD8F0F89F735DFF11CC55114859B902841E4D163D64E19DFAE0151B93590C8D770E47E939DF08242897F9319DC6AB272C26DE2ACC539BF055CE528B139D61B45542FF35D2ABDE34EEF5BE19D1C48679187B455864EDD3D976CDC80070A6A6635DF5A00AF08CBBF309C4D59A4710A531A719562D390394A736E9F2DED502B2F766BA56727DFB0C6A92FD4D2BABC69BDDBD6B17EB376FA9ADD83C2974292447E63F26D168E66A4558ED97E417BDE97837188DB4F414A2219BAC50A8D726CD54C3C1EXAMPLE", "WrappedKeyMaterialFormat": "TR34_KEY_BLOCK" } } ``` Para obter mais informações, consulte [Exportar chaves](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-export.html) no *Guia do usuário do AWS Payment Cryptography*. + Para ver detalhes da API, consulte [ExportKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/export-key.html) na *Referência de comandos da AWS CLI*. ### `get-alias` O código de exemplo a seguir mostra como usar `get-alias`. **AWS CLI** **Para obter um alias** O exemplo `get-alias` a seguir retorna o ARN da chave associada ao alias. ``` aws payment-cryptography get-alias \ --alias-name alias/sampleAlias1 ``` Resultado: ``` { "Alias": { "AliasName": "alias/sampleAlias1", "KeyArn": "arn:aws:payment-cryptography:us-west-2:123456789012:key/kwapwa6qaifllw2h" } } ``` Para obter mais informações, consulte [Sobre aliases](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/alias-about.html) no *Guia do usuário do AWS Payment Cryptography*. + Consulte detalhes da API em [GetAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/get-alias.html) na *Referência de comandos da AWS CLI*. ### `get-key` O código de exemplo a seguir mostra como usar `get-key`. **AWS CLI** **Para obter os metadados de uma chave** O exemplo `get-key` a seguir retorna os metadados da chave associada ao alias. Esta operação não apresenta material criptográfico. ``` aws payment-cryptography get-key \ --key-identifier alias/sampleAlias1 ``` Resultado: ``` { "Key": { "CreateTimestamp": "1686800690", "DeletePendingTimestamp": "1687405998", "Enabled": true, "Exportable": true, "KeyArn": "arn:aws:payment-cryptography:us-west-2:123456789012:key/kwapwa6qaifllw2h", "KeyAttributes": { "KeyAlgorithm": "TDES_2KEY", "KeyClass": "SYMMETRIC_KEY", "KeyModesOfUse": { "Decrypt": false, "DeriveKey": false, "Encrypt": false, "Generate": true, "NoRestrictions": false, "Sign": false, "Unwrap": false, "Verify": true, "Wrap": false }, "KeyUsage": "TR31_C0_CARD_VERIFICATION_KEY" }, "KeyCheckValue": "F2E50F", "KeyCheckValueAlgorithm": "ANSI_X9_24", "KeyOrigin": "AWS_PAYMENT_CRYPTOGRAPHY", "KeyState": "DELETE_PENDING", "UsageStartTimestamp": "1686801190" } } ``` Para obter mais informações, consulte [Obter chaves](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/getkeys.html) no *Guia do usuário do AWS Payment Cryptography*. + Para ver detalhes da API, consulte [GetKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/get-key.html) na *Referência de comandos da AWS CLI*. ### `get-parameters-for-export` O código de exemplo a seguir mostra como usar `get-parameters-for-export`. **AWS CLI** **Como inicializar o processo de exportação** O exemplo `get-parameters-for-export` a seguir gera um par de chaves, assina a chave e retorna o certificado e a raiz do certificado. ``` aws payment-cryptography get-parameters-for-export \ --signing-key-algorithm RSA_2048 \ --key-material-type TR34_KEY_BLOCK ``` Resultado: ``` { "ExportToken": "export-token-ep5cwyzune7oya53", "ParametersValidUntilTimestamp": "1687415640", "SigningKeyAlgorithm": "RSA_2048", "SigningKeyCertificate": "MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=", "SigningKeyCertificateChain": "NIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=" } ``` Para obter mais informações, consulte [Exportar chaves](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-export.html) no *Guia do usuário do AWS Payment Cryptography*. + Para ver detalhes da API, consulte [GetParametersForExport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/get-parameters-for-export.html) na *Referência de comandos da AWS CLI*. ### `get-parameters-for-import` O código de exemplo a seguir mostra como usar `get-parameters-for-import`. **AWS CLI** **Como inicializar o processo de importação** O exemplo `get-parameters-for-import` a seguir gera um par de chaves, assina a chave e retorna o certificado e a raiz do certificado. ``` aws payment-cryptography get-parameters-for-import \ --key-material-type TR34_KEY_BLOCK \ --wrapping-key-algorithm RSA_2048 ``` Resultado: ``` { "ImportToken": "import-token-qgmafpaa7nt2kfbb", "ParametersValidUntilTimestamp": "1687415640", "WrappingKeyAlgorithm": "RSA_2048", "WrappingKeyCertificate": "MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=", "WrappingKeyCertificateChain": "NIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=" } ``` Para obter mais informações, consulte [Importar chaves](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-import.html) no *Guia do usuário do AWS Payment Cryptography*. + Para ver detalhes da API, consulte [GetParametersForImport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/get-parameters-for-import.html) na *Referência de comandos da AWS CLI*. ### `get-public-key-certificate` O código de exemplo a seguir mostra como usar `get-public-key-certificate`. **AWS CLI** **Como retornar a chave pública** O exemplo `get-public-key-certificate` a seguir retorna a parte pública de um par de chaves. ``` aws payment-cryptography get-public-key-certificate \ --key-identifier arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h ``` Resultado: ``` { "KeyCertificate": "MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=", "KeyCertificateChain": "NIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=" } ``` Para obter mais informações, consulte [Obter a chave pública/certificado associado a um par de chaves](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys.getpubliccertificate-example.html) no *Guia do usuário do AWS Payment Cryptography*. + Para ver detalhes da API, consulte [GetPublicKeyCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/get-public-key-certificate.html) na *Referência de comandos da AWS CLI*. ### `import-key` O código de exemplo a seguir mostra como usar `import-key`. **AWS CLI** **Para importar uma chave TR-34** O exemplo `import-key` a seguir importa uma chave TR-34. ``` aws payment-cryptography import-key \ --key-material='{ "Tr34KeyBlock": {" \ CertificateAuthorityPublicKeyIdentifier": "arn:aws:payment-cryptography:us-west-2:123456789012:key/rmm5wn2q564njnjm", \ "ImportToken": "import-token-5ott6ho5nts7bbcg", \ "KeyBlockFormat": "X9_TR34_2012", \ "SigningKeyCertificate": file://signing-key-certificate.pem, \ "WrappedKeyBlock": file://wrapped-key-block.pem }}' ``` Conteúdo de `signing-key-certificate.pem`: ``` LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUV2RENDQXFTZ0F3SUJBZ0lRYWVCK25IbE1WZU1PR1ZiNjU1Q2JzREFOQmdrcWhraUc5dzBCQVEwRkFEQ0IKaVRFTE1Ba0dBMVVFQmhNQ1ZWTXhHVEFYQmdOVkJBb01FRUZYVXlCRGNubHdkRzluY21Gd2FIa3hJVEFmQmdOVgpCQXNNR0VGWFV5QlFZWGx0Wlc1MElFTnllWEIwYjJkeVlYQm9lVEVSTUE4R0ExVUVDQXdJVm1seVoybHVhV0V4CkZUQVRCZ05WQkFNTUREVXlPVEF5TnpRMU5UUTVOVEVTTUJBR0ExVUVCd3dKUVhKc2FXNW5kRzl1TUI0WERUSXoKTURZd09USXlNVEkxTUZvWERUSXpNRFl4TmpJek1USTFNRm93TERFVk1CTUdBMVVFQXd3TU5USTVNREkzTkRVMQpORGsxTVJNd0VRWURWUVFGRXdvek1EVTRNVGszTkRjNE1JSUJJakFOQmdrcWhraUc5dzBCQVFFRkFBT0NBUThBCk1JSUJDZ0tDQVFFQXdMc0dGb0pqOTVJY0UxL1p1OGZxak40SDVHTFJHVGZQSkFyWWJLbjA4WXVrQTE0SjRBSHEKWGR6ZlY5MjcvVTJZTWN2S3FsNlk5SVQwejZhTVBGbDVYemZWNU1YVW5YMlJxYTladU1ndDhGSDJJYWxsMEQ3bgo0V0RjUkg3TERQdEhXZTRaVmh3aExRVEFQa1I2dUxTWC84UDhSN2lrSWpkVkI4SytjVitnbHh0clB1Vkh5TzNxCjhXRUl3a1lYVTFDVjJybHptNklzWjcycjhPcXJWcHNiZEhERENBelJ2YUtPN3hMNU1RUGVFMFcvdkxmRGdrYmoKb2h4VHl6Z3dRSlJFK21tUXdCRmlIeXdaY2F5Y1FZdXdzTktoK0xPWXJpN0ZGM2lRRTJlYlY5Mm4zZER5NDRtcQpUSjFHUWJENndFM3ZHS0xnYXNqMVl0WVNSTk9xNld1UTV3SURBUUFCbzN3d2VqQUpCZ05WSFJNRUFqQUFNQjhHCkExVWRJd1FZTUJhQUZHMVBsWElaUGdETVU0WjVwRTc3dE8xYmV2eDVNQjBHQTFVZERnUVdCQlFwanByQXFoZGMKVmF2dElTRnBBNkswVzJMcmJUQU9CZ05WSFE4QkFmOEVCQU1DQmFBd0hRWURWUjBsQkJZd0ZBWUlLd1lCQlFVSApBd0VHQ0NzR0FRVUZCd01DTUEwR0NTcUdTSWIzRFFFQkRRVUFBNElDQVFCOXVxcFVadU1oK1kzQXhXSklNUkx5Cmlob2gvR0xIanh1aVhxK1IvdFRxbTBNYTA3R2dvbGxhRkdIZzZMei9ELy9ZRDB2UHdYc1dVOE5qY0Vib095aGcKc0hmay9hVGxjRnovZm51MVlkRUpvYUpFdW15bDkwSTBMNyswUmJNYXJScWU0bC9yQlQ4YTM3R0JyQ0x0ZUlyRgorcnp1cmovU1BDM1FiUWkvOVBzWmlieTFKMlFxTzVVRUJncEYreklaVk84dzgwMzVEK1YrUXhsY2RaUGVLS2JnCmI5WHNSeHF3cUZIVUVRM2tybXdVZUZveERlbm91QmxKMVFzOTVXUHBpVk9zYUFvbkJkYUtEbFBaRTlqdG1zZkwKMER3b1lRRy92bHdWN0pIVnNNd0dleml2VGJXaWFNdmZTTkxIMmVZMG9rblhFcHlHcmlWMjczSVFqVU1QTXBMNgpjODh3OUYzcTJnY0x6Nk0ycEFHUTZ0SVBrZ2c3aUZjbk9haGp4Ty9ORFZrS0xxbXZ0eFFlcUk2VDRveWRuWkVWCkdOMjBISStZcFVud09Eem1GL1k5TXZQQXFtdGJka2dZZGRJWExtbU9ORlF1dm4wenp0Tm01NzNTN0NSYWxCNTgKeFhyNm1iak1MQU1tcmZGQmNrU0NYaUZ6Y3gvNHJTRGJtbU9INWM0dGxiNEM3SzF5QU96NWo3OHhWOWNQOTM3SQpwczcrZUFZRkFpYTdzZGpuS3hNUDN4ZVVTM0tNS2FGMzg2TGRYbkRwdTFyczhVRWhPeDhqakt6RWplWU9qV3hLClo5Mjd1Yzd0b2kwZlcvT2tzT3NnWVlybmttSEhyd3p0NXRBc2llcjFyWXFGK2lYa1Y4TzRxSzI0bHc4cXFPanUKS3htVHMzY0NlTmdGNUZhVmhCV1Zjdz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0= ``` Conteúdo de `wrapped-key-block.pem`: ``` 3082059806092A864886F70D010702A082058930820585020101310D300B06096086480165030402013082031606092A864886F70D010703A082030704820303020100318201F3308201EF02010030819E308189310B300906035504061302555331193017060355040A0C104157532043727970746F6772617068793121301F060355040B0C18415753205061796D656E742043727970746F6772617068793111300F06035504080C0856697267696E69613115301306035504030C0C3532393032373435353439353112301006035504070C0941726C696E67746F6E021026C5E52507841B72C59D9F0065548DC1304506092A864886F70D0101073038300D06096086480165030402010500301806092A864886F70D010108300B0609608648016503040201300D06092A864886F70D01010904000482010013D3C2E9405CA45A947BA6EA098DD5A83A7E6CFF4E140B141634EBFF9E0F78057B5C22013574BA8C8D8D64B43C391E1D9CDF081B33D15CDE3AB2DB21CAE7380E64B0A09A8C45B8A0F87659638E6E30D4351E9B941EDD384183DA169ADDF71FC64E06487F8750B74B2CD3AB4F8534C024AE04BD7C070CB685A250EB2A8C1EEDEBFA387935466D152E063D3EBEDD6231216EEE5145983C74D755C050D191E6E41DC2BDB09E78CDA203C2767270E3E56C6E24EB1090904462743B054098DE278A18C71577CAE1EC13CF776055224F299DBF1BC96C11F339DEE1A2CD130A275959820FBE5C34C0CB21DB6404F868B348D5A6F8ED8E5DC5BC681F6115BA278879FF8F3082010506092A864886F70D0107013081F706082A864886F70D0307040857F8BFE99B4493AD8081E05DEE59D9E60520DB8A15869BB840F1CC908DAE6CC6F6BE79DDF72DD8EA84F881D7DFB4A186CDC622B29E3F97AEB7C00872D1BB47FE235D9204F80A4D3EF502309ECD967F8F70A2F741738ACE7B7CA0AA2EBB0DACD3126F7831F79AF6DC3C74CEBF7D0947301245F42C59508FBC0318C03F02E37EDF014C4D0170ACC4E992EC7E9B85D95BF87F75FD2E0B938E2D8E807872DE4017F8530D59A48C9F68AF5BEC1B2115D7555C248F980DF28C69619E508317F0C20461AE26CD0D55896FEE71E1EA89F7F9B5DC047F9BD063210E1F09D9566EF2AF6472AD44A8ACC0180AC1995CDE318202553082025102010130819E308189310B300906035504061302555331193017060355040A0C104157532043727970746F6772617068793121301F060355040B0C18415753205061796D656E742043727970746F6772617068793111300F06035504080C0856697267696E69613115301306035504030C0C3532393032373435353439353112301006035504070C0941726C696E67746F6E021069E07E9C794C55E30E1956FAE7909BB0300B0609608648016503040201A0818A301806092A864886F70D010903310B06092A864886F70D010703301C06092A864886F70D010905310F170D3233303630393233333934365A301F06092A864886F70D0107013112041044303131324330544330304530303030302F06092A864886F70D01090431220420D6413C502DC4552B495B9A8449F9A3BF9E6DCB31AD56A1D158DB482BDF06EEAD300D06092A864886F70D010101050004820100313BA7BCDFE6C55F3544A8E7D9973A346DDAD17CC5C506DE72B8B7E490891702E753C445FED78D5477C5E5A2BF63378B2F12CE6C22C1A543BCC41FA978568F65C0171DBF3E438E70FD68DAB52BA1DEB294C4ED92CD6EAA684B4352AF6C53924048931595FC7F1FF642E82B12DBD8B8578DA200DC0CCE2FA075897CDA6D5257C78DC2B515015CC414E78B49075AFF333C7CEAFF81F5EEC44C5C9F6BD32898E6983A7CEA40DD5C0CF9CD51DB3E712ED1C755E0A9DA38286872B46D7119088A76728DC08AECB0F624B34E15349E5B2334900E57885A6461AC6E74B35A3FFF5C010ACE5F15DE9D867A5160D30217997E7DE6319A74F5D55D44A934908A3BC1602D22 ``` Resultado: ``` { "Key": { "CreateTimestamp": "2023-06-09T16:56:27.621000-07:00", "Enabled": true, "KeyArn": "arn:aws:payment-cryptography:us-west-2:123456789012:key/bzmvgyxdg3sktwxd", "KeyAttributes": { "KeyAlgorithm": "TDES_2KEY", "KeyClass": "SYMMETRIC_KEY", "KeyModesOfUse": { "Decrypt": false, "DeriveKey": false, "Encrypt": false, "Generate": true, "NoRestrictions": false, "Sign": false, "Unwrap": false, "Verify": true, "Wrap": false }, "KeyUsage": "TR31_C0_CARD_VERIFICATION_KEY" }, "KeyCheckValue": "D9B20E", "KeyCheckValueAlgorithm": "ANSI_X9_24", "KeyOrigin": "EXTERNAL", "KeyState": "CREATE_COMPLETE", "UsageStartTimestamp": "2023-06-09T16:56:27.621000-07:00" } } ``` Para obter mais informações, consulte [Importar chaves](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-import.html) no *Guia do usuário do AWS Payment Cryptography*. + Para ver detalhes da API, consulte [ImportKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/import-key.html) na *Referência de comandos da AWS CLI*. ### `list-aliases` O código de exemplo a seguir mostra como usar `list-aliases`. **AWS CLI** **Para obter uma lista de aliases** O exemplo `list-aliases` a seguir mostra todos os aliases da sua conta nessa região. ``` aws payment-cryptography list-aliases ``` Resultado: ``` { "Aliases": [ { "AliasName": "alias/sampleAlias1", "KeyArn": "arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h" }, { "AliasName": "alias/sampleAlias2", "KeyArn": "arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h" } ] } ``` Para obter mais informações, consulte [Sobre aliases](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/alias-about.html) no *Guia do usuário do AWS Payment Cryptography*. + Consulte detalhes da API em [ListAliases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/list-aliases.html) na *Referência de comandos da AWS CLI*. ### `list-keys` O código de exemplo a seguir mostra como usar `list-keys`. **AWS CLI** **Para obter uma lista de chaves** O exemplo `list-keys` a seguir mostra todas as chaves em sua conta nessa região. ``` aws payment-cryptography list-keys ``` Resultado: ``` { "Keys": [ { "CreateTimestamp": "1666506840", "Enabled": false, "Exportable": true, "KeyArn": "arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h", "KeyAttributes": { "KeyAlgorithm": "TDES_3KEY", "KeyClass": "SYMMETRIC_KEY", "KeyModesOfUse": { "Decrypt": true, "DeriveKey": false, "Encrypt": true, "Generate": false, "NoRestrictions": false, "Sign": false, "Unwrap": true, "Verify": false, "Wrap": true }, "KeyUsage": "TR31_P1_PIN_GENERATION_KEY" }, "KeyCheckValue": "369D", "KeyCheckValueAlgorithm": "ANSI_X9_24", "KeyOrigin": "AWS_PAYMENT_CRYPTOGRAPHY", "KeyState": "CREATE_COMPLETE", "UsageStopTimestamp": "1666938840" } ] } ``` Para obter mais informações, consulte [Listar chaves](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/alias-about.html) no *Guia do usuário do AWS Payment Cryptography*. + Consulte detalhes da API em [ListKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/list-keys.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para obter a lista de tags de uma chave** O exemplo `list-tags-for-resource` a seguir obtém as tags de uma chave. ``` aws payment-cryptography list-tags-for-resource \ --resource-arn arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h ``` Resultado: ``` { "Tags": [ { "Key": "BIN", "Value": "20151120" }, { "Key": "Project", "Value": "Production" } ] } ``` Para obter mais informações, consulte [Gerenciar de tags de chave com operações de API](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/manage-tags-api.html) no *Guia do usuário do AWS Payment Cryptography*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `restore-key` O código de exemplo a seguir mostra como usar `restore-key`. **AWS CLI** **Como restaurar uma chave programada para exclusão** O exemplo `restore-key` a seguir cancela a exclusão de uma chave. ``` aws payment-cryptography restore-key \ --key-identifier arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h ``` Resultado: ``` { "Key": { "KeyArn": "arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h", "KeyAttributes": { "KeyUsage": "TR31_V2_VISA_PIN_VERIFICATION_KEY", "KeyClass": "SYMMETRIC_KEY", "KeyAlgorithm": "TDES_3KEY", "KeyModesOfUse": { "Encrypt": false, "Decrypt": false, "Wrap": false, "Unwrap": false, "Generate": true, "Sign": false, "Verify": true, "DeriveKey": false, "NoRestrictions": false } }, "KeyCheckValue": "", "KeyCheckValueAlgorithm": "ANSI_X9_24", "Enabled": false, "Exportable": true, "KeyState": "CREATE_COMPLETE", "KeyOrigin": "AWS_PAYMENT_CRYPTOGRAPHY", "CreateTimestamp": "1686800690", "UsageStopTimestamp": "1687405998" } } ``` Para obter mais informações, consulte [Excluir chaves](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-deleting.html) no *Guia do usuário do AWS Payment Cryptography*. + Para ver detalhes da API, consulte [RestoreKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/restore-key.html) na *Referência de comandos da AWS CLI*. ### `start-key-usage` O código de exemplo a seguir mostra como usar `start-key-usage`. **AWS CLI** **Como ativar uma chave** O exemplo `start-key-usage` a seguir permite que uma chave seja usada. ``` aws payment-cryptography start-key-usage \ --key-identifier arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h ``` Resultado: ``` { "Key": { "CreateTimestamp": "1686800690", "Enabled": true, "Exportable": true, "KeyArn": "arn:aws:payment-cryptography:us-east-2:111122223333:key/alsuwfxug3pgy6xh", "KeyAttributes": { "KeyAlgorithm": "TDES_3KEY", "KeyClass": "SYMMETRIC_KEY", "KeyModesOfUse": { "Decrypt": true, "DeriveKey": false, "Encrypt": true, "Generate": false, "NoRestrictions": false, "Sign": false, "Unwrap": true, "Verify": false, "Wrap": true }, "KeyUsage": "TR31_P1_PIN_GENERATION_KEY" }, "KeyCheckValue": "369D", "KeyCheckValueAlgorithm": "ANSI_X9_24", "KeyOrigin": "AWS_PAYMENT_CRYPTOGRAPHY", "KeyState": "CREATE_COMPLETE", "UsageStartTimestamp": "1686800690" } } ``` Para obter mais informações, consulte [Ativar e desativar chaves](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-enable-disable.html) no *Guia do usuário do AWS Payment Cryptography*. + Para ver detalhes da API, consulte [StartKeyUsage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/start-key-usage.html) na *Referência de comandos da AWS CLI*. ### `stop-key-usage` O código de exemplo a seguir mostra como usar `stop-key-usage`. **AWS CLI** **Como desativar uma chave** O exemplo `stop-key-usage` a seguir desativa uma chave. ``` aws payment-cryptography stop-key-usage \ --key-identifier arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h ``` Resultado: ``` { "Key": { "CreateTimestamp": "1686800690", "Enabled": true, "Exportable": true, "KeyArn": "arn:aws:payment-cryptography:us-east-2:111122223333:key/alsuwfxug3pgy6xh", "KeyAttributes": { "KeyAlgorithm": "TDES_3KEY", "KeyClass": "SYMMETRIC_KEY", "KeyModesOfUse": { "Decrypt": true, "DeriveKey": false, "Encrypt": true, "Generate": false, "NoRestrictions": false, "Sign": false, "Unwrap": true, "Verify": false, "Wrap": true }, "KeyUsage": "TR31_P1_PIN_GENERATION_KEY" }, "KeyCheckValue": "369D", "KeyCheckValueAlgorithm": "ANSI_X9_24", "KeyOrigin": "AWS_PAYMENT_CRYPTOGRAPHY", "KeyState": "CREATE_COMPLETE", "UsageStartTimestamp": "1686800690" } } ``` Para obter mais informações, consulte [Ativar e desativar chaves](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-enable-disable.html) no *Guia do usuário do AWS Payment Cryptography*. + Para ver detalhes da API, consulte [StopKeyUsage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/stop-key-usage.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Para adicionar uma tag a uma chave** O exemplo `tag-resource` a seguir adiciona uma tag a uma chave. ``` aws payment-cryptography tag-resource \ --resource-arn arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h \ --tags Key=sampleTag,Value=sampleValue ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar de tags de chaves](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/manage-tags-api.html) no *Guia do usuário do AWS Payment Cryptography*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Para remover uma tag de uma chave** O exemplo `untag-resource` a seguir remove uma tag de uma chave. ``` aws payment-cryptography untag-resource \ --resource-arn arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h \ --tag-keys sampleTag ``` Este comando não produz saída. Para obter mais informações, consulte [Gerenciar de tags de chaves](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/manage-tags-api.html) no *Guia do usuário do AWS Payment Cryptography*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-alias` O código de exemplo a seguir mostra como usar `update-alias`. **AWS CLI** **Para atualizar um alias** O exemplo `update-alias` a seguir associa o alias a uma chave diferente. ``` aws payment-cryptography update-alias \ --alias-name alias/sampleAlias1 \ --key-arn arn:aws:payment-cryptography:us-east-2:123456789012:key/tqv5yij6wtxx64pi ``` Resultado: ``` { "Alias": { "AliasName": "alias/sampleAlias1", "KeyArn": "arn:aws:payment-cryptography:us-west-2:123456789012:key/tqv5yij6wtxx64pi " } } ``` Para obter mais informações, consulte [Sobre aliases](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/alias-about.html) no *Guia do usuário do AWS Payment Cryptography*. + Consulte detalhes da API em [UpdateAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/update-alias.html) na *Referência de comandos da AWS CLI*. # Exemplos do plano de dados AWS Payment Cryptography usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o plano de dados AWS Payment Cryptography. *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 ### `decrypt-data` O código de exemplo a seguir mostra como usar `decrypt-data`. **AWS CLI** **Como descriptografar texto cifrado** O exemplo `decrypt-data` a seguir descriptografa dados de texto cifrado usando uma chave simétrica. Para essa operação, a chave deve ter `KeyModesOfUse` definido como `Decrypt` e `KeyUsage` definido como `TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY`. ``` aws payment-cryptography-data decrypt-data \ --key-identifier arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h \ --cipher-text 33612AB9D6929C3A828EB6030082B2BD \ --decryption-attributes 'Symmetric={Mode=CBC}' ``` Resultado: ``` { "KeyArn": "arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h", "KeyCheckValue": "71D7AE", "PlainText": "31323334313233343132333431323334" } ``` Para obter mais informações, consulte [Descriptografar dados](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/decrypt-data.html) no *Guia do usuário do AWSPayment Cryptography*. + Para ver detalhes da API, consulte [DecryptData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography-data/decrypt-data.html) na *Referência de comandos da AWS CLI*. ### `encrypt-data` O código de exemplo a seguir mostra como usar `encrypt-data`. **AWS CLI** **Como criptografar dados** O exemplo `encrypt-data` a seguir criptografa dados de texto simples usando uma chave simétrica. Para essa operação, a chave deve ter `KeyModesOfUse` definido como `Encrypt` e `KeyUsage` definido como `TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY`. ``` aws payment-cryptography-data encrypt-data \ --key-identifier arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h \ --plain-text 31323334313233343132333431323334 \ --encryption-attributes 'Symmetric={Mode=CBC}' ``` Resultado: ``` { "KeyArn": "arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h", "KeyCheckValue": "71D7AE", "CipherText": "33612AB9D6929C3A828EB6030082B2BD" } ``` Para obter mais informações, consulte [Criptografar dados](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/encrypt-data.html) no *Guia do usuário do AWS Payment Cryptography*. + Para ver detalhes da API, consulte [EncryptData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography-data/encrypt-data.html) na *Referência de comandos da AWS CLI*. ### `generate-card-validation-data` O código de exemplo a seguir mostra como usar `generate-card-validation-data`. **AWS CLI** **Como gerar um CVV** O exemplo `generate-card-validation-data` a seguir gera um CVV/CVV2. ``` aws payment-cryptography-data generate-card-validation-data \ --key-identifier arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h \ --primary-account-number=171234567890123 \ --generation-attributes CardVerificationValue2={CardExpiryDate=0123} ``` Resultado: ``` { "KeyArn": "arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h", "KeyCheckValue": "CADDA1", "ValidationData": "801" } ``` Para obter mais informações, consulte [Gerar dados de cartões](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/generate-card-data.html) no *Guia do usuário do AWS Payment Cryptography*. + Para ver detalhes da API, consulte [GenerateCardValidationData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography-data/generate-card-validation-data.html) na *Referência de comandos da AWS CLI*. ### `generate-mac` O código de exemplo a seguir mostra como usar `generate-mac`. **AWS CLI** **Como gerar um MAC** O exemplo `generate-card-validation-data` a seguir gera um código de autenticação de mensagens por hash (HMAC) para autenticação de dados do cartão usando o algoritmo HMAC\$1SHA256 e a chave de criptografia HMAC. A chave deve ter `KeyUsage` definido como `TR31_M7_HMAC_KEY` e `KeyModesOfUse` como `Generate`. ``` aws payment-cryptography-data generate-mac \ --key-identifier arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h \ --message-data "3b313038383439303031303733393431353d32343038323236303030373030303f33" \ --generation-attributes Algorithm=HMAC_SHA256 ``` Resultado: ``` { "KeyArn": "arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h, "KeyCheckValue": "2976E7", "Mac": "ED87F26E961C6D0DDB78DA5038AA2BDDEA0DCE03E5B5E96BDDD494F4A7AA470C" } ``` Para obter mais informações, consulte [Gerar MAC](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/generate-mac.html) no *Guia do usuário do AWS Payment Cryptography*. + Para ver detalhes da API, consulte [GenerateMac](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography-data/generate-mac.html) na *Referência de comandos da AWS CLI*. ### `generate-pin-data` O código de exemplo a seguir mostra como usar `generate-pin-data`. **AWS CLI** **Como gerar um PIN** O exemplo `generate-card-validation-data` a seguir gera um novo PIN aleatório usando o esquema de PIN Visa. ``` aws payment-cryptography-data generate-pin-data \ --generation-key-identifier arn:aws:payment-cryptography:us-east-2:111122223333:key/37y2tsl45p5zjbh2 \ --encryption-key-identifier arn:aws:payment-cryptography:us-east-2:111122223333:key/ivi5ksfsuplneuyt \ --primary-account-number 171234567890123 \ --pin-block-format ISO_FORMAT_0 \ --generation-attributes VisaPin={PinVerificationKeyIndex=1} ``` Resultado: ``` { "GenerationKeyArn": "arn:aws:payment-cryptography:us-east-2:111122223333:key/37y2tsl45p5zjbh2", "GenerationKeyCheckValue": "7F2363", "EncryptionKeyArn": "arn:aws:payment-cryptography:us-east-2:111122223333:key/ivi5ksfsuplneuyt", "EncryptionKeyCheckValue": "7CC9E2", "EncryptedPinBlock": "AC17DC148BDA645E", "PinData": { "VerificationValue": "5507" } } ``` Para obter mais informações, consulte [Gerar dados de PIN](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/generate-pin-data.html) no *Guia do usuário do AWS Payment Cryptography*. + Para ver detalhes da API, consulte [GeneratePinData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography-data/generate-pin-data.html) na *Referência de comandos da AWS CLI*. ### `re-encrypt-data` O código de exemplo a seguir mostra como usar `re-encrypt-data`. **AWS CLI** **Como recriptografar dados com uma chave diferente** O exemplo `re-encrypt-data` a seguir descriptografa o texto cifrado que foi criptografado usando uma chave simétrica AES e o recriptografa usando uma chave do tipo DUKPT (Chave Derivada Exclusiva por Transação). ``` aws payment-cryptography-data re-encrypt-data \ --incoming-key-identifier arn:aws:payment-cryptography:us-west-2:111122223333:key/hyvv7ymboitd4vfy \ --outgoing-key-identifier arn:aws:payment-cryptography:us-west-2:111122223333:key/jl6ythkcvzesbxen \ --cipher-text 4D2B0BDBA192D5AEFEAA5B3EC28E4A65383C313FFA25140101560F75FE1B99F27192A90980AB9334 \ --incoming-encryption-attributes "Dukpt={Mode=ECB,KeySerialNumber=0123456789111111}" \ --outgoing-encryption-attributes '{"Symmetric": {"Mode": "ECB"}}' ``` Resultado: ``` { "CipherText": "F94959DA30EEFF0C035483C6067667CF6796E3C1AD28C2B61F9CFEB772A8DD41C0D6822931E0D3B1", "KeyArn": "arn:aws:payment-cryptography:us-west-2:111122223333:key/jl6ythkcvzesbxen", "KeyCheckValue": "2E8CD9" } ``` Para obter mais informações, consulte [Criptografar e descriptografar dados](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops.encryptdecrypt.html) no *Guia do usuário do AWS Payment Cryptography*. + Para ver detalhes da API, consulte [ReEncryptData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography-data/re-encrypt-data.html) na *Referência de comandos da AWS CLI*. ### `translate-pin-data` O código de exemplo a seguir mostra como usar `translate-pin-data`. **AWS CLI** **Como traduzir dados de PIN** O exemplo `translate-pin-data` a seguir traduz um PIN da criptografia PEK TDES usando um bloco de PIN ISO 0 para um bloco de PIN ISO 4 AES usando o algoritmo DUKPT. ``` aws payment-cryptography-data translate-pin-data \ --encrypted-pin-block "AC17DC148BDA645E" \ --incoming-translation-attributes=IsoFormat0='{PrimaryAccountNumber=171234567890123}' \ --incoming-key-identifier arn:aws:payment-cryptography:us-east-2:111122223333:key/ivi5ksfsuplneuyt \ --outgoing-key-identifier arn:aws:payment-cryptography:us-east-2:111122223333:key/4pmyquwjs3yj4vwe \ --outgoing-translation-attributes IsoFormat4="{PrimaryAccountNumber=171234567890123}" \ --outgoing-dukpt-attributes KeySerialNumber="FFFF9876543210E00008" ``` Resultado: ``` { "PinBlock": "1F4209C670E49F83E75CC72E81B787D9", "KeyArn": "arn:aws:payment-cryptography:us-east-2:111122223333:key/ivi5ksfsuplneuyt "KeyCheckValue": "7CC9E2" } ``` Para obter mais informações, consulte [Traduzir dados de PIN](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/translate-pin-data.html) no *Guia do usuário do AWS Payment Cryptography*. + Para ver detalhes da API, consulte [TranslatePinData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography-data/translate-pin-data.html) na *Referência de comandos da AWS CLI*. ### `verify-auth-request-cryptogram` O código de exemplo a seguir mostra como usar `verify-auth-request-cryptogram`. **AWS CLI** **Como verificar uma solicitação de autenticação** O exemplo `verify-auth-request-cryptogram` a seguir verifica um criptograma de solicitação de autorização (ARQC). ``` aws payment-cryptography-data verify-auth-request-cryptogram \ --auth-request-cryptogram F6E1BD1E6037FB3E \ --auth-response-attributes '{"ArpcMethod1": {"AuthResponseCode": "1111"}}' \ --key-identifier arn:aws:payment-cryptography:us-west-2:111122223333:key/pboipdfzd4mdklya \ --major-key-derivation-mode "EMV_OPTION_A" \ --session-key-derivation-attributes '{"EmvCommon": {"ApplicationTransactionCounter": "1234","PanSequenceNumber": "01","PrimaryAccountNumber": "471234567890123"}}' \ --transaction-data "123456789ABCDEF" ``` Resultado: ``` { "AuthResponseValue": "D899B8C6FBF971AA", "KeyArn": "arn:aws:payment-cryptography:us-west-2:111122223333:key/pboipdfzd4mdklya", "KeyCheckValue": "985792" } ``` Para obter mais informações, consulte [verificar um criptograma de solicitação de autorização (ARQC)](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/data-operations.verifyauthrequestcryptogram.html) no *Guia do usuário do AWS Payment Cryptography*. + Para ver detalhes da API, consulte [VerifyAuthRequestCryptogram](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography-data/verify-auth-request-cryptogram.html) na *Referência de comandos da AWS CLI*. ### `verify-card-validation-data` O código de exemplo a seguir mostra como usar `verify-card-validation-data`. **AWS CLI** **Para validar um CVV** O exemplo `verify-card-validation-data` a seguir valida um CVV/CVV/CVV2 para um PAN. ``` aws payment-cryptography-data verify-card-validation-data \ --key-identifier arn:aws:payment-cryptography:us-east-2:111122223333:key/tqv5yij6wtxx64pi \ --primary-account-number=171234567890123 \ --verification-attributes CardVerificationValue2={CardExpiryDate=0123} \ --validation-data 801 ``` Resultado: ``` { "KeyArn": "arn:aws:payment-cryptography:us-east-2:111122223333:key/tqv5yij6wtxx64pi", "KeyCheckValue": "CADDA1" } ``` Para obter mais informações, consulte [Verificar dados de cartões](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/verify-card-data.html) no *Guia do usuário do AWS Payment Cryptography*. + Para ver detalhes da API, consulte [VerifyCardValidationData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography-data/verify-card-validation-data.html) na *Referência de comandos da AWS CLI*. ### `verify-mac` O código de exemplo a seguir mostra como usar `verify-mac`. **AWS CLI** **Como verificar um MAC** O exemplo `verify-mac` a seguir gera um código de autenticação de mensagens por hash (HMAC) para autenticação de dados do cartão usando o algoritmo HMAC\$1SHA256 e a chave de criptografia HMAC. ``` aws payment-cryptography-data verify-mac \ --key-identifier arn:aws:payment-cryptography:us-east-2:111122223333:key/qnobl5lghrzunce6 \ --message-data "3b343038383439303031303733393431353d32343038323236303030373030303f33" \ --verification-attributes='Algorithm=HMAC_SHA256' \ --mac ED87F26E961C6D0DDB78DA5038AA2BDDEA0DCE03E5B5E96BDDD494F4A7AA470C ``` Resultado: ``` { "KeyArn": "arn:aws:payment-cryptography:us-east-2:111122223333:key/qnobl5lghrzunce6, "KeyCheckValue": "2976E7", } ``` Para obter mais informações, consulte [Verificar MAC](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/verify-mac.html) no *Guia do usuário do AWS Payment Cryptography*. + Para ver detalhes da API, consulte [VerifyMac](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography-data/verify-mac.html) na *Referência de comandos da AWS CLI*. ### `verify-pin-data` O código de exemplo a seguir mostra como usar `verify-pin-data`. **AWS CLI** **Como verificar um PIN** O exemplo `verify-pin-data` a seguir valida um PIN para um PAN. ``` aws payment-cryptography-data verify-pin-data \ --verification-key-identifier arn:aws:payment-cryptography:us-east-2:111122223333:key/37y2tsl45p5zjbh2 \ --encryption-key-identifier arn:aws:payment-cryptography:us-east-2:111122223333:key/ivi5ksfsuplneuyt \ --primary-account-number 171234567890123 \ --pin-block-format ISO_FORMAT_0 \ --verification-attributes VisaPin="{PinVerificationKeyIndex=1,VerificationValue=5507}" \ --encrypted-pin-block AC17DC148BDA645E ``` Resultado: ``` { "VerificationKeyArn": "arn:aws:payment-cryptography:us-east-2:111122223333:key/37y2tsl45p5zjbh2", "VerificationKeyCheckValue": "7F2363", "EncryptionKeyArn": "arn:aws:payment-cryptography:us-east-2:111122223333:key/ivi5ksfsuplneuyt", "EncryptionKeyCheckValue": "7CC9E2", } ``` Para obter mais informações, consulte [Verificar dados de PIN](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/verify-pin-data.html) no *Guia do usuário do AWS Payment Cryptography*. + Para ver detalhes da API, consulte [VerifyPinData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography-data/verify-pin-data.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon Pinpoint usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Amazon Pinpoint. *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 ### `create-app` O código de exemplo a seguir mostra como usar `create-app`. **AWS CLI** **Exemplo 1: como criar uma aplicação** O exemplo de `create-app` a seguir cria uma aplicação (projeto). ``` aws pinpoint create-app \ --create-application-request Name=ExampleCorp ``` Resultado: ``` { "ApplicationResponse": { "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example", "Id": "810c7aab86d42fb2b56c8c966example", "Name": "ExampleCorp", "tags": {} } } ``` **Exemplo 2: como criar uma aplicação marcada** O exemplo de `create-app` a seguir cria uma aplicação (projeto) e associa uma tag (chave e valor) a ela. ``` aws pinpoint create-app \ --create-application-request Name=ExampleCorp,tags={"Stack"="Test"} ``` Resultado: ``` { "ApplicationResponse": { "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example", "Id": "810c7aab86d42fb2b56c8c966example", "Name": "ExampleCorp", "tags": { "Stack": "Test" } } } ``` + Consulte detalhes da API em [CreateApp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/create-app.html) na *Referência de comandos da AWS CLI*. ### `create-sms-template` O código de exemplo a seguir mostra como usar `create-sms-template`. **AWS CLI** **Cria um modelo de mensagem para mensagens enviadas por meio do canal SMS** O exemplo `create-sms-template` a seguir cria um modelo de mensagem SMS. ``` aws pinpoint create-sms-template \ --template-name TestTemplate \ --sms-template-request file://myfile.json \ --region us-east-1 ``` Conteúdo de `myfile.json`: ``` { "Body": "hello\n how are you?\n food is good", "TemplateDescription": "Test SMS Template" } ``` Resultado: ``` { "CreateTemplateMessageBody": { "Arn": "arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:templates/TestTemplate/SMS", "Message": "Created", "RequestID": "8c36b17f-a0b0-400f-ac21-29e9b62a975d" } } ``` Para obter mais informações, consulte [Modelos de mensagem do Amazon Pinpoint](https://docs.aws.amazon.com/pinpoint/latest/userguide/messages-templates.html) no *Guia do usuário do Amazon Pinpoint*. + Para ver detalhes da API, consulte [CreateSmsTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/create-sms-template.html) na *Referência de comandos da AWS CLI*. ### `delete-app` O código de exemplo a seguir mostra como usar `delete-app`. **AWS CLI** **Como excluir uma aplicação** O exemplo de `delete-app` a seguir exclui uma aplicação (projeto). ``` aws pinpoint delete-app \ --application-id 810c7aab86d42fb2b56c8c966example ``` Resultado: ``` { "ApplicationResponse": { "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example", "Id": "810c7aab86d42fb2b56c8c966example", "Name": "ExampleCorp", "tags": {} } } ``` + Consulte detalhes da API em [DeleteApp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/delete-app.html) na *Referência de comandos da AWS CLI*. ### `get-apns-channel` O código de exemplo a seguir mostra como usar `get-apns-channel`. **AWS CLI** **Para recuperar informações sobre o status e as configurações do canal de APNs de uma aplicação** O exemplo `get-apns-channel` a seguir recupera as informações de status e as configurações do canal de APNs de uma aplicação. ``` aws pinpoint get-apns-channel \ --application-id 9ab1068eb0a6461c86cce7f27ce0efd7 \ --region us-east-1 ``` Resultado: ``` { "APNSChannelResponse": { "ApplicationId": "9ab1068eb0a6461c86cce7f27ce0efd7", "CreationDate": "2019-05-09T21:54:45.082Z", "DefaultAuthenticationMethod": "CERTIFICATE", "Enabled": true, "HasCredential": true, "HasTokenKey": false, "Id": "apns", "IsArchived": false, "LastModifiedDate": "2019-05-09T22:04:01.067Z", "Platform": "APNS", "Version": 2 } } ``` + Para ver detalhes da API, consulte [GetApnsChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-apns-channel.html) na *Referência de comandos da AWS CLI*. ### `get-app` O código de exemplo a seguir mostra como usar `get-app`. **AWS CLI** **Para recuperar informações sobre uma aplicação (projeto)** O exemplo `get-app` a seguir recupera informações sobre uma aplicação (projeto). ``` aws pinpoint get-app \ --application-id 810c7aab86d42fb2b56c8c966example \ --region us-east-1 ``` Resultado: ``` { "ApplicationResponse": { "Arn": "arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example", "Id": "810c7aab86d42fb2b56c8c966example", "Name": "ExampleCorp", "tags": { "Year": "2019", "Stack": "Production" } } } ``` + Para ver detalhes da API, consulte [GetApp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-app.html) na *Referência de comandos da AWS CLI*. ### `get-apps` O código de exemplo a seguir mostra como usar `get-apps`. **AWS CLI** **Para recuperar informações sobre todas as aplicações** O exemplo `get-apps` a seguir recupera informações sobre todas as aplicações (projetos). ``` aws pinpoint get-apps ``` Resultado: ``` { "ApplicationsResponse": { "Item": [ { "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example", "Id": "810c7aab86d42fb2b56c8c966example", "Name": "ExampleCorp", "tags": { "Year": "2019", "Stack": "Production" } }, { "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/42d8c7eb0990a57ba1d5476a3example", "Id": "42d8c7eb0990a57ba1d5476a3example", "Name": "AnyCompany", "tags": {} }, { "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/80f5c382b638ffe5ad12376bbexample", "Id": "80f5c382b638ffe5ad12376bbexample", "Name": "ExampleCorp_Test", "tags": { "Year": "2019", "Stack": "Test" } } ], "NextToken": "eyJDcmVhdGlvbkRhdGUiOiIyMDE5LTA3LTE2VDE0OjM4OjUzLjkwM1oiLCJBY2NvdW50SWQiOiI1MTIzOTcxODM4NzciLCJBcHBJZCI6Ijk1ZTM2MGRiMzBkMjQ1ZjRiYTYwYjhlMzllMzZlNjZhIn0" } } ``` A presença do valor da `NextToken` resposta indica que há mais saída disponível. Chame o comando novamente e forneça esse valor como parâmetro de entrada de `NextToken`. + Para ver detalhes da API, consulte [GetApps](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-apps.html) na *Referência de comandos da AWS CLI*. ### `get-campaign` O código de exemplo a seguir mostra como usar `get-campaign`. **AWS CLI** **Para recuperar informações sobre o status, a configuração e outras definições de uma campanha** O exemplo `get-campaign` a seguir recupera informações sobre o status, a configuração e outras definições de uma campanha. ``` aws pinpoint get-campaign \ --application-id 6e0b7591a90841d2b5d93fa11143e5a7 \ --campaign-id a1e63c6cc0eb43ed826ffcc3cc90b30d \ --region us-east-1 ``` Resultado: ``` { "CampaignResponse": { "AdditionalTreatments": [], "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7", "Arn": "arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:apps/6e0b7591a90841d2b5d93fa11143e5a7/campaigns/a1e63c6cc0eb43ed826ffcc3cc90b30d", "CreationDate": "2019-10-08T18:40:16.581Z", "Description": " ", "HoldoutPercent": 0, "Id": "a1e63c6cc0eb43ed826ffcc3cc90b30d", "IsPaused": false, "LastModifiedDate": "2019-10-08T18:40:16.581Z", "Limits": { "Daily": 0, "MaximumDuration": 60, "MessagesPerSecond": 50, "Total": 0 }, "MessageConfiguration": { "EmailMessage": { "FromAddress": "sender@example.com", "HtmlBody": "\n \n \n \n\nHello\n", "Title": "PinpointDemo" } }, "Name": "MyCampaign", "Schedule": { "IsLocalTime": false, "StartTime": "IMMEDIATE", "Timezone": "utc" }, "SegmentId": "b66c9e42f71444b2aa2e0ffc1df28f60", "SegmentVersion": 1, "State": { "CampaignStatus": "COMPLETED" }, "tags": {}, "TemplateConfiguration": {}, "Version": 1 } } ``` + Para ver detalhes da API, consulte [GetCampaign](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-campaign.html) na *Referência de comandos da AWS CLI*. ### `get-campaigns` O código de exemplo a seguir mostra como usar `get-campaigns`. **AWS CLI** **Para recuperar informações sobre o status, a configuração e outras definições de todas as campanhas associadas a uma aplicação** O exemplo `get-campaigns` a seguir recupera informações sobre o status, a configuração e outras definições de todas as campanhas associadas a uma aplicação. ``` aws pinpoint get-campaigns \ --application-id 6e0b7591a90841d2b5d93fa11143e5a7 \ --region us-east-1 ``` Resultado: ``` { "CampaignsResponse": { "Item": [ { "AdditionalTreatments": [], "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7", "Arn": "arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:apps/6e0b7591a90841d2b5d93fa11143e5a7/campaigns/7e1280344c8f4a9aa40a00b006fe44f1", "CreationDate": "2019-10-08T18:40:22.905Z", "Description": " ", "HoldoutPercent": 0, "Id": "7e1280344c8f4a9aa40a00b006fe44f1", "IsPaused": false, "LastModifiedDate": "2019-10-08T18:40:22.905Z", "Limits": {}, "MessageConfiguration": { "EmailMessage": { "FromAddress": "sender@example.com", "HtmlBody": "\n \n \n \n\nHello\n", "Title": "PInpointDemo Test" } }, "Name": "MyCampaign1", "Schedule": { "IsLocalTime": false, "QuietTime": {}, "StartTime": "IMMEDIATE", "Timezone": "UTC" }, "SegmentId": "b66c9e42f71444b2aa2e0ffc1df28f60", "SegmentVersion": 1, "State": { "CampaignStatus": "COMPLETED" }, "tags": {}, "TemplateConfiguration": {}, "Version": 1 }, { "AdditionalTreatments": [], "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7", "Arn": "arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:apps/6e0b7591a90841d2b5d93fa11143e5a7/campaigns/a1e63c6cc0eb43ed826ffcc3cc90b30d", "CreationDate": "2019-10-08T18:40:16.581Z", "Description": " ", "HoldoutPercent": 0, "Id": "a1e63c6cc0eb43ed826ffcc3cc90b30d", "IsPaused": false, "LastModifiedDate": "2019-10-08T18:40:16.581Z", "Limits": { "Daily": 0, "MaximumDuration": 60, "MessagesPerSecond": 50, "Total": 0 }, "MessageConfiguration": { "EmailMessage": { "FromAddress": "sender@example.com", "HtmlBody": "\n \n \n \n\nDemo\n", "Title": "PinpointDemo" } }, "Name": "MyCampaign2", "Schedule": { "IsLocalTime": false, "StartTime": "IMMEDIATE", "Timezone": "utc" }, "SegmentId": "b66c9e42f71444b2aa2e0ffc1df28f60", "SegmentVersion": 1, "State": { "CampaignStatus": "COMPLETED" }, "tags": {}, "TemplateConfiguration": {}, "Version": 1 } ] } } ``` + Para ver detalhes da API, consulte [GetCampaigns](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-campaigns.html) na *Referência de comandos da AWS CLI*. ### `get-channels` O código de exemplo a seguir mostra como usar `get-channels`. **AWS CLI** **Para recuperar informações sobre o histórico e o status de cada canal de uma aplicação** O exemplo `get-channels` a seguir obtém informações sobre o histórico e o status de cada canal de uma aplicação. ``` aws pinpoint get-channels \ --application-id 6e0b7591a90841d2b5d93fa11143e5a7 \ --region us-east-1 ``` Resultado: ``` { "ChannelsResponse": { "Channels": { "GCM": { "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7", "CreationDate": "2019-10-08T18:28:23.182Z", "Enabled": true, "HasCredential": true, "Id": "gcm", "IsArchived": false, "LastModifiedDate": "2019-10-08T18:28:23.182Z", "Version": 1 }, "SMS": { "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7", "CreationDate": "2019-10-08T18:39:18.511Z", "Enabled": true, "Id": "sms", "IsArchived": false, "LastModifiedDate": "2019-10-08T18:39:18.511Z", "Version": 1 }, "EMAIL": { "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7", "CreationDate": "2019-10-08T18:27:23.990Z", "Enabled": true, "Id": "email", "IsArchived": false, "LastModifiedDate": "2019-10-08T18:27:23.990Z", "Version": 1 }, "IN_APP": { "Enabled": true, "IsArchived": false, "Version": 0 } } } } ``` + Para ver detalhes da API, consulte [GetChannels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-channels.html) na *Referência de comandos da AWS CLI*. ### `get-email-channel` O código de exemplo a seguir mostra como usar `get-email-channel`. **AWS CLI** **Para recuperar informações sobre o status e as configurações do canal de e-mail de uma aplicação** O exemplo `get-email-channel` a seguir recupera o status e as configurações do canal de e-mail de uma aplicação. ``` aws pinpoint get-email-channel \ --application-id 6e0b7591a90841d2b5d93fa11143e5a7 \ --region us-east-1 ``` Resultado: ``` { "EmailChannelResponse": { "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7", "CreationDate": "2019-10-08T18:27:23.990Z", "Enabled": true, "FromAddress": "sender@example.com", "Id": "email", "Identity": "arn:aws:ses:us-east-1:AIDACKCEVSQ6C2EXAMPLE:identity/sender@example.com", "IsArchived": false, "LastModifiedDate": "2019-10-08T18:27:23.990Z", "MessagesPerSecond": 1, "Platform": "EMAIL", "RoleArn": "arn:aws:iam::AIDACKCEVSQ6C2EXAMPLE:role/pinpoint-events", "Version": 1 } } ``` + Para ver detalhes da API, consulte [GetEmailChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-email-channel.html) na *Referência de comandos da AWS CLI*. ### `get-endpoint` O código de exemplo a seguir mostra como usar `get-endpoint`. **AWS CLI** **Para recuperar informações sobre as configurações e os atributos de um endpoint específico de uma aplicação** O exemplo de `get-endpoint` a seguir recupera informações sobre as configurações e os atributos de um endpoint específico de uma aplicação. ``` aws pinpoint get-endpoint \ --application-id 611e3e3cdd47474c9c1399a505665b91 \ --endpoint-id testendpoint \ --region us-east-1 ``` Resultado: ``` { "EndpointResponse": { "Address": "+11234567890", "ApplicationId": "611e3e3cdd47474c9c1399a505665b91", "Attributes": {}, "ChannelType": "SMS", "CohortId": "63", "CreationDate": "2019-01-28T23:55:11.534Z", "EffectiveDate": "2021-08-06T00:04:51.763Z", "EndpointStatus": "ACTIVE", "Id": "testendpoint", "Location": { "Country": "USA" }, "Metrics": { "SmsDelivered": 1.0 }, "OptOut": "ALL", "RequestId": "a204b1f2-7e26-48a7-9c80-b49a2143489d", "User": { "UserAttributes": { "Age": [ "24" ] }, "UserId": "testuser" } } } ``` + Consulte detalhes da API em [GetEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-endpoint.html) na *Referência de comandos da AWS CLI*. ### `get-gcm-channel` O código de exemplo a seguir mostra como usar `get-gcm-channel`. **AWS CLI** **Para recuperar informações sobre o status e as configurações do canal de GCM de uma aplicação** O exemplo `get-gcm-channel` a seguir recupera as informações de status e as configurações do canal de GCM de uma aplicação. ``` aws pinpoint get-gcm-channel \ --application-id 6e0b7591a90841d2b5d93fa11143e5a7 \ --region us-east-1 ``` Resultado: ``` { "GCMChannelResponse": { "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7", "CreationDate": "2019-10-08T18:28:23.182Z", "Enabled": true, "HasCredential": true, "Id": "gcm", "IsArchived": false, "LastModifiedDate": "2019-10-08T18:28:23.182Z", "Platform": "GCM", "Version": 1 } } ``` + Para ver detalhes da API, consulte [GetGcmChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-gcm-channel.html) na *Referência de comandos da AWS CLI*. ### `get-sms-channel` O código de exemplo a seguir mostra como usar `get-sms-channel`. **AWS CLI** **Para recuperar informações sobre o status e as configurações do canal de SMS de uma aplicação** O exemplo de `get-sms-channel` a seguir recupera o status e as configurações do canal de SMS de uma aplicação. ``` aws pinpoint get-sms-channel \ --application-id 6e0b7591a90841d2b5d93fa11143e5a7 \ --region us-east-1 ``` Resultado: ``` { "SMSChannelResponse": { "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7", "CreationDate": "2019-10-08T18:39:18.511Z", "Enabled": true, "Id": "sms", "IsArchived": false, "LastModifiedDate": "2019-10-08T18:39:18.511Z", "Platform": "SMS", "PromotionalMessagesPerSecond": 20, "TransactionalMessagesPerSecond": 20, "Version": 1 } } ``` + Consulte detalhes da API em [GetSmsChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-sms-channel.html) na *Referência de comandos da AWS CLI*. ### `get-sms-template` O código de exemplo a seguir mostra como usar `get-sms-template`. **AWS CLI** **Recupera o conteúdo e as configurações de um modelo de mensagem para mensagens enviadas pelo canal SMS** O exemplo `get-sms-template` a seguir recupera o conteúdo e as configurações de um modelo de mensagem SMS. ``` aws pinpoint get-sms-template \ --template-name TestTemplate \ --region us-east-1 ``` Resultado: ``` { "SMSTemplateResponse": { "Arn": "arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:templates/TestTemplate/SMS", "Body": "hello\n how are you?\n food is good", "CreationDate": "2023-06-20T21:37:30.124Z", "LastModifiedDate": "2023-06-20T21:37:30.124Z", "tags": {}, "TemplateDescription": "Test SMS Template", "TemplateName": "TestTemplate", "TemplateType": "SMS", "Version": "1" } } ``` Para obter mais informações, consulte [Modelos de mensagem do Amazon Pinpoint](https://docs.aws.amazon.com/pinpoint/latest/userguide/messages-templates.html) no *Guia do usuário do Amazon Pinpoint*. + Para ver detalhes da API, consulte [GetSmsTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-sms-template.html) na *Referência de comandos da AWS CLI*. ### `get-voice-channel` O código de exemplo a seguir mostra como usar `get-voice-channel`. **AWS CLI** **Para obter informações sobre o status e as configurações do canal de voz de uma aplicação** O exemplo `get-voice-channel` a seguir recupera o status e as configurações do canal de voz de uma aplicação. ``` aws pinpoint get-voice-channel \ --application-id 6e0b7591a90841d2b5d93fa11143e5a7 \ --region us-east-1 ``` Resultado: ``` { "VoiceChannelResponse": { "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7", "CreationDate": "2022-04-28T00:17:03.836Z", "Enabled": true, "Id": "voice", "IsArchived": false, "LastModifiedDate": "2022-04-28T00:17:03.836Z", "Platform": "VOICE", "Version": 1 } } ``` + Para ver detalhes da API, consulte [GetVoiceChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-voice-channel.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Para recuperar uma lista de tags de um recurso** O exemplo `list-tags-for-resource` a seguir recupera todas as tags (nomes e valores de chave) associadas ao recurso especificado. ``` aws pinpoint list-tags-for-resource \ --resource-arn arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example ``` Resultado: ``` { "TagsModel": { "tags": { "Year": "2019", "Stack": "Production" } } } ``` Para obter mais informações, consulte "Adicionar tags a recursos do Amazon Pinpoint '\$1\$1 no *Guia do desenvolvedor do Amazon Pinpoint*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `phone-number-validate` O código de exemplo a seguir mostra como usar `phone-number-validate`. **AWS CLI** **Recupera informações sobre um número de telefone** O exemplo `phone-number-validate` a seguir recupera informações sobre um número de telefone. ``` aws pinpoint phone-number-validate \ --number-validate-request PhoneNumber="+12065550142" \ --region us-east-1 ``` Resultado: ``` { "NumberValidateResponse": { "Carrier": "ExampleCorp Mobile", "City": "Seattle", "CleansedPhoneNumberE164": "+12065550142", "CleansedPhoneNumberNational": "2065550142", "Country": "United States", "CountryCodeIso2": "US", "CountryCodeNumeric": "1", "OriginalPhoneNumber": "+12065550142", "PhoneType": "MOBILE", "PhoneTypeCode": 0, "Timezone": "America/Los_Angeles", "ZipCode": "98101" } } ``` Para obter mais informações, consulte [Canal de SMS do Amazon Pinpoint](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms.html) no *Guia do usuário do Amazon Pinpoint*. + Para ver detalhes da API, consulte [PhoneNumberValidate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/phone-number-validate.html) na *Referência de comandos da AWS CLI*. ### `send-messages` O código de exemplo a seguir mostra como usar `send-messages`. **AWS CLI** **Como enviar uma mensagem SMS usando o endpoint de uma aplicação** O exemplo de `send-messages` a seguir envia uma mensagem direta a uma aplicação com um endpoint. ``` aws pinpoint send-messages \ --application-id 611e3e3cdd47474c9c1399a505665b91 \ --message-request file://myfile.json \ --region us-west-2 ``` Conteúdo de `myfile.json`: ``` { "MessageConfiguration": { "SMSMessage": { "Body": "hello, how are you?" } }, "Endpoints": { "testendpoint": {} } } ``` Resultado: ``` { "MessageResponse": { "ApplicationId": "611e3e3cdd47474c9c1399a505665b91", "EndpointResult": { "testendpoint": { "Address": "+12345678900", "DeliveryStatus": "SUCCESSFUL", "MessageId": "itnuqhai5alf1n6ahv3udc05n7hhddr6gb3lq6g0", "StatusCode": 200, "StatusMessage": "MessageId: itnuqhai5alf1n6ahv3udc05n7hhddr6gb3lq6g0" } }, "RequestId": "c7e23264-04b2-4a46-b800-d24923f74753" } } ``` Para obter mais informações, consulte [Canal de SMS do Amazon Pinpoint](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms.html) no *Guia do usuário do Amazon Pinpoint*. + Consulte detalhes da API em [SendMessages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/send-messages.html) na *Referência de comandos da AWS CLI*. ### `send-users-messages` O código de exemplo a seguir mostra como usar `send-users-messages`. **AWS CLI** **Como enviar uma mensagem SMS para um usuário de uma aplicação** O exemplo `send-users-messages` a seguir envia uma mensagem direta a um usuário de uma aplicação. ``` aws pinpoint send-users-messages \ --application-id 611e3e3cdd47474c9c1399a505665b91 \ --send-users-message-request file://myfile.json \ --region us-west-2 ``` Conteúdo de `myfile.json`: ``` { "MessageConfiguration": { "SMSMessage": { "Body": "hello, how are you?" } }, "Users": { "testuser": {} } } ``` Resultado: ``` { "SendUsersMessageResponse": { "ApplicationId": "611e3e3cdd47474c9c1399a505665b91", "RequestId": "e0b12cf5-2359-11e9-bb0b-d5fb91876b25", "Result": { "testuser": { "testuserendpoint": { "DeliveryStatus": "SUCCESSFUL", "MessageId": "7qu4hk5bqhda3i7i2n4pjf98qcuh8b7p45ifsmo0", "StatusCode": 200, "StatusMessage": "MessageId: 7qu4hk5bqhda3i7i2n4pjf98qcuh8b7p45ifsmo0", "Address": "+12345678900" } } } } } ``` Para obter mais informações, consulte [Canal de SMS do Amazon Pinpoint](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms.html) no *Guia do usuário do Amazon Pinpoint*. + Para ver detalhes da API, consulte [SendUsersMessages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/send-users-messages.html) na *Referência de comandos da AWS CLI*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Para adicionar tags a um recurso** O exemplo a seguir adiciona duas tags (nomes e valores de chave) a um recurso. ``` aws pinpoint list-tags-for-resource \ --resource-arn arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example \ --tags-model tags={Stack=Production,Year=2019} ``` Este comando não produz saída. Para obter mais informações, consulte "Adicionar tags a recursos do Amazon Pinpoint '\$1\$1 no *Guia do desenvolvedor do Amazon Pinpoint*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Exemplo 1: remover uma tag de um recurso** O exemplo `untag-resource` a seguir remove a tag especificada (nome e valor de chave) de um recurso. ``` aws pinpoint untag-resource \ --resource-arn arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example \ --tag-keys Year ``` Este comando não produz saída. **Exemplo 2: remover várias tags de um recurso** O exemplo `untag-resource` a seguir remove as tag especificadas (nomes e valores de chave) de um recurso. ``` aws pinpoint untag-resource \ --resource-arn arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example \ --tag-keys Year Stack ``` Este comando não produz saída. Para obter mais informações, consulte "Adicionar tags a recursos do Amazon Pinpoint '\$1\$1 no *Guia do desenvolvedor do Amazon Pinpoint*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/untag-resource.html) na *Referência de comandos da AWS CLI*. ### `update-sms-channel` O código de exemplo a seguir mostra como usar `update-sms-channel`. **AWS CLI** **Como ativar o canal SMS ou atualizar o status e as configurações do canal de SMS de uma aplicação.** O exemplo `update-sms-channel` a seguir ativa o canal SMS para um canal SMS de uma aplicação. ``` aws pinpoint update-sms-channel \ --application-id 611e3e3cdd47474c9c1399a505665b91 \ --sms-channel-request Enabled=true \ --region us-west-2 ``` Resultado: ``` { "SMSChannelResponse": { "ApplicationId": "611e3e3cdd47474c9c1399a505665b91", "CreationDate": "2019-01-28T23:25:25.224Z", "Enabled": true, "Id": "sms", "IsArchived": false, "LastModifiedDate": "2023-05-18T23:22:50.977Z", "Platform": "SMS", "PromotionalMessagesPerSecond": 20, "TransactionalMessagesPerSecond": 20, "Version": 3 } } ``` Para obter mais informações, consulte [Canal de SMS do Amazon Pinpoint](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms.html) no *Guia do usuário do Amazon Pinpoint*. + Para ver detalhes da API, consulte [UpdateSmsChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/update-sms-channel.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon Polly usando o AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Amazon Polly. *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 ### `delete-lexicon` O código de exemplo a seguir mostra como usar `delete-lexicon`. **AWS CLI** **Como excluir um léxico** O exemplo de `delete-lexicon` a seguir exclui o léxico especificado. ``` aws polly delete-lexicon \ --name w3c ``` Este comando não produz saída. Para obter mais informações, consulte [Uso da operação DeleteLexicon](https://docs.aws.amazon.com/polly/latest/dg/gs-delete-lexicon.html) no *Guia do desenvolvedor do Amazon Polly*. + Consulte detalhes da API em [DeleteLexicon](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/polly/delete-lexicon.html) na *Referência de comandos da AWS CLI*. ### `get-lexicon` O código de exemplo a seguir mostra como usar `get-lexicon`. **AWS CLI** **Para recuperar o conteúdo de um léxico** O exemplo de `get-lexicon` a seguir recupera o conteúdo do léxico de pronúncia especificado. ``` aws polly get-lexicon \ --name w3c ``` Resultado: ``` { "Lexicon": { "Content": "\n\n \n W3C\n World Wide Web Consortium\n \n\n", "Name": "w3c" }, "LexiconAttributes": { "Alphabet": "ipa", "LanguageCode": "en-US", "LastModified": 1603908910.99, "LexiconArn": "arn:aws:polly:us-west-2:880185128111:lexicon/w3c", "LexemesCount": 1, "Size": 492 } } ``` Para obter mais informações, consulte [Usando a operação GetLexicon](https://docs.aws.amazon.com/polly/latest/dg/gs-get-lexicon.html) no *Guia do desenvolvedor do Amazon Polly*. + Consulte detalhes da API em [GetLexicon](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/polly/get-lexicon.html) na *Referência de comandos da AWS CLI*. ### `get-speech-synthesis-task` O código de exemplo a seguir mostra como usar `get-speech-synthesis-task`. **AWS CLI** **Como obter informações sobre uma tarefa de síntese de fala** O exemplo de `get-speech-synthesis-task` a seguir recupera informações sobre a tarefa de síntese de fala especificada. ``` aws polly get-speech-synthesis-task \ --task-id 70b61c0f-57ce-4715-a247-cae8729dcce9 ``` Resultado: ``` { "SynthesisTask": { "TaskId": "70b61c0f-57ce-4715-a247-cae8729dcce9", "TaskStatus": "completed", "OutputUri": "https://s3.us-west-2.amazonaws.com/amzn-s3-demo-bucket/70b61c0f-57ce-4715-a247-cae8729dcce9.mp3", "CreationTime": 1603911042.689, "RequestCharacters": 1311, "OutputFormat": "mp3", "TextType": "text", "VoiceId": "Joanna" } } ``` Para obter mais informações, consulte [Criar arquivos de áudio longos](https://docs.aws.amazon.com/polly/latest/dg/longer-cli.html) no *Guia do desenvolvedor do Amazon Polly*. + Consulte detalhes da API em [GetSpeechSynthesisTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/polly/get-speech-synthesis-task.html) na *Referência de comandos da AWS CLI*. ### `list-lexicons` O código de exemplo a seguir mostra como usar `list-lexicons`. **AWS CLI** **Para listar os léxicos** O exemplo de `list-lexicons` a seguir lista os léxicos de pronúncia. ``` aws polly list-lexicons ``` Resultado: ``` { "Lexicons": [ { "Name": "w3c", "Attributes": { "Alphabet": "ipa", "LanguageCode": "en-US", "LastModified": 1603908910.99, "LexiconArn": "arn:aws:polly:us-east-2:123456789012:lexicon/w3c", "LexemesCount": 1, "Size": 492 } } ] } ``` Para obter mais informações, consulte [Uso das operações ListLexicons](https://docs.aws.amazon.com/polly/latest/dg/gs-list-lexicons.html) no *Guia do desenvolvedor do Amazon Polly*. + Consulte detalhes da API em [ListLexicons](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/polly/list-lexicons.html) na *Referência de comandos da AWS CLI*. ### `list-speech-synthesis-tasks` O código de exemplo a seguir mostra como usar `list-speech-synthesis-tasks`. **AWS CLI** **Para listar suas tarefas de síntese de fala** O exemplo `list-speech-synthesis-tasks` a seguir lista suas tarefas de síntese de fala. ``` aws polly list-speech-synthesis-tasks ``` Resultado: ``` { "SynthesisTasks": [ { "TaskId": "70b61c0f-57ce-4715-a247-cae8729dcce9", "TaskStatus": "completed", "OutputUri": "https://s3.us-west-2.amazonaws.com/amzn-s3-demo-bucket/70b61c0f-57ce-4715-a247-cae8729dcce9.mp3", "CreationTime": 1603911042.689, "RequestCharacters": 1311, "OutputFormat": "mp3", "TextType": "text", "VoiceId": "Joanna" } ] } ``` Para obter mais informações, consulte [Criar arquivos de áudio longos](https://docs.aws.amazon.com/polly/latest/dg/longer-cli.html) no *Guia do desenvolvedor do Amazon Polly*. + Para ver detalhes da API, consulte [ListSpeechSynthesisTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/polly/list-speech-synthesis-tasks.html) na *Referência de comandos da AWS CLI*. ### `put-lexicon` O código de exemplo a seguir mostra como usar `put-lexicon`. **AWS CLI** **Como armazenar um léxico** O exemplo de `put-lexicon` a seguir armazena o léxico de pronúncia especificado. O arquivo `example.pls` especifica um léxico compatível com o PLS do W3C. ``` aws polly put-lexicon \ --name w3c \ --content file://example.pls ``` Conteúdo de `example.pls` ``` { W3C World Wide Web Consortium } ``` Este comando não produz saída. Para obter mais informações, consulte [Uso da operação PutLexicon](https://docs.aws.amazon.com/polly/latest/dg/gs-put-lexicon.html) no *Guia do desenvolvedor do Amazon Polly*. + Consulte detalhes da API em [PutLexicon](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/polly/put-lexicon.html) na *Referência de comandos da AWS CLI*. ### `start-speech-synthesis-task` O código de exemplo a seguir mostra como usar `start-speech-synthesis-task`. **AWS CLI** **Como sintetizar texto** O exemplo de `start-speech-synthesis-task` a seguir sintetiza o texto em `text_file.txt` e armazena o arquivo MP3 resultante no bucket especificado. ``` aws polly start-speech-synthesis-task \ --output-format mp3 \ --output-s3-bucket-name amzn-s3-demo-bucket \ --text file://text_file.txt \ --voice-id Joanna ``` Resultado: ``` { "SynthesisTask": { "TaskId": "70b61c0f-57ce-4715-a247-cae8729dcce9", "TaskStatus": "scheduled", "OutputUri": "https://s3.us-east-2.amazonaws.com/amzn-s3-demo-bucket/70b61c0f-57ce-4715-a247-cae8729dcce9.mp3", "CreationTime": 1603911042.689, "RequestCharacters": 1311, "OutputFormat": "mp3", "TextType": "text", "VoiceId": "Joanna" } } ``` Para obter mais informações, consulte [Criar arquivos de áudio longos](https://docs.aws.amazon.com/polly/latest/dg/longer-cli.html) no *Guia do desenvolvedor do Amazon Polly*. + Consulte detalhes da API em [StartSpeechSynthesisTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/polly/start-speech-synthesis-task.html) na *Referência de comandos da AWS CLI*. # AWS Price List Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o 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 ### `describe-services` O código de exemplo a seguir mostra como usar `describe-services`. **AWS CLI** **Para recuperar metadados do serviço** Este exemplo recupera os metadados do código de serviço do Amazon EC2. Comando: ``` aws pricing describe-services --service-code AmazonEC2 --format-version aws_v1 --max-items 1 ``` Resultado: ``` { "Services": [ { "ServiceCode": "AmazonEC2", "AttributeNames": [ "volumeType", "maxIopsvolume", "instance", "instanceCapacity10xlarge", "locationType", "instanceFamily", "operatingSystem", "clockSpeed", "LeaseContractLength", "ecu", "networkPerformance", "instanceCapacity8xlarge", "group", "maxThroughputvolume", "gpuMemory", "ebsOptimized", "elasticGpuType", "maxVolumeSize", "gpu", "processorFeatures", "intelAvxAvailable", "instanceCapacity4xlarge", "servicecode", "groupDescription", "processorArchitecture", "physicalCores", "productFamily", "enhancedNetworkingSupported", "intelTurboAvailable", "memory", "dedicatedEbsThroughput", "vcpu", "OfferingClass", "instanceCapacityLarge", "capacitystatus", "termType", "storage", "intelAvx2Available", "storageMedia", "physicalProcessor", "provisioned", "servicename", "PurchaseOption", "instanceCapacity18xlarge", "instanceType", "tenancy", "usagetype", "normalizationSizeFactor", "instanceCapacity2xlarge", "instanceCapacity16xlarge", "maxIopsBurstPerformance", "instanceCapacity12xlarge", "instanceCapacity32xlarge", "instanceCapacityXlarge", "licenseModel", "currentGeneration", "preInstalledSw", "location", "instanceCapacity24xlarge", "instanceCapacity9xlarge", "instanceCapacityMedium", "operation" ] } ], "FormatVersion": "aws_v1" } ``` + Consulte detalhes da API em [DescribeServices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pricing/describe-services.html) na *Referência de comandos da AWS CLI*. ### `get-attribute-values` O código de exemplo a seguir mostra como usar `get-attribute-values`. **AWS CLI** **Para recuperar uma lista de valores de atributos** O exemplo `get-attribute-values` a seguir recupera uma lista de valores disponíveis para o atributo especificado. ``` aws pricing get-attribute-values \ --service-code AmazonEC2 \ --attribute-name volumeType \ --max-items 2 ``` Resultado: ``` { "NextToken": "eyJOZXh0VG9rZW4iOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==", "AttributeValues": [ { "Value": "Cold HDD" }, { "Value": "General Purpose" } ] } ``` + Para ver detalhes da API, consulte [GetAttributeValues](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pricing/get-attribute-values.html) na *Referência de comandos da AWS CLI*. ### `get-products` O código de exemplo a seguir mostra como usar `get-products`. **AWS CLI** **Para recuperar uma lista de produtos** Este exemplo recupera uma lista de produtos que correspondem aos critérios fornecidos. Comando: ``` aws pricing get-products --filters file://filters.json --format-version aws_v1 --max-results 1 --service-code AmazonEC2 ``` filters.json: ``` [ { "Type": "TERM_MATCH", "Field": "ServiceCode", "Value": "AmazonEC2" }, { "Type": "TERM_MATCH", "Field": "volumeType", "Value": "Provisioned IOPS" } ] ``` Resultado: ``` { "FormatVersion": "aws_v1", "NextToken": "WGDY7ko8fQXdlaUZVdasFQ==:RVSagyIFn770XQOzdUIcO9BY6ucBG9itXAZGZF/zioUzOsUKh6PCcPWaOyPZRiMePb986TeoKYB9l55fw/CyoMq5ymnGmT1Vj39TljbbAlhcqnVfTmPIilx8Uy5bdDaBYy/e/2Ofw9Edzsykbs8LTBuNbiDQ+BBds5yeI9AQkUepruKk3aEahFPxJ55kx/zk", "PriceList": [ "{\"product\":{\"productFamily\":\"Storage\",\"attributes\":{\"storageMedia\":\"SSD-backed\",\"maxThroughputvolume\":\"320 MB/sec\",\"volumeType\":\"Provisioned IOPS\",\"maxIopsvolume\":\"20000\",\"servicecode\":\"AmazonEC2\",\"usagetype\":\"APS1-EBS:VolumeUsage.piops\",\"locationType\":\"AWS Region\",\"location\":\"Asia Pacific (Singapore)\",\"servicename\":\"Amazon Elastic Compute Cloud\",\"maxVolumeSize\":\"16 TiB\",\"operation\":\"\"},\"sku\":\"3MKHN58N7RDDVGKJ\"},\"serviceCode\":\"AmazonEC2\",\"terms\":{\"OnDemand\":{\"3MKHN58N7RDDVGKJ.JRTCKXETXF\":{\"priceDimensions\":{\"3MKHN58N7RDDVGKJ.JRTCKXETXF.6YS6EN2CT7\":{\"unit\":\"GB-Mo\",\"endRange\":\"Inf\",\"description\":\"$0.138 per GB-month of Provisioned IOPS SSD (io1) provisioned storage - Asia Pacific (Singapore)\",\"appliesTo\":[],\"rateCode\":\"3MKHN58N7RDDVGKJ.JRTCKXETXF.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.1380000000\"}}},\"sku\":\"3MKHN58N7RDDVGKJ\",\"effectiveDate\":\"2018-08-01T00:00:00Z\",\"offerTermCode\":\"JRTCKXETXF\",\"termAttributes\":{}}}},\"version\":\"20180808005701\",\"publicationDate\":\"2018-08-08T00:57:01Z\"}" ] } ``` + Para ver detalhes da API, consulte [GetProducts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pricing/get-products.html) na *Referência de comandos da AWS CLI*. # CA Privada da AWS Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o CA Privada da AWS. *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 ### `create-certificate-authority-audit-report` O código de exemplo a seguir mostra como usar `create-certificate-authority-audit-report`. **AWS CLI** **Para criar um relatório de auditoria da autoridade de certificação** O comando `create-certificate-authority-audit-report` a seguir cria um relatório de auditoria para a autoridade de certificação privada identificada pelo ARN. ``` aws acm-pca create-certificate-authority-audit-report --certificate-authority-arn arn:aws:acm-pca:us-east-1:accountid:certificate-authority/12345678-1234-1234-1234-123456789012 --s3-bucket-name your-bucket-name --audit-report-response-format JSON ``` + Para ver detalhes da API, consulte [CreateCertificateAuthorityAuditReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/create-certificate-authority-audit-report.html) na *Referência de comandos da AWS CLI*. ### `create-certificate-authority` O código de exemplo a seguir mostra como usar `create-certificate-authority`. **AWS CLI** **Para criar uma autoridade de certificação privada** O comando `create-certificate-authority` a seguir cria uma autoridade de certificação privada em sua conta da AWS. ``` aws acm-pca create-certificate-authority --certificate-authority-configuration file://C:\ca_config.txt --revocation-configuration file://C:\revoke_config.txt --certificate-authority-type "SUBORDINATE" --idempotency-token 98256344 ``` + Para ver detalhes da API, consulte [CreateCertificateAuthority](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/create-certificate-authority.html) na *Referência de comandos da AWS CLI*. ### `delete-certificate-authority` O código de exemplo a seguir mostra como usar `delete-certificate-authority`. **AWS CLI** **Para excluir uma autoridade de certificação privada** O comando `delete-certificate-authority` a seguir exclui a autoridade de certificação identificada pelo ARN. ``` aws acm-pca delete-certificate-authority --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 ``` + Para ver detalhes da API, consulte [DeleteCertificateAuthority](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/delete-certificate-authority.html) na *Referência de comandos da AWS CLI*. ### `describe-certificate-authority-audit-report` O código de exemplo a seguir mostra como usar `describe-certificate-authority-audit-report`. **AWS CLI** **Para descrever um relatório de auditoria para uma autoridade de certificação** O comando `describe-certificate-authority-audit-report` a seguir lista informações sobre o relatório de auditoria especificado para a autoridade de certificação identificado pelo ARN. ``` aws acm-pca describe-certificate-authority-audit-report --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/99999999-8888-7777-6666-555555555555 --audit-report-id 11111111-2222-3333-4444-555555555555 ``` + Para ver detalhes da API, consulte [DescribeCertificateAuthorityAuditReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/describe-certificate-authority-audit-report.html) na *Referência de comandos da AWS CLI*. ### `describe-certificate-authority` O código de exemplo a seguir mostra como usar `describe-certificate-authority`. **AWS CLI** **Para descrever uma autoridade de certificação privada** O comando `describe-certificate-authority` a seguir lista informações sobre a autoridade de certificação privada identificada pelo ARN. ``` aws acm-pca describe-certificate-authority --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 ``` + Para ver detalhes da API, consulte [DescribeCertificateAuthority](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/describe-certificate-authority.html) na *Referência de comandos da AWS CLI*. ### `get-certificate-authority-certificate` O código de exemplo a seguir mostra como usar `get-certificate-authority-certificate`. **AWS CLI** **Para recuperar um certificado de autoridade de certificação (CA)** O comando `get-certificate-authority-certificate` a seguir recupera o certificado e a cadeia de certificados para a autoridade de certificação especificada pelo ARN. ``` aws acm-pca get-certificate-authority-certificate --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 --output text ``` + Para ver detalhes da API, consulte [GetCertificateAuthorityCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/get-certificate-authority-certificate.html) na *Referência de comandos da AWS CLI*. ### `get-certificate-authority-csr` O código de exemplo a seguir mostra como usar `get-certificate-authority-csr`. **AWS CLI** **Para recuperar a solicitação de assinatura de certificado para uma autoridade de certificação** O comando `get-certificate-authority-csr` a seguir recupera a solicitação de assinatura de certificado da autoridade de certificação privada especificada pelo ARN. ``` aws acm-pca get-certificate-authority-csr --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 --output text ``` + Consulte detalhes da API em [GetCertificateAuthorityCsr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/get-certificate-authority-csr.html) na *Referência de comandos da AWS CLI*. ### `get-certificate` O código de exemplo a seguir mostra como usar `get-certificate`. **AWS CLI** **Para recuperar um certificado emitido** O exemplo `get-certificate` a seguir recupera um certificado da CA privada especificada. ``` aws acm-pca get-certificate \ --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 \ --certificate-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/6707447683a9b7f4055627ffd55cebcc \ --output text ``` Resultado: ``` -----BEGIN CERTIFICATE----- MIIEDzCCAvegAwIBAgIRAJuJ8f6ZVYL7gG/rS3qvrZMwDQYJKoZIhvcNAQELBQAw cTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCldhc2hpbmd0b24xEDAOBgNVBAcMB1Nl ....certificate body truncated for brevity.... tKCSglgZZrd4FdLw1EkGm+UVXnodwMtJEQyy3oTfZjURPIyyaqskTu/KSS7YDjK0 KQNy73D6LtmdOEbAyq10XiDxqY41lvKHJ1eZrPaBmYNABxU= -----END CERTIFICATE---- -----BEGIN CERTIFICATE----- MIIDrzCCApegAwIBAgIRAOskdzLvcj1eShkoyEE693AwDQYJKoZIhvcNAQELBQAw cTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCldhc2hpbmd0b24xEDAOBgNVBAcMB1Nl ...certificate body truncated for brevity.... kdRGB6P2hpxstDOUIwAoCbhoaWwfA4ybJznf+jOQhAziNlRdKQRR8nODWpKt7H9w dJ5nxsTk/fniJz86Ddtp6n8s82wYdkN3cVffeK72A9aTCOU= -----END CERTIFICATE----- ``` A primeira parte da saída é o certificado em si. A segunda parte é a cadeia de certificados vinculada ao certificado CA raiz. Observe que, ao usar a opção `--output text`, um caractere `TAB` é inserido entre as duas partes do certificado (essa é a causa do texto recuado). Se você pretende pegar essa saída e analisar os certificados com outras ferramentas, talvez seja necessário remover o caractere `TAB` para que ele seja processado corretamente. + Consulte detalhes da API em [GetCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/get-certificate.html) na *Referência de comandos da AWS CLI*. ### `import-certificate-authority-certificate` O código de exemplo a seguir mostra como usar `import-certificate-authority-certificate`. **AWS CLI** **Para importar seu certificado de autoridade de certificação para o ACM PCA** O comando `import-certificate-authority-certificate` a seguir importa o certificado da autoridade de certificação privada assinado para a autoridade de certificação especificada pelo ARN para o ACM PCA. ``` aws acm-pca import-certificate-authority-certificate --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 --certificate file://C:\ca_cert.pem --certificate-chain file://C:\ca_cert_chain.pem ``` + Para ver detalhes da API, consulte [ImportCertificateAuthorityCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/import-certificate-authority-certificate.html) na *Referência de comandos da AWS CLI.* ### `issue-certificate` O código de exemplo a seguir mostra como usar `issue-certificate`. **AWS CLI** **Como emitir um certificado privado** O comando `issue-certificate` a seguir usa a autoridade de certificação privada especificada pelo ARN para emitir um certificado privado. ``` aws acm-pca issue-certificate --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 --csr file://C:\cert_1.csr --signing-algorithm "SHA256WITHRSA" --validity Value=365,Type="DAYS" --idempotency-token 1234 ``` + Para ver detalhes da API, consulte [IssueCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/issue-certificate.html) na *Referência de comandos da AWS CLI*. ### `list-certificate-authorities` O código de exemplo a seguir mostra como usar `list-certificate-authorities`. **AWS CLI** **Para listar suas autoridades de certificação privadas** O comando `list-certificate-authorities` a seguir lista as informações sobre todas as CAs privadas em sua conta. ``` aws acm-pca list-certificate-authorities --max-results 10 ``` + Para ver detalhes da API, consulte [ListCertificateAuthorities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/list-certificate-authorities.html) na *Referência de comandos da AWS CLI*. ### `list-tags` O código de exemplo a seguir mostra como usar `list-tags`. **AWS CLI** **Para listar as etiquetas da sua autoridade de certificação** O comando `list-tags` a seguir lista as tags associadas à autoridade de certificação privada especificada pelo ARN. ``` aws acm-pca list-tags --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/123455678-1234-1234-1234-123456789012 --max-results 10 ``` + Consulte detalhes da API em [ListTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/list-tags.html) na *Referência de comandos da AWS CLI*. ### `revoke-certificate` O código de exemplo a seguir mostra como usar `revoke-certificate`. **AWS CLI** **Como revogar um certificado privado** O comando `revoke-certificate` a seguir revoga um certificado privado da CA identificado pelo ARN. ``` aws acm-pca revoke-certificate --certificate-authority-arn arn:aws:acm-pca:us-west-2:1234567890:certificate-authority/12345678-1234-1234-1234-123456789012 --certificate-serial 67:07:44:76:83:a9:b7:f4:05:56:27:ff:d5:5c:eb:cc --revocation-reason "KEY_COMPROMISE" ``` + Para ver detalhes da API, consulte [RevokeCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/revoke-certificate.html) na *Referência de comandos da AWS CLI*. ### `tag-certificate-authority` O código de exemplo a seguir mostra como usar `tag-certificate-authority`. **AWS CLI** **Como anexar tags a uma autoridade de certificação privada** O comando `tag-certificate-authority` a seguir anexa uma ou mais tags à sua CA privada. ``` aws acm-pca tag-certificate-authority --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 --tags Key=Admin,Value=Alice ``` + Para ver detalhes da API, consulte [TagCertificateAuthority](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/tag-certificate-authority.html) na *Referência de comandos da AWS CLI*. ### `untag-certificate-authority` O código de exemplo a seguir mostra como usar `untag-certificate-authority`. **AWS CLI** **Para remover uma ou mais tags de uma autoridade de certificação privada** O comando `untag-certificate-authority` a seguir remove as tags da autoridade de certificação privada identificada pelo ARN. ``` aws acm-pca untag-certificate-authority --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 --tags Key=Purpose,Value=Website ``` + Para ver detalhes da API, consulte [UntagCertificateAuthority](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/untag-certificate-authority.html) na *Referência de comandos da AWS CLI*. ### `update-certificate-authority` O código de exemplo a seguir mostra como usar `update-certificate-authority`. **AWS CLI** **Para atualizar a configuração da sua autoridade de certificação privada** O comando `update-certificate-authority` a seguir atualiza o status e a configuração da autoridade de certificação privada identificada pelo ARN. ``` aws acm-pca update-certificate-authority --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-1232456789012 --revocation-configuration file://C:\revoke_config.txt --status "DISABLED" ``` + Para ver detalhes da API, consulte [UpdateCertificateAuthority](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/update-certificate-authority.html) na *Referência de comandos da AWS CLI*. # AWS Proton Exemplos do usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o AWS Proton. *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 ### `cancel-service-instance-deployment` O código de exemplo a seguir mostra como usar `cancel-service-instance-deployment`. **AWS CLI** **Para cancelar uma implantação de instância de serviço** O exemplo `cancel-service-instance-deployment` a seguir cancela a implantação de uma instância de serviço. ``` aws proton cancel-service-instance-deployment \ --service-instance-name "instance-one" \ --service-name "simple-svc" ``` Resultado: ``` { "serviceInstance": { "arn": "arn:aws:proton:region-id:123456789012:service/simple-svc/service-instance/instance-one", "createdAt": "2021-04-02T21:29:59.962000+00:00", "deploymentStatus": "CANCELLING", "environmentName": "simple-env", "lastDeploymentAttemptedAt": "2021-04-02T21:45:15.406000+00:00", "lastDeploymentSucceededAt": "2021-04-02T21:38:00.823000+00:00", "name": "instance-one", "serviceName": "simple-svc", "spec": "proton: ServiceSpec\npipeline:\n my_sample_pipeline_optional_input: abc\n my_sample_pipeline_required_input: '123'\ninstances:\n- name: my-instance\n environment: MySimpleEnv\n spec:\n my_sample_service_instance_optional_input: def\n my_sample_service_instance_required_input: '456'\n- name: my-other-instance\n environment: MySimpleEnv\n spec:\n my_sample_service_instance_required_input: '789'\n", "templateMajorVersion": "1", "templateMinorVersion": "1", "templateName": "svc-simple" } } ``` Para obter mais informações, consulte [Atualizar uma instância de serviço](https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-instance-update.html) no *Guia do administrador do AWS Proton* ou [Atualizar uma instância de serviço](https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-instance-update.html) no *Guia do usuário do AWS Proton*. + Para ver detalhes da API, consulte [CancelServiceInstanceDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/proton/cancel-service-instance-deployment.html) na *Referência de comandos da AWS CLI*. ### `cancel-service-pipeline-deployment` O código de exemplo a seguir mostra como usar `cancel-service-pipeline-deployment`. **AWS CLI** **Para cancelar uma implantação de pipeline de serviço** O exemplo `cancel-service-pipeline-deployment` a seguir cancela a implantação de um pipeline de serviço. ``` aws proton cancel-service-pipeline-deployment \ --service-name "simple-svc" ``` Resultado: ``` { "pipeline": { "arn": "arn:aws:proton:region-id:123456789012:service/simple-svc/pipeline", "createdAt": "2021-04-02T21:29:59.962000+00:00", "deploymentStatus": "CANCELLING", "lastDeploymentAttemptedAt": "2021-04-02T22:02:45.095000+00:00", "lastDeploymentSucceededAt": "2021-04-02T21:39:28.991000+00:00", "templateMajorVersion": "1", "templateMinorVersion": "1", "templateName": "svc-simple" } } ``` Para obter mais informações, consulte [Atualizar um pipeline de serviço](https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-pipeline-update.html) no *Guia do administrador do AWS Proton* ou [Atualizar um pipeline de serviço](https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-pipeline-update.html) no *Guia do usuário do AWS Proton*. + Para ver detalhes da API, consulte [CancelServicePipelineDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/proton/cancel-service-pipeline-deployment.html) na *Referência de comandos da AWS CLI*. ### `create-service` O código de exemplo a seguir mostra como usar `create-service`. **AWS CLI** **Para criar um serviço** O exemplo `create-service` a seguir cria um serviço com um pipeline de serviços. ``` aws proton create-service \ --name "MySimpleService" \ --template-name "fargate-service" \ --template-major-version "1" \ --branch-name "mainline" \ --repository-connection-arn "arn:aws:codestar-connections:region-id:account-id:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" \ --repository-id "myorg/myapp" \ --spec file://spec.yaml ``` Conteúdo de `spec.yaml`: ``` proton: ServiceSpec pipeline: my_sample_pipeline_required_input: "hello" my_sample_pipeline_optional_input: "bye" instances: - name: "acme-network-dev" environment: "ENV_NAME" spec: my_sample_service_instance_required_input: "hi" my_sample_service_instance_optional_input: "ho" ``` Resultado: ``` { "service": { "arn": "arn:aws:proton:region-id:123456789012:service/MySimpleService", "createdAt": "2020-11-18T19:50:27.460000+00:00", "lastModifiedAt": "2020-11-18T19:50:27.460000+00:00", "name": "MySimpleService", "repositoryConnectionArn": "arn:aws:codestar-connections:region-id:123456789012connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "repositoryId": "myorg/myapp", "status": "CREATE_IN_PROGRESS", "templateName": "fargate-service" } } ``` Para obter mais informações, consulte [Criar um serviço](https://docs.aws.amazon.com/proton/latest/adminguide/ag-create-svc.html) no *Guia do administrador do AWS Proton* ou [Criar um serviço](https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-create.html) no *Guia do usuário do AWS Proton*. + Consulte detalhes da API em [CreateService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/proton/create-service.html) na *Referência de comandos da AWS CLI*. ### `delete-service` O código de exemplo a seguir mostra como usar `delete-service`. **AWS CLI** **Como excluir um serviço** O exemplo `delete-service` a seguir exclui um serviço. ``` aws proton delete-service \ --name "simple-svc" ``` Resultado: ``` { "service": { "arn": "arn:aws:proton:region-id:123456789012:service/simple-svc", "branchName": "mainline", "createdAt": "2020-11-28T22:40:50.512000+00:00", "description": "Edit by updating description", "lastModifiedAt": "2020-11-29T00:30:39.248000+00:00", "name": "simple-svc", "repositoryConnectionArn": "arn:aws:codestar-connections:region-id:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "repositoryId": "myorg/myapp", "status": "DELETE_IN_PROGRESS", "templateName": "fargate-service" } } ``` Para obter mais informações, consulte [Excluir um serviço](https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-delete.html) no *Guia do administrador do AWS Proton*. + Consulte detalhes da API em [DeleteService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/proton/delete-service.html) na *Referência de comandos da AWS CLI*. ### `get-service-instance` O código de exemplo a seguir mostra como usar `get-service-instance`. **AWS CLI** **Para obter detalhes da instância do serviço** O exemplo `get-service-instance` a seguir obtém dados detalhados de uma instância de serviço. ``` aws proton get-service-instance \ --name "instance-one" \ --service-name "simple-svc" ``` Resultado: ``` { "serviceInstance": { "arn": "arn:aws:proton:region-id:123456789012:service/simple-svc/service-instance/instance-one", "createdAt": "2020-11-28T22:40:50.512000+00:00", "deploymentStatus": "SUCCEEDED", "environmentName": "simple-env", "lastDeploymentAttemptedAt": "2020-11-28T22:40:50.512000+00:00", "lastDeploymentSucceededAt": "2020-11-28T22:40:50.512000+00:00", "name": "instance-one", "serviceName": "simple-svc", "spec": "proton: ServiceSpec\npipeline:\n my_sample_pipeline_optional_input: hello world\n my_sample_pipeline_required_input: pipeline up\ninstances:\n- name: instance-one\n environment: my-simple-env\n spec:\n my_sample_service_instance_optional_input: Ola\n my_sample_service_instance_required_input: Ciao\n", "templateMajorVersion": "1", "templateMinorVersion": "0", "templateName": "svc-simple" } } ``` Para obter mais informações, consulte [Visualizar dados de um serviço](https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-view.html) no *Guia do administrador do AWS Proton* ou [Visualizar dados de um serviço](https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-view.html) no *Guia do usuário do AWS Proton*. + Para ver detalhes da API, consulte [GetServiceInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/proton/get-service-instance.html) na *Referência de comandos da AWS CLI*. ### `get-service` O código de exemplo a seguir mostra como usar `get-service`. **AWS CLI** **Para obter detalhes do serviço** O exemplo `get-service` a seguir obtém dados detalhados de uma serviço. ``` aws proton get-service \ --name "simple-svc" ``` Resultado: ``` { "service": { "arn": "arn:aws:proton:region-id:123456789012:service/simple-svc", "branchName": "mainline", "createdAt": "2020-11-28T22:40:50.512000+00:00", "lastModifiedAt": "2020-11-28T22:44:51.207000+00:00", "name": "simple-svc", "pipeline": { "arn": "arn:aws:proton:region-id:123456789012:service/simple-svc/pipeline/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "createdAt": "2020-11-28T22:40:50.512000+00:00", "deploymentStatus": "SUCCEEDED", "lastDeploymentAttemptedAt": "2020-11-28T22:40:50.512000+00:00", "lastDeploymentSucceededAt": "2020-11-28T22:40:50.512000+00:00", "spec": "proton: ServiceSpec\npipeline:\n my_sample_pipeline_required_input: hello\n my_sample_pipeline_optional_input: bye\ninstances:\n- name: instance-svc-simple\n environment: my-simple-env\n spec:\n my_sample_service_instance_required_input: hi\n my_sample_service_instance_optional_input: ho\n", "templateMajorVersion": "1", "templateMinorVersion": "1", "templateName": "svc-simple" }, "repositoryConnectionArn": "arn:aws:codestar-connections:region-id:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "repositoryId": "myorg/myapp", "spec": "proton: ServiceSpec\npipeline:\n my_sample_pipeline_required_input: hello\n my_sample_pipeline_optional_input: bye\ninstances:\n- name: instance-svc-simple\n environment: my-simple-env\n spec:\n my_sample_service_instance_required_input: hi\n my_sample_service_instance_optional_input: ho\n", "status": "ACTIVE", "templateName": "svc-simple" } } ``` Para obter mais informações, consulte [Visualizar dados de um serviço](https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-view.html) no *Guia do administrador do AWS Proton* ou [Visualizar dados de um serviço](https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-view.html) no *Guia do usuário do AWS Proton*. + Para ver detalhes da API, consulte [GetService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/proton/get-service.html) na *Referência de comandos da AWS CLI*. ### `list-service-instances` O código de exemplo a seguir mostra como usar `list-service-instances`. **AWS CLI** **Exemplo 1: listar todas as instâncias de um serviço** O exemplo `list-service-instances` a seguir lista as instâncias do serviço. ``` aws proton list-service-instances ``` Resultado: ``` { "serviceInstances": [ { "arn": "arn:aws:proton:region-id:123456789012:service/simple-svc/service-instance/instance-one", "createdAt": "2020-11-28T22:40:50.512000+00:00", "deploymentStatus": "SUCCEEDED", "environmentArn": "arn:aws:proton:region-id:123456789012:environment/simple-env", "lastDeploymentAttemptedAt": "2020-11-28T22:40:50.512000+00:00", "lastDeploymentSucceededAt": "2020-11-28T22:40:50.512000+00:00", "name": "instance-one", "serviceName": "simple-svc", "templateMajorVersion": "1", "templateMinorVersion": "0", "templateName": "fargate-service" } ] } ``` Para obter mais informações, consulte [Visualizar dados de instâncias de um serviço](https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-instance-view.html) no *Guia do administrador do AWS Proton* ou [Visualizar dados de instâncias de um serviço](https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-instance-view.html) no *Guia do usuário do AWS Proton*. **Exemplo 2: listar a instância especificada de um serviço** O exemplo `get-service-instance` a seguir obtém uma instância de um serviço. ``` aws proton get-service-instance \ --name "instance-one" \ --service-name "simple-svc" ``` Resultado: ``` { "serviceInstance": { "arn": "arn:aws:proton:region-id:123456789012:service/simple-svc/service-instance/instance-one", "createdAt": "2020-11-28T22:40:50.512000+00:00", "deploymentStatus": "SUCCEEDED", "environmentName": "simple-env", "lastDeploymentAttemptedAt": "2020-11-28T22:40:50.512000+00:00", "lastDeploymentSucceededAt": "2020-11-28T22:40:50.512000+00:00", "name": "instance-one", "serviceName": "simple-svc", "spec": "proton: ServiceSpec\npipeline:\n my_sample_pipeline_optional_input: hello world\n my_sample_pipeline_required_input: pipeline up\ninstances:\n- name: instance-one\n environment: my-simple-env\n spec:\n my_sample_service_instance_optional_input: Ola\n my_sample_service_instance_required_input: Ciao\n", "templateMajorVersion": "1", "templateMinorVersion": "0", "templateName": "svc-simple" } } ``` Para obter mais informações, consulte [Visualizar dados de instâncias de um serviço](https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-instance-view.html) no *Guia do administrador do AWS Proton* ou [Visualizar dados de instâncias de um serviço](https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-instance-view.html) no *Guia do usuário do AWS Proton*. + Para ver detalhes da API, consulte [ListServiceInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/proton/list-service-instances.html) na *Referência de comandos da AWS CLI*. ### `update-service-instance` O código de exemplo a seguir mostra como usar `update-service-instance`. **AWS CLI** **Para atualizar uma instância de serviço para uma nova versão secundária** O exemplo `update-service-instance` a seguir atualiza uma instância de serviço para uma nova versão secundária de seu modelo de serviço que adiciona uma nova instância chamada "my-other-instance" com uma nova entrada obrigatória. ``` aws proton update-service-instance \ --service-name "simple-svc" \ --spec "file://service-spec.yaml " \ --template-major-version "1" \ --template-minor-version "1" \ --deployment-type "MINOR_VERSION" \ --name "instance-one" ``` Conteúdo de `service-spec.yaml`: ``` proton: ServiceSpec pipeline: my_sample_pipeline_optional_input: "abc" my_sample_pipeline_required_input: "123" instances: - name: "instance-one" environment: "simple-env" spec: my_sample_service_instance_optional_input: "def" my_sample_service_instance_required_input: "456" - name: "my-other-instance" environment: "simple-env" spec: my_sample_service_instance_required_input: "789" ``` Resultado: ``` { "serviceInstance": { "arn": "arn:aws:proton:region-id:123456789012:service/simple-svc/service-instance/instance-one", "createdAt": "2021-04-02T21:29:59.962000+00:00", "deploymentStatus": "IN_PROGRESS", "environmentName": "arn:aws:proton:region-id:123456789012:environment/simple-env", "lastDeploymentAttemptedAt": "2021-04-02T21:38:00.823000+00:00", "lastDeploymentSucceededAt": "2021-04-02T21:29:59.962000+00:00", "name": "instance-one", "serviceName": "simple-svc", "templateMajorVersion": "1", "templateMinorVersion": "0", "templateName": "svc-simple" } } ``` Para obter mais informações, consulte [Atualizar uma instância de serviço](https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-instance-update.html) no *Guia do administrador do AWS Proton* ou [Atualizar uma instância de serviço](https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-instance-update.html) no *Guia do usuário do AWS Proton*. + Para ver detalhes da API, consulte [UpdateServiceInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/proton/update-service-instance.html) na *Referência de comandos da AWS CLI*. ### `update-service-pipeline` O código de exemplo a seguir mostra como usar `update-service-pipeline`. **AWS CLI** **Para atualizar um pipeline de serviço** O exemplo `update-service-pipeline` a seguir atualiza um pipeline de serviço para uma nova versão secundária de seu modelo de serviço. ``` aws proton update-service-pipeline \ --service-name "simple-svc" \ --spec "file://service-spec.yaml" \ --template-major-version "1" \ --template-minor-version "1" \ --deployment-type "MINOR_VERSION" ``` Resultado: ``` { "pipeline": { "arn": "arn:aws:proton:region-id:123456789012:service/simple-svc/pipeline/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "createdAt": "2021-04-02T21:29:59.962000+00:00", "deploymentStatus": "IN_PROGRESS", "lastDeploymentAttemptedAt": "2021-04-02T21:39:28.991000+00:00", "lastDeploymentSucceededAt": "2021-04-02T21:29:59.962000+00:00", "spec": "proton: ServiceSpec\n\npipeline:\n my_sample_pipeline_optional_input: \"abc\"\n my_sample_pipeline_required_input: \"123\"\n\ninstances:\n - name: \"my-instance\"\n environment: \"MySimpleEnv\"\n spec:\n my_sample_service_instance_optional_input: \"def\"\n my_sample_service_instance_required_input: \"456\"\n - name: \"my-other-instance\"\n environment: \"MySimpleEnv\"\n spec:\n my_sample_service_instance_required_input: \"789\"\n", "templateMajorVersion": "1", "templateMinorVersion": "0", "templateName": "svc-simple" } } ``` Para obter mais informações, consulte [Atualizar um pipeline de serviço](https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-pipeline-update.html) no *Guia do administrador do AWS Proton* ou [Atualizar um pipeline de serviço](https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-pipeline-update.html) no *Guia do usuário do AWS Proton*. + Para ver detalhes da API, consulte [UpdateServicePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/proton/update-service-pipeline.html) na *Referência de comandos da AWS CLI*. ### `update-service` O código de exemplo a seguir mostra como usar `update-service`. **AWS CLI** **Para atualizar um serviço** O exemplo `update-service` a seguir edita a descrição de um serviço. ``` aws proton update-service \ --name "MySimpleService" \ --description "Edit by updating description" ``` Resultado: ``` { "service": { "arn": "arn:aws:proton:region-id:123456789012:service/MySimpleService", "branchName": "mainline", "createdAt": "2021-03-12T22:39:42.318000+00:00", "description": "Edit by updating description", "lastModifiedAt": "2021-03-12T22:44:21.975000+00:00", "name": "MySimpleService", "repositoryConnectionArn": "arn:aws:codestar-connections:region-id:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "repositoryId": "myorg/myapp", "status": "ACTIVE", "templateName": "fargate-service" } } ``` Para obter mais informações, consulte [Editar um serviço](https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-update.html) no *Guia do administrador do AWS Proton* ou [Editar um serviço](https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-update.html) no *Guia do usuário do AWS Proton*. + Consulte detalhes da API em [UpdateService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/proton/update-service.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon RDS usando o AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Amazon RDS. *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-option-to-option-group` O código de exemplo a seguir mostra como usar `add-option-to-option-group`. **AWS CLI** **Para adicionar uma opção a um grupo de opções** O exemplo `add-option-to-option-group` a seguir adiciona uma opção ao grupo de opções especificado. ``` aws rds add-option-to-option-group \ --option-group-name myoptiongroup \ --options OptionName=OEM,Port=5500,DBSecurityGroupMemberships=default \ --apply-immediately ``` Resultado: ``` { "OptionGroup": { "OptionGroupName": "myoptiongroup", "OptionGroupDescription": "Test Option Group", "EngineName": "oracle-ee", "MajorEngineVersion": "12.1", "Options": [ { "OptionName": "Timezone", "OptionDescription": "Change time zone", "Persistent": true, "Permanent": false, "OptionSettings": [ { "Name": "TIME_ZONE", "Value": "Australia/Sydney", "DefaultValue": "UTC", "Description": "Specifies the timezone the user wants to change the system time to", "ApplyType": "DYNAMIC", "DataType": "STRING", "AllowedValues": "Africa/Cairo,Africa/Casablanca,Africa/Harare,Africa/Lagos,Africa/Luanda,Africa/Monrovia,Africa/Nairobi,Africa/Tripoli,Africa/Windhoek,America/Araguaina,America/Argentina/Buenos_Aires,America/Asuncion,America/Bogota,America/Caracas,America/Chicago,America/Chihuahua,America/Cuiaba,America/Denver,America/Detroit,America/Fortaleza,America/Godthab,America/Guatemala,America/Halifax,America/Lima,America/Los_Angeles,America/Manaus,America/Matamoros,America/Mexico_City,America/Monterrey,America/Montevideo,America/New_York,America/Phoenix,America/Santiago,America/Sao_Paulo,America/Tijuana,America/Toronto,Asia/Amman,Asia/Ashgabat,Asia/Baghdad,Asia/Baku,Asia/Bangkok,Asia/Beirut,Asia/Calcutta,Asia/Damascus,Asia/Dhaka,Asia/Hong_Kong,Asia/Irkutsk,Asia/Jakarta,Asia/Jerusalem,Asia/Kabul,Asia/Karachi,Asia/Kathmandu,Asia/Kolkata,Asia/Krasnoyarsk,Asia/Magadan,Asia/Manila,Asia/Muscat,Asia/Novosibirsk,Asia/Rangoon,Asia/Riyadh,Asia/Seoul,Asia/Shanghai,Asia/Singapore,Asia/Taipei,Asia/Tehran,Asia/Tokyo,Asia/Ulaanbaatar,Asia/Vladivostok,Asia/Yakutsk,Asia/Yerevan,Atlantic/Azores,Atlantic/Cape_Verde,Australia/Adelaide,Australia/Brisbane,Australia/Darwin,Australia/Eucla,Australia/Hobart,Australia/Lord_Howe,Australia/Perth,Australia/Sydney,Brazil/DeNoronha,Brazil/East,Canada/Newfoundland,Canada/Saskatchewan,Etc/GMT-3,Europe/Amsterdam,Europe/Athens,Europe/Berlin,Europe/Dublin,Europe/Helsinki,Europe/Kaliningrad,Europe/London,Europe/Madrid,Europe/Moscow,Europe/Paris,Europe/Prague,Europe/Rome,Europe/Sarajevo,Pacific/Apia,Pacific/Auckland,Pacific/Chatham,Pacific/Fiji,Pacific/Guam,Pacific/Honolulu,Pacific/Kiritimati,Pacific/Marquesas,Pacific/Samoa,Pacific/Tongatapu,Pacific/Wake,US/Alaska,US/Central,US/East-Indiana,US/Eastern,US/Pacific,UTC", "IsModifiable": true, "IsCollection": false } ], "DBSecurityGroupMemberships": [], "VpcSecurityGroupMemberships": [] }, { "OptionName": "OEM", "OptionDescription": "Oracle 12c EM Express", "Persistent": false, "Permanent": false, "Port": 5500, "OptionSettings": [], "DBSecurityGroupMemberships": [ { "DBSecurityGroupName": "default", "Status": "authorized" } ], "VpcSecurityGroupMemberships": [] } ], "AllowsVpcAndNonVpcInstanceMemberships": false, "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:myoptiongroup" } } ``` Para obter mais informações, consulte [Adicionar uma opção a um grupo de opções](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithOptionGroups.html#USER_WorkingWithOptionGroups.AddOption) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [AddOptionToOptionGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/add-option-to-option-group.html) em *Referência de comandos da AWS CLI*. ### `add-role-to-db-cluster` O código de exemplo a seguir mostra como usar `add-role-to-db-cluster`. **AWS CLI** **Associar um perfil do AWS Identity and Access Management (IAM) a um cluster de banco de dados**. O exemplo `add-role-to-db-cluster` a seguir associa um perfil a um cluster de banco de dados. ``` aws rds add-role-to-db-cluster \ --db-cluster-identifier mydbcluster \ --role-arn arn:aws:iam::123456789012:role/RDSLoadFromS3 ``` Este comando não produz saída. Para obter mais informações, consulte [Associar um perfil do IAM a um cluster de banco de dados do Amazon Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Integrating.Authorizing.IAM.AddRoleToDBCluster.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [AddRoleToDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/add-role-to-db-cluster.html) em *Referência de comandos da AWS CLI*. ### `add-role-to-db-instance` O código de exemplo a seguir mostra como usar `add-role-to-db-instance`. **AWS CLI** **Associar um perfil do AWS Identity and Access Management (IAM) a uma instância de banco de dados** O exemplo `add-role-to-db-instance` a seguir adiciona o perfil a uma instância de banco de dados Oracle denominada `test-instance`. ``` aws rds add-role-to-db-instance \ --db-instance-identifier test-instance \ --feature-name S3_INTEGRATION \ --role-arn arn:aws:iam::111122223333:role/rds-s3-integration-role ``` Este comando não produz saída. Para obter mais informações, consulte os [Pré-requisitos para a integração do Amazon RDS Oracle com o Amazon S3](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html#oracle-s3-integration.preparing) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [AddRoleToDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/add-role-to-db-instance.html) e *Referência de comandos da AWS CLI*. ### `add-source-identifier-to-subscription` O código de exemplo a seguir mostra como usar `add-source-identifier-to-subscription`. **AWS CLI** **Adicionar um identificador de origem a uma assinatura** O exemplo `add-source-identifier` a seguir adiciona outro identificador de origem a uma assinatura já existente. ``` aws rds add-source-identifier-to-subscription \ --subscription-name my-instance-events \ --source-identifier test-instance-repl ``` Resultado: ``` { "EventSubscription": { "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", "CustSubscriptionId": "my-instance-events", "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", "Enabled": false, "Status": "modifying", "EventCategoriesList": [ "backup", "recovery" ], "CustomerAwsId": "123456789012", "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", "SourceType": "db-instance", "SourceIdsList": [ "test-instance", "test-instance-repl" ] } } ``` + Para ver detalhes da API, consulte [AddSourceIdentifierToSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/add-source-identifier-to-subscription.html) em *Referência de comandos da AWS CLI*. ### `add-tags-to-resource` O código de exemplo a seguir mostra como usar `add-tags-to-resource`. **AWS CLI** **Para adicionar tags a um recurso** O exemplo `add-tags-to-resource` a seguir adiciona tags a um banco de dados do RDS. ``` aws rds add-tags-to-resource \ --resource-name arn:aws:rds:us-east-1:123456789012:db:database-mysql \ --tags "[{\"Key\": \"Name\",\"Value\": \"MyDatabase\"},{\"Key\": \"Environment\",\"Value\": \"test\"}]" ``` Este comando não produz saída. Para obter mais informações, consulte [Marcar recursos do Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) no *Guia do usuário do Amazon RDS*. + Consulte detalhes da API em [AddTagsToResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/add-tags-to-resource.html) na *Referência de comandos da AWS CLI*. ### `apply-pending-maintenance-action` O código de exemplo a seguir mostra como usar `apply-pending-maintenance-action`. **AWS CLI** **Para aplicar ações de manutenção pendentes** O exemplo `apply-pending-maintenance-action` a seguir aplica as ações de manutenção pendentes em um cluster de banco de dados. ``` aws rds apply-pending-maintenance-action \ --resource-identifier arn:aws:rds:us-east-1:123456789012:cluster:my-db-cluster \ --apply-action system-update \ --opt-in-type immediate ``` Resultado: ``` { "ResourcePendingMaintenanceActions": { "ResourceIdentifier": "arn:aws:rds:us-east-1:123456789012:cluster:my-db-cluster", "PendingMaintenanceActionDetails": [ { "Action": "system-update", "OptInStatus": "immediate", "CurrentApplyDate": "2021-01-23T01:07:36.100Z", "Description": "Upgrade to Aurora PostgreSQL 3.3.2" } ] } } ``` Para obter mais informações, consulte [Manutenção de uma instância de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html) em *Guia do usuário do Amazon RDS* e [Manutenção de um cluster de banco de dados do Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [ApplyPendingMaintenanceAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/apply-pending-maintenance-action.html) na *Referência de comandos da AWS CLI*. ### `authorize-db-security-group-ingress` O código de exemplo a seguir mostra como usar `authorize-db-security-group-ingress`. **AWS CLI** **Associar um perfil do AWS Identity and Access Management (IAM) a uma instância de banco de dados** O exemplo `authorize-db-security-group-ingress` a seguir configura o grupo de segurança padrão com uma regra de entrada para o intervalo de IP CIDR 192.0.2.0/24. ``` aws rds authorize-db-security-group-ingress \ --db-security-group-name default \ --cidrip 192.0.2.0/24 ``` Resultado: ``` { "DBSecurityGroup": { "OwnerId": "123456789012", "DBSecurityGroupName": "default", "DBSecurityGroupDescription": "default", "EC2SecurityGroups": [], "IPRanges": [ { "Status": "authorizing", "CIDRIP": "192.0.2.0/24" } ], "DBSecurityGroupArn": "arn:aws:rds:us-east-1:111122223333:secgrp:default" } } ``` Para obter mais informações, consulte [Autorizar o acesso à rede a um grupo de segurança de banco de dados a partir de um intervalo de IP](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithSecurityGroups.html#USER_WorkingWithSecurityGroups.Authorizing) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [AuthorizeDbSecurityGroupIngress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/authorize-db-security-group-ingress.html) em *Referência de comandos da AWS CLI*. ### `backtrack-db-cluster` O código de exemplo a seguir mostra como usar `backtrack-db-cluster`. **AWS CLI** **Retroceder um cluster do banco de dados do Aurora** O exemplo `backtrack-db-cluster` a seguir retrocede o cluster de banco de dados especificado a 19 de março de 2018, às 10h. ``` aws rds backtrack-db-cluster --db-cluster-identifier sample-cluster --backtrack-to 2018-03-19T10:00:00+00:00 ``` Esse comando gera um bloco JSON que reconhece a alteração no recurso RDS. + Para ver detalhes da API, consulte [BacktrackDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/backtrack-db-cluster.html) em *Referência de comandos da AWS CLI*. ### `cancel-export-task` O código de exemplo a seguir mostra como usar `cancel-export-task`. **AWS CLI** **Cancelar a exportação de um snapshot para o Amazon S3** O exemplo `cancel-export-task` a seguir cancela uma tarefa de exportação em andamento que está exportando um snapshot para o Amazon S3. ``` aws rds cancel-export-task \ --export-task-identifier my-s3-export-1 ``` Resultado: ``` { "ExportTaskIdentifier": "my-s3-export-1", "SourceArn": "arn:aws:rds:us-east-1:123456789012:snapshot:publisher-final-snapshot", "SnapshotTime": "2019-03-24T20:01:09.815Z", "S3Bucket": "amzn-s3-demo-bucket", "S3Prefix": "", "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/export-snap-S3-role", "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/abcd0000-7bfd-4594-af38-aabbccddeeff", "Status": "CANCELING", "PercentProgress": 0, "TotalExtractedDataInGB": 0 } ``` Para obter mais informações, consulte [Cancelar uma tarefa de exportação de snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ExportSnapshot.html#USER_ExportSnapshot.Canceling) no *Guia do usuário do Amazon RDS* ou [Cancelar uma tarefa de exportação de snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_ExportSnapshot.html#USER_ExportSnapshot.Canceling) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [CancelExportTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/cancel-export-task.html) na *Referência de comandos da AWS CLI*. ### `copy-db-cluster-parameter-group` O código de exemplo a seguir mostra como usar `copy-db-cluster-parameter-group`. **AWS CLI** **Copiar um grupo de parâmetros de cluster de banco de dados** O exemplo `copy-db-cluster-parameter-group` a seguir faz uma cópia de um grupo de parâmetros de cluster de banco de dados. ``` aws rds copy-db-cluster-parameter-group \ --source-db-cluster-parameter-group-identifier mydbclusterpg \ --target-db-cluster-parameter-group-identifier mydbclusterpgcopy \ --target-db-cluster-parameter-group-description "Copy of mydbclusterpg parameter group" ``` Resultado: ``` { "DBClusterParameterGroup": { "DBClusterParameterGroupName": "mydbclusterpgcopy", "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpgcopy", "DBParameterGroupFamily": "aurora-mysql5.7", "Description": "Copy of mydbclusterpg parameter group" } } ``` Para obter mais informações, consulte [Copiar um grupo de parâmetros de cluster de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html#USER_WorkingWithParamGroups.CopyingCluster) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [CopyDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/copy-db-cluster-parameter-group.html) na *Referência de comandos da AWS CLI*. ### `copy-db-cluster-snapshot` O código de exemplo a seguir mostra como usar `copy-db-cluster-snapshot`. **AWS CLI** **Para copiar um snapshot de cluster de banco de dados** O exemplo `copy-db-cluster-snapshot` a seguir cria uma cópia de um snapshot de cluster de banco de dados, incluindo suas tags. ``` aws rds copy-db-cluster-snapshot \ --source-db-cluster-snapshot-identifier arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:myaurora-2019-06-04-09-16 --target-db-cluster-snapshot-identifier myclustersnapshotcopy \ --copy-tags ``` Resultado: ``` { "DBClusterSnapshot": { "AvailabilityZones": [ "us-east-1a", "us-east-1b", "us-east-1e" ], "DBClusterSnapshotIdentifier": "myclustersnapshotcopy", "DBClusterIdentifier": "myaurora", "SnapshotCreateTime": "2019-06-04T09:16:42.649Z", "Engine": "aurora-mysql", "AllocatedStorage": 0, "Status": "available", "Port": 0, "VpcId": "vpc-6594f31c", "ClusterCreateTime": "2019-04-15T14:18:42.785Z", "MasterUsername": "myadmin", "EngineVersion": "5.7.mysql_aurora.2.04.2", "LicenseModel": "aurora-mysql", "SnapshotType": "manual", "PercentProgress": 100, "StorageEncrypted": true, "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:myclustersnapshotcopy", "IAMDatabaseAuthenticationEnabled": false } } ``` Para obter mais informações, consulte [Copiar um snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [CopyDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/copy-db-cluster-snapshot.html) na *Referência de comandos da AWS CLI*. ### `copy-db-parameter-group` O código de exemplo a seguir mostra como usar `copy-db-parameter-group`. **AWS CLI** **Copiar um grupo de parâmetros de cluster de banco de dados** O exemplo `copy-db-parameter-group` a seguir faz uma cópia de um grupo de parâmetros de banco de dados. ``` aws rds copy-db-parameter-group \ --source-db-parameter-group-identifier mydbpg \ --target-db-parameter-group-identifier mydbpgcopy \ --target-db-parameter-group-description "Copy of mydbpg parameter group" ``` Resultado: ``` { "DBParameterGroup": { "DBParameterGroupName": "mydbpgcopy", "DBParameterGroupArn": "arn:aws:rds:us-east-1:814387698303:pg:mydbpgcopy", "DBParameterGroupFamily": "mysql5.7", "Description": "Copy of mydbpg parameter group" } } ``` Para obter mais informações, consulte [Copiar um grupo de parâmetros de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html#USER_WorkingWithParamGroups.Copying) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [CopyDbParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/copy-db-parameter-group.html) em *Referência de comandos da AWS CLI*. ### `copy-db-snapshot` O código de exemplo a seguir mostra como usar `copy-db-snapshot`. **AWS CLI** **Para copiar um snapshot de banco de dados** O exemplo `copy-db-snapshot` a seguir cria uma cópia de um snapshot de banco de dados. ``` aws rds copy-db-snapshot \ --source-db-snapshot-identifier rds:database-mysql-2019-06-06-08-38 --target-db-snapshot-identifier mydbsnapshotcopy ``` Resultado: ``` { "DBSnapshot": { "VpcId": "vpc-6594f31c", "Status": "creating", "Encrypted": true, "SourceDBSnapshotIdentifier": "arn:aws:rds:us-east-1:123456789012:snapshot:rds:database-mysql-2019-06-06-08-38", "MasterUsername": "admin", "Iops": 1000, "Port": 3306, "LicenseModel": "general-public-license", "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshotcopy", "EngineVersion": "5.6.40", "OptionGroupName": "default:mysql-5-6", "ProcessorFeatures": [], "Engine": "mysql", "StorageType": "io1", "DbiResourceId": "db-ZI7UJ5BLKMBYFGX7FDENCKADC4", "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", "SnapshotType": "manual", "IAMDatabaseAuthenticationEnabled": false, "SourceRegion": "us-east-1", "DBInstanceIdentifier": "database-mysql", "InstanceCreateTime": "2019-04-30T15:45:53.663Z", "AvailabilityZone": "us-east-1f", "PercentProgress": 0, "AllocatedStorage": 100, "DBSnapshotIdentifier": "mydbsnapshotcopy" } } ``` Para obter mais informações, consulte [Copiar um snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html) no *Guia do usuário do Amazon RDS*. + *Para ver detalhes da API, consulte [CopyDbSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/copy-db-snapshot.html) em Referência de comandos da AWS CLI*. ### `copy-option-group` O código de exemplo a seguir mostra como usar `copy-option-group`. **AWS CLI** **Copiar um grupo de opções** O exemplos de `copy-option-group` a seguir faz uma cópia de um grupo de opções. ``` aws rds copy-option-group \ --source-option-group-identifier myoptiongroup \ --target-option-group-identifier new-option-group \ --target-option-group-description "My option group copy" ``` Resultado: ``` { "OptionGroup": { "Options": [], "OptionGroupName": "new-option-group", "MajorEngineVersion": "11.2", "OptionGroupDescription": "My option group copy", "AllowsVpcAndNonVpcInstanceMemberships": true, "EngineName": "oracle-ee", "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:new-option-group" } } ``` Para obter mais informações, consulte [Copiar um grupo de opções](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithOptionGroups.html#USER_WorkingWithOptionGroups.Copy) no *Guia do usuário do Amazon RDS*. + *Para ver detalhes da API, consulte [CopyOptionGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/copy-option-group.html) em Referência de comandos da AWS CLI*. ### `create-blue-green-deployment` O código de exemplo a seguir mostra como usar `create-blue-green-deployment`. **AWS CLI** **Exemplo 1: Criar uma implantação azul/verde para uma instância de banco de dados do RDS para MySQL** O exemplo `create-blue-green-deployment` a seguir cria uma implantação azul/verde para uma instância de banco de dados MySQL. ``` aws rds create-blue-green-deployment \ --blue-green-deployment-name bgd-cli-test-instance \ --source arn:aws:rds:us-east-1:123456789012:db:my-db-instance \ --target-engine-version 8.0 \ --target-db-parameter-group-name mysql-80-group ``` Resultado: ``` { "BlueGreenDeployment": { "BlueGreenDeploymentIdentifier": "bgd-v53303651eexfake", "BlueGreenDeploymentName": "bgd-cli-test-instance", "Source": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance", "SwitchoverDetails": [ { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3" } ], "Tasks": [ { "Name": "CREATING_READ_REPLICA_OF_SOURCE", "Status": "PENDING" }, { "Name": "DB_ENGINE_VERSION_UPGRADE", "Status": "PENDING" }, { "Name": "CONFIGURE_BACKUPS", "Status": "PENDING" }, { "Name": "CREATING_TOPOLOGY_OF_SOURCE", "Status": "PENDING" } ], "Status": "PROVISIONING", "CreateTime": "2022-02-25T21:18:51.183000+00:00" } } ``` Para obter mais informações, consulte [Criar uma implantação azul/verde](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments-creating.html) no *Guia do usuário do Amazon RDS*. **Exemplo 2: Criar uma implantação azul/verde para um cluster de banco de dados do Aurora MySQL** O exemplo `create-blue-green-deployment` a seguir cria uma implantação azul/verde para um cluster de banco de dados do Aurora MySQL. ``` aws rds create-blue-green-deployment \ --blue-green-deployment-name my-blue-green-deployment \ --source arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster \ --target-engine-version 8.0 \ --target-db-cluster-parameter-group-name ams-80-binlog-enabled \ --target-db-parameter-group-name mysql-80-cluster-group ``` Resultado: ``` { "BlueGreenDeployment": { "BlueGreenDeploymentIdentifier": "bgd-wi89nwzglccsfake", "BlueGreenDeploymentName": "my-blue-green-deployment", "Source": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster", "SwitchoverDetails": [ { "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster", "Status": "PROVISIONING" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1", "Status": "PROVISIONING" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2", "Status": "PROVISIONING" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3", "Status": "PROVISIONING" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint", "Status": "PROVISIONING" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint", "Status": "PROVISIONING" } ], "Tasks": [ { "Name": "CREATING_READ_REPLICA_OF_SOURCE", "Status": "PENDING" }, { "Name": "DB_ENGINE_VERSION_UPGRADE", "Status": "PENDING" }, { "Name": "CREATE_DB_INSTANCES_FOR_CLUSTER", "Status": "PENDING" }, { "Name": "CREATE_CUSTOM_ENDPOINTS", "Status": "PENDING" } ], "Status": "PROVISIONING", "CreateTime": "2022-02-25T21:12:00.288000+00:00" } } ``` Para obter mais informações, consulte [Criar uma implantação azul/verde](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments-creating.html) no do *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [CreateBlueGreenDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-blue-green-deployment.html) em *Referência de comandos da AWS CLI*. ### `create-db-cluster-endpoint` O código de exemplo a seguir mostra como usar `create-db-cluster-endpoint`. **AWS CLI** **Criar um endpoint de cluster de banco de dados personalizado** O exemplo `create-db-cluster-endpoint` a seguir cria um endpoint de cluster de banco de dados personalizado e o associa ao cluster de banco de dados Aurora especificado. ``` aws rds create-db-cluster-endpoint \ --db-cluster-endpoint-identifier mycustomendpoint \ --endpoint-type reader \ --db-cluster-identifier mydbcluster \ --static-members dbinstance1 dbinstance2 ``` Resultado: ``` { "DBClusterEndpointIdentifier": "mycustomendpoint", "DBClusterIdentifier": "mydbcluster", "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE", "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com", "Status": "creating", "EndpointType": "CUSTOM", "CustomEndpointType": "READER", "StaticMembers": [ "dbinstance1", "dbinstance2" ], "ExcludedMembers": [], "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint" } ``` Para obter mais informações, consulte [Gerenciamento de conexões do Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.Endpoints.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [CreateDbClusterEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-cluster-endpoint.html) em *Referência de comandos da AWS CLI*. ### `create-db-cluster-parameter-group` O código de exemplo a seguir mostra como usar `create-db-cluster-parameter-group`. **AWS CLI** **Criar um grupo de parâmetros de cluster de banco de dados** O exemplo `create-db-cluster-parameter-group` a seguir cria um grupo de parâmetros de banco de dados. ``` aws rds create-db-cluster-parameter-group \ --db-cluster-parameter-group-name mydbclusterparametergroup \ --db-parameter-group-family aurora5.6 \ --description "My new cluster parameter group" ``` Resultado: ``` { "DBClusterParameterGroup": { "DBClusterParameterGroupName": "mydbclusterparametergroup", "DBParameterGroupFamily": "aurora5.6", "Description": "My new cluster parameter group", "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup" } } ``` Para obter mais informações, consulte [Criar um grupo de parâmetros de cluster de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html#USER_WorkingWithParamGroups.CreatingCluster) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [CreateDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-cluster-parameter-group.html) na *Referência de comandos da AWS CLI*. ### `create-db-cluster-snapshot` O código de exemplo a seguir mostra como usar `create-db-cluster-snapshot`. **AWS CLI** **Para criar um snapshot de cluster de banco de dados** O exemplo `create-db-cluster-snapshot` a seguir cria um snapshot de banco de dados. ``` aws rds create-db-cluster-snapshot \ --db-cluster-identifier mydbcluster \ --db-cluster-snapshot-identifier mydbclustersnapshot ``` Resultado: ``` { "DBClusterSnapshot": { "AvailabilityZones": [ "us-east-1a", "us-east-1b", "us-east-1e" ], "DBClusterSnapshotIdentifier": "mydbclustersnapshot", "DBClusterIdentifier": "mydbcluster", "SnapshotCreateTime": "2019-06-18T21:21:00.469Z", "Engine": "aurora-mysql", "AllocatedStorage": 1, "Status": "creating", "Port": 0, "VpcId": "vpc-6594f31c", "ClusterCreateTime": "2019-04-15T14:18:42.785Z", "MasterUsername": "myadmin", "EngineVersion": "5.7.mysql_aurora.2.04.2", "LicenseModel": "aurora-mysql", "SnapshotType": "manual", "PercentProgress": 0, "StorageEncrypted": true, "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot", "IAMDatabaseAuthenticationEnabled": false } } ``` Para obter mais informações, consulte [Criar um snapshot de cluster de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CreateSnapshotCluster.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [CreateDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-cluster-snapshot.html) na *Referência de comandos da AWS CLI*. ### `create-db-cluster` O código de exemplo a seguir mostra como usar `create-db-cluster`. **AWS CLI** **Exemplo 1: criar um cluster de banco de dados compatível com MySQL 5.7** O exemplo `create-db-cluster` a seguir cria um cluster de banco de dados compatível com o MySQL 5.7 usando a versão padrão do mecanismo. Substitua a senha de exemplo `secret99` por uma senha segura. Quando você usa o console para criar um cluster de banco de dados, o Amazon RDS cria automaticamente a instância de banco de dados de gravador para o cluster de banco de dados. No entanto, ao usar a AWS CLI para criar um cluster de banco de dados, você deverá criar explicitamente a instância de banco de dados de gravador para o cluster de banco de dados usando o comando `create-db-instance` AWS da CLI. ``` aws rds create-db-cluster \ --db-cluster-identifier sample-cluster \ --engine aurora-mysql \ --engine-version 5.7 \ --master-username admin \ --master-user-password secret99 \ --db-subnet-group-name default \ --vpc-security-group-ids sg-0b9130572daf3dc16 ``` Resultado: ``` { "DBCluster": { "DBSubnetGroup": "default", "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sg-0b9130572daf3dc16", "Status": "active" } ], "AllocatedStorage": 1, "AssociatedRoles": [], "PreferredBackupWindow": "09:12-09:42", "ClusterCreateTime": "2023-02-27T23:21:33.048Z", "DeletionProtection": false, "IAMDatabaseAuthenticationEnabled": false, "ReadReplicaIdentifiers": [], "EngineMode": "provisioned", "Engine": "aurora-mysql", "StorageEncrypted": false, "MultiAZ": false, "PreferredMaintenanceWindow": "mon:04:31-mon:05:01", "HttpEndpointEnabled": false, "BackupRetentionPeriod": 1, "DbClusterResourceId": "cluster-ANPAJ4AE5446DAEXAMPLE", "DBClusterIdentifier": "sample-cluster", "AvailabilityZones": [ "us-east-1a", "us-east-1b", "us-east-1e" ], "MasterUsername": "master", "EngineVersion": "5.7.mysql_aurora.2.11.1", "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster", "DBClusterMembers": [], "Port": 3306, "Status": "creating", "Endpoint": "sample-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", "DBClusterParameterGroup": "default.aurora-mysql5.7", "HostedZoneId": "Z2R2ITUGPM61AM", "ReaderEndpoint": "sample-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", "CopyTagsToSnapshot": false } } ``` **Exemplo 2: criar um cluster de banco de dados compatível com PostgreSQL** O exemplo `create-db-cluster` a seguir cria um cluster de banco de dados compatível com PostgreSQL usando a versão padrão do mecanismo. Substitua a senha de exemplo `secret99` por uma senha segura. Quando você usa o console para criar um cluster de banco de dados, o Amazon RDS cria automaticamente a instância de banco de dados de gravador para o cluster de banco de dados. No entanto, ao usar a AWS CLI para criar um cluster de banco de dados, você deverá criar explicitamente a instância de banco de dados de gravador para o cluster de banco de dados usando o comando `create-db-instance` AWS da CLI. ``` aws rds create-db-cluster \ --db-cluster-identifier sample-pg-cluster \ --engine aurora-postgresql \ --master-username master \ --master-user-password secret99 \ --db-subnet-group-name default \ --vpc-security-group-ids sg-0b9130572daf3dc16 ``` Resultado: ``` { "DBCluster": { "Endpoint": "sample-pg-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", "HttpEndpointEnabled": false, "DBClusterMembers": [], "EngineMode": "provisioned", "CopyTagsToSnapshot": false, "HostedZoneId": "Z2R2ITUGPM61AM", "IAMDatabaseAuthenticationEnabled": false, "AllocatedStorage": 1, "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sg-0b9130572daf3dc16", "Status": "active" } ], "DeletionProtection": false, "StorageEncrypted": false, "BackupRetentionPeriod": 1, "PreferredBackupWindow": "09:56-10:26", "ClusterCreateTime": "2023-02-27T23:26:08.371Z", "DBClusterParameterGroup": "default.aurora-postgresql13", "EngineVersion": "13.7", "Engine": "aurora-postgresql", "Status": "creating", "DBClusterIdentifier": "sample-pg-cluster", "MultiAZ": false, "Port": 5432, "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-pg-cluster", "AssociatedRoles": [], "DbClusterResourceId": "cluster-ANPAJ4AE5446DAEXAMPLE", "PreferredMaintenanceWindow": "wed:03:33-wed:04:03", "ReaderEndpoint": "sample-pg-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", "MasterUsername": "master", "AvailabilityZones": [ "us-east-1a", "us-east-1b", "us-east-1c" ], "ReadReplicaIdentifiers": [], "DBSubnetGroup": "default" } } ``` Para obter mais informações, consulte [Criar um cluster do banco de dados do Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [CreateDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-cluster.html) na *Referência de comandos da AWS CLI*. ### `create-db-instance-read-replica` O código de exemplo a seguir mostra como usar `create-db-instance-read-replica`. **AWS CLI** **Criar uma réplica de leitura de instância de banco de dados** Este exemplo cria uma réplica de leitura de uma instância de banco de dados existente denominada `test-instance`. A réplica de leitura foi denominada `test-instance-repl`. ``` aws rds create-db-instance-read-replica \ --db-instance-identifier test-instance-repl \ --source-db-instance-identifier test-instance ``` Resultado: ``` { "DBInstance": { "IAMDatabaseAuthenticationEnabled": false, "MonitoringInterval": 0, "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance-repl", "ReadReplicaSourceDBInstanceIdentifier": "test-instance", "DBInstanceIdentifier": "test-instance-repl", ...some output truncated... } } ``` + Para ver detalhes da API, consulte [CreateDbInstanceReadReplica](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-instance-read-replica.html) em *Referência de comandos da AWS CLI*. ### `create-db-instance` O código de exemplo a seguir mostra como usar `create-db-instance`. **AWS CLI** **Como criar uma instância de banco de dados** O exemplo de `create-db-instance` a seguir usa as opções necessárias para iniciar uma nova instância de banco de dados. ``` aws rds create-db-instance \ --db-instance-identifier test-mysql-instance \ --db-instance-class db.t3.micro \ --engine mysql \ --master-username admin \ --master-user-password secret99 \ --allocated-storage 20 ``` Resultado: ``` { "DBInstance": { "DBInstanceIdentifier": "test-mysql-instance", "DBInstanceClass": "db.t3.micro", "Engine": "mysql", "DBInstanceStatus": "creating", "MasterUsername": "admin", "AllocatedStorage": 20, "PreferredBackupWindow": "12:55-13:25", "BackupRetentionPeriod": 1, "DBSecurityGroups": [], "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sg-12345abc", "Status": "active" } ], "DBParameterGroups": [ { "DBParameterGroupName": "default.mysql5.7", "ParameterApplyStatus": "in-sync" } ], "DBSubnetGroup": { "DBSubnetGroupName": "default", "DBSubnetGroupDescription": "default", "VpcId": "vpc-2ff2ff2f", "SubnetGroupStatus": "Complete", "Subnets": [ { "SubnetIdentifier": "subnet-########", "SubnetAvailabilityZone": { "Name": "us-west-2c" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-########", "SubnetAvailabilityZone": { "Name": "us-west-2d" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-########", "SubnetAvailabilityZone": { "Name": "us-west-2a" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-########", "SubnetAvailabilityZone": { "Name": "us-west-2b" }, "SubnetStatus": "Active" } ] }, "PreferredMaintenanceWindow": "sun:08:07-sun:08:37", "PendingModifiedValues": { "MasterUserPassword": "****" }, "MultiAZ": false, "EngineVersion": "5.7.22", "AutoMinorVersionUpgrade": true, "ReadReplicaDBInstanceIdentifiers": [], "LicenseModel": "general-public-license", "OptionGroupMemberships": [ { "OptionGroupName": "default:mysql-5-7", "Status": "in-sync" } ], "PubliclyAccessible": true, "StorageType": "gp2", "DbInstancePort": 0, "StorageEncrypted": false, "DbiResourceId": "db-5555EXAMPLE44444444EXAMPLE", "CACertificateIdentifier": "rds-ca-2019", "DomainMemberships": [], "CopyTagsToSnapshot": false, "MonitoringInterval": 0, "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:test-mysql-instance", "IAMDatabaseAuthenticationEnabled": false, "PerformanceInsightsEnabled": false, "DeletionProtection": false, "AssociatedRoles": [] } } ``` Para obter mais informações, consulte [Criar uma instância de banco de dados do Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) no *Guia do usuário do Amazon RDS*. + Consulte detalhes da API em [CreateDBInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-instance.html) na *Referência de comandos da AWS CLI*. ### `create-db-parameter-group` O código de exemplo a seguir mostra como usar `create-db-parameter-group`. **AWS CLI** **Como criar um grupo de parâmetros de banco de dados** O exemplo de `create-db-parameter-group` a seguir cria um grupo de parâmetros de banco de dados. ``` aws rds create-db-parameter-group \ --db-parameter-group-name mydbparametergroup \ --db-parameter-group-family MySQL5.6 \ --description "My new parameter group" ``` Resultado: ``` { "DBParameterGroup": { "DBParameterGroupName": "mydbparametergroup", "DBParameterGroupFamily": "mysql5.6", "Description": "My new parameter group", "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:mydbparametergroup" } } ``` Para obter mais informações, consulte [Criar um grupo de parâmetros de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html#USER_WorkingWithParamGroups.Creating) no *Guia do usuário do Amazon RDS*. + Consulte detalhes da API em [CreateDBParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-parameter-group.html) na *Referência de comandos da AWS CLI*. ### `create-db-proxy-endpoint` O código de exemplo a seguir mostra como usar `create-db-proxy-endpoint`. **AWS CLI** **Criar um endpoint de proxy de banco de dados para um banco de dados RDS** O exemplo `create-db-proxy-endpoint` a seguir cria um endpoint de proxy de banco de dados. ``` aws rds create-db-proxy-endpoint \ --db-proxy-name proxyExample \ --db-proxy-endpoint-name "proxyep1" \ --vpc-subnet-ids subnetgroup1 subnetgroup2 ``` Resultado: ``` { "DBProxyEndpoint": { "DBProxyEndpointName": "proxyep1", "DBProxyEndpointArn": "arn:aws:rds:us-east-1:123456789012:db-proxy-endpoint:prx-endpoint-0123a01b12345c0ab", "DBProxyName": "proxyExample", "Status": "creating", "VpcId": "vpc-1234567", "VpcSecurityGroupIds": [ "sg-1234", "sg-5678" ], "VpcSubnetIds": [ "subnetgroup1", "subnetgroup2" ], "Endpoint": "proxyep1.endpoint.proxy-ab0cd1efghij.us-east-1.rds.amazonaws.com", "CreatedDate": "2023-04-05T16:09:33.452000+00:00", "TargetRole": "READ_WRITE", "IsDefault": false } } ``` Para obter mais informações, consulte [Criar um endpoint proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-endpoints.html#rds-proxy-endpoints.CreatingEndpoint) no *Guia do usuário do Amazon RDS* e [Criar um endpoint proxy](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-endpoints.html#rds-proxy-endpoints.CreatingEndpoint) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [CreateDbProxyEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-proxy-endpoint.html) e *Referência de comandos da AWS CLI*. ### `create-db-proxy` O código de exemplo a seguir mostra como usar `create-db-proxy`. **AWS CLI** **Criar um proxy de banco de dados para um banco de dados RDS** O exemplo `create-db-proxy` a seguir cria um proxy de banco de dados. ``` aws rds create-db-proxy \ --db-proxy-name proxyExample \ --engine-family MYSQL \ --auth Description="proxydescription1",AuthScheme="SECRETS",SecretArn="arn:aws:secretsmanager:us-west-2:123456789123:secret:secretName-1234f",IAMAuth="DISABLED",ClientPasswordAuthType="MYSQL_NATIVE_PASSWORD" \ --role-arn arn:aws:iam::123456789123:role/ProxyRole \ --vpc-subnet-ids subnetgroup1 subnetgroup2 ``` Resultado: ``` { "DBProxy": { "DBProxyName": "proxyExample", "DBProxyArn": "arn:aws:rds:us-east-1:123456789012:db-proxy:prx-0123a01b12345c0ab", "EngineFamily": "MYSQL", "VpcId": "vpc-1234567", "VpcSecuritytGroupIds": [ "sg-1234", "sg-5678", "sg-9101" ], "VpcSubnetIds": [ "subnetgroup1", "subnetgroup2" ], "Auth": "[ { "Description": "proxydescription1", "AuthScheme": "SECRETS", "SecretArn": "arn:aws:secretsmanager:us-west-2:123456789123:secret:proxysecret1-Abcd1e", "IAMAuth": "DISABLED" } ]", "RoleArn": "arn:aws:iam::12345678912:role/ProxyRole", "Endpoint": "proxyExample.proxy-ab0cd1efghij.us-east-1.rds.amazonaws.com", "RequireTLS": false, "IdleClientTimeout": 1800, "DebuggingLogging": false, "CreatedDate": "2023-04-05T16:09:33.452000+00:00", "UpdatedDate": "2023-04-13T01:49:38.568000+00:00" } } ``` Para obter mais informações, consulte [Criar um proxy do RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-setup.html#rds-proxy-creating) no *Guia do usuário do Amazon RDS* e [Criar um proxy do RDS](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-setup.html#rds-proxy-creating) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [CreateDbProxy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-proxy.html) em * Referência de comandos da AWS CLI*. ### `create-db-security-group` O código de exemplo a seguir mostra como usar `create-db-security-group`. **AWS CLI** **Criar um grupo de segurança do banco de dados do Amazon RDS** O comando `create-db-security-group` a seguir cria um novo grupo de segurança do banco de dados do Amazon RDS: ``` aws rds create-db-security-group --db-security-group-name mysecgroup --db-security-group-description "My Test Security Group" ``` No exemplo, o novo grupo de segurança do banco de dados é denominado `mysecgroup` e tem uma descrição. Resultado: ``` { "DBSecurityGroup": { "OwnerId": "123456789012", "DBSecurityGroupName": "mysecgroup", "DBSecurityGroupDescription": "My Test Security Group", "VpcId": "vpc-a1b2c3d4", "EC2SecurityGroups": [], "IPRanges": [], "DBSecurityGroupArn": "arn:aws:rds:us-west-2:123456789012:secgrp:mysecgroup" } } ``` + Para ver detalhes da API, consulte [CreateDbSecurityGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-security-group.html) em *Referência de comandos da AWS CLI*. ### `create-db-shard-group` O código de exemplo a seguir mostra como usar `create-db-shard-group`. **AWS CLI** **Exemplo 1: criar um cluster de banco de dados primário do Aurora PostgreSQL** O exemplo `create-db-cluster` a seguir cria um cluster de banco de dados primário do Aurora PostgreSQL compatível com o Aurora Serverless v2 e o Aurora Limitless Database. ``` aws rds create-db-cluster \ --db-cluster-identifier my-sv2-cluster \ --engine aurora-postgresql \ --engine-version 15.2-limitless \ --storage-type aurora-iopt1 \ --serverless-v2-scaling-configuration MinCapacity=2,MaxCapacity=16 \ --enable-limitless-database \ --master-username myuser \ --master-user-password mypassword \ --enable-cloudwatch-logs-exports postgresql ``` Resultado: ``` { "DBCluster": { "AllocatedStorage": 1, "AvailabilityZones": [ "us-east-2b", "us-east-2c", "us-east-2a" ], "BackupRetentionPeriod": 1, "DBClusterIdentifier": "my-sv2-cluster", "DBClusterParameterGroup": "default.aurora-postgresql15", "DBSubnetGroup": "default", "Status": "creating", "Endpoint": "my-sv2-cluster.cluster-cekycexample.us-east-2.rds.amazonaws.com", "ReaderEndpoint": "my-sv2-cluster.cluster-ro-cekycexample.us-east-2.rds.amazonaws.com", "MultiAZ": false, "Engine": "aurora-postgresql", "EngineVersion": "15.2-limitless", "Port": 5432, "MasterUsername": "myuser", "PreferredBackupWindow": "06:05-06:35", "PreferredMaintenanceWindow": "mon:08:25-mon:08:55", "ReadReplicaIdentifiers": [], "DBClusterMembers": [], "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sg-########", "Status": "active" } ], "HostedZoneId": "Z2XHWR1EXAMPLE", "StorageEncrypted": false, "DbClusterResourceId": "cluster-XYEDT6ML6FHIXH4Q2J1EXAMPLE", "DBClusterArn": "arn:aws:rds:us-east-2:123456789012:cluster:my-sv2-cluster", "AssociatedRoles": [], "IAMDatabaseAuthenticationEnabled": false, "ClusterCreateTime": "2024-02-19T16:24:07.771000+00:00", "EnabledCloudwatchLogsExports": [ "postgresql" ], "EngineMode": "provisioned", "DeletionProtection": false, "HttpEndpointEnabled": false, "CopyTagsToSnapshot": false, "CrossAccountClone": false, "DomainMemberships": [], "TagList": [], "StorageType": "aurora-iopt1", "AutoMinorVersionUpgrade": true, "ServerlessV2ScalingConfiguration": { "MinCapacity": 2.0, "MaxCapacity": 16.0 }, "NetworkType": "IPV4", "IOOptimizedNextAllowedModificationTime": "2024-03-21T16:24:07.781000+00:00", "LimitlessDatabase": { "Status": "not-in-use", "MinRequiredACU": 96.0 } } } ``` **Exemplo 2: criar a instância de banco de dados primária (gravadora)** O exemplo `create-db-instance` a seguir cria uma instância de banco de dados primária (gravadora) do Aurora Serverless v2. Quando você usa o console para criar um cluster de banco de dados, o Amazon RDS cria automaticamente a instância de banco de dados de gravador para o cluster de banco de dados. No entanto, ao usar a AWS CLI para criar um cluster de banco de dados, você deverá criar explicitamente a instância de banco de dados de gravador para o cluster de banco de dados usando o comando `create-db-instance` AWS da CLI. ``` aws rds create-db-instance \ --db-instance-identifier my-sv2-instance \ --db-cluster-identifier my-sv2-cluster \ --engine aurora-postgresql \ --db-instance-class db.serverless ``` Resultado: ``` { "DBInstance": { "DBInstanceIdentifier": "my-sv2-instance", "DBInstanceClass": "db.serverless", "Engine": "aurora-postgresql", "DBInstanceStatus": "creating", "MasterUsername": "myuser", "AllocatedStorage": 1, "PreferredBackupWindow": "06:05-06:35", "BackupRetentionPeriod": 1, "DBSecurityGroups": [], "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sg-########", "Status": "active" } ], "DBParameterGroups": [ { "DBParameterGroupName": "default.aurora-postgresql15", "ParameterApplyStatus": "in-sync" } ], "DBSubnetGroup": { "DBSubnetGroupName": "default", "DBSubnetGroupDescription": "default", "VpcId": "vpc-########", "SubnetGroupStatus": "Complete", "Subnets": [ { "SubnetIdentifier": "subnet-########", "SubnetAvailabilityZone": { "Name": "us-east-2c" }, "SubnetOutpost": {}, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-########", "SubnetAvailabilityZone": { "Name": "us-east-2a" }, "SubnetOutpost": {}, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-########", "SubnetAvailabilityZone": { "Name": "us-east-2b" }, "SubnetOutpost": {}, "SubnetStatus": "Active" } ] }, "PreferredMaintenanceWindow": "fri:09:01-fri:09:31", "PendingModifiedValues": { "PendingCloudwatchLogsExports": { "LogTypesToEnable": [ "postgresql" ] } }, "MultiAZ": false, "EngineVersion": "15.2-limitless", "AutoMinorVersionUpgrade": true, "ReadReplicaDBInstanceIdentifiers": [], "LicenseModel": "postgresql-license", "OptionGroupMemberships": [ { "OptionGroupName": "default:aurora-postgresql-15", "Status": "in-sync" } ], "PubliclyAccessible": false, "StorageType": "aurora-iopt1", "DbInstancePort": 0, "DBClusterIdentifier": "my-sv2-cluster", "StorageEncrypted": false, "DbiResourceId": "db-BIQTE3B3K3RM7M74SK5EXAMPLE", "CACertificateIdentifier": "rds-ca-rsa2048-g1", "DomainMemberships": [], "CopyTagsToSnapshot": false, "MonitoringInterval": 0, "PromotionTier": 1, "DBInstanceArn": "arn:aws:rds:us-east-2:123456789012:db:my-sv2-instance", "IAMDatabaseAuthenticationEnabled": false, "PerformanceInsightsEnabled": false, "DeletionProtection": false, "AssociatedRoles": [], "TagList": [], "CustomerOwnedIpEnabled": false, "BackupTarget": "region", "NetworkType": "IPV4", "StorageThroughput": 0, "CertificateDetails": { "CAIdentifier": "rds-ca-rsa2048-g1" }, "DedicatedLogVolume": false } } ``` **Exemplo 3: criar o grupo de fragmentos de banco de dados** O exemplo `create-db-shard-group` a seguir cria um grupo de fragmentos de banco de dados no cluster de banco de dados primário do Aurora PostgreSQL. ``` aws rds create-db-shard-group \ --db-shard-group-identifier my-db-shard-group \ --db-cluster-identifier my-sv2-cluster \ --max-acu 768 ``` Resultado: ``` { "DBShardGroupResourceId": "shardgroup-a6e3a0226aa243e2ac6c7a1234567890", "DBShardGroupIdentifier": "my-db-shard-group", "DBClusterIdentifier": "my-sv2-cluster", "MaxACU": 768.0, "ComputeRedundancy": 0, "Status": "creating", "PubliclyAccessible": false, "Endpoint": "my-sv2-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com" } ``` Para obter mais informações, consulte [Como usar o Amazon Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [CreateDbShardGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-shard-group.html) na *Referência de comandos da AWS CLI*. ### `create-db-snapshot` O código de exemplo a seguir mostra como usar `create-db-snapshot`. **AWS CLI** **Como criar um snapshot de banco de dados** O exemplo de `create-db-snapshot` a seguir cria um snapshot de banco de dados. ``` aws rds create-db-snapshot \ --db-instance-identifier database-mysql \ --db-snapshot-identifier mydbsnapshot ``` Resultado: ``` { "DBSnapshot": { "DBSnapshotIdentifier": "mydbsnapshot", "DBInstanceIdentifier": "database-mysql", "Engine": "mysql", "AllocatedStorage": 100, "Status": "creating", "Port": 3306, "AvailabilityZone": "us-east-1b", "VpcId": "vpc-6594f31c", "InstanceCreateTime": "2019-04-30T15:45:53.663Z", "MasterUsername": "admin", "EngineVersion": "5.6.40", "LicenseModel": "general-public-license", "SnapshotType": "manual", "Iops": 1000, "OptionGroupName": "default:mysql-5-6", "PercentProgress": 0, "StorageType": "io1", "Encrypted": true, "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot", "IAMDatabaseAuthenticationEnabled": false, "ProcessorFeatures": [], "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE" } } ``` Para obter mais informações, consulte [Criar um snapshot de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateSnapshot.html) no *Guia do usuário do Amazon RDS*. + Consulte detalhes da API em [CreateDBSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-snapshot.html) na *Referência de comandos da AWS CLI*. ### `create-db-subnet-group` O código de exemplo a seguir mostra como usar `create-db-subnet-group`. **AWS CLI** **Para criar um grupo de sub-redes de banco de dados** O exemplo `create-db-subnet-group` a seguir cria um grupo de sub-redes de banco de dados chamado `mysubnetgroup` usando sub-redes existentes. ``` aws rds create-db-subnet-group \ --db-subnet-group-name mysubnetgroup \ --db-subnet-group-description "test DB subnet group" \ --subnet-ids '["subnet-0a1dc4e1a6f123456","subnet-070dd7ecb3aaaaaaa","subnet-00f5b198bc0abcdef"]' ``` Resultado: ``` { "DBSubnetGroup": { "DBSubnetGroupName": "mysubnetgroup", "DBSubnetGroupDescription": "test DB subnet group", "VpcId": "vpc-0f08e7610a1b2c3d4", "SubnetGroupStatus": "Complete", "Subnets": [ { "SubnetIdentifier": "subnet-070dd7ecb3aaaaaaa", "SubnetAvailabilityZone": { "Name": "us-west-2b" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-00f5b198bc0abcdef", "SubnetAvailabilityZone": { "Name": "us-west-2d" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-0a1dc4e1a6f123456", "SubnetAvailabilityZone": { "Name": "us-west-2b" }, "SubnetStatus": "Active" } ], "DBSubnetGroupArn": "arn:aws:rds:us-west-2:0123456789012:subgrp:mysubnetgroup" } } ``` Para obter mais informações, consulte [Criar uma instância de banco de dados em um VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.InstanceInVPC) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [CreateDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-subnet-group.html) na *Referência de comandos da AWS CLI*. ### `create-event-subscription` O código de exemplo a seguir mostra como usar `create-event-subscription`. **AWS CLI** **Para criar uma assinatura de evento** O exemplo `create-event-subscription` a seguir cria uma assinatura para eventos de backup e recuperação para uma instância de banco de dados na conta atual da AWS. As notificações são enviadas para um tópico do Amazon Simple Notification Service, especificado por `--sns-topic-arn`. ``` aws rds create-event-subscription \ --subscription-name my-instance-events \ --source-type db-instance \ --event-categories '["backup","recovery"]' \ --sns-topic-arn arn:aws:sns:us-east-1:123456789012:interesting-events ``` Resultado: ``` { "EventSubscription": { "Status": "creating", "CustSubscriptionId": "my-instance-events", "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", "EventCategoriesList": [ "backup", "recovery" ], "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", "CustomerAwsId": "123456789012", "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", "SourceType": "db-instance", "Enabled": true } } ``` + Para ver detalhes da API, consulte [CreateEventSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-event-subscription.html) na *Referência de comandos da AWS CLI*. ### `create-global-cluster` O código de exemplo a seguir mostra como usar `create-global-cluster`. **AWS CLI** **Para criar um novo cluster de banco de dados global** O exemplo `create-global-cluster` a seguir cria um cluster de banco de dados global compatível com o Aurora MySQL. ``` aws rds create-global-cluster \ --global-cluster-identifier myglobalcluster \ --engine aurora-mysql ``` Resultado: ``` { "GlobalCluster": { "GlobalClusterIdentifier": "myglobalcluster", "GlobalClusterResourceId": "cluster-f0e523bfe07aabb", "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", "Status": "available", "Engine": "aurora-mysql", "EngineVersion": "5.7.mysql_aurora.2.07.2", "StorageEncrypted": false, "DeletionProtection": false, "GlobalClusterMembers": [] } } ``` Para obter mais informações, consulte [Criar um banco de dados global no Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-getting-started.html#aurora-global-database-creating) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [CreateGlobalCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-global-cluster.html) em *Referência de comandos da AWS CLI*. ### `create-option-group` O código de exemplo a seguir mostra como usar `create-option-group`. **AWS CLI** **Criar um grupo de opções personalizado do Amazon RDS** O comando `create-option-group` a seguir cria um novo grupo de opções do Amazon RDS para a versão `Oracle Enterprise Edition` `11.2`, is named ``MyOptionGroup` e inclui uma descrição. ``` aws rds create-option-group \ --option-group-name MyOptionGroup \ --engine-name oracle-ee \ --major-engine-version 11.2 \ --option-group-description "Oracle Database Manager Database Control" ``` Resultado: ``` { "OptionGroup": { "OptionGroupName": "myoptiongroup", "OptionGroupDescription": "Oracle Database Manager Database Control", "EngineName": "oracle-ee", "MajorEngineVersion": "11.2", "Options": [], "AllowsVpcAndNonVpcInstanceMemberships": true, "OptionGroupArn": "arn:aws:rds:us-west-2:123456789012:og:myoptiongroup" } } ``` + Para ver detalhes da API, consulte [CreateOptionGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-option-group.html) em *Referência de comandos da AWS CLI*. ### `delete-blue-green-deployment` O código de exemplo a seguir mostra como usar `delete-blue-green-deployment`. **AWS CLI** **Exemplo 1: excluir recursos em um ambiente verde para uma instância de banco de dados do RDS para MySQL** O exemplo `delete-blue-green-deployment` a seguir exclui os recursos em um ambiente verde de uma instância de banco de dados do RDS para MySQL. ``` aws rds delete-blue-green-deployment \ --blue-green-deployment-identifier bgd-v53303651eexfake \ --delete-target ``` Resultado: ``` { "BlueGreenDeployment": { "BlueGreenDeploymentIdentifier": "bgd-v53303651eexfake", "BlueGreenDeploymentName": "bgd-cli-test-instance", "Source": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance", "Target": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-rkfbpe", "SwitchoverDetails": [ { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-rkfbpe", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1-green-j382ha", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2-green-ejv4ao", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3-green-vlpz3t", "Status": "AVAILABLE" } ], "Tasks": [ { "Name": "CREATING_READ_REPLICA_OF_SOURCE", "Status": "COMPLETED" }, { "Name": "DB_ENGINE_VERSION_UPGRADE", "Status": "COMPLETED" }, { "Name": "CONFIGURE_BACKUPS", "Status": "COMPLETED" }, { "Name": "CREATING_TOPOLOGY_OF_SOURCE", "Status": "COMPLETED" } ], "Status": "DELETING", "CreateTime": "2022-02-25T21:18:51.183000+00:00", "DeleteTime": "2022-02-25T22:25:31.331000+00:00" } } ``` Para obter mais informações, consulte [Excluir uma implantação azul/verde](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments-deleting.html) no *Guia do usuário do Amazon RDS*. **Exemplo 2: excluir recursos em um ambiente verde para um cluster de banco de dados do Aurora MySQL** O exemplo `delete-blue-green-deployment` a seguir exclui os recursos em um ambiente verde de um cluster de banco de dados do Aurora MySQL. ``` aws rds delete-blue-green-deployment \ --blue-green-deployment-identifier bgd-wi89nwzglccsfake \ --delete-target ``` Resultado: ``` { "BlueGreenDeployment": { "BlueGreenDeploymentIdentifier": "bgd-wi89nwzglccsfake", "BlueGreenDeploymentName": "my-blue-green-deployment", "Source": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster", "Target": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3rnukl", "SwitchoverDetails": [ { "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster", "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3rnukl", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1-green-gpmaxf", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2-green-j2oajq", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3-green-mkxies", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint", "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint-green-4sqjrq", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint", "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint-green-gwwzlg", "Status": "AVAILABLE" } ], "Tasks": [ { "Name": "CREATING_READ_REPLICA_OF_SOURCE", "Status": "COMPLETED" }, { "Name": "DB_ENGINE_VERSION_UPGRADE", "Status": "COMPLETED" }, { "Name": "CREATE_DB_INSTANCES_FOR_CLUSTER", "Status": "COMPLETED" }, { "Name": "CREATE_CUSTOM_ENDPOINTS", "Status": "COMPLETED" } ], "Status": "DELETING", "CreateTime": "2022-02-25T21:12:00.288000+00:00", "DeleteTime": "2022-02-25T22:29:11.336000+00:00" } } ``` Para obter mais informações, consulte [Excluir uma implantação azul/verde](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments-deleting.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DeleteBlueGreenDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-blue-green-deployment.html) em *Referência de comandos da AWS CLI*. ### `delete-db-cluster-endpoint` O código de exemplo a seguir mostra como usar `delete-db-cluster-endpoint`. **AWS CLI** **Excluir um endpoint de cluster de banco de dados personalizado** O exemplo `delete-db-cluster-endpoint` a seguir exclui o endpoint de cluster de banco de dados especificado. ``` aws rds delete-db-cluster-endpoint \ --db-cluster-endpoint-identifier mycustomendpoint ``` Resultado: ``` { "DBClusterEndpointIdentifier": "mycustomendpoint", "DBClusterIdentifier": "mydbcluster", "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE", "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com", "Status": "deleting", "EndpointType": "CUSTOM", "CustomEndpointType": "READER", "StaticMembers": [ "dbinstance1", "dbinstance2", "dbinstance3" ], "ExcludedMembers": [], "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint" } ``` Para obter mais informações, consulte [Gerenciamento de conexões do Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.Endpoints.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DeleteDbClusterEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-cluster-endpoint.html) em *Referência de comandos da AWS CLI*. ### `delete-db-cluster-parameter-group` O código de exemplo a seguir mostra como usar `delete-db-cluster-parameter-group`. **AWS CLI** **Para excluir um grupo de parâmetros de cluster** O exemplo `delete-db-cluster-parameter-group` a seguir exclui o grupo de parâmetros do cluster de banco de dados especificado. ``` aws rds delete-db-cluster-parameter-group \ --db-cluster-parameter-group-name mydbclusterparametergroup ``` Este comando não produz saída. Para obter mais informações, consulte [Trabalhar com grupos de parâmetros de banco de dados e grupos de parâmetros de cluster de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DeleteDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-cluster-parameter-group.html) na *Referência de comandos da AWS CLI*. ### `delete-db-cluster-snapshot` O código de exemplo a seguir mostra como usar `delete-db-cluster-snapshot`. **AWS CLI** **Para excluir um snapshot de cluster de banco de dados** O exemplo `delete-db-cluster-snapshot` a seguir exclui o snapshot de cluster de banco de dados especificado. ``` aws rds delete-db-cluster-snapshot \ --db-cluster-snapshot-identifier mydbclustersnapshot ``` Resultado: ``` { "DBClusterSnapshot": { "AvailabilityZones": [ "us-east-1a", "us-east-1b", "us-east-1e" ], "DBClusterSnapshotIdentifier": "mydbclustersnapshot", "DBClusterIdentifier": "mydbcluster", "SnapshotCreateTime": "2019-06-18T21:21:00.469Z", "Engine": "aurora-mysql", "AllocatedStorage": 0, "Status": "available", "Port": 0, "VpcId": "vpc-6594f31c", "ClusterCreateTime": "2019-04-15T14:18:42.785Z", "MasterUsername": "myadmin", "EngineVersion": "5.7.mysql_aurora.2.04.2", "LicenseModel": "aurora-mysql", "SnapshotType": "manual", "PercentProgress": 100, "StorageEncrypted": true, "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot", "IAMDatabaseAuthenticationEnabled": false } } ``` Para obter mais informações, consulte [Excluir um snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_DeleteSnapshot.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DeleteDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-cluster-snapshot.html) na *Referência de comandos da AWS CLI*. ### `delete-db-cluster` O código de exemplo a seguir mostra como usar `delete-db-cluster`. **AWS CLI** **Exemplo 1: excluir uma instância de banco de dados em um cluster de banco de dados** O exemplo `delete-db-instance` a seguir exclui a instância de banco de dados final em um cluster de banco de dados. Você não pode excluir um cluster de banco de dados se ele contiver instâncias de banco de dados que não estejam no estado de **exclusão**. Não é possível tirar um snapshot final ao excluir uma instância de banco de dados em um cluster de banco de dados. ``` aws rds delete-db-instance \ --db-instance-identifier database-3 ``` Resultado: ``` { "DBInstance": { "DBInstanceIdentifier": "database-3", "DBInstanceClass": "db.r4.large", "Engine": "aurora-postgresql", "DBInstanceStatus": "deleting", ...output omitted... } } ``` Para obter mais informações, consulte [Excluir uma instância de banco de dados em um cluster de banco de dados do Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_DeleteInstance.html) no *Guia do usuário do Amazon Aurora*. **Exemplo 2: excluir um cluster de banco de dados** O exemplo `delete-db-cluster` a seguir exclui o cluster de banco de dados denominado `mycluster` e tira um snapshot final denominado `mycluster-final-snapshot`. O status do cluster de banco de dados fica **disponível** enquanto o snapshot está sendo obtido. Para acompanhar o progresso da exclusão, use o comando `describe-db-clusters` da CLI. ``` aws rds delete-db-cluster \ --db-cluster-identifier mycluster \ --no-skip-final-snapshot \ --final-db-snapshot-identifier mycluster-final-snapshot ``` Resultado: ``` { "DBCluster": { "AllocatedStorage": 20, "AvailabilityZones": [ "eu-central-1b", "eu-central-1c", "eu-central-1a" ], "BackupRetentionPeriod": 7, "DBClusterIdentifier": "mycluster", "DBClusterParameterGroup": "default.aurora-postgresql10", "DBSubnetGroup": "default-vpc-aa11bb22", "Status": "available", ...output omitted... } } ``` Para obter mais informações, consulte [Clusters do Aurora com Instância uma instância única de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_DeleteInstance.html#USER_DeleteInstance.LastInstance) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DeleteDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-cluster.html) na *Referência de comandos da AWS CLI*. ### `delete-db-instance-automated-backup` O código de exemplo a seguir mostra como usar `delete-db-instance-automated-backup`. **AWS CLI** **Excluir um backup automatizado replicado de uma região** O exemplo `delete-db-instance-automated-backup` a seguir exclui o backup automatizado com o nome do recurso da Amazon (ARN) especificado. ``` aws rds delete-db-instance-automated-backup \ --db-instance-automated-backups-arn "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" ``` Resultado: ``` { "DBInstanceAutomatedBackup": { "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE", "Region": "us-east-1", "DBInstanceIdentifier": "new-orcl-db", "RestoreWindow": {}, "AllocatedStorage": 20, "Status": "deleting", "Port": 1521, "AvailabilityZone": "us-east-1b", "VpcId": "vpc-########", "InstanceCreateTime": "2020-12-04T15:28:31Z", "MasterUsername": "admin", "Engine": "oracle-se2", "EngineVersion": "12.1.0.2.v21", "LicenseModel": "bring-your-own-license", "OptionGroupName": "default:oracle-se2-12-1", "Encrypted": false, "StorageType": "gp2", "IAMDatabaseAuthenticationEnabled": false, "BackupRetentionPeriod": 7, "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" } } ``` Para obter mais informações, consulte [Excluir backups replicados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html#AutomatedBackups.Delete) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [DeleteDbInstanceAutomatedBackup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-instance-automated-backup.html) em *Referência de comandos da AWS CLI*. ### `delete-db-instance` O código de exemplo a seguir mostra como usar `delete-db-instance`. **AWS CLI** **Como excluir uma instância de banco de dados** O exemplo de `delete-db-instance` a seguir exclui a instância de banco de dados especificada depois de criar um snapshot de banco de dados final chamado `test-instance-final-snap`. ``` aws rds delete-db-instance \ --db-instance-identifier test-instance \ --final-db-snapshot-identifier test-instance-final-snap ``` Resultado: ``` { "DBInstance": { "DBInstanceIdentifier": "test-instance", "DBInstanceStatus": "deleting", ...some output truncated... } } ``` + Consulte detalhes da API em [DeleteDBInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-instance.html) na *Referência de comandos da AWS CLI*. ### `delete-db-parameter-group` O código de exemplo a seguir mostra como usar `delete-db-parameter-group`. **AWS CLI** **Como excluir um grupo de parâmetros de banco de dados** O exemplo de `command` a seguir exclui um grupo de parâmetros de banco de dados. ``` aws rds delete-db-parameter-group \ --db-parameter-group-name mydbparametergroup ``` Este comando não produz saída. Para obter mais informações, consulte [ Como trabalhar com grupos de parâmetros de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) no *Guia do usuário do Amazon RDS*. + Consulte detalhes da API em [DeleteDBParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-parameter-group.html) na *Referência de comandos da AWS CLI*. ### `delete-db-proxy-endpoint` O código de exemplo a seguir mostra como usar `delete-db-proxy-endpoint`. **AWS CLI** **Para excluir um endpoint de proxy de banco de dados para um banco de dados do RDS** O exemplo `delete-db-proxy-endpoint` a seguir exclui um endpoint de proxy de banco de dados para o banco de dados de destino. ``` aws rds delete-db-proxy-endpoint \ --db-proxy-endpoint-name proxyEP1 ``` Resultado: ``` { "DBProxyEndpoint": { "DBProxyEndpointName": "proxyEP1", "DBProxyEndpointArn": "arn:aws:rds:us-east-1:123456789012:db-proxy-endpoint:prx-endpoint-0123a01b12345c0ab", "DBProxyName": "proxyExample", "Status": "deleting", "VpcId": "vpc-1234567", "VpcSecurityGroupIds": [ "sg-1234", "sg-5678" ], "VpcSubnetIds": [ "subnetgroup1", "subnetgroup2" ], "Endpoint": "proxyEP1.endpoint.proxy-ab0cd1efghij.us-east-1.rds.amazonaws.com", "CreatedDate": "2023-04-13T01:49:38.568000+00:00", "TargetRole": "READ_ONLY", "IsDefault": false } } ``` Para obter mais informações, consulte [Excluir um endpoint de proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-endpoints.html#rds-proxy-endpoints.DeletingEndpoint) no *Guia do usuário do Amazon RDS* e [Excluir um endpoint de proxy](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-endpoints.html#rds-proxy-endpoints.DeletingEndpoint) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DeleteDbProxyEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-proxy-endpoint.html) na *Referência de comandos da AWS CLI*. ### `delete-db-proxy` O código de exemplo a seguir mostra como usar `delete-db-proxy`. **AWS CLI** **Para excluir um proxy de banco de dados de um banco de dados do RDS** O exemplo `delete-db-proxy` a seguir exclui um proxy de banco de dados. ``` aws rds delete-db-proxy \ --db-proxy-name proxyExample ``` Resultado: ``` { "DBProxy": { "DBProxyName": "proxyExample", "DBProxyArn": "arn:aws:rds:us-east-1:123456789012:db-proxy:prx-0123a01b12345c0ab", "Status": "deleting", "EngineFamily": "PostgreSQL", "VpcId": "vpc-1234567", "VpcSecurityGroupIds": [ "sg-1234", "sg-5678" ], "VpcSubnetIds": [ "subnetgroup1", "subnetgroup2" ], "Auth": "[ { "Description": "proxydescription`" "AuthScheme": "SECRETS", "SecretArn": "arn:aws:secretsmanager:us-west-2:123456789123:secret:proxysecret1-Abcd1e", "IAMAuth": "DISABLED" } ], "RoleArn": "arn:aws:iam::12345678912:role/ProxyPostgreSQLRole", "Endpoint": "proxyExample.proxy-ab0cd1efghij.us-east-1.rds.amazonaws.com", "RequireTLS": false, "IdleClientTimeout": 1800, "DebuggingLogging": false, "CreatedDate": "2023-04-05T16:09:33.452000+00:00", "UpdatedDate": "2023-04-13T01:49:38.568000+00:00" } } ``` Para obter mais informações, consulte [Excluir um proxy do RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-managing.html#rds-proxy-deleting) no *Guia do usuário do Amazon RDS* e [Excluir um proxy do RDS](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-managing.html#rds-proxy-deleting) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DeleteDbProxy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-proxy.html) em *Referência de comandos da AWS CLI*. ### `delete-db-security-group` O código de exemplo a seguir mostra como usar `delete-db-security-group`. **AWS CLI** **Para excluir um grupo de segurança do banco de dados** O exemplo `delete-db-security-group` a seguir exclui um grupo de segurança denominado `mysecuritygroup`. ``` aws rds delete-db-security-group \ --db-security-group-name mysecuritygroup ``` Este comando não produz saída. Para obter mais informações, consulte [Trabalhar com grupos de segurança de banco de dados (EC2-Classic platform)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithSecurityGroups.html) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [DeleteDbSecurityGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-security-group.html) em *Referência de comandos da AWS CLI*. ### `delete-db-shard-group` O código de exemplo a seguir mostra como usar `delete-db-shard-group`. **AWS CLI** **Exemplo 1: excluir um grupo de fragmentos de banco de dados sem êxito** O exemplo `delete-db-shard-group` a seguir mostra o erro que ocorre quando você tenta excluir um grupo de fragmentos de banco de dados antes de excluir todos os bancos de dados e esquemas. ``` aws rds delete-db-shard-group \ --db-shard-group-identifier limitless-test-shard-grp ``` Resultado: ``` An error occurred (InvalidDBShardGroupState) when calling the DeleteDBShardGroup operation: Unable to delete the DB shard group limitless-test-db-shard-group. Delete all of your Limitless Database databases and schemas, then try again. ``` **Exemplo 2: excluir um grupo de fragmentos de banco de dados com êxito** O exemplo `delete-db-shard-group` a seguir exclui um grupo de fragmentos de banco de dados depois que você exclui todos os bancos de dados e esquemas, incluindo o esquema `public`. ``` aws rds delete-db-shard-group \ --db-shard-group-identifier limitless-test-shard-grp ``` Resultado: ``` { "DBShardGroupResourceId": "shardgroup-7bb446329da94788b3f957746example", "DBShardGroupIdentifier": "limitless-test-shard-grp", "DBClusterIdentifier": "limitless-test-cluster", "MaxACU": 768.0, "ComputeRedundancy": 0, "Status": "deleting", "PubliclyAccessible": true, "Endpoint": "limitless-test-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com" } ``` Para obter mais informações, consulte [Excluir clusters de banco de dados do Aurora e instâncias de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_DeleteCluster.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DeleteDbShardGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-shard-group.html) em *Referência de comandos da AWS CLI*. ### `delete-db-snapshot` O código de exemplo a seguir mostra como usar `delete-db-snapshot`. **AWS CLI** **Para excluir um snapshot de banco de dados** O exemplo `delete-db-snapshot` a seguir exclui o snapshot de banco de dados especificado. ``` aws rds delete-db-snapshot \ --db-snapshot-identifier mydbsnapshot ``` Resultado: ``` { "DBSnapshot": { "DBSnapshotIdentifier": "mydbsnapshot", "DBInstanceIdentifier": "database-mysql", "SnapshotCreateTime": "2019-06-18T22:08:40.702Z", "Engine": "mysql", "AllocatedStorage": 100, "Status": "deleted", "Port": 3306, "AvailabilityZone": "us-east-1b", "VpcId": "vpc-6594f31c", "InstanceCreateTime": "2019-04-30T15:45:53.663Z", "MasterUsername": "admin", "EngineVersion": "5.6.40", "LicenseModel": "general-public-license", "SnapshotType": "manual", "Iops": 1000, "OptionGroupName": "default:mysql-5-6", "PercentProgress": 100, "StorageType": "io1", "Encrypted": true, "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot", "IAMDatabaseAuthenticationEnabled": false, "ProcessorFeatures": [], "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE" } } ``` Para obter mais informações, consulte [Excluir um snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteSnapshot.html) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [DeleteDbSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-snapshot.html) em *Referência de comandos da AWS CLI*. ### `delete-db-subnet-group` O código de exemplo a seguir mostra como usar `delete-db-subnet-group`. **AWS CLI** **Excluir um grupo de sub-redes de banco de dados** O exemplo `delete-db-subnet-group` a seguir exclui o grupo de sub-redes de banco de dados denominado `mysubnetgroup`. ``` aws rds delete-db-subnet-group --db-subnet-group-name mysubnetgroup ``` Este comando não produz saída. Para obter mais informações, consulte [Trabalhar com uma instância de banco de dados em uma VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [DeleteDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-subnet-group.html) na *Referência de comandos da AWS CLI*. ### `delete-event-subscription` O código de exemplo a seguir mostra como usar `delete-event-subscription`. **AWS CLI** **Para excluir uma assinatura de evento** O exemplo `delete-event-subscription` a seguir exclui a assinatura especificada de um evento. ``` aws rds delete-event-subscription --subscription-name my-instance-events ``` Resultado: ``` { "EventSubscription": { "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", "CustomerAwsId": "123456789012", "Enabled": false, "SourceIdsList": [ "test-instance" ], "SourceType": "db-instance", "EventCategoriesList": [ "backup", "recovery" ], "SubscriptionCreationTime": "2018-07-31 23:22:01.893", "CustSubscriptionId": "my-instance-events", "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", "Status": "deleting" } } ``` + Para ver detalhes da API, consulte [DeleteEventSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-event-subscription.html) na *Referência de comandos da AWS CLI*. ### `delete-global-cluster` O código de exemplo a seguir mostra como usar `delete-global-cluster`. **AWS CLI** **Excluir um cluster de banco de dados global** O exemplo `delete-global-cluster` a seguir exclui um cluster de banco de dados global compatível com o Aurora MySQL. O resultado mostra o cluster que você está excluindo, mas os comandos de `describe-global-clusters` subsequentes não listam esse cluster de banco de dados. ``` aws rds delete-global-cluster \ --global-cluster-identifier myglobalcluster ``` Resultado: ``` { "GlobalCluster": { "GlobalClusterIdentifier": "myglobalcluster", "GlobalClusterResourceId": "cluster-f0e523bfe07aabb", "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", "Status": "available", "Engine": "aurora-mysql", "EngineVersion": "5.7.mysql_aurora.2.07.2", "StorageEncrypted": false, "DeletionProtection": false, "GlobalClusterMembers": [] } } ``` Para obter mais informações, consulte [Excluir um banco de dados global do Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-managing.html#aurora-global-database-deleting) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DeleteGlobalCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-global-cluster.html) em *Referência de comandos da AWS CLI*. ### `delete-option-group` O código de exemplo a seguir mostra como usar `delete-option-group`. **AWS CLI** **Excluir um grupo de opções** O exemplo `delete-option-group` a seguir exclui o grupo de opções especificado. ``` aws rds delete-option-group \ --option-group-name myoptiongroup ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir um grupo de opções](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithOptionGroups.html#USER_WorkingWithOptionGroups.Delete) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [DeleteOptionGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-option-group.html) em *Referência de comandos da AWS CLI*. ### `deregister-db-proxy-targets` O código de exemplo a seguir mostra como usar `deregister-db-proxy-targets`. **AWS CLI** **Cancelar o registro de um alvo de proxy de banco de dados do grupo de destino do banco de dados** O exemplo `deregister-db-proxy-targets` a seguir remove a associação entre o proxy `proxyExample` e seu destino. ``` aws rds deregister-db-proxy-targets \ --db-proxy-name proxyExample \ --db-instance-identifiers database-1 ``` Este comando não produz saída. Para obter mais informações, consulte [Excluir um proxy do RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-managing.html#rds-proxy-deleting) no *Guia do usuário do Amazon RDS* e [Excluir um proxy do RDS](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-managing.html#rds-proxy-deleting) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DeregisterDbProxyTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/deregister-db-proxy-targets.html) em *Referência de comandos da AWS CLI*. ### `describe-account-attributes` O código de exemplo a seguir mostra como usar `describe-account-attributes`. **AWS CLI** **Como descrever os atributos da conta** O exemplo de `describe-account-attributes` a seguir recupera os atributos da conta da AWS atual. ``` aws rds describe-account-attributes ``` Resultado: ``` { "AccountQuotas": [ { "Max": 40, "Used": 4, "AccountQuotaName": "DBInstances" }, { "Max": 40, "Used": 0, "AccountQuotaName": "ReservedDBInstances" }, { "Max": 100000, "Used": 40, "AccountQuotaName": "AllocatedStorage" }, { "Max": 25, "Used": 0, "AccountQuotaName": "DBSecurityGroups" }, { "Max": 20, "Used": 0, "AccountQuotaName": "AuthorizationsPerDBSecurityGroup" }, { "Max": 50, "Used": 1, "AccountQuotaName": "DBParameterGroups" }, { "Max": 100, "Used": 3, "AccountQuotaName": "ManualSnapshots" }, { "Max": 20, "Used": 0, "AccountQuotaName": "EventSubscriptions" }, { "Max": 50, "Used": 1, "AccountQuotaName": "DBSubnetGroups" }, { "Max": 20, "Used": 1, "AccountQuotaName": "OptionGroups" }, { "Max": 20, "Used": 6, "AccountQuotaName": "SubnetsPerDBSubnetGroup" }, { "Max": 5, "Used": 0, "AccountQuotaName": "ReadReplicasPerMaster" }, { "Max": 40, "Used": 1, "AccountQuotaName": "DBClusters" }, { "Max": 50, "Used": 0, "AccountQuotaName": "DBClusterParameterGroups" }, { "Max": 5, "Used": 0, "AccountQuotaName": "DBClusterRoles" } ] } ``` + Consulte detalhes da API em [DescribeAccountAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-account-attributes.html) na *Referência de comandos da AWS CLI*. ### `describe-blue-green-deployments` O código de exemplo a seguir mostra como usar `describe-blue-green-deployments`. **AWS CLI** **Exemplo 1: descrever uma implantação azul/verde de uma instância de banco de dados do RDS após a conclusão da criação** O exemplo `describe-blue-green-deployment` a seguir recupera os detalhes de uma implantação azul/verde após a conclusão da criação. ``` aws rds describe-blue-green-deployments \ --blue-green-deployment-identifier bgd-v53303651eexfake ``` Resultado: ``` { "BlueGreenDeployments": [ { "BlueGreenDeploymentIdentifier": "bgd-v53303651eexfake", "BlueGreenDeploymentName": "bgd-cli-test-instance", "Source": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance", "Target": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-rkfbpe", "SwitchoverDetails": [ { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-rkfbpe", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1-green-j382ha", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2-green-ejv4ao", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3-green-vlpz3t", "Status": "AVAILABLE" } ], "Tasks": [ { "Name": "CREATING_READ_REPLICA_OF_SOURCE", "Status": "COMPLETED" }, { "Name": "DB_ENGINE_VERSION_UPGRADE", "Status": "COMPLETED" }, { "Name": "CONFIGURE_BACKUPS", "Status": "COMPLETED" }, { "Name": "CREATING_TOPOLOGY_OF_SOURCE", "Status": "COMPLETED" } ], "Status": "AVAILABLE", "CreateTime": "2022-02-25T21:18:51.183000+00:00" } ] } ``` Para obter mais informações, consulte [Visualizar uma implantação azul/verde](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments-viewing.html) no *Guia do usuário do Amazon RDS*. **Exemplo 2: descrever uma implantação azul/verde para um cluster de banco de dados do Aurora MySQL** O exemplo `describe-blue-green-deployment` a seguir recupera os detalhes de uma implantação azul/verde. ``` aws rds describe-blue-green-deployments \ --blue-green-deployment-identifier bgd-wi89nwzglccsfake ``` Resultado: ``` { "BlueGreenDeployments": [ { "BlueGreenDeploymentIdentifier": "bgd-wi89nwzglccsfake", "BlueGreenDeploymentName": "my-blue-green-deployment", "Source": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster", "Target": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3rnukl", "SwitchoverDetails": [ { "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster", "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3rnukl", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1-green-gpmaxf", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2-green-j2oajq", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3-green-mkxies", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint", "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint-green-4sqjrq", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint", "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint-green-gwwzlg", "Status": "AVAILABLE" } ], "Tasks": [ { "Name": "CREATING_READ_REPLICA_OF_SOURCE", "Status": "COMPLETED" }, { "Name": "DB_ENGINE_VERSION_UPGRADE", "Status": "COMPLETED" }, { "Name": "CREATE_DB_INSTANCES_FOR_CLUSTER", "Status": "COMPLETED" }, { "Name": "CREATE_CUSTOM_ENDPOINTS", "Status": "COMPLETED" } ], "Status": "AVAILABLE", "CreateTime": "2022-02-25T21:12:00.288000+00:00" } ] } ``` Para obter mais informações, consulte [Visualizar uma implantação azul/verde](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments-viewing.html) no *Guia do usuário do Amazon Aurora*. **Exemplo 3: descrever uma implantação azul/verde para um cluster do Aurora MySQL após a transição** O exemplo `describe-blue-green-deployment` a seguir recupera os detalhes sobre uma implantação azul/verde depois que o ambiente verde é promovido para ser o ambiente de produção. ``` aws rds describe-blue-green-deployments \ --blue-green-deployment-identifier bgd-wi89nwzglccsfake ``` Resultado: ``` { "BlueGreenDeployments": [ { "BlueGreenDeploymentIdentifier": "bgd-wi89nwzglccsfake", "BlueGreenDeploymentName": "my-blue-green-deployment", "Source": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-old1", "Target": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster", "SwitchoverDetails": [ { "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-old1", "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster", "Status": "SWITCHOVER_COMPLETED" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1-old1", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1", "Status": "SWITCHOVER_COMPLETED" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2-old1", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2", "Status": "SWITCHOVER_COMPLETED" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3-old1", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3", "Status": "SWITCHOVER_COMPLETED" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint-old1", "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint", "Status": "SWITCHOVER_COMPLETED" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint-old1", "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint", "Status": "SWITCHOVER_COMPLETED" } ], "Tasks": [ { "Name": "CREATING_READ_REPLICA_OF_SOURCE", "Status": "COMPLETED" }, { "Name": "DB_ENGINE_VERSION_UPGRADE", "Status": "COMPLETED" }, { "Name": "CREATE_DB_INSTANCES_FOR_CLUSTER", "Status": "COMPLETED" }, { "Name": "CREATE_CUSTOM_ENDPOINTS", "Status": "COMPLETED" } ], "Status": "SWITCHOVER_COMPLETED", "CreateTime": "2022-02-25T22:38:49.522000+00:00" } ] } ``` Para obter mais informações, consulte [Visualizar uma implantação azul/verde](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments-viewing.html) no *Guia do usuário do Amazon Aurora*. **Exemplo 4: descrever uma implantação azul/verde combinada** O exemplo `describe-blue-green-deployment` a seguir recupera os detalhes de uma implantação azul/verde combinada. ``` aws rds describe-blue-green-deployments ``` Resultado: ``` { "BlueGreenDeployments": [ { "BlueGreenDeploymentIdentifier": "bgd-wi89nwzgfakelccs", "BlueGreenDeploymentName": "my-blue-green-deployment", "Source": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster", "Target": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3rnukl", "SwitchoverDetails": [ { "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster", "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3rnukl", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1-green-gpmaxf", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2-green-j2oajq", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3-green-mkxies", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint", "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint-green-4sqjrq", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint", "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint-green-gwwzlg", "Status": "AVAILABLE" } ], "Tasks": [ { "Name": "CREATING_READ_REPLICA_OF_SOURCE", "Status": "COMPLETED" }, { "Name": "DB_ENGINE_VERSION_UPGRADE", "Status": "COMPLETED" }, { "Name": "CREATE_DB_INSTANCES_FOR_CLUSTER", "Status": "COMPLETED" }, { "Name": "CREATE_CUSTOM_ENDPOINTS", "Status": "COMPLETED" } ], "Status": "AVAILABLE", "CreateTime": "2022-02-25T21:12:00.288000+00:00" }, { "BlueGreenDeploymentIdentifier": "bgd-v5330365fake1eex", "BlueGreenDeploymentName": "bgd-cli-test-instance", "Source": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-old1", "Target": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance", "SwitchoverDetails": [ { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-old1", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance", "Status": "SWITCHOVER_COMPLETED" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1-old1", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1", "Status": "SWITCHOVER_COMPLETED" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2-old1", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2", "Status": "SWITCHOVER_COMPLETED" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3-old1", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3", "Status": "SWITCHOVER_COMPLETED" } ], "Tasks": [ { "Name": "CREATING_READ_REPLICA_OF_SOURCE", "Status": "COMPLETED" }, { "Name": "DB_ENGINE_VERSION_UPGRADE", "Status": "COMPLETED" }, { "Name": "CONFIGURE_BACKUPS", "Status": "COMPLETED" }, { "Name": "CREATING_TOPOLOGY_OF_SOURCE", "Status": "COMPLETED" } ], "Status": "SWITCHOVER_COMPLETED", "CreateTime": "2022-02-25T22:33:22.225000+00:00" } ] } ``` Para obter mais informações, consulte [Visualizar uma implantação azul/verde](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments-viewing.html) no *Guia do usuário do Amazon RDS* e [Visualizar uma implantação azul/verde](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments-viewing.html) em *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DescribeBlueGreenDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-blue-green-deployments.html) em *Referência de comandos da AWS CLI*. ### `describe-certificates` O código de exemplo a seguir mostra como usar `describe-certificates`. **AWS CLI** **descrever certificados** O exemplo `describe-certificates` a seguir recupera os detalhes do certificado associado à região padrão do usuário. ``` aws rds describe-certificates ``` Resultado: ``` { "Certificates": [ { "CertificateIdentifier": "rds-ca-ecc384-g1", "CertificateType": "CA", "Thumbprint": "2ee3dcc06e50192559b13929e73484354f23387d", "ValidFrom": "2021-05-24T22:06:59+00:00", "ValidTill": "2121-05-24T23:06:59+00:00", "CertificateArn": "arn:aws:rds:us-west-2::cert:rds-ca-ecc384-g1", "CustomerOverride": false }, { "CertificateIdentifier": "rds-ca-rsa4096-g1", "CertificateType": "CA", "Thumbprint": "19da4f2af579a8ae1f6a0fa77aa5befd874b4cab", "ValidFrom": "2021-05-24T22:03:20+00:00", "ValidTill": "2121-05-24T23:03:20+00:00", "CertificateArn": "arn:aws:rds:us-west-2::cert:rds-ca-rsa4096-g1", "CustomerOverride": false }, { "CertificateIdentifier": "rds-ca-rsa2048-g1", "CertificateType": "CA", "Thumbprint": "7c40cb42714b6fdb2b296f9bbd0e8bb364436a76", "ValidFrom": "2021-05-24T21:59:00+00:00", "ValidTill": "2061-05-24T22:59:00+00:00", "CertificateArn": "arn:aws:rds:us-west-2::cert:rds-ca-rsa2048-g1", "CustomerOverride": true, "CustomerOverrideValidTill": "2061-05-24T22:59:00+00:00" }, { "CertificateIdentifier": "rds-ca-2019", "CertificateType": "CA", "Thumbprint": "d40ddb29e3750dffa671c3140bbf5f478d1c8096", "ValidFrom": "2019-08-22T17:08:50+00:00", "ValidTill": "2024-08-22T17:08:50+00:00", "CertificateArn": "arn:aws:rds:us-west-2::cert:rds-ca-2019", "CustomerOverride": false } ], "DefaultCertificateForNewLaunches": "rds-ca-rsa2048-g1" } ``` Para obter mais informações, consulte [Usar SSL/TLS para criptografar uma conexão com uma instância de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) no *Guia do usuário do Amazon RDS* e [Usar SSL/TLS para criptografar uma conexão com um cluster de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DescribeCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-certificates.html) na *Referência de comandos da AWS CLI*. ### `describe-db-cluster-backtracks` O código de exemplo a seguir mostra como usar `describe-db-cluster-backtracks`. **AWS CLI** **Descrever os retrocessos para um cluster de banco de dados** O exemplo `describe-db-cluster-backtracks` a seguir recupera detalhes do cluster especificado. ``` aws rds describe-db-cluster-backtracks \ --db-cluster-identifier mydbcluster ``` Resultado: ``` { "DBClusterBacktracks": [ { "DBClusterIdentifier": "mydbcluster", "BacktrackIdentifier": "2f5f5294-0dd2-44c9-9f50-EXAMPLE", "BacktrackTo": "2021-02-12T04:59:22Z", "BacktrackedFrom": "2021-02-12T14:37:31.640Z", "BacktrackRequestCreationTime": "2021-02-12T14:36:18.819Z", "Status": "COMPLETED" }, { "DBClusterIdentifier": "mydbcluster", "BacktrackIdentifier": "3c7a6421-af2a-4ea3-ae95-EXAMPLE", "BacktrackTo": "2021-02-11T22:53:46Z", "BacktrackedFrom": "2021-02-12T00:09:27.006Z", "BacktrackRequestCreationTime": "2021-02-12T00:07:53.487Z", "Status": "COMPLETED" } ] } ``` Para obter mais informações, consulte [Retroceder um cluster de banco de dados do Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Backtrack.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DescribeDbClusterBacktracks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-cluster-backtracks.html) em *Referência de comandos da AWS CLI*. ### `describe-db-cluster-endpoints` O código de exemplo a seguir mostra como usar `describe-db-cluster-endpoints`. **AWS CLI** **Exemplo 1: descrever endpoints de um cluster de banco de dados** O exemplo `describe-db-cluster-endpoints` a seguir recupera detalhes dos endpoints do cluster de banco de dados. Os tipos mais comuns de clusters do Aurora têm dois endpoints. Um endpoint é do tipo`WRITER`. Você pode usar esse endpoint para todas as instruções de SQL. O outro endpoint é do tipo`READER`. Você pode usar esse endpoint somente para SELECT e outras instruções de SQL somente leitura. ``` aws rds describe-db-cluster-endpoints ``` Resultado: ``` { "DBClusterEndpoints": [ { "DBClusterIdentifier": "my-database-1", "Endpoint": "my-database-1.cluster-cnpexample.us-east-1.rds.amazonaws.com", "Status": "creating", "EndpointType": "WRITER" }, { "DBClusterIdentifier": "my-database-1", "Endpoint": "my-database-1.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", "Status": "creating", "EndpointType": "READER" }, { "DBClusterIdentifier": "mydbcluster", "Endpoint": "mydbcluster.cluster-cnpexamle.us-east-1.rds.amazonaws.com", "Status": "available", "EndpointType": "WRITER" }, { "DBClusterIdentifier": "mydbcluster", "Endpoint": "mydbcluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", "Status": "available", "EndpointType": "READER" } ] } ``` **Exemplo 2: descrever os endpoints do cluster de banco de dados de um único cluster de banco de dados** O exemplo `describe-db-cluster-endpoints` a seguir recupera detalhes dos endpoints do cluster de banco de dados de um único cluster de banco de dados especificado. Os clusters de tecnologia sem servidor do Aurora têm apenas um único endpoint do tipo `WRITER`. ``` aws rds describe-db-cluster-endpoints \ --db-cluster-identifier serverless-cluster ``` Resultado: ``` { "DBClusterEndpoints": [ { "Status": "available", "Endpoint": "serverless-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", "DBClusterIdentifier": "serverless-cluster", "EndpointType": "WRITER" } ] } ``` Para obter mais informações, consulte [Gerenciamento de conexões do Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.Endpoints.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DescribeDbClusterEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-cluster-endpoints.html) em *Referência de comandos da AWS CLI*. ### `describe-db-cluster-parameter-groups` O código de exemplo a seguir mostra como usar `describe-db-cluster-parameter-groups`. **AWS CLI** **Descrever os grupos de parâmetros de cluster de banco de dados** O exemplo `describe-db-cluster-parameter-groups` a seguir recupera detalhes dos grupos de parâmetros de banco de dados. ``` aws rds describe-db-cluster-parameter-groups ``` Resultado: ``` { "DBClusterParameterGroups": [ { "DBClusterParameterGroupName": "default.aurora-mysql5.7", "DBParameterGroupFamily": "aurora-mysql5.7", "Description": "Default cluster parameter group for aurora-mysql5.7", "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora-mysql5.7" }, { "DBClusterParameterGroupName": "default.aurora-postgresql9.6", "DBParameterGroupFamily": "aurora-postgresql9.6", "Description": "Default cluster parameter group for aurora-postgresql9.6", "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora-postgresql9.6" }, { "DBClusterParameterGroupName": "default.aurora5.6", "DBParameterGroupFamily": "aurora5.6", "Description": "Default cluster parameter group for aurora5.6", "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora5.6" }, { "DBClusterParameterGroupName": "mydbclusterpg", "DBParameterGroupFamily": "aurora-mysql5.7", "Description": "My DB cluster parameter group", "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpg" }, { "DBClusterParameterGroupName": "mydbclusterpgcopy", "DBParameterGroupFamily": "aurora-mysql5.7", "Description": "Copy of mydbclusterpg parameter group", "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpgcopy" } ] } ``` Para obter mais informações, consulte [Trabalhar com grupos de parâmetros de banco de dados e grupos de parâmetros de cluster de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DescribeDbClusterParameterGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-cluster-parameter-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-db-cluster-parameters` O código de exemplo a seguir mostra como usar `describe-db-cluster-parameters`. **AWS CLI** **Exemplo 1: descrever os parâmetros em um grupo de parâmetros de cluster de banco de dados** O exemplo `describe-db-cluster-parameters` a seguir recupera detalhes sobre os parâmetros em um grupo de parâmetros de banco de dados. ``` aws rds describe-db-cluster-parameters \ --db-cluster-parameter-group-name mydbclusterpg ``` Resultado: ``` { "Parameters": [ { "ParameterName": "allow-suspicious-udfs", "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", "Source": "engine-default", "ApplyType": "static", "DataType": "boolean", "AllowedValues": "0,1", "IsModifiable": false, "ApplyMethod": "pending-reboot", "SupportedEngineModes": [ "provisioned" ] }, { "ParameterName": "aurora_lab_mode", "ParameterValue": "0", "Description": "Enables new features in the Aurora engine.", "Source": "engine-default", "ApplyType": "static", "DataType": "boolean", "AllowedValues": "0,1", "IsModifiable": true, "ApplyMethod": "pending-reboot", "SupportedEngineModes": [ "provisioned" ] }, ...some output truncated... ] } ``` **Exemplo 2: listar somente os nomes dos parâmetros em um grupo de parâmetros do cluster de banco de dados** O exemplo `describe-db-cluster-parameters` a seguir recupera somente os nomes dos parâmetros em um grupo de parâmetros do cluster de banco de dados. ``` aws rds describe-db-cluster-parameters \ --db-cluster-parameter-group-name default.aurora-mysql5.7 \ --query 'Parameters[].{ParameterName:ParameterName}' ``` Resultado: ``` [ { "ParameterName": "allow-suspicious-udfs" }, { "ParameterName": "aurora_binlog_read_buffer_size" }, { "ParameterName": "aurora_binlog_replication_max_yield_seconds" }, { "ParameterName": "aurora_binlog_use_large_read_buffer" }, { "ParameterName": "aurora_lab_mode" }, ...some output truncated... } ] ``` **Exemplo 3: descrever somente os parâmetros modificáveis em um grupo de parâmetros de cluster de banco de dados** O exemplo `describe-db-cluster-parameters` a seguir recupera os nomes somente dos parâmetros que você pode modificar em um grupo de parâmetros do cluster de banco de dados. ``` aws rds describe-db-cluster-parameters \ --db-cluster-parameter-group-name default.aurora-mysql5.7 \ --query 'Parameters[].{ParameterName:ParameterName,IsModifiable:IsModifiable} | [?IsModifiable == `true`]' ``` Resultado: ``` [ { "ParameterName": "aurora_binlog_read_buffer_size", "IsModifiable": true }, { "ParameterName": "aurora_binlog_replication_max_yield_seconds", "IsModifiable": true }, { "ParameterName": "aurora_binlog_use_large_read_buffer", "IsModifiable": true }, { "ParameterName": "aurora_lab_mode", "IsModifiable": true }, ...some output truncated... } ] ``` **Exemplo 4: descrever somente os parâmetros boolianos modificáveis em um grupo de parâmetros de cluster de banco de dados** O exemplo `describe-db-cluster-parameters` a seguir recupera somente os nomes dos parâmetros que você pode modificar em um grupo de parâmetros de cluster de banco de dados e que têm um tipo de dados booleano. ``` aws rds describe-db-cluster-parameters \ --db-cluster-parameter-group-name default.aurora-mysql5.7 \ --query 'Parameters[].{ParameterName:ParameterName,DataType:DataType,IsModifiable:IsModifiable} | [?DataType == `boolean`] | [?IsModifiable == `true`]' ``` Resultado: ``` [ { "DataType": "boolean", "ParameterName": "aurora_binlog_use_large_read_buffer", "IsModifiable": true }, { "DataType": "boolean", "ParameterName": "aurora_lab_mode", "IsModifiable": true }, { "DataType": "boolean", "ParameterName": "autocommit", "IsModifiable": true }, { "DataType": "boolean", "ParameterName": "automatic_sp_privileges", "IsModifiable": true }, ...some output truncated... } ] ``` Para obter mais informações, consulte [Trabalhar com grupos de parâmetros de banco de dados e grupos de parâmetros de cluster de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DescribeDbClusterParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-cluster-parameters.html) na *Referência de comandos da AWS CLI*. ### `describe-db-cluster-snapshot-attributes` O código de exemplo a seguir mostra como usar `describe-db-cluster-snapshot-attributes`. **AWS CLI** **Descrever os nomes e valores de atributos de um snapshot de cluster de banco de dados** O exemplo `describe-db-cluster-snapshot-attributes` a seguir recupera os detalhes dos nomes e valores dos atributos do snapshot do cluster do banco de dados especificado. ``` aws rds describe-db-cluster-snapshot-attributes \ --db-cluster-snapshot-identifier myclustersnapshot ``` Resultado: ``` { "DBClusterSnapshotAttributesResult": { "DBClusterSnapshotIdentifier": "myclustersnapshot", "DBClusterSnapshotAttributes": [ { "AttributeName": "restore", "AttributeValues": [ "123456789012" ] } ] } } ``` Para obter mais informações, consulte [Compartilhar um snapshot de cluster de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_ShareSnapshot.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DescribeDbClusterSnapshotAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-cluster-snapshot-attributes.html) na *Referência de comandos da AWS CLI*. ### `describe-db-cluster-snapshots` O código de exemplo a seguir mostra como usar `describe-db-cluster-snapshots`. **AWS CLI** **Descrever um snapshot de cluster de banco de dados de um cluster de banco de dados** O exemplo `describe-db-cluster-snapshots` a seguir recupera os detalhes dos snapshots do cluster de banco de dados para o cluster de banco de dados especificado. ``` aws rds describe-db-cluster-snapshots \ --db-cluster-identifier mydbcluster ``` Resultado: ``` { "DBClusterSnapshots": [ { "AvailabilityZones": [ "us-east-1a", "us-east-1b", "us-east-1e" ], "DBClusterSnapshotIdentifier": "myclustersnapshotcopy", "DBClusterIdentifier": "mydbcluster", "SnapshotCreateTime": "2019-06-04T09:16:42.649Z", "Engine": "aurora-mysql", "AllocatedStorage": 0, "Status": "available", "Port": 0, "VpcId": "vpc-6594f31c", "ClusterCreateTime": "2019-04-15T14:18:42.785Z", "MasterUsername": "myadmin", "EngineVersion": "5.7.mysql_aurora.2.04.2", "LicenseModel": "aurora-mysql", "SnapshotType": "manual", "PercentProgress": 100, "StorageEncrypted": true, "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:814387698303:cluster-snapshot:myclustersnapshotcopy", "IAMDatabaseAuthenticationEnabled": false }, { "AvailabilityZones": [ "us-east-1a", "us-east-1b", "us-east-1e" ], "DBClusterSnapshotIdentifier": "rds:mydbcluster-2019-06-20-09-16", "DBClusterIdentifier": "mydbcluster", "SnapshotCreateTime": "2019-06-20T09:16:26.569Z", "Engine": "aurora-mysql", "AllocatedStorage": 0, "Status": "available", "Port": 0, "VpcId": "vpc-6594f31c", "ClusterCreateTime": "2019-04-15T14:18:42.785Z", "MasterUsername": "myadmin", "EngineVersion": "5.7.mysql_aurora.2.04.2", "LicenseModel": "aurora-mysql", "SnapshotType": "automated", "PercentProgress": 100, "StorageEncrypted": true, "KmsKeyId": "arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE", "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:mydbcluster-2019-06-20-09-16", "IAMDatabaseAuthenticationEnabled": false } ] } ``` Para obter mais informações, consulte [Criar um snapshot de cluster de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CreateSnapshotCluster.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DescribeDbClusterSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-cluster-snapshots.html) na *Referência de comandos da AWS CLI*. ### `describe-db-clusters` O código de exemplo a seguir mostra como usar `describe-db-clusters`. **AWS CLI** **Exemplo 1: descrever um cluster** O exemplo `describe-db-clusters` a seguir recupera detalhes do cluster de banco de dados especificado. ``` aws rds describe-db-clusters \ --db-cluster-identifier mydbcluster ``` Resultado: ``` { "DBClusters": [ { "AllocatedStorage": 1, "AvailabilityZones": [ "us-east-1a", "us-east-1b", "us-east-1e" ], "BackupRetentionPeriod": 1, "DatabaseName": "mydbcluster", "DBClusterIdentifier": "mydbcluster", "DBClusterParameterGroup": "default.aurora-mysql5.7", "DBSubnetGroup": "default", "Status": "available", "EarliestRestorableTime": "2019-06-19T09:16:28.210Z", "Endpoint": "mydbcluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", "ReaderEndpoint": "mydbcluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", "MultiAZ": true, "Engine": "aurora-mysql", "EngineVersion": "5.7.mysql_aurora.2.04.2", "LatestRestorableTime": "2019-06-20T22:38:14.908Z", "Port": 3306, "MasterUsername": "myadmin", "PreferredBackupWindow": "09:09-09:39", "PreferredMaintenanceWindow": "sat:04:09-sat:04:39", "ReadReplicaIdentifiers": [], "DBClusterMembers": [ { "DBInstanceIdentifier": "dbinstance3", "IsClusterWriter": false, "DBClusterParameterGroupStatus": "in-sync", "PromotionTier": 1 }, { "DBInstanceIdentifier": "dbinstance1", "IsClusterWriter": false, "DBClusterParameterGroupStatus": "in-sync", "PromotionTier": 1 }, { "DBInstanceIdentifier": "dbinstance2", "IsClusterWriter": false, "DBClusterParameterGroupStatus": "in-sync", "PromotionTier": 1 }, { "DBInstanceIdentifier": "mydbcluster", "IsClusterWriter": false, "DBClusterParameterGroupStatus": "in-sync", "PromotionTier": 1 }, { "DBInstanceIdentifier": "mydbcluster-us-east-1b", "IsClusterWriter": false, "DBClusterParameterGroupStatus": "in-sync", "PromotionTier": 1 }, { "DBInstanceIdentifier": "mydbcluster", "IsClusterWriter": true, "DBClusterParameterGroupStatus": "in-sync", "PromotionTier": 1 } ], "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sg-0b9130572daf3dc16", "Status": "active" } ], "HostedZoneId": "Z2R2ITUGPM61AM", "StorageEncrypted": true, "KmsKeyId": "arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE", "DbClusterResourceId": "cluster-AKIAIOSFODNN7EXAMPLE", "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:mydbcluster", "AssociatedRoles": [], "IAMDatabaseAuthenticationEnabled": false, "ClusterCreateTime": "2019-04-15T14:18:42.785Z", "EngineMode": "provisioned", "DeletionProtection": false, "HttpEndpointEnabled": false } ] } ``` **Exemplo 2: listar determinados atributos de todos os clusters de banco de dados** O exemplo `describe-db-clusters` a seguir recupera somente os atributos `DBClusterIdentifier`, `Endpoint` e `ReaderEndpoint`, e atributos de todos os clusters de banco de dados na região da AWS atual. ``` aws rds describe-db-clusters \ --query 'DBClusters[].{DBClusterIdentifier:DBClusterIdentifier,Endpoint:Endpoint,ReaderEndpoint:ReaderEndpoint}' ``` Resultado: ``` [ { "Endpoint": "cluster-57-2020-05-01-2270.cluster-cnpexample.us-east-1.rds.amazonaws.com", "ReaderEndpoint": "cluster-57-2020-05-01-2270.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", "DBClusterIdentifier": "cluster-57-2020-05-01-2270" }, { "Endpoint": "cluster-57-2020-05-01-4615.cluster-cnpexample.us-east-1.rds.amazonaws.com", "ReaderEndpoint": "cluster-57-2020-05-01-4615.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", "DBClusterIdentifier": "cluster-57-2020-05-01-4615" }, { "Endpoint": "pg2-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", "ReaderEndpoint": "pg2-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", "DBClusterIdentifier": "pg2-cluster" }, ...output omitted... } ] ``` **Exemplo 3: listar clusters de banco de dados com um atributo específico** O exemplo `describe-db-clusters` a seguir recupera somente os atributos `DBClusterIdentifier` e `Engine` dos clusters de banco de dados que usam o mecanismo de banco de dados `aurora-postgresql`. ``` aws rds describe-db-clusters \ --query 'DBClusters[].{DBClusterIdentifier:DBClusterIdentifier,Engine:Engine} | [?Engine == `aurora-postgresql`]' ``` Resultado: ``` [ { "Engine": "aurora-postgresql", "DBClusterIdentifier": "pg2-cluster" } ] ``` Para obter mais informações, consulte [Clusters de banco de dados do Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DescribeDbClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-clusters.html) na *Referência de comandos da AWS CLI*. ### `describe-db-engine-versions` O código de exemplo a seguir mostra como usar `describe-db-engine-versions`. **AWS CLI** **Como descrever as versões do mecanismo de banco de dados do mecanismo de banco de dados do MySQL** O exemplo de `describe-db-engine-versions` a seguir exibe os detalhes de cada uma das versões do mecanismo de banco de dados para o mecanismo de banco de dados especificado. ``` aws rds describe-db-engine-versions \ --engine mysql ``` Resultado: ``` { "DBEngineVersions": [ { "Engine": "mysql", "EngineVersion": "5.5.46", "DBParameterGroupFamily": "mysql5.5", "DBEngineDescription": "MySQL Community Edition", "DBEngineVersionDescription": "MySQL 5.5.46", "ValidUpgradeTarget": [ { "Engine": "mysql", "EngineVersion": "5.5.53", "Description": "MySQL 5.5.53", "AutoUpgrade": false, "IsMajorVersionUpgrade": false }, { "Engine": "mysql", "EngineVersion": "5.5.54", "Description": "MySQL 5.5.54", "AutoUpgrade": false, "IsMajorVersionUpgrade": false }, { "Engine": "mysql", "EngineVersion": "5.5.57", "Description": "MySQL 5.5.57", "AutoUpgrade": false, "IsMajorVersionUpgrade": false }, ...some output truncated... ] } ``` Para obter mais informações sobre o Amazon RDS, consulte [O que é o Amazon Relational Database Service (Amazon RDS)?](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Welcome.html) no *Guia do usuário do Amazon RDS*. + Consulte detalhes da API em [DescribeDBEngineVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-engine-versions.html) na *Referência de comandos da AWS CLI*. ### `describe-db-instance-automated-backups` O código de exemplo a seguir mostra como usar `describe-db-instance-automated-backups`. **AWS CLI** **Descrever backups automatizados para uma instância de banco de dados** O exemplo `describe-db-instance-automated-backups` a seguir exibe os detalhes dos backups automatizados para a instância de banco de dados especificada. Os detalhes incluem backups automatizados replicados em outras regiões da AWS. ``` aws rds describe-db-instance-automated-backups \ --db-instance-identifier new-orcl-db ``` Resultado: ``` { "DBInstanceAutomatedBackups": [ { "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE", "Region": "us-east-1", "DBInstanceIdentifier": "new-orcl-db", "RestoreWindow": { "EarliestTime": "2020-12-07T21:05:20.939Z", "LatestTime": "2020-12-07T21:05:20.939Z" }, "AllocatedStorage": 20, "Status": "replicating", "Port": 1521, "InstanceCreateTime": "2020-12-04T15:28:31Z", "MasterUsername": "admin", "Engine": "oracle-se2", "EngineVersion": "12.1.0.2.v21", "LicenseModel": "bring-your-own-license", "OptionGroupName": "default:oracle-se2-12-1", "Encrypted": false, "StorageType": "gp2", "IAMDatabaseAuthenticationEnabled": false, "BackupRetentionPeriod": 14, "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" } ] } ``` Para obter mais informações, consulte [Descobrir informações sobre backups replicados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html#AutomatedBackups.Replicating.Describe) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [DescribeDbInstanceAutomatedBackups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-instance-automated-backups.html) em *Referência de comandos da AWS CLI*. ### `describe-db-instances` O código de exemplo a seguir mostra como usar `describe-db-instances`. **AWS CLI** **Como descrever uma instância de banco de dados** O exemplo de `describe-db-instances` a seguir recupera detalhes sobre a instância de banco de dados especificada. ``` aws rds describe-db-instances \ --db-instance-identifier mydbinstancecf ``` Resultado: ``` { "DBInstances": [ { "DBInstanceIdentifier": "mydbinstancecf", "DBInstanceClass": "db.t3.small", "Engine": "mysql", "DBInstanceStatus": "available", "MasterUsername": "masterawsuser", "Endpoint": { "Address": "mydbinstancecf.abcexample.us-east-1.rds.amazonaws.com", "Port": 3306, "HostedZoneId": "Z2R2ITUGPM61AM" }, ...some output truncated... } ] } ``` + Consulte detalhes da API em [DescribeDBInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-instances.html) na *Referência de comandos da AWS CLI*. ### `describe-db-log-files` O código de exemplo a seguir mostra como usar `describe-db-log-files`. **AWS CLI** **Descrever os arquivos de log de uma instância de banco de dados** O exemplo `describe-db-log-files` a seguir recupera detalhes dos arquivos de log da instância de banco de dados especificada. ``` aws rds describe-db-log-files -\ -db-instance-identifier test-instance ``` Resultado: ``` { "DescribeDBLogFiles": [ { "Size": 0, "LastWritten": 1533060000000, "LogFileName": "error/mysql-error-running.log" }, { "Size": 2683, "LastWritten": 1532994300000, "LogFileName": "error/mysql-error-running.log.0" }, { "Size": 107, "LastWritten": 1533057300000, "LogFileName": "error/mysql-error-running.log.18" }, { "Size": 13105, "LastWritten": 1532991000000, "LogFileName": "error/mysql-error-running.log.23" }, { "Size": 0, "LastWritten": 1533061200000, "LogFileName": "error/mysql-error.log" }, { "Size": 3519, "LastWritten": 1532989252000, "LogFileName": "mysqlUpgrade" } ] } ``` + Para ver detalhes da API, consulte [DescribeDbLogFiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-log-files.html) em *Referência de comandos da AWS CLI*. ### `describe-db-parameter-groups` O código de exemplo a seguir mostra como usar `describe-db-parameter-groups`. **AWS CLI** **Como descrever um grupo de parâmetros de banco de dados** O exemplo de `describe-db-parameter-groups` a seguir recupera detalhes sobre os grupos de parâmetros de banco de dados. ``` aws rds describe-db-parameter-groups ``` Resultado: ``` { "DBParameterGroups": [ { "DBParameterGroupName": "default.aurora-mysql5.7", "DBParameterGroupFamily": "aurora-mysql5.7", "Description": "Default parameter group for aurora-mysql5.7", "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora-mysql5.7" }, { "DBParameterGroupName": "default.aurora-postgresql9.6", "DBParameterGroupFamily": "aurora-postgresql9.6", "Description": "Default parameter group for aurora-postgresql9.6", "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora-postgresql9.6" }, { "DBParameterGroupName": "default.aurora5.6", "DBParameterGroupFamily": "aurora5.6", "Description": "Default parameter group for aurora5.6", "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora5.6" }, { "DBParameterGroupName": "default.mariadb10.1", "DBParameterGroupFamily": "mariadb10.1", "Description": "Default parameter group for mariadb10.1", "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.mariadb10.1" }, ...some output truncated... ] } ``` Para obter mais informações, consulte [ Como trabalhar com grupos de parâmetros de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) no *Guia do usuário do Amazon RDS*. + Consulte detalhes da API em [DescribeDBParameterGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-parameter-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-db-parameters` O código de exemplo a seguir mostra como usar `describe-db-parameters`. **AWS CLI** **Como descrever os parâmetros de um grupo de parâmetros de banco de dados** O exemplo de `describe-db-parameters` a seguir recupera detalhes sobre o grupo de parâmetros de banco de dados especificado. ``` aws rds describe-db-parameters \ --db-parameter-group-name mydbpg ``` Resultado: ``` { "Parameters": [ { "ParameterName": "allow-suspicious-udfs", "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", "Source": "engine-default", "ApplyType": "static", "DataType": "boolean", "AllowedValues": "0,1", "IsModifiable": false, "ApplyMethod": "pending-reboot" }, { "ParameterName": "auto_generate_certs", "Description": "Controls whether the server autogenerates SSL key and certificate files in the data directory, if they do not already exist.", "Source": "engine-default", "ApplyType": "static", "DataType": "boolean", "AllowedValues": "0,1", "IsModifiable": false, "ApplyMethod": "pending-reboot" }, ...some output truncated... ] } ``` Para obter mais informações, consulte [ Como trabalhar com grupos de parâmetros de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) no *Guia do usuário do Amazon RDS*. + Consulte detalhes da API em [DescribeDBParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-parameters.html) na *Referência de comandos da AWS CLI*. ### `describe-db-proxies` O código de exemplo a seguir mostra como usar `describe-db-proxies`. **AWS CLI** **Descrever um proxy de banco de dados para um banco de dados do RDS** O exemplo `describe-db-proxies` a seguir retorna informações sobre proxy de banco de dados. ``` aws rds describe-db-proxies ``` Resultado: ``` { "DBProxies": [ { "DBProxyName": "proxyExample1", "DBProxyArn": "arn:aws:rds:us-east-1:123456789012:db-proxy:prx-0123a01b12345c0ab", "Status": "available", "EngineFamily": "PostgreSQL", "VpcId": "vpc-1234567", "VpcSecurityGroupIds": [ "sg-1234" ], "VpcSubnetIds": [ "subnetgroup1", "subnetgroup2" ], "Auth": "[ { "Description": "proxydescription1" "AuthScheme": "SECRETS", "SecretArn": "arn:aws:secretsmanager:us-west-2:123456789123:secret:secretName-1234f", "IAMAuth": "DISABLED" } ]", "RoleArn": "arn:aws:iam::12345678912??:role/ProxyPostgreSQLRole", "Endpoint": "proxyExample1.proxy-ab0cd1efghij.us-east-1.rds.amazonaws.com", "RequireTLS": false, "IdleClientTimeout": 1800, "DebuggingLogging": false, "CreatedDate": "2023-04-05T16:09:33.452000+00:00", "UpdatedDate": "2023-04-13T01:49:38.568000+00:00" }, { "DBProxyName": "proxyExample2", "DBProxyArn": "arn:aws:rds:us-east-1:123456789012:db-proxy:prx-1234a12b23456c1ab", "Status": "available", "EngineFamily": "PostgreSQL", "VpcId": "sg-1234567", "VpcSecurityGroupIds": [ "sg-1234" ], "VpcSubnetIds": [ "subnetgroup1", "subnetgroup2" ], "Auth": "[ { "Description": "proxydescription2" "AuthScheme": "SECRETS", "SecretArn": "aarn:aws:secretsmanager:us-west-2:123456789123:secret:secretName-1234f", "IAMAuth": "DISABLED" } ]", "RoleArn": "arn:aws:iam::12345678912:role/ProxyPostgreSQLRole", "Endpoint": "proxyExample2.proxy-ab0cd1efghij.us-east-1.rds.amazonaws.com", "RequireTLS": false, "IdleClientTimeout": 1800, "DebuggingLogging": false, "CreatedDate": "2022-01-05T16:19:33.452000+00:00", "UpdatedDate": "2023-04-13T01:49:38.568000+00:00" } ] } ``` Para obter mais informações, consulte [Visualizar um proxy do RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-setup.html#rds-proxy-viewing) no *Guia do usuário do Amazon RDS* e [Visualizar um proxy do RDS](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-setup.html#rds-proxy-viewing) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DescribeDbProxies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-proxies.html) em *Referência de comandos da AWS CLI*. ### `describe-db-proxy-endpoints` O código de exemplo a seguir mostra como usar `describe-db-proxy-endpoints`. **AWS CLI** **Descrever os endpoints de um proxy de banco de dados** O exemplo `describe-db-proxy-endpoints` a seguir retorna informações sobre endpoints de proxy de banco de dados. ``` aws rds describe-db-proxy-endpoints ``` Resultado: ``` { "DBProxyEndpoints": [ { "DBProxyEndpointName": "proxyEndpoint1", "DBProxyEndpointArn": "arn:aws:rds:us-east-1:123456789012:db-proxy-endpoint:prx-endpoint-0123a01b12345c0ab", "DBProxyName": "proxyExample", "Status": "available", "VpcId": "vpc-1234567", "VpcSecurityGroupIds": [ "sg-1234" ], "VpcSubnetIds": [ "subnetgroup1", "subnetgroup2" ], "Endpoint": "proxyEndpoint1.endpoint.proxy-ab0cd1efghij.us-east-1.rds.amazonaws.com", "CreatedDate": "2023-04-05T16:09:33.452000+00:00", "TargetRole": "READ_WRITE", "IsDefault": false }, { "DBProxyEndpointName": "proxyEndpoint2", "DBProxyEndpointArn": "arn:aws:rds:us-east-1:123456789012:db-proxy-endpoint:prx-endpoint-4567a01b12345c0ab", "DBProxyName": "proxyExample2", "Status": "available", "VpcId": "vpc1234567", "VpcSecurityGroupIds": [ "sg-5678" ], "VpcSubnetIds": [ "subnetgroup1", "subnetgroup2" ], "Endpoint": "proxyEndpoint2.endpoint.proxy-cd1ef2klmnop.us-east-1.rds.amazonaws.com", "CreatedDate": "2023-04-05T16:09:33.452000+00:00", "TargetRole": "READ_WRITE", "IsDefault": false } ] } ``` Para obter mais informações, consulte [Visualizar um endpoint de proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-endpoints.html#rds-proxy-endpoints.DescribingEndpoint) no *Guia do usuário do Amazon RDS* e [Criar um endpoint de proxy](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-endpoints.html#rds-proxy-endpoints.DescribingEndpoint) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DescribeDbProxyEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-proxy-endpoints.html) em *Referência de comandos da AWS CLI*. ### `describe-db-proxy-target-groups` O código de exemplo a seguir mostra como usar `describe-db-proxy-target-groups`. **AWS CLI** **Descrever os endpoints de um proxy de banco de dados** O exemplo `describe-db-proxy-target-groups` a seguir retorna informações sobre grupos de destino de proxy de banco de dados. ``` aws rds describe-db-proxy-target-groups \ --db-proxy-name proxyExample ``` Resultado: ``` { "TargetGroups": { "DBProxyName": "proxyExample", "TargetGroupName": "default", "TargetGroupArn": "arn:aws:rds:us-east-1:123456789012:target-group:prx-tg-0123a01b12345c0ab", "IsDefault": true, "Status": "available", "ConnectionPoolConfig": { "MaxConnectionsPercent": 100, "MaxIdleConnectionsPercent": 50, "ConnectionBorrowTimeout": 120, "SessionPinningFilters": [] }, "CreatedDate": "2023-05-02T18:41:19.495000+00:00", "UpdatedDate": "2023-05-02T18:41:21.762000+00:00" } } ``` Para obter mais informações, consulte [Visualizar um proxy do RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-setup.html#rds-proxy-viewing) no *Guia do usuário do Amazon RDS* e [Visualizar um proxy do RDS](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-setup.html#rds-proxy-viewing) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DescribeDbProxyTargetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-proxy-target-groups.html) em *Referência de comandos da AWS CLI*. ### `describe-db-proxy-targets` O código de exemplo a seguir mostra como usar `describe-db-proxy-targets`. **AWS CLI** **Descrever os alvos do proxy do banco de dados** O exemplo `describe-db-proxy-targets` a seguir retorna informações sobre destinos do proxy do banco de dados. ``` aws rds describe-db-proxy-targets \ --db-proxy-name proxyExample ``` Resultado: ``` { "Targets": [ { "Endpoint": "database1.ab0cd1efghij.us-east-1.rds.amazonaws.com", "TrackedClusterId": "database1", "RdsResourceId": "database1-instance-1", "Port": 3306, "Type": "RDS_INSTANCE", "Role": "READ_WRITE", "TargetHealth": { "State": "UNAVAILABLE", "Reason": "PENDING_PROXY_CAPACITY", "Description": "DBProxy Target is waiting for proxy to scale to desired capacity" } } ] } ``` Para obter mais informações, consulte [Visualizar um proxy do RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-setup.html#rds-proxy-viewing) no *Guia do usuário do Amazon RDS* e [Visualizar um proxy do RDS](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-setup.html#rds-proxy-viewing) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DescribeDbProxyTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-proxy-targets.html) em *Referência de comandos da AWS CLI*. ### `describe-db-recommendations` O código de exemplo a seguir mostra como usar `describe-db-recommendations`. **AWS CLI** **Exemplo 1: listar todas as recomendações de banco de dados** O exemplo `describe-db-recommendations` a seguir lista todas as recomendações de banco de dados em sua conta da AWS. ``` aws rds describe-db-recommendations ``` Resultado: ``` { "DBRecommendations": [ { "RecommendationId": "12ab3cde-f456-7g8h-9012-i3j45678k9lm", "TypeId": "config_recommendation::old_minor_version", "Severity": "informational", "ResourceArn": "arn:aws:rds:us-west-2:111122223333:db:database-1", "Status": "active", "CreatedTime": "2024-02-21T23:14:19.292000+00:00", "UpdatedTime": "2024-02-21T23:14:19+00:00", "Detection": "**[resource-name]** is not running the latest minor DB engine version", "Recommendation": "Upgrade to latest engine version", "Description": "Your database resources aren't running the latest minor DB engine version. The latest minor version contains the latest security fixes and other improvements.", "RecommendedActions": [ { "ActionId": "12ab34c5de6fg7h89i0jk1lm234n5678", "Operation": "modifyDbInstance", "Parameters": [ { "Key": "EngineVersion", "Value": "5.7.44" }, { "Key": "DBInstanceIdentifier", "Value": "database-1" } ], "ApplyModes": [ "immediately", "next-maintenance-window" ], "Status": "ready", "ContextAttributes": [ { "Key": "Recommended value", "Value": "5.7.44" }, { "Key": "Current engine version", "Value": "5.7.42" } ] } ], "Category": "security", "Source": "RDS", "TypeDetection": "**[resource-count] resources** are not running the latest minor DB engine version", "TypeRecommendation": "Upgrade to latest engine version", "Impact": "Reduced database performance and data security at risk", "AdditionalInfo": "We recommend that you maintain your database with the latest DB engine minor version as this version includes the latest security and functionality fixes. The DB engine minor version upgrades contain only the changes which are backward-compatible with earlier minor versions of the same major version of the DB engine.", "Links": [ { "Text": "Upgrading an RDS DB instance engine version", "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html" }, { "Text": "Using Amazon RDS Blue/Green Deployments for database updates for Amazon Aurora", "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html" }, { "Text": "Using Amazon RDS Blue/Green Deployments for database updates for Amazon RDS", "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html" } ] } ] } ``` Para obter mais informações, consulte [Visualizar e responder às recomendações do Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/monitoring-recommendations.html) no *Guia do usuário do Amazon RDS* e [Visualizar e responder às recomendações do Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/monitoring-recommendations.html) no *Guia do usuário do Amazon Aurora*. **Exemplo 2: listar recomendações de banco de dados de alta severidade** O exemplo `describe-db-recommendations` a seguir lista recomendações de banco de dados de alta severidade em sua conta da AWS. ``` aws rds describe-db-recommendations \ --filters Name=severity,Values=high ``` Resultado: ``` { "DBRecommendations": [ { "RecommendationId": "12ab3cde-f456-7g8h-9012-i3j45678k9lm", "TypeId": "config_recommendation::rds_extended_support", "Severity": "high", "ResourceArn": "arn:aws:rds:us-west-2:111122223333:db:database-1", "Status": "active", "CreatedTime": "2024-02-21T23:14:19.392000+00:00", "UpdatedTime": "2024-02-21T23:14:19+00:00", "Detection": "Your databases will be auto-enrolled to RDS Extended Support on February 29", "Recommendation": "Upgrade your major version before February 29, 2024 to avoid additional charges", "Description": "Your PostgreSQL 11 and MySQL 5.7 databases will be automatically enrolled into RDS Extended Support on February 29, 2024. To avoid the increase in charges due to RDS Extended Support, we recommend upgrading your databases to a newer major engine version before February 29, 2024.\nTo learn more about the RDS Extended Support pricing, refer to the pricing page.", "RecommendedActions": [ { "ActionId": "12ab34c5de6fg7h89i0jk1lm234n5678", "Parameters": [], "ApplyModes": [ "manual" ], "Status": "ready", "ContextAttributes": [] } ], "Category": "cost optimization", "Source": "RDS", "TypeDetection": "Your database will be auto-enrolled to RDS Extended Support on February 29", "TypeRecommendation": "Upgrade your major version before February 29, 2024 to avoid additional charges", "Impact": "Increase in charges due to RDS Extended Support", "AdditionalInfo": "With Amazon RDS Extended Support, you can continue running your database on a major engine version past the RDS end of standard support date for an additional cost. This paid feature gives you more time to upgrade to a supported major engine version.\nDuring Extended Support, Amazon RDS will supply critical CVE patches and bug fixes.", "Links": [ { "Text": "Amazon RDS Extended Support pricing for RDS for MySQL", "Url": "https://aws.amazon.com/rds/mysql/pricing/" }, { "Text": "Amazon RDS Extended Support for RDS for MySQL and PostgreSQL databases", "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html" }, { "Text": "Amazon RDS Extended Support pricing for Amazon Aurora PostgreSQL", "Url": "https://aws.amazon.com/rds/aurora/pricing/" }, { "Text": "Amazon RDS Extended Support for Aurora PostgreSQL databases", "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html" }, { "Text": "Amazon RDS Extended Support pricing for RDS for PostgreSQL", "Url": "https://aws.amazon.com/rds/postgresql/pricing/" } ] } ] } ``` Para obter mais informações, consulte [Visualizar e responder às recomendações do Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/monitoring-recommendations.html) no *Guia do usuário do Amazon RDS* e [Visualizar e responder às recomendações do Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/monitoring-recommendations.html) no *Guia do usuário do Amazon Aurora*. **Exemplo 3: listar recomendações de banco de dados para uma instância de banco de dados especificada** O exemplo `describe-db-recommendations` a seguir lista todas as recomendações de banco de dados para uma instância de banco de dados especificada. ``` aws rds describe-db-recommendations \ --filters Name=dbi-resource-id,Values=database-1 ``` Resultado: ``` { "DBRecommendations": [ { "RecommendationId": "12ab3cde-f456-7g8h-9012-i3j45678k9lm", "TypeId": "config_recommendation::old_minor_version", "Severity": "informational", "ResourceArn": "arn:aws:rds:us-west-2:111122223333:db:database-1", "Status": "active", "CreatedTime": "2024-02-21T23:14:19.292000+00:00", "UpdatedTime": "2024-02-21T23:14:19+00:00", "Detection": "**[resource-name]** is not running the latest minor DB engine version", "Recommendation": "Upgrade to latest engine version", "Description": "Your database resources aren't running the latest minor DB engine version. The latest minor version contains the latest security fixes and other improvements.", "RecommendedActions": [ { "ActionId": "12ab34c5de6fg7h89i0jk1lm234n5678", "Operation": "modifyDbInstance", "Parameters": [ { "Key": "EngineVersion", "Value": "5.7.44" }, { "Key": "DBInstanceIdentifier", "Value": "database-1" } ], "ApplyModes": [ "immediately", "next-maintenance-window" ], "Status": "ready", "ContextAttributes": [ { "Key": "Recommended value", "Value": "5.7.44" }, { "Key": "Current engine version", "Value": "5.7.42" } ] } ], "Category": "security", "Source": "RDS", "TypeDetection": "**[resource-count] resources** are not running the latest minor DB engine version", "TypeRecommendation": "Upgrade to latest engine version", "Impact": "Reduced database performance and data security at risk", "AdditionalInfo": "We recommend that you maintain your database with the latest DB engine minor version as this version includes the latest security and functionality fixes. The DB engine minor version upgrades contain only the changes which are backward-compatible with earlier minor versions of the same major version of the DB engine.", "Links": [ { "Text": "Upgrading an RDS DB instance engine version", "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html" }, { "Text": "Using Amazon RDS Blue/Green Deployments for database updates for Amazon Aurora", "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html" }, { "Text": "Using Amazon RDS Blue/Green Deployments for database updates for Amazon RDS", "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html" } ] } ] } ``` Para obter mais informações, consulte [Visualizar e responder às recomendações do Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/monitoring-recommendations.html) no *Guia do usuário do Amazon RDS* e [Visualizar e responder às recomendações do Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/monitoring-recommendations.html) no *Guia do usuário do Amazon Aurora*. **Exemplo 4: listar todas as recomendações ativas do banco de dados** O exemplo `describe-db-recommendations` a seguir lista todas as recomendações ativas de banco de dados em sua conta da AWS. ``` aws rds describe-db-recommendations \ --filters Name=status,Values=active ``` Resultado: ``` { "DBRecommendations": [ { "RecommendationId": "12ab3cde-f456-7g8h-9012-i3j45678k9lm", "TypeId": "config_recommendation::old_minor_version", "Severity": "informational", "ResourceArn": "arn:aws:rds:us-west-2:111122223333:db:database-1", "Status": "active", "CreatedTime": "2024-02-21T23:14:19.292000+00:00", "UpdatedTime": "2024-02-21T23:14:19+00:00", "Detection": "**[resource-name]** is not running the latest minor DB engine version", "Recommendation": "Upgrade to latest engine version", "Description": "Your database resources aren't running the latest minor DB engine version. The latest minor version contains the latest security fixes and other improvements.", "RecommendedActions": [ { "ActionId": "12ab34c5de6fg7h89i0jk1lm234n5678", "Operation": "modifyDbInstance", "Parameters": [ { "Key": "EngineVersion", "Value": "5.7.44" }, { "Key": "DBInstanceIdentifier", "Value": "database-1" } ], "ApplyModes": [ "immediately", "next-maintenance-window" ], "Status": "ready", "ContextAttributes": [ { "Key": "Recommended value", "Value": "5.7.44" }, { "Key": "Current engine version", "Value": "5.7.42" } ] } ], "Category": "security", "Source": "RDS", "TypeDetection": "**[resource-count] resources** are not running the latest minor DB engine version", "TypeRecommendation": "Upgrade to latest engine version", "Impact": "Reduced database performance and data security at risk", "AdditionalInfo": "We recommend that you maintain your database with the latest DB engine minor version as this version includes the latest security and functionality fixes. The DB engine minor version upgrades contain only the changes which are backward-compatible with earlier minor versions of the same major version of the DB engine.", "Links": [ { "Text": "Upgrading an RDS DB instance engine version", "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html" }, { "Text": "Using Amazon RDS Blue/Green Deployments for database updates for Amazon Aurora", "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html" }, { "Text": "Using Amazon RDS Blue/Green Deployments for database updates for Amazon RDS", "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html" } ] } ] } ``` Para obter mais informações, consulte [Visualizar e responder às recomendações do Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/monitoring-recommendations.html) no *Guia do usuário do Amazon RDS* e [Visualizar e responder às recomendações do Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/monitoring-recommendations.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DescribeDbRecommendations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-recommendations.html) em *Referência de comandos da AWS CLI*. ### `describe-db-security-groups` O código de exemplo a seguir mostra como usar `describe-db-security-groups`. **AWS CLI** **Listar grupos de segurança de banco de dados** O exemplo `describe-db-security-groups` a seguir lista os grupos de segurança do banco de dados. ``` aws rds describe-db-security-groups ``` Resultado: ``` { "DBSecurityGroups": [ { "OwnerId": "123456789012", "DBSecurityGroupName": "default", "DBSecurityGroupDescription": "default", "EC2SecurityGroups": [], "IPRanges": [], "DBSecurityGroupArn": "arn:aws:rds:us-west-1:111122223333:secgrp:default" }, { "OwnerId": "123456789012", "DBSecurityGroupName": "mysecgroup", "DBSecurityGroupDescription": "My Test Security Group", "VpcId": "vpc-1234567f", "EC2SecurityGroups": [], "IPRanges": [], "DBSecurityGroupArn": "arn:aws:rds:us-west-1:111122223333:secgrp:mysecgroup" } ] } ``` Para obter mais informações, consulte [Listar grupos de segurança disponíveis do banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithSecurityGroups.html#USER_WorkingWithSecurityGroups.Listing) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [DescribeDbSecurityGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-security-groups.html) em *Referência de comandos da AWS CLI*. ### `describe-db-shard-groups` O código de exemplo a seguir mostra como usar `describe-db-shard-groups`. **AWS CLI** **Exemplo 1: descrever grupos de fragmentos de banco de dados** O exemplo `describe-db-shard-groups` a seguir recupera detalhes dos grupos de fragmentos de banco de dados. ``` aws rds describe-db-shard-groups ``` Resultado: ``` { "DBShardGroups": [ { "DBShardGroupResourceId": "shardgroup-7bb446329da94788b3f957746example", "DBShardGroupIdentifier": "limitless-test-shard-grp", "DBClusterIdentifier": "limitless-test-cluster", "MaxACU": 768.0, "ComputeRedundancy": 0, "Status": "available", "PubliclyAccessible": true, "Endpoint": "limitless-test-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com" }, { "DBShardGroupResourceId": "shardgroup-a6e3a0226aa243e2ac6c7a1234567890", "DBShardGroupIdentifier": "my-db-shard-group", "DBClusterIdentifier": "my-sv2-cluster", "MaxACU": 768.0, "ComputeRedundancy": 0, "Status": "available", "PubliclyAccessible": false, "Endpoint": "my-sv2-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com" } ] } ``` Para obter mais informações, consulte [Clusters de banco de dados do Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DescribeDbShardGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-shard-groups.html) em *Referência de comandos da AWS CLI*. ### `describe-db-snapshot-attributes` O código de exemplo a seguir mostra como usar `describe-db-snapshot-attributes`. **AWS CLI** **Descrever os nomes e valores dos atributos de um snapshot de banco de dados** O exemplo `describe-db-snapshot-attributes` a seguir descreve os nomes e valores de atributos de m snapshot de banco de dados. ``` aws rds describe-db-snapshot-attributes \ --db-snapshot-identifier mydbsnapshot ``` Resultado: ``` { "DBSnapshotAttributesResult": { "DBSnapshotIdentifier": "mydbsnapshot", "DBSnapshotAttributes": [ { "AttributeName": "restore", "AttributeValues": [ "123456789012", "210987654321" ] } ] } } ``` Para obter mais informações, consulte [Compartilhar um snapshot de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ShareSnapshot.html) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [DescribeDbSnapshotAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-snapshot-attributes.html) em *Referência de comandos da AWS CLI*. ### `describe-db-snapshots` O código de exemplo a seguir mostra como usar `describe-db-snapshots`. **AWS CLI** **Exemplo 1: como descrever um snapshot de banco de dados de uma instância de banco de dados** O exemplo de `describe-db-snapshots` a seguir recupera os detalhes de um snapshot de banco de dados para uma instância de banco de dados. ``` aws rds describe-db-snapshots \ --db-snapshot-identifier mydbsnapshot ``` Resultado: ``` { "DBSnapshots": [ { "DBSnapshotIdentifier": "mydbsnapshot", "DBInstanceIdentifier": "mysqldb", "SnapshotCreateTime": "2018-02-08T22:28:08.598Z", "Engine": "mysql", "AllocatedStorage": 20, "Status": "available", "Port": 3306, "AvailabilityZone": "us-east-1f", "VpcId": "vpc-6594f31c", "InstanceCreateTime": "2018-02-08T22:24:55.973Z", "MasterUsername": "mysqladmin", "EngineVersion": "5.6.37", "LicenseModel": "general-public-license", "SnapshotType": "manual", "OptionGroupName": "default:mysql-5-6", "PercentProgress": 100, "StorageType": "gp2", "Encrypted": false, "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot", "IAMDatabaseAuthenticationEnabled": false, "ProcessorFeatures": [], "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE" } ] } ``` Para obter mais informações, consulte [Criar um snapshot de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateSnapshot.html) no *Guia do usuário do Amazon RDS*. **Exemplo 2: como encontrar o número de snapshots manuais criados** O exemplo de `describe-db-snapshots` a seguir usa o operador `length` na opção `--query` para retornar o número de snapshots manuais que foram criados em uma determinada região da AWS. ``` aws rds describe-db-snapshots \ --snapshot-type manual \ --query "length(*[].{DBSnapshots:SnapshotType})" \ --region eu-central-1 ``` Resultado: ``` 35 ``` Para obter mais informações, consulte [Criar um snapshot de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateSnapshot.html) no *Guia do usuário do Amazon RDS*. + Consulte detalhes da API em [DescribeDBSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-snapshots.html) na *Referência de comandos da AWS CLI*. ### `describe-db-subnet-groups` O código de exemplo a seguir mostra como usar `describe-db-subnet-groups`. **AWS CLI** **Descrever um grupo de sub-redes de banco de dados** O exemplo `describe-db-subnet-groups` a seguir recupera detalhes do grupo de sub-redes de banco de dados especificado. ``` aws rds describe-db-subnet-groups ``` Resultado: ``` { "DBSubnetGroups": [ { "DBSubnetGroupName": "mydbsubnetgroup", "DBSubnetGroupDescription": "My DB Subnet Group", "VpcId": "vpc-971c12ee", "SubnetGroupStatus": "Complete", "Subnets": [ { "SubnetIdentifier": "subnet-d8c8e7f4", "SubnetAvailabilityZone": { "Name": "us-east-1a" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-718fdc7d", "SubnetAvailabilityZone": { "Name": "us-east-1f" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-cbc8e7e7", "SubnetAvailabilityZone": { "Name": "us-east-1a" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-0ccde220", "SubnetAvailabilityZone": { "Name": "us-east-1a" }, "SubnetStatus": "Active" } ], "DBSubnetGroupArn": "arn:aws:rds:us-east-1:123456789012:subgrp:mydbsubnetgroup" } ] } ``` Para obter mais informações, consulte [Nuvem privada virtual (VPC) da Amazon e Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [DescribeDbSubnetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-subnet-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-engine-default-cluster-parameters` O código de exemplo a seguir mostra como usar `describe-engine-default-cluster-parameters`. **AWS CLI** **Descrever informações sobre o mecanismo padrão e parâmetros do sistema do mecanismo de banco de dados do Aurora** O exemplo `describe-engine-default-cluster-parameters` a seguir recupera os detalhes do mecanismo padrão e as informações dos parâmetros do sistema para clusters de banco de dados do Aurora compatíveis com o MySQL 5.7. ``` aws rds describe-engine-default-cluster-parameters \ --db-parameter-group-family aurora-mysql5.7 ``` Resultado: ``` { "EngineDefaults": { "Parameters": [ { "ParameterName": "aurora_load_from_s3_role", "Description": "IAM role ARN used to load data from AWS S3", "Source": "engine-default", "ApplyType": "dynamic", "DataType": "string", "IsModifiable": true, "SupportedEngineModes": [ "provisioned" ] }, ...some output truncated... ] } } ``` Para obter mais informações, consulte [Trabalhar com grupos de parâmetros de banco de dados e grupos de parâmetros de cluster de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DescribeEngineDefaultClusterParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-engine-default-cluster-parameters.html) na *Referência de comandos da AWS CLI*. ### `describe-engine-default-parameters` O código de exemplo a seguir mostra como usar `describe-engine-default-parameters`. **AWS CLI** **Para descrever informações sobre o mecanismo padrão e parâmetros do sistema para o mecanismo de banco de dados** O exemplo `describe-engine-default-parameters` a seguir recupera os detalhes do mecanismo padrão e informações sobre parâmetros do sistema para instâncias de banco de dados MySQL 5.7. ``` aws rds describe-engine-default-parameters \ --db-parameter-group-family mysql5.7 ``` Resultado: ``` { "EngineDefaults": { "Parameters": [ { "ParameterName": "allow-suspicious-udfs", "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", "Source": "engine-default", "ApplyType": "static", "DataType": "boolean", "AllowedValues": "0,1", "IsModifiable": false }, ...some output truncated... ] } } ``` Para obter mais informações, consulte [ Como trabalhar com grupos de parâmetros de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [DescribeEngineDefaultParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-engine-default-parameters.html) na *Referência de comandos da AWS CLI*. ### `describe-event-categories` O código de exemplo a seguir mostra como usar `describe-event-categories`. **AWS CLI** **Para descrever categorias de eventos** O exemplo `describe-event-categories` a seguir recupera detalhes sobre as categorias de eventos para todas as fontes de eventos disponíveis. ``` aws rds describe-event-categories ``` Resultado: ``` { "EventCategoriesMapList": [ { "SourceType": "db-instance", "EventCategories": [ "deletion", "read replica", "failover", "restoration", "maintenance", "low storage", "configuration change", "backup", "creation", "availability", "recovery", "failure", "backtrack", "notification" ] }, { "SourceType": "db-security-group", "EventCategories": [ "configuration change", "failure" ] }, { "SourceType": "db-parameter-group", "EventCategories": [ "configuration change" ] }, { "SourceType": "db-snapshot", "EventCategories": [ "deletion", "creation", "restoration", "notification" ] }, { "SourceType": "db-cluster", "EventCategories": [ "failover", "failure", "notification" ] }, { "SourceType": "db-cluster-snapshot", "EventCategories": [ "backup" ] } ] } ``` + Para ver detalhes da API, consulte [DescribeEventCategories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-event-categories.html) na *Referência de comandos da AWS CLI*. ### `describe-event-subscriptions` O código de exemplo a seguir mostra como usar `describe-event-subscriptions`. **AWS CLI** **Para descrever assinaturas de eventos** Este exemplo descreve todas as assinaturas de eventos do Amazon RDS para a conta da AWS atual. ``` aws rds describe-event-subscriptions ``` Resultado: ``` { "EventSubscriptionsList": [ { "EventCategoriesList": [ "backup", "recovery" ], "Enabled": true, "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", "Status": "creating", "SourceType": "db-instance", "CustomerAwsId": "123456789012", "SubscriptionCreationTime": "2018-07-31 23:22:01.893", "CustSubscriptionId": "my-instance-events", "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events" }, ...some output truncated... ] } ``` + Para ver detalhes da API, consulte [DescribeEventSubscriptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-event-subscriptions.html) na *Referência de comandos da AWS CLI*. ### `describe-events` O código de exemplo a seguir mostra como usar `describe-events`. **AWS CLI** **Para descrever eventos** O exemplo `describe-events` a seguir recupera detalhes dos eventos que ocorreram para a instância de banco de dados especificada. ``` aws rds describe-events \ --source-identifier test-instance \ --source-type db-instance ``` Resultado: ``` { "Events": [ { "SourceType": "db-instance", "SourceIdentifier": "test-instance", "EventCategories": [ "backup" ], "Message": "Backing up DB instance", "Date": "2018-07-31T23:09:23.983Z", "SourceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance" }, { "SourceType": "db-instance", "SourceIdentifier": "test-instance", "EventCategories": [ "backup" ], "Message": "Finished DB Instance backup", "Date": "2018-07-31T23:15:13.049Z", "SourceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance" } ] } ``` + Para ver detalhes da API, consulte [DescribeEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-events.html) na *Referência de comandos da AWS CLI*. ### `describe-export-tasks` O código de exemplo a seguir mostra como usar `describe-export-tasks`. **AWS CLI** **Descrever tarefas de exportação de snapshots** O exemplo `describe-export-tasks` a seguir retorna informações sobre exportações de snapshots para o Amazon S3. ``` aws rds describe-export-tasks ``` Resultado: ``` { "ExportTasks": [ { "ExportTaskIdentifier": "test-snapshot-export", "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:test-snapshot", "SnapshotTime": "2020-03-02T18:26:28.163Z", "TaskStartTime": "2020-03-02T18:57:56.896Z", "TaskEndTime": "2020-03-02T19:10:31.985Z", "S3Bucket": "amzn-s3-demo-bucket", "S3Prefix": "", "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole", "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff", "Status": "COMPLETE", "PercentProgress": 100, "TotalExtractedDataInGB": 0 }, { "ExportTaskIdentifier": "my-s3-export", "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test", "SnapshotTime": "2020-03-27T20:48:42.023Z", "S3Bucket": "amzn-s3-demo-bucket", "S3Prefix": "", "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole", "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff", "Status": "STARTING", "PercentProgress": 0, "TotalExtractedDataInGB": 0 } ] } ``` Para obter mais informações, consulte [Monitorar exportações de snapshots](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ExportSnapshot.html#USER_ExportSnapshot.Monitoring) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [DescribeExportTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-export-tasks.html) na *Referência de comandos da AWS CLI*. ### `describe-global-clusters` O código de exemplo a seguir mostra como usar `describe-global-clusters`. **AWS CLI** **Descrever clusters de banco de dados globais** O exemplo `describe-global-clusters` a seguir lista os clusters de banco de dados globais do Aurora na região da AWS atual. ``` aws rds describe-global-clusters ``` Resultado: ``` { "GlobalClusters": [ { "GlobalClusterIdentifier": "myglobalcluster", "GlobalClusterResourceId": "cluster-f5982077e3b5aabb", "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", "Status": "available", "Engine": "aurora-mysql", "EngineVersion": "5.7.mysql_aurora.2.07.2", "StorageEncrypted": false, "DeletionProtection": false, "GlobalClusterMembers": [] } ] } ``` Para obter mais informações, consulte [Gerenciar um banco de dados global do Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-managing.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DescribeGlobalClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-global-clusters.html) em *Referência de comandos da AWS CLI*. ### `describe-option-group-options` O código de exemplo a seguir mostra como usar `describe-option-group-options`. **AWS CLI** **Descrever todas as opções disponíveis** O exemplo `describe-option-group-options` a seguir lista duas opções para uma instância do Oracle Database 19c. ``` aws rds describe-option-group-options \ --engine-name oracle-ee \ --major-engine-version 19 \ --max-items 2 ``` Resultado: ``` { "OptionGroupOptions": [ { "Name": "APEX", "Description": "Oracle Application Express Runtime Environment", "EngineName": "oracle-ee", "MajorEngineVersion": "19", "MinimumRequiredMinorEngineVersion": "0.0.0.ru-2019-07.rur-2019-07.r1", "PortRequired": false, "OptionsDependedOn": [], "OptionsConflictsWith": [], "Persistent": false, "Permanent": false, "RequiresAutoMinorEngineVersionUpgrade": false, "VpcOnly": false, "SupportsOptionVersionDowngrade": false, "OptionGroupOptionSettings": [], "OptionGroupOptionVersions": [ { "Version": "19.1.v1", "IsDefault": true }, { "Version": "19.2.v1", "IsDefault": false } ] }, { "Name": "APEX-DEV", "Description": "Oracle Application Express Development Environment", "EngineName": "oracle-ee", "MajorEngineVersion": "19", "MinimumRequiredMinorEngineVersion": "0.0.0.ru-2019-07.rur-2019-07.r1", "PortRequired": false, "OptionsDependedOn": [ "APEX" ], "OptionsConflictsWith": [], "Persistent": false, "Permanent": false, "RequiresAutoMinorEngineVersionUpgrade": false, "VpcOnly": false, "OptionGroupOptionSettings": [] } ], "NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==" } ``` Para obter mais informações, consulte [Listar opções e configurações de opção para um grupo de opções](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithOptionGroups.html#USER_WorkingWithOptionGroups.ListOption) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [DescribeOptionGroupOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-option-group-options.html) em *Referência de comandos da AWS CLI*. ### `describe-option-groups` O código de exemplo a seguir mostra como usar `describe-option-groups`. **AWS CLI** **Descrever os grupos de opções disponíveis** O exemplo `describe-option-groups` a seguir lista os grupos de opções para uma instância do Oracle Database 19c. ``` aws rds describe-option-groups \ --engine-name oracle-ee \ --major-engine-version 19 ``` Resultado: ``` { "OptionGroupsList": [ { "OptionGroupName": "default:oracle-ee-19", "OptionGroupDescription": "Default option group for oracle-ee 19", "EngineName": "oracle-ee", "MajorEngineVersion": "19", "Options": [], "AllowsVpcAndNonVpcInstanceMemberships": true, "OptionGroupArn": "arn:aws:rds:us-west-1:111122223333:og:default:oracle-ee-19" } ] } ``` Para obter mais informações, consulte [Listar opções e configurações de opção para um grupo de opções](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithOptionGroups.html#USER_WorkingWithOptionGroups.ListOption) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [DescribeOptionGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-option-groups.html) em *Referência de comandos da AWS CLI*. ### `describe-orderable-db-instance-options` O código de exemplo a seguir mostra como usar `describe-orderable-db-instance-options`. **AWS CLI** **Como descrever as opções de instância solicitável do banco de dados** O exemplo de `describe-orderable-db-instance-options` a seguir recupera detalhes sobre as opções que podem ser solicitadas em uma instância de banco de dados que executa o mecanismo de banco de dados do MySQL. ``` aws rds describe-orderable-db-instance-options \ --engine mysql ``` Resultado: ``` { "OrderableDBInstanceOptions": [ { "MinStorageSize": 5, "ReadReplicaCapable": true, "MaxStorageSize": 6144, "AvailabilityZones": [ { "Name": "us-east-1a" }, { "Name": "us-east-1b" }, { "Name": "us-east-1c" }, { "Name": "us-east-1d" } ], "SupportsIops": false, "AvailableProcessorFeatures": [], "MultiAZCapable": true, "DBInstanceClass": "db.m1.large", "Vpc": true, "StorageType": "gp2", "LicenseModel": "general-public-license", "EngineVersion": "5.5.46", "SupportsStorageEncryption": false, "SupportsEnhancedMonitoring": true, "Engine": "mysql", "SupportsIAMDatabaseAuthentication": false, "SupportsPerformanceInsights": false } ] ...some output truncated... } ``` + Consulte detalhes da API em [DescribeOrderableDBInstanceOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-orderable-db-instance-options.html) na *Referência de comandos da AWS CLI*. ### `describe-pending-maintenance-actions` O código de exemplo a seguir mostra como usar `describe-pending-maintenance-actions`. **AWS CLI** **Para listar recursos com pelo menos uma ação de manutenção pendente** O exemplo `describe-pending-maintenance-actions` a seguir lista a ação de manutenção pendente para uma instância de banco de dados. ``` aws rds describe-pending-maintenance-actions ``` Resultado: ``` { "PendingMaintenanceActions": [ { "ResourceIdentifier": "arn:aws:rds:us-west-2:123456789012:cluster:global-db1-cl1", "PendingMaintenanceActionDetails": [ { "Action": "system-update", "Description": "Upgrade to Aurora PostgreSQL 2.4.2" } ] } ] } ``` Para obter mais informações, consulte [Gerenciar uma instância de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [DescribePendingMaintenanceActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-pending-maintenance-actions.html) na *Referência de comandos da AWS CLI*. ### `describe-reserved-db-instances-offerings` O código de exemplo a seguir mostra como usar `describe-reserved-db-instances-offerings`. **AWS CLI** **Descrever ofertas de instâncias de banco de dados reservadas** O exemplo `describe-reserved-db-instances-offerings` a seguir recupera detalhes sobre as opções de instância de banco de dados reservada para`oracle`. ``` aws rds describe-reserved-db-instances-offerings \ --product-description oracle ``` Resultado: ``` { "ReservedDBInstancesOfferings": [ { "CurrencyCode": "USD", "UsagePrice": 0.0, "ProductDescription": "oracle-se2(li)", "ReservedDBInstancesOfferingId": "005bdee3-9ef4-4182-aa0c-58ef7cb6c2f8", "MultiAZ": true, "DBInstanceClass": "db.m4.xlarge", "OfferingType": "Partial Upfront", "RecurringCharges": [ { "RecurringChargeAmount": 0.594, "RecurringChargeFrequency": "Hourly" } ], "FixedPrice": 4089.0, "Duration": 31536000 }, ...some output truncated... } ``` + Para ver detalhes da API, consulte [DescribeReservedDbInstancesOfferings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-reserved-db-instances-offerings.html) em *Referência de comandos da AWS CLI*. ### `describe-reserved-db-instances` O código de exemplo a seguir mostra como usar `describe-reserved-db-instances`. **AWS CLI** **Descrever instâncias de banco de dados reservadas** O exemplo `describe-reserved-db-instances` a seguir recupera detalhes sobre todas as instâncias de banco de dados reservadas na conta da AWS atual. ``` aws rds describe-reserved-db-instances ``` Resultado: ``` { "ReservedDBInstances": [ { "ReservedDBInstanceId": "myreservedinstance", "ReservedDBInstancesOfferingId": "12ab34cd-59af-4b2c-a660-1abcdef23456", "DBInstanceClass": "db.t3.micro", "StartTime": "2020-06-01T13:44:21.436Z", "Duration": 31536000, "FixedPrice": 0.0, "UsagePrice": 0.0, "CurrencyCode": "USD", "DBInstanceCount": 1, "ProductDescription": "sqlserver-ex(li)", "OfferingType": "No Upfront", "MultiAZ": false, "State": "payment-pending", "RecurringCharges": [ { "RecurringChargeAmount": 0.014, "RecurringChargeFrequency": "Hourly" } ], "ReservedDBInstanceArn": "arn:aws:rds:us-west-2:123456789012:ri:myreservedinstance", "LeaseId": "a1b2c3d4-6b69-4a59-be89-5e11aa446666" } ] } ``` Para obter mais informações, consulte [Instâncias de banco de dados reservadas do Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithReservedDBInstances.html) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [DescribeReservedDbInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-reserved-db-instances.html) em *Referência de comandos da AWS CLI*. ### `describe-source-regions` O código de exemplo a seguir mostra como usar `describe-source-regions`. **AWS CLI** **Descrever as regiões de origem** O exemplo `describe-source-regions` a seguir recupera detalhes sobre todas as regiões de origem da AWS. Também mostra que os backups automatizados podem ser replicados somente do Oeste dos EUA (Oregon) para a região da AWS de destino, Leste dos EUA (Norte da Virgínia). ``` aws rds describe-source-regions \ --region us-east-1 ``` Resultado: ``` { "SourceRegions": [ { "RegionName": "af-south-1", "Endpoint": "https://rds.af-south-1.amazonaws.com", "Status": "available", "SupportsDBInstanceAutomatedBackupsReplication": false }, { "RegionName": "ap-east-1", "Endpoint": "https://rds.ap-east-1.amazonaws.com", "Status": "available", "SupportsDBInstanceAutomatedBackupsReplication": false }, { "RegionName": "ap-northeast-1", "Endpoint": "https://rds.ap-northeast-1.amazonaws.com", "Status": "available", "SupportsDBInstanceAutomatedBackupsReplication": true }, { "RegionName": "ap-northeast-2", "Endpoint": "https://rds.ap-northeast-2.amazonaws.com", "Status": "available", "SupportsDBInstanceAutomatedBackupsReplication": true }, { "RegionName": "ap-northeast-3", "Endpoint": "https://rds.ap-northeast-3.amazonaws.com", "Status": "available", "SupportsDBInstanceAutomatedBackupsReplication": false }, { "RegionName": "ap-south-1", "Endpoint": "https://rds.ap-south-1.amazonaws.com", "Status": "available", "SupportsDBInstanceAutomatedBackupsReplication": true }, { "RegionName": "ap-southeast-1", "Endpoint": "https://rds.ap-southeast-1.amazonaws.com", "Status": "available", "SupportsDBInstanceAutomatedBackupsReplication": true }, { "RegionName": "ap-southeast-2", "Endpoint": "https://rds.ap-southeast-2.amazonaws.com", "Status": "available", "SupportsDBInstanceAutomatedBackupsReplication": true }, { "RegionName": "ap-southeast-3", "Endpoint": "https://rds.ap-southeast-3.amazonaws.com", "Status": "available", "SupportsDBInstanceAutomatedBackupsReplication": false }, { "RegionName": "ca-central-1", "Endpoint": "https://rds.ca-central-1.amazonaws.com", "Status": "available", "SupportsDBInstanceAutomatedBackupsReplication": true }, { "RegionName": "eu-north-1", "Endpoint": "https://rds.eu-north-1.amazonaws.com", "Status": "available", "SupportsDBInstanceAutomatedBackupsReplication": true }, { "RegionName": "eu-south-1", "Endpoint": "https://rds.eu-south-1.amazonaws.com", "Status": "available", "SupportsDBInstanceAutomatedBackupsReplication": false }, { "RegionName": "eu-west-1", "Endpoint": "https://rds.eu-west-1.amazonaws.com", "Status": "available", "SupportsDBInstanceAutomatedBackupsReplication": true }, { "RegionName": "eu-west-2", "Endpoint": "https://rds.eu-west-2.amazonaws.com", "Status": "available", "SupportsDBInstanceAutomatedBackupsReplication": true }, { "RegionName": "eu-west-3", "Endpoint": "https://rds.eu-west-3.amazonaws.com", "Status": "available", "SupportsDBInstanceAutomatedBackupsReplication": true }, { "RegionName": "me-central-1", "Endpoint": "https://rds.me-central-1.amazonaws.com", "Status": "available", "SupportsDBInstanceAutomatedBackupsReplication": false }, { "RegionName": "me-south-1", "Endpoint": "https://rds.me-south-1.amazonaws.com", "Status": "available", "SupportsDBInstanceAutomatedBackupsReplication": false }, { "RegionName": "sa-east-1", "Endpoint": "https://rds.sa-east-1.amazonaws.com", "Status": "available", "SupportsDBInstanceAutomatedBackupsReplication": true }, { "RegionName": "us-east-2", "Endpoint": "https://rds.us-east-2.amazonaws.com", "Status": "available", "SupportsDBInstanceAutomatedBackupsReplication": true }, { "RegionName": "us-west-1", "Endpoint": "https://rds.us-west-1.amazonaws.com", "Status": "available", "SupportsDBInstanceAutomatedBackupsReplication": true }, { "RegionName": "us-west-2", "Endpoint": "https://rds.us-west-2.amazonaws.com", "Status": "available", "SupportsDBInstanceAutomatedBackupsReplication": true } ] } ``` Para obter mais informações, consulte [Descobrir informações sobre backups replicados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html#AutomatedBackups.Replicating.Describe) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [DescribeSourceRegions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-source-regions.html) em *Referência de comandos da AWS CLI*. ### `describe-valid-db-instance-modifications` O código de exemplo a seguir mostra como usar `describe-valid-db-instance-modifications`. **AWS CLI** **Descrever modificações válidas para uma instância de banco de dados** O exemplo `describe-valid-db-instance-modifications` a seguir recupera detalhes das modificações válidas para a instância de banco de dados especificada. ``` aws rds describe-valid-db-instance-modifications \ --db-instance-identifier test-instance ``` Resultado: ``` { "ValidDBInstanceModificationsMessage": { "ValidProcessorFeatures": [], "Storage": [ { "StorageSize": [ { "Step": 1, "To": 20, "From": 20 }, { "Step": 1, "To": 6144, "From": 22 } ], "ProvisionedIops": [ { "Step": 1, "To": 0, "From": 0 } ], "IopsToStorageRatio": [ { "To": 0.0, "From": 0.0 } ], "StorageType": "gp2" }, { "StorageSize": [ { "Step": 1, "To": 6144, "From": 100 } ], "ProvisionedIops": [ { "Step": 1, "To": 40000, "From": 1000 } ], "IopsToStorageRatio": [ { "To": 50.0, "From": 1.0 } ], "StorageType": "io1" }, { "StorageSize": [ { "Step": 1, "To": 20, "From": 20 }, { "Step": 1, "To": 3072, "From": 22 } ], "ProvisionedIops": [ { "Step": 1, "To": 0, "From": 0 } ], "IopsToStorageRatio": [ { "To": 0.0, "From": 0.0 } ], "StorageType": "magnetic" } ] } } ``` + Para ver detalhes da API, consulte [DescribeValidDbInstanceModifications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-valid-db-instance-modifications.html) em *Referência de comandos da AWS CLI*. ### `download-db-log-file-portion` O código de exemplo a seguir mostra como usar `download-db-log-file-portion`. **AWS CLI** **Exemplo 1: como baixar a parte mais recente de um arquivo de log do banco de dados** O exemplo `download-db-log-file-portion` a seguir baixa somente a parte mais recente do arquivo de log, salvando-a em um arquivo local denominado `tail.txt`. ``` aws rds download-db-log-file-portion \ --db-instance-identifier test-instance \ --log-file-name log.txt \ --output text > tail.txt ``` O arquivo salvo pode conter linhas em branco. Eles aparecem no final de cada parte do arquivo de log durante o download. **Exemplo 2: como baixar um arquivo de log de banco de dados completo** O exemplo de `download-db-log-file-portion` a seguir baixa o arquivo de log completo, usando o parâmetro `--starting-token 0`, e salva a saída em um arquivo local chamado `full.txt`. ``` aws rds download-db-log-file-portion \ --db-instance-identifier test-instance \ --log-file-name log.txt \ --starting-token 0 \ --output text > full.txt ``` O arquivo salvo pode conter linhas em branco. Eles aparecem no final de cada parte do arquivo de log durante o download. + Para ver detalhes da API, consulte [DownloadDbLogFilePortion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/download-db-log-file-portion.html) em *Referência de comandos da AWS CLI*. ### `generate-auth-token` O código de exemplo a seguir mostra como usar `generate-auth-token`. **AWS CLI** **Gerar token de autenticação** O exemplo `generate-db-auth-token` a seguir gera um token de autenticação para uso com a autenticação do banco de dados do IAM. ``` aws rds generate-db-auth-token \ --hostname aurmysql-test.cdgmuqiadpid.us-west-2.rds.amazonaws.com \ --port 3306 \ --region us-east-1 \ --username jane_doe ``` Resultado: ``` aurmysql-test.cdgmuqiadpid.us-west-2.rds.amazonaws.com:3306/?Action=connect&DBUser=jane_doe&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIESZCNJ3OEXAMPLE%2F20180731%2Fus-east-1%2Frds-db%2Faws4_request&X-Amz-Date=20180731T235209Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=5a8753ebEXAMPLEa2c724e5667797EXAMPLE9d6ec6e3f427191fa41aeEXAMPLE ``` + *Para ver detalhes da API, consulte [GenerateAuthToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/generate-auth-token.html) em Referência de comandos da AWS CLI*. ### `generate-db-auth-token` O código de exemplo a seguir mostra como usar `generate-db-auth-token`. **AWS CLI** **Gerar um token de autenticação do IAM** O exemplo `generate-db-auth-token` a seguir gera um token de autenticação do IAM para se conectar a um banco de dados. ``` aws rds generate-db-auth-token \ --hostname mydb.123456789012.us-east-1.rds.amazonaws.com \ --port 3306 \ --region us-east-1 \ --username db_user ``` Resultado: ``` mydb.123456789012.us-east-1.rds.amazonaws.com:3306/?Action=connect&DBUser=db_user&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIEXAMPLE%2Fus-east-1%2Frds-db%2Faws4_request&X-Amz-Date=20210123T011543Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=88987EXAMPLE1EXAMPLE2EXAMPLE3EXAMPLE4EXAMPLE5EXAMPLE6 ``` Para obter mais informações, consulte [Conectar-se à instância de banco de dados usando a autenticação do IAM](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.Connecting.html) no *Guia do usuário do Amazon RDS* e [Conectar-se ao cluster de banco de dados usando a autenticação do IAM](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.Connecting.html) no *Guia do usuário do Amazon Aurora*. + *Para ver detalhes da API, consulte [GenerateDbAuthToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/generate-db-auth-token.html) em Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Listar todas as tags em um recurso do Amazon RDS** O exemplo `list-tags-for-resource` a seguir lista todas as tags em uma instância de banco de dados. ``` aws rds list-tags-for-resource \ --resource-name arn:aws:rds:us-east-1:123456789012:db:orcl1 ``` Resultado: ``` { "TagList": [ { "Key": "Environment", "Value": "test" }, { "Key": "Name", "Value": "MyDatabase" } ] } ``` Para obter mais informações, consulte [Marcar recursos do Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) no *Guia do usuário do Amazon RDS*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `modify-certificates` O código de exemplo a seguir mostra como usar `modify-certificates`. **AWS CLI** **Substituir temporariamente o certificado SSL/TLS padrão do sistema para novas instâncias de banco de dados** O exemplo `modify-certificates` a seguir substitui temporariamente o certificado SSL/TLS padrão do sistema para novas instâncias de banco de dados. ``` aws rds modify-certificates \ --certificate-identifier rds-ca-2019 ``` Resultado: ``` { "Certificate": { "CertificateIdentifier": "rds-ca-2019", "CertificateType": "CA", "Thumbprint": "EXAMPLE123456789012", "ValidFrom": "2019-09-19T18:16:53Z", "ValidTill": "2024-08-22T17:08:50Z", "CertificateArn": "arn:aws:rds:us-east-1::cert:rds-ca-2019", "CustomerOverride": true, "CustomerOverrideValidTill": "2024-08-22T17:08:50Z" } } ``` Para obter mais informações, consulte [Rotacionar o certificado SSL/TLS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) no *Guia do usuário do Amazon RDS* e [Rotacionar o certificado SSL/TLS](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) no *Guia do usuário do Amazon Aurora.* + Para ver detalhes da API, consulte [ModifyCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-certificates.html) em *Referência de comandos da AWS CLI*. ### `modify-current-db-cluster-capacity` O código de exemplo a seguir mostra como usar `modify-current-db-cluster-capacity`. **AWS CLI** **Escalar a capacidade de um cluster de banco de dados do Aurora Serverless** O exemplo `modify-current-db-cluster-capacity` a seguir escalona para 8 a capacidade de um cluster de banco de dados do Aurora Serverless. ``` aws rds modify-current-db-cluster-capacity \ --db-cluster-identifier mydbcluster \ --capacity 8 ``` Resultado: ``` { "DBClusterIdentifier": "mydbcluster", "PendingCapacity": 8, "CurrentCapacity": 1, "SecondsBeforeTimeout": 300, "TimeoutAction": "ForceApplyCapacityChange" } ``` Para obter mais informações, consulte [Escalar manualmente a capacidade do cluster de banco de dados do Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.setting-capacity.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [ModifyCurrentDbClusterCapacity](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-current-db-cluster-capacity.html) em *Referência de comandos da AWS CLI*. ### `modify-db-cluster-endpoint` O código de exemplo a seguir mostra como usar `modify-db-cluster-endpoint`. **AWS CLI** **Modificar um endpoint de cluster de banco de dados personalizado** O exemplo `modify-db-cluster-endpoint` a seguir modifica o endpoint do cluster de banco de dados personalizado especificado. ``` aws rds modify-db-cluster-endpoint \ --db-cluster-endpoint-identifier mycustomendpoint \ --static-members dbinstance1 dbinstance2 dbinstance3 ``` Resultado: ``` { "DBClusterEndpointIdentifier": "mycustomendpoint", "DBClusterIdentifier": "mydbcluster", "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE", "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com", "Status": "modifying", "EndpointType": "CUSTOM", "CustomEndpointType": "READER", "StaticMembers": [ "dbinstance1", "dbinstance2", "dbinstance3" ], "ExcludedMembers": [], "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint" } ``` Para obter mais informações, consulte [Gerenciamento de conexões do Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.Endpoints.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [ModifyDbClusterEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-cluster-endpoint.html) em *Referência de comandos da AWS CLI*. ### `modify-db-cluster-parameter-group` O código de exemplo a seguir mostra como usar `modify-db-cluster-parameter-group`. **AWS CLI** **Modificar parâmetros em um grupo de parâmetros do cluster de banco de dados** O exemplo `modify-db-cluster-parameter-group` a seguir altera os valores dos parâmetros em um grupo de parâmetros de cluster de banco de dados. ``` aws rds modify-db-cluster-parameter-group \ --db-cluster-parameter-group-name mydbclusterpg \ --parameters "ParameterName=server_audit_logging,ParameterValue=1,ApplyMethod=immediate" \ "ParameterName=server_audit_logs_upload,ParameterValue=1,ApplyMethod=immediate" ``` Resultado: ``` { "DBClusterParameterGroupName": "mydbclusterpg" } ``` Para obter mais informações, consulte [Trabalhar com grupos de parâmetros de banco de dados e grupos de parâmetros de cluster de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [ModifyDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-cluster-parameter-group.html) na *Referência de comandos da AWS CLI*. ### `modify-db-cluster-snapshot-attribute` O código de exemplo a seguir mostra como usar `modify-db-cluster-snapshot-attribute`. **AWS CLI** **Modificar um atributo do snapshot do cluster de banco de dados** O exemplo `modify-db-cluster-snapshot-attribute` a seguir faz alterações no atributo de snapshot do cluster de banco de dados especificado. ``` aws rds modify-db-cluster-snapshot-attribute \ --db-cluster-snapshot-identifier myclustersnapshot \ --attribute-name restore \ --values-to-add 123456789012 ``` Resultado: ``` { "DBClusterSnapshotAttributesResult": { "DBClusterSnapshotIdentifier": "myclustersnapshot", "DBClusterSnapshotAttributes": [ { "AttributeName": "restore", "AttributeValues": [ "123456789012" ] } ] } } ``` Para obter mais informações, consulte [Restaurar a partir de um snapshot de um cluster de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_RestoreFromSnapshot.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [ModifyDbClusterSnapshotAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-cluster-snapshot-attribute.html) na *Referência de comandos da AWS CLI*. ### `modify-db-cluster` O código de exemplo a seguir mostra como usar `modify-db-cluster`. **AWS CLI** **Exemplo 1: modificar um cluster de banco de dados** O exemplo `modify-db-cluster` a seguir altera a senha do usuário mestre do cluster de banco de dados denominado `cluster-2` e define o período de retenção de backup para 14 dias. O parâmetro de `--apply-immediately` faz com que a alterações sejam imediatas em vez de ter que esperar a próxima janela de manutenção. ``` aws rds modify-db-cluster \ --db-cluster-identifier cluster-2 \ --backup-retention-period 14 \ --master-user-password newpassword99 \ --apply-immediately ``` Resultado: ``` { "DBCluster": { "AllocatedStorage": 1, "AvailabilityZones": [ "eu-central-1b", "eu-central-1c", "eu-central-1a" ], "BackupRetentionPeriod": 14, "DatabaseName": "", "DBClusterIdentifier": "cluster-2", "DBClusterParameterGroup": "default.aurora5.6", "DBSubnetGroup": "default-vpc-2305ca49", "Status": "available", "EarliestRestorableTime": "2020-06-03T02:07:29.637Z", "Endpoint": "cluster-2.cluster-############.eu-central-1.rds.amazonaws.com", "ReaderEndpoint": "cluster-2.cluster-ro-############.eu-central-1.rds.amazonaws.com", "MultiAZ": false, "Engine": "aurora", "EngineVersion": "5.6.10a", "LatestRestorableTime": "2020-06-04T15:11:25.748Z", "Port": 3306, "MasterUsername": "admin", "PreferredBackupWindow": "01:55-02:25", "PreferredMaintenanceWindow": "thu:21:14-thu:21:44", "ReadReplicaIdentifiers": [], "DBClusterMembers": [ { "DBInstanceIdentifier": "cluster-2-instance-1", "IsClusterWriter": true, "DBClusterParameterGroupStatus": "in-sync", "PromotionTier": 1 } ], "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sg-20a5c047", "Status": "active" } ], "HostedZoneId": "Z1RLNU0EXAMPLE", "StorageEncrypted": true, "KmsKeyId": "arn:aws:kms:eu-central-1:123456789012:key/d1bd7c8f-5cdb-49ca-8a62-a1b2c3d4e5f6", "DbClusterResourceId": "cluster-AGJ7XI77XVIS6FUXHU1EXAMPLE", "DBClusterArn": "arn:aws:rds:eu-central-1:123456789012:cluster:cluster-2", "AssociatedRoles": [], "IAMDatabaseAuthenticationEnabled": false, "ClusterCreateTime": "2020-04-03T14:44:02.764Z", "EngineMode": "provisioned", "DeletionProtection": false, "HttpEndpointEnabled": false, "CopyTagsToSnapshot": true, "CrossAccountClone": false, "DomainMemberships": [] } } ``` Para obter mais informações, consulte [Modificar um cluster de banco de dados do Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Modifying.html) no *Guia do usuário do Amazon Aurora*. **Exemplo 2: associar um grupo de segurança VPC a um cluster de banco de dados** O exemplo `modify-db-instance` a seguir associa um grupo de segurança VPC específico e remove grupos de segurança de banco de dados de um cluster de banco de dados: ``` aws rds modify-db-cluster \ --db-cluster-identifier dbName \ --vpc-security-group-ids sg-ID ``` Resultado: ``` { "DBCluster": { "AllocatedStorage": 1, "AvailabilityZones": [ "us-west-2c", "us-west-2b", "us-west-2a" ], "BackupRetentionPeriod": 1, "DBClusterIdentifier": "dbName", "DBClusterParameterGroup": "default.aurora-mysql8.0", "DBSubnetGroup": "default", "Status": "available", "EarliestRestorableTime": "2024-02-15T01:12:13.966000+00:00", "Endpoint": "dbName.cluster-abcdefghji.us-west-2.rds.amazonaws.com", "ReaderEndpoint": "dbName.cluster-ro-abcdefghji.us-west-2.rds.amazonaws.com", "MultiAZ": false, "Engine": "aurora-mysql", "EngineVersion": "8.0.mysql_aurora.3.04.1", "LatestRestorableTime": "2024-02-15T02:25:33.696000+00:00", "Port": 3306, "MasterUsername": "admin", "PreferredBackupWindow": "10:59-11:29", "PreferredMaintenanceWindow": "thu:08:54-thu:09:24", "ReadReplicaIdentifiers": [], "DBClusterMembers": [ { "DBInstanceIdentifier": "dbName-instance-1", "IsClusterWriter": true, "DBClusterParameterGroupStatus": "in-sync", "PromotionTier": 1 } ], "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sg-ID", "Status": "active" } ], ...output omitted... } } ``` Para ter mais informações, consulte [Controlar acesso com grupos de segurança](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Overview.RDSSecurityGroups.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [ModifyDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-cluster.html) na *Referência de comandos da AWS CLI*. ### `modify-db-instance` O código de exemplo a seguir mostra como usar `modify-db-instance`. **AWS CLI** **Exemplo 1: Como modificar uma instância de banco de dados** O exemplo de `modify-db-instance` a seguir associa um grupo de opção e um grupo de parâmetros a uma instância de banco de dados do Microsoft SQL Server compatível. O parâmetro `--apply-immediately` faz com que os grupos de opção e parâmetro sejam associados imediatamente em vez de ter que esperar a próxima janela de manutenção. ``` aws rds modify-db-instance \ --db-instance-identifier database-2 \ --option-group-name test-se-2017 \ --db-parameter-group-name test-sqlserver-se-2017 \ --apply-immediately ``` Resultado: ``` { "DBInstance": { "DBInstanceIdentifier": "database-2", "DBInstanceClass": "db.r4.large", "Engine": "sqlserver-se", "DBInstanceStatus": "available", ...output omitted... "DBParameterGroups": [ { "DBParameterGroupName": "test-sqlserver-se-2017", "ParameterApplyStatus": "applying" } ], "AvailabilityZone": "us-west-2d", ...output omitted... "MultiAZ": true, "EngineVersion": "14.00.3281.6.v1", "AutoMinorVersionUpgrade": false, "ReadReplicaDBInstanceIdentifiers": [], "LicenseModel": "license-included", "OptionGroupMemberships": [ { "OptionGroupName": "test-se-2017", "Status": "pending-apply" } ], "CharacterSetName": "SQL_Latin1_General_CP1_CI_AS", "SecondaryAvailabilityZone": "us-west-2c", "PubliclyAccessible": true, "StorageType": "gp2", ...output omitted... "DeletionProtection": false, "AssociatedRoles": [], "MaxAllocatedStorage": 1000 } } ``` Para obter mais informações, consulte [Modificar uma instância de banco de dados do Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html) no *Guia do usuário do Amazon RDS*. **Exemplo 2: Como associar um grupo de segurança da VPC a uma instância de banco de dados** O seguinte exemplo de `modify-db-instance` associa um grupo de segurança da VPC específico e remove grupos de segurança de banco de dados da instância de banco de dados: ``` aws rds modify-db-instance \ --db-instance-identifier dbName \ --vpc-security-group-ids sg-ID ``` Resultado: ``` { "DBInstance": { "DBInstanceIdentifier": "dbName", "DBInstanceClass": "db.t3.micro", "Engine": "mysql", "DBInstanceStatus": "available", "MasterUsername": "admin", "Endpoint": { "Address": "dbName.abcdefghijk.us-west-2.rds.amazonaws.com", "Port": 3306, "HostedZoneId": "ABCDEFGHIJK1234" }, "AllocatedStorage": 20, "InstanceCreateTime": "2024-02-15T00:37:58.793000+00:00", "PreferredBackupWindow": "11:57-12:27", "BackupRetentionPeriod": 7, "DBSecurityGroups": [], "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sg-ID", "Status": "active" } ], ... output omitted ... "MultiAZ": false, "EngineVersion": "8.0.35", "AutoMinorVersionUpgrade": true, "ReadReplicaDBInstanceIdentifiers": [], "LicenseModel": "general-public-license", ... output omitted ... } } ``` Para ter mais informações, consulte [Controlar acesso com grupos de segurança](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.RDSSecurityGroups.html) no *Guia do usuário do Amazon RDS*. + Consulte detalhes da API em [ModifyDBInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-instance.html) na *Referência de comandos da AWS CLI*. ### `modify-db-parameter-group` O código de exemplo a seguir mostra como usar `modify-db-parameter-group`. **AWS CLI** **Como modificar um grupo de parâmetros de banco de dados** O exemplo de `modify-db-parameter-group` a seguir altera o valor do parâmetro `clr enabled` em um grupo de parâmetros de banco de dados. O parâmetro `--apply-immediately` faz com que o grupo de parâmetros de banco de dados seja modificado imediatamente em vez de ter que esperar a próxima janela de manutenção. ``` aws rds modify-db-parameter-group \ --db-parameter-group-name test-sqlserver-se-2017 \ --parameters "ParameterName='clr enabled',ParameterValue=1,ApplyMethod=immediate" ``` Resultado: ``` { "DBParameterGroupName": "test-sqlserver-se-2017" } ``` Para obter mais informações, consulte [Modificar parâmetros em um grupo de parâmetros de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html#USER_WorkingWithParamGroups.Modifying) no *Guia do usuário do Amazon RDS*. + Consulte detalhes da API em [ModifyDBParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-parameter-group.html) na *Referência de comandos da AWS CLI*. ### `modify-db-proxy-endpoint` O código de exemplo a seguir mostra como usar `modify-db-proxy-endpoint`. **AWS CLI** **Modificar um endpoint de proxy de banco de dados para um banco de dados do RDS** O exemplo `modify-db-proxy-endpoint` a seguir modifica um endpoint de proxy de banco de dados `proxyEndpoint` para definir o tempo limite de leitura em 65 segundos. ``` aws rds modify-db-proxy-endpoint \ --db-proxy-endpoint-name proxyEndpoint \ --cli-read-timeout 65 ``` Resultado: ``` { "DBProxyEndpoint": { "DBProxyEndpointName": "proxyEndpoint", "DBProxyEndpointArn": "arn:aws:rds:us-east-1:123456789012:db-proxy-endpoint:prx-endpoint-0123a01b12345c0ab", "DBProxyName": "proxyExample", "Status": "available", "VpcId": "vpc-1234567", "VpcSecurityGroupIds": [ "sg-1234" ], "VpcSubnetIds": [ "subnetgroup1", "subnetgroup2" ], "Endpoint": "proxyEndpoint.endpoint.proxyExample-ab0cd1efghij.us-east-1.rds.amazonaws.com", "CreatedDate": "2023-04-05T16:09:33.452000+00:00", "TargetRole": "READ_WRITE", "IsDefault": "false" } } ``` Para obter mais informações, consulte [Modificar um endpoint de proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-endpoints.html#rds-proxy-endpoints.ModifyingEndpoint) no *Guia do usuário do Amazon RDS* e [Modificar um endpoint de proxy](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-endpoints.html#rds-proxy-endpoints.ModifyingEndpoint) no *Guia do usuário do Amazon Aurora.* + Para ver detalhes da API, consulte [ModifyDbProxyEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-proxy-endpoint.html) em *Referência de comandos da AWS CLI*. ### `modify-db-proxy-target-group` O código de exemplo a seguir mostra como usar `modify-db-proxy-target-group`. **AWS CLI** **Modificar os endpoints de um proxy de banco de dados** O exemplo `modify-db-proxy-target-group` a seguir modifica um grupo-alvo de proxy de banco de dados para definir o máximo de conexões em 80% e o máximo de conexões ociosas em 10%. ``` aws rds modify-db-proxy-target-group \ --target-group-name default \ --db-proxy-name proxyExample \ --connection-pool-config MaxConnectionsPercent=80,MaxIdleConnectionsPercent=10 ``` Resultado: ``` { "DBProxyTargetGroup": { "DBProxyName": "proxyExample", "TargetGroupName": "default", "TargetGroupArn": "arn:aws:rds:us-east-1:123456789012:target-group:prx-tg-0123a01b12345c0ab", "IsDefault": true, "Status": "available", "ConnectionPoolConfig": { "MaxConnectionsPercent": 80, "MaxIdleConnectionsPercent": 10, "ConnectionBorrowTimeout": 120, "SessionPinningFilters": [] }, "CreatedDate": "2023-05-02T18:41:19.495000+00:00", "UpdatedDate": "2023-05-02T18:41:21.762000+00:00" } } ``` Para obter mais informações, consulte [Modificar um proxy do RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-managing.html#rds-proxy-modifying-proxy) no *Guia do usuário do Amazon RDS* e [Modificar um proxy do RDS](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-managing.html#rds-proxy-modifying-proxy) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [ModifyDbProxyTargetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-proxy-target-group.html) em *Referência de comandos da AWS CLI*. ### `modify-db-proxy` O código de exemplo a seguir mostra como usar `modify-db-proxy`. **AWS CLI** **Modificar um proxy de banco de dados para um banco de dados do RDS** O exemplo `modify-db-proxy` a seguir modifica um proxy de banco de dados denominado `proxyExample` para exigir SSL em suas conexões. ``` aws rds modify-db-proxy \ --db-proxy-name proxyExample \ --require-tls ``` Resultado: ``` { "DBProxy": { "DBProxyName": "proxyExample", "DBProxyArn": "arn:aws:rds:us-east-1:123456789012:db-proxy:prx-0123a01b12345c0ab", "Status": "modifying" "EngineFamily": "PostgreSQL", "VpcId": "sg-1234567", "VpcSecurityGroupIds": [ "sg-1234" ], "VpcSubnetIds": [ "subnetgroup1", "subnetgroup2" ], "Auth": "[ { "Description": "proxydescription1", "AuthScheme": "SECRETS", "SecretArn": "arn:aws:secretsmanager:us-west-2:123456789123:secret:proxysecret1-Abcd1e", "IAMAuth": "DISABLED" } ]", "RoleArn": "arn:aws:iam::12345678912:role/ProxyPostgreSQLRole", "Endpoint": "proxyExample.proxy-ab0cd1efghij.us-east-1.rds.amazonaws.com", "RequireTLS": true, "IdleClientTimeout": 1800, "DebuggingLogging": false, "CreatedDate": "2023-04-05T16:09:33.452000+00:00", "UpdatedDate": "2023-04-13T01:49:38.568000+00:00" } } ``` Para obter mais informações, consulte [Modificar um proxy do RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-managing.html#rds-proxy-modifying-proxy) no *Guia do usuário do Amazon RDS* e [Criar um proxy do RDS](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-managing.html#rds-proxy-modifying-proxy) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [ModifyDbProxy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-proxy.html) em *Referência de comandos da AWS CLI*. ### `modify-db-shard-group` O código de exemplo a seguir mostra como usar `modify-db-shard-group`. **AWS CLI** **Exemplo 1: modificar um grupo de fragmentos de banco de dados** O exemplo `modify-db-shard-group` a seguir altera a capacidade máxima de um grupo de fragmentos de banco de dados. ``` aws rds modify-db-shard-group \ --db-shard-group-identifier my-db-shard-group \ --max-acu 1000 ``` Resultado: ``` { "DBShardGroups": [ { "DBShardGroupResourceId": "shardgroup-a6e3a0226aa243e2ac6c7a1234567890", "DBShardGroupIdentifier": "my-db-shard-group", "DBClusterIdentifier": "my-sv2-cluster", "MaxACU": 768.0, "ComputeRedundancy": 0, "Status": "available", "PubliclyAccessible": false, "Endpoint": "my-sv2-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com" } ] } ``` Para obter mais informações, consulte [Clusters de banco de dados do Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.html) no *Guia do usuário do Amazon Aurora*. **Exemplo 2: descrever seus grupos de fragmentos de banco de dados** O exemplo `describe-db-shard-groups` a seguir recupera os detalhes dos seus grupos de fragmentos de banco de dados depois que você executa o comando `modify-db-shard-group`. Atualmente, a capacidade máxima do grupo de fragmentos de banco de dados `my-db-shard-group` é de 1000 unidades de capacidade do Aurora (ACUs). ``` aws rds describe-db-shard-groups ``` Resultado: ``` { "DBShardGroups": [ { "DBShardGroupResourceId": "shardgroup-7bb446329da94788b3f957746example", "DBShardGroupIdentifier": "limitless-test-shard-grp", "DBClusterIdentifier": "limitless-test-cluster", "MaxACU": 768.0, "ComputeRedundancy": 0, "Status": "available", "PubliclyAccessible": true, "Endpoint": "limitless-test-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com" }, { "DBShardGroupResourceId": "shardgroup-a6e3a0226aa243e2ac6c7a1234567890", "DBShardGroupIdentifier": "my-db-shard-group", "DBClusterIdentifier": "my-sv2-cluster", "MaxACU": 1000.0, "ComputeRedundancy": 0, "Status": "available", "PubliclyAccessible": false, "Endpoint": "my-sv2-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com" } ] } ``` Para obter mais informações, consulte [Clusters de banco de dados do Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [ModifyDbShardGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-shard-group.html) em *Referência de comandos da AWS CLI*. ### `modify-db-snapshot-attribute` O código de exemplo a seguir mostra como usar `modify-db-snapshot-attribute`. **AWS CLI** **Exemplo 1: habilitar duas contas da AWS para restaurar um snapshot do banco de dados** O exemplo `modify-db-snapshot-attribute` a seguir concede permissão a duas contas da AWS, com os identificadores `111122223333` e `444455556666`, para restaurar o snapshot denominado `mydbsnapshot`. ``` aws rds modify-db-snapshot-attribute \ --db-snapshot-identifier mydbsnapshot \ --attribute-name restore \ --values-to-add {"111122223333","444455556666"} ``` Resultado: ``` { "DBSnapshotAttributesResult": { "DBSnapshotIdentifier": "mydbsnapshot", "DBSnapshotAttributes": [ { "AttributeName": "restore", "AttributeValues": [ "111122223333", "444455556666" ] } ] } } ``` Para obter mais informações, consulte [Compartilhar um snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ShareSnapshot.html#USER_ShareSnapshot.Sharing) no *Guia do usuário do Amazon RDS*. **Exemplo 2: evitar que uma conta da AWS restaure um snapshot do banco de dados** O exemplo `modify-db-snapshot-attribute` a seguir remove a permissão de uma conta da AWS específica para restaurar o snapshot do banco de dados denominado `mydbsnapshot`. Ao especificar uma única conta, o identificador da conta não pode ser delimitado por aspas ou chaves. ``` aws rds modify-db-snapshot-attribute \ --db-snapshot-identifier mydbsnapshot \ --attribute-name restore \ --values-to-remove 444455556666 ``` Resultado: ``` { "DBSnapshotAttributesResult": { "DBSnapshotIdentifier": "mydbsnapshot", "DBSnapshotAttributes": [ { "AttributeName": "restore", "AttributeValues": [ "111122223333" ] } ] } } ``` Para obter mais informações, consulte [Compartilhar um snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ShareSnapshot.html#USER_ShareSnapshot.Sharing) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [ModifyDbSnapshotAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-snapshot-attribute.html) em *Referência de comandos da AWS CLI*. ### `modify-db-snapshot-attributes` O código de exemplo a seguir mostra como usar `modify-db-snapshot-attributes`. **AWS CLI** **Para modificar um atributo de snapshot do banco de dados** O exemplo `modify-db-snapshot-attribute` a seguir permite que dois identificadores de contas da AWS, `111122223333` e `444455556666`, restaurem o snapshot do banco de dados denominado `mydbsnapshot`. ``` aws rds modify-db-snapshot-attribute \ --db-snapshot-identifier mydbsnapshot \ --attribute-name restore \ --values-to-add '["111122223333","444455556666"]' ``` Resultado: ``` { "DBSnapshotAttributesResult": { "DBSnapshotIdentifier": "mydbsnapshot", "DBSnapshotAttributes": [ { "AttributeName": "restore", "AttributeValues": [ "111122223333", "444455556666" ] } ] } } ``` Para obter mais informações, consulte [Compartilhar um snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ShareSnapshot.html#USER_ShareSnapshot.Sharing) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [ModifyDbSnapshotAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-snapshot-attributes.html) em *Referência de comandos da AWS CLI*. ### `modify-db-snapshot` O código de exemplo a seguir mostra como usar `modify-db-snapshot`. **AWS CLI** **Para modificar um snapshot do banco de dados** O exemplo `modify-db-snapshot` a seguir atualiza um snapshot do PostgreSQL 10.6 denominado `db5-snapshot-upg-test` para PostgreSQL 11.7. A nova versão do mecanismo de banco de dados é exibida após a conclusão da atualização do snapshot e seu status estiver como **disponível**. ``` aws rds modify-db-snapshot \ --db-snapshot-identifier db5-snapshot-upg-test \ --engine-version 11.7 ``` Resultado: ``` { "DBSnapshot": { "DBSnapshotIdentifier": "db5-snapshot-upg-test", "DBInstanceIdentifier": "database-5", "SnapshotCreateTime": "2020-03-27T20:49:17.092Z", "Engine": "postgres", "AllocatedStorage": 20, "Status": "upgrading", "Port": 5432, "AvailabilityZone": "us-west-2a", "VpcId": "vpc-2ff27557", "InstanceCreateTime": "2020-03-27T19:59:04.735Z", "MasterUsername": "postgres", "EngineVersion": "10.6", "LicenseModel": "postgresql-license", "SnapshotType": "manual", "OptionGroupName": "default:postgres-11", "PercentProgress": 100, "StorageType": "gp2", "Encrypted": false, "DBSnapshotArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-upg-test", "IAMDatabaseAuthenticationEnabled": false, "ProcessorFeatures": [], "DbiResourceId": "db-GJMF75LM42IL6BTFRE4UZJ5YM4" } } ``` Para obter mais informações, consulte [Atualizar um snapshot de banco de dados do PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBSnapshot.PostgreSQL.html) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [ModifyDbSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-snapshot.html) na *Referência de comandos da AWS CLI*. ### `modify-db-subnet-group` O código de exemplo a seguir mostra como usar `modify-db-subnet-group`. **AWS CLI** **Modificar um grupo de sub-redes do banco de dados** O exemplo `modify-db-subnet-group` a seguir adiciona uma sub-rede com o ID `subnet-08e41f9e230222222` ao grupo de sub-redes do banco de dados denominado `mysubnetgroup`. Para manter as sub-redes existentes no grupo de sub-redes, inclua os IDs como valores na opção `--subnet-ids`. Certifique-se de ter sub-redes com pelo menos duas zonas de disponibilidade diferentes no grupo de sub-redes do banco de dados. ``` aws rds modify-db-subnet-group \ --db-subnet-group-name mysubnetgroup \ --subnet-ids '["subnet-0a1dc4e1a6f123456","subnet-070dd7ecb3aaaaaaa","subnet-00f5b198bc0abcdef","subnet-08e41f9e230222222"]' ``` Resultado: ``` { "DBSubnetGroup": { "DBSubnetGroupName": "mysubnetgroup", "DBSubnetGroupDescription": "test DB subnet group", "VpcId": "vpc-0f08e7610a1b2c3d4", "SubnetGroupStatus": "Complete", "Subnets": [ { "SubnetIdentifier": "subnet-08e41f9e230222222", "SubnetAvailabilityZone": { "Name": "us-west-2a" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-070dd7ecb3aaaaaaa", "SubnetAvailabilityZone": { "Name": "us-west-2b" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-00f5b198bc0abcdef", "SubnetAvailabilityZone": { "Name": "us-west-2d" }, "SubnetStatus": "Active" }, { "SubnetIdentifier": "subnet-0a1dc4e1a6f123456", "SubnetAvailabilityZone": { "Name": "us-west-2b" }, "SubnetStatus": "Active" } ], "DBSubnetGroupArn": "arn:aws:rds:us-west-2:534026745191:subgrp:mysubnetgroup" } } ``` Para obter mais informações, consulte [Etapa 3: criar um grupo de sub-redes do banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.CreateDBSubnetGroup) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [ModifyDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-subnet-group.html) na *Referência de comandos da AWS CLI*. ### `modify-event-subscription` O código de exemplo a seguir mostra como usar `modify-event-subscription`. **AWS CLI** **Para modificar a assinatura de um evento** O exemplo `modify-event-subscription` a seguir desativa a assinatura do evento especificado, de forma que não publique mais notificações para o tópico especificado do Amazon Simple Notification Service. ``` aws rds modify-event-subscription \ --subscription-name my-instance-events \ --no-enabled ``` Resultado: ``` { "EventSubscription": { "EventCategoriesList": [ "backup", "recovery" ], "CustomerAwsId": "123456789012", "SourceType": "db-instance", "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", "CustSubscriptionId": "my-instance-events", "Status": "modifying", "Enabled": false } } ``` + Para ver detalhes da API, consulte [ModifyEventSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-event-subscription.html) na *Referência de comandos da AWS CLI*. ### `modify-global-cluster` O código de exemplo a seguir mostra como usar `modify-global-cluster`. **AWS CLI** **Modificar um cluster de banco de dados global** O exemplo `modify-global-cluster` a seguir ativa a proteção contra exclusão de um cluster de banco de dados global compatível com o Aurora MySQL. ``` aws rds modify-global-cluster \ --global-cluster-identifier myglobalcluster \ --deletion-protection ``` Resultado: ``` { "GlobalCluster": { "GlobalClusterIdentifier": "myglobalcluster", "GlobalClusterResourceId": "cluster-f0e523bfe07aabb", "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", "Status": "available", "Engine": "aurora-mysql", "EngineVersion": "5.7.mysql_aurora.2.07.2", "StorageEncrypted": false, "DeletionProtection": true, "GlobalClusterMembers": [] } } ``` Para obter mais informações, consulte [Gerenciar um banco de dados global do Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-managing.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [ModifyGlobalCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-global-cluster.html) em *Referência de comandos da AWS CLI*. ### `promote-read-replica-db-cluster` O código de exemplo a seguir mostra como usar `promote-read-replica-db-cluster`. **AWS CLI** **Promover uma réplica de leitura de um cluster de banco de dados** O exemplo `promote-read-replica-db-cluster` a seguir promove a réplica de leitura especificada para um cluster de banco de dados autônomo. ``` aws rds promote-read-replica-db-cluster \ --db-cluster-identifier mydbcluster-1 ``` Resultado: ``` { "DBCluster": { "AllocatedStorage": 1, "AvailabilityZones": [ "us-east-1a", "us-east-1b", "us-east-1c" ], "BackupRetentionPeriod": 1, "DatabaseName": "", "DBClusterIdentifier": "mydbcluster-1", ...some output truncated... } } ``` Para obter mais informações, consulte [Promover uma réplica de leitura para um cluster de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Replication.CrossRegion.html#AuroraMySQL.Replication.CrossRegion.Promote) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [PromoteReadReplicaDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/promote-read-replica-db-cluster.html) em *Referência de comandos da AWS CLI*. ### `promote-read-replica` O código de exemplo a seguir mostra como usar `promote-read-replica`. **AWS CLI** **Promover uma réplica de leitura** O exemplo `promote-read-replica` a seguir promove a réplica de leitura especificada para uma instância de banco de dados autônoma. ``` aws rds promote-read-replica \ --db-instance-identifier test-instance-repl ``` Resultado: ``` { "DBInstance": { "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance-repl", "StorageType": "standard", "ReadReplicaSourceDBInstanceIdentifier": "test-instance", "DBInstanceStatus": "modifying", ...some output truncated... } } ``` + Para ver detalhes da API, consulte [PromoteReadReplica](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/promote-read-replica.html) em *Referência de comandos da AWS CLI*. ### `purchase-reserved-db-instance` O código de exemplo a seguir mostra como usar `purchase-reserved-db-instance`. **AWS CLI** **Comprar uma oferta de instância de banco de dados reservada** O exemplo `purchase-reserved-db-instances-offering` seguir compra uma oferta de instância de banco de dados reservada. O `reserved-db-instances-offering-id` deve ser um ID de oferta válido, conforme retornado pelo comando `describe-reserved-db-instances-offering`. aws rds purchase-reserved-db-instances-offering --reserved-db-instances-offering-id 438012d3-4a52-4cc7-b2e3-8dff72e0e706 + Para ver detalhes da API, consulte [PurchaseReservedDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/purchase-reserved-db-instance.html) em *Referência de comandos da AWS CLI*. ### `purchase-reserved-db-instances-offerings` O código de exemplo a seguir mostra como usar `purchase-reserved-db-instances-offerings`. **AWS CLI** **Exemplo 1: encontrar uma instância de banco de dados reservada para comprar** O exemplo `describe-reserved-db-instances-offerings` a seguir lista as instâncias de banco de dados MySQL reservadas disponíveis com a classe de instância db.t2.micro e duração de um ano. É necessário o ID da oferta para comprar uma instância de banco de dados reservada. ``` aws rds describe-reserved-db-instances-offerings \ --product-description mysql \ --db-instance-class db.t2.micro \ --duration 1 ``` Resultado: ``` { "ReservedDBInstancesOfferings": [ { "ReservedDBInstancesOfferingId": "8ba30be1-b9ec-447f-8f23-6114e3f4c7b4", "DBInstanceClass": "db.t2.micro", "Duration": 31536000, "FixedPrice": 51.0, "UsagePrice": 0.0, "CurrencyCode": "USD", "ProductDescription": "mysql", "OfferingType": "Partial Upfront", "MultiAZ": false, "RecurringCharges": [ { "RecurringChargeAmount": 0.006, "RecurringChargeFrequency": "Hourly" } ] }, ... some output truncated ... ] } ``` Para obter mais informações, consulte [Instâncias de banco de dados reservadas do Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithReservedDBInstances.html) no *Guia do usuário do Amazon RDS*. **Exemplo 2: comprar uma instância de banco de dados reservada** O exemplo `purchase-reserved-db-instances-offering` a seguir mostra como comprar a oferta de instância de banco de dados reservada do exemplo anterior. aws rds purchase-reserved-db-instances-offering --reserved-db-instances-offering-id 8ba30be1-b9ec-447f-8f23-6114e3f4c7b4 Resultado: ``` { "ReservedDBInstance": { "ReservedDBInstanceId": "ri-2020-06-29-16-54-57-670", "ReservedDBInstancesOfferingId": "8ba30be1-b9ec-447f-8f23-6114e3f4c7b4", "DBInstanceClass": "db.t2.micro", "StartTime": "2020-06-29T16:54:57.670Z", "Duration": 31536000, "FixedPrice": 51.0, "UsagePrice": 0.0, "CurrencyCode": "USD", "DBInstanceCount": 1, "ProductDescription": "mysql", "OfferingType": "Partial Upfront", "MultiAZ": false, "State": "payment-pending", "RecurringCharges": [ { "RecurringChargeAmount": 0.006, "RecurringChargeFrequency": "Hourly" } ], "ReservedDBInstanceArn": "arn:aws:rds:us-west-2:123456789012:ri:ri-2020-06-29-16-54-57-670" } } ``` Para obter mais informações, consulte [Instâncias de banco de dados reservadas do Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithReservedDBInstances.html) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [PurchaseReservedDbInstancesOfferings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/purchase-reserved-db-instances-offerings.html) em *Referência de comandos da AWS CLI*. ### `reboot-db-instance` O código de exemplo a seguir mostra como usar `reboot-db-instance`. **AWS CLI** **Como reinicializar uma instância de banco de dados** O exemplo de `reboot-db-instance` a seguir inicia uma reinicialização da instância de banco de dados especificada. ``` aws rds reboot-db-instance \ --db-instance-identifier test-mysql-instance ``` Resultado: ``` { "DBInstance": { "DBInstanceIdentifier": "test-mysql-instance", "DBInstanceClass": "db.t3.micro", "Engine": "mysql", "DBInstanceStatus": "rebooting", "MasterUsername": "admin", "Endpoint": { "Address": "test-mysql-instance.############.us-west-2.rds.amazonaws.com", "Port": 3306, "HostedZoneId": "Z1PVIF0EXAMPLE" }, ... output omitted... } } ``` Para obter mais informações, consulte [Reinicializar uma instância de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_RebootInstance.html) no *Guia do usuário do Amazon RDS*. + Consulte detalhes da API em [RebootDBInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/reboot-db-instance.html) na *Referência de comandos da AWS CLI*. ### `reboot-db-shard-group` O código de exemplo a seguir mostra como usar `reboot-db-shard-group`. **AWS CLI** **Exemplo 1: reinicializar um grupo de fragmentos de banco de dados** O exemplo `reboot-db-shard-group` a seguir reinicializa um grupo de fragmentos de banco de dados. ``` aws rds reboot-db-shard-group \ --db-shard-group-identifier my-db-shard-group ``` Resultado: ``` { "DBShardGroups": [ { "DBShardGroupResourceId": "shardgroup-a6e3a0226aa243e2ac6c7a1234567890", "DBShardGroupIdentifier": "my-db-shard-group", "DBClusterIdentifier": "my-sv2-cluster", "MaxACU": 1000.0, "ComputeRedundancy": 0, "Status": "available", "PubliclyAccessible": false, "Endpoint": "my-sv2-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com" } ] } ``` Para obter mais informações, consulte [Reinicializar uma instância, cluster ou banco de dados do Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_RebootCluster.html) no *Guia do usuário do Amazon Aurora*. **Exemplo 2: descrever seus grupos de fragmentos de banco de dados** O exemplo `describe-db-shard-groups` a seguir recupera os detalhes dos seus grupos de fragmentos de banco de dados depois que você executa o comando `reboot-db-shard-group`. O grupo de fragmentos de banco de dados `my-db-shard-group` está sendo reinicializado. ``` aws rds describe-db-shard-groups ``` Resultado: ``` { "DBShardGroups": [ { "DBShardGroupResourceId": "shardgroup-7bb446329da94788b3f957746example", "DBShardGroupIdentifier": "limitless-test-shard-grp", "DBClusterIdentifier": "limitless-test-cluster", "MaxACU": 768.0, "ComputeRedundancy": 0, "Status": "available", "PubliclyAccessible": true, "Endpoint": "limitless-test-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com" }, { "DBShardGroupResourceId": "shardgroup-a6e3a0226aa243e2ac6c7a1234567890", "DBShardGroupIdentifier": "my-db-shard-group", "DBClusterIdentifier": "my-sv2-cluster", "MaxACU": 1000.0, "ComputeRedundancy": 0, "Status": "rebooting", "PubliclyAccessible": false, "Endpoint": "my-sv2-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com" } ] } ``` Para obter mais informações, consulte [Reinicializar uma instância, cluster ou banco de dados do Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_RebootCluster.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [RebootDbShardGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/reboot-db-shard-group.html) em *Referência de Comandos da AWS CLI*. ### `register-db-proxy-targets` O código de exemplo a seguir mostra como usar `register-db-proxy-targets`. **AWS CLI** **Registrar um proxy de banco de dados com um banco de dados** O exemplo `register-db-proxy-targets` a seguir cria a associação entre um banco de dados e um proxy. ``` aws rds register-db-proxy-targets \ --db-proxy-name proxyExample \ --db-cluster-identifiers database-5 ``` Resultado: ``` { "DBProxyTargets": [ { "RdsResourceId": "database-5", "Port": 3306, "Type": "TRACKED_CLUSTER", "TargetHealth": { "State": "REGISTERING" } }, { "Endpoint": "database-5instance-1.ab0cd1efghij.us-east-1.rds.amazonaws.com", "RdsResourceId": "database-5", "Port": 3306, "Type": "RDS_INSTANCE", "TargetHealth": { "State": "REGISTERING" } } ] } ``` Para obter mais informações, consulte [Criar um proxy do RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-setup.html#rds-proxy-creating) no *Guia do usuário do Amazon RDS* e [Criar um proxy do RDS](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-setup.html#rds-proxy-creating) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [RegisterDbProxyTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/register-db-proxy-targets.html) em *Referência de comandos da AWS CLI*. ### `remove-from-global-cluster` O código de exemplo a seguir mostra como usar `remove-from-global-cluster`. **AWS CLI** **Separar um cluster secundário do Aurora de um cluster de banco de dados global do Aurora** O exemplo `remove-from-global-cluster` separa um cluster secundário do Aurora de um cluster de banco de dados global do Aurora. O cluster deixa de ser somente para leitura para ser um cluster autônomo com capacidade de leitura e gravação. ``` aws rds remove-from-global-cluster \ --region us-west-2 \ --global-cluster-identifier myglobalcluster \ --db-cluster-identifier arn:aws:rds:us-west-2:123456789012:cluster:DB-1 ``` Resultado: ``` { "GlobalCluster": { "GlobalClusterIdentifier": "myglobalcluster", "GlobalClusterResourceId": "cluster-abc123def456gh", "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", "Status": "available", "Engine": "aurora-postgresql", "EngineVersion": "10.11", "StorageEncrypted": true, "DeletionProtection": false, "GlobalClusterMembers": [ { "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:js-global-cluster", "Readers": [ "arn:aws:rds:us-west-2:123456789012:cluster:DB-1" ], "IsWriter": true }, { "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:DB-1", "Readers": [], "IsWriter": false, "GlobalWriteForwardingStatus": "disabled" } ] } } ``` Para obter mais informações, consulte [Remover um cluster de um banco de dados global do Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-managing.html#aurora-global-database-detaching) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [RemoveFromGlobalCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/remove-from-global-cluster.html) em *Referência de Comandos da AWS CLI*. ### `remove-option-from-option-group` O código de exemplo a seguir mostra como usar `remove-option-from-option-group`. **AWS CLI** **Excluir uma opção de um grupo de opções** O exemplo `remove-option-from-option-group` a seguir remove a opção `OEM` de `myoptiongroup`. ``` aws rds remove-option-from-option-group \ --option-group-name myoptiongroup \ --options OEM \ --apply-immediately ``` Resultado: ``` { "OptionGroup": { "OptionGroupName": "myoptiongroup", "OptionGroupDescription": "Test", "EngineName": "oracle-ee", "MajorEngineVersion": "19", "Options": [], "AllowsVpcAndNonVpcInstanceMemberships": true, "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:myoptiongroup" } } ``` Para obter mais informações, consulte [Remover uma opção de um grupo de opções](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithOptionGroups.html#USER_WorkingWithOptionGroups.RemoveOption) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [RemoveOptionFromOptionGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/remove-option-from-option-group.html) em *Referência de comandos da AWS CLI*. ### `remove-role-from-db-cluster` O código de exemplo a seguir mostra como usar `remove-role-from-db-cluster`. **AWS CLI** **Desassociar um perfil do Identity and Access Management (IAM) da AWS de um cluster de banco de dados** O exemplo `remove-role-from-db-cluster` a seguir remove um perfil de um cluster de banco de dados. ``` aws rds remove-role-from-db-cluster \ --db-cluster-identifier mydbcluster \ --role-arn arn:aws:iam::123456789012:role/RDSLoadFromS3 ``` Este comando não produz saída. Para obter mais informações, consulte [Associar um perfil do IAM a um cluster de banco de dados do Amazon Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Integrating.Authorizing.IAM.AddRoleToDBCluster.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [RemoveRoleFromDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/remove-role-from-db-cluster.html) em *Referência de Comandos da AWS CLI*. ### `remove-role-from-db-instance` O código de exemplo a seguir mostra como usar `remove-role-from-db-instance`. **AWS CLI** **Desassociar um perfil do Identity and Access Management (IAM) da AWS de uma instância de banco de dados.** O exemplo `remove-role-from-db-instance` a seguir remove o perfil denominado `rds-s3-integration-role` de uma instância de banco de dados do Oracle denominada`test-instance`. ``` aws rds remove-role-from-db-instance \ --db-instance-identifier test-instance \ --feature-name S3_INTEGRATION \ --role-arn arn:aws:iam::111122223333:role/rds-s3-integration-role ``` Este comando não produz saída. Para obter mais informações, consulte [Desabilitar a integração do RDS SQL Server com o S3](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/User.SQLServer.Options.S3-integration.html#Appendix.SQLServer.Options.S3-integration.disabling) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [RemoveRoleFromDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/remove-role-from-db-instance.html) em *Referência de comandos da AWS CLI*. ### `remove-source-identifier-from-subscription` O código de exemplo a seguir mostra como usar `remove-source-identifier-from-subscription`. **AWS CLI** **Remover um identificador de origem de uma assinatura** O exemplo `remove-source-identifier` a seguir remove o identificador de origem de uma assinatura existente. ``` aws rds remove-source-identifier-from-subscription \ --subscription-name my-instance-events \ --source-identifier test-instance-repl ``` Resultado: ``` { "EventSubscription": { "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", "EventCategoriesList": [ "backup", "recovery" ], "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", "Status": "modifying", "CustSubscriptionId": "my-instance-events", "CustomerAwsId": "123456789012", "SourceIdsList": [ "test-instance" ], "SourceType": "db-instance", "Enabled": false } } ``` + Para ver detalhes da API, consulte [RemoveSourceIdentifierFromSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/remove-source-identifier-from-subscription.html) em *Referência de comandos da AWS CLI*. ### `remove-tags-from-resource` O código de exemplo a seguir mostra como usar `remove-tags-from-resource`. **AWS CLI** **Como remover as tags de um recurso** O exemplo `remove-tags-from-resource` a seguir remove as tags de um recurso. ``` aws rds remove-tags-from-resource \ --resource-name arn:aws:rds:us-east-1:123456789012:db:mydbinstance \ --tag-keys Name Environment ``` Este comando não produz saída. Para obter mais informações, consulte [Marcar recursos do Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) no *Guia do usuário do Amazon RDS* e [Marcar recursos do Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) no *Guia do usuário do Amazon Aurora.* + Consulte detalhes da API em [RemoveTagsFromResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/remove-tags-from-resource.html) na *Referência de comandos da AWS CLI*. ### `reset-db-cluster-parameter-group` O código de exemplo a seguir mostra como usar `reset-db-cluster-parameter-group`. **AWS CLI** **Exemplo 1: redefinir todos os parâmetros para os valores padrão** O exemplo `reset-db-cluster-parameter-group` a seguir redefine todos os valores de parâmetro em um grupo de parâmetros de banco de dados do cliente para os valores padrão. ``` aws rds reset-db-cluster-parameter-group \ --db-cluster-parameter-group-name mydbclpg \ --reset-all-parameters ``` Resultado: ``` { "DBClusterParameterGroupName": "mydbclpg" } ``` Para obter mais informações, consulte [Trabalhar com grupos de parâmetros de banco de dados e grupos de parâmetros de cluster de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) no *Guia do usuário do Amazon Aurora*. **Exemplo 2: redefinir os parâmetros especificados para os valores padrão** O exemplo `reset-db-cluster-parameter-group` a seguir redefine os valores de parâmetro de parâmetros específicos para os valores padrão em um grupo de parâmetros de cluster de banco de dados do cliente. ``` aws rds reset-db-cluster-parameter-group \ --db-cluster-parameter-group-name mydbclpgy \ --parameters "ParameterName=max_connections,ApplyMethod=immediate" \ "ParameterName=max_allowed_packet,ApplyMethod=immediate" ``` Resultado: ``` { "DBClusterParameterGroupName": "mydbclpg" } ``` Para obter mais informações, consulte [Trabalhar com grupos de parâmetros de banco de dados e grupos de parâmetros de cluster de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [ResetDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/reset-db-cluster-parameter-group.html) na *Referência de comandos da AWS CLI*. ### `reset-db-parameter-group` O código de exemplo a seguir mostra como usar `reset-db-parameter-group`. **AWS CLI** **Exemplo 1: redefinir todos os parâmetros para os valores padrão** O exemplo `reset-db-parameter-group` a seguir, redefine todos os valores de parâmetro em um grupo de parâmetros de banco de dados do cliente para os valores padrão. ``` aws rds reset-db-parameter-group \ --db-parameter-group-name mypg \ --reset-all-parameters ``` Resultado: ``` { "DBParameterGroupName": "mypg" } ``` Para obter mais informações, consulte [Trabalhar com grupos de parâmetros de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) no *Guia do usuário do Amazon RDS* e [Trabalhar com grupos de parâmetros de banco de dados e grupos de parâmetros de cluster de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) no *Guia do usuário do Amazon Aurora*. **Exemplo 2: redefinir os parâmetros especificados para os valores padrão** O exemplo `reset-db-parameter-group` a seguir redefine os valores de parâmetro de parâmetros específicos para os valores padrão em um grupo de parâmetros de banco de dados do cliente. ``` aws rds reset-db-parameter-group \ --db-parameter-group-name mypg \ --parameters "ParameterName=max_connections,ApplyMethod=immediate" \ "ParameterName=max_allowed_packet,ApplyMethod=immediate" ``` Resultado: ``` { "DBParameterGroupName": "mypg" } ``` Para obter mais informações, consulte [Trabalhar com grupos de parâmetros de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) no *Guia do usuário do Amazon RDS* e [Trabalhar com grupos de parâmetros de banco de dados e grupos de parâmetros de cluster de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [ResetDbParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/reset-db-parameter-group.html) em *Referência de comandos da AWS CLI*. ### `restore-db-cluster-from-s3` O código de exemplo a seguir mostra como usar `restore-db-cluster-from-s3`. **AWS CLI** **Restaurar um cluster de banco de dados do Amazon Aurora a partir do Amazon S3** O exemplo `restore-db-cluster-from-s3` a seguir restaura um cluster de banco de dados compatível com Amazon Aurora MySQL versão 5.7 a partir de um arquivo de backup de banco de dados MySQL 5.7 no Amazon S3. ``` aws rds restore-db-cluster-from-s3 \ --db-cluster-identifier cluster-s3-restore \ --engine aurora-mysql \ --master-username admin \ --master-user-password mypassword \ --s3-bucket-name amzn-s3-demo-bucket \ --s3-prefix test-backup \ --s3-ingestion-role-arn arn:aws:iam::123456789012:role/service-role/TestBackup \ --source-engine mysql \ --source-engine-version 5.7.28 ``` Resultado: ``` { "DBCluster": { "AllocatedStorage": 1, "AvailabilityZones": [ "us-west-2c", "us-west-2a", "us-west-2b" ], "BackupRetentionPeriod": 1, "DBClusterIdentifier": "cluster-s3-restore", "DBClusterParameterGroup": "default.aurora-mysql5.7", "DBSubnetGroup": "default", "Status": "creating", "Endpoint": "cluster-s3-restore.cluster-co3xyzabc123.us-west-2.rds.amazonaws.com", "ReaderEndpoint": "cluster-s3-restore.cluster-ro-co3xyzabc123.us-west-2.rds.amazonaws.com", "MultiAZ": false, "Engine": "aurora-mysql", "EngineVersion": "5.7.12", "Port": 3306, "MasterUsername": "admin", "PreferredBackupWindow": "11:15-11:45", "PreferredMaintenanceWindow": "thu:12:19-thu:12:49", "ReadReplicaIdentifiers": [], "DBClusterMembers": [], "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sg-########", "Status": "active" } ], "HostedZoneId": "Z1PVIF0EXAMPLE", "StorageEncrypted": false, "DbClusterResourceId": "cluster-SU5THYQQHOWCXZZDGXREXAMPLE", "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:cluster-s3-restore", "AssociatedRoles": [], "IAMDatabaseAuthenticationEnabled": false, "ClusterCreateTime": "2020-07-27T14:22:08.095Z", "EngineMode": "provisioned", "DeletionProtection": false, "HttpEndpointEnabled": false, "CopyTagsToSnapshot": false, "CrossAccountClone": false, "DomainMemberships": [] } } ``` Para obter mais informações, consulte [Migrar dados do MySQL usando m bucket do Amazon S3](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Migrating.ExtMySQL.html#AuroraMySQL.Migrating.ExtMySQL.S3) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [RestoreDbClusterFromS3](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/restore-db-cluster-from-s3.html) em *Referência de comandos da AWS CLI*. ### `restore-db-cluster-from-snapshot` O código de exemplo a seguir mostra como usar `restore-db-cluster-from-snapshot`. **AWS CLI** **Restaurar um cluster a partir de um snapshot** O exemplo `restore-db-cluster-from-snapshot` a seguir restaura um cluster de banco de dados do Aurora PostgreSQL compatível com o PostgreSQL versão 10.7 a partir de um snapshot de cluster de banco de dados denominado `test-instance-snapshot`. ``` aws rds restore-db-cluster-from-snapshot \ --db-cluster-identifier newdbcluster \ --snapshot-identifier test-instance-snapshot \ --engine aurora-postgresql \ --engine-version 10.7 ``` Resultado: ``` { "DBCluster": { "AllocatedStorage": 1, "AvailabilityZones": [ "us-west-2c", "us-west-2a", "us-west-2b" ], "BackupRetentionPeriod": 7, "DatabaseName": "", "DBClusterIdentifier": "newdbcluster", "DBClusterParameterGroup": "default.aurora-postgresql10", "DBSubnetGroup": "default", "Status": "creating", "Endpoint": "newdbcluster.cluster-############.us-west-2.rds.amazonaws.com", "ReaderEndpoint": "newdbcluster.cluster-ro-############.us-west-2.rds.amazonaws.com", "MultiAZ": false, "Engine": "aurora-postgresql", "EngineVersion": "10.7", "Port": 5432, "MasterUsername": "postgres", "PreferredBackupWindow": "09:33-10:03", "PreferredMaintenanceWindow": "sun:12:22-sun:12:52", "ReadReplicaIdentifiers": [], "DBClusterMembers": [], "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sg-########", "Status": "active" } ], "HostedZoneId": "Z1PVIF0EXAMPLE", "StorageEncrypted": true, "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/287364e4-33e3-4755-a3b0-a1b2c3d4e5f6", "DbClusterResourceId": "cluster-5DSB5IFQDDUVAWOUWM1EXAMPLE", "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:newdbcluster", "AssociatedRoles": [], "IAMDatabaseAuthenticationEnabled": false, "ClusterCreateTime": "2020-06-05T15:06:58.634Z", "EngineMode": "provisioned", "DeletionProtection": false, "HttpEndpointEnabled": false, "CopyTagsToSnapshot": false, "CrossAccountClone": false, "DomainMemberships": [] } } ``` Para obter mais informações, consulte [Restaurar a partir de um snapshot de um cluster de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_RestoreFromSnapshot.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [RestoreDbClusterFromSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/restore-db-cluster-from-snapshot.html) na *Referência de comandos da AWS CLI*. ### `restore-db-cluster-to-point-in-time` O código de exemplo a seguir mostra como usar `restore-db-cluster-to-point-in-time`. **AWS CLI** **Restaurar um cluster de banco de dados para um horário específico** O exemplo `restore-db-cluster-to-point-in-time` a seguir restaura o cluster de banco de dados denominado `database-4` para a hora mais recente possível. Usar `copy-on-write` como tipo de restauração restaura o novo cluster de banco de dados como um clone do cluster de banco de dados de origem. ``` aws rds restore-db-cluster-to-point-in-time \ --source-db-cluster-identifier database-4 \ --db-cluster-identifier sample-cluster-clone \ --restore-type copy-on-write \ --use-latest-restorable-time ``` Resultado: ``` { "DBCluster": { "AllocatedStorage": 1, "AvailabilityZones": [ "us-west-2c", "us-west-2a", "us-west-2b" ], "BackupRetentionPeriod": 7, "DatabaseName": "", "DBClusterIdentifier": "sample-cluster-clone", "DBClusterParameterGroup": "default.aurora-postgresql10", "DBSubnetGroup": "default", "Status": "creating", "Endpoint": "sample-cluster-clone.cluster-############.us-west-2.rds.amazonaws.com", "ReaderEndpoint": "sample-cluster-clone.cluster-ro-############.us-west-2.rds.amazonaws.com", "MultiAZ": false, "Engine": "aurora-postgresql", "EngineVersion": "10.7", "Port": 5432, "MasterUsername": "postgres", "PreferredBackupWindow": "09:33-10:03", "PreferredMaintenanceWindow": "sun:12:22-sun:12:52", "ReadReplicaIdentifiers": [], "DBClusterMembers": [], "VpcSecurityGroups": [ { "VpcSecurityGroupId": "sg-########", "Status": "active" } ], "HostedZoneId": "Z1PVIF0EXAMPLE", "StorageEncrypted": true, "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/287364e4-33e3-4755-a3b0-a1b2c3d4e5f6", "DbClusterResourceId": "cluster-BIZ77GDSA2XBSTNPFW1EXAMPLE", "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster-clone", "AssociatedRoles": [], "IAMDatabaseAuthenticationEnabled": false, "CloneGroupId": "8d19331a-099a-45a4-b4aa-11aa22bb33cc44dd", "ClusterCreateTime": "2020-03-10T19:57:38.967Z", "EngineMode": "provisioned", "DeletionProtection": false, "HttpEndpointEnabled": false, "CopyTagsToSnapshot": false, "CrossAccountClone": false } } ``` Para obter mais informações, consulte [Restaurar um cluster de banco de dados em um horário específico](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PIT.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [RestoreDbClusterToPointInTime](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/restore-db-cluster-to-point-in-time.html) na *Referência de comandos da AWS CLI*. ### `restore-db-instance-from-db-snapshot` O código de exemplo a seguir mostra como usar `restore-db-instance-from-db-snapshot`. **AWS CLI** **Para restaurar uma instância de banco de dados a partir de um snapshot de banco de dados** O exemplo `restore-db-instance-from-db-snapshot` a seguir cria uma nova instância de banco de dados denominada `db7-new-instance` com a classe de instância de banco de dados `db.t3.small` a partir do snapshot de banco de dados especificado. A instância de banco de dados de origem da qual o snapshot foi obtido usa uma classe de instância de banco de dados obsoleta, então não é possível atualizá-la. ``` aws rds restore-db-instance-from-db-snapshot \ --db-instance-identifier db7-new-instance \ --db-snapshot-identifier db7-test-snapshot \ --db-instance-class db.t3.small ``` Resultado: ``` { "DBInstance": { "DBInstanceIdentifier": "db7-new-instance", "DBInstanceClass": "db.t3.small", "Engine": "mysql", "DBInstanceStatus": "creating", ...output omitted... "PreferredMaintenanceWindow": "mon:07:37-mon:08:07", "PendingModifiedValues": {}, "MultiAZ": false, "EngineVersion": "5.7.22", "AutoMinorVersionUpgrade": true, "ReadReplicaDBInstanceIdentifiers": [], "LicenseModel": "general-public-license", ...output omitted... "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:db7-new-instance", "IAMDatabaseAuthenticationEnabled": false, "PerformanceInsightsEnabled": false, "DeletionProtection": false, "AssociatedRoles": [] } } ``` Para obter mais informações, consulte [Restaurar a partir de um snapshot de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_RestoreFromSnapshot.html) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [RestoreDbInstanceFromDbSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/restore-db-instance-from-db-snapshot.html) na *Referência de comandos da AWS CLI*. ### `restore-db-instance-from-s3` O código de exemplo a seguir mostra como usar `restore-db-instance-from-s3`. **AWS CLI** **Restaurar uma instância de banco de dados a partir de um backup no Amazon S3** O exemplo `restore-db-instance-from-s3` a seguir cria uma nova instância de banco de dados denominada `restored-test-instance` a partir de um backup existente no bucket `my-backups` do S3. ``` aws rds restore-db-instance-from-s3 \ --db-instance-identifier restored-test-instance \ --allocated-storage 250 --db-instance-class db.m4.large --engine mysql \ --master-username master --master-user-password secret99 \ --s3-bucket-name my-backups --s3-ingestion-role-arn arn:aws:iam::123456789012:role/my-role \ --source-engine mysql --source-engine-version 5.6.27 ``` + Para ver detalhes da API, consulte [RestoreDbInstanceFromS3](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/restore-db-instance-from-s3.html) em *Referência de comandos da AWS CLI*. ### `restore-db-instance-to-point-in-time` O código de exemplo a seguir mostra como usar `restore-db-instance-to-point-in-time`. **AWS CLI** **Exemplo 1: restaurar uma instância de banco de dados para um momento específico** O exemplo `restore-db-instance-to-point-in-time` a seguir restaura `test-instance` para uma nova instância de banco de dados denominada `restored-test-instance`, a partir do momento especificado. ``` aws rds restore-db-instance-to-point-in-time \ --source-db-instance-identifier test-instance \ --target-db-instance restored-test-instance \ --restore-time 2018-07-30T23:45:00.000Z ``` Resultado: ``` { "DBInstance": { "AllocatedStorage": 20, "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:restored-test-instance", "DBInstanceStatus": "creating", "DBInstanceIdentifier": "restored-test-instance", ...some output omitted... } } ``` Para obter instruções, consulte [Restaurar uma instância de banco de dados para um horário especificado](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIT.html) no *Guia do usuário do Amazon RDS*. **Exemplo 2: restaurar uma instância de banco de dados para um horário específico a partir de um backup replicado** O exemplo `restore-db-instance-to-point-in-time` a seguir restaura uma instância de banco de dados do Oracle para o horário especificado usando um backup automatizado replicado. ``` aws rds restore-db-instance-to-point-in-time \ --source-db-instance-automated-backups-arn "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" \ --target-db-instance-identifier myorclinstance-from-replicated-backup \ --restore-time 2020-12-08T18:45:00.000Z ``` Resultado: ``` { "DBInstance": { "DBInstanceIdentifier": "myorclinstance-from-replicated-backup", "DBInstanceClass": "db.t3.micro", "Engine": "oracle-se2", "DBInstanceStatus": "creating", "MasterUsername": "admin", "DBName": "ORCL", "AllocatedStorage": 20, "PreferredBackupWindow": "07:45-08:15", "BackupRetentionPeriod": 14, ... some output omitted ... "DbiResourceId": "db-KGLXG75BGVIWKQT7NQ4EXAMPLE", "CACertificateIdentifier": "rds-ca-2019", "DomainMemberships": [], "CopyTagsToSnapshot": false, "MonitoringInterval": 0, "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:myorclinstance-from-replicated-backup", "IAMDatabaseAuthenticationEnabled": false, "PerformanceInsightsEnabled": false, "DeletionProtection": false, "AssociatedRoles": [], "TagList": [] } } ``` Para obter mais informações, consulte [Restaurar para um horário específico a partir de um backup replicado](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html#AutomatedBackups.PiTR) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [RestoreDbInstanceToPointInTime](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/restore-db-instance-to-point-in-time.html) em *Referência de comandos da AWS CLI*. ### `start-activity-stream` O código de exemplo a seguir mostra como usar `start-activity-stream`. **AWS CLI** **Iniciar um fluxo de atividade de banco de dados** O exemplo `start-activity-stream` a seguir inicia um fluxo de atividades assíncrono para monitorar um cluster do Aurora denominado my-pg-cluster. ``` aws rds start-activity-stream \ --region us-east-1 \ --mode async \ --kms-key-id arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1 \ --resource-arn arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster \ --apply-immediately ``` Resultado: ``` { "KmsKeyId": "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1", "KinesisStreamName": "aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S", "Status": "starting", "Mode": "async", "ApplyImmediately": true } ``` Para obter mais informações, consulte [Iniciar um fluxo de atividades de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/DBActivityStreams.html#DBActivityStreams.Enabling) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [StartActivityStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/start-activity-stream.html) em *Referência de comandos daAWS CLI*. ### `start-db-cluster` O código de exemplo a seguir mostra como usar `start-db-cluster`. **AWS CLI** **Iniciar um cluster de banco de dados** O exemplo `start-db-cluster` a seguir inicia um cluster de banco de dados e as instâncias de banco de dados. ``` aws rds start-db-cluster \ --db-cluster-identifier mydbcluster ``` Resultado: ``` { "DBCluster": { "AllocatedStorage": 1, "AvailabilityZones": [ "us-east-1a", "us-east-1e", "us-east-1b" ], "BackupRetentionPeriod": 1, "DatabaseName": "mydb", "DBClusterIdentifier": "mydbcluster", ...some output truncated... } } ``` Para obter mais informações, consulte [Interromper e iniciar um cluster de banco de dados do Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [StartDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/start-db-cluster.html) na *Referência de comandos da AWS CLI*. ### `start-db-instance-automated-backups-replication` O código de exemplo a seguir mostra como usar `start-db-instance-automated-backups-replication`. **AWS CLI** **Habilitar backups automatizados entre regiões** O exemplo `start-db-instance-automated-backups-replication` a seguir replica backups automatizados de uma instância de banco de dados na região Leste dos EUA (N. da Virgínia) para Oeste dos EUA (Oregon). O período de retenção de backup é de 14 dias. ``` aws rds start-db-instance-automated-backups-replication \ --region us-west-2 \ --source-db-instance-arn "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db" \ --backup-retention-period 14 ``` Resultado: ``` { "DBInstanceAutomatedBackup": { "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE", "Region": "us-east-1", "DBInstanceIdentifier": "new-orcl-db", "RestoreWindow": {}, "AllocatedStorage": 20, "Status": "pending", "Port": 1521, "InstanceCreateTime": "2020-12-04T15:28:31Z", "MasterUsername": "admin", "Engine": "oracle-se2", "EngineVersion": "12.1.0.2.v21", "LicenseModel": "bring-your-own-license", "OptionGroupName": "default:oracle-se2-12-1", "Encrypted": false, "StorageType": "gp2", "IAMDatabaseAuthenticationEnabled": false, "BackupRetentionPeriod": 14, "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" } } ``` Para obter mais informações, consulte [Habilitar backups automáticos entre regiões](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html#AutomatedBackups.Replicating.Enable) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [StartDbInstanceAutomatedBackupsReplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/start-db-instance-automated-backups-replication.html) em *Referência de comandos da AWS CLI*. ### `start-db-instance` O código de exemplo a seguir mostra como usar `start-db-instance`. **AWS CLI** **Iniciar uma instância de banco de dados** O exemplo `start-db-instance` a seguir inicia uma instância de banco de dados especificada. ``` aws rds start-db-instance \ --db-instance-identifier test-instance ``` Resultado: ``` { "DBInstance": { "DBInstanceStatus": "starting", ...some output truncated... } } ``` + Para ver detalhes da API, consulte [StartDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/start-db-instance.html) em *Referência de comandos da AWS CLI*. ### `start-export-task` O código de exemplo a seguir mostra como usar `start-export-task`. **AWS CLI** **Exportar um snapshot para o Amazon S3** O exemplo `start-export-task` a seguir exporta um snapshot de banco de dados denominado `db5-snapshot-test` para o bucket do Amazon S3 denominado `amzn-s3-demo-bucket`. ``` aws rds start-export-task \ --export-task-identifier my-s3-export \ --source-arn arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test \ --s3-bucket-name amzn-s3-demo-bucket \ --iam-role-arn arn:aws:iam::123456789012:role/service-role/ExportRole \ --kms-key-id arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff ``` Resultado: ``` { "ExportTaskIdentifier": "my-s3-export", "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test", "SnapshotTime": "2020-03-27T20:48:42.023Z", "S3Bucket": "amzn-s3-demo-bucket", "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole", "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff", "Status": "STARTING", "PercentProgress": 0, "TotalExtractedDataInGB": 0 } ``` Para obter mais informações, consulte [Exportar um snapshot para um bucket do Amazon S3](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ExportSnapshot.html#USER_ExportSnapshot.Exporting) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [StartExportTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/start-export-task.html) em *Referência de comandos da AWS CLI*. ### `stop-activity-stream` O código de exemplo a seguir mostra como usar `stop-activity-stream`. **AWS CLI** **Interromper um fluxo de atividade de banco de dados** O exemplo `stop-activity-stream` a seguir interrompe um fluxo de atividades em um cluster do Aurora denominado my-pg-cluster. ``` aws rds stop-activity-stream \ --region us-east-1 \ --resource-arn arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster \ --apply-immediately ``` Resultado: ``` { "KmsKeyId": "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1", "KinesisStreamName": "aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S", "Status": "stopping" } ``` Para obter mais informações, consulte [Interromper um fluxo de atividade](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/DBActivityStreams.html#DBActivityStreams.Disabling) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [StopActivityStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/stop-activity-stream.html) em *Referência de comandos da AWS CLI*. ### `stop-db-cluster` O código de exemplo a seguir mostra como usar `stop-db-cluster`. **AWS CLI** **Interromper um cluster de banco de dados** O exemplo `stop-db-cluster` a seguir interrompe um cluster de banco de dados e as instâncias de banco de dados. ``` aws rds stop-db-cluster \ --db-cluster-identifier mydbcluster ``` Resultado: ``` { "DBCluster": { "AllocatedStorage": 1, "AvailabilityZones": [ "us-east-1a", "us-east-1e", "us-east-1b" ], "BackupRetentionPeriod": 1, "DatabaseName": "mydb", "DBClusterIdentifier": "mydbcluster", ...some output truncated... } } ``` Para obter mais informações, consulte [Interromper e iniciar um cluster de banco de dados do Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [StopDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/stop-db-cluster.html) na *Referência de comandos da AWS CLI*. ### `stop-db-instance-automated-backups-replication` O código de exemplo a seguir mostra como usar `stop-db-instance-automated-backups-replication`. **AWS CLI** **Parar de replicar backups automatizados** O exemplo `stop-db-instance-automated-backups-replication` a seguir encerra a replicação de backups automatizados para a região Oeste dos EUA (Oregon). Os backups replicados são retidos de acordo com o período de retenção de backup definido. ``` aws rds stop-db-instance-automated-backups-replication \ --region us-west-2 \ --source-db-instance-arn "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db" ``` Resultado: ``` { "DBInstanceAutomatedBackup": { "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE", "Region": "us-east-1", "DBInstanceIdentifier": "new-orcl-db", "RestoreWindow": { "EarliestTime": "2020-12-04T23:13:21.030Z", "LatestTime": "2020-12-07T19:59:57Z" }, "AllocatedStorage": 20, "Status": "replicating", "Port": 1521, "InstanceCreateTime": "2020-12-04T15:28:31Z", "MasterUsername": "admin", "Engine": "oracle-se2", "EngineVersion": "12.1.0.2.v21", "LicenseModel": "bring-your-own-license", "OptionGroupName": "default:oracle-se2-12-1", "Encrypted": false, "StorageType": "gp2", "IAMDatabaseAuthenticationEnabled": false, "BackupRetentionPeriod": 7, "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" } } ``` Para obter mais informações, consulte [Interromper a replicação automatizada de backup](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html#AutomatedBackups.StopReplicating) no *Guia do Usuário do Amazon RDS*. + Para ver detalhes da API, consulte [StopDbInstanceAutomatedBackupsReplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/stop-db-instance-automated-backups-replication.html) em *Referência de Comandos da AWS CLI*. ### `stop-db-instance` O código de exemplo a seguir mostra como usar `stop-db-instance`. **AWS CLI** **Encerrar uma instância de banco de dados** O exemplo `stop-db-instance` a seguir interrompe a instância de banco de dados especificada. ``` aws rds stop-db-instance \ --db-instance-identifier test-instance ``` Resultado: ``` { "DBInstance": { "DBInstanceStatus": "stopping", ...some output truncated... } } ``` + Para ver detalhes da API, consulte [StopDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/stop-db-instance.html) em *Referência de comandos da AWS CLI*. ### `switchover-blue-green-deployment` O código de exemplo a seguir mostra como usar `switchover-blue-green-deployment`. **AWS CLI** **Exemplo 1: alternar uma implantação azul/verde para uma instância de banco de dados do RDS** O exemplo `switchover-blue-green-deployment` a seguir promove o ambiente verde especificado como o novo ambiente de produção. ``` aws rds switchover-blue-green-deployment \ --blue-green-deployment-identifier bgd-wi89nwzglccsfake \ --switchover-timeout 300 ``` Resultado: ``` { "BlueGreenDeployment": { "BlueGreenDeploymentIdentifier": "bgd-v53303651eexfake", "BlueGreenDeploymentName": "bgd-cli-test-instance", "Source": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance", "Target": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-blhi1e", "SwitchoverDetails": [ { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-blhi1e", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1-green-k5fv7u", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2-green-ggsh8m", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3-green-o2vwm0", "Status": "AVAILABLE" } ], "Tasks": [ { "Name": "CREATING_READ_REPLICA_OF_SOURCE", "Status": "COMPLETED" }, { "Name": "DB_ENGINE_VERSION_UPGRADE", "Status": "COMPLETED" }, { "Name": "CONFIGURE_BACKUPS", "Status": "COMPLETED" }, { "Name": "CREATING_TOPOLOGY_OF_SOURCE", "Status": "COMPLETED" } ], "Status": "SWITCHOVER_IN_PROGRESS", "CreateTime": "2022-02-25T22:33:22.225000+00:00" } } ``` Para obter mais informações, consulte [Alternar uma implantação azul/verde](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments-switching.html) no *Guia do usuário do Amazon RDS*. **Exemplo 2: promover uma implantação azul/verde de um cluster de banco de dados do Aurora MySQL** O exemplo `switchover-blue-green-deployment` a seguir promove o ambiente verde especificado como o novo ambiente de produção. ``` aws rds switchover-blue-green-deployment \ --blue-green-deployment-identifier bgd-wi89nwzglccsfake \ --switchover-timeout 300 ``` Resultado: ``` { "BlueGreenDeployment": { "BlueGreenDeploymentIdentifier": "bgd-wi89nwzglccsfake", "BlueGreenDeploymentName": "my-blue-green-deployment", "Source": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster", "Target": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3ud8z6", "SwitchoverDetails": [ { "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster", "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3ud8z6", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1-green-bvxc73", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2-green-7wc4ie", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3", "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3-green-p4xxkz", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint", "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint-green-np1ikl", "Status": "AVAILABLE" }, { "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint", "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint-green-miszlf", "Status": "AVAILABLE" } ], "Tasks": [ { "Name": "CREATING_READ_REPLICA_OF_SOURCE", "Status": "COMPLETED" }, { "Name": "DB_ENGINE_VERSION_UPGRADE", "Status": "COMPLETED" }, { "Name": "CREATE_DB_INSTANCES_FOR_CLUSTER", "Status": "COMPLETED" }, { "Name": "CREATE_CUSTOM_ENDPOINTS", "Status": "COMPLETED" } ], "Status": "SWITCHOVER_IN_PROGRESS", "CreateTime": "2022-02-25T22:38:49.522000+00:00" } } ``` Para obter mais informações, consulte [Alternar uma implantação azul/verde](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments-switching.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [SwitchoverBlueGreenDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/switchover-blue-green-deployment.html) em *Referência de comandos da AWS CLI*. # Exemplos do Amazon RDS Data Service usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o Amazon RDS Data 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 ### `batch-execute-statement` O código de exemplo a seguir mostra como usar `batch-execute-statement`. **AWS CLI** **Para executar uma instrução SQL em lote** O exemplo `batch-execute-statement` a seguir executa uma instrução SQL em lote em uma matriz de dados com um conjunto de parâmetros. ``` aws rds-data batch-execute-statement \ --resource-arn "arn:aws:rds:us-west-2:123456789012:cluster:mydbcluster" \ --database "mydb" \ --secret-arn "arn:aws:secretsmanager:us-west-2:123456789012:secret:mysecret" \ --sql "insert into mytable values (:id, :val)" \ --parameter-sets "[[{\"name\": \"id\", \"value\": {\"longValue\": 1}},{\"name\": \"val\", \"value\": {\"stringValue\": \"ValueOne\"}}], [{\"name\": \"id\", \"value\": {\"longValue\": 2}},{\"name\": \"val\", \"value\": {\"stringValue\": \"ValueTwo\"}}], [{\"name\": \"id\", \"value\": {\"longValue\": 3}},{\"name\": \"val\", \"value\": {\"stringValue\": \"ValueThree\"}}]]" ``` Este comando não produz saída. Para obter mais informações, consulte [Using the Data API for Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [BatchExecuteStatement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds-data/batch-execute-statement.html) na *Referência de comandos da AWS CLI*. ### `begin-transaction` O código de exemplo a seguir mostra como usar `begin-transaction`. **AWS CLI** **Para iniciar uma transação SQL** O exemplo `begin-transaction` a seguir executa uma transação SQL. ``` aws rds-data begin-transaction \ --resource-arn "arn:aws:rds:us-west-2:123456789012:cluster:mydbcluster" \ --database "mydb" \ --secret-arn "arn:aws:secretsmanager:us-west-2:123456789012:secret:mysecret" ``` Resultado: ``` { "transactionId": "ABC1234567890xyz" } ``` Para obter mais informações, consulte [Using the Data API for Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [BeginTransaction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds-data/begin-transaction.html) na *Referência de comandos da AWS CLI*. ### `commit-transaction` O código de exemplo a seguir mostra como usar `commit-transaction`. **AWS CLI** **Como confirmar uma transação SQL** O exemplo `commit-transaction` a seguir encerra a transação SQL especificada e confirma as alterações feitas como parte dela. ``` aws rds-data commit-transaction \ --resource-arn "arn:aws:rds:us-west-2:123456789012:cluster:mydbcluster" \ --secret-arn "arn:aws:secretsmanager:us-west-2:123456789012:secret:mysecret" \ --transaction-id "ABC1234567890xyz" ``` Resultado: ``` { "transactionStatus": "Transaction Committed" } ``` Para obter mais informações, consulte [Using the Data API for Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [CommitTransaction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds-data/commit-transaction.html) na *Referência de comandos da AWS CLI*. ### `execute-statement` O código de exemplo a seguir mostra como usar `execute-statement`. **AWS CLI** **Exemplo 1: como executar uma instrução SQL que faz parte de uma transação** O exemplo de `execute-statement` a seguir executa uma instrução SQL que é parte de uma transação. ``` aws rds-data execute-statement \ --resource-arn "arn:aws:rds:us-west-2:123456789012:cluster:mydbcluster" \ --database "mydb" \ --secret-arn "arn:aws:secretsmanager:us-west-2:123456789012:secret:mysecret" \ --sql "update mytable set quantity=5 where id=201" \ --transaction-id "ABC1234567890xyz" ``` Resultado: ``` { "numberOfRecordsUpdated": 1 } ``` **Exemplo 2: como executar uma instrução SQL com parâmetros** O exemplo de `execute-statement` a seguir executa uma instrução SQL com parâmetros. ``` aws rds-data execute-statement \ --resource-arn "arn:aws:rds:us-east-1:123456789012:cluster:mydbcluster" \ --database "mydb" \ --secret-arn "arn:aws:secretsmanager:us-east-1:123456789012:secret:mysecret" \ --sql "insert into mytable values (:id, :val)" \ --parameters "[{\"name\": \"id\", \"value\": {\"longValue\": 1}},{\"name\": \"val\", \"value\": {\"stringValue\": \"value1\"}}]" ``` Resultado: ``` { "numberOfRecordsUpdated": 1 } ``` Para obter mais informações, consulte [Using the Data API for Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) no *Guia do usuário do Amazon RDS*. + Consulte detalhes da API em [ExecuteStatement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds-data/execute-statement.html) na *Referência de comandos da AWS CLI*. ### `rollback-transaction` O código de exemplo a seguir mostra como usar `rollback-transaction`. **AWS CLI** **Como reverter uma transação SQL** O exemplo `rollback-transaction` a seguir reverte a transação SQL especificada. ``` aws rds-data rollback-transaction \ --resource-arn "arn:aws:rds:us-west-2:123456789012:cluster:mydbcluster" \ --secret-arn "arn:aws:secretsmanager:us-west-2:123456789012:secret:mysecret" \ --transaction-id "ABC1234567890xyz" ``` Resultado: ``` { "transactionStatus": "Rollback Complete" } ``` Para obter mais informações, consulte [Using the Data API for Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) no *Guia do usuário do Amazon RDS*. + Para ver detalhes da API, consulte [RollbackTransaction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds-data/rollback-transaction.html) na *Referência de comandos da AWS CLI*. # Exemplos do Insights de Performance do Amazon RDS usando a AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o Insights de Performance do Amazon RDS. *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 ### `create-performance-analysis-report` O código de exemplo a seguir mostra como usar `create-performance-analysis-report`. **AWS CLI** **Como criar um relatório de análise de performance** O exemplo `create-performance-analysis-report` a seguir cria um relatório de análise de performance com o horário de início `1682969503` e o horário de término `1682979503` do banco de dados `db-abcdefg123456789`. ``` aws pi create-performance-analysis-report \ --service-type RDS \ --identifier db-abcdefg123456789 \ --start-time 1682969503 \ --end-time 1682979503 ``` Resultado: ``` { "AnalysisReportId": "report-0234d3ed98e28fb17" } ``` Para ter mais informações sobre como criar relatórios de análise de performance, consulte [Criar um relatório de análise de performance no Insights de Performance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.CreatingPerfAnlysisReport.html) no *Guia do usuário do Amazon RDS* e [Criar um relatório de análise de performance no Insights de Performance](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.UsingDashboard.CreatingPerfAnlysisReport.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [CreatePerformanceAnalysisReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/create-performance-analysis-report.html) na *Referência de comandos da AWS CLI*. ### `delete-performance-analysis-report` O código de exemplo a seguir mostra como usar `delete-performance-analysis-report`. **AWS CLI** **Como excluir um relatório de análise de performance** O exemplo `delete-performance-analysis-report` a seguir exclui o relatório de análise de performance com o ID de relatório `report-0d99cc91c4422ee61`. ``` aws pi delete-performance-analysis-report \ --service-type RDS \ --identifier db-abcdefg123456789 \ --analysis-report-id report-0d99cc91c4422ee61 ``` Este comando não produz saída. Para ter mais informações sobre como excluir relatórios de análise de performance, consulte [Excluir um relatório de análise de performance no Insights de Performance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.DeletePerfAnalysisReport.html) no *Guia do usuário do Amazon RDS* e [Excluir um relatório de análise de performance no Insights de Performance](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.UsingDashboard.DeletePerfAnalysisReport.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DeletePerformanceAnalysisReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/delete-performance-analysis-report.html) na *Referência de comandos da AWS CLI*. ### `describe-dimension-keys` O código de exemplo a seguir mostra como usar `describe-dimension-keys`. **AWS CLI** **Exemplo 1: descrever chaves de dimensão** Este exemplo solicita os nomes de todos os eventos de espera. Os dados são organizados pelo nome do evento e pelos valores agregados desses eventos durante o período especificado. Comando: ``` aws pi describe-dimension-keys --service-type RDS --identifier db-LKCGOBK26374TPTDFXOIWVCPPM --start-time 1527026400 --end-time 1527080400 --metric db.load.avg --group-by '{"Group":"db.wait_event"}' ``` Resultado: ``` { "AlignedEndTime": 1.5270804E9, "AlignedStartTime": 1.5270264E9, "Keys": [ { "Dimensions": {"db.wait_event.name": "wait/synch/mutex/innodb/aurora_lock_thread_slot_futex"}, "Total": 0.05906906851195666 }, { "Dimensions": {"db.wait_event.name": "wait/io/aurora_redo_log_flush"}, "Total": 0.015824722186149193 }, { "Dimensions": {"db.wait_event.name": "CPU"}, "Total": 0.008014396230265477 }, { "Dimensions": {"db.wait_event.name": "wait/io/aurora_respond_to_client"}, "Total": 0.0036361612526204477 }, { "Dimensions": {"db.wait_event.name": "wait/io/table/sql/handler"}, "Total": 0.0019108398419382965 }, { "Dimensions": {"db.wait_event.name": "wait/synch/cond/mysys/my_thread_var::suspend"}, "Total": 8.533847837782684E-4 }, { "Dimensions": {"db.wait_event.name": "wait/io/file/csv/data"}, "Total": 6.864181956477376E-4 }, { "Dimensions": {"db.wait_event.name": "Unknown"}, "Total": 3.895887056379051E-4 }, { "Dimensions": {"db.wait_event.name": "wait/synch/mutex/sql/FILE_AS_TABLE::LOCK_shim_lists"}, "Total": 3.710368625122906E-5 }, { "Dimensions": {"db.wait_event.name": "wait/lock/table/sql/handler"}, "Total": 0 } ] } ``` **Exemplo 2: encontrar o ID SQL das instruções que mais contribuem para a carga do banco de dados** O `describe-dimension-keys` a seguir solicita a instrução SQL e o ID SQL para as dez instruções que mais contribuíram para a carga do banco de dados. ``` aws pi describe-dimension-keys \ --service-type RDS \ --identifier db-abcdefg123456789 \ --start-time 2023-05-01T00:00:00Z \ --end-time 2023-05-01T01:00:00Z \ --metric db.load.avg \ --group-by '{"Group": "db.sql", "Dimensions": ["db.sql.id", "db.sql.statement"],"Limit": 10}' ``` Resultado: ``` { "AlignedEndTime": 1.5270804E9, "AlignedStartTime": 1.5270264E9, "Identifier": "db-abcdefg123456789", "MetricList": [ { "Keys": [ { "Dimensions": {"db.sql.id": "AKIAIOSFODNN7EXAMPLE", "db.sql.statement": "SELECT * FROM customers WHERE customer_id = 123"}, "Total": 25.5,"Partitions": [12.3, 13.2] } ] } ] } ``` Para ter mais informações sobre carga de banco de dados, consulte [Carga de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.Overview.ActiveSessions.html) no *Guia do usuário do Amazon RDS* ou [Carga de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.Overview.ActiveSessions.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [DescribeDimensionKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/describe-dimension-keys.html) na *Referência de comandos da AWS CLI*. ### `get-dimension-key-details` O código de exemplo a seguir mostra como usar `get-dimension-key-details`. **AWS CLI** **Como obter detalhes de um grupo de dimensões especificado para uma instância de banco de dados** O exemplo `get-dimension-key-details` a seguir recupera o texto completo de uma instrução SQL para a instância de banco de dados `db-10BCD2EFGHIJ3KL4M5NO6PQRS5`. O `--group` é `db.sql`, e o `--group-identifier` é `db.sql.id`. Neste exemplo, `example-sql-id` representa um ID SQL recuperado usando as operações `get-resource-metrics` ou `describe-dimension-keys`. Nesse exemplo, os detalhes das dimensões estão disponíveis. Assim, o Performance Insights recupera o texto completo da instrução SQL, sem truncá-lo. ``` aws pi get-dimension-key-details \ --service-type RDS \ --identifier db-10BCD2EFGHIJ3KL4M5NO6PQRS5 \ --group db.sql \ --group-identifier example-sql-id \ --requested-dimensions statement ``` Resultado: ``` { "Dimensions":[ { "Value": "SELECT e.last_name, d.department_name FROM employees e, departments d WHERE e.department_id=d.department_id", "Dimension": "db.sql.statement", "Status": "AVAILABLE" }, ... ] } ``` Para ter mais informações sobre carga de banco de dados, consulte [Carga de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.Overview.ActiveSessions.html) no *Guia do usuário do Amazon RDS* ou [Carga de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.Overview.ActiveSessions.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [GetDimensionKeyDetails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/get-dimension-key-details.html) na *Referência de comandos da AWS CLI*. ### `get-performance-analysis-report` O código de exemplo a seguir mostra como usar `get-performance-analysis-report`. **AWS CLI** **Como visualizar um relatório de análise de performance** O exemplo `get-performance-analysis-report` a seguir obtém o relatório de análise de performance para o banco de dados `db-abcdefg123456789` com o ID de relatório `report-0d99cc91c4422ee61`. A resposta fornece o status, o ID, os detalhes do horário e os insights do relatório. ``` aws pi get-performance-analysis-report \ --service-type RDS \ --identifier db-abcdefg123456789 \ --analysis-report-id report-0d99cc91c4422ee61 ``` Resultado: ``` { "AnalysisReport": { "Status": "Succeeded", "ServiceType": "RDS", "Identifier": "db-abcdefg123456789", "StartTime": 1680583486.584, "AnalysisReportId": "report-0d99cc91c4422ee61", "EndTime": 1680587086.584, "CreateTime": 1680587087.139, "Insights": [ ... (Condensed for space) ] } } ``` Para ter mais informações sobre relatórios de análise de performance, consulte [Analisar a performance do banco de dados por um período](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.AnalyzePerformanceTimePeriod.html) no *Guia do usuário do Amazon RDS* e [Analisar a performance do banco de dados por um período](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.UsingDashboard.AnalyzePerformanceTimePeriod.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [GetPerformanceAnalysisReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/get-performance-analysis-report.html) na *Referência de comandos da AWS CLI*. ### `get-resource-metadata` O código de exemplo a seguir mostra como usar `get-resource-metadata`. **AWS CLI** **Como obter metadados de recursos para um banco de dados** O exemplo `get-resource-metadata` a seguir obtém os metadados do recurso para o banco de dados `db-abcdefg123456789`. A resposta mostra que as estatísticas de resumo do SQL estão habilitadas. ``` aws pi get-resource-metadata \ --service-type RDS \ --identifier db-abcdefg123456789 ``` Resultado: ``` { "Identifier": "db-abcdefg123456789", "Features":{ "SQL_DIGEST_STATISTICS":{ "Status": "ENABLED" } } } ``` Para ter mais informações sobre estatísticas SQL para o Performance Insights, consulte [Estatísticas SQL para Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/sql-statistics.html) no *Guia do usuário do Amazon RDS* e [Estatísticas SQL para Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/sql-statistics.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [GetResourceMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/get-resource-metadata.html) na *Referência de comandos da AWS CLI*. ### `get-resource-metrics` O código de exemplo a seguir mostra como usar `get-resource-metrics`. **AWS CLI** **Para obter métricas de recursos** Este exemplo solicita pontos de dados para o grupo de dimensões *db.wait\$1event* e para a dimensão *db.wait\$1event.name* dentro desse grupo. Na resposta, os pontos de dados relevantes são agrupados pela dimensão solicitada (*db.wait\$1event.name*). Comando: ``` aws pi get-resource-metrics --service-type RDS --identifier db-LKCGOBK26374TPTDFXOIWVCPPM --start-time 1527026400 --end-time 1527080400 --period-in-seconds 300 --metric db.load.avg --metric-queries file://metric-queries.json ``` Os argumentos para `--metric-queries` são armazenados no arquivo JSON chamado `metric-queries.json`. Veja o conteúdo desse arquivo: ``` [ { "Metric": "db.load.avg", "GroupBy": { "Group":"db.wait_event" } } ] ``` Resultado: ``` { "AlignedEndTime": 1.5270804E9, "AlignedStartTime": 1.5270264E9, "Identifier": "db-LKCGOBK26374TPTDFXOIWVCPPM", "MetricList": [ { "Key": { "Metric": "db.load.avg" }, "DataPoints": [ { "Timestamp": 1527026700.0, "Value": 1.3533333333333333 }, { "Timestamp": 1527027000.0, "Value": 0.88 }, <...remaining output omitted...> ] }, { "Key": { "Metric": "db.load.avg", "Dimensions": { "db.wait_event.name": "wait/synch/mutex/innodb/aurora_lock_thread_slot_futex" } }, "DataPoints": [ { "Timestamp": 1527026700.0, "Value": 0.8566666666666667 }, { "Timestamp": 1527027000.0, "Value": 0.8633333333333333 }, <...remaining output omitted...> ], }, <...remaining output omitted...> ] } ``` + Para ver detalhes da API, consulte [GetResourceMetrics](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/get-resource-metrics.html) na *Referência de comandos da AWS CLI*. ### `list-available-resource-dimensions` O código de exemplo a seguir mostra como usar `list-available-resource-dimensions`. **AWS CLI** **Como listar as dimensões que podem ser consultadas para um tipo de métrica em uma instância de banco de dados** O exemplo `list-available-resource-dimensions` a seguir lista as métricas `db.load` que você pode consultar para o banco de dados `db-abcdefg123456789`. ``` aws pi list-available-resource-dimensions \ --service-type RDS \ --identifier db-abcdefg123456789 \ --metrics db.load ``` Resultado: ``` { "MetricDimensions": [ { "Metric": "db.load", "Groups": [ { "Group": "db.user", "Dimensions": [ { "Identifier": "db.user.id" }, { "Identifier": "db.user.name" } ] }, { "Group": "db.sql_tokenized", "Dimensions": [ { "Identifier": "db.sql_tokenized.id" }, { "Identifier": "db.sql_tokenized.db_id" }, { "Identifier": "db.sql_tokenized.statement" } ] }, ... ] } ] } ``` Para ter mais informações sobre carga de banco de dados, consulte [Carga de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.Overview.ActiveSessions.html) no *Guia do usuário do Amazon RDS* ou [Carga de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.Overview.ActiveSessions.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [ListAvailableResourceDimensions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/list-available-resource-dimensions.html) na *Referência de comandos da AWS CLI*. ### `list-available-resource-metrics` O código de exemplo a seguir mostra como usar `list-available-resource-metrics`. **AWS CLI** **Como listar as métricas que podem ser consultadas para um tipo de métrica em uma instância de banco de dados** O exemplo `list-available-resource-metrics` a seguir lista as métricas `db.load` que você pode consultar para o banco de dados `db-abcdefg123456789`. ``` aws pi list-available-resource-metrics \ --service-type RDS \ --identifier db-abcdefg123456789 \ --metric-types "os" "db" ``` Resultado: ``` { "Metrics": [ { "Description": "The number of virtual CPUs for the DB instance", "Metric": "os.general.numVCPUs", "Unit": "vCPUs" }, ......, { "Description": "Time spent reading data file blocks by backends in this instance", "Metric": "db.IO.read_latency", "Unit": "Milliseconds per block" }, ...... ] } ``` Para ter mais informações sobre métricas no Insights de Performance, consulte [Carga de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.Overview.ActiveSessions.html) no *Guia do usuário do Amazon RDS* ou [Carga de banco de dados](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.Overview.ActiveSessions.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [ListAvailableResourceMetrics](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/list-available-resource-metrics.html) na *Referência de comandos da AWS CLI*. ### `list-performance-analysis-reports` O código de exemplo a seguir mostra como usar `list-performance-analysis-reports`. **AWS CLI** **Como listar relatórios de análise de performance para um banco de dados** O exemplo `list-performance-analysis-reports` a seguir lista todos os relatórios de análise de performance disponíveis para o banco de dados `db-abcdefg123456789`. A resposta lista todos os relatórios com o ID do relatório, o status e os detalhes do período. ``` aws pi list-performance-analysis-reports \ --service-type RDS \ --identifier db-abcdefg123456789 ``` Resultado: ``` { "AnalysisReports": [ { "Status": "Succeeded", "EndTime": 1680587086.584, "CreateTime": 1680587087.139, "StartTime": 1680583486.584, "AnalysisReportId": "report-0d99cc91c4422ee61" }, { "Status": "Succeeded", "EndTime": 1681491137.914, "CreateTime": 1681491145.973, "StartTime": 1681487537.914, "AnalysisReportId": "report-002633115cc002233" }, { "Status": "Succeeded", "EndTime": 1681493499.849, "CreateTime": 1681493507.762, "StartTime": 1681489899.849, "AnalysisReportId": "report-043b1e006b47246f9" }, { "Status": "InProgress", "EndTime": 1682979503.0, "CreateTime": 1682979618.994, "StartTime": 1682969503.0, "AnalysisReportId": "report-01ad15f9b88bcbd56" } ] } ``` Para ter mais informações sobre relatórios de análise de performance, consulte [Analisar a performance do banco de dados por um período](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.AnalyzePerformanceTimePeriod.html) no *Guia do usuário do Amazon RDS* e [Analisar a performance do banco de dados por um período](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.UsingDashboard.AnalyzePerformanceTimePeriod.html) no *Guia do usuário do Amazon Aurora*. + Para ver detalhes da API, consulte [ListPerformanceAnalysisReports](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/list-performance-analysis-reports.html) na *Referência de comandos da AWS CLI*. ### `list-tags-for-resource` O código de exemplo a seguir mostra como usar `list-tags-for-resource`. **AWS CLI** **Como listar tags para um relatório de análise de performance** O exemplo `list-tags-for-resource` a seguir lista as tags para um relatório de análise de performance com o ID de relatório `report-0d99cc91c4422ee61`. ``` aws pi list-tags-for-resource \ --service-type RDS \ --resource-arn arn:aws:pi:us-west-2:123456789012:perf-reports/RDS/db-abcdefg123456789/report-0d99cc91c4422ee61 ``` Resultado: ``` { "Tags": [ { "Value": "test-tag", "Key": "name" } ] } ``` Para ter mais informações sobre como marcar relatórios de análise de performance, consulte [Adicionar tags a um relatório de análise de performance no Insights de Performance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.ManagePerfAnalysisReportTags.html) no *Guia do usuário do Amazon RDS* e [Adicionar tags a um relatório de análise de performance no Insights de Performance](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.UsingDashboard.ManagePerfAnalysisReportTags.html) no *Guia do usuário do Amazon Aurora*. + Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/list-tags-for-resource.html) na *AWS CLI Command Reference*. ### `tag-resource` O código de exemplo a seguir mostra como usar `tag-resource`. **AWS CLI** **Como adicionar tags a um relatório de análise de performance** O exemplo `tag-resource` a seguir adiciona a chave de tag `name` com o valor de tag `test-tag` a um relatório de análise de performance com o ID de relatório `report-0d99cc91c4422ee61`. ``` aws pi tag-resource \ --service-type RDS \ --resource-arn arn:aws:pi:us-west-2:123456789012:perf-reports/RDS/db-abcdefg123456789/report-0d99cc91c4422ee61 \ --tags Key=name,Value=test-tag ``` Este comando não produz saída. Para ter mais informações sobre como marcar relatórios de análise de performance, consulte [Adicionar tags a um relatório de análise de performance no Insights de Performance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.ManagePerfAnalysisReportTags.html) no *Guia do usuário do Amazon RDS* e [Adicionar tags a um relatório de análise de performance no Insights de Performance](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.UsingDashboard.ManagePerfAnalysisReportTags.html) no *Guia do usuário do Amazon Aurora*. + Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/tag-resource.html) na *Referência de comandos da AWS CLI*. ### `untag-resource` O código de exemplo a seguir mostra como usar `untag-resource`. **AWS CLI** **Como excluir tags a um relatório de análise de performance** O exemplo `untag-resource` a seguir exclui a tag `name` de um relatório de análise de performance com o ID de relatório `report-0d99cc91c4422ee61`. ``` aws pi untag-resource \ --service-type RDS \ --resource-arn arn:aws:pi:us-west-2:123456789012:perf-reports/RDS/db-abcdefg123456789/report-0d99cc91c4422ee61 \ --tag-keys name ``` Este comando não produz saída. Para ter mais informações sobre como marcar relatórios de análise de performance, consulte [Adicionar tags a um relatório de análise de performance no Insights de Performance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.ManagePerfAnalysisReportTags.html) no *Guia do usuário do Amazon RDS* e [Adicionar tags a um relatório de análise de performance no Insights de Performance](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.UsingDashboard.ManagePerfAnalysisReportTags.html) no *Guia do usuário do Amazon Aurora*. + Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/untag-resource.html) na *Referência de comandos da AWS CLI*. # Exemplos do Amazon Redshift com o uso da AWS CLI Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Amazon Redshift. *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 ### `accept-reserved-node-exchange` O código de exemplo a seguir mostra como usar `accept-reserved-node-exchange`. **AWS CLI** **Para aceitar a troca de nós reservados** O exemplo `accept-reserved-node-exchange` a seguir aceita a troca de um nó reservado DC1 por um nó reservado DC2. ``` aws redshift accept-reserved-node-exchange / --reserved-node-id 12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE / --target-reserved-node-offering-id 12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE ``` Resultado: ``` { "ExchangedReservedNode": { "ReservedNodeId": "12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE", "ReservedNodeOfferingId": "12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE", "NodeType": "dc2.large", "StartTime": "2019-12-06T21:17:26Z", "Duration": 31536000, "FixedPrice": 0.0, "UsagePrice": 0.0, "CurrencyCode": "USD", "NodeCount": 1, "State": "exchanging", "OfferingType": "All Upfront", "RecurringCharges": [ { "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" } ], "ReservedNodeOfferingType": "Regular" } } ``` Para obter mais informações, consulte [Atualizar nós reservados com a AWS CLI](https://docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-offering-console.html) no *Guia de gerenciamento de clusters do Amazon Redshift*. + Para ver detalhes da API, consulte [AcceptReservedNodeExchange](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/accept-reserved-node-exchange.html) na *Referência de comandos da AWS CLI*. ### `authorize-cluster-security-group-ingress` O código de exemplo a seguir mostra como usar `authorize-cluster-security-group-ingress`. **AWS CLI** Como autorizar o acesso a um grupo de segurança do EC2. Este exemplo autoriza o acesso a um grupo de segurança nomeado do Amazon EC2. Comando: ``` aws redshift authorize-cluster-security-group-ingress --cluster-security-group-name mysecuritygroup --ec2-security-group-name myec2securitygroup --ec2-security-group-owner-id 123445677890 ``` Como autorizar o acesso a um intervalo CIDR. Este exemplo autoriza o acesso a um intervalo CIDR. Comando: ``` aws redshift authorize-cluster-security-group-ingress --cluster-security-group-name mysecuritygroup --cidrip 192.168.100.100/32 ``` + Para ver detalhes da API, consulte [AuthorizeClusterSecurityGroupIngress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/authorize-cluster-security-group-ingress.html) na *Referência de comandos da AWS CLI*. ### `authorize-snapshot-access` O código de exemplo a seguir mostra como usar `authorize-snapshot-access`. **AWS CLI** Autorizar uma AWS conta a restaurar um snapshot. Este exemplo autoriza a AWS conta `444455556666` a restaurar o snapshot `my-snapshot-id`. Por padrão, o formato da saída é JSON. Comando: ``` aws redshift authorize-snapshot-access --snapshot-id my-snapshot-id --account-with-restore-access 444455556666 ``` Resultado: ``` { "Snapshot": { "Status": "available", "SnapshotCreateTime": "2013-07-17T22:04:18.947Z", "EstimatedSecondsToCompletion": 0, "AvailabilityZone": "us-east-1a", "ClusterVersion": "1.0", "MasterUsername": "adminuser", "Encrypted": false, "OwnerAccount": "111122223333", "BackupProgressInMegabytes": 11.0, "ElapsedTimeInSeconds": 0, "DBName": "dev", "CurrentBackupRateInMegabytesPerSecond: 0.1534, "ClusterCreateTime": "2013-01-22T21:59:29.559Z", "ActualIncrementalBackupSizeInMegabytes"; 11.0, "SnapshotType": "manual", "NodeType": "dw.hs1.xlarge", "ClusterIdentifier": "mycluster", "TotalBackupSizeInMegabytes": 20.0, "Port": 5439, "NumberOfNodes": 2, "SnapshotIdentifier": "my-snapshot-id" } } ``` + Para ver detalhes da API, consulte [AuthorizeSnapshotAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/authorize-snapshot-access.html) na *Referência de comandos da AWS CLI*. ### `batch-delete-cluster-snapshots` O código de exemplo a seguir mostra como usar `batch-delete-cluster-snapshots`. **AWS CLI** **Para excluir um conjunto de snapshots do cluster** O exemplo `batch-delete-cluster-snapshots` a seguir exclui um conjunto de snapshots manuais do cluster. ``` aws redshift batch-delete-cluster-snapshots \ --identifiers SnapshotIdentifier=mycluster-2019-11-06-14-12 SnapshotIdentifier=mycluster-2019-11-06-14-20 ``` Resultado: ``` { "Resources": [ "mycluster-2019-11-06-14-12", "mycluster-2019-11-06-14-20" ] } ``` Para obter mais informações, consulte [Snapshots do Amazon Redshift](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html) no *Guia de gerenciamento de clusters do Amazon Redshift*. + Para ver detalhes da API, consulte [BatchDeleteClusterSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/batch-delete-cluster-snapshots.html) na *Referência de comandos da AWS CLI*. ### `batch-modify-cluster-snapshots` O código de exemplo a seguir mostra como usar `batch-modify-cluster-snapshots`. **AWS CLI** **Para modificar um conjunto de snapshots do cluster** O exemplo `batch-modify-cluster-snapshots` a seguir modifica as configurações de um conjunto de snapshots do cluster. ``` aws redshift batch-modify-cluster-snapshots \ --snapshot-identifier-list mycluster-2019-11-06-16-31 mycluster-2019-11-06-16-32 \ --manual-snapshot-retention-period 30 ``` Resultado: ``` { "Resources": [ "mycluster-2019-11-06-16-31", "mycluster-2019-11-06-16-32" ], "Errors": [], "ResponseMetadata": { "RequestId": "12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE", "HTTPStatusCode": 200, "HTTPHeaders": { "x-amzn-requestid": "12345678-12ab-12a1-1a2a-12ab-12a12EXAMPLE, "content-type": "text/xml", "content-length": "480", "date": "Sat, 07 Dec 2019 00:36:09 GMT", "connection": "keep-alive" }, "RetryAttempts": 0 } } ``` Para obter mais informações, consulte [Snapshots do Amazon Redshift](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html) no *Guia de gerenciamento de clusters do Amazon Redshift*. + Para ver detalhes da API, consulte [BatchModifyClusterSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/batch-modify-cluster-snapshots.html) na *Referência de comandos da AWS CLI*. ### `cancel-resize` O código de exemplo a seguir mostra como usar `cancel-resize`. **AWS CLI** **Para cancelar o redimensionamento de um cluster** O exemplo `cancel-resize` a seguir cancela uma operação de redimensionamento clássica para um cluster. ``` aws redshift cancel-resize \ --cluster-identifier mycluster ``` Resultado: ``` { "TargetNodeType": "dc2.large", "TargetNumberOfNodes": 2, "TargetClusterType": "multi-node", "Status": "CANCELLING", "ResizeType": "ClassicResize", "TargetEncryptionType": "NONE" } ``` Para obter mais informações, consulte [Redimensionar clusters do Amazon Redshift](https://docs.aws.amazon.com/redshift/latest/mgmt/rs-resize-tutorial.html) no *Guia de gerenciamento de clusters do Amazon Redshift*. + Para ver detalhes da API, consulte [CancelResize](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/cancel-resize.html) na *Referência de comandos da AWS CLI*. ### `copy-cluster-snapshot` O código de exemplo a seguir mostra como usar `copy-cluster-snapshot`. **AWS CLI** Obter uma descrição de todas as versões do cluster. Este exemplo retorna uma descrição de todas as versões do cluster. Por padrão, o formato da saída é JSON. Comando: ``` aws redshift copy-cluster-snapshot --source-snapshot-identifier cm:examplecluster-2013-01-22-19-27-58 --target-snapshot-identifier my-saved-snapshot-copy ``` Resultado: ``` { "Snapshot": { "Status": "available", "SnapshotCreateTime": "2013-01-22T19:27:58.931Z", "AvailabilityZone": "us-east-1c", "ClusterVersion": "1.0", "MasterUsername": "adminuser", "DBName": "dev", "ClusterCreateTime": "2013-01-22T19:23:59.368Z", "SnapshotType": "manual", "NodeType": "dw.hs1.xlarge", "ClusterIdentifier": "examplecluster", "Port": 5439, "NumberOfNodes": "2", "SnapshotIdentifier": "my-saved-snapshot-copy" }, "ResponseMetadata": { "RequestId": "3b279691-64e3-11e2-bec0-17624ad140dd" } } ``` + Para ver detalhes da API, consulte [CopyClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/copy-cluster-snapshot.html) na *Referência de comandos da AWS CLI*. ### `create-cluster-parameter-group` O código de exemplo a seguir mostra como usar `create-cluster-parameter-group`. **AWS CLI** Criar um grupo de parâmetros de cluster. Este exemplo cria um novo grupo de parâmetros de cluster. Comando: ``` aws redshift create-cluster-parameter-group --parameter-group-name myclusterparametergroup --parameter-group-family redshift-1.0 --description "My first cluster parameter group" ``` Resultado: ``` { "ClusterParameterGroup": { "ParameterGroupFamily": "redshift-1.0", "Description": "My first cluster parameter group", "ParameterGroupName": "myclusterparametergroup" }, "ResponseMetadata": { "RequestId": "739448f0-64cc-11e2-8f7d-3b939af52818" } } ``` + Para ver detalhes da API, consulte [CreateClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-cluster-parameter-group.html) na *Referência de comandos da AWS CLI*. ### `create-cluster-security-group` O código de exemplo a seguir mostra como usar `create-cluster-security-group`. **AWS CLI** Para criar um grupo de segurança do cluster. Este exemplo cria um novo grupo de segurança do cluster. Por padrão, o formato da saída é JSON. Comando: ``` aws redshift create-cluster-security-group --cluster-security-group-name mysecuritygroup --description "This is my cluster security group" ``` Resultado: ``` { "create_cluster_security_group_response": { "create_cluster_security_group_result": { "cluster_security_group": { "description": "This is my cluster security group", "owner_id": "300454760768", "cluster_security_group_name": "mysecuritygroup", "ec2_security_groups": \[], "ip_ranges": \[] } }, "response_metadata": { "request_id": "5df486a0-343a-11e2-b0d8-d15d0ef48549" } } } ``` Você pode obter as mesmas informações em formato de texto com a opção `--output text`. Comando: opção `--output text`. Comando: opção. Comando: ``` aws redshift create-cluster-security-group --cluster-security-group-name mysecuritygroup --description "This is my cluster security group" --output text ``` Resultado: ``` This is my cluster security group 300454760768 mysecuritygroup a0c0bfab-343a-11e2-95d2-c3dc9fe8ab57 ``` + Para ver detalhes da API, consulte [CreateClusterSecurityGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-cluster-security-group.html) na *Referência de comandos da AWS CLI*. ### `create-cluster-snapshot` O código de exemplo a seguir mostra como usar `create-cluster-snapshot`. **AWS CLI** Criar um snapshot do cluster. Este exemplo cria um novo snapshot do cluster. Por padrão, o formato da saída é JSON. Comando: ``` aws redshift create-cluster-snapshot --cluster-identifier mycluster --snapshot-identifier my-snapshot-id ``` Resultado: ``` { "Snapshot": { "Status": "creating", "SnapshotCreateTime": "2013-01-22T22:20:33.548Z", "AvailabilityZone": "us-east-1a", "ClusterVersion": "1.0", "MasterUsername": "adminuser", "DBName": "dev", "ClusterCreateTime": "2013-01-22T21:59:29.559Z", "SnapshotType": "manual", "NodeType": "dw.hs1.xlarge", "ClusterIdentifier": "mycluster", "Port": 5439, "NumberOfNodes": "2", "SnapshotIdentifier": "my-snapshot-id" }, "ResponseMetadata": { "RequestId": "f024d1a5-64e1-11e2-88c5-53eb05787dfb" } } ``` + Para ver detalhes da API, consulte [CreateClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-cluster-snapshot.html) na *Referência de comandos da AWS CLI*. ### `create-cluster-subnet-group` O código de exemplo a seguir mostra como usar `create-cluster-subnet-group`. **AWS CLI** Criar um grupo de sub-redes do cluster. Este exemplo cria um novo grupo de sub-redes do cluster. Comando: ``` aws redshift create-cluster-subnet-group --cluster-subnet-group-name mysubnetgroup --description "My subnet group" --subnet-ids subnet-763fdd1c ``` Resultado: ``` { "ClusterSubnetGroup": { "Subnets": [ { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-763fdd1c", "SubnetAvailabilityZone": { "Name": "us-east-1a" } } ], "VpcId": "vpc-7e3fdd14", "SubnetGroupStatus": "Complete", "Description": "My subnet group", "ClusterSubnetGroupName": "mysubnetgroup" }, "ResponseMetadata": { "RequestId": "500b8ce2-698f-11e2-9790-fd67517fb6fd" } } ``` + Para ver detalhes da API, consulte [CreateClusterSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-cluster-subnet-group.html) na *Referência de comandos da AWS CLI*. ### `create-cluster` O código de exemplo a seguir mostra como usar `create-cluster`. **AWS CLI** Criar um cluster com parâmetros mínimos Este exemplo cria um cluster com o conjunto mínimo de parâmetros. Por padrão, o formato da saída é JSON. Comando: ``` aws redshift create-cluster --node-type dw.hs1.xlarge --number-of-nodes 2 --master-username adminuser --master-user-password TopSecret1 --cluster-identifier mycluster ``` Resultado: ``` { "Cluster": { "NodeType": "dw.hs1.xlarge", "ClusterVersion": "1.0", "PubliclyAccessible": "true", "MasterUsername": "adminuser", "ClusterParameterGroups": [ { "ParameterApplyStatus": "in-sync", "ParameterGroupName": "default.redshift-1.0" } ], "ClusterSecurityGroups": [ { "Status": "active", "ClusterSecurityGroupName": "default" } ], "AllowVersionUpgrade": true, "VpcSecurityGroups": \[], "PreferredMaintenanceWindow": "sat:03:30-sat:04:00", "AutomatedSnapshotRetentionPeriod": 1, "ClusterStatus": "creating", "ClusterIdentifier": "mycluster", "DBName": "dev", "NumberOfNodes": 2, "PendingModifiedValues": { "MasterUserPassword": "\****" } }, "ResponseMetadata": { "RequestId": "7cf4bcfc-64dd-11e2-bea9-49e0ce183f07" } } ``` + Consulte detalhes da API em [CreateCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-cluster.html) na *Referência de comandos da AWS CLI*. ### `create-event-subscription` O código de exemplo a seguir mostra como usar `create-event-subscription`. **AWS CLI** **Para criar uma assinatura de notificação para um evento** O exemplo `create-event-subscription` a seguir cria uma assinatura de notificação de evento. ``` aws redshift create-event-subscription \ --subscription-name mysubscription \ --sns-topic-arn arn:aws:sns:us-west-2:123456789012:MySNStopic \ --source-type cluster \ --source-ids mycluster ``` Resultado: ``` { "EventSubscription": { "CustomerAwsId": "123456789012", "CustSubscriptionId": "mysubscription", "SnsTopicArn": "arn:aws:sns:us-west-2:123456789012:MySNStopic", "Status": "active", "SubscriptionCreationTime": "2019-12-09T20:05:19.365Z", "SourceType": "cluster", "SourceIdsList": [ "mycluster" ], "EventCategoriesList": [], "Severity": "INFO", "Enabled": true, "Tags": [] } } ``` Para obter mais informações, consulte [Como se inscrever nas notificações de eventos do Amazon Redshift](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-event-notifications.html) no *Guia de gerenciamento de clusters do Amazon Redshift*. + Para ver detalhes da API, consulte [CreateEventSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-event-subscription.html) na *Referência de comandos da AWS CLI*. ### `create-hsm-client-certificate` O código de exemplo a seguir mostra como usar `create-hsm-client-certificate`. **AWS CLI** **Para criar um certificado de cliente HSM** O exemplo `create-hsm-client-certificate` a seguir gera um certificado de cliente HSM usado por um cluster para se conectar a um HSM. ``` aws redshift create-hsm-client-certificate \ --hsm-client-certificate-identifier myhsmclientcert ``` Resultado: ``` { "HsmClientCertificate": { "HsmClientCertificateIdentifier": "myhsmclientcert", "HsmClientCertificatePublicKey": "-----BEGIN CERTIFICATE----- MIICiEXAMPLECQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC VVMxCzAJBgNVBAgTEXAMPLEwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 b24xFDASBgNVBAsTC0lBTSBDb25EXAMPLEIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb2EXAMPLETEwNDI1MjA0NTIxWhcN MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBEXAMPLEMRAwDgYD EXAMPLETZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z b2xlMRIwEAEXAMPLEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt YXpvbi5jb20wgZ8wDQYJKEXAMPLEAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk6EXAMPLE3G93vUEIO3IyNoH/f0wYK8m9T rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugEXAMPLEzZswY6786m86gpE Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEEXAMPLEEAtCu4 nUhVVxYUEXAMPLEh8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb FFBjvSfpJIlJ00zbhNYS5f6GEXAMPLEl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb NYiytVbZPQUQ5Yaxu2jXnimvw3rEXAMPLE=-----END CERTIFICATE-----\n", "Tags": [] } } ``` Para obter mais informações, consulte [Referência de permissões da API do Amazon Redshift](https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-policy-resources.resource-permissions.html) no *Guia de gerenciamento de clusters do Amazon Redshift*. + Para ver detalhes da API, consulte [CreateHsmClientCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-hsm-client-certificate.html) na *Referência de comandos da AWS CLI*. ### `create-hsm-configuration` O código de exemplo a seguir mostra como usar `create-hsm-configuration`. **AWS CLI** **Para criar uma configuração HSM** O exemplo `create-hsm-configuration` a seguir cria uma configuração do HSM que contém as informações necessárias para um cluster armazenar e usar chaves de criptografia de banco de dados em um módulo de segurança de hardware (HSM). ``` aws redshift create-hsm-configuration / --hsm-configuration-identifier myhsmconnection --description "My HSM connection" --hsm-ip-address 192.0.2.09 --hsm-partition-name myhsmpartition / --hsm-partition-password A1b2c3d4 / --hsm-server-public-certificate myhsmclientcert ``` Resultado: ``` { "HsmConfiguration": { "HsmConfigurationIdentifier": "myhsmconnection", "Description": "My HSM connection", "HsmIpAddress": "192.0.2.09", "HsmPartitionName": "myhsmpartition", "Tags": [] } } ``` + Para ver detalhes da API, consulte [CreateHsmConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-hsm-configuration.html) na *Referência de comandos da AWS CLI*. ### `create-snapshot-copy-grant` O código de exemplo a seguir mostra como usar `create-snapshot-copy-grant`. **AWS CLI** **Para criar uma concessão de cópia do snapshot** O exemplo `create-snapshot-copy-grant` a seguir cria uma concessão de cópia do snapshot e criptografa snapshots copiados em uma região de destino da AWS. ``` aws redshift create-snapshot-copy-grant \ --snapshot-copy-grant-name mysnapshotcopygrantname ``` Resultado: ``` { "SnapshotCopyGrant": { "SnapshotCopyGrantName": "mysnapshotcopygrantname", "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/bPxRfih3yCo8nvbEXAMPLEKEY", "Tags": [] } } ``` Para obter mais informações, consulte [Criptografia de banco de dados do Amazon Redshift](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html) no *Guia de gerenciamento de clusters do Amazon Redshift*. + Para ver detalhes da API, consulte [CreateSnapshotCopyGrant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-snapshot-copy-grant.html) na *Referência de comandos da AWS CLI*. ### `create-snapshot-schedule` O código de exemplo a seguir mostra como usar `create-snapshot-schedule`. **AWS CLI** **Para criar uma programação de snapshot** O exemplo `create-snapshot-schedule` a seguir cria uma programação de snapshot com a descrição especificada e uma taxa a cada 12 horas. ``` aws redshift create-snapshot-schedule \ --schedule-definitions "rate(12 hours)" \ --schedule-identifier mysnapshotschedule \ --schedule-description "My schedule description" ``` Resultado: ``` { "ScheduleDefinitions": [ "rate(12 hours)" ], "ScheduleIdentifier": "mysnapshotschedule", "ScheduleDescription": "My schedule description", "Tags": [] } ``` Para obter mais informações, consulte [Programações de snapshot automáticas](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html#automated-snapshot-schedules) no *Guia de gerenciamento de clusters do Amazon Redshift*. + Para ver detalhes da API, consulte [CreateSnapshotSchedule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-snapshot-schedule.html) na *Referência de comandos da AWS CLI*. ### `create-tags` O código de exemplo a seguir mostra como usar `create-tags`. **AWS CLI** **Para criar tags para um cluster** O exemplo `create-tags` a seguir adiciona o par chave/valor da tag especificado ao cluster especificado. ``` aws redshift create-tags \ --resource-name arn:aws:redshift:us-west-2:123456789012:cluster:mycluster \ --tags "Key"="mytags","Value"="tag1" ``` Esse comando não produz nenhuma saída. Para obter mais informações, consulte [Marcação de recursos no Amazon Redshift](https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-tagging.html) no *Guia de gerenciamento de clusters do Amazon Redshift*. + Consulte detalhes da API em [CreateTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-tags.html) na *Referência de comandos da AWS CLI*. ### `delete-cluster-parameter-group` O código de exemplo a seguir mostra como usar `delete-cluster-parameter-group`. **AWS CLI** Excluir um grupo de parâmetros de cluster. Este exemplo exclui um grupo de parâmetros de cluster. Comando: ``` aws redshift delete-cluster-parameter-group --parameter-group-name myclusterparametergroup ``` + Para ver detalhes da API, consulte [DeleteClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-cluster-parameter-group.html) na *Referência de comandos da AWS CLI*. ### `delete-cluster-security-group` O código de exemplo a seguir mostra como usar `delete-cluster-security-group`. **AWS CLI** Excluir um grupo de segurança do cluster. Este exemplo exclui um grupo de segurança do cluster. Comando: ``` aws redshift delete-cluster-security-group --cluster-security-group-name mysecuritygroup ``` + Para ver detalhes da API, consulte [DeleteClusterSecurityGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-cluster-security-group.html) na *Referência de comandos da AWS CLI*. ### `delete-cluster-snapshot` O código de exemplo a seguir mostra como usar `delete-cluster-snapshot`. **AWS CLI** Excluir um snapshot do cluster. Este exemplo exclui um snapshot do cluster. Comando: ``` aws redshift delete-cluster-snapshot --snapshot-identifier my-snapshot-id ``` + Para ver detalhes da API, consulte [DeleteClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-cluster-snapshot.html) na *Referência de comandos da AWS CLI*. ### `delete-cluster-subnet-group` O código de exemplo a seguir mostra como usar `delete-cluster-subnet-group`. **AWS CLI** Excluir um grupo de sub-redes do cluster. Este exemplo exclui um grupo de sub-redes do cluster. Comando: ``` aws redshift delete-cluster-subnet-group --cluster-subnet-group-name mysubnetgroup ``` Resultado: ``` { "ResponseMetadata": { "RequestId": "253fbffd-6993-11e2-bc3a-47431073908a" } } ``` + Para ver detalhes da API, consulte [DeleteClusterSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-cluster-subnet-group.html) na *Referência de comandos da AWS CLI*. ### `delete-cluster` O código de exemplo a seguir mostra como usar `delete-cluster`. **AWS CLI** Excluir um cluster sem um snapshot final do cluster Este exemplo exclui um cluster, forçando a exclusão de dados, para que nenhum snapshot final do cluster seja criado. Comando: ``` aws redshift delete-cluster --cluster-identifier mycluster --skip-final-cluster-snapshot ``` Excluir um cluster, permitindo a criação de um snapshot final do cluster Este exemplo exclui um cluster, mas especifica o snapshot final do cluster. Comando: ``` aws redshift delete-cluster --cluster-identifier mycluster --final-cluster-snapshot-identifier myfinalsnapshot ``` + Consulte detalhes da API em [DeleteCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-cluster.html) na *Referência de comandos da AWS CLI*. ### `delete-event-subscription` O código de exemplo a seguir mostra como usar `delete-event-subscription`. **AWS CLI** **Para excluir a assinatura de evento** O exemplo `delete-event-subscription` a seguir exclui a assinatura de notificação de evento especificada. ``` aws redshift delete-event-subscription \ --subscription-name mysubscription ``` Esse comando não produz nenhuma saída. Para obter mais informações, consulte [Como se inscrever nas notificações de eventos do Amazon Redshift](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-event-notifications.html) no *Guia de gerenciamento de clusters do Amazon Redshift*. + Para ver detalhes da API, consulte [DeleteEventSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-event-subscription.html) na *Referência de comandos da AWS CLI*. ### `delete-hsm-client-certificate` O código de exemplo a seguir mostra como usar `delete-hsm-client-certificate`. **AWS CLI** **Para excluir o certificado do cliente HSM** O exemplo `delete-hsm-client-certificate` a seguir exclui um certificado de cliente HSM. ``` aws redshift delete-hsm-client-certificate \ --hsm-client-certificate-identifier myhsmclientcert ``` Esse comando não produz nenhuma saída. Para obter mais informações, consulte [Referência de permissões da API do Amazon Redshift](https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-policy-resources.resource-permissions.html) no *Guia de gerenciamento de clusters do Amazon Redshift*. + Para ver detalhes da API, consulte [DeleteHsmClientCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-hsm-client-certificate.html) na *Referência de comandos da AWS CLI*. ### `delete-hsm-configuration` O código de exemplo a seguir mostra como usar `delete-hsm-configuration`. **AWS CLI** **Para excluir uma configuração HSM** O exemplo `delete-hsm-configuration` a seguir exclui a configuração HSM especificada da conta atual da AWS. ``` aws redshift delete-hsm-configuration / --hsm-configuration-identifier myhsmconnection ``` Esse comando não produz nenhuma saída. + Para ver detalhes da API, consulte [DeleteHsmConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-hsm-configuration.html) na *Referência de comandos da AWS CLI*. ### `delete-scheduled-action` O código de exemplo a seguir mostra como usar `delete-scheduled-action`. **AWS CLI** **Para excluir uma ação programada** O exemplo `delete-scheduled-action` a seguir exclui uma ação programada específica. ``` aws redshift delete-scheduled-action \ --scheduled-action-name myscheduledaction ``` Esse comando não produz nenhuma saída. + Para ver detalhes da API, consulte [DeleteScheduledAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-scheduled-action.html) na *Referência de comandos da AWS CLI*. ### `delete-snapshot-copy-grant` O código de exemplo a seguir mostra como usar `delete-snapshot-copy-grant`. **AWS CLI** **Para excluir uma concessão de cópia do snapshot** O exemplo `delete-snapshot-copy-grant` a seguir exclui a concessão de cópia do snapshot especificada. ``` aws redshift delete-snapshot-copy-grant \ --snapshot-copy-grant-name mysnapshotcopygrantname ``` Esse comando não produz nenhuma saída. Para obter mais informações, consulte [Criptografia de banco de dados do Amazon Redshift](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html) no *Guia de gerenciamento de clusters do Amazon Redshift*. + Para ver detalhes da API, consulte [DeleteSnapshotCopyGrant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-snapshot-copy-grant.html) na *Referência de comandos da AWS CLI*. ### `delete-snapshot-schedule` O código de exemplo a seguir mostra como usar `delete-snapshot-schedule`. **AWS CLI** **Para excluir a programação do snapshot** O exemplo `delete-snapshot-schedule` a seguir exclui a programação do snapshot especificada. Você deve desassociar os clusters antes de excluir a programação. ``` aws redshift delete-snapshot-schedule \ --schedule-identifier mysnapshotschedule ``` Esse comando não produz nenhuma saída. Para obter mais informações, consulte [Programações de snapshot automáticas](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html#automated-snapshot-schedules) no *Guia de gerenciamento de clusters do Amazon Redshift*. + Para ver detalhes da API, consulte [DeleteSnapshotSchedule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-snapshot-schedule.html) na *Referência de comandos da AWS CLI*. ### `delete-tags` O código de exemplo a seguir mostra como usar `delete-tags`. **AWS CLI** **Para excluir tags de um cluster** O exemplo `delete-tags` a seguir exclui as tags com os nomes de chave especificados do cluster especificado. ``` aws redshift delete-tags \ --resource-name arn:aws:redshift:us-west-2:123456789012:cluster:mycluster \ --tag-keys "clustertagkey" "clustertagvalue" ``` Esse comando não produz nenhuma saída. Para obter mais informações, consulte [Marcação de recursos no Amazon Redshift](https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-tagging.html) no *Guia de gerenciamento de clusters do Amazon Redshift*. + Para ver detalhes da API, consulte [DeleteTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-tags.html) na *Referência de comandos da AWS CLI*. ### `describe-account-attributes` O código de exemplo a seguir mostra como usar `describe-account-attributes`. **AWS CLI** **Para descrever os atributos de uma** conta da AWS O exemplo `describe-account-attributes` a seguir exibe os atributos associados à conta da AWS que está fazendo a chamada. ``` aws redshift describe-account-attributes ``` Resultado: ``` { "AccountAttributes": [ { "AttributeName": "max-defer-maintenance-duration", "AttributeValues": [ { "AttributeValue": "45" } ] } ] } ``` + Consulte detalhes da API em [DescribeAccountAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-account-attributes.html) na *Referência de comandos da AWS CLI*. ### `describe-cluster-db-revisions` O código de exemplo a seguir mostra como usar `describe-cluster-db-revisions`. **AWS CLI** **Para descrever as revisões de banco de dados para um cluster** O exemplo `describe-cluster-db-revisions` a seguir exibe os detalhes de uma matriz de objetos `ClusterDbRevision` para o cluster especificado. ``` aws redshift describe-cluster-db-revisions \ --cluster-identifier mycluster ``` Resultado: ``` { "ClusterDbRevisions": [ { "ClusterIdentifier": "mycluster", "CurrentDatabaseRevision": "11420", "DatabaseRevisionReleaseDate": "2019-11-22T16:43:49.597Z", "RevisionTargets": [] } ] } ``` + Para ver detalhes da API, consulte [DescribeClusterDbRevisions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-cluster-db-revisions.html) na *Referência de comandos da AWS CLI*. ### `describe-cluster-parameter-groups` O código de exemplo a seguir mostra como usar `describe-cluster-parameter-groups`. **AWS CLI** Obter uma descrição de todos os grupos de parâmetros de cluster. Este exemplo retorna uma descrição de todos os grupos do parâmetros de cluster da conta, com cabeçalhos de colunas. Por padrão, o formato da saída é JSON. Comando: ``` aws redshift describe-cluster-parameter-groups ``` Resultado: ``` { "ParameterGroups": [ { "ParameterGroupFamily": "redshift-1.0", "Description": "My first cluster parameter group", "ParameterGroupName": "myclusterparametergroup" } ], "ResponseMetadata": { "RequestId": "8ceb8f6f-64cc-11e2-bea9-49e0ce183f07" } } ``` Você pode obter as mesmas informações em formato de texto com a opção `--output text`. Comando: opção `--output text`. Comando: opção. Comando: ``` aws redshift describe-cluster-parameter-groups --output text ``` Resultado: ``` redshift-1.0 My first cluster parameter group myclusterparametergroup RESPONSEMETADATA 9e665a36-64cc-11e2-8f7d-3b939af52818 ``` + Para ver detalhes da API, consulte [DescribeClusterParameterGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-cluster-parameter-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-cluster-parameters` O código de exemplo a seguir mostra como usar `describe-cluster-parameters`. **AWS CLI** Recupere os parâmetros de um grupo de parâmetros de cluster especificado. Este exemplo recupera os parâmetros do grupo de parâmetros nomeado. Por padrão, o formato da saída é JSON. Comando: ``` aws redshift describe-cluster-parameters --parameter-group-name myclusterparametergroup ``` Resultado: ``` { "Parameters": [ { "Description": "Sets the display format for date and time values.", "DataType": "string", "IsModifiable": true, "Source": "engine-default", "ParameterValue": "ISO, MDY", "ParameterName": "datestyle" }, { "Description": "Sets the number of digits displayed for floating-point values", "DataType": "integer", "IsModifiable": true, "AllowedValues": "-15-2", "Source": "engine-default", "ParameterValue": "0", "ParameterName": "extra_float_digits" }, (...remaining output omitted...) ] } ``` Você pode obter as mesmas informações em formato de texto com a opção `--output text`. Comando: opção `--output text`. Comando: opção. Comando: ``` aws redshift describe-cluster-parameters --parameter-group-name myclusterparametergroup --output text ``` Resultado: ``` RESPONSEMETADATA cdac40aa-64cc-11e2-9e70-918437dd236d Sets the display format for date and time values. string True engine-default ISO, MDY datestyle Sets the number of digits displayed for floating-point values integer True -15-2 engine-default 0 extra_float_digits This parameter applies a user-defined label to a group of queries that are run during the same session.. string True engine-default default query_group require ssl for all databaseconnections boolean True true,false engine-default false require_ssl Sets the schema search order for names that are not schema-qualified. string True engine-default $user, public search_path Aborts any statement that takes over the specified number of milliseconds. integer True engine-default 0 statement_timeout wlm json configuration string True engine-default \[{"query_concurrency":5}] wlm_json_configuration ``` + Para ver detalhes da API, consulte [DescribeClusterParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-cluster-parameters.html) na *Referência de comandos da AWS CLI*. ### `describe-cluster-security-groups` O código de exemplo a seguir mostra como usar `describe-cluster-security-groups`. **AWS CLI** Obter uma descrição de todos os grupos de segurança de cluster Este exemplo retorna uma descrição de todos os grupos de segurança de cluster para a conta. Por padrão, o formato da saída é JSON. Comando: ``` aws redshift describe-cluster-security-groups ``` Resultado: ``` { "ClusterSecurityGroups": [ { "OwnerId": "100447751468", "Description": "default", "ClusterSecurityGroupName": "default", "EC2SecurityGroups": \[], "IPRanges": [ { "Status": "authorized", "CIDRIP": "0.0.0.0/0" } ] }, { "OwnerId": "100447751468", "Description": "This is my cluster security group", "ClusterSecurityGroupName": "mysecuritygroup", "EC2SecurityGroups": \[], "IPRanges": \[] }, (...remaining output omitted...) ] } ``` + Para ver detalhes da API, consulte [DescribeClusterSecurityGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-cluster-security-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-cluster-snapshots` O código de exemplo a seguir mostra como usar `describe-cluster-snapshots`. **AWS CLI** Obter uma descrição de todos os snapshots do cluster. Este exemplo retorna uma descrição de todos os snapshots do cluster para a conta. Por padrão, o formato da saída é JSON. Comando: ``` aws redshift describe-cluster-snapshots ``` Resultado: ``` { "Snapshots": [ { "Status": "available", "SnapshotCreateTime": "2013-07-17T22:02:22.852Z", "EstimatedSecondsToCompletion": -1, "AvailabilityZone": "us-east-1a", "ClusterVersion": "1.0", "MasterUsername": "adminuser", "Encrypted": false, "OwnerAccount": "111122223333", "BackupProgressInMegabytes": 20.0, "ElapsedTimeInSeconds": 0, "DBName": "dev", "CurrentBackupRateInMegabytesPerSecond: 0.0, "ClusterCreateTime": "2013-01-22T21:59:29.559Z", "ActualIncrementalBackupSizeInMegabytes"; 20.0 "SnapshotType": "automated", "NodeType": "dw.hs1.xlarge", "ClusterIdentifier": "mycluster", "Port": 5439, "TotalBackupSizeInMegabytes": 20.0, "NumberOfNodes": "2", "SnapshotIdentifier": "cm:mycluster-2013-01-22-22-04-18" }, { "EstimatedSecondsToCompletion": 0, "OwnerAccount": "111122223333", "CurrentBackupRateInMegabytesPerSecond: 0.1534, "ActualIncrementalBackupSizeInMegabytes"; 11.0, "NumberOfNodes": "2", "Status": "available", "ClusterVersion": "1.0", "MasterUsername": "adminuser", "AccountsWithRestoreAccess": [ { "AccountID": "444455556666" } ], "TotalBackupSizeInMegabytes": 20.0, "DBName": "dev", "BackupProgressInMegabytes": 11.0, "ClusterCreateTime": "2013-01-22T21:59:29.559Z", "ElapsedTimeInSeconds": 0, "ClusterIdentifier": "mycluster", "SnapshotCreateTime": "2013-07-17T22:04:18.947Z", "AvailabilityZone": "us-east-1a", "NodeType": "dw.hs1.xlarge", "Encrypted": false, "SnapshotType": "manual", "Port": 5439, "SnapshotIdentifier": "my-snapshot-id" } ] } (...remaining output omitted...) ``` + Para ver detalhes da API, consulte [DescribeClusterSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-cluster-snapshots.html) na *Referência de comandos da AWS CLI*. ### `describe-cluster-subnet-groups` O código de exemplo a seguir mostra como usar `describe-cluster-subnet-groups`. **AWS CLI** Obter uma descrição de todos os grupos de sub-redes do cluster Este exemplo retorna uma descrição de todos os grupos de sub-redes do cluster. Por padrão, o formato da saída é JSON. Comando: ``` aws redshift describe-cluster-subnet-groups ``` Resultado: ``` { "ClusterSubnetGroups": [ { "Subnets": [ { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-763fdd1c", "SubnetAvailabilityZone": { "Name": "us-east-1a" } } ], "VpcId": "vpc-7e3fdd14", "SubnetGroupStatus": "Complete", "Description": "My subnet group", "ClusterSubnetGroupName": "mysubnetgroup" } ], "ResponseMetadata": { "RequestId": "37fa8c89-6990-11e2-8f75-ab4018764c77" } } ``` + Para ver detalhes da API, consulte [DescribeClusterSubnetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-cluster-subnet-groups.html) na *Referência de comandos da AWS CLI*. ### `describe-cluster-tracks` O código de exemplo a seguir mostra como usar `describe-cluster-tracks`. **AWS CLI** **Para descrever as trilhas do cluster** O exemplo `describe-cluster-tracks` a seguir exibe detalhes das trilhas de manutenção disponíveis. ``` aws redshift describe-cluster-tracks \ --maintenance-track-name current ``` Resultado: ``` { "MaintenanceTracks": [ { "MaintenanceTrackName": "current", "DatabaseVersion": "1.0.11420", "UpdateTargets": [ { "MaintenanceTrackName": "preview_features", "DatabaseVersion": "1.0.11746", "SupportedOperations": [ { "OperationName": "restore-from-cluster-snapshot" } ] }, { "MaintenanceTrackName": "trailing", "DatabaseVersion": "1.0.11116", "SupportedOperations": [ { "OperationName": "restore-from-cluster-snapshot" }, { "OperationName": "modify-cluster" } ] } ] } ] } ``` Para obter mais informações, consulte [Como escolher trilhas de manutenção de cluster](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-mgmt-maintenance-tracks) no *Guia de gerenciamento de clusters do Amazon Redshift*. + Para ver detalhes da API, consulte [DescribeClusterTracks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-cluster-tracks.html) na *Referência de comandos da AWS CLI*. ### `describe-cluster-versions` O código de exemplo a seguir mostra como usar `describe-cluster-versions`. **AWS CLI** Obter uma descrição de todas as versões do cluster. Este exemplo retorna uma descrição de todas as versões do cluster. Por padrão, o formato da saída é JSON. Comando: ``` aws redshift describe-cluster-versions ``` Resultado: ``` { "ClusterVersions": [ { "ClusterVersion": "1.0", "Description": "Initial release", "ClusterParameterGroupFamily": "redshift-1.0" } ], "ResponseMetadata": { "RequestId": "16a53de3-64cc-11e2-bec0-17624ad140dd" } } ``` + Para ver detalhes da API, consulte [DescribeClusterVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-cluster-versions.html) na *Referência de comandos da AWS CLI*. ### `describe-clusters` O código de exemplo a seguir mostra como usar `describe-clusters`. **AWS CLI** Obter uma descrição de todos os clusters Este exemplo retorna uma descrição de todos os clusters da conta. Por padrão, o formato da saída é JSON. Comando: ``` aws redshift describe-clusters ``` Resultado: ``` { "Clusters": [ { "NodeType": "dw.hs1.xlarge", "Endpoint": { "Port": 5439, "Address": "mycluster.coqoarplqhsn.us-east-1.redshift.amazonaws.com" }, "ClusterVersion": "1.0", "PubliclyAccessible": "true", "MasterUsername": "adminuser", "ClusterParameterGroups": [ { "ParameterApplyStatus": "in-sync", "ParameterGroupName": "default.redshift-1.0" } ], "ClusterSecurityGroups": [ { "Status": "active", "ClusterSecurityGroupName": "default" } ], "AllowVersionUpgrade": true, "VpcSecurityGroups": \[], "AvailabilityZone": "us-east-1a", "ClusterCreateTime": "2013-01-22T21:59:29.559Z", "PreferredMaintenanceWindow": "sat:03:30-sat:04:00", "AutomatedSnapshotRetentionPeriod": 1, "ClusterStatus": "available", "ClusterIdentifier": "mycluster", "DBName": "dev", "NumberOfNodes": 2, "PendingModifiedValues": {} } ], "ResponseMetadata": { "RequestId": "65b71cac-64df-11e2-8f5b-e90bd6c77476" } } ``` Você pode obter as mesmas informações em formato de texto com a opção `--output text`. Comando: opção `--output text`. Comando: opção. Comando: ``` aws redshift describe-clusters --output text ``` Resultado: ``` dw.hs1.xlarge 1.0 true adminuser True us-east-1a 2013-01-22T21:59:29.559Z sat:03:30-sat:04:00 1 available mycluster dev 2 ENDPOINT 5439 mycluster.coqoarplqhsn.us-east-1.redshift.amazonaws.com in-sync default.redshift-1.0 active default PENDINGMODIFIEDVALUES RESPONSEMETADATA 934281a8-64df-11e2-b07c-f7fbdd006c67 ``` + Consulte detalhes da API em [DescribeClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-clusters.html) na *Referência de comandos da AWS CLI*. ### `describe-default-cluster-parameters` O código de exemplo a seguir mostra como usar `describe-default-cluster-parameters`. **AWS CLI** Obter uma descrição dos parâmetros padrão de cluster. Este exemplo retorna uma descrição dos parâmetros padrão do cluster para a família `redshift-1.0`. Por padrão, o formato da saída é JSON. Comando: ``` aws redshift describe-default-cluster-parameters --parameter-group-family redshift-1.0 ``` Resultado: ``` { "DefaultClusterParameters": { "ParameterGroupFamily": "redshift-1.0", "Parameters": [ { "Description": "Sets the display format for date and time values.", "DataType": "string", "IsModifiable": true, "Source": "engine-default", "ParameterValue": "ISO, MDY", "ParameterName": "datestyle" }, { "Description": "Sets the number of digits displayed for floating-point values", "DataType": "integer", "IsModifiable": true, "AllowedValues": "-15-2", "Source": "engine-default", "ParameterValue": "0", "ParameterName": "extra_float_digits" }, (...remaining output omitted...) ] } } ``` Para ver uma lista de famílias de grupos de parâmetros válidas, use o comando `describe-cluster-parameter-groups`. comando `describe-cluster-parameter-groups`. comando. + Para ver detalhes da API, consulte [DescribeDefaultClusterParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-default-cluster-parameters.html) na *Referência de comandos da AWS CLI*. ### `describe-event-categories` O código de exemplo a seguir mostra como usar `describe-event-categories`. **AWS CLI** **Para descrever categorias de eventos para um cluster** O exemplo `describe-event-categories` a seguir exibe detalhes das categorias de eventos de um cluster. ``` aws redshift describe-event-categories \ --source-type cluster ``` Resultado: ``` { "EventCategoriesMapList": [ { "SourceType": "cluster", "Events": [ { "EventId": "REDSHIFT-EVENT-2000", "EventCategories": [ "management" ], "EventDescription": "Cluster created at